[FL-2975] WS: add protocol GT-WT02 (#2001)

* WS: add protocol GT-WT02
* WS: fix text "About" scene

Co-authored-by: あく <alleteam@gmail.com>
This commit is contained in:
Skorpionm 2022-11-23 13:44:49 +04:00 committed by GitHub
parent 00fcd9cfcd
commit b9c483fbf8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 348 additions and 2 deletions

View File

@ -3,7 +3,7 @@
#include <furi.h>
#include <furi_hal.h>
#define WS_VERSION_APP "0.4"
#define WS_VERSION_APP "0.5"
#define WS_DEVELOPED "SkorP"
#define WS_GITHUB "https://github.com/flipperdevices/flipperzero-firmware"

View File

@ -0,0 +1,265 @@
#include "gt_wt_02.h"
#define TAG "WSProtocolGT_WT02"
/*
* Help
* https://github.com/merbanan/rtl_433/blob/master/src/devices/gt_wt_02.c
*
* GT-WT-02 sensor on 433.92MHz.
* Example and frame description provided by https://github.com/ludwich66
* [01] {37} 34 00 ed 47 60 : 00110100 00000000 11101101 01000111 01100000
* code, BatOK,not-man-send, Channel1, +23,7°C, 35%
* [01] {37} 34 8f 87 15 90 : 00110100 10001111 10000111 00010101 10010000
* code, BatOK,not-man-send, Channel1,-12,1°C, 10%
* Humidity:
* - the working range is 20-90 %
* - if "LL" in display view it sends 10 %
* - if "HH" in display view it sends 110%
* SENSOR: GT-WT-02 (ALDI Globaltronics..)
* TYP IIIIIIII BMCCTTTT TTTTTTTT HHHHHHHX XXXXX
* TYPE Description:
* - I = Random Device Code, changes with battery reset
* - 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
* - H = Humidity = 7 Bit bin2dez 00-99, Display LL=10%, Display HH=110% (Range 20-90%)
* - X = Checksum, sum modulo 64
* A Lidl AURIO (from 12/2018) with PCB marking YJ-T12 V02 has two extra bits in front.
*
*/
static const SubGhzBlockConst ws_protocol_gt_wt_02_const = {
.te_short = 500,
.te_long = 2000,
.te_delta = 150,
.min_count_bit_for_found = 37,
};
struct WSProtocolDecoderGT_WT02 {
SubGhzProtocolDecoderBase base;
SubGhzBlockDecoder decoder;
WSBlockGeneric generic;
};
struct WSProtocolEncoderGT_WT02 {
SubGhzProtocolEncoderBase base;
SubGhzProtocolBlockEncoder encoder;
WSBlockGeneric generic;
};
typedef enum {
GT_WT02DecoderStepReset = 0,
GT_WT02DecoderStepSaveDuration,
GT_WT02DecoderStepCheckDuration,
} GT_WT02DecoderStep;
const SubGhzProtocolDecoder ws_protocol_gt_wt_02_decoder = {
.alloc = ws_protocol_decoder_gt_wt_02_alloc,
.free = ws_protocol_decoder_gt_wt_02_free,
.feed = ws_protocol_decoder_gt_wt_02_feed,
.reset = ws_protocol_decoder_gt_wt_02_reset,
.get_hash_data = ws_protocol_decoder_gt_wt_02_get_hash_data,
.serialize = ws_protocol_decoder_gt_wt_02_serialize,
.deserialize = ws_protocol_decoder_gt_wt_02_deserialize,
.get_string = ws_protocol_decoder_gt_wt_02_get_string,
};
const SubGhzProtocolEncoder ws_protocol_gt_wt_02_encoder = {
.alloc = NULL,
.free = NULL,
.deserialize = NULL,
.stop = NULL,
.yield = NULL,
};
const SubGhzProtocol ws_protocol_gt_wt_02 = {
.name = WS_PROTOCOL_GT_WT_02_NAME,
.type = SubGhzProtocolWeatherStation,
.flag = SubGhzProtocolFlag_433 | SubGhzProtocolFlag_315 | SubGhzProtocolFlag_868 |
SubGhzProtocolFlag_AM | SubGhzProtocolFlag_Decodable,
.decoder = &ws_protocol_gt_wt_02_decoder,
.encoder = &ws_protocol_gt_wt_02_encoder,
};
void* ws_protocol_decoder_gt_wt_02_alloc(SubGhzEnvironment* environment) {
UNUSED(environment);
WSProtocolDecoderGT_WT02* instance = malloc(sizeof(WSProtocolDecoderGT_WT02));
instance->base.protocol = &ws_protocol_gt_wt_02;
instance->generic.protocol_name = instance->base.protocol->name;
return instance;
}
void ws_protocol_decoder_gt_wt_02_free(void* context) {
furi_assert(context);
WSProtocolDecoderGT_WT02* instance = context;
free(instance);
}
void ws_protocol_decoder_gt_wt_02_reset(void* context) {
furi_assert(context);
WSProtocolDecoderGT_WT02* instance = context;
instance->decoder.parser_step = GT_WT02DecoderStepReset;
}
static bool ws_protocol_gt_wt_02_check(WSProtocolDecoderGT_WT02* instance) {
if(!instance->decoder.decode_data) return false;
uint8_t sum = (instance->decoder.decode_data >> 5) & 0xe;
uint64_t temp_data = instance->decoder.decode_data >> 9;
for(uint8_t i = 0; i < 7; i++) {
sum += (temp_data >> (i * 4)) & 0xF;
}
return ((uint8_t)(instance->decoder.decode_data & 0x3F) == (sum & 0x3F));
}
/**
* Analysis of received data
* @param instance Pointer to a WSBlockGeneric* instance
*/
static void ws_protocol_gt_wt_02_remote_controller(WSBlockGeneric* instance) {
instance->id = (instance->data >> 29) & 0xFF;
instance->battery_low = (instance->data >> 28) & 1;
instance->btn = (instance->data >> 27) & 1;
instance->channel = ((instance->data >> 25) & 0x3) + 1;
if(!((instance->data >> 24) & 1)) {
instance->temp = (float)((instance->data >> 13) & 0x07FF) / 10.0f;
} else {
instance->temp = (float)((~(instance->data >> 13) & 0x07FF) + 1) / -10.0f;
}
instance->humidity = (instance->data >> 6) & 0x7F;
if(instance->humidity <= 10) // actually the sensors sends 10 below working range of 20%
instance->humidity = 0;
else if(instance->humidity > 90) // actually the sensors sends 110 above working range of 90%
instance->humidity = 100;
}
void ws_protocol_decoder_gt_wt_02_feed(void* context, bool level, uint32_t duration) {
furi_assert(context);
WSProtocolDecoderGT_WT02* instance = context;
switch(instance->decoder.parser_step) {
case GT_WT02DecoderStepReset:
if((!level) && (DURATION_DIFF(duration, ws_protocol_gt_wt_02_const.te_short * 18) <
ws_protocol_gt_wt_02_const.te_delta * 8)) {
//Found syncPrefix
instance->decoder.parser_step = GT_WT02DecoderStepSaveDuration;
instance->decoder.decode_data = 0;
instance->decoder.decode_count_bit = 0;
}
break;
case GT_WT02DecoderStepSaveDuration:
if(level) {
instance->decoder.te_last = duration;
instance->decoder.parser_step = GT_WT02DecoderStepCheckDuration;
} else {
instance->decoder.parser_step = GT_WT02DecoderStepReset;
}
break;
case GT_WT02DecoderStepCheckDuration:
if(!level) {
if(DURATION_DIFF(instance->decoder.te_last, ws_protocol_gt_wt_02_const.te_short) <
ws_protocol_gt_wt_02_const.te_delta) {
if(DURATION_DIFF(duration, ws_protocol_gt_wt_02_const.te_short * 18) <
ws_protocol_gt_wt_02_const.te_delta * 8) {
//Found syncPostfix
instance->decoder.parser_step = GT_WT02DecoderStepReset;
if((instance->decoder.decode_count_bit ==
ws_protocol_gt_wt_02_const.min_count_bit_for_found) &&
ws_protocol_gt_wt_02_check(instance)) {
instance->generic.data = instance->decoder.decode_data;
instance->generic.data_count_bit = instance->decoder.decode_count_bit;
ws_protocol_gt_wt_02_remote_controller(&instance->generic);
if(instance->base.callback)
instance->base.callback(&instance->base, instance->base.context);
} else if(instance->decoder.decode_count_bit == 1) {
instance->decoder.parser_step = GT_WT02DecoderStepSaveDuration;
}
instance->decoder.decode_data = 0;
instance->decoder.decode_count_bit = 0;
} else if(
DURATION_DIFF(duration, ws_protocol_gt_wt_02_const.te_long) <
ws_protocol_gt_wt_02_const.te_delta * 2) {
subghz_protocol_blocks_add_bit(&instance->decoder, 0);
instance->decoder.parser_step = GT_WT02DecoderStepSaveDuration;
} else if(
DURATION_DIFF(duration, ws_protocol_gt_wt_02_const.te_long * 2) <
ws_protocol_gt_wt_02_const.te_delta * 4) {
subghz_protocol_blocks_add_bit(&instance->decoder, 1);
instance->decoder.parser_step = GT_WT02DecoderStepSaveDuration;
} else {
instance->decoder.parser_step = GT_WT02DecoderStepReset;
}
} else {
instance->decoder.parser_step = GT_WT02DecoderStepReset;
}
} else {
instance->decoder.parser_step = GT_WT02DecoderStepReset;
}
break;
}
}
uint8_t ws_protocol_decoder_gt_wt_02_get_hash_data(void* context) {
furi_assert(context);
WSProtocolDecoderGT_WT02* instance = context;
return subghz_protocol_blocks_get_hash_data(
&instance->decoder, (instance->decoder.decode_count_bit / 8) + 1);
}
bool ws_protocol_decoder_gt_wt_02_serialize(
void* context,
FlipperFormat* flipper_format,
SubGhzRadioPreset* preset) {
furi_assert(context);
WSProtocolDecoderGT_WT02* instance = context;
return ws_block_generic_serialize(&instance->generic, flipper_format, preset);
}
bool ws_protocol_decoder_gt_wt_02_deserialize(void* context, FlipperFormat* flipper_format) {
furi_assert(context);
WSProtocolDecoderGT_WT02* instance = context;
bool ret = false;
do {
if(!ws_block_generic_deserialize(&instance->generic, flipper_format)) {
break;
}
if(instance->generic.data_count_bit !=
ws_protocol_gt_wt_02_const.min_count_bit_for_found) {
FURI_LOG_E(TAG, "Wrong number of bits in key");
break;
}
ret = true;
} while(false);
return ret;
}
void ws_protocol_decoder_gt_wt_02_get_string(void* context, FuriString* output) {
furi_assert(context);
WSProtocolDecoderGT_WT02* 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);
}

