Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
bratanon committed Dec 15, 2023
1 parent 8a2a508 commit 34ac9fe
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
# NodeSOS MQTT
# NodeSOS MQTT (For Home Assistant)

[![Version][version-shield]][npm-link]
[![License][license-shield]](LICENSE.md)
[![Type definitions][type-definitions-shield]][npm-link]

This application provides an MQTT client that interfaces with
[LifeSOS](http://lifesos.com.tw) alarm system.
It will publish the state of all devices to an MQTT broker, which can
then be consumed by [Home Assistant](https://www.home-assistant.io). It will also subscribe to topics on the
broker that allow the control of the alarm system (e.g. arm, disarm) and
turn on/off device features (e.g. bypass, home guard etc.).

It was written for & tested with the LS-20/LS-30 model, though it should also
work on the LS-10 model.

---

Expand Down

0 comments on commit 34ac9fe

Please sign in to comment.