liz/flipperzero-firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Move Oregon2 to Weather Station FAP (#1910)

Browse Source 
* Init copy of oregon2 to weather station app
* WS decoder
* Reuse decoded data
* Delete old protocol
* Delete oregon2 unit test
* Decrement count of random test

Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>
This commit is contained in:
Max Lapan
2022-10-22 17:50:26 +02:00
committed by GitHub
parent f8af0c1509
commit d8fbaba7a0
10 changed files with 109 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
applications/debug/unit_tests/subghz/subghz_test.c
View File

@@ -13,7 +13,7 @@
#define CAME_ATOMO_DIR_NAME EXT_PATH("subghz/assets/came_atomo")
#define NICE_FLOR_S_DIR_NAME EXT_PATH("subghz/assets/nice_flor_s")
#define TEST_RANDOM_DIR_NAME EXT_PATH("unit_tests/subghz/test_random_raw.sub")
#define TEST_RANDOM_COUNT_PARSE 233
#define TEST_RANDOM_COUNT_PARSE 232
#define TEST_TIMEOUT 10000
static SubGhzEnvironment* environment_handler;
@@ -437,13 +437,6 @@ MU_TEST(subghz_decoder_clemsa_test) {
"Test decoder " SUBGHZ_PROTOCOL_CLEMSA_NAME " error\r\n");
}
MU_TEST(subghz_decoder_oregon2_test) {
mu_assert(
subghz_decoder_test(
EXT_PATH("unit_tests/subghz/oregon2_raw.sub"), SUBGHZ_PROTOCOL_OREGON2_NAME),
"Test decoder " SUBGHZ_PROTOCOL_OREGON2_NAME " error\r\n");
}
//test encoders
MU_TEST(subghz_encoder_princeton_test) {
mu_assert(
@@ -605,7 +598,6 @@ MU_TEST_SUITE(subghz) {
MU_RUN_TEST(subghz_decoder_magellan_test);
MU_RUN_TEST(subghz_decoder_intertechno_v3_test);
MU_RUN_TEST(subghz_decoder_clemsa_test);
MU_RUN_TEST(subghz_decoder_oregon2_test);
MU_RUN_TEST(subghz_encoder_princeton_test);
MU_RUN_TEST(subghz_encoder_came_test);

354
applications/plugins/weather_station/protocols/oregon2.c Normal file
View File

@@ -0,0 +1,354 @@
#include "oregon2.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 "WSProtocolOregon2"
static const SubGhzBlockConst ws_oregon2_const = {
.te_long = 1000,
.te_short = 500,
.te_delta = 200,
.min_count_bit_for_found = 32,
};
#define OREGON2_PREAMBLE_BITS 19
#define OREGON2_PREAMBLE_MASK ((1 << (OREGON2_PREAMBLE_BITS + 1)) - 1)
#define OREGON2_SENSOR_ID(d) (((d) >> 16) & 0xFFFF)
#define OREGON2_CHECKSUM_BITS 8
// 15 ones + 0101 (inverted A)
#define OREGON2_PREAMBLE 0b1111111111111110101
// bit indicating the low battery
#define OREGON2_FLAG_BAT_LOW 0x4
struct WSProtocolDecoderOregon2 {
SubGhzProtocolDecoderBase base;
SubGhzBlockDecoder decoder;
WSBlockGeneric generic;
ManchesterState manchester_state;
bool prev_bit;
bool have_bit;
uint8_t var_bits;
uint32_t var_data;
};
typedef struct WSProtocolDecoderOregon2 WSProtocolDecoderOregon2;
typedef enum {
Oregon2DecoderStepReset = 0,
Oregon2DecoderStepFoundPreamble,
Oregon2DecoderStepVarData,
} Oregon2DecoderStep;
void* ws_protocol_decoder_oregon2_alloc(SubGhzEnvironment* environment) {
UNUSED(environment);
WSProtocolDecoderOregon2* instance = malloc(sizeof(WSProtocolDecoderOregon2));
instance->base.protocol = &ws_protocol_oregon2;
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;
return instance;
}
void ws_protocol_decoder_oregon2_free(void* context) {
furi_assert(context);
WSProtocolDecoderOregon2* instance = context;
free(instance);
}
void ws_protocol_decoder_oregon2_reset(void* context) {
furi_assert(context);
WSProtocolDecoderOregon2* instance = context;
instance->decoder.parser_step = Oregon2DecoderStepReset;
instance->decoder.decode_data = 0UL;
instance->decoder.decode_count_bit = 0;
manchester_advance(
instance->manchester_state, ManchesterEventReset, &instance->manchester_state, NULL);
instance->have_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_oregon2_const.te_long) < ws_oregon2_const.te_delta) {
is_long = true;
} else if(DURATION_DIFF(duration, ws_oregon2_const.te_short) < ws_oregon2_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
static uint8_t oregon2_sensor_id_var_bits(uint16_t sensor_id) {
if(sensor_id == 0xEC40) return 16;
return 0;
}
static void ws_oregon2_decode_const_data(WSBlockGeneric* ws_block) {
ws_block->id = OREGON2_SENSOR_ID(ws_block->data);
uint8_t ch_bits = (ws_block->data >> 12) & 0xF;
ws_block->channel = 1;
while(ch_bits > 1) {
ws_block->channel++;
ch_bits >>= 1;
}
ws_block->battery_low = (ws_block->data & OREGON2_FLAG_BAT_LOW) ? 1 : 0;
}
static void
ws_oregon2_decode_var_data(WSBlockGeneric* ws_block, uint16_t sensor_id, uint32_t var_data) {
int16_t temp_val;
if(sensor_id == 0xEC40) {
temp_val = ((var_data >> 4) & 0xF) * 10 + ((var_data >> 8) & 0xF);
temp_val *= 10;
temp_val += (var_data >> 12) & 0xF;
if(var_data & 0xF) temp_val = -temp_val;
} else
return;
ws_block->temp = (float)temp_val / 10.0;
}
void ws_protocol_decoder_oregon2_feed(void* context, bool level, uint32_t duration) {
furi_assert(context);
WSProtocolDecoderOregon2* instance = context;
// oregon v2.1 signal is inverted
ManchesterEvent event = level_and_duration_to_event(!level, duration);
bool data;
// low-level bit sequence decoding
if(event == ManchesterEventReset) {
instance->decoder.parser_step = Oregon2DecoderStepReset;
instance->have_bit = false;
instance->decoder.decode_data = 0UL;
instance->decoder.decode_count_bit = 0;
}
if(manchester_advance(instance->manchester_state, event, &instance->manchester_state, &data)) {
if(instance->have_bit) {
if(!instance->prev_bit && data) {
subghz_protocol_blocks_add_bit(&instance->decoder, 1);
} else if(instance->prev_bit && !data) {
subghz_protocol_blocks_add_bit(&instance->decoder, 0);
} else {
ws_protocol_decoder_oregon2_reset(context);
}
instance->have_bit = false;
} else {
instance->prev_bit = data;
instance->have_bit = true;
}
}
switch(instance->decoder.parser_step) {
case Oregon2DecoderStepReset:
// waiting for fixed oregon2 preamble
if(instance->decoder.decode_count_bit >= OREGON2_PREAMBLE_BITS &&
((instance->decoder.decode_data & OREGON2_PREAMBLE_MASK) == OREGON2_PREAMBLE)) {
instance->decoder.parser_step = Oregon2DecoderStepFoundPreamble;
instance->decoder.decode_count_bit = 0;
instance->decoder.decode_data = 0UL;
}
break;
case Oregon2DecoderStepFoundPreamble:
// waiting for fixed oregon2 data
if(instance->decoder.decode_count_bit == 32) {
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
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_oregon2_decode_const_data(&instance->generic);
instance->var_bits =
oregon2_sensor_id_var_bits(OREGON2_SENSOR_ID(instance->generic.data));
if(!instance->var_bits) {
// sensor is not supported, stop decoding, but showing the decoded fixed part
instance->decoder.parser_step = Oregon2DecoderStepReset;
if(instance->base.callback)
instance->base.callback(&instance->base, instance->base.context);
} else {
instance->decoder.parser_step = Oregon2DecoderStepVarData;
}
}
break;
case Oregon2DecoderStepVarData:
// waiting for variable (sensor-specific data)
if(instance->decoder.decode_count_bit == instance->var_bits + OREGON2_CHECKSUM_BITS) {
instance->var_data = instance->decoder.decode_data & 0xFFFFFFFF;
// reverse nibbles in var data
instance->var_data = (instance->var_data & 0x55555555) << 1 |
(instance->var_data & 0xAAAAAAAA) >> 1;
instance->var_data = (instance->var_data & 0x33333333) << 2 |
(instance->var_data & 0xCCCCCCCC) >> 2;
ws_oregon2_decode_var_data(
&instance->generic,
OREGON2_SENSOR_ID(instance->generic.data),
instance->var_data >> OREGON2_CHECKSUM_BITS);
instance->decoder.parser_step = Oregon2DecoderStepReset;
if(instance->base.callback)
instance->base.callback(&instance->base, instance->base.context);
}
break;
}
}
uint8_t ws_protocol_decoder_oregon2_get_hash_data(void* context) {
furi_assert(context);
WSProtocolDecoderOregon2* instance = context;
return subghz_protocol_blocks_get_hash_data(
&instance->decoder, (instance->decoder.decode_count_bit / 8) + 1);
}
bool ws_protocol_decoder_oregon2_serialize(
void* context,
FlipperFormat* flipper_format,
SubGhzRadioPreset* preset) {
furi_assert(context);
WSProtocolDecoderOregon2* instance = context;
if(!ws_block_generic_serialize(&instance->generic, flipper_format, preset)) return false;
uint32_t temp = instance->var_bits;
if(!flipper_format_write_uint32(flipper_format, "VarBits", &temp, 1)) {
FURI_LOG_E(TAG, "Error adding VarBits");
return false;
}
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 false;
}
return true;
}
bool ws_protocol_decoder_oregon2_deserialize(void* context, FlipperFormat* flipper_format) {
furi_assert(context);
WSProtocolDecoderOregon2* instance = context;
bool ret = false;
uint32_t temp_data;
do {
if(!ws_block_generic_deserialize(&instance->generic, flipper_format)) {
break;
}
if(!flipper_format_read_uint32(flipper_format, "VarBits", &temp_data, 1)) {
FURI_LOG_E(TAG, "Missing VarLen");
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))) {
FURI_LOG_E(TAG, "Missing VarData");
break;
}
if(instance->generic.data_count_bit != ws_oregon2_const.min_count_bit_for_found) {
FURI_LOG_E(TAG, "Wrong number of bits in key: %d", instance->generic.data_count_bit);
break;
}
ret = true;
} while(false);
return ret;
}
static void oregon2_append_check_sum(uint32_t fix_data, uint32_t var_data, FuriString* output) {
uint8_t sum = fix_data & 0xF;
uint8_t ref_sum = var_data & 0xFF;
var_data >>= 8;
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_oregon2_get_string(void* context, FuriString* output) {
furi_assert(context);
WSProtocolDecoderOregon2* 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);
oregon2_append_check_sum((uint32_t)instance->generic.data, instance->var_data, output);
}
}
const SubGhzProtocolDecoder ws_protocol_oregon2_decoder = {
.alloc = ws_protocol_decoder_oregon2_alloc,
.free = ws_protocol_decoder_oregon2_free,
.feed = ws_protocol_decoder_oregon2_feed,
.reset = ws_protocol_decoder_oregon2_reset,
.get_hash_data = ws_protocol_decoder_oregon2_get_hash_data,
.serialize = ws_protocol_decoder_oregon2_serialize,
.deserialize = ws_protocol_decoder_oregon2_deserialize,
.get_string = ws_protocol_decoder_oregon2_get_string,
};
const SubGhzProtocol ws_protocol_oregon2 = {
.name = WS_PROTOCOL_OREGON2_NAME,
.type = SubGhzProtocolTypeStatic,
.flag = SubGhzProtocolFlag_433 | SubGhzProtocolFlag_AM | SubGhzProtocolFlag_Decodable |
SubGhzProtocolFlag_Load | SubGhzProtocolFlag_Save,
.decoder = &ws_protocol_oregon2_decoder,
};

6
applications/plugins/weather_station/protocols/oregon2.h Normal file
View File

@@ -0,0 +1,6 @@
#pragma once
#include <lib/subghz/protocols/base.h>
#define WS_PROTOCOL_OREGON2_NAME "Oregon2"
extern const SubGhzProtocol ws_protocol_oregon2;

1
applications/plugins/weather_station/protocols/protocol_items.c
View File

@@ -7,6 +7,7 @@ const SubGhzProtocol* weather_station_protocol_registry_items[] = {
&ws_protocol_gt_wt_03,
&ws_protocol_acurite_606tx,
&ws_protocol_lacrosse_tx141thbv2,
&ws_protocol_oregon2,
};
const SubGhzProtocolRegistry weather_station_protocol_registry = {

1
applications/plugins/weather_station/protocols/protocol_items.h
View File

@@ -7,5 +7,6 @@
#include "gt_wt_03.h"
#include "acurite_606tx.h"
#include "lacrosse_tx141thbv2.h"
#include "oregon2.h"
extern const SubGhzProtocolRegistry weather_station_protocol_registry;