View File

@ -0,0 +1,79 @@
#pragma once
#include <lib/subghz/protocols/base.h>
#include <lib/subghz/blocks/const.h>
#include <lib/subghz/blocks/decoder.h>
#include <lib/subghz/blocks/encoder.h>
#include "ws_generic.h"
#include <lib/subghz/blocks/math.h>
#define WS_PROTOCOL_GT_WT_02_NAME "GT-WT02"
typedef struct WSProtocolDecoderGT_WT02 WSProtocolDecoderGT_WT02;
typedef struct WSProtocolEncoderGT_WT02 WSProtocolEncoderGT_WT02;
extern const SubGhzProtocolDecoder ws_protocol_gt_wt_02_decoder;
extern const SubGhzProtocolEncoder ws_protocol_gt_wt_02_encoder;
extern const SubGhzProtocol ws_protocol_gt_wt_02;
/**
* Allocate WSProtocolDecoderGT_WT02.
* @param environment Pointer to a SubGhzEnvironment instance
* @return WSProtocolDecoderGT_WT02* pointer to a WSProtocolDecoderGT_WT02 instance
*/
void* ws_protocol_decoder_gt_wt_02_alloc(SubGhzEnvironment* environment);
/**
* Free WSProtocolDecoderGT_WT02.
* @param context Pointer to a WSProtocolDecoderGT_WT02 instance
*/
void ws_protocol_decoder_gt_wt_02_free(void* context);
/**
* Reset decoder WSProtocolDecoderGT_WT02.
* @param context Pointer to a WSProtocolDecoderGT_WT02 instance
*/
void ws_protocol_decoder_gt_wt_02_reset(void* context);
/**
* Parse a raw sequence of levels and durations received from the air.
* @param context Pointer to a WSProtocolDecoderGT_WT02 instance
* @param level Signal level true-high false-low
* @param duration Duration of this level in, us
*/
void ws_protocol_decoder_gt_wt_02_feed(void* context, bool level, uint32_t duration);
/**
* Getting the hash sum of the last randomly received parcel.
* @param context Pointer to a WSProtocolDecoderGT_WT02 instance
* @return hash Hash sum
*/
uint8_t ws_protocol_decoder_gt_wt_02_get_hash_data(void* context);
/**
* Serialize data WSProtocolDecoderGT_WT02.
* @param context Pointer to a WSProtocolDecoderGT_WT02 instance
* @param flipper_format Pointer to a FlipperFormat instance
* @param preset The modulation on which the signal was received, SubGhzRadioPreset
* @return true On success
*/
bool ws_protocol_decoder_gt_wt_02_serialize(
void* context,
FlipperFormat* flipper_format,
SubGhzRadioPreset* preset);
/**
* Deserialize data WSProtocolDecoderGT_WT02.
* @param context Pointer to a WSProtocolDecoderGT_WT02 instance
* @param flipper_format Pointer to a FlipperFormat instance
* @return true On success
*/
bool ws_protocol_decoder_gt_wt_02_deserialize(void* context, FlipperFormat* flipper_format);
/**
* Getting a textual representation of the received data.
* @param context Pointer to a WSProtocolDecoderGT_WT02 instance
* @param output Resulting text
*/
void ws_protocol_decoder_gt_wt_02_get_string(void* context, FuriString* output);

View File

@ -4,6 +4,7 @@ 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,

View File

@ -4,6 +4,7 @@
#include "infactory.h"
#include "thermopro_tx4.h"
#include "nexus_th.h"
#include "gt_wt_02.h"
#include "gt_wt_03.h"
#include "acurite_606tx.h"
#include "acurite_609txc.h"

View File

@ -24,7 +24,7 @@ void weather_station_scene_about_on_enter(void* context) {
furi_string_cat_printf(temp_str, "\e#%s\n", "Description");
furi_string_cat_printf(
temp_str, "Reading messages from\nweather station that work\nwith SubGhz sensors\n\n");
temp_str, "Reading messages from\nweather stations that work\nwith SubGhz sensors\n\n");
furi_string_cat_printf(temp_str, "Supported protocols:\n");
size_t i = 0;