[FL-2934] WS: add protocol Acurite 592TXR (#1916)

* WS: add protocol Acurite 592TXR
* WS: fix decoder Acurite_592TXR
* SubGhz: proper types in math

Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>

applications/plugins/weather_station/helpers/weather_station_types.h

@@ -3,7 +3,7 @@
 #include <furi.h>
 #include <furi_hal.h>
 
-#define WS_VERSION_APP "0.2"
+#define WS_VERSION_APP "0.3"
 #define WS_DEVELOPED "SkorP"
 #define WS_GITHUB "https://github.com/flipperdevices/flipperzero-firmware"
 

applications/plugins/weather_station/protocols/acurite_592txr.c

@@ -0,0 +1,307 @@
+#include "acurite_592txr.h"
+
+#define TAG "WSProtocolAcurite_592TXR"
+
+/*
+ * Help
+ * https://github.com/merbanan/rtl_433/blob/5bef4e43133ac4c0e2d18d36f87c52b4f9458453/src/devices/acurite.c
+ * 
+ * Acurite 592TXR Temperature Humidity sensor decoder
+ * Message Type 0x04, 7 bytes
+ * | Byte 0    | Byte 1    | Byte 2    | Byte 3    | Byte 4    | Byte 5    | Byte 6    |
+ * | --------- | --------- | --------- | --------- | --------- | --------- | --------- |
+ * | CCII IIII | IIII IIII | pB00 0100 | pHHH HHHH | p??T TTTT | pTTT TTTT | KKKK KKKK |
+ * - C: Channel 00: C, 10: B, 11: A, (01 is invalid)
+ * - I: Device ID (14 bits)
+ * - B: Battery, 1 is battery OK, 0 is battery low
+ * - M: Message type (6 bits), 0x04
+ * - T: Temperature Celsius (11 - 14 bits?), + 1000 * 10
+ * - H: Relative Humidity (%) (7 bits)
+ * - K: Checksum (8 bits)
+ * - p: Parity bit
+ * Notes:
+ * - Temperature
+ *   - Encoded as Celsius + 1000 * 10
+ *   - only 11 bits needed for specified range -40 C to 70 C (-40 F - 158 F)
+ *   - However 14 bits available for temperature, giving possible range of -100 C to 1538.4 C
+ *   - @todo - check if high 3 bits ever used for anything else
+ * 
+ */
+
+static const SubGhzBlockConst ws_protocol_acurite_592txr_const = {
+    .te_short = 200,
+    .te_long = 400,
+    .te_delta = 90,
+    .min_count_bit_for_found = 56,
+};
+
+struct WSProtocolDecoderAcurite_592TXR {
+    SubGhzProtocolDecoderBase base;
+
+    SubGhzBlockDecoder decoder;
+    WSBlockGeneric generic;
+
+    uint16_t header_count;
+};
+
+struct WSProtocolEncoderAcurite_592TXR {
+    SubGhzProtocolEncoderBase base;
+
+    SubGhzProtocolBlockEncoder encoder;
+    WSBlockGeneric generic;
+};
+
+typedef enum {
+    Acurite_592TXRDecoderStepReset = 0,
+    Acurite_592TXRDecoderStepCheckPreambule,
+    Acurite_592TXRDecoderStepSaveDuration,
+    Acurite_592TXRDecoderStepCheckDuration,
+} Acurite_592TXRDecoderStep;
+
+const SubGhzProtocolDecoder ws_protocol_acurite_592txr_decoder = {
+    .alloc = ws_protocol_decoder_acurite_592txr_alloc,
+    .free = ws_protocol_decoder_acurite_592txr_free,
+
+    .feed = ws_protocol_decoder_acurite_592txr_feed,
+    .reset = ws_protocol_decoder_acurite_592txr_reset,
+
+    .get_hash_data = ws_protocol_decoder_acurite_592txr_get_hash_data,
+    .serialize = ws_protocol_decoder_acurite_592txr_serialize,
+    .deserialize = ws_protocol_decoder_acurite_592txr_deserialize,
+    .get_string = ws_protocol_decoder_acurite_592txr_get_string,
+};
+
+const SubGhzProtocolEncoder ws_protocol_acurite_592txr_encoder = {
+    .alloc = NULL,
+    .free = NULL,
+
+    .deserialize = NULL,
+    .stop = NULL,
+    .yield = NULL,
+};
+
+const SubGhzProtocol ws_protocol_acurite_592txr = {
+    .name = WS_PROTOCOL_ACURITE_592TXR_NAME,
+    .type = SubGhzProtocolWeatherStation,
+    .flag = SubGhzProtocolFlag_433 | SubGhzProtocolFlag_315 | SubGhzProtocolFlag_868 |
+            SubGhzProtocolFlag_AM | SubGhzProtocolFlag_Decodable,
+
+    .decoder = &ws_protocol_acurite_592txr_decoder,
+    .encoder = &ws_protocol_acurite_592txr_encoder,
+};
+
+void* ws_protocol_decoder_acurite_592txr_alloc(SubGhzEnvironment* environment) {
+    UNUSED(environment);
+    WSProtocolDecoderAcurite_592TXR* instance = malloc(sizeof(WSProtocolDecoderAcurite_592TXR));
+    instance->base.protocol = &ws_protocol_acurite_592txr;
+    instance->generic.protocol_name = instance->base.protocol->name;
+    return instance;
+}
+
+void ws_protocol_decoder_acurite_592txr_free(void* context) {
+    furi_assert(context);
+    WSProtocolDecoderAcurite_592TXR* instance = context;
+    free(instance);
+}
+
+void ws_protocol_decoder_acurite_592txr_reset(void* context) {
+    furi_assert(context);
+    WSProtocolDecoderAcurite_592TXR* instance = context;
+    instance->decoder.parser_step = Acurite_592TXRDecoderStepReset;
+}
+
+static bool ws_protocol_acurite_592txr_check_crc(WSProtocolDecoderAcurite_592TXR* instance) {
+    uint8_t msg[] = {
+        instance->decoder.decode_data >> 48,
+        instance->decoder.decode_data >> 40,
+        instance->decoder.decode_data >> 32,
+        instance->decoder.decode_data >> 24,
+        instance->decoder.decode_data >> 16,
+        instance->decoder.decode_data >> 8};
+
+    if((subghz_protocol_blocks_add_bytes(msg, 6) ==
+        (uint8_t)(instance->decoder.decode_data & 0xFF)) &&
+       (!subghz_protocol_blocks_parity_bytes(&msg[2], 4))) {
+        return true;
+    } else {
+        return false;
+    }
+}
+
+/**
+ * Analysis of received data
+ * @param instance Pointer to a WSBlockGeneric* instance
+ */
+static void ws_protocol_acurite_592txr_remote_controller(WSBlockGeneric* instance) {
+    uint8_t channel[] = {3, 0, 2, 1};
+    uint8_t channel_raw = ((instance->data >> 54) & 0x03);
+    instance->channel = channel[channel_raw];
+    instance->id = (instance->data >> 40) & 0x3FFF;
+    instance->battery_low = !((instance->data >> 38) & 1);
+    instance->humidity = (instance->data >> 24) & 0x7F;
+
+    uint16_t temp_raw = ((instance->data >> 9) & 0xF80) | ((instance->data >> 8) & 0x7F);
+    instance->temp = ((float)(temp_raw)-1000) / 10.0f;
+
+    instance->btn = WS_NO_BTN;
+}
+
+void ws_protocol_decoder_acurite_592txr_feed(void* context, bool level, uint32_t duration) {
+    furi_assert(context);
+    WSProtocolDecoderAcurite_592TXR* instance = context;
+
+    switch(instance->decoder.parser_step) {
+    case Acurite_592TXRDecoderStepReset:
+        if((level) && (DURATION_DIFF(duration, ws_protocol_acurite_592txr_const.te_short * 3) <
+                       ws_protocol_acurite_592txr_const.te_delta * 2)) {
+            instance->decoder.parser_step = Acurite_592TXRDecoderStepCheckPreambule;
+            instance->decoder.te_last = duration;
+            instance->header_count = 0;
+        }
+        break;
+
+    case Acurite_592TXRDecoderStepCheckPreambule:
+        if(level) {
+            instance->decoder.te_last = duration;
+        } else {
+            if((DURATION_DIFF(
+                    instance->decoder.te_last, ws_protocol_acurite_592txr_const.te_short * 3) <
+                ws_protocol_acurite_592txr_const.te_delta * 2) &&
+               (DURATION_DIFF(duration, ws_protocol_acurite_592txr_const.te_short * 3) <
+                ws_protocol_acurite_592txr_const.te_delta * 2)) {
+                //Found preambule
+                instance->header_count++;
+            } else if((instance->header_count > 2) && (instance->header_count < 5)) {
+                if((DURATION_DIFF(
+                        instance->decoder.te_last, ws_protocol_acurite_592txr_const.te_short) <
+                    ws_protocol_acurite_592txr_const.te_delta) &&
+                   (DURATION_DIFF(duration, ws_protocol_acurite_592txr_const.te_long) <
+                    ws_protocol_acurite_592txr_const.te_delta)) {
+                    instance->decoder.decode_data = 0;
+                    instance->decoder.decode_count_bit = 0;
+                    subghz_protocol_blocks_add_bit(&instance->decoder, 0);
+                    instance->decoder.parser_step = Acurite_592TXRDecoderStepSaveDuration;
+                } else if(
+                    (DURATION_DIFF(
+                         instance->decoder.te_last, ws_protocol_acurite_592txr_const.te_long) <
+                     ws_protocol_acurite_592txr_const.te_delta) &&
+                    (DURATION_DIFF(duration, ws_protocol_acurite_592txr_const.te_short) <
+                     ws_protocol_acurite_592txr_const.te_delta)) {
+                    instance->decoder.decode_data = 0;
+                    instance->decoder.decode_count_bit = 0;
+                    subghz_protocol_blocks_add_bit(&instance->decoder, 1);
+                    instance->decoder.parser_step = Acurite_592TXRDecoderStepSaveDuration;
+                } else {
+                    instance->decoder.parser_step = Acurite_592TXRDecoderStepReset;
+                }
+            } else {
+                instance->decoder.parser_step = Acurite_592TXRDecoderStepReset;
+            }
+        }
+        break;
+
+    case Acurite_592TXRDecoderStepSaveDuration:
+        if(level) {
+            instance->decoder.te_last = duration;
+            instance->decoder.parser_step = Acurite_592TXRDecoderStepCheckDuration;
+        } else {
+            instance->decoder.parser_step = Acurite_592TXRDecoderStepReset;
+        }
+        break;
+
+    case Acurite_592TXRDecoderStepCheckDuration:
+        if(!level) {
+            if(duration >= ((uint32_t)ws_protocol_acurite_592txr_const.te_short * 5)) {
+                if((instance->decoder.decode_count_bit ==
+                    ws_protocol_acurite_592txr_const.min_count_bit_for_found) &&
+                   ws_protocol_acurite_592txr_check_crc(instance)) {
+                    instance->generic.data = instance->decoder.decode_data;
+                    instance->generic.data_count_bit = instance->decoder.decode_count_bit;
+                    ws_protocol_acurite_592txr_remote_controller(&instance->generic);
+                    if(instance->base.callback)
+                        instance->base.callback(&instance->base, instance->base.context);
+                }
+                instance->decoder.decode_data = 0;
+                instance->decoder.decode_count_bit = 0;
+                instance->decoder.parser_step = Acurite_592TXRDecoderStepReset;
+                break;
+            } else if(
+                (DURATION_DIFF(
+                     instance->decoder.te_last, ws_protocol_acurite_592txr_const.te_short) <
+                 ws_protocol_acurite_592txr_const.te_delta) &&
+                (DURATION_DIFF(duration, ws_protocol_acurite_592txr_const.te_long) <
+                 ws_protocol_acurite_592txr_const.te_delta)) {
+                subghz_protocol_blocks_add_bit(&instance->decoder, 0);
+                instance->decoder.parser_step = Acurite_592TXRDecoderStepSaveDuration;
+            } else if(
+                (DURATION_DIFF(
+                     instance->decoder.te_last, ws_protocol_acurite_592txr_const.te_long) <
+                 ws_protocol_acurite_592txr_const.te_delta) &&
+                (DURATION_DIFF(duration, ws_protocol_acurite_592txr_const.te_short) <
+                 ws_protocol_acurite_592txr_const.te_delta)) {
+                subghz_protocol_blocks_add_bit(&instance->decoder, 1);
+                instance->decoder.parser_step = Acurite_592TXRDecoderStepSaveDuration;
+            } else {
+                instance->decoder.parser_step = Acurite_592TXRDecoderStepReset;
+            }
+        } else {
+            instance->decoder.parser_step = Acurite_592TXRDecoderStepReset;
+        }
+        break;
+    }
+}
+
+uint8_t ws_protocol_decoder_acurite_592txr_get_hash_data(void* context) {
+    furi_assert(context);
+    WSProtocolDecoderAcurite_592TXR* instance = context;
+    return subghz_protocol_blocks_get_hash_data(
+        &instance->decoder, (instance->decoder.decode_count_bit / 8) + 1);
+}
+
+bool ws_protocol_decoder_acurite_592txr_serialize(
+    void* context,
+    FlipperFormat* flipper_format,
+    SubGhzRadioPreset* preset) {
+    furi_assert(context);
+    WSProtocolDecoderAcurite_592TXR* instance = context;
+    return ws_block_generic_serialize(&instance->generic, flipper_format, preset);
+}
+
+bool ws_protocol_decoder_acurite_592txr_deserialize(void* context, FlipperFormat* flipper_format) {
+    furi_assert(context);
+    WSProtocolDecoderAcurite_592TXR* instance = context;
+    bool ret = false;
+    do {
+        if(!ws_block_generic_deserialize(&instance->generic, flipper_format)) {
+            break;
+        }
+        if(instance->generic.data_count_bit !=
+           ws_protocol_acurite_592txr_const.min_count_bit_for_found) {
+            FURI_LOG_E(TAG, "Wrong number of bits in key");
+            break;
+        }
+        ret = true;
+    } while(false);
+    return ret;
+}
+
+void ws_protocol_decoder_acurite_592txr_get_string(void* context, FuriString* output) {
+    furi_assert(context);
+    WSProtocolDecoderAcurite_592TXR* instance = context;
+    furi_string_printf(
+        output,
+        "%s %dbit\r\n"
+        "Key:0x%lX%08lX\r\n"
+        "Sn:0x%lX Ch:%d  Bat:%d\r\n"
+        "Temp:%d.%d C Hum:%d%%",
+        instance->generic.protocol_name,
+        instance->generic.data_count_bit,
+        (uint32_t)(instance->generic.data >> 32),
+        (uint32_t)(instance->generic.data),
+        instance->generic.id,
+        instance->generic.channel,
+        instance->generic.battery_low,
+        (int16_t)instance->generic.temp,
+        abs(((int16_t)(instance->generic.temp * 10) - (((int16_t)instance->generic.temp) * 10))),
+        instance->generic.humidity);
+}

applications/plugins/weather_station/protocols/acurite_592txr.h

@@ -0,0 +1,79 @@
+#pragma once
+
+#include <lib/subghz/protocols/base.h>
+
+#include <lib/subghz/blocks/const.h>
+#include <lib/subghz/blocks/decoder.h>
+#include <lib/subghz/blocks/encoder.h>
+#include "ws_generic.h"
+#include <lib/subghz/blocks/math.h>
+
+#define WS_PROTOCOL_ACURITE_592TXR_NAME "Acurite 592TXR"
+
+typedef struct WSProtocolDecoderAcurite_592TXR WSProtocolDecoderAcurite_592TXR;
+typedef struct WSProtocolEncoderAcurite_592TXR WSProtocolEncoderAcurite_592TXR;
+
+extern const SubGhzProtocolDecoder ws_protocol_acurite_592txr_decoder;
+extern const SubGhzProtocolEncoder ws_protocol_acurite_592txr_encoder;
+extern const SubGhzProtocol ws_protocol_acurite_592txr;
+
+/**
+ * Allocate WSProtocolDecoderAcurite_592TXR.
+ * @param environment Pointer to a SubGhzEnvironment instance
+ * @return WSProtocolDecoderAcurite_592TXR* pointer to a WSProtocolDecoderAcurite_592TXR instance
+ */
+void* ws_protocol_decoder_acurite_592txr_alloc(SubGhzEnvironment* environment);
+
+/**
+ * Free WSProtocolDecoderAcurite_592TXR.
+ * @param context Pointer to a WSProtocolDecoderAcurite_592TXR instance
+ */
+void ws_protocol_decoder_acurite_592txr_free(void* context);
+
+/**
+ * Reset decoder WSProtocolDecoderAcurite_592TXR.
+ * @param context Pointer to a WSProtocolDecoderAcurite_592TXR instance
+ */
+void ws_protocol_decoder_acurite_592txr_reset(void* context);
+
+/**
+ * Parse a raw sequence of levels and durations received from the air.
+ * @param context Pointer to a WSProtocolDecoderAcurite_592TXR instance
+ * @param level Signal level true-high false-low
+ * @param duration Duration of this level in, us
+ */
+void ws_protocol_decoder_acurite_592txr_feed(void* context, bool level, uint32_t duration);
+
+/**
+ * Getting the hash sum of the last randomly received parcel.
+ * @param context Pointer to a WSProtocolDecoderAcurite_592TXR instance
+ * @return hash Hash sum
+ */
+uint8_t ws_protocol_decoder_acurite_592txr_get_hash_data(void* context);
+
+/**
+ * Serialize data WSProtocolDecoderAcurite_592TXR.
+ * @param context Pointer to a WSProtocolDecoderAcurite_592TXR instance
+ * @param flipper_format Pointer to a FlipperFormat instance
+ * @param preset The modulation on which the signal was received, SubGhzRadioPreset
+ * @return true On success
+ */
+bool ws_protocol_decoder_acurite_592txr_serialize(
+    void* context,
+    FlipperFormat* flipper_format,
+    SubGhzRadioPreset* preset);
+
+/**
+ * Deserialize data WSProtocolDecoderAcurite_592TXR.
+ * @param context Pointer to a WSProtocolDecoderAcurite_592TXR instance
+ * @param flipper_format Pointer to a FlipperFormat instance
+ * @return true On success
+ */
+bool ws_protocol_decoder_acurite_592txr_deserialize(void* context, FlipperFormat* flipper_format);
+
+/**
+ * Getting a textual representation of the received data.
+ * @param context Pointer to a WSProtocolDecoderAcurite_592TXR instance
+ * @param output Resulting text
+ */
+void ws_protocol_decoder_acurite_592txr_get_string(void* context, FuriString* output);

applications/plugins/weather_station/protocols/protocol_items.c

@@ -8,6 +8,7 @@ const SubGhzProtocol* weather_station_protocol_registry_items[] = {
     &ws_protocol_acurite_606tx,
     &ws_protocol_lacrosse_tx141thbv2,
     &ws_protocol_oregon2,
+    &ws_protocol_acurite_592txr,
 };
 
 const SubGhzProtocolRegistry weather_station_protocol_registry = {

applications/plugins/weather_station/protocols/protocol_items.h

@@ -8,5 +8,6 @@
 #include "acurite_606tx.h"
 #include "lacrosse_tx141thbv2.h"
 #include "oregon2.h"
+#include "acurite_592txr.h"
 
 extern const SubGhzProtocolRegistry weather_station_protocol_registry;

firmware/targets/f7/api_symbols.csv

@@ -1,5 +1,5 @@
 entry,status,name,type,params
-Version,+,5.0,,
+Version,+,5.1,,
 Header,+,applications/services/bt/bt_service/bt.h,,
 Header,+,applications/services/cli/cli.h,,
 Header,+,applications/services/cli/cli_vcp.h,,
@@ -2271,6 +2271,7 @@ Function,-,subghz_keystore_raw_encrypted_save,_Bool,"const char*, const char*, u
 Function,-,subghz_keystore_raw_get_data,_Bool,"const char*, size_t, uint8_t*, size_t"
 Function,-,subghz_keystore_save,_Bool,"SubGhzKeystore*, const char*, uint8_t*"
 Function,+,subghz_protocol_blocks_add_bit,void,"SubGhzBlockDecoder*, uint8_t"
+Function,+,subghz_protocol_blocks_add_bytes,uint8_t,"const uint8_t[], size_t"
 Function,+,subghz_protocol_blocks_crc16,uint16_t,"const uint8_t[], unsigned, uint16_t, uint16_t"
 Function,+,subghz_protocol_blocks_crc16lsb,uint16_t,"const uint8_t[], unsigned, uint16_t, uint16_t"
 Function,+,subghz_protocol_blocks_crc4,uint8_t,"const uint8_t[], unsigned, uint8_t, uint8_t"
@@ -2284,8 +2285,11 @@ Function,+,subghz_protocol_blocks_get_upload,size_t,"uint8_t[], size_t, LevelDur
 Function,+,subghz_protocol_blocks_lfsr_digest16,uint16_t,"const uint8_t[], unsigned, uint16_t, uint16_t"
 Function,+,subghz_protocol_blocks_lfsr_digest8,uint8_t,"const uint8_t[], unsigned, uint8_t, uint8_t"
 Function,+,subghz_protocol_blocks_lfsr_digest8_reflect,uint8_t,"const uint8_t[], int, uint8_t, uint8_t"
+Function,+,subghz_protocol_blocks_parity8,int,uint8_t
+Function,+,subghz_protocol_blocks_parity_bytes,int,"const uint8_t[], size_t"
 Function,+,subghz_protocol_blocks_reverse_key,uint64_t,"uint64_t, uint8_t"
 Function,+,subghz_protocol_blocks_set_bit_array,void,"_Bool, uint8_t[], size_t, size_t"
+Function,+,subghz_protocol_blocks_xor_bytes,uint8_t,"const uint8_t[], size_t"
 Function,-,subghz_protocol_decoder_base_deserialize,_Bool,"SubGhzProtocolDecoderBase*, FlipperFormat*"
 Function,+,subghz_protocol_decoder_base_get_hash_data,uint8_t,SubGhzProtocolDecoderBase*
 Function,+,subghz_protocol_decoder_base_get_string,_Bool,"SubGhzProtocolDecoderBase*, FuriString*"

lib/subghz/blocks/math.c

@@ -217,3 +217,33 @@ uint16_t subghz_protocol_blocks_lfsr_digest16(
     }
     return sum;
 }
+
+uint8_t subghz_protocol_blocks_add_bytes(uint8_t const message[], size_t num_bytes) {
+    int result = 0;
+    for(size_t i = 0; i < num_bytes; ++i) {
+        result += message[i];
+    }
+    return (uint8_t)result;
+}
+
+int subghz_protocol_blocks_parity8(uint8_t byte) {
+    byte ^= byte >> 4;
+    byte &= 0xf;
+    return (0x6996 >> byte) & 1;
+}
+
+int subghz_protocol_blocks_parity_bytes(uint8_t const message[], size_t num_bytes) {
+    int result = 0;
+    for(size_t i = 0; i < num_bytes; ++i) {
+        result ^= subghz_protocol_blocks_parity8(message[i]);
+    }
+    return result;
+}
+
+uint8_t subghz_protocol_blocks_xor_bytes(uint8_t const message[], size_t num_bytes) {
+    uint8_t result = 0;
+    for(size_t i = 0; i < num_bytes; ++i) {
+        result ^= message[i];
+    }
+    return result;
+}

lib/subghz/blocks/math.h

@@ -161,6 +161,37 @@ uint16_t subghz_protocol_blocks_lfsr_digest16(
     uint16_t gen,
     uint16_t key);
 
+/**
+ *  Compute Addition of a number of bytes.
+ *  @param message bytes of message data
+ *  @param num_bytes number of bytes to sum
+ *  @return summation value
+ **/
+uint8_t subghz_protocol_blocks_add_bytes(uint8_t const message[], size_t num_bytes);
+
+/**
+ *  Compute bit parity of a single byte (8 bits).
+ *  @param byte single byte to check
+ *  @return 1 odd parity, 0 even parity
+ **/
+int subghz_protocol_blocks_parity8(uint8_t byte);
+
+/**
+ *  Compute bit parity of a number of bytes.
+ *  @param message bytes of message data
+ *  @param num_bytes number of bytes to sum
+ *  @return 1 odd parity, 0 even parity
+ **/
+int subghz_protocol_blocks_parity_bytes(uint8_t const message[], size_t num_bytes);
+
+/**
+ *  Compute XOR (byte-wide parity) of a number of bytes.
+ *  @param message bytes of message data
+ *  @param num_bytes number of bytes to sum
+ *  @return summation value, per bit-position 1 odd parity, 0 even parity
+ **/
+uint8_t subghz_protocol_blocks_xor_bytes(uint8_t const message[], size_t num_bytes);
+
 #ifdef __cplusplus
 }
 #endif