[FL-2976] SubGhz: add protocol "Ansonic" (#2000)

* SubGhz: add protocol "Ansonic"
* SubGhz: fix encoder "Ansonic"
* SubGhz: add unit_test "Ansonic"
* SubGhz: fix flag
* SubGhz: protocol "Ansonic" fix timing

Co-authored-by: あく <alleteam@gmail.com>

applications/debug/unit_tests/subghz/subghz_test.c

@@ -13,7 +13,7 @@
 #define CAME_ATOMO_DIR_NAME EXT_PATH("subghz/assets/came_atomo")
 #define NICE_FLOR_S_DIR_NAME EXT_PATH("subghz/assets/nice_flor_s")
 #define TEST_RANDOM_DIR_NAME EXT_PATH("unit_tests/subghz/test_random_raw.sub")
-#define TEST_RANDOM_COUNT_PARSE 232
+#define TEST_RANDOM_COUNT_PARSE 244
 #define TEST_TIMEOUT 10000
 
 static SubGhzEnvironment* environment_handler;
@@ -437,6 +437,13 @@ MU_TEST(subghz_decoder_clemsa_test) {
         "Test decoder " SUBGHZ_PROTOCOL_CLEMSA_NAME " error\r\n");
 }
 
+MU_TEST(subghz_decoder_ansonic_test) {
+    mu_assert(
+        subghz_decoder_test(
+            EXT_PATH("unit_tests/subghz/ansonic_raw.sub"), SUBGHZ_PROTOCOL_ANSONIC_NAME),
+        "Test decoder " SUBGHZ_PROTOCOL_ANSONIC_NAME " error\r\n");
+}
+
 //test encoders
 MU_TEST(subghz_encoder_princeton_test) {
     mu_assert(
@@ -558,6 +565,12 @@ MU_TEST(subghz_encoder_clemsa_test) {
         "Test encoder " SUBGHZ_PROTOCOL_CLEMSA_NAME " error\r\n");
 }
 
+MU_TEST(subghz_encoder_ansonic_test) {
+    mu_assert(
+        subghz_encoder_test(EXT_PATH("unit_tests/subghz/ansonic.sub")),
+        "Test encoder " SUBGHZ_PROTOCOL_ANSONIC_NAME " error\r\n");
+}
+
 MU_TEST(subghz_random_test) {
     mu_assert(subghz_decode_random_test(TEST_RANDOM_DIR_NAME), "Random test error\r\n");
 }
@@ -598,6 +611,7 @@ MU_TEST_SUITE(subghz) {
     MU_RUN_TEST(subghz_decoder_magellan_test);
     MU_RUN_TEST(subghz_decoder_intertechno_v3_test);
     MU_RUN_TEST(subghz_decoder_clemsa_test);
+    MU_RUN_TEST(subghz_decoder_ansonic_test);
 
     MU_RUN_TEST(subghz_encoder_princeton_test);
     MU_RUN_TEST(subghz_encoder_came_test);
@@ -619,6 +633,7 @@ MU_TEST_SUITE(subghz) {
     MU_RUN_TEST(subghz_encoder_magellan_test);
     MU_RUN_TEST(subghz_encoder_intertechno_v3_test);
     MU_RUN_TEST(subghz_encoder_clemsa_test);
+    MU_RUN_TEST(subghz_encoder_ansonic_test);
 
     MU_RUN_TEST(subghz_random_test);
     subghz_test_deinit();

assets/unit_tests/subghz/ansonic.sub

@@ -0,0 +1,7 @@
+Filetype: Flipper SubGhz Key File
+Version: 1
+Frequency: 433920000
+Preset: FuriHalSubGhzPresetOok650Async
+Protocol: Ansonic
+Bit: 12
+Key: 00 00 00 00 00 00 05 5A

lib/subghz/protocols/ansonic.c

@@ -0,0 +1,346 @@
+#include "ansonic.h"
+#include "../blocks/const.h"
+#include "../blocks/decoder.h"
+#include "../blocks/encoder.h"
+#include "../blocks/generic.h"
+#include "../blocks/math.h"
+
+#define TAG "SubGhzProtocolAnsonic"
+
+#define DIP_PATTERN "%c%c%c%c%c%c%c%c%c%c"
+#define CNT_TO_DIP(dip)                                                                     \
+    (dip & 0x0800 ? '1' : '0'), (dip & 0x0400 ? '1' : '0'), (dip & 0x0200 ? '1' : '0'),     \
+        (dip & 0x0100 ? '1' : '0'), (dip & 0x0080 ? '1' : '0'), (dip & 0x0040 ? '1' : '0'), \
+        (dip & 0x0020 ? '1' : '0'), (dip & 0x0010 ? '1' : '0'), (dip & 0x0001 ? '1' : '0'), \
+        (dip & 0x0008 ? '1' : '0')
+
+static const SubGhzBlockConst subghz_protocol_ansonic_const = {
+    .te_short = 555,
+    .te_long = 1111,
+    .te_delta = 120,
+    .min_count_bit_for_found = 12,
+};
+
+struct SubGhzProtocolDecoderAnsonic {
+    SubGhzProtocolDecoderBase base;
+
+    SubGhzBlockDecoder decoder;
+    SubGhzBlockGeneric generic;
+};
+
+struct SubGhzProtocolEncoderAnsonic {
+    SubGhzProtocolEncoderBase base;
+
+    SubGhzProtocolBlockEncoder encoder;
+    SubGhzBlockGeneric generic;
+};
+
+typedef enum {
+    AnsonicDecoderStepReset = 0,
+    AnsonicDecoderStepFoundStartBit,
+    AnsonicDecoderStepSaveDuration,
+    AnsonicDecoderStepCheckDuration,
+} AnsonicDecoderStep;
+
+const SubGhzProtocolDecoder subghz_protocol_ansonic_decoder = {
+    .alloc = subghz_protocol_decoder_ansonic_alloc,
+    .free = subghz_protocol_decoder_ansonic_free,
+
+    .feed = subghz_protocol_decoder_ansonic_feed,
+    .reset = subghz_protocol_decoder_ansonic_reset,
+
+    .get_hash_data = subghz_protocol_decoder_ansonic_get_hash_data,
+    .serialize = subghz_protocol_decoder_ansonic_serialize,
+    .deserialize = subghz_protocol_decoder_ansonic_deserialize,
+    .get_string = subghz_protocol_decoder_ansonic_get_string,
+};
+
+const SubGhzProtocolEncoder subghz_protocol_ansonic_encoder = {
+    .alloc = subghz_protocol_encoder_ansonic_alloc,
+    .free = subghz_protocol_encoder_ansonic_free,
+
+    .deserialize = subghz_protocol_encoder_ansonic_deserialize,
+    .stop = subghz_protocol_encoder_ansonic_stop,
+    .yield = subghz_protocol_encoder_ansonic_yield,
+};
+
+const SubGhzProtocol subghz_protocol_ansonic = {
+    .name = SUBGHZ_PROTOCOL_ANSONIC_NAME,
+    .type = SubGhzProtocolTypeStatic,
+    .flag = SubGhzProtocolFlag_433 | SubGhzProtocolFlag_315 | SubGhzProtocolFlag_FM |
+            SubGhzProtocolFlag_Decodable | SubGhzProtocolFlag_Load | SubGhzProtocolFlag_Save |
+            SubGhzProtocolFlag_Send,
+
+    .decoder = &subghz_protocol_ansonic_decoder,
+    .encoder = &subghz_protocol_ansonic_encoder,
+};
+
+void* subghz_protocol_encoder_ansonic_alloc(SubGhzEnvironment* environment) {
+    UNUSED(environment);
+    SubGhzProtocolEncoderAnsonic* instance = malloc(sizeof(SubGhzProtocolEncoderAnsonic));
+
+    instance->base.protocol = &subghz_protocol_ansonic;
+    instance->generic.protocol_name = instance->base.protocol->name;
+
+    instance->encoder.repeat = 10;
+    instance->encoder.size_upload = 52;
+    instance->encoder.upload = malloc(instance->encoder.size_upload * sizeof(LevelDuration));
+    instance->encoder.is_running = false;
+    return instance;
+}
+
+void subghz_protocol_encoder_ansonic_free(void* context) {
+    furi_assert(context);
+    SubGhzProtocolEncoderAnsonic* instance = context;
+    free(instance->encoder.upload);
+    free(instance);
+}
+
+/**
+ * Generating an upload from data.
+ * @param instance Pointer to a SubGhzProtocolEncoderAnsonic instance
+ * @return true On success
+ */
+static bool subghz_protocol_encoder_ansonic_get_upload(SubGhzProtocolEncoderAnsonic* instance) {
+    furi_assert(instance);
+    size_t index = 0;
+    size_t size_upload = (instance->generic.data_count_bit * 2) + 2;
+    if(size_upload > instance->encoder.size_upload) {
+        FURI_LOG_E(TAG, "Size upload exceeds allocated encoder buffer.");
+        return false;
+    } else {
+        instance->encoder.size_upload = size_upload;
+    }
+    //Send header
+    instance->encoder.upload[index++] =
+        level_duration_make(false, (uint32_t)subghz_protocol_ansonic_const.te_short * 35);
+    //Send start bit
+    instance->encoder.upload[index++] =
+        level_duration_make(true, (uint32_t)subghz_protocol_ansonic_const.te_short);
+    //Send key data
+    for(uint8_t i = instance->generic.data_count_bit; i > 0; i--) {
+        if(bit_read(instance->generic.data, i - 1)) {
+            //send bit 1
+            instance->encoder.upload[index++] =
+                level_duration_make(false, (uint32_t)subghz_protocol_ansonic_const.te_short);
+            instance->encoder.upload[index++] =
+                level_duration_make(true, (uint32_t)subghz_protocol_ansonic_const.te_long);
+        } else {
+            //send bit 0
+            instance->encoder.upload[index++] =
+                level_duration_make(false, (uint32_t)subghz_protocol_ansonic_const.te_long);
+            instance->encoder.upload[index++] =
+                level_duration_make(true, (uint32_t)subghz_protocol_ansonic_const.te_short);
+        }
+    }
+    return true;
+}
+
+bool subghz_protocol_encoder_ansonic_deserialize(void* context, FlipperFormat* flipper_format) {
+    furi_assert(context);
+    SubGhzProtocolEncoderAnsonic* instance = context;
+    bool res = false;
+    do {
+        if(!subghz_block_generic_deserialize(&instance->generic, flipper_format)) {
+            FURI_LOG_E(TAG, "Deserialize error");
+            break;
+        }
+        if(instance->generic.data_count_bit !=
+           subghz_protocol_ansonic_const.min_count_bit_for_found) {
+            FURI_LOG_E(TAG, "Wrong number of bits in key");
+            break;
+        }
+        //optional parameter parameter
+        flipper_format_read_uint32(
+            flipper_format, "Repeat", (uint32_t*)&instance->encoder.repeat, 1);
+
+        if(!subghz_protocol_encoder_ansonic_get_upload(instance)) break;
+        instance->encoder.is_running = true;
+
+        res = true;
+    } while(false);
+
+    return res;
+}
+
+void subghz_protocol_encoder_ansonic_stop(void* context) {
+    SubGhzProtocolEncoderAnsonic* instance = context;
+    instance->encoder.is_running = false;
+}
+
+LevelDuration subghz_protocol_encoder_ansonic_yield(void* context) {
+    SubGhzProtocolEncoderAnsonic* instance = context;
+
+    if(instance->encoder.repeat == 0 || !instance->encoder.is_running) {
+        instance->encoder.is_running = false;
+        return level_duration_reset();
+    }
+
+    LevelDuration ret = instance->encoder.upload[instance->encoder.front];
+
+    if(++instance->encoder.front == instance->encoder.size_upload) {
+        instance->encoder.repeat--;
+        instance->encoder.front = 0;
+    }
+
+    return ret;
+}
+
+void* subghz_protocol_decoder_ansonic_alloc(SubGhzEnvironment* environment) {
+    UNUSED(environment);
+    SubGhzProtocolDecoderAnsonic* instance = malloc(sizeof(SubGhzProtocolDecoderAnsonic));
+    instance->base.protocol = &subghz_protocol_ansonic;
+    instance->generic.protocol_name = instance->base.protocol->name;
+    return instance;
+}
+
+void subghz_protocol_decoder_ansonic_free(void* context) {
+    furi_assert(context);
+    SubGhzProtocolDecoderAnsonic* instance = context;
+    free(instance);
+}
+
+void subghz_protocol_decoder_ansonic_reset(void* context) {
+    furi_assert(context);
+    SubGhzProtocolDecoderAnsonic* instance = context;
+    instance->decoder.parser_step = AnsonicDecoderStepReset;
+}
+
+void subghz_protocol_decoder_ansonic_feed(void* context, bool level, uint32_t duration) {
+    furi_assert(context);
+    SubGhzProtocolDecoderAnsonic* instance = context;
+
+    switch(instance->decoder.parser_step) {
+    case AnsonicDecoderStepReset:
+        if((!level) && (DURATION_DIFF(duration, subghz_protocol_ansonic_const.te_short * 35) <
+                        subghz_protocol_ansonic_const.te_delta * 35)) {
+            //Found header Ansonic
+            instance->decoder.parser_step = AnsonicDecoderStepFoundStartBit;
+        }
+        break;
+    case AnsonicDecoderStepFoundStartBit:
+        if(!level) {
+            break;
+        } else if(
+            DURATION_DIFF(duration, subghz_protocol_ansonic_const.te_short) <
+            subghz_protocol_ansonic_const.te_delta) {
+            //Found start bit Ansonic
+            instance->decoder.parser_step = AnsonicDecoderStepSaveDuration;
+            instance->decoder.decode_data = 0;
+            instance->decoder.decode_count_bit = 0;
+        } else {
+            instance->decoder.parser_step = AnsonicDecoderStepReset;
+        }
+        break;
+    case AnsonicDecoderStepSaveDuration:
+        if(!level) { //save interval
+            if(duration >= (subghz_protocol_ansonic_const.te_short * 4)) {
+                instance->decoder.parser_step = AnsonicDecoderStepFoundStartBit;
+                if(instance->decoder.decode_count_bit >=
+                   subghz_protocol_ansonic_const.min_count_bit_for_found) {
+                    instance->generic.serial = 0x0;
+                    instance->generic.btn = 0x0;
+
+                    instance->generic.data = instance->decoder.decode_data;
+                    instance->generic.data_count_bit = instance->decoder.decode_count_bit;
+                    if(instance->base.callback)
+                        instance->base.callback(&instance->base, instance->base.context);
+                }
+                break;
+            }
+            instance->decoder.te_last = duration;
+            instance->decoder.parser_step = AnsonicDecoderStepCheckDuration;
+        } else {
+            instance->decoder.parser_step = AnsonicDecoderStepReset;
+        }
+        break;
+    case AnsonicDecoderStepCheckDuration:
+        if(level) {
+            if((DURATION_DIFF(instance->decoder.te_last, subghz_protocol_ansonic_const.te_short) <
+                subghz_protocol_ansonic_const.te_delta) &&
+               (DURATION_DIFF(duration, subghz_protocol_ansonic_const.te_long) <
+                subghz_protocol_ansonic_const.te_delta)) {
+                subghz_protocol_blocks_add_bit(&instance->decoder, 1);
+                instance->decoder.parser_step = AnsonicDecoderStepSaveDuration;
+            } else if(
+                (DURATION_DIFF(instance->decoder.te_last, subghz_protocol_ansonic_const.te_long) <
+                 subghz_protocol_ansonic_const.te_delta) &&
+                (DURATION_DIFF(duration, subghz_protocol_ansonic_const.te_short) <
+                 subghz_protocol_ansonic_const.te_delta)) {
+                subghz_protocol_blocks_add_bit(&instance->decoder, 0);
+                instance->decoder.parser_step = AnsonicDecoderStepSaveDuration;
+            } else
+                instance->decoder.parser_step = AnsonicDecoderStepReset;
+        } else {
+            instance->decoder.parser_step = AnsonicDecoderStepReset;
+        }
+        break;
+    }
+}
+
+/** 
+ * Analysis of received data
+ * @param instance Pointer to a SubGhzBlockGeneric* instance
+ */
+static void subghz_protocol_ansonic_check_remote_controller(SubGhzBlockGeneric* instance) {
+    /*
+ *        12345678(10) k   9                    
+ * AAA => 10101010 1   01  0
+ *
+ * 1...10 - DIP
+ * k- KEY
+ */
+    instance->cnt = instance->data & 0xFFF;
+    instance->btn = ((instance->data >> 1) & 0x3);
+}
+
+uint8_t subghz_protocol_decoder_ansonic_get_hash_data(void* context) {
+    furi_assert(context);
+    SubGhzProtocolDecoderAnsonic* instance = context;
+    return subghz_protocol_blocks_get_hash_data(
+        &instance->decoder, (instance->decoder.decode_count_bit / 8) + 1);
+}
+
+bool subghz_protocol_decoder_ansonic_serialize(
+    void* context,
+    FlipperFormat* flipper_format,
+    SubGhzRadioPreset* preset) {
+    furi_assert(context);
+    SubGhzProtocolDecoderAnsonic* instance = context;
+    return subghz_block_generic_serialize(&instance->generic, flipper_format, preset);
+}
+
+bool subghz_protocol_decoder_ansonic_deserialize(void* context, FlipperFormat* flipper_format) {
+    furi_assert(context);
+    SubGhzProtocolDecoderAnsonic* instance = context;
+    bool ret = false;
+    do {
+        if(!subghz_block_generic_deserialize(&instance->generic, flipper_format)) {
+            break;
+        }
+        if(instance->generic.data_count_bit !=
+           subghz_protocol_ansonic_const.min_count_bit_for_found) {
+            FURI_LOG_E(TAG, "Wrong number of bits in key");
+            break;
+        }
+        ret = true;
+    } while(false);
+    return ret;
+}
+
+void subghz_protocol_decoder_ansonic_get_string(void* context, FuriString* output) {
+    furi_assert(context);
+    SubGhzProtocolDecoderAnsonic* instance = context;
+    subghz_protocol_ansonic_check_remote_controller(&instance->generic);
+    furi_string_cat_printf(
+        output,
+        "%s %dbit\r\n"
+        "Key:%03lX\r\n"
+        "Btn:%X\r\n"
+        "DIP:" DIP_PATTERN "\r\n",
+        instance->generic.protocol_name,
+        instance->generic.data_count_bit,
+        (uint32_t)(instance->generic.data & 0xFFFFFFFF),
+        instance->generic.btn,
+        CNT_TO_DIP(instance->generic.cnt));
+}

lib/subghz/protocols/ansonic.h

@@ -0,0 +1,107 @@
+#pragma once
+
+#include "base.h"
+
+#define SUBGHZ_PROTOCOL_ANSONIC_NAME "Ansonic"
+
+typedef struct SubGhzProtocolDecoderAnsonic SubGhzProtocolDecoderAnsonic;
+typedef struct SubGhzProtocolEncoderAnsonic SubGhzProtocolEncoderAnsonic;
+
+extern const SubGhzProtocolDecoder subghz_protocol_ansonic_decoder;
+extern const SubGhzProtocolEncoder subghz_protocol_ansonic_encoder;
+extern const SubGhzProtocol subghz_protocol_ansonic;
+
+/**
+ * Allocate SubGhzProtocolEncoderAnsonic.
+ * @param environment Pointer to a SubGhzEnvironment instance
+ * @return SubGhzProtocolEncoderAnsonic* pointer to a SubGhzProtocolEncoderAnsonic instance
+ */
+void* subghz_protocol_encoder_ansonic_alloc(SubGhzEnvironment* environment);
+
+/**
+ * Free SubGhzProtocolEncoderAnsonic.
+ * @param context Pointer to a SubGhzProtocolEncoderAnsonic instance
+ */
+void subghz_protocol_encoder_ansonic_free(void* context);
+
+/**
+ * Deserialize and generating an upload to send.
+ * @param context Pointer to a SubGhzProtocolEncoderAnsonic instance
+ * @param flipper_format Pointer to a FlipperFormat instance
+ * @return true On success
+ */
+bool subghz_protocol_encoder_ansonic_deserialize(void* context, FlipperFormat* flipper_format);
+
+/**
+ * Forced transmission stop.
+ * @param context Pointer to a SubGhzProtocolEncoderAnsonic instance
+ */
+void subghz_protocol_encoder_ansonic_stop(void* context);
+
+/**
+ * Getting the level and duration of the upload to be loaded into DMA.
+ * @param context Pointer to a SubGhzProtocolEncoderAnsonic instance
+ * @return LevelDuration 
+ */
+LevelDuration subghz_protocol_encoder_ansonic_yield(void* context);
+
+/**
+ * Allocate SubGhzProtocolDecoderAnsonic.
+ * @param environment Pointer to a SubGhzEnvironment instance
+ * @return SubGhzProtocolDecoderAnsonic* pointer to a SubGhzProtocolDecoderAnsonic instance
+ */
+void* subghz_protocol_decoder_ansonic_alloc(SubGhzEnvironment* environment);
+
+/**
+ * Free SubGhzProtocolDecoderAnsonic.
+ * @param context Pointer to a SubGhzProtocolDecoderAnsonic instance
+ */
+void subghz_protocol_decoder_ansonic_free(void* context);
+
+/**
+ * Reset decoder SubGhzProtocolDecoderAnsonic.
+ * @param context Pointer to a SubGhzProtocolDecoderAnsonic instance
+ */
+void subghz_protocol_decoder_ansonic_reset(void* context);
+
+/**
+ * Parse a raw sequence of levels and durations received from the air.
+ * @param context Pointer to a SubGhzProtocolDecoderAnsonic instance
+ * @param level Signal level true-high false-low
+ * @param duration Duration of this level in, us
+ */
+void subghz_protocol_decoder_ansonic_feed(void* context, bool level, uint32_t duration);
+
+/**
+ * Getting the hash sum of the last randomly received parcel.
+ * @param context Pointer to a SubGhzProtocolDecoderAnsonic instance
+ * @return hash Hash sum
+ */
+uint8_t subghz_protocol_decoder_ansonic_get_hash_data(void* context);
+
+/**
+ * Serialize data SubGhzProtocolDecoderAnsonic.
+ * @param context Pointer to a SubGhzProtocolDecoderAnsonic 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 subghz_protocol_decoder_ansonic_serialize(
+    void* context,
+    FlipperFormat* flipper_format,
+    SubGhzRadioPreset* preset);
+
+/**
+ * Deserialize data SubGhzProtocolDecoderAnsonic.
+ * @param context Pointer to a SubGhzProtocolDecoderAnsonic instance
+ * @param flipper_format Pointer to a FlipperFormat instance
+ * @return true On success
+ */
+bool subghz_protocol_decoder_ansonic_deserialize(void* context, FlipperFormat* flipper_format);
+
+/**
+ * Getting a textual representation of the received data.
+ * @param context Pointer to a SubGhzProtocolDecoderAnsonic instance
+ * @param output Resulting text
+ */
+void subghz_protocol_decoder_ansonic_get_string(void* context, FuriString* output);

lib/subghz/protocols/protocol_items.c

@@ -12,7 +12,7 @@ const SubGhzProtocol* subghz_protocol_registry_items[] = {
     &subghz_protocol_chamb_code,    &subghz_protocol_power_smart, &subghz_protocol_marantec,
     &subghz_protocol_bett,          &subghz_protocol_doitrand,    &subghz_protocol_phoenix_v2,
     &subghz_protocol_honeywell_wdb, &subghz_protocol_magellan,    &subghz_protocol_intertechno_v3,
-    &subghz_protocol_clemsa,
+    &subghz_protocol_clemsa,        &subghz_protocol_ansonic,
 };
 
 const SubGhzProtocolRegistry subghz_protocol_registry = {

lib/subghz/protocols/protocol_items.h

@@ -35,5 +35,6 @@
 #include "magellan.h"
 #include "intertechno_v3.h"
 #include "clemsa.h"
+#include "ansonic.h"
 
 extern const SubGhzProtocolRegistry subghz_protocol_registry;