Mirrors/unleashed-firmware
2
0
Fork 0
mirror of https://github.com/DarkFlippers/unleashed-firmware synced 2024-12-30 06:33:07 +00:00
Code Issues Projects Releases Packages Wiki Activity
unleashed-firmware/applications/plugins/weather_station/protocols/gt_wt_03.c
Skorpionm 72ca6b25e9
[FL-3106] SubGhz: better and more verbose error handling in protocols, stricter CAME validation (#2443) 
* SubGhz: add error protocol
* WS: add error protocol
* SubGhz: error processing
* SubGhz: more stringent CAME protocol restrictions
* SubGhz: fix header duration CAME protocol
* SubGhz: delete comments
* SubGhz: sync SubGhzProtocolStatus with FuriStatus
* SubGhz: update documentation and bump api_version

Co-authored-by: あく <alleteam@gmail.com>
2023-03-04 00:09:13 +09:00

330 lines
13 KiB
C
Raw Blame History

#include "gt_wt_03.h"
#define TAG "WSProtocolGT_WT03"
/*
* Help
* https://github.com/merbanan/rtl_433/blob/master/src/devices/gt_wt_03.c
*
*
* Globaltronics GT-WT-03 sensor on 433.92MHz.
* The 01-set sensor has 60 ms packet gap with 10 repeats.
* The 02-set sensor has no packet gap with 23 repeats.
* Example:
* {41} 17 cf be fa 6a 80 [ S1 C1 26,1 C 78.9 F 48% Bat-Good Manual-Yes ]
* {41} 17 cf be fa 6a 80 [ S1 C1 26,1 C 78.9 F 48% Bat-Good Manual-Yes Batt-Changed ]
* {41} 17 cf fe fa ea 80 [ S1 C1 26,1 C 78.9 F 48% Bat-Good Manual-No Batt-Changed ]
* {41} 01 cf 6f 11 b2 80 [ S2 C2 23,8 C 74.8 F 48% Bat-LOW Manual-No ]
* {41} 01 c8 d0 2b 76 80 [ S2 C3 -4,4 C 24.1 F 55% Bat-Good Manual-No Batt-Changed ]
* Format string:
* ID:8h HUM:8d B:b M:b C:2d TEMP:12d CHK:8h 1x
* Data layout:
* TYP IIIIIIII HHHHHHHH BMCCTTTT TTTTTTTT XXXXXXXX
* - I: Random Device Code: changes with battery reset
* - H: Humidity: 8 Bit 00-99, Display LL=10%, Display HH=110% (Range 20-95%)
* - B: Battery: 0=OK 1=LOW
* - M: Manual Send Button Pressed: 0=not pressed, 1=pressed
* - C: Channel: 00=CH1, 01=CH2, 10=CH3
* - T: Temperature: 12 Bit 2's complement, scaled by 10, range-50.0 C (-50.1 shown as Lo) to +70.0 C (+70.1 C is shown as Hi)
* - X: Checksum, xor shifting key per byte
* Humidity:
* - the working range is 20-95 %
* - if "LL" in display view it sends 10 %
* - if "HH" in display view it sends 110%
* Checksum:
* Per byte xor the key for each 1-bit, shift per bit. Key list per bit, starting at MSB:
* - 0x00 [07]
* - 0x80 [06]
* - 0x40 [05]
* - 0x20 [04]
* - 0x10 [03]
* - 0x88 [02]
* - 0xc4 [01]
* - 0x62 [00]
* Note: this can also be seen as lower byte of a Galois/Fibonacci LFSR-16, gen 0x00, init 0x3100 (or 0x62 if reversed) resetting at every byte.
* Battery voltages:
* - U=<2,65V +- ~5% Battery indicator
* - U=>2.10C +- 5% plausible readings
* - U=2,00V +- ~5% Temperature offset -5°C Humidity offset unknown
* - U=<1,95V +- ~5% does not initialize anymore
* - U=1,90V +- 5% temperature offset -15°C
* - U=1,80V +- 5% Display is showing refresh pattern
* - U=1.75V +- ~5% TX causes cut out
*
*/
static const SubGhzBlockConst ws_protocol_gt_wt_03_const = {
.te_short = 285,
.te_long = 570,
.te_delta = 120,
.min_count_bit_for_found = 41,
};
struct WSProtocolDecoderGT_WT03 {
SubGhzProtocolDecoderBase base;
SubGhzBlockDecoder decoder;
WSBlockGeneric generic;
uint16_t header_count;
};
struct WSProtocolEncoderGT_WT03 {
SubGhzProtocolEncoderBase base;
SubGhzProtocolBlockEncoder encoder;
WSBlockGeneric generic;
};
typedef enum {
GT_WT03DecoderStepReset = 0,
GT_WT03DecoderStepCheckPreambule,
GT_WT03DecoderStepSaveDuration,
GT_WT03DecoderStepCheckDuration,
} GT_WT03DecoderStep;
const SubGhzProtocolDecoder ws_protocol_gt_wt_03_decoder = {
.alloc = ws_protocol_decoder_gt_wt_03_alloc,
.free = ws_protocol_decoder_gt_wt_03_free,
.feed = ws_protocol_decoder_gt_wt_03_feed,
.reset = ws_protocol_decoder_gt_wt_03_reset,
.get_hash_data = ws_protocol_decoder_gt_wt_03_get_hash_data,
.serialize = ws_protocol_decoder_gt_wt_03_serialize,
.deserialize = ws_protocol_decoder_gt_wt_03_deserialize,
.get_string = ws_protocol_decoder_gt_wt_03_get_string,
};
const SubGhzProtocolEncoder ws_protocol_gt_wt_03_encoder = {
.alloc = NULL,
.free = NULL,
.deserialize = NULL,
.stop = NULL,
.yield = NULL,
};
const SubGhzProtocol ws_protocol_gt_wt_03 = {
.name = WS_PROTOCOL_GT_WT_03_NAME,
.type = SubGhzProtocolWeatherStation,
.flag = SubGhzProtocolFlag_433 | SubGhzProtocolFlag_315 | SubGhzProtocolFlag_868 |
SubGhzProtocolFlag_AM | SubGhzProtocolFlag_Decodable,
.decoder = &ws_protocol_gt_wt_03_decoder,
.encoder = &ws_protocol_gt_wt_03_encoder,
};
void* ws_protocol_decoder_gt_wt_03_alloc(SubGhzEnvironment* environment) {
UNUSED(environment);
WSProtocolDecoderGT_WT03* instance = malloc(sizeof(WSProtocolDecoderGT_WT03));
instance->base.protocol = &ws_protocol_gt_wt_03;
instance->generic.protocol_name = instance->base.protocol->name;
return instance;
}
void ws_protocol_decoder_gt_wt_03_free(void* context) {
furi_assert(context);
WSProtocolDecoderGT_WT03* instance = context;
free(instance);
}
void ws_protocol_decoder_gt_wt_03_reset(void* context) {
furi_assert(context);
WSProtocolDecoderGT_WT03* instance = context;
instance->decoder.parser_step = GT_WT03DecoderStepReset;
}
static bool ws_protocol_gt_wt_03_check_crc(WSProtocolDecoderGT_WT03* instance) {
uint8_t msg[] = {
instance->decoder.decode_data >> 33,
instance->decoder.decode_data >> 25,
instance->decoder.decode_data >> 17,
instance->decoder.decode_data >> 9};
uint8_t sum = 0;
for(unsigned k = 0; k < sizeof(msg); ++k) {
uint8_t data = msg[k];
uint16_t key = 0x3100;
for(int i = 7; i >= 0; --i) {
// XOR key into sum if data bit is set
if((data >> i) & 1) sum ^= key & 0xff;
// roll the key right
key = (key >> 1);
}
}
return ((sum ^ (uint8_t)((instance->decoder.decode_data >> 1) & 0xFF)) == 0x2D);
}
/**
* Analysis of received data
* @param instance Pointer to a WSBlockGeneric* instance
*/
static void ws_protocol_gt_wt_03_remote_controller(WSBlockGeneric* instance) {
instance->id = instance->data >> 33;
instance->humidity = (instance->data >> 25) & 0xFF;
if(instance->humidity <= 10) { // actually the sensors sends 10 below working range of 20%
instance->humidity = 0;
} else if(instance->humidity > 95) { // actually the sensors sends 110 above working range of 90%
instance->humidity = 100;
}
instance->battery_low = (instance->data >> 24) & 1;
instance->btn = (instance->data >> 23) & 1;
instance->channel = ((instance->data >> 21) & 0x03) + 1;
if(!((instance->data >> 20) & 1)) {
instance->temp = (float)((instance->data >> 9) & 0x07FF) / 10.0f;
} else {
instance->temp = (float)((~(instance->data >> 9) & 0x07FF) + 1) / -10.0f;
}
}
void ws_protocol_decoder_gt_wt_03_feed(void* context, bool level, uint32_t duration) {
furi_assert(context);
WSProtocolDecoderGT_WT03* instance = context;
switch(instance->decoder.parser_step) {
case GT_WT03DecoderStepReset:
if((level) && (DURATION_DIFF(duration, ws_protocol_gt_wt_03_const.te_short * 3) <
ws_protocol_gt_wt_03_const.te_delta * 2)) {
instance->decoder.parser_step = GT_WT03DecoderStepCheckPreambule;
instance->decoder.te_last = duration;
instance->header_count = 0;
}
break;
case GT_WT03DecoderStepCheckPreambule:
if(level) {
instance->decoder.te_last = duration;
} else {
if((DURATION_DIFF(instance->decoder.te_last, ws_protocol_gt_wt_03_const.te_short * 3) <
ws_protocol_gt_wt_03_const.te_delta * 2) &&
(DURATION_DIFF(duration, ws_protocol_gt_wt_03_const.te_short * 3) <
ws_protocol_gt_wt_03_const.te_delta * 2)) {
//Found preambule
instance->header_count++;
} else if(instance->header_count == 4) {
if((DURATION_DIFF(instance->decoder.te_last, ws_protocol_gt_wt_03_const.te_short) <
ws_protocol_gt_wt_03_const.te_delta) &&
(DURATION_DIFF(duration, ws_protocol_gt_wt_03_const.te_long) <
ws_protocol_gt_wt_03_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 = GT_WT03DecoderStepSaveDuration;
} else if(
(DURATION_DIFF(instance->decoder.te_last, ws_protocol_gt_wt_03_const.te_long) <
ws_protocol_gt_wt_03_const.te_delta) &&
(DURATION_DIFF(duration, ws_protocol_gt_wt_03_const.te_short) <
ws_protocol_gt_wt_03_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 = GT_WT03DecoderStepSaveDuration;
} else {
instance->decoder.parser_step = GT_WT03DecoderStepReset;
}
} else {
instance->decoder.parser_step = GT_WT03DecoderStepReset;
}
}
break;
case GT_WT03DecoderStepSaveDuration:
if(level) {
instance->decoder.te_last = duration;
instance->decoder.parser_step = GT_WT03DecoderStepCheckDuration;
} else {
instance->decoder.parser_step = GT_WT03DecoderStepReset;
}
break;
case GT_WT03DecoderStepCheckDuration:
if(!level) {
if(((DURATION_DIFF(instance->decoder.te_last, ws_protocol_gt_wt_03_const.te_short * 3) <
ws_protocol_gt_wt_03_const.te_delta * 2) &&
(DURATION_DIFF(duration, ws_protocol_gt_wt_03_const.te_short * 3) <
ws_protocol_gt_wt_03_const.te_delta * 2))) {
if((instance->decoder.decode_count_bit ==
ws_protocol_gt_wt_03_const.min_count_bit_for_found) &&
ws_protocol_gt_wt_03_check_crc(instance)) {
instance->generic.data = instance->decoder.decode_data;
instance->generic.data_count_bit = instance->decoder.decode_count_bit;
ws_protocol_gt_wt_03_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->header_count = 1;
instance->decoder.parser_step = GT_WT03DecoderStepCheckPreambule;
break;
} else if(
(DURATION_DIFF(instance->decoder.te_last, ws_protocol_gt_wt_03_const.te_short) <
ws_protocol_gt_wt_03_const.te_delta) &&
(DURATION_DIFF(duration, ws_protocol_gt_wt_03_const.te_long) <
ws_protocol_gt_wt_03_const.te_delta)) {
subghz_protocol_blocks_add_bit(&instance->decoder, 0);
instance->decoder.parser_step = GT_WT03DecoderStepSaveDuration;
} else if(
(DURATION_DIFF(instance->decoder.te_last, ws_protocol_gt_wt_03_const.te_long) <
ws_protocol_gt_wt_03_const.te_delta) &&
(DURATION_DIFF(duration, ws_protocol_gt_wt_03_const.te_short) <
ws_protocol_gt_wt_03_const.te_delta)) {
subghz_protocol_blocks_add_bit(&instance->decoder, 1);
instance->decoder.parser_step = GT_WT03DecoderStepSaveDuration;
} else {
instance->decoder.parser_step = GT_WT03DecoderStepReset;
}
} else {
instance->decoder.parser_step = GT_WT03DecoderStepReset;
}
break;
}
}
uint8_t ws_protocol_decoder_gt_wt_03_get_hash_data(void* context) {
furi_assert(context);
WSProtocolDecoderGT_WT03* instance = context;
return subghz_protocol_blocks_get_hash_data(
&instance->decoder, (instance->decoder.decode_count_bit / 8) + 1);
}
SubGhzProtocolStatus ws_protocol_decoder_gt_wt_03_serialize(
void* context,
FlipperFormat* flipper_format,
SubGhzRadioPreset* preset) {
furi_assert(context);
WSProtocolDecoderGT_WT03* instance = context;
return ws_block_generic_serialize(&instance->generic, flipper_format, preset);
}
SubGhzProtocolStatus
ws_protocol_decoder_gt_wt_03_deserialize(void* context, FlipperFormat* flipper_format) {
furi_assert(context);
WSProtocolDecoderGT_WT03* instance = context;
return ws_block_generic_deserialize_check_count_bit(
&instance->generic, flipper_format, ws_protocol_gt_wt_03_const.min_count_bit_for_found);
}
void ws_protocol_decoder_gt_wt_03_get_string(void* context, FuriString* output) {
furi_assert(context);
WSProtocolDecoderGT_WT03* 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);
}
Reference in a new issue View git blame Copy permalink