@ngreatorex/homie-device
Version:
Homie Device for NodeJS
39 lines (28 loc) • 2 kB
Markdown
Homie Device
============
This is a (substantially rewritten) TypeScript port of a [NodeJS port](https://github.com/microclimates/homie-device) of the [Homie convention](https://github.com/marvinroger/homie) for lightweight IoT device interaction on an [MQTT](https://en.wikipedia.org/wiki/MQTT) message bus. It includes several modifications to make the API a bit easier to use.
Features
--------
* Device, Node, and Property
* Auto MQTT connect with optional username/password
* Auto MQTT re-connect
* Periodic $stats/uptime publishing
* $online will
* Device topic events
* Broadcast message events
* Periodic stats interval events
* Device/node/property announcement on connect
* Property send with retained value
* Settable properties
* Property ranges
* Lightweight
Quick Start
-----------
Maybe later...
Contributors
------------
<table id="contributors"><tr><td><img width="124" src="https://avatars2.githubusercontent.com/u/373538?v=4"><br/><a href="https://github.com/lorenwest">lorenwest</a></td><td><img width="124" src="https://avatars0.githubusercontent.com/u/7427179?v=4"><br/><a href="https://github.com/marcus-garvey">marcus-garvey</a></td><td><img width="124" src="https://avatars0.githubusercontent.com/u/7627635?v=4"><br/><a href="https://github.com/rozpuszczalny">rozpuszczalny</a></td><td><img width="124" src="https://avatars0.githubusercontent.com/u/10454636?v=4"><br/><a href="https://github.com/chrispyduck">chrispyduck</a></td><td><img width="124" src="https://avatars1.githubusercontent.com/u/35524902?v=4"><br/><a href="https://github.com/freddebacker">freddebacker</a></td><td><img width="124" src="https://avatars0.githubusercontent.com/u/52833340?v=4"><br/><a href="https://github.com/wolfgangcolsman">wolfgangcolsman</a></td></tr></table>
License
-------
May be freely distributed under the [MIT license](https://raw.githubusercontent.com/chrispyduck/homie-device/master/LICENSE).