From 0cc36ade0cbb41c53542bf81d7be7d5f91781f91 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=B6ran=20Sander?= Date: Fri, 1 May 2020 20:39:11 +0200 Subject: [PATCH] RC 1.2.0 --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c652576..fbbdc4a 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@ [![Build Status](https://cloud.drone.io/api/badges/mountaindude/verisure-mqtt/status.svg)](https://cloud.drone.io/mountaindude/verisure-mqtt) [![Maintainability](https://api.codeclimate.com/v1/badges/0f88c41e4ee6b831ab49/maintainability)](https://codeclimate.com/github/mountaindude/verisure-mqtt/maintainability) -Dockerized Node.js app that queries Verisure's APIs for status and sensor readings, and then forwards this info to MQTT. +Dockerized Node.js app that queries Verisure's APIs for status and sensor readings, and then forwards this info to MQTT. + Once the data has been injected into MQTT messages, it can be acted upon by any tool or system capable of subscribing to MQTT topics. What kind of data that is available from different Verisure devices vary, but many of them (PIR, camera, smoke detectors etc) contain temperature and/or humidity sensors. These sensor readings can be logged and then provide useful long-term environmental information. @@ -47,7 +48,8 @@ Pushing the sensor readings to MQTT makes it possible to act on them from other While Node-RED was initially (and still is) positioned as a visual prototyping tool for IoT applications, it has over the past several years developed into a rock-solid platform that lots of people use for continuous data processing. It might not be solid enough for mission critical enterprise data, but it's not far away. -For the purpose of collecting and acting on sensor data in a home setting, Node-RED is more than adequate. +For the purpose of collecting and acting on sensor data in a home setting, Node-RED is more than adequate. + Oh, and Node-RED of course runs as a Docker container too.. making it a breeze to set up. Once the data is stored in InfluxDB it can be visualised using Grafana och other similar tools. A Grafana dashboard showing temperatures and humidity can look like this: @@ -56,7 +58,7 @@ Once the data is stored in InfluxDB it can be visualised using Grafana och other ## Querying Verisure's API -There is some rate limiting for the API, preventing too frequent calls. +There is some rate limiting for the API, preventing too frequent calls. It is hard to say how often calls can be made, but given that climate sensors only update once per hour, the Node.js code in index.js is set to query the API every 10 minutes. This seems to work fine from a rate limiting perspective.