doc

burba/sys/include/nais.h

@@ -47,27 +47,20 @@ enum nais_message_type {
     CONFIG_TYPE,      ///< network setting (topic, host, port)
     ACK_TYPE,         ///< command ack
     SECRET_TYPE,      ///< exchange a secret
-    COMMAND_TYPE,     ///< a built in or a custom command
+    COMMAND_TYPE,     ///< a builtin or a custom command
     EVENT_TYPE        ///< conveys an event
 };
 
-/*
-enum event_types {
-    RESERVED = 0,
-    ALIVE,
-    ALARM
-};
-*/
 
 /**
- * @brief built in commands 
+ * @brief builtin commands 
  */
 enum command_types {
-    REBOOT_CMD = 1,
-    TOGGLE_WIFI_MODE_CMD,
-    FACTORY_RESET_CMD,
-    OTA_CMD,
-    GET_CONFIG_CMD
+    REBOOT_CMD = 1,   ///< board reboot (soft RESET) 
+    TOGGLE_WIFI_MODE_CMD, ///< toggle between STA and AP mode
+    FACTORY_RESET_CMD, ///< delete config file and reboot
+    OTA_CMD,           ///< Over The Air firmware update
+    GET_CONFIG_CMD     ///< return the current board configuration
 };