add subghz honeywell protocol

by htotoo

https://github.com/Flipper-XFW/Xtreme-Firmware/commits?author=htotoo

lib/subghz/protocols/honeywell.c

@@ -0,0 +1,357 @@
+#include "honeywell.h"
+#include <lib/toolbox/manchester_decoder.h>
+
+//Created by HTotoo 2023-10-30
+//Got a lot of help from LiQuiDz.
+//Protocol decoding help from: https://github.com/merbanan/rtl_433/blob/master/src/devices/honeywell.c
+
+/*
+64 bit packets, repeated multiple times per open/close event.
+
+Protocol whitepaper: "DEFCON 22: Home Insecurity" by Logan Lamb.
+
+Data layout:
+
+    PP PP C IIIII EE SS SS
+
+- P: 16bit Preamble and sync bit (always ff fe)
+- C: 4bit Channel
+- I: 20bit Device serial number / or counter value
+- E: 8bit Event, where 0x80 = Open/Close, 0x04 = Heartbeat / or id
+- S: 16bit CRC
+*/
+
+#define TAG "SubGhzProtocolHoneywell"
+
+uint16_t subghz_protocol_honeywell_crc16(
+    uint8_t const message[],
+    unsigned nBytes,
+    uint16_t polynomial,
+    uint16_t init) {
+    uint16_t remainder = init;
+    unsigned byte, bit;
+
+    for(byte = 0; byte < nBytes; ++byte) {
+        remainder ^= message[byte] << 8;
+        for(bit = 0; bit < 8; ++bit) {
+            if(remainder & 0x8000) {
+                remainder = (remainder << 1) ^ polynomial;
+            } else {
+                remainder = (remainder << 1);
+            }
+        }
+    }
+    return remainder;
+}
+
+void subghz_protocol_decoder_honeywell_free(void* context) {
+    furi_assert(context);
+    SubGhzProtocolDecoderHoneywell* instance = context;
+    free(instance);
+}
+
+void subghz_protocol_decoder_honeywell_reset(void* context) {
+    furi_assert(context);
+    SubGhzProtocolDecoderHoneywell* instance = context;
+    instance->decoder.decode_data = 0;
+    instance->decoder.decode_count_bit = 0;
+}
+
+void subghz_protocol_decoder_honeywell_addbit(void* context, bool data) {
+    SubGhzProtocolDecoderHoneywell* instance = context;
+    instance->decoder.decode_data = (instance->decoder.decode_data << 1) | data;
+    instance->decoder.decode_count_bit++;
+
+    uint16_t preamble = (instance->decoder.decode_data >> 48) & 0xFFFF;
+    //can be multiple, since flipper can't read it well..
+    if(preamble == 0b0011111111111110 || preamble == 0b0111111111111110 ||
+       preamble == 0b1111111111111110) {
+        uint8_t datatocrc[4];
+        datatocrc[0] = (instance->decoder.decode_data >> 40) & 0xFFFF;
+        datatocrc[1] = (instance->decoder.decode_data >> 32) & 0xFFFF;
+        datatocrc[2] = (instance->decoder.decode_data >> 24) & 0xFFFF;
+        datatocrc[3] = (instance->decoder.decode_data >> 16) & 0xFFFF;
+        uint8_t channel = (instance->decoder.decode_data >> 44) & 0xF;
+        uint16_t crc_calc = 0;
+        if(channel == 0x2 || channel == 0x4 || channel == 0xA) {
+            // 2GIG brand
+            crc_calc = subghz_protocol_honeywell_crc16(datatocrc, 4, 0x8050, 0);
+        } else { // channel == 0x8
+            crc_calc = subghz_protocol_honeywell_crc16(datatocrc, 4, 0x8005, 0);
+        }
+        uint16_t crc = instance->decoder.decode_data & 0xFFFF;
+        if(crc == crc_calc) {
+            //the data is good. process it.
+            instance->generic.data = instance->decoder.decode_data;
+            instance->generic.data_count_bit =
+                instance->decoder
+                    .decode_count_bit; //maybe set it to 64, and hack the first 2 bits to 1! will see if replay needs it
+            instance->generic.serial = (instance->decoder.decode_data >> 24) & 0xFFFFF;
+            instance->generic.btn = (instance->decoder.decode_data >> 16) &
+                                    0xFF; //not exactly button, but can contain btn data too.
+            if(instance->base.callback)
+                instance->base.callback(&instance->base, instance->base.context);
+            instance->decoder.decode_data = 0;
+            instance->decoder.decode_count_bit = 0;
+        } else {
+            return;
+        }
+    }
+}
+
+void subghz_protocol_decoder_honeywell_feed(void* context, bool level, uint32_t duration) {
+    furi_assert(context);
+    SubGhzProtocolDecoderHoneywell* instance = context;
+
+    ManchesterEvent event = ManchesterEventReset;
+    if(!level) {
+        if(DURATION_DIFF(duration, subghz_protocol_honeywell_const.te_short) <
+           subghz_protocol_honeywell_const.te_delta) {
+            event = ManchesterEventShortLow;
+        } else if(
+            DURATION_DIFF(duration, subghz_protocol_honeywell_const.te_long) <
+            subghz_protocol_honeywell_const.te_delta * 2) {
+            event = ManchesterEventLongLow;
+        }
+    } else {
+        if(DURATION_DIFF(duration, subghz_protocol_honeywell_const.te_short) <
+           subghz_protocol_honeywell_const.te_delta) {
+            event = ManchesterEventShortHigh;
+        } else if(
+            DURATION_DIFF(duration, subghz_protocol_honeywell_const.te_long) <
+            subghz_protocol_honeywell_const.te_delta * 2) {
+            event = ManchesterEventLongHigh;
+        }
+    }
+    if(event != ManchesterEventReset) {
+        bool data;
+        bool data_ok = manchester_advance(
+            instance->manchester_saved_state, event, &instance->manchester_saved_state, &data);
+        if(data_ok) {
+            subghz_protocol_decoder_honeywell_addbit(instance, data);
+        }
+    } else {
+        instance->decoder.decode_data = 0;
+        instance->decoder.decode_count_bit = 0;
+    }
+}
+
+uint8_t subghz_protocol_decoder_honeywell_get_hash_data(void* context) {
+    furi_assert(context);
+    SubGhzProtocolDecoderHoneywell* instance = context;
+    return subghz_protocol_blocks_get_hash_data(
+        &instance->decoder, (instance->decoder.decode_count_bit / 8) + 1);
+}
+
+SubGhzProtocolStatus subghz_protocol_decoder_honeywell_serialize(
+    void* context,
+    FlipperFormat* flipper_format,
+    SubGhzRadioPreset* preset) {
+    furi_assert(context);
+    SubGhzProtocolDecoderHoneywell* instance = context;
+    return subghz_block_generic_serialize(&instance->generic, flipper_format, preset);
+}
+
+SubGhzProtocolStatus
+    subghz_protocol_decoder_honeywell_deserialize(void* context, FlipperFormat* flipper_format) {
+    furi_assert(context);
+    SubGhzProtocolDecoderHoneywell* instance = context;
+    return subghz_block_generic_deserialize_check_count_bit(
+        &instance->generic,
+        flipper_format,
+        subghz_protocol_honeywell_const.min_count_bit_for_found);
+}
+
+void subghz_protocol_decoder_honeywell_get_string(void* context, FuriString* output) {
+    furi_assert(context);
+    SubGhzProtocolDecoderHoneywell* instance = context;
+
+    uint8_t channel = (instance->generic.data >> 44) & 0xF;
+    uint8_t contact = (instance->generic.btn & 0x80) >> 7;
+    uint8_t tamper = (instance->generic.btn & 0x40) >> 6;
+    uint8_t reed = (instance->generic.btn & 0x20) >> 5;
+    uint8_t alarm = (instance->generic.btn & 0x10) >> 4;
+    uint8_t battery_low = (instance->generic.btn & 0x08) >> 3;
+    uint8_t heartbeat = (instance->generic.btn & 0x04) >> 2;
+
+    furi_string_cat_printf(
+        output,
+        "%s\r\n%dbit  "
+        "Sn:%07lu\r\nCh:%u  Bat:%d  Hb: %d\r\n"
+        "L1: %u, L2: %u, L3: %u, L4: %u\r\n",
+        instance->generic.protocol_name,
+        instance->generic.data_count_bit,
+        instance->generic.serial,
+        channel,
+        battery_low,
+        heartbeat,
+        contact,
+        reed,
+        alarm,
+        tamper);
+}
+
+void* subghz_protocol_decoder_honeywell_alloc(SubGhzEnvironment* environment) {
+    UNUSED(environment);
+    SubGhzProtocolDecoderHoneywell* instance = malloc(sizeof(SubGhzProtocolDecoderHoneywell));
+    instance->base.protocol = &subghz_protocol_honeywell;
+    instance->generic.protocol_name = instance->base.protocol->name;
+    return instance;
+}
+
+void* subghz_protocol_encoder_honeywell_alloc(SubGhzEnvironment* environment) {
+    UNUSED(environment);
+    SubGhzProtocolEncoderHoneywell* instance = malloc(sizeof(SubGhzProtocolEncoderHoneywell));
+
+    instance->base.protocol = &subghz_protocol_honeywell;
+    instance->generic.protocol_name = instance->base.protocol->name;
+
+    instance->encoder.repeat = 3;
+    instance->encoder.size_upload = 64 * 2 + 10;
+    instance->encoder.upload = malloc(instance->encoder.size_upload * sizeof(LevelDuration));
+    instance->encoder.is_running = false;
+    return instance;
+}
+
+void subghz_protocol_encoder_honeywell_free(void* context) {
+    furi_assert(context);
+    SubGhzProtocolEncoderHoneywell* instance = context;
+    free(instance->encoder.upload);
+    free(instance);
+}
+static LevelDuration
+    subghz_protocol_encoder_honeywell_add_duration_to_upload(ManchesterEncoderResult result) {
+    LevelDuration data = {.duration = 0, .level = 0};
+    switch(result) {
+    case ManchesterEncoderResultShortLow:
+        data.duration = subghz_protocol_honeywell_const.te_short;
+        data.level = false;
+        break;
+    case ManchesterEncoderResultLongLow:
+        data.duration = subghz_protocol_honeywell_const.te_long;
+        data.level = false;
+        break;
+    case ManchesterEncoderResultLongHigh:
+        data.duration = subghz_protocol_honeywell_const.te_long;
+        data.level = true;
+        break;
+    case ManchesterEncoderResultShortHigh:
+        data.duration = subghz_protocol_honeywell_const.te_short;
+        data.level = true;
+        break;
+
+    default:
+        furi_crash("SubGhz: ManchesterEncoderResult is incorrect.");
+        break;
+    }
+    return level_duration_make(data.level, data.duration);
+}
+
+static void
+    subghz_protocol_encoder_honeywell_get_upload(SubGhzProtocolEncoderHoneywell* instance) {
+    furi_assert(instance);
+    size_t index = 0;
+
+    ManchesterEncoderState enc_state;
+    manchester_encoder_reset(&enc_state);
+    ManchesterEncoderResult result;
+
+    for(uint8_t i = 63; i > 0; i--) {
+        if(!manchester_encoder_advance(
+               &enc_state, bit_read(instance->generic.data, i - 1), &result)) {
+            instance->encoder.upload[index++] =
+                subghz_protocol_encoder_honeywell_add_duration_to_upload(result);
+            manchester_encoder_advance(
+                &enc_state, bit_read(instance->generic.data, i - 1), &result);
+        }
+        instance->encoder.upload[index++] =
+            subghz_protocol_encoder_honeywell_add_duration_to_upload(result);
+    }
+    instance->encoder.upload[index] = subghz_protocol_encoder_honeywell_add_duration_to_upload(
+        manchester_encoder_finish(&enc_state));
+    if(level_duration_get_level(instance->encoder.upload[index])) {
+        index++;
+    }
+    instance->encoder.size_upload = index;
+}
+
+SubGhzProtocolStatus
+    subghz_protocol_encoder_honeywell_deserialize(void* context, FlipperFormat* flipper_format) {
+    furi_assert(context);
+    SubGhzProtocolEncoderHoneywell* instance = context;
+    SubGhzProtocolStatus res = SubGhzProtocolStatusError;
+    do {
+        if(SubGhzProtocolStatusOk !=
+           subghz_block_generic_deserialize(&instance->generic, flipper_format)) {
+            FURI_LOG_E(TAG, "Deserialize error");
+            break;
+        }
+
+        //optional parameter parameter
+        flipper_format_read_uint32(
+            flipper_format, "Repeat", (uint32_t*)&instance->encoder.repeat, 1);
+
+        subghz_protocol_encoder_honeywell_get_upload(instance);
+
+        if(!flipper_format_rewind(flipper_format)) {
+            FURI_LOG_E(TAG, "Rewind error");
+            break;
+        }
+
+        instance->encoder.is_running = true;
+
+        res = SubGhzProtocolStatusOk;
+    } while(false);
+
+    return res;
+}
+
+void subghz_protocol_encoder_honeywell_stop(void* context) {
+    SubGhzProtocolEncoderHoneywell* instance = context;
+    instance->encoder.is_running = false;
+}
+
+LevelDuration subghz_protocol_encoder_honeywell_yield(void* context) {
+    SubGhzProtocolEncoderHoneywell* 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;
+}
+
+const SubGhzProtocolDecoder subghz_protocol_honeywell_decoder = {
+    .alloc = subghz_protocol_decoder_honeywell_alloc,
+    .free = subghz_protocol_decoder_honeywell_free,
+    .feed = subghz_protocol_decoder_honeywell_feed,
+    .reset = subghz_protocol_decoder_honeywell_reset,
+    .get_hash_data = subghz_protocol_decoder_honeywell_get_hash_data,
+    .serialize = subghz_protocol_decoder_honeywell_serialize,
+    .deserialize = subghz_protocol_decoder_honeywell_deserialize,
+    .get_string = subghz_protocol_decoder_honeywell_get_string,
+};
+
+const SubGhzProtocolEncoder subghz_protocol_honeywell_encoder = {
+    .alloc = subghz_protocol_encoder_honeywell_alloc,
+    .free = subghz_protocol_encoder_honeywell_free,
+    .deserialize = subghz_protocol_encoder_honeywell_deserialize,
+    .stop = subghz_protocol_encoder_honeywell_stop,
+    .yield = subghz_protocol_encoder_honeywell_yield,
+};
+
+const SubGhzProtocol subghz_protocol_honeywell = {
+    .name = SUBGHZ_PROTOCOL_HONEYWELL_NAME,
+    .type = SubGhzProtocolTypeStatic,
+    .flag = SubGhzProtocolFlag_433 | SubGhzProtocolFlag_315 | SubGhzProtocolFlag_868 |
+            SubGhzProtocolFlag_AM | SubGhzProtocolFlag_Decodable | SubGhzProtocolFlag_Load |
+            SubGhzProtocolFlag_Save | SubGhzProtocolFlag_Send,
+    .encoder = &subghz_protocol_honeywell_encoder,
+    .decoder = &subghz_protocol_honeywell_decoder,
+
+};

