Implement the rest of the IZAR protocol to read all the data contained in the frame.

Improves the whole code a bit in the process.

Author: ZeWaren

Diff for: ST-STEVAL-FKI868V1/EWARM/ST-STEVAL-FKI868V1.dep

@@ -14,13 +14,13 @@
     <StLinkDriver>
         <stlinkserialNo>0670FF495355878281223610</stlinkserialNo>
         <stlinkfoundProbes />
-        <stlinkResetStyle>4</stlinkResetStyle>
-        <stlinkResetStrategy>2</stlinkResetStrategy>
         <CStepIntDis>_ 0</CStepIntDis>
         <LeaveTargetRunning>_ 0</LeaveTargetRunning>
+        <stlinkResetStyle>0</stlinkResetStyle>
+        <stlinkResetStrategy>2</stlinkResetStrategy>
     </StLinkDriver>
     <DebugChecksum>
-        <Checksum>2347194289</Checksum>
+        <Checksum>2385112967</Checksum>
     </DebugChecksum>
     <Exceptions>
         <StopOnUncaught>_ 0</StopOnUncaught>
@@ -36,6 +36,12 @@
         <Fmt0>{W}1:A_Id	4	0</Fmt0>
         <Fmt1>{W}1:cRxData	3	0</Fmt1>
     </watch_formats>
+    <DisassembleMode>
+        <mode>0</mode>
+    </DisassembleMode>
+    <Breakpoints2>
+        <Count>0</Count>
+    </Breakpoints2>
     <TermIOLog>
         <LoggingEnabled>_ 0</LoggingEnabled>
         <LogFile>_ ""</LogFile>
@@ -45,20 +51,14 @@
         <LogFile>_ ""</LogFile>
         <Category>_ 0</Category>
     </LogFile>
+    <Aliases>
+        <Count>0</Count>
+        <SuppressDialog>0</SuppressDialog>
+    </Aliases>
     <CallStackLog>
         <Enabled>0</Enabled>
     </CallStackLog>
     <CallStackStripe>
         <ShowTiming>1</ShowTiming>
     </CallStackStripe>
-    <DisassembleMode>
-        <mode>0</mode>
-    </DisassembleMode>
-    <Breakpoints2>
-        <Count>0</Count>
-    </Breakpoints2>
-    <Aliases>
-        <Count>0</Count>
-        <SuppressDialog>0</SuppressDialog>
-    </Aliases>
 </settings>

Diff for: ST-STEVAL-FKI868V1/EWARM/settings/IZAR-PRIOS-ST-STEVAL-FKI868V1.wsdt

@@ -2,8 +2,43 @@
 #define __PRIOS_H
 
 #include <stdint.h>
+#include <stdbool.h>
 
-uint8_t decodePRIOSPayload(uint8_t *in, uint8_t payload_len, uint32_t key, uint8_t *out);
-uint8_t getMetricsFromPRIOSWMBusFrame(uint8_t *frame, uint32_t *total_consumption, uint32_t *last_month_total_consumption);
+/** Contains all the booleans required to store the alarms of a PRIOS device. */
+typedef struct _izar_alarms {
+    bool general_alarm;
+    bool leakage_currently;
+    bool leakage_previously;
+    bool meter_blocked;
+    bool back_flow;
+    bool underflow;
+    bool overflow;
+    bool submarine;
+    bool sensor_fraud_currently;
+    bool sensor_fraud_previously;
+    bool mechanical_fraud_currently;
+    bool mechanical_fraud_previously;
+} izar_alarms;
+
+/** Describe the various unit types we can encounter */
+typedef enum unit_type {UNKNOWN_UNIT, VOLUME_CUBIC_METER} unit_type_t;
+
+/** Can store everything a PRIOS frame can offer */
+typedef struct _izar_reading {
+    izar_alarms alarms;
+    uint8_t random_generator;
+    uint8_t radio_interval;
+    float remaining_battery_life;
+    unit_type_t unit_type;
+    float current_reading;
+    float h0_reading;
+    uint16_t h0_year;
+    uint8_t h0_month;
+    uint8_t h0_day;
+} izar_reading;
+
+void printIZARReadingAsCSV(const uint32_t A_Id, const izar_reading * const reading);
+uint8_t decodePRIOSPayload(const uint8_t * const in, const uint8_t payload_len, const uint32_t key, uint8_t *out);
+uint8_t getMetricsFromPRIOSWMBusFrame(const uint8_t * const frame, izar_reading * const reading);
 
 #endif

