Merge pull request #8 from adafruit/board_id

Board Metadata Utilities

Author: toddtreece

src/AdafruitIO.cpp

@@ -199,6 +199,22 @@ aio_status_t AdafruitIO::status()
   return _status;
 }
 
+char* AdafruitIO::boardID()
+{
+  return AdafruitIO_Board::id();
+}
+
+const char* AdafruitIO::boardType()
+{
+  return AdafruitIO_Board::type();
+}
+
+char* AdafruitIO::version()
+{
+  sprintf(_version, "%d.%d.%d", ADAFRUITIO_VERSION_MAJOR, ADAFRUITIO_VERSION_MINOR, ADAFRUITIO_VERSION_PATCH);
+  return _version;
+}
+
 aio_status_t AdafruitIO::mqttStatus()
 {
   // if the connection failed,

src/AdafruitIO.h

@@ -19,6 +19,7 @@
 #include "AdafruitIO_Dashboard.h"
 #include "AdafruitIO_Data.h"
 #include "ArduinoHttpClient.h"
+#include "util/AdafruitIO_Board.h"
 
 #ifndef ADAFRUIT_MQTT_VERSION_MAJOR
   #error "This sketch requires Adafruit MQTT Library v0.16.0 or higher. Please install or upgrade using the Library Manager."
@@ -54,6 +55,11 @@ class AdafruitIO {
     virtual aio_status_t networkStatus() = 0;
     aio_status_t mqttStatus();
 
+    char* boardID();
+    const char* boardType();
+    char* version();
+    virtual const char* connectionType() = 0;
+
   protected:
     virtual void _connect() = 0;
     aio_status_t _status = AIO_IDLE;
@@ -62,6 +68,8 @@ class AdafruitIO {
     Adafruit_MQTT *_mqtt;
     HttpClient *_http;
 
+    char _version[10];
+
     const char *_host = "io.adafruit.com";
     uint16_t _mqtt_port = 8883;
     uint16_t _http_port = 443;

src/AdafruitIO_Ethernet.h

@@ -51,6 +51,11 @@ class AdafruitIO_Ethernet : public AdafruitIO {
       return _status;
     }
 
+    const char* connectionType()
+    {
+      return "ethernet_wing";
+    }
+
   protected:
     byte _mac[6] = {0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED};
     uint16_t _port = 1883;

src/AdafruitIO_FONA.h

@@ -68,6 +68,11 @@ class AdafruitIO_FONA : public AdafruitIO {
       return AIO_NET_CONNECTED;
     }
 
+    const char* connectionType()
+    {
+      return "fona";
+    }
+
   protected:
     uint16_t _mqtt_port = 1883;
 

src/util/AdafruitIO_Board.cpp

@@ -0,0 +1,89 @@
+//
+// Adafruit invests time and resources providing this open source code.
+// Please support Adafruit and open source hardware by purchasing
+// products from Adafruit!
+//
+// Copyright (c) 2015-2016 Adafruit Industries
+// Authors: Todd Treece
+// Licensed under the MIT license.
+//
+// All text above must be included in any redistribution.
+//
+#include "AdafruitIO_Board.h"
+
+char AdafruitIO_Board::_id[64] = "";
+
+#if defined(ARDUINO_SAMD_MKR1000)
+    const char AdafruitIO_Board::_type[] = "mkr1000";
+#elif defined(ARDUINO_SAMD_FEATHER_M0)
+    const char AdafruitIO_Board::_type[] = "feather_m0";
+#elif defined(ARDUINO_AVR_FEATHER32U4)
+    const char AdafruitIO_Board::_type[] = "feather_32u4";
+#elif defined(ARDUINO_STM32_FEATHER)
+    const char AdafruitIO_Board::_type[] = "feather_wiced";
+#elif defined(ESP8266)
+    const char AdafruitIO_Board::_type[] = "esp8266";
+#else
+    const char AdafruitIO_Board::_type[] = "unknown";
+#endif
+
+const char* AdafruitIO_Board::type()
+{
+  return AdafruitIO_Board::_type;
+}
+
+#if defined(ARDUINO_ARCH_SAMD)
+
+  char* AdafruitIO_Board::id()
+  {
+    volatile uint32_t val1, val2, val3, val4;
+    volatile uint32_t *ptr1 = (volatile uint32_t *)0x0080A00C;
+    val1 = *ptr1;
+    volatile uint32_t *ptr = (volatile uint32_t *)0x0080A040;
+    val2 = *ptr;
+    ptr++;
+    val3 = *ptr;
+    ptr++;
+    val4 = *ptr;
+
+    sprintf(AdafruitIO_Board::_id, "%8x%8x%8x%8x", val1, val2, val3, val4);
+
+    return AdafruitIO_Board::_id;
+  }
+
+#elif defined(ARDUINO_ARCH_AVR)
+
+  char* AdafruitIO_Board::id()
+  {
+    for(int i=0; i < 32; i++) {
+      sprintf(&AdafruitIO_Board::_id[i*2],"%02x", boot_signature_byte_get(i));
+    }
+    return AdafruitIO_Board::_id;
+  }
+
+#elif defined(ESP8266)
+
+  char* AdafruitIO_Board::id()
+  {
+    sprintf(AdafruitIO_Board::_id, "%06x", ESP.getChipId());
+    return AdafruitIO_Board::_id;
+  }
+
+#elif defined(ARDUINO_STM32_FEATHER)
+
+  char* AdafruitIO_Board::id()
+  {
+    uint32_t* p_unique_id = (uint32_t*) (0x1FFF7A10);
+    sprintf(AdafruitIO_Board::_id, "%08lX%08lX%08lX", p_unique_id[2], p_unique_id[1], p_unique_id[0]);
+    return AdafruitIO_Board::_id;
+  }
+
+#else
+
+  char* AdafruitIO_Board::id()
+  {
+    strcpy(AdafruitIO_Board::_id, "unknown");
+    return AdafruitIO_Board::_id;
+  }
+
+#endif

src/util/AdafruitIO_Board.h

@@ -0,0 +1,34 @@
+//
+// Adafruit invests time and resources providing this open source code.
+// Please support Adafruit and open source hardware by purchasing
+// products from Adafruit!
+//
+// Copyright (c) 2015-2017 Adafruit Industries
+// Authors: Todd Treece
+// Licensed under the MIT license.
+//
+// All text above must be included in any redistribution.
+//
+#ifndef ADAFRUITIO_BOARD_H
+#define ADAFRUITIO_BOARD_H
+
+#include "Arduino.h"
+
+#if defined(ARDUINO_ARCH_AVR)
+  #include <avr/boot.h>
+#endif
+
+class AdafruitIO_Board {
+
+  public:
+
+    static char _id[64];
+    static char* id();
+
+    static const char _type[];
+    static const char* type();
+
+
+};
+
+#endif // ADAFRUITIO_BOARD_H

src/wifi/AdafruitIO_ESP8266.cpp

@@ -65,4 +65,9 @@ aio_status_t AdafruitIO_ESP8266::networkStatus()
 
 }
 
+const char* AdafruitIO_ESP8266::connectionType()
+{
+  return "wifi";
+}
+
 #endif // ESP8266

src/wifi/AdafruitIO_ESP8266.h

@@ -29,6 +29,7 @@ class AdafruitIO_ESP8266 : public AdafruitIO {
     ~AdafruitIO_ESP8266();
 
     aio_status_t networkStatus();
+    const char* connectionType();
 
   protected:
     void _connect();

src/wifi/AdafruitIO_MKR1000.cpp

@@ -67,4 +67,9 @@ aio_status_t AdafruitIO_MKR1000::networkStatus()
 
 }
 
+const char* AdafruitIO_MKR1000::connectionType()
+{
+  return "wifi";
+}
+
 #endif // ARDUINO_ARCH_SAMD

src/wifi/AdafruitIO_MKR1000.h

@@ -30,6 +30,7 @@ class AdafruitIO_MKR1000 : public AdafruitIO {
     ~AdafruitIO_MKR1000();
 
     aio_status_t networkStatus();
+    const char* connectionType();
 
   protected:
     void _connect();