scy/fhz

Library to access the ELV FHZ series of devices

Maintainers

Details

github.com/scy/php-fhz

Source

Issues

Installs: 9

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

0.2.0 2018-11-06 23:10 UTC

Requires

Requires (Dev)

MIT 7ebcaef05c3db84f46ea8aeb4d166beeb5078348

  • Tim Weber <scy.woop@scy.name>

This package is auto-updated.

Last update: 2024-03-29 03:38:42 UTC

README

This is a PHP package to access the FHZ 1000 family of SRD860 transceivers and parse messages from sensors.

At least that's what it currently does. The features are limited to what the author currently needs:

  • connect to a FHZ 1000 PC from Linux (tested on WSL as well)
  • receive temperature and humidity readings from several HMS100T and HMS100TF sensors and make them available as PHP objects

Installation

composer require scy/fhz should be sufficient. In case you want to try the example script, make sure you install the development dependencies. Recent versions of Composer do that automatically, older ones need the --dev switch.

Usage

Create a new Connection, passing the path to the serial device your FHZ is connected to as a parameter. You can optionally supply a PSR-3 logger as the second parameter.

Calling read($seconds) on the resulting object will listen for incoming transmissions and return the first incoming message. If no messages arrived after $seconds (a float), the method will return false. Messages that arrive while your read() is not running will be buffered by your operating system's IO buffer and returned one by one when you call read() the next time. (That buffer is limited, so don't get too crazy.)

The message is returned as a a Message object or a subclass of it.

Currently, only one subclass is implemented: TemperatureMessage. It represents a single reading of a HMS100T (temperature) or HMS100TF (temperature/humidity) sensor. Use methods like getTemperature() to access the data.

You can also have a look at some example code, which probably explains it better.

Status

I'm currently integrating this library into a management and logging interface for my van. The API isn't stable, but shouldn't change too much either.

Documentation, error handling and code structure could use some improvements.

Meta

This library is free software released under the terms of the MIT license. It is written and maintained by Tim Weber and its source code is hosted at https://github.com/scy/php-fhz.