Merge pull request #142 from TheThingsNetwork/changeProto

Added fields in appData and sensorData

Author: johanstokking

docs/TheThingsMessage.md

@@ -1,18 +1,18 @@
 # API Reference
-The `TheThingsMessage` class provides structs for sensor and application data you can encode and decode as bytes.
+The `TheThingsMessage` class provides structs for device and application data you can encode and decode as bytes.
 
 ## Class: TheThingsMessage
 
 ```c
 #include <TheThingsMessage.h>
 ```
 
-## Type: sensordata_t
+## Type: devicedata_t
 
-Create a struct of this type using `api_SensorData_init_default` as defaults.
+Create a struct of this type using `api_DeviceData_init_default` as defaults.
 
 ```c
-sensordata_t data = api_SensorData_init_default;
+devicedata_t data = api_DeviceData_init_default;
 ```
 
 Then in your `setup()` function select what fields of the struct should be included when encoding it as bytes:
@@ -41,14 +41,14 @@ You can also add other analog readings.
 
 > **TODO:** Document how this works and include in example.
 
-## Method: encodeSensorData
+## Method: encodeDeviceData
 Encode the message you want to send.
 
 ```c
-static void encodeSensorData(sensordata_t *data, byte **buffer, size_t *size);
+static void encodeDeviceData(devicedata_t *data, byte **buffer, size_t *size);
 ```
 
-- `sensordata_t *data`: Structure containing all the message we can send.
+- `devicedata_t *data`: Structure containing typical fields that devices send.
 - `byte **buffer`: Bytes to send.
 - `size_t *size`: The number of bytes to send.
 
@@ -57,7 +57,7 @@ Usage:
 ```c
 byte *buffer;
 size_t size;
-TheThingsMessage::encodeSensorData(&data, &buffer, &size);
+TheThingsMessage::encodeDeviceData(&data, &buffer, &size);
 ```
 
 ## Method: decodeAppData

examples/Message/Receive/Receive.ino

@@ -13,7 +13,7 @@ const char *appKey = "00000000000000000000000000000000";
 
 TheThingsNetwork ttn(loraSerial, debugSerial, freqPlan);
 
-sensordata_t sensorData = api_SensorData_init_default;
+devicedata_t data = api_DeviceData_init_default;
 
 void setup()
 {
@@ -33,24 +33,21 @@ void setup()
 
   ttn.onMessage(message);
 
-  sensorData.has_motion = true;
-  sensorData.has_water = true;
-  sensorData.has_temperature_celcius = false;
-  sensorData.has_temperature_fahrenheit = false;
-  sensorData.has_humidity = false;
+  data.has_motion = true;
+  data.has_water = true;
 }
 
 void loop() {
   // Read sensors
-  sensorData.motion = digitalRead(TTN_PIN_LED) == HIGH;
-  sensorData.water = 682;
+  data.motion = digitalRead(TTN_PIN_LED) == HIGH;
+  data.water = 682;
 
   // Encode data
   byte *buffer;
   size_t size;
 
   // Send standard message on port 100
-  TheThingsMessage::encodeSensorData(&sensorData, &buffer, &size);
+  TheThingsMessage::encodeDeviceData(&data, &buffer, &size);
   ttn.sendBytes(buffer, size, 100);
 
   delay(10000);

examples/Message/Send/Send.ino

@@ -13,7 +13,7 @@ const char *appKey = "00000000000000000000000000000000";
 
 TheThingsNetwork ttn(loraSerial, debugSerial, freqPlan);
 
-sensordata_t data = api_SensorData_init_default;
+devicedata_t data = api_DeviceData_init_default;
 
 void setup() {
   loraSerial.begin(57600);
@@ -49,7 +49,7 @@ void loop() {
   // Encode the selected fields of the struct as bytes
   byte *buffer;
   size_t size;
-  TheThingsMessage::encodeSensorData(&data, &buffer, &size);
+  TheThingsMessage::encodeDeviceData(&data, &buffer, &size);
 
   ttn.sendBytes(buffer, size);
 

examples/waterNet

@@ -0,0 +1 @@
+Subproject commit 68d00c1be0f938e848e84b569d19a9c3f75810ab

keywords.txt

@@ -23,7 +23,7 @@ poll                    KEYWORD2
 calculateAirtime        KEYWORD2
 airtime                 KEYWORD2
 
-encodeSensorData        KEYWORD2
+encodeDeviceData        KEYWORD2
 decodeAppData           KEYWORD2
 
 #######################################

src/TheThingsMessage.cpp

@@ -9,11 +9,11 @@ bool TheThingsMessage::decodeAppData(appdata_t *receiveData, const byte *payload
   return true;
 }
 
-void TheThingsMessage::encodeSensorData(sensordata_t *data, byte **buffer, size_t *size) {
+void TheThingsMessage::encodeDeviceData(devicedata_t *data, byte **buffer, size_t *size) {
   byte message[TTN_BUFFER_SIZE];
 
   pb_ostream_t sendStream = pb_ostream_from_buffer(message, sizeof(message));
-  pb_encode(&sendStream, api_SensorData_fields, data);
+  pb_encode(&sendStream, api_DeviceData_fields, data);
   *buffer = message;
   *size = sendStream.bytes_written;
 }

src/TheThingsMessage.h

@@ -5,18 +5,18 @@
 #include <pb.h>
 #include <pb_encode.h>
 #include <pb_decode.h>
-#include "sensorData.pb.h"
+#include "deviceData.pb.h"
 #include "appData.pb.h"
 
 #define TTN_PIN_LED A2
 
-typedef api_SensorData sensordata_t;
+typedef api_DeviceData devicedata_t;
 typedef api_AppData appdata_t;
 
 class TheThingsMessage
 {
   public:
-    static void encodeSensorData(sensordata_t *data, byte **buffer, size_t *size);
+    static void encodeDeviceData(devicedata_t *data, byte **buffer, size_t *size);
     static bool decodeAppData(appdata_t *receiveData, const byte *payload, size_t length);
 };
 

src/api/appData.proto

@@ -4,4 +4,7 @@ package api;
 
 message AppData {
         optional bool light = 1;
-}
+        optional bool activation_limit = 2;
+        optional bool switch_state  = 3;
+        optional float deactivation_limit = 4;
+}

src/api/deviceData.proto

@@ -0,0 +1,25 @@
+syntax = "proto2";
+
+package api;
+
+message Location {
+        optional float longitude = 1;
+        optional float latitude = 2;
+        optional int32 altitude = 3;
+}
+
+message DeviceData {
+        optional bool motion = 1;
+        optional uint32 water = 2;
+        optional float temperature_celcius = 3;
+        optional float temperature_fahrenheit = 4;
+        optional float humidity = 5;
+
+        optional Location location = 6;
+        optional float level = 7;
+        optional bool triggered = 8;
+        optional bool actuator_active = 9;
+        optional float actuator_time = 10;
+
+        repeated uint32 analog_readings = 110;
+}