lib/subghz/protocols/honeywell.h

@@ -0,0 +1,61 @@
+#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 "base.h"
+#include "../blocks/generic.h"
+#include <lib/subghz/blocks/math.h>
+#include <lib/toolbox/manchester_decoder.h>
+#include <lib/toolbox/manchester_encoder.h>
+
+#define SUBGHZ_PROTOCOL_HONEYWELL_NAME "Honeywell Sec"
+
+typedef struct SubGhzProtocolDecoderHoneywell SubGhzProtocolDecoderHoneywell;
+typedef struct SubGhzProtocolEncoderHoneywell SubGhzProtocolEncoderHoneywell;
+
+extern const SubGhzProtocolDecoder subghz_protocol_honeywell_decoder;
+extern const SubGhzProtocolEncoder subghz_protocol_honeywell_encoder;
+extern const SubGhzProtocol subghz_protocol_honeywell;
+
+void* subghz_protocol_decoder_honeywell_alloc(SubGhzEnvironment* environment);
+
+void subghz_protocol_decoder_honeywell_free(void* context);
+
+void subghz_protocol_decoder_honeywell_reset(void* context);
+
+void subghz_protocol_decoder_honeywell_feed(void* context, bool level, uint32_t duration);
+
+uint8_t subghz_protocol_decoder_honeywell_get_hash_data(void* context);
+
+SubGhzProtocolStatus subghz_protocol_decoder_honeywell_serialize(
+    void* context,
+    FlipperFormat* flipper_format,
+    SubGhzRadioPreset* preset);
+
+SubGhzProtocolStatus
+    subghz_protocol_decoder_honeywell_deserialize(void* context, FlipperFormat* flipper_format);
+
+void subghz_protocol_decoder_honeywell_get_string(void* context, FuriString* output);
+
+static const SubGhzBlockConst subghz_protocol_honeywell_const = {
+    .te_long = 280,
+    .te_short = 143,
+    .te_delta = 51,
+    .min_count_bit_for_found = 62,
+};
+
+struct SubGhzProtocolDecoderHoneywell {
+    SubGhzProtocolDecoderBase base;
+    SubGhzBlockGeneric generic;
+    SubGhzBlockDecoder decoder;
+    ManchesterState manchester_saved_state;
+};
+
+struct SubGhzProtocolEncoderHoneywell {
+    SubGhzProtocolEncoderBase base;
+    SubGhzBlockGeneric generic;
+    SubGhzProtocolBlockEncoder encoder;
+};

lib/subghz/protocols/protocol_items.c

@@ -44,6 +44,7 @@ const SubGhzProtocol* subghz_protocol_registry_items[] = {
     &subghz_protocol_kinggates_stylo_4k,
     &subghz_protocol_bin_raw,
     &subghz_protocol_mastercode,
+    &subghz_protocol_honeywell,
 };
 
 const SubGhzProtocolRegistry subghz_protocol_registry = {

lib/subghz/protocols/protocol_items.h

@@ -45,3 +45,4 @@
 #include "kinggates_stylo_4k.h"
 #include "bin_raw.h"
 #include "mastercode.h"
+#include "honeywell.h"