mirror of
https://github.com/DarkFlippers/unleashed-firmware
synced 2024-12-24 11:43:09 +00:00
365 lines
13 KiB
C
365 lines
13 KiB
C
#include "oregon3.h"
|
|
|
|
#include <lib/subghz/blocks/const.h>
|
|
#include <lib/subghz/blocks/decoder.h>
|
|
#include <lib/subghz/blocks/encoder.h>
|
|
#include <lib/subghz/blocks/math.h>
|
|
#include "ws_generic.h"
|
|
|
|
#include <lib/toolbox/manchester_decoder.h>
|
|
#include <lib/flipper_format/flipper_format_i.h>
|
|
|
|
#define TAG "WSProtocolOregon3"
|
|
|
|
static const SubGhzBlockConst ws_oregon3_const = {
|
|
.te_long = 1100,
|
|
.te_short = 500,
|
|
.te_delta = 300,
|
|
.min_count_bit_for_found = 32,
|
|
};
|
|
|
|
#define OREGON3_PREAMBLE_BITS 28
|
|
#define OREGON3_PREAMBLE_MASK 0b1111111111111111111111111111
|
|
// 24 ones + 0101 (inverted A)
|
|
#define OREGON3_PREAMBLE 0b1111111111111111111111110101
|
|
|
|
// Fixed part contains:
|
|
// - Sensor type: 16 bits
|
|
// - Channel: 4 bits
|
|
// - ID (changes when batteries are changed): 8 bits
|
|
// - Battery status: 4 bits
|
|
#define OREGON3_FIXED_PART_BITS (16 + 4 + 8 + 4)
|
|
#define OREGON3_SENSOR_ID(d) (((d) >> 16) & 0xFFFF)
|
|
#define OREGON3_CHECKSUM_BITS 8
|
|
|
|
// bit indicating the low battery
|
|
#define OREGON3_FLAG_BAT_LOW 0x4
|
|
|
|
/// Documentation for Oregon Scientific protocols can be found here:
|
|
/// https://www.osengr.org/Articles/OS-RF-Protocols-IV.pdf
|
|
// Sensors ID
|
|
#define ID_THGR221 0xf824
|
|
|
|
struct WSProtocolDecoderOregon3 {
|
|
SubGhzProtocolDecoderBase base;
|
|
|
|
SubGhzBlockDecoder decoder;
|
|
WSBlockGeneric generic;
|
|
ManchesterState manchester_state;
|
|
bool prev_bit;
|
|
|
|
uint8_t var_bits;
|
|
uint64_t var_data;
|
|
};
|
|
|
|
typedef struct WSProtocolDecoderOregon3 WSProtocolDecoderOregon3;
|
|
|
|
typedef enum {
|
|
Oregon3DecoderStepReset = 0,
|
|
Oregon3DecoderStepFoundPreamble,
|
|
Oregon3DecoderStepVarData,
|
|
} Oregon3DecoderStep;
|
|
|
|
void* ws_protocol_decoder_oregon3_alloc(SubGhzEnvironment* environment) {
|
|
UNUSED(environment);
|
|
WSProtocolDecoderOregon3* instance = malloc(sizeof(WSProtocolDecoderOregon3));
|
|
instance->base.protocol = &ws_protocol_oregon3;
|
|
instance->generic.protocol_name = instance->base.protocol->name;
|
|
instance->generic.humidity = WS_NO_HUMIDITY;
|
|
instance->generic.temp = WS_NO_TEMPERATURE;
|
|
instance->generic.btn = WS_NO_BTN;
|
|
instance->generic.channel = WS_NO_CHANNEL;
|
|
instance->generic.battery_low = WS_NO_BATT;
|
|
instance->generic.id = WS_NO_ID;
|
|
instance->prev_bit = false;
|
|
return instance;
|
|
}
|
|
|
|
void ws_protocol_decoder_oregon3_free(void* context) {
|
|
furi_assert(context);
|
|
WSProtocolDecoderOregon3* instance = context;
|
|
free(instance);
|
|
}
|
|
|
|
void ws_protocol_decoder_oregon3_reset(void* context) {
|
|
furi_assert(context);
|
|
WSProtocolDecoderOregon3* instance = context;
|
|
instance->decoder.parser_step = Oregon3DecoderStepReset;
|
|
instance->decoder.decode_data = 0UL;
|
|
instance->decoder.decode_count_bit = 0;
|
|
manchester_advance(
|
|
instance->manchester_state, ManchesterEventReset, &instance->manchester_state, NULL);
|
|
instance->prev_bit = false;
|
|
instance->var_data = 0;
|
|
instance->var_bits = 0;
|
|
}
|
|
|
|
static ManchesterEvent level_and_duration_to_event(bool level, uint32_t duration) {
|
|
bool is_long = false;
|
|
|
|
if(DURATION_DIFF(duration, ws_oregon3_const.te_long) < ws_oregon3_const.te_delta) {
|
|
is_long = true;
|
|
} else if(DURATION_DIFF(duration, ws_oregon3_const.te_short) < ws_oregon3_const.te_delta) {
|
|
is_long = false;
|
|
} else {
|
|
return ManchesterEventReset;
|
|
}
|
|
|
|
if(level)
|
|
return is_long ? ManchesterEventLongHigh : ManchesterEventShortHigh;
|
|
else
|
|
return is_long ? ManchesterEventLongLow : ManchesterEventShortLow;
|
|
}
|
|
|
|
// From sensor id code return amount of bits in variable section
|
|
// https://temofeev.ru/info/articles/o-dekodirovanii-protokola-pogodnykh-datchikov-oregon-scientific
|
|
static uint8_t oregon3_sensor_id_var_bits(uint16_t sensor_id) {
|
|
switch(sensor_id) {
|
|
case ID_THGR221:
|
|
// nibbles: temp + hum + '0'
|
|
return (4 + 2 + 1) * 4;
|
|
default:
|
|
FURI_LOG_D(TAG, "Unsupported sensor id 0x%x", sensor_id);
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
static void ws_oregon3_decode_const_data(WSBlockGeneric* ws_block) {
|
|
ws_block->id = OREGON3_SENSOR_ID(ws_block->data);
|
|
ws_block->channel = (ws_block->data >> 12) & 0xF;
|
|
ws_block->battery_low = (ws_block->data & OREGON3_FLAG_BAT_LOW) ? 1 : 0;
|
|
}
|
|
|
|
static uint16_t ws_oregon3_bcd_decode_short(uint32_t data) {
|
|
return (data & 0xF) * 10 + ((data >> 4) & 0xF);
|
|
}
|
|
|
|
static float ws_oregon3_decode_temp(uint32_t data) {
|
|
int32_t temp_val;
|
|
temp_val = ws_oregon3_bcd_decode_short(data >> 4);
|
|
temp_val *= 10;
|
|
temp_val += (data >> 12) & 0xF;
|
|
if(data & 0xF) temp_val = -temp_val;
|
|
return (float)temp_val / 10.0;
|
|
}
|
|
|
|
static void ws_oregon3_decode_var_data(WSBlockGeneric* ws_b, uint16_t sensor_id, uint32_t data) {
|
|
switch(sensor_id) {
|
|
case ID_THGR221:
|
|
default:
|
|
ws_b->humidity = ws_oregon3_bcd_decode_short(data >> 4);
|
|
ws_b->temp = ws_oregon3_decode_temp(data >> 12);
|
|
break;
|
|
}
|
|
}
|
|
|
|
void ws_protocol_decoder_oregon3_feed(void* context, bool level, uint32_t duration) {
|
|
furi_assert(context);
|
|
WSProtocolDecoderOregon3* instance = context;
|
|
// Oregon v3.0 protocol is inverted
|
|
ManchesterEvent event = level_and_duration_to_event(!level, duration);
|
|
|
|
// low-level bit sequence decoding
|
|
if(event == ManchesterEventReset) {
|
|
instance->decoder.parser_step = Oregon3DecoderStepReset;
|
|
instance->prev_bit = false;
|
|
instance->decoder.decode_data = 0UL;
|
|
instance->decoder.decode_count_bit = 0;
|
|
}
|
|
if(manchester_advance(
|
|
instance->manchester_state, event, &instance->manchester_state, &instance->prev_bit)) {
|
|
subghz_protocol_blocks_add_bit(&instance->decoder, instance->prev_bit);
|
|
}
|
|
|
|
switch(instance->decoder.parser_step) {
|
|
case Oregon3DecoderStepReset:
|
|
// waiting for fixed oregon3 preamble
|
|
if(instance->decoder.decode_count_bit >= OREGON3_PREAMBLE_BITS &&
|
|
((instance->decoder.decode_data & OREGON3_PREAMBLE_MASK) == OREGON3_PREAMBLE)) {
|
|
instance->decoder.parser_step = Oregon3DecoderStepFoundPreamble;
|
|
instance->decoder.decode_count_bit = 0;
|
|
instance->decoder.decode_data = 0UL;
|
|
}
|
|
break;
|
|
case Oregon3DecoderStepFoundPreamble:
|
|
// waiting for fixed oregon3 data
|
|
if(instance->decoder.decode_count_bit == OREGON3_FIXED_PART_BITS) {
|
|
instance->generic.data = instance->decoder.decode_data;
|
|
instance->generic.data_count_bit = instance->decoder.decode_count_bit;
|
|
instance->decoder.decode_data = 0UL;
|
|
instance->decoder.decode_count_bit = 0;
|
|
|
|
// reverse nibbles in decoded data as oregon v3.0 is LSB first
|
|
instance->generic.data = (instance->generic.data & 0x55555555) << 1 |
|
|
(instance->generic.data & 0xAAAAAAAA) >> 1;
|
|
instance->generic.data = (instance->generic.data & 0x33333333) << 2 |
|
|
(instance->generic.data & 0xCCCCCCCC) >> 2;
|
|
|
|
ws_oregon3_decode_const_data(&instance->generic);
|
|
instance->var_bits =
|
|
oregon3_sensor_id_var_bits(OREGON3_SENSOR_ID(instance->generic.data));
|
|
|
|
if(!instance->var_bits) {
|
|
// sensor is not supported, stop decoding
|
|
instance->decoder.parser_step = Oregon3DecoderStepReset;
|
|
} else {
|
|
instance->decoder.parser_step = Oregon3DecoderStepVarData;
|
|
}
|
|
}
|
|
break;
|
|
case Oregon3DecoderStepVarData:
|
|
// waiting for variable (sensor-specific data)
|
|
if(instance->decoder.decode_count_bit == instance->var_bits + OREGON3_CHECKSUM_BITS) {
|
|
instance->var_data = instance->decoder.decode_data & 0xFFFFFFFFFFFFFFFF;
|
|
|
|
// reverse nibbles in var data
|
|
instance->var_data = (instance->var_data & 0x5555555555555555) << 1 |
|
|
(instance->var_data & 0xAAAAAAAAAAAAAAAA) >> 1;
|
|
instance->var_data = (instance->var_data & 0x3333333333333333) << 2 |
|
|
(instance->var_data & 0xCCCCCCCCCCCCCCCC) >> 2;
|
|
|
|
ws_oregon3_decode_var_data(
|
|
&instance->generic,
|
|
OREGON3_SENSOR_ID(instance->generic.data),
|
|
instance->var_data >> OREGON3_CHECKSUM_BITS);
|
|
|
|
instance->decoder.parser_step = Oregon3DecoderStepReset;
|
|
if(instance->base.callback)
|
|
instance->base.callback(&instance->base, instance->base.context);
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
|
|
uint8_t ws_protocol_decoder_oregon3_get_hash_data(void* context) {
|
|
furi_assert(context);
|
|
WSProtocolDecoderOregon3* instance = context;
|
|
return subghz_protocol_blocks_get_hash_data(
|
|
&instance->decoder, (instance->decoder.decode_count_bit / 8) + 1);
|
|
}
|
|
|
|
SubGhzProtocolStatus ws_protocol_decoder_oregon3_serialize(
|
|
void* context,
|
|
FlipperFormat* flipper_format,
|
|
SubGhzRadioPreset* preset) {
|
|
furi_assert(context);
|
|
WSProtocolDecoderOregon3* instance = context;
|
|
SubGhzProtocolStatus ret = SubGhzProtocolStatusError;
|
|
ret = ws_block_generic_serialize(&instance->generic, flipper_format, preset);
|
|
if(ret != SubGhzProtocolStatusOk) return ret;
|
|
uint32_t temp = instance->var_bits;
|
|
if(!flipper_format_write_uint32(flipper_format, "VarBits", &temp, 1)) {
|
|
FURI_LOG_E(TAG, "Error adding VarBits");
|
|
return SubGhzProtocolStatusErrorParserOthers;
|
|
}
|
|
if(!flipper_format_write_hex(
|
|
flipper_format,
|
|
"VarData",
|
|
(const uint8_t*)&instance->var_data,
|
|
sizeof(instance->var_data))) {
|
|
FURI_LOG_E(TAG, "Error adding VarData");
|
|
return SubGhzProtocolStatusErrorParserOthers;
|
|
}
|
|
return ret;
|
|
}
|
|
|
|
SubGhzProtocolStatus
|
|
ws_protocol_decoder_oregon3_deserialize(void* context, FlipperFormat* flipper_format) {
|
|
furi_assert(context);
|
|
WSProtocolDecoderOregon3* instance = context;
|
|
uint32_t temp_data;
|
|
SubGhzProtocolStatus ret = SubGhzProtocolStatusError;
|
|
do {
|
|
ret = ws_block_generic_deserialize(&instance->generic, flipper_format);
|
|
if(ret != SubGhzProtocolStatusOk) {
|
|
break;
|
|
}
|
|
if(!flipper_format_read_uint32(flipper_format, "VarBits", &temp_data, 1)) {
|
|
FURI_LOG_E(TAG, "Missing VarLen");
|
|
ret = SubGhzProtocolStatusErrorParserOthers;
|
|
break;
|
|
}
|
|
instance->var_bits = (uint8_t)temp_data;
|
|
if(!flipper_format_read_hex(
|
|
flipper_format,
|
|
"VarData",
|
|
(uint8_t*)&instance->var_data,
|
|
sizeof(instance->var_data))) { //-V1051
|
|
FURI_LOG_E(TAG, "Missing VarData");
|
|
ret = SubGhzProtocolStatusErrorParserOthers;
|
|
break;
|
|
}
|
|
if(instance->generic.data_count_bit != ws_oregon3_const.min_count_bit_for_found) {
|
|
FURI_LOG_E(TAG, "Wrong number of bits in key: %d", instance->generic.data_count_bit);
|
|
ret = SubGhzProtocolStatusErrorValueBitCount;
|
|
break;
|
|
}
|
|
} while(false);
|
|
return ret;
|
|
}
|
|
|
|
static void oregon3_append_check_sum(uint32_t fix_data, uint64_t var_data, FuriString* output) {
|
|
uint8_t sum = fix_data & 0xF;
|
|
uint8_t ref_sum = var_data & 0xFF;
|
|
var_data >>= 4;
|
|
|
|
for(uint8_t i = 1; i < 8; i++) {
|
|
fix_data >>= 4;
|
|
var_data >>= 4;
|
|
sum += (fix_data & 0xF) + (var_data & 0xF);
|
|
}
|
|
|
|
// swap calculated sum nibbles
|
|
sum = (((sum >> 4) & 0xF) | (sum << 4)) & 0xFF;
|
|
if(sum == ref_sum)
|
|
furi_string_cat_printf(output, "Sum ok: 0x%hhX", ref_sum);
|
|
else
|
|
furi_string_cat_printf(output, "Sum err: 0x%hhX vs 0x%hhX", ref_sum, sum);
|
|
}
|
|
|
|
void ws_protocol_decoder_oregon3_get_string(void* context, FuriString* output) {
|
|
furi_assert(context);
|
|
WSProtocolDecoderOregon3* instance = context;
|
|
furi_string_cat_printf(
|
|
output,
|
|
"%s\r\n"
|
|
"ID: 0x%04lX, ch: %d, bat: %d, rc: 0x%02lX\r\n",
|
|
instance->generic.protocol_name,
|
|
instance->generic.id,
|
|
instance->generic.channel,
|
|
instance->generic.battery_low,
|
|
(uint32_t)(instance->generic.data >> 4) & 0xFF);
|
|
|
|
if(instance->var_bits > 0) {
|
|
furi_string_cat_printf(
|
|
output,
|
|
"Temp:%d.%d C Hum:%d%%",
|
|
(int16_t)instance->generic.temp,
|
|
abs(
|
|
((int16_t)(instance->generic.temp * 10) -
|
|
(((int16_t)instance->generic.temp) * 10))),
|
|
instance->generic.humidity);
|
|
oregon3_append_check_sum((uint32_t)instance->generic.data, instance->var_data, output);
|
|
}
|
|
}
|
|
|
|
const SubGhzProtocolDecoder ws_protocol_oregon3_decoder = {
|
|
.alloc = ws_protocol_decoder_oregon3_alloc,
|
|
.free = ws_protocol_decoder_oregon3_free,
|
|
|
|
.feed = ws_protocol_decoder_oregon3_feed,
|
|
.reset = ws_protocol_decoder_oregon3_reset,
|
|
|
|
.get_hash_data = ws_protocol_decoder_oregon3_get_hash_data,
|
|
.serialize = ws_protocol_decoder_oregon3_serialize,
|
|
.deserialize = ws_protocol_decoder_oregon3_deserialize,
|
|
.get_string = ws_protocol_decoder_oregon3_get_string,
|
|
};
|
|
|
|
const SubGhzProtocol ws_protocol_oregon3 = {
|
|
.name = WS_PROTOCOL_OREGON3_NAME,
|
|
.type = SubGhzProtocolWeatherStation,
|
|
.flag = SubGhzProtocolFlag_433 | SubGhzProtocolFlag_AM | SubGhzProtocolFlag_Decodable,
|
|
|
|
.decoder = &ws_protocol_oregon3_decoder,
|
|
};
|