diff --git a/weather_station/.catalog/README.md b/weather_station/.catalog/README.md index ac80d300..cf8b2fc7 100644 --- a/weather_station/.catalog/README.md +++ b/weather_station/.catalog/README.md @@ -11,7 +11,7 @@ GT-WT02 GT-WT03 Acurite 592TXR Acurite-606TX -Acurite-606TXC +Acurite-609TXC Acurite-986 LaCrosse_TX TX141THBv2 @@ -23,3 +23,4 @@ Avriol HG06061 TX8300 Wendox W6276 Auriol AHFL +Kedsum-TH/Conrad-S3318P diff --git a/weather_station/.catalog/changelog.md b/weather_station/.catalog/changelog.md index cc2ef090..c18ed191 100644 --- a/weather_station/.catalog/changelog.md +++ b/weather_station/.catalog/changelog.md @@ -1,3 +1,5 @@ +## 1.3 + - Add protocol Kedsum-TH/Conrad-S3318P ## 1.2 - Add protocol Acurite-986 - Minimal changes for recent API updates diff --git a/weather_station/application.fam b/weather_station/application.fam index 5061750e..20377da8 100644 --- a/weather_station/application.fam +++ b/weather_station/application.fam @@ -7,7 +7,7 @@ App( requires=["gui"], stack_size=4 * 1024, fap_description="Receive weather data from a wide range of supported Sub-1GHz remote sensor", - fap_version="1.2", + fap_version="1.3", fap_icon="weather_station_10px.png", fap_category="Sub-GHz", fap_icon_assets="images", diff --git a/weather_station/protocols/kedsum_th.c b/weather_station/protocols/kedsum_th.c new file mode 100644 index 00000000..fe20bd31 --- /dev/null +++ b/weather_station/protocols/kedsum_th.c @@ -0,0 +1,294 @@ +#include "kedsum_th.h" + +#define TAG "WSProtocolKedsumTH" + +/* + * Help + * https://github.com/merbanan/rtl_433/blob/master/src/devices/kedsum.c + * + * Frame structure: + * + * Byte: 0 1 2 3 4 + * Nibble: 1 2 3 4 5 6 7 8 9 10 + * Type: 00 IIIIIIII BBCC++++ ttttTTTT hhhhHHHH FFFFXXXX + * + * - I: unique id. changes on powercycle + * - B: Battery state 10 = Ok, 01 = weak, 00 = bad + * - C: channel, 00 = ch1, 10=ch3 + * - + low temp nibble + * - t: med temp nibble + * - T: high temp nibble + * - h: humidity low nibble + * - H: humidity high nibble + * - F: flags + * - X: CRC-4 poly 0x3 init 0x0 xor last 4 bits + */ + +static const SubGhzBlockConst ws_protocol_kedsum_th_const = { + .te_short = 500, + .te_long = 2000, + .te_delta = 150, + .min_count_bit_for_found = 42, +}; + +struct WSProtocolDecoderKedsumTH { + SubGhzProtocolDecoderBase base; + + SubGhzBlockDecoder decoder; + WSBlockGeneric generic; + + uint16_t header_count; +}; + +struct WSProtocolEncoderKedsumTH { + SubGhzProtocolEncoderBase base; + + SubGhzProtocolBlockEncoder encoder; + WSBlockGeneric generic; +}; + +typedef enum { + KedsumTHDecoderStepReset = 0, + KedsumTHDecoderStepCheckPreambule, + KedsumTHDecoderStepSaveDuration, + KedsumTHDecoderStepCheckDuration, +} KedsumTHDecoderStep; + +const SubGhzProtocolDecoder ws_protocol_kedsum_th_decoder = { + .alloc = ws_protocol_decoder_kedsum_th_alloc, + .free = ws_protocol_decoder_kedsum_th_free, + + .feed = ws_protocol_decoder_kedsum_th_feed, + .reset = ws_protocol_decoder_kedsum_th_reset, + + .get_hash_data = ws_protocol_decoder_kedsum_th_get_hash_data, + .serialize = ws_protocol_decoder_kedsum_th_serialize, + .deserialize = ws_protocol_decoder_kedsum_th_deserialize, + .get_string = ws_protocol_decoder_kedsum_th_get_string, +}; + +const SubGhzProtocolEncoder ws_protocol_kedsum_th_encoder = { + .alloc = NULL, + .free = NULL, + + .deserialize = NULL, + .stop = NULL, + .yield = NULL, +}; + +const SubGhzProtocol ws_protocol_kedsum_th = { + .name = WS_PROTOCOL_KEDSUM_TH_NAME, + .type = SubGhzProtocolWeatherStation, + .flag = SubGhzProtocolFlag_433 | SubGhzProtocolFlag_315 | SubGhzProtocolFlag_868 | + SubGhzProtocolFlag_AM | SubGhzProtocolFlag_Decodable, + + .decoder = &ws_protocol_kedsum_th_decoder, + .encoder = &ws_protocol_kedsum_th_encoder, +}; + +void* ws_protocol_decoder_kedsum_th_alloc(SubGhzEnvironment* environment) { + UNUSED(environment); + WSProtocolDecoderKedsumTH* instance = malloc(sizeof(WSProtocolDecoderKedsumTH)); + instance->base.protocol = &ws_protocol_kedsum_th; + instance->generic.protocol_name = instance->base.protocol->name; + return instance; +} + +void ws_protocol_decoder_kedsum_th_free(void* context) { + furi_assert(context); + WSProtocolDecoderKedsumTH* instance = context; + free(instance); +} + +void ws_protocol_decoder_kedsum_th_reset(void* context) { + furi_assert(context); + WSProtocolDecoderKedsumTH* instance = context; + instance->decoder.parser_step = KedsumTHDecoderStepReset; +} + +static bool ws_protocol_kedsum_th_check_crc(WSProtocolDecoderKedsumTH* instance) { + uint8_t msg[] = { + instance->decoder.decode_data >> 32, + instance->decoder.decode_data >> 24, + instance->decoder.decode_data >> 16, + instance->decoder.decode_data >> 8, + instance->decoder.decode_data}; + + uint8_t crc = + subghz_protocol_blocks_crc4(msg, 4, 0x03, 0); // CRC-4 poly 0x3 init 0x0 xor last 4 bits + crc ^= msg[4] >> 4; // last nibble is only XORed + return (crc == (msg[4] & 0x0F)); +} + +/** + * Analysis of received data + * @param instance Pointer to a WSBlockGeneric* instance + */ +static void ws_protocol_kedsum_th_remote_controller(WSBlockGeneric* instance) { + instance->id = instance->data >> 32; + if((instance->data >> 30) & 0x3) { + instance->battery_low = 0; + } else { + instance->battery_low = 1; + } + instance->channel = ((instance->data >> 28) & 0x3) + 1; + instance->btn = WS_NO_BTN; + uint16_t temp_raw = ((instance->data >> 16) & 0x0f) << 8 | + ((instance->data >> 20) & 0x0f) << 4 | ((instance->data >> 24) & 0x0f); + instance->temp = locale_fahrenheit_to_celsius(((float)temp_raw - 900.0f) / 10.0f); + instance->humidity = ((instance->data >> 8) & 0x0f) << 4 | ((instance->data >> 12) & 0x0f); +} + +void ws_protocol_decoder_kedsum_th_feed(void* context, bool level, uint32_t duration) { + furi_assert(context); + WSProtocolDecoderKedsumTH* instance = context; + + switch(instance->decoder.parser_step) { + case KedsumTHDecoderStepReset: + if((level) && (DURATION_DIFF(duration, ws_protocol_kedsum_th_const.te_short) < + ws_protocol_kedsum_th_const.te_delta)) { + instance->decoder.parser_step = KedsumTHDecoderStepCheckPreambule; + instance->decoder.te_last = duration; + instance->header_count = 0; + } + break; + + case KedsumTHDecoderStepCheckPreambule: + if(level) { + instance->decoder.te_last = duration; + } else { + if((DURATION_DIFF(instance->decoder.te_last, ws_protocol_kedsum_th_const.te_short) < + ws_protocol_kedsum_th_const.te_delta) && + (DURATION_DIFF(duration, ws_protocol_kedsum_th_const.te_long * 4) < + ws_protocol_kedsum_th_const.te_delta * 4)) { + //Found preambule + instance->header_count++; + } else if( + (DURATION_DIFF(instance->decoder.te_last, ws_protocol_kedsum_th_const.te_short) < + ws_protocol_kedsum_th_const.te_delta) && + (duration < (ws_protocol_kedsum_th_const.te_long * 2 + + ws_protocol_kedsum_th_const.te_delta * 2))) { + //Found syncPrefix + if(instance->header_count > 0) { + instance->decoder.parser_step = KedsumTHDecoderStepSaveDuration; + instance->decoder.decode_data = 0; + instance->decoder.decode_count_bit = 0; + if((DURATION_DIFF( + instance->decoder.te_last, ws_protocol_kedsum_th_const.te_short) < + ws_protocol_kedsum_th_const.te_delta) && + (DURATION_DIFF(duration, ws_protocol_kedsum_th_const.te_long) < + ws_protocol_kedsum_th_const.te_delta * 2)) { + subghz_protocol_blocks_add_bit(&instance->decoder, 0); + instance->decoder.parser_step = KedsumTHDecoderStepSaveDuration; + } else if( + (DURATION_DIFF( + instance->decoder.te_last, ws_protocol_kedsum_th_const.te_short) < + ws_protocol_kedsum_th_const.te_delta) && + (DURATION_DIFF(duration, ws_protocol_kedsum_th_const.te_long * 2) < + ws_protocol_kedsum_th_const.te_delta * 4)) { + subghz_protocol_blocks_add_bit(&instance->decoder, 1); + instance->decoder.parser_step = KedsumTHDecoderStepSaveDuration; + } else { + instance->decoder.parser_step = KedsumTHDecoderStepReset; + } + } + } else { + instance->decoder.parser_step = KedsumTHDecoderStepReset; + } + } + break; + + case KedsumTHDecoderStepSaveDuration: + if(level) { + instance->decoder.te_last = duration; + instance->decoder.parser_step = KedsumTHDecoderStepCheckDuration; + } else { + instance->decoder.parser_step = KedsumTHDecoderStepReset; + } + break; + + case KedsumTHDecoderStepCheckDuration: + if(!level) { + if(DURATION_DIFF(duration, ws_protocol_kedsum_th_const.te_long * 4) < + ws_protocol_kedsum_th_const.te_delta * 4) { + //Found syncPostfix + if((instance->decoder.decode_count_bit == + ws_protocol_kedsum_th_const.min_count_bit_for_found) && + ws_protocol_kedsum_th_check_crc(instance)) { + instance->generic.data = instance->decoder.decode_data; + instance->generic.data_count_bit = instance->decoder.decode_count_bit; + ws_protocol_kedsum_th_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 = KedsumTHDecoderStepReset; + break; + } else if( + (DURATION_DIFF(instance->decoder.te_last, ws_protocol_kedsum_th_const.te_short) < + ws_protocol_kedsum_th_const.te_delta) && + (DURATION_DIFF(duration, ws_protocol_kedsum_th_const.te_long) < + ws_protocol_kedsum_th_const.te_delta * 2)) { + subghz_protocol_blocks_add_bit(&instance->decoder, 0); + instance->decoder.parser_step = KedsumTHDecoderStepSaveDuration; + } else if( + (DURATION_DIFF(instance->decoder.te_last, ws_protocol_kedsum_th_const.te_short) < + ws_protocol_kedsum_th_const.te_delta) && + (DURATION_DIFF(duration, ws_protocol_kedsum_th_const.te_long * 2) < + ws_protocol_kedsum_th_const.te_delta * 4)) { + subghz_protocol_blocks_add_bit(&instance->decoder, 1); + instance->decoder.parser_step = KedsumTHDecoderStepSaveDuration; + } else { + instance->decoder.parser_step = KedsumTHDecoderStepReset; + } + } else { + instance->decoder.parser_step = KedsumTHDecoderStepReset; + } + break; + } +} + +uint8_t ws_protocol_decoder_kedsum_th_get_hash_data(void* context) { + furi_assert(context); + WSProtocolDecoderKedsumTH* instance = context; + return subghz_protocol_blocks_get_hash_data( + &instance->decoder, (instance->decoder.decode_count_bit / 8) + 1); +} + +SubGhzProtocolStatus ws_protocol_decoder_kedsum_th_serialize( + void* context, + FlipperFormat* flipper_format, + SubGhzRadioPreset* preset) { + furi_assert(context); + WSProtocolDecoderKedsumTH* instance = context; + return ws_block_generic_serialize(&instance->generic, flipper_format, preset); +} + +SubGhzProtocolStatus + ws_protocol_decoder_kedsum_th_deserialize(void* context, FlipperFormat* flipper_format) { + furi_assert(context); + WSProtocolDecoderKedsumTH* instance = context; + return ws_block_generic_deserialize_check_count_bit( + &instance->generic, flipper_format, ws_protocol_kedsum_th_const.min_count_bit_for_found); +} + +void ws_protocol_decoder_kedsum_th_get_string(void* context, FuriString* output) { + furi_assert(context); + WSProtocolDecoderKedsumTH* 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:%3.1f 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, + (double)instance->generic.temp, + instance->generic.humidity); +} diff --git a/weather_station/protocols/kedsum_th.h b/weather_station/protocols/kedsum_th.h new file mode 100644 index 00000000..54146b4d --- /dev/null +++ b/weather_station/protocols/kedsum_th.h @@ -0,0 +1,80 @@ +#pragma once + +#include + +#include +#include +#include +#include "ws_generic.h" +#include + +#define WS_PROTOCOL_KEDSUM_TH_NAME "Kedsum-TH" + +typedef struct WSProtocolDecoderKedsumTH WSProtocolDecoderKedsumTH; +typedef struct WSProtocolEncoderKedsumTH WSProtocolEncoderKedsumTH; + +extern const SubGhzProtocolDecoder ws_protocol_kedsum_th_decoder; +extern const SubGhzProtocolEncoder ws_protocol_kedsum_th_encoder; +extern const SubGhzProtocol ws_protocol_kedsum_th; + +/** + * Allocate WSProtocolDecoderKedsumTH. + * @param environment Pointer to a SubGhzEnvironment instance + * @return WSProtocolDecoderKedsumTH* pointer to a WSProtocolDecoderKedsumTH instance + */ +void* ws_protocol_decoder_kedsum_th_alloc(SubGhzEnvironment* environment); + +/** + * Free WSProtocolDecoderKedsumTH. + * @param context Pointer to a WSProtocolDecoderKedsumTH instance + */ +void ws_protocol_decoder_kedsum_th_free(void* context); + +/** + * Reset decoder WSProtocolDecoderKedsumTH. + * @param context Pointer to a WSProtocolDecoderKedsumTH instance + */ +void ws_protocol_decoder_kedsum_th_reset(void* context); + +/** + * Parse a raw sequence of levels and durations received from the air. + * @param context Pointer to a WSProtocolDecoderKedsumTH instance + * @param level Signal level true-high false-low + * @param duration Duration of this level in, us + */ +void ws_protocol_decoder_kedsum_th_feed(void* context, bool level, uint32_t duration); + +/** + * Getting the hash sum of the last randomly received parcel. + * @param context Pointer to a WSProtocolDecoderKedsumTH instance + * @return hash Hash sum + */ +uint8_t ws_protocol_decoder_kedsum_th_get_hash_data(void* context); + +/** + * Serialize data WSProtocolDecoderKedsumTH. + * @param context Pointer to a WSProtocolDecoderKedsumTH instance + * @param flipper_format Pointer to a FlipperFormat instance + * @param preset The modulation on which the signal was received, SubGhzRadioPreset + * @return status + */ +SubGhzProtocolStatus ws_protocol_decoder_kedsum_th_serialize( + void* context, + FlipperFormat* flipper_format, + SubGhzRadioPreset* preset); + +/** + * Deserialize data WSProtocolDecoderKedsumTH. + * @param context Pointer to a WSProtocolDecoderKedsumTH instance + * @param flipper_format Pointer to a FlipperFormat instance + * @return status + */ +SubGhzProtocolStatus + ws_protocol_decoder_kedsum_th_deserialize(void* context, FlipperFormat* flipper_format); + +/** + * Getting a textual representation of the received data. + * @param context Pointer to a WSProtocolDecoderKedsumTH instance + * @param output Resulting text + */ +void ws_protocol_decoder_kedsum_th_get_string(void* context, FuriString* output); diff --git a/weather_station/protocols/protocol_items.c b/weather_station/protocols/protocol_items.c index a8219649..dbd51d6d 100644 --- a/weather_station/protocols/protocol_items.c +++ b/weather_station/protocols/protocol_items.c @@ -1,25 +1,16 @@ #include "protocol_items.h" const SubGhzProtocol* weather_station_protocol_registry_items[] = { - &ws_protocol_infactory, - &ws_protocol_thermopro_tx4, - &ws_protocol_nexus_th, - &ws_protocol_gt_wt_02, - &ws_protocol_gt_wt_03, - &ws_protocol_acurite_606tx, - &ws_protocol_acurite_609txc, - &ws_protocol_acurite_986, - &ws_protocol_lacrosse_tx, - &ws_protocol_lacrosse_tx141thbv2, - &ws_protocol_oregon2, - &ws_protocol_oregon3, - &ws_protocol_acurite_592txr, - &ws_protocol_ambient_weather, - &ws_protocol_auriol_th, - &ws_protocol_oregon_v1, - &ws_protocol_tx_8300, - &ws_protocol_wendox_w6726, - &ws_protocol_auriol_ahfl, + &ws_protocol_infactory, &ws_protocol_thermopro_tx4, + &ws_protocol_nexus_th, &ws_protocol_gt_wt_02, + &ws_protocol_gt_wt_03, &ws_protocol_acurite_606tx, + &ws_protocol_acurite_609txc, &ws_protocol_acurite_986, + &ws_protocol_lacrosse_tx, &ws_protocol_lacrosse_tx141thbv2, + &ws_protocol_oregon2, &ws_protocol_oregon3, + &ws_protocol_acurite_592txr, &ws_protocol_ambient_weather, + &ws_protocol_auriol_th, &ws_protocol_oregon_v1, + &ws_protocol_tx_8300, &ws_protocol_wendox_w6726, + &ws_protocol_auriol_ahfl, &ws_protocol_kedsum_th, }; const SubGhzProtocolRegistry weather_station_protocol_registry = { diff --git a/weather_station/protocols/protocol_items.h b/weather_station/protocols/protocol_items.h index f495d9b2..695769e2 100644 --- a/weather_station/protocols/protocol_items.h +++ b/weather_station/protocols/protocol_items.h @@ -20,5 +20,6 @@ #include "tx_8300.h" #include "wendox_w6726.h" #include "auriol_ahfl.h" +#include "kedsum_th.h" extern const SubGhzProtocolRegistry weather_station_protocol_registry;