thermferm/simulator.h

changeset 715
f5d85af156ab
parent 714
24749c296a50
--- a/thermferm/simulator.h	Tue Apr 30 17:26:41 2024 +0200
+++ b/thermferm/simulator.h	Wed May 01 14:38:37 2024 +0200
@@ -3,9 +3,23 @@
 
 #ifdef USE_SIMULATOR
 
+/**
+ * @brief Return a json string with one simulator record
+ * @param simulator The simulator record
+ * @return Json string
+ */
 char *simulator_json(simulator_list *simulator);
+
+
+/**
+ * @brief Send all simulator records to the websocket
+ */
 void simulator_ws(void);
 
+
+/**
+ * @brief The simulator thread.
+ */
 void *my_simulator_loop(void *);
 
 #endif

mercurial