Get device metadata admin message (#1607)

* Get device metadata admin message

* Bump device state version

protobufs

@@ -1 +1 @@
-Subproject commit 6bddcd2647af44cb9997e08871897a3aa2157362
+Subproject commit 7ea5bd3922eb77db9d01d8ee70032337eb639071

src/mesh/NodeDB.cpp

@@ -43,14 +43,6 @@ ChannelFile channelFile;
  */
 uint32_t radioGeneration;
 
-/*
-DeviceState versions used to be defined in the .proto file but really only this function cares.  So changed to a
-#define here.
-*/
-
-#define DEVICESTATE_CUR_VER 13
-#define DEVICESTATE_MIN_VER DEVICESTATE_CUR_VER
-
 // FIXME - move this somewhere else
 extern void getMacAddr(uint8_t *dmac);
 

src/mesh/NodeDB.h

@@ -8,6 +8,14 @@
 #include "NodeStatus.h"
 #include "mesh-pb-constants.h"
 
+/*
+DeviceState versions used to be defined in the .proto file but really only this function cares.  So changed to a
+#define here.
+*/
+
+#define DEVICESTATE_CUR_VER 14
+#define DEVICESTATE_MIN_VER DEVICESTATE_CUR_VER
+
 extern DeviceState devicestate;
 extern ChannelFile channelFile;
 extern MyNodeInfo &myNodeInfo;

src/mesh/generated/admin.pb.h

@@ -6,6 +6,7 @@
 #include <pb.h>
 #include "channel.pb.h"
 #include "config.pb.h"
+#include "device_metadata.pb.h"
 #include "mesh.pb.h"
 #include "module_config.pb.h"
 
@@ -73,6 +74,8 @@ typedef struct _AdminMessage {
         ModuleConfig set_module_config;
         /* Sent immediatly after a config change has been sent to ensure comms, if this is not recieved, the config will be reverted after 10 mins */
         bool confirm_set_module_config;
+        /* Send all channels in the response to this message */
+        bool get_all_channel_request;
         /* Setting channels/radio config remotely carries the risk that you might send an invalid config and the radio never talks to your mesh again.
      Therefore if setting either of these properties remotely, you must send a confirm_xxx message within 10 minutes.
      If you fail to do so, the radio will assume loss of comms and revert your changes.
@@ -111,6 +114,10 @@ typedef struct _AdminMessage {
         char set_canned_message_module_part4[201];
         /* Tell the node to shutdown in this many seconds (or <0 to cancel shutdown) */
         int32_t shutdown_seconds;
+        /* Request the node to send device metadata (firmware, protobuf version, etc) */
+        uint32_t get_device_metadata_request;
+        /* Device metadata response */
+        DeviceMetadata get_device_metadata_response;
     };
 } AdminMessage;
 
@@ -148,6 +155,7 @@ extern "C" {
 #define AdminMessage_get_module_config_response_tag 15
 #define AdminMessage_set_module_config_tag       16
 #define AdminMessage_confirm_set_module_config_tag 17
+#define AdminMessage_get_all_channel_request_tag 18
 #define AdminMessage_confirm_set_channel_tag     32
 #define AdminMessage_confirm_set_radio_tag       33
 #define AdminMessage_exit_simulator_tag          34
@@ -165,6 +173,8 @@ extern "C" {
 #define AdminMessage_set_canned_message_module_part3_tag 46
 #define AdminMessage_set_canned_message_module_part4_tag 47
 #define AdminMessage_shutdown_seconds_tag        51
+#define AdminMessage_get_device_metadata_request_tag 52
+#define AdminMessage_get_device_metadata_response_tag 53
 
 /* Struct field encoding specification for nanopb */
 #define AdminMessage_FIELDLIST(X, a) \
@@ -182,6 +192,7 @@ X(a, STATIC,   ONEOF,    UENUM,    (variant,get_module_config_request,get_module
 X(a, STATIC,   ONEOF,    MESSAGE,  (variant,get_module_config_response,get_module_config_response),  15) \
 X(a, STATIC,   ONEOF,    MESSAGE,  (variant,set_module_config,set_module_config),  16) \
 X(a, STATIC,   ONEOF,    BOOL,     (variant,confirm_set_module_config,confirm_set_module_config),  17) \
+X(a, STATIC,   ONEOF,    BOOL,     (variant,get_all_channel_request,get_all_channel_request),  18) \
 X(a, STATIC,   ONEOF,    BOOL,     (variant,confirm_set_channel,confirm_set_channel),  32) \
 X(a, STATIC,   ONEOF,    BOOL,     (variant,confirm_set_radio,confirm_set_radio),  33) \
 X(a, STATIC,   ONEOF,    BOOL,     (variant,exit_simulator,exit_simulator),  34) \
@@ -198,7 +209,9 @@ X(a, STATIC,   ONEOF,    STRING,   (variant,set_canned_message_module_part1,set_
 X(a, STATIC,   ONEOF,    STRING,   (variant,set_canned_message_module_part2,set_canned_message_module_part2),  45) \
 X(a, STATIC,   ONEOF,    STRING,   (variant,set_canned_message_module_part3,set_canned_message_module_part3),  46) \
 X(a, STATIC,   ONEOF,    STRING,   (variant,set_canned_message_module_part4,set_canned_message_module_part4),  47) \
-X(a, STATIC,   ONEOF,    INT32,    (variant,shutdown_seconds,shutdown_seconds),  51)
+X(a, STATIC,   ONEOF,    INT32,    (variant,shutdown_seconds,shutdown_seconds),  51) \
+X(a, STATIC,   ONEOF,    UINT32,   (variant,get_device_metadata_request,get_device_metadata_request),  52) \
+X(a, STATIC,   ONEOF,    MESSAGE,  (variant,get_device_metadata_response,get_device_metadata_response),  53)
 #define AdminMessage_CALLBACK NULL
 #define AdminMessage_DEFAULT NULL
 #define AdminMessage_variant_set_owner_MSGTYPE User
@@ -209,6 +222,7 @@ X(a, STATIC,   ONEOF,    INT32,    (variant,shutdown_seconds,shutdown_seconds),
 #define AdminMessage_variant_set_config_MSGTYPE Config
 #define AdminMessage_variant_get_module_config_response_MSGTYPE ModuleConfig
 #define AdminMessage_variant_set_module_config_MSGTYPE ModuleConfig
+#define AdminMessage_variant_get_device_metadata_response_MSGTYPE DeviceMetadata
 
 extern const pb_msgdesc_t AdminMessage_msg;
 

src/mesh/generated/device_metadata.pb.c

@@ -0,0 +1,12 @@
+/* Automatically generated nanopb constant definitions */
+/* Generated by nanopb-0.4.6 */
+
+#include "device_metadata.pb.h"
+#if PB_PROTO_HEADER_VERSION != 40
+#error Regenerate this file with the current version of nanopb generator.
+#endif
+
+PB_BIND(DeviceMetadata, DeviceMetadata, AUTO)
+
+
+

src/mesh/generated/device_metadata.pb.h

@@ -0,0 +1,53 @@
+/* Automatically generated nanopb header */
+/* Generated by nanopb-0.4.6 */
+
+#ifndef PB_DEVICE_METADATA_PB_H_INCLUDED
+#define PB_DEVICE_METADATA_PB_H_INCLUDED
+#include <pb.h>
+
+#if PB_PROTO_HEADER_VERSION != 40
+#error Regenerate this file with the current version of nanopb generator.
+#endif
+
+/* Struct definitions */
+/* Device metadata response */
+typedef struct _DeviceMetadata { 
+    /* Device firmware version string */
+    char firmware_version[18];
+    /* Device state version */
+    uint32_t device_state_version;
+} DeviceMetadata;
+
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* Initializer values for message structs */
+#define DeviceMetadata_init_default              {"", 0}
+#define DeviceMetadata_init_zero                 {"", 0}
+
+/* Field tags (for use in manual encoding/decoding) */
+#define DeviceMetadata_firmware_version_tag      1
+#define DeviceMetadata_device_state_version_tag  2
+
+/* Struct field encoding specification for nanopb */
+#define DeviceMetadata_FIELDLIST(X, a) \
+X(a, STATIC,   SINGULAR, STRING,   firmware_version,   1) \
+X(a, STATIC,   SINGULAR, UINT32,   device_state_version,   2)
+#define DeviceMetadata_CALLBACK NULL
+#define DeviceMetadata_DEFAULT NULL
+
+extern const pb_msgdesc_t DeviceMetadata_msg;
+
+/* Defines for backwards compatibility with code written before nanopb-0.4.0 */
+#define DeviceMetadata_fields &DeviceMetadata_msg
+
+/* Maximum encoded size of messages (where known) */
+#define DeviceMetadata_size                      25
+
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
+
+#endif

src/modules/AdminModule.cpp

@@ -109,6 +109,11 @@ bool AdminModule::handleReceivedProtobuf(const MeshPacket &mp, AdminMessage *r)
         shutdownAtMsec = (s < 0) ? 0 : (millis() + s * 1000);
         break;
     }
+    case AdminMessage_get_device_metadata_request_tag: {
+        DEBUG_MSG("Client is getting device metadata\n");
+        handleGetDeviceMetadata(mp);
+        break;
+    }
 
 #ifdef ARCH_PORTDUINO
     case AdminMessage_exit_simulator_tag:
@@ -374,6 +379,18 @@ void AdminModule::handleGetModuleConfig(const MeshPacket &req, const uint32_t co
     }
 }
 
+void AdminModule::handleGetDeviceMetadata(const MeshPacket &req) {
+    AdminMessage r = AdminMessage_init_default;
+    
+    DeviceMetadata deviceMetadata;
+    strncpy(deviceMetadata.firmware_version, myNodeInfo.firmware_version, 18);
+    deviceMetadata.device_state_version = DEVICESTATE_CUR_VER;
+
+    r.get_device_metadata_response = deviceMetadata;
+    r.which_variant = AdminMessage_get_device_metadata_response_tag;
+    myReply = allocDataProtobuf(r);
+}
+
 void AdminModule::handleGetChannel(const MeshPacket &req, uint32_t channelIndex)
 {
     if (req.decoded.want_response) {

src/modules/AdminModule.h

@@ -27,6 +27,7 @@ class AdminModule : public ProtobufModule<AdminMessage>
     void handleGetConfig(const MeshPacket &req, uint32_t configType);
     void handleGetModuleConfig(const MeshPacket &req, uint32_t configType);
     void handleGetChannel(const MeshPacket &req, uint32_t channelIndex);
+    void handleGetDeviceMetadata(const MeshPacket &req);
 
     /**
      * Setters