Merge pull request #739 from meshtastic/event-enum

Add event enum to indicate to client if this is event firmware

meshtastic/mesh.options

@@ -31,6 +31,8 @@
 *MyNodeInfo.air_period_tx       max_count:8
 *MyNodeInfo.air_period_rx       max_count:8
 
+*MyNodeInfo.firmware_edition int_size:8
+
 # Note: the actual limit (because of header bytes) on the size of encrypted payloads is 251 bytes, but I use 256
 # here because we might need to fill with zeros for padding to encryption block size (16 bytes per block)
 *MeshPacket.encrypted max_size:256

meshtastic/mesh.proto

@@ -1627,6 +1627,47 @@ enum CriticalErrorCode {
   FLASH_CORRUPTION_UNRECOVERABLE = 13;
 }
 
+/*
+ * Enum to indicate to clients whether this firmware is a special firmware build, like an event.
+ * The first 16 values are reserved for non-event special firmwares, like the Smart Citizen use case.
+ */
+enum FirmwareEdition {
+  /*
+   * Vanilla firmware
+   */
+  VANILLA = 0;
+
+  /*
+   * Firmware for use in the Smart Citizen environmental monitoring network
+   */
+  SMART_CITIZEN = 1;
+
+  /*
+   * Open Sauce, the maker conference held yearly in CA
+   */
+  OPEN_SAUCE = 16;
+
+  /*
+   * DEFCON, the yearly hacker conference
+   */
+  DEFCON = 17;
+
+  /*
+   * Burning Man, the yearly hippie gathering in the desert
+   */
+  BURNING_MAN = 18;
+
+  /*
+   * Hamvention, the Dayton amateur radio convention
+   */
+  HAMVENTION = 19;
+
+  /*
+   * Placeholder for DIY and unofficial events
+   */
+  DIY_EDITION = 127;
+}
+
 /*
  * Unique local debugging info for this node
  * Note: we don't include position or the user info, because that will come in the
@@ -1660,6 +1701,11 @@ message MyNodeInfo {
    * The PlatformIO environment used to build this firmware
    */
   string pio_env = 13;
+
+  /*
+   * The indicator for whether this device is running event firmware and which
+   */
+  FirmwareEdition firmware_edition = 14;
 }
 
 /*