latest update - still work in progress

Author: gigapod

docs/data_encoding.md

@@ -11,7 +11,6 @@ The general structure of a packed value is:
 
  \[ **Value Type** *{1 byte}* ][**Data Value** *{n bytes - network byte order }*]
 
-
 ### Value Type
 
 Key attributes of a "Value Type" tag/code:
@@ -38,3 +37,94 @@ The following table outlines how a data value is packed, based on it's data type
 | float  | 4 | Network Byte Order (4 bytes) |
 | double  | 8 | \[ Network Byte Order (4 bytes) ][ Network Byte Order (4 bytes) ] |
 
+## Packet Encoding
+
+When packing a data value in the LoRaWAN packet payload, which has a total of 11 bytes available, data values are formatted as described in the previous section and added to the payload until no further space is available. When the payload is *full* (no free space available for the next data value), it is sent to the LoRaWAN network.
+
+So for a 11 byte LoRaWAN Payload buffer, the contents could be (note a Value Type is 1 byte):
+
+* \[ **Value Type**][**Data Value** *{4 bytes}*]\[ **Value Type**][**Data Value** *{4 bytes}*]\[**empty** {1 byte}]  = **10 bytes used**
+* \[ **Value Type**][**Data Value** *{2 bytes}*]\[ **Value Type**][**Data Value** *{4 bytes}*]\[**empty** {3 byte}]  = **8 bytes used***
+* \[ **Value Type**][**Data Value** *{2 bytes}*]\[ **Value Type**][**Data Value** *{4 bytes}*]\[ **Value Type**][**Data Value** *{2 bytes}*] =  **11 bytes used**
+
+The general payload packing is as follows:
+
+### *Initial Condition*
+
+* Set the current position in the payload to position 0
+
+### *Operation*
+
+1) Data Packet is formatted
+1) If no room is available in the payload
+    * The data payload is sent to the LoRaWAN
+    * The payload buffer set to position 0
+1) The data packet is added to the payload buffer
+1) The current position in in the payload is incremented by the size of the data packet
+1) Repeat step 1) until all data is sent
+
+### *End Condition*
+
+* Flush the payload buffer - send any pending data to the LoRaWAN
+
+## Sensor and Data Value Encodings
+
+The following table outlines the sensors and data encoding used by the IoT Node - LoRaWAN firmware:
+
+| Sensor | Parameter | Value Type | Value Type Code | Data Type |
+| -- | -- | -- | -- | -- |
+| BME688  | |  |  ||
+|  | Humidity | Humidity_F |  | float|
+| | Temperature C | TempC | | float|
+| | Pressure | Pressure_F | | float|
+| BME280 | ||||
+|| Humidity |Humidity_F | | float|
+|| Temperature F | TempF || float|
+|| Temperature C | TempC || float|
+|BMP384|||||
+|| Temperature C | TempC_D ||double|
+|| Presure (Pa)| Pressure_D || double|
+|BMP581|||||
+|| Pressure (Pa) | Pressure_F || float|
+|| Temperature C | TempC || float|
+|CCS811|||||
+|| CO2 | CO2_F || float|
+|| VOC| TVOC || float|
+|ENS160|||||
+|| Equivalent CO2 | CO2 || uint16|
+|| TVOC| VOC || unit16|
+||Ethanol Concentration | ETOH || uint16 |
+|| Air Quality Index | AQI || uint8 |
+|FS3000|||||
+|| Flow (MPS) | MPS || float|
+|| FLow (MPH) | MPH || float|
+|GNSS|||||
+|| Latitude in Degrees | Latitude || double|
+|| Longitude in Degrees| Longitude || double|
+|| Altitude (meters) | Altitude || double|
+|ISM330|||||
+|| Accelerometer X (milli-g)| AccelX || float|
+|| Accelerometer Y (milli-g)| AccelY || float|
+|| Accelerometer Z (milli-g)| AccelZ || float|
+|| Gyro X (milli-dps)| GyroX || float|
+|| Gyro Y (milli-dps)| GyroY || float|
+|| Gyro Z (milli-dps)| GyroZ || float|
+|LPS25HB|||||
+|| Pressure (hPa) | Pressure_F || float|
+|| Temperature C | TempC || float|
+|MAX17048|||||
+|| Voltage (V)| BatteryVoltage || float|
+|| State Of Charge (%) | BatteryCharge || float|
+|| Change Rate (%/hr) | BatteryChargeRate || float|
+|Micro Pressure|||||
+|| Pressure (Pa)| Pressure_F || float|
+|MS5637|||||
+|| Pressure (mBar) | Pressure_mBar || float|
+|| Temperature C | TempC || float|
+|NAU7802|||||
+|| Weight| WeightUserUnits|| float|
+|OPT4048|||||
+|| CIEx| CIE_X || double|
+|| CIEy | CIE_Y || double|
+|| CIET | CCT || double|
+

mkdocs.yml

@@ -249,6 +249,7 @@ extra_javascript:
 nav:
   - Getting Started:
     - Introduction: introduction.md
+  - Advanced:
     - Data Encoding: data_encoding.md
   - Support:
     - Troubleshooting: troubleshooting.md