Diff for: ST-STEVAL-FKI868V1/EWARM/settings/ST-STEVAL-FKI868V1.dbgdt

@@ -1,6 +1,6 @@
 #ifndef __WMBUS_H
 #define __WMBUS_H
 
-uint8_t CheckWMBusFrame(uint8_t *frame, uint8_t len, uint8_t *LField, uint8_t *CField, uint16_t *Manufacturer, uint32_t *A_Id, uint8_t *A_Ver, uint8_t *A_Type);
+uint8_t CheckWMBusFrame(const uint8_t * const frame, const uint8_t len, uint8_t * const LField, uint8_t * const CField, uint16_t * const Manufacturer, uint32_t * const A_Id, uint8_t * const A_Ver, uint8_t * const A_Type);
 
 #endif

Diff for: ST-STEVAL-FKI868V1/EWARM/settings/ST-STEVAL-FKI868V1.dnx

@@ -5,8 +5,16 @@
   * @author         : Erwan Martin <[email protected]>
   ******************************************************************************
   */
+#include <math.h>
+#include <stdio.h>
+
 #include "PRIOS.h"
 
+const char * const unit_displays[] = {
+    [UNKNOWN_UNIT] = "banana",
+    [VOLUME_CUBIC_METER] = "m3",
+};
+    
 /* The default encryption keys of IZAR devices */
 uint8_t PRIOS_DEFAULT_KEY1[8] = {0x39, 0xBC, 0x8A, 0x10, 0xE6, 0x6D, 0x83, 0xF8};
 uint8_t PRIOS_DEFAULT_KEY2[8] = {0x51, 0x72, 0x89, 0x10, 0xE6, 0x6D, 0x83, 0xF8};
@@ -18,7 +26,7 @@ uint8_t PRIOS_DEFAULT_KEY2[8] = {0x51, 0x72, 0x89, 0x10, 0xE6, 0x6D, 0x83, 0xF8}
   * @param  int offset Offset from the start of the location.
   * @retval uint32_t
   */
