bmsd/ispindels.h

changeset 568
6f3c24e21deb
parent 567
6bf0afc33e70
child 578
e75ce5bbda73
--- a/bmsd/ispindels.h	Fri Dec 13 16:49:50 2019 +0100
+++ b/bmsd/ispindels.h	Fri Dec 13 20:33:38 2019 +0100
@@ -8,10 +8,14 @@
 void ispindel_dump(sys_ispindel_list *ispindel);
 
 /**
- * @brief Birth of a ispindel or data update. Create it in the database if 
- *        never seen before, else just update the database entry.
- * @param topic The MQTT topic string, contains the ispindel type and name.
- * @param payload The JSON formatted payload with the ispindel details.
+ * @brief Messages received from a iSpindel using the MQTT sender.
+ *        A new node is created if this is the first message of the
+ *        iSpindel, else the last seen time is updated. Then the last
+ *        actual state is recorded. A log line is written when a beer
+ *        is assigned.
+ * @param topic The MQTT topic string, contains the ispindel name and
+ *        keyword for the data.
+ * @param payload The value for the selected keyword.
  */
 void ispindel_mqtt(char *topic, char *payload);
 

mercurial