Files
Momentum-Firmware/lib/subghz/protocols/bresser_3ch.c
m7i-org 3351f9b636 Sub-GHz: Add Bresser 3CH weather station protocol (#217)
* feat(subghz): added Bresser 3CH weather station

Added the Bresser 3CH, a weather station supported by rtl_433 already.

* Update changelog

---------

Co-authored-by: Willy-JL <49810075+Willy-JL@users.noreply.github.com>
2024-09-18 01:14:29 +02:00

265 lines
10 KiB
C

#include "bresser_3ch.h"
#include "furi/core/log.h"
#define TAG "WSProtocolBresser3ch"
/*
* Help:
* https://github.com/merbanan/rtl_433/blob/master/src/devices/bresser_3ch.c
*
* Bresser sensor protocol.
*
* The protocol is for the wireless Temperature/Humidity sensor
* - Bresser Thermo-/Hygro-Sensor 3CH
* - also works for Renkforce DM-7511
*
* The sensor sends 15 identical packages of 40 bits each ~60s.
* The bits are PWM modulated with On Off Keying.
*
* A short pulse of 250 us followed by a 500 us gap is a 0 bit,
* a long pulse of 500 us followed by a 250 us gap is a 1 bit,
* there is a sync preamble of pulse, gap, 750 us each, repeated 4 times.
* Actual received and demodulated timings might be 2% shorter.
*
* The data is grouped in 5 bytes / 10 nibbles
*
* [id] [id] [flags] [temp] [temp] [temp] [humi] [humi] [chk] [chk]
*
* - id is an 8 bit random id that is generated when the sensor starts
* - flags are 4 bits battery low indicator, test button press and channel
* - temp is 12 bit unsigned fahrenheit offset by 90 and scaled by 10
* - humi is 8 bit relative humidity percentage
* - chk is the sum of the four data bytes
*
* @m7i-org - because there's more stuff screaming in the ether than you might think
*
*/
static const SubGhzBlockConst ws_protocol_bresser_3ch_const = {
.te_short = 250,
.te_long = 500,
.te_delta = 150,
.min_count_bit_for_found = 40,
};
struct WSProtocolDecoderBresser3ch {
SubGhzProtocolDecoderBase base;
SubGhzBlockDecoder decoder;
WSBlockGeneric generic;
};
struct WSProtocolEncoderBresser3ch {
SubGhzProtocolEncoderBase base;
SubGhzProtocolBlockEncoder encoder;
WSBlockGeneric generic;
};
const SubGhzProtocolDecoder ws_protocol_bresser_3ch_decoder = {
.alloc = ws_protocol_decoder_bresser_3ch_alloc,
.free = ws_protocol_decoder_bresser_3ch_free,
.feed = ws_protocol_decoder_bresser_3ch_feed,
.reset = ws_protocol_decoder_bresser_3ch_reset,
.get_hash_data = NULL,
.get_hash_data_long = ws_protocol_decoder_bresser_3ch_get_hash_data,
.serialize = ws_protocol_decoder_bresser_3ch_serialize,
.deserialize = ws_protocol_decoder_bresser_3ch_deserialize,
.get_string = ws_protocol_decoder_bresser_3ch_get_string,
.get_string_brief = NULL,
};
const SubGhzProtocolEncoder ws_protocol_bresser_3ch_encoder = {
.alloc = NULL,
.free = NULL,
.deserialize = NULL,
.stop = NULL,
.yield = NULL,
};
const SubGhzProtocol ws_protocol_bresser_3ch = {
.name = WS_PROTOCOL_BRESSER_3CH_NAME,
.type = SubGhzProtocolTypeStatic,
.flag = SubGhzProtocolFlag_433 | SubGhzProtocolFlag_315 | SubGhzProtocolFlag_868 |
SubGhzProtocolFlag_AM | SubGhzProtocolFlag_Decodable | SubGhzProtocolFlag_Load |
SubGhzProtocolFlag_Save,
.filter = SubGhzProtocolFilter_Weather,
.decoder = &ws_protocol_bresser_3ch_decoder,
.encoder = &ws_protocol_bresser_3ch_encoder,
};
typedef enum {
Bresser3chDecoderStepReset = 0,
Bresser3chDecoderStepPreambleDn,
Bresser3chDecoderStepPreambleUp,
Bresser3chDecoderStepSaveDuration,
Bresser3chDecoderStepCheckDuration,
} Bresser3chDecoderStep;
void* ws_protocol_decoder_bresser_3ch_alloc(SubGhzEnvironment* environment) {
UNUSED(environment);
WSProtocolDecoderBresser3ch* instance = malloc(sizeof(WSProtocolDecoderBresser3ch));
instance->base.protocol = &ws_protocol_bresser_3ch;
instance->generic.protocol_name = instance->base.protocol->name;
return instance;
}
void ws_protocol_decoder_bresser_3ch_free(void* context) {
furi_assert(context);
WSProtocolDecoderBresser3ch* instance = context;
free(instance);
}
void ws_protocol_decoder_bresser_3ch_reset(void* context) {
furi_assert(context);
WSProtocolDecoderBresser3ch* instance = context;
instance->decoder.parser_step = Bresser3chDecoderStepReset;
}
static bool ws_protocol_bresser_3ch_check(WSProtocolDecoderBresser3ch* instance) {
if(!instance->decoder.decode_data) return false;
uint8_t sum = (((instance->decoder.decode_data >> 32) & 0xff) +
((instance->decoder.decode_data >> 24) & 0xff) +
((instance->decoder.decode_data >> 16) & 0xff) +
((instance->decoder.decode_data >> 8) & 0xff)) &
0xff;
return (instance->decoder.decode_data & 0xff) == sum;
}
/**
* Analysis of received data
* @param instance Pointer to a WSBlockGeneric* instance
*/
static void ws_protocol_bresser_3ch_extract_data(WSBlockGeneric* instance) {
instance->id = (instance->data >> 32) & 0xff;
instance->battery_low = ((instance->data >> 31) & 0x1);
instance->btn = (instance->data >> 30) & 0x1;
instance->channel = (instance->data >> 28) & 0x3;
int16_t temp = (instance->data >> 16) & 0xfff;
instance->temp = locale_fahrenheit_to_celsius((float)(temp - 900) / 10.0);
instance->humidity = (instance->data >> 8) & 0xff;
}
void ws_protocol_decoder_bresser_3ch_feed(void* context, bool level, uint32_t duration) {
furi_assert(context);
WSProtocolDecoderBresser3ch* instance = context;
switch(instance->decoder.parser_step) {
case Bresser3chDecoderStepReset:
if(level && DURATION_DIFF(duration, ws_protocol_bresser_3ch_const.te_short * 3) <
ws_protocol_bresser_3ch_const.te_delta) {
instance->decoder.te_last = duration;
instance->decoder.parser_step = Bresser3chDecoderStepPreambleDn;
instance->decoder.decode_data = 0;
instance->decoder.decode_count_bit = 0;
}
break;
case Bresser3chDecoderStepPreambleDn:
if((!level) && DURATION_DIFF(duration, ws_protocol_bresser_3ch_const.te_short * 3) <
ws_protocol_bresser_3ch_const.te_delta) {
if(DURATION_DIFF(
instance->decoder.te_last, ws_protocol_bresser_3ch_const.te_short * 12) <
ws_protocol_bresser_3ch_const.te_delta * 2) {
// End of sync after 4*750 (12*250) high values, start reading the message
instance->decoder.parser_step = Bresser3chDecoderStepSaveDuration;
} else {
instance->decoder.parser_step = Bresser3chDecoderStepPreambleUp;
}
} else {
instance->decoder.parser_step = Bresser3chDecoderStepReset;
}
break;
case Bresser3chDecoderStepPreambleUp:
if(level && DURATION_DIFF(duration, ws_protocol_bresser_3ch_const.te_short * 3) <
ws_protocol_bresser_3ch_const.te_delta) {
instance->decoder.te_last = instance->decoder.te_last + duration;
instance->decoder.parser_step = Bresser3chDecoderStepPreambleDn;
} else {
instance->decoder.parser_step = Bresser3chDecoderStepReset;
}
break;
case Bresser3chDecoderStepSaveDuration:
if(instance->decoder.decode_count_bit ==
ws_protocol_bresser_3ch_const.min_count_bit_for_found) {
if(ws_protocol_bresser_3ch_check(instance)) {
instance->generic.data = instance->decoder.decode_data;
instance->generic.data_count_bit = instance->decoder.decode_count_bit;
ws_protocol_bresser_3ch_extract_data(&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 = Bresser3chDecoderStepReset;
} else if(level) {
instance->decoder.te_last = duration;
instance->decoder.parser_step = Bresser3chDecoderStepCheckDuration;
} else {
instance->decoder.parser_step = Bresser3chDecoderStepReset;
}
break;
case Bresser3chDecoderStepCheckDuration:
if(!level) {
if(DURATION_DIFF(instance->decoder.te_last, ws_protocol_bresser_3ch_const.te_short) <
ws_protocol_bresser_3ch_const.te_delta &&
DURATION_DIFF(duration, ws_protocol_bresser_3ch_const.te_long) <
ws_protocol_bresser_3ch_const.te_delta) {
subghz_protocol_blocks_add_bit(&instance->decoder, 0);
instance->decoder.parser_step = Bresser3chDecoderStepSaveDuration;
} else if(
DURATION_DIFF(instance->decoder.te_last, ws_protocol_bresser_3ch_const.te_long) <
ws_protocol_bresser_3ch_const.te_delta &&
DURATION_DIFF(duration, ws_protocol_bresser_3ch_const.te_short) <
ws_protocol_bresser_3ch_const.te_delta) {
subghz_protocol_blocks_add_bit(&instance->decoder, 1);
instance->decoder.parser_step = Bresser3chDecoderStepSaveDuration;
} else
instance->decoder.parser_step = Bresser3chDecoderStepReset;
} else
instance->decoder.parser_step = Bresser3chDecoderStepReset;
break;
}
}
uint32_t ws_protocol_decoder_bresser_3ch_get_hash_data(void* context) {
furi_assert(context);
WSProtocolDecoderBresser3ch* instance = context;
return subghz_protocol_blocks_get_hash_data_long(
&instance->decoder, (instance->decoder.decode_count_bit / 8) + 1);
}
SubGhzProtocolStatus ws_protocol_decoder_bresser_3ch_serialize(
void* context,
FlipperFormat* flipper_format,
SubGhzRadioPreset* preset) {
furi_assert(context);
WSProtocolDecoderBresser3ch* instance = context;
return ws_block_generic_serialize(&instance->generic, flipper_format, preset);
}
SubGhzProtocolStatus
ws_protocol_decoder_bresser_3ch_deserialize(void* context, FlipperFormat* flipper_format) {
furi_assert(context);
WSProtocolDecoderBresser3ch* instance = context;
return ws_block_generic_deserialize_check_count_bit(
&instance->generic, flipper_format, ws_protocol_bresser_3ch_const.min_count_bit_for_found);
}
void ws_protocol_decoder_bresser_3ch_get_string(void* context, FuriString* output) {
furi_assert(context);
WSProtocolDecoderBresser3ch* instance = context;
ws_block_generic_get_string(&instance->generic, output);
}