-uint32_t read_uint32_le(uint8_t *data, int offset) {
+uint32_t read_uint32_le(const uint8_t * const data, int offset) {
     uint32_t result = *(data + offset + 3) << 24;
     result |= *(data + offset + 2) << 16;
     result |= *(data + offset + 1) << 8;
@@ -33,7 +41,7 @@ uint32_t read_uint32_le(uint8_t *data, int offset) {
   * @param  int offset Offset from the start of the location.
   * @retval uint32_t
   */
-uint32_t read_uint32_be(uint8_t *data, int offset) {
+uint32_t read_uint32_be(const uint8_t * const data, int offset) {
     uint32_t result = *(data + offset) << 24;
     result |= *(data + offset + 1) << 16;
     result |= *(data + offset + 2) << 8;
@@ -47,7 +55,7 @@ uint32_t read_uint32_be(uint8_t *data, int offset) {
   * @param  uint8_t *bytes Location of where to extract the key from.
   * @retval uint32_t
   */
-uint32_t preparePRIOSKey(uint8_t *bytes) {
+uint32_t preparePRIOSKey(const uint8_t * const bytes) {
     uint32_t key1 = read_uint32_be(bytes, 0);
     uint32_t key2 = read_uint32_be(bytes, 4);
     uint32_t key = key1 ^ key2;
@@ -68,7 +76,7 @@ uint32_t preparePRIOSKey(uint8_t *bytes) {
   * @param  uint8_t *out Buffer to store the decoded data
   * @retval uint8_t
   */
-uint8_t decodePRIOSPayload(uint8_t *in, uint8_t payload_len, uint32_t key, uint8_t *out) {
+uint8_t decodePRIOSPayload(const uint8_t * const in, const uint8_t payload_len, uint32_t key, uint8_t *out) {
     // modify seed key with header values
     key ^= read_uint32_be(in, 2); // manufacturer + address[0-1]
     key ^= read_uint32_be(in, 6); // address[2-3] + version + type
@@ -95,27 +103,105 @@ uint8_t decodePRIOSPayload(uint8_t *in, uint8_t payload_len, uint32_t key, uint8
 }
 
 /**
-  * @brief Get the water metrics from a decoded PRIOS payload.
-  * @param uint8_t *payload The location of the decoded PRIOS payload
-  * @param uint32_t *total_consumption Where to store the current total
-           consumption
-  * @param uint32_t *last_month_total_consumption Where to store last month's
-           consumption
-  */
-void getMetricsFromPriosPayload(uint8_t *payload, uint32_t *total_consumption, uint32_t *last_month_total_consumption) {
-    *total_consumption = read_uint32_le(payload, 1);
-    *last_month_total_consumption = read_uint32_le(payload, 5);
+ * @brief Extract the data from a PRIOS frame.
+ * @param uint8_t *header_data The start of the wmbus frame application data.
+ * @param uint8_t *decoded_data The data that was decrypted from the frame.
+ * @param izar_reading *reading Where to store the extracted data.
+ */
+void parsePRIOSFrame(const uint8_t * const header_data, const uint8_t * const decoded_data, izar_reading * const reading) {
+    // Extract the header values:
+    reading->radio_interval = 1 << ((header_data[0] & 0x0F) + 2);
+    reading->random_generator = (header_data[0] >> 4) & 0x3;
+
+    // Extract the battery remaining life:
+    reading->remaining_battery_life = (header_data[1] & 0x1F) / 2.0;
+
+    // Read the alarms:
+    reading->alarms.general_alarm = header_data[0] >> 7;
+    reading->alarms.leakage_currently = header_data[1] >> 7;
+    reading->alarms.leakage_previously = header_data[1] >> 6 & 0x1;
+    reading->alarms.meter_blocked = header_data[1] >> 5 & 0x1;
+    reading->alarms.back_flow = header_data[2] >> 7;
+    reading->alarms.underflow = header_data[2] >> 6 & 0x1;
+    reading->alarms.overflow = header_data[2] >> 5 & 0x1;
+    reading->alarms.submarine = header_data[2] >> 4 & 0x1;
+    reading->alarms.sensor_fraud_currently = header_data[2] >> 3 & 0x1;
+    reading->alarms.sensor_fraud_previously = header_data[2] >> 2 & 0x1;
+    reading->alarms.mechanical_fraud_currently = header_data[2] >> 1 & 0x1;
+    reading->alarms.mechanical_fraud_previously = header_data[2] & 0x1;
+
+    // Read the readings:
+    reading->current_reading = read_uint32_le(decoded_data, 1);
+    reading->h0_reading = read_uint32_le(decoded_data, 5);
+
+    // Apply the multiplier to the values:
+    int8_t multiplier_exponent = (header_data[3] & 0x07) - 6;
+    if (multiplier_exponent > 0) {
+        reading->current_reading *= pow(10, multiplier_exponent);
+        reading->h0_reading *= pow(10, multiplier_exponent);
+    } else if (multiplier_exponent < 0) {
+        reading->current_reading /= pow(10, -multiplier_exponent);
+        reading->h0_reading /= pow(10, -multiplier_exponent);
+    }
+
+    // Extract the measurement unit:
+    uint8_t unit_type = header_data[3] >> 3;
+    if (unit_type == 0x02) {
+        reading->unit_type = VOLUME_CUBIC_METER;
+    } else {
+        reading->unit_type = UNKNOWN_UNIT;
+    }
+
+    // Extract the date:
+    reading->h0_year = ((decoded_data[10] & 0xF0) >> 1) + ((decoded_data[9] & 0xE0) >> 5);
+    if (reading->h0_year > 80) {
+        reading->h0_year += 1900;
+    } else {
+        reading->h0_year += 2000;
+    }
+    reading->h0_month = decoded_data[10] & 0xF;
+    reading->h0_day = decoded_data[9] & 0x1F;
+}
+
+/**
+ * @brief Print an entire IZAR reading to the standard output device, as CSV data.
+ * @param uint32_t A_Id The identifier of the device the reading was from.
+ * @param izar_reading *reading The reading to print
+ */
+void printIZARReadingAsCSV(const uint32_t A_Id, const izar_reading * const reading) {
+    printf(
+        "%.6x,%f,%f,%s,%.2d,%.2d,%.2d,%.1f,%d,%d,%d,%d,%d,%d,%d,%d,%d,%d,%d,%d,%d,%d\r\n",
+        A_Id,
+        reading->current_reading,
+        reading->h0_reading,
+        unit_displays[reading->unit_type],
+        reading->h0_year,
+        reading->h0_month,
+        reading->h0_day,
+        reading->remaining_battery_life,
+        reading->radio_interval,
+        reading->random_generator,
+        reading->alarms.general_alarm,
+        reading->alarms.leakage_currently,
+        reading->alarms.leakage_previously,
+        reading->alarms.meter_blocked,
+        reading->alarms.back_flow,
+        reading->alarms.underflow,
+        reading->alarms.overflow,
+        reading->alarms.submarine,
+        reading->alarms.sensor_fraud_currently,
+        reading->alarms.sensor_fraud_previously,
+        reading->alarms.mechanical_fraud_currently,
+        reading->alarms.mechanical_fraud_previously
+    );
 }
 
 /**
   * @brief Get the water metrics from a WMBus Prios frame.
   * @param uint8_t *payload The location of the WMBus frame
-  * @param uint32_t *total_consumption Where to store the current total
-           consumption
-  * @param uint32_t *last_month_total_consumption Where to store last month's
-           consumption
+  * @param izar_reading *reading Where to store the extracted data
   */
-uint8_t getMetricsFromPRIOSWMBusFrame(uint8_t *frame, uint32_t *total_consumption, uint32_t *last_month_total_consumption) {
+uint8_t getMetricsFromPRIOSWMBusFrame(const uint8_t * const frame, izar_reading * const reading) {
     /* Decode the payload */
     uint32_t key = preparePRIOSKey(PRIOS_DEFAULT_KEY1);
     uint8_t decodedPayload[32];
@@ -124,7 +210,9 @@ uint8_t getMetricsFromPRIOSWMBusFrame(uint8_t *frame, uint32_t *total_consumptio
           return 0;
     }
 
-    /* Get the data from the decoded payload */
-    getMetricsFromPriosPayload(decodedPayload, total_consumption, last_month_total_consumption);
+    /* Extract the data from the frame and the decoded data: */
+    parsePRIOSFrame(frame + 13, decodedPayload, reading);
+
+    /* Return: */
     return 1;
 }

Diff for: ST-STEVAL-FKI868V1/Inc/PRIOS.h

@@ -80,13 +80,13 @@ void S2LP_HandleGPIOInterrupt() {
 
         /* The frame is an IZAR meter reporting data, let's handle it */
         if (LField == 0x19 && CField == 0x44 && MField == 0x4C30 && A_Ver == 0xD4 && A_Type == 0x01) {
-            uint32_t total_consumption, last_month_total_consumption;
-            if (!getMetricsFromPRIOSWMBusFrame(s2lpRxData, &total_consumption, &last_month_total_consumption)) {
+            izar_reading reading;
+            if (!getMetricsFromPRIOSWMBusFrame(s2lpRxData, &reading)) {
                 return;
             }
 
             /* Output the data on the COM port */
-            printf("%.6x,%u,%u\r\n", A_Id, total_consumption, last_month_total_consumption);
+            printIZARReadingAsCSV(A_Id, &reading);
         }
     }
 }

Diff for: ST-STEVAL-FKI868V1/Inc/WMBus.h

@@ -48,7 +48,7 @@ uint16_t crcCalc(uint16_t crcReg, uint8_t crcData) {
 *       LINK_STATUS_INVALID_SIZE   - The data-field buffer is too large
 *
 */
-uint8_t CRCCheck(uint8_t *pStart, uint8_t *pStop) {
+uint8_t CRCCheck(const uint8_t * pStart, const uint8_t * const pStop) {
   uint16_t  seed=0x0000;
 
   while (pStart != pStop) {
@@ -75,7 +75,7 @@ uint8_t CRCCheck(uint8_t *pStart, uint8_t *pStop) {
   * @param uint8_t *A_Type Where to store the type part of the A-field
   * @retval uint8_t 1 if the frame is valid, 0 otherwise
   */
-uint8_t CheckWMBusFrame(uint8_t *frame, uint8_t len, uint8_t *LField, uint8_t *CField, uint16_t *MField, uint32_t *A_Id, uint8_t *A_Ver, uint8_t *A_Type) {
+uint8_t CheckWMBusFrame(const uint8_t *frame, const uint8_t len, uint8_t * const LField, uint8_t * const CField, uint16_t * const MField, uint32_t * const A_Id, uint8_t * const A_Ver, uint8_t * const A_Type) {
     if (len < 13) {
         /* The frame is too short to be what we want */
         return 0;
@@ -96,7 +96,7 @@ uint8_t CheckWMBusFrame(uint8_t *frame, uint8_t len, uint8_t *LField, uint8_t *C
     }
 
     if((len-12)%18!=0) {
-        crc &= CRCCheck(&frame[len-((len-12)%18)],&frame[len-2]);
+        crc &= CRCCheck(&frame[len-((len-12)%18)], &frame[len-2]);
         if (!crc) {
             return 0;
         }