flipperzero-firmware/lib/subghz/protocols/dooya.h
Skorpionm 0afc4a8982
[FL-3092] SubGhz: add DOOYA protocol (#2178)
* SubGhz: add DOOYA protocol
* SubGhz: add unit_test DOOYA protocol
* SubGhz: fix protocol Dooya

Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>
2023-02-09 01:37:24 +09:00

108 lines
3.6 KiB
C

#pragma once
#include "base.h"
#define SUBGHZ_PROTOCOL_DOOYA_NAME "Dooya"
typedef struct SubGhzProtocolDecoderDooya SubGhzProtocolDecoderDooya;
typedef struct SubGhzProtocolEncoderDooya SubGhzProtocolEncoderDooya;
extern const SubGhzProtocolDecoder subghz_protocol_dooya_decoder;
extern const SubGhzProtocolEncoder subghz_protocol_dooya_encoder;
extern const SubGhzProtocol subghz_protocol_dooya;
/**
* Allocate SubGhzProtocolEncoderDooya.
* @param environment Pointer to a SubGhzEnvironment instance
* @return SubGhzProtocolEncoderDooya* pointer to a SubGhzProtocolEncoderDooya instance
*/
void* subghz_protocol_encoder_dooya_alloc(SubGhzEnvironment* environment);
/**
* Free SubGhzProtocolEncoderDooya.
* @param context Pointer to a SubGhzProtocolEncoderDooya instance
*/
void subghz_protocol_encoder_dooya_free(void* context);
/**
* Deserialize and generating an upload to send.
* @param context Pointer to a SubGhzProtocolEncoderDooya instance
* @param flipper_format Pointer to a FlipperFormat instance
* @return true On success
*/
bool subghz_protocol_encoder_dooya_deserialize(void* context, FlipperFormat* flipper_format);
/**
* Forced transmission stop.
* @param context Pointer to a SubGhzProtocolEncoderDooya instance
*/
void subghz_protocol_encoder_dooya_stop(void* context);
/**
* Getting the level and duration of the upload to be loaded into DMA.
* @param context Pointer to a SubGhzProtocolEncoderDooya instance
* @return LevelDuration
*/
LevelDuration subghz_protocol_encoder_dooya_yield(void* context);
/**
* Allocate SubGhzProtocolDecoderDooya.
* @param environment Pointer to a SubGhzEnvironment instance
* @return SubGhzProtocolDecoderDooya* pointer to a SubGhzProtocolDecoderDooya instance
*/
void* subghz_protocol_decoder_dooya_alloc(SubGhzEnvironment* environment);
/**
* Free SubGhzProtocolDecoderDooya.
* @param context Pointer to a SubGhzProtocolDecoderDooya instance
*/
void subghz_protocol_decoder_dooya_free(void* context);
/**
* Reset decoder SubGhzProtocolDecoderDooya.
* @param context Pointer to a SubGhzProtocolDecoderDooya instance
*/
void subghz_protocol_decoder_dooya_reset(void* context);
/**
* Parse a raw sequence of levels and durations received from the air.
* @param context Pointer to a SubGhzProtocolDecoderDooya instance
* @param level Signal level true-high false-low
* @param duration Duration of this level in, us
*/
void subghz_protocol_decoder_dooya_feed(void* context, bool level, uint32_t duration);
/**
* Getting the hash sum of the last randomly received parcel.
* @param context Pointer to a SubGhzProtocolDecoderDooya instance
* @return hash Hash sum
*/
uint8_t subghz_protocol_decoder_dooya_get_hash_data(void* context);
/**
* Serialize data SubGhzProtocolDecoderDooya.
* @param context Pointer to a SubGhzProtocolDecoderDooya 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 subghz_protocol_decoder_dooya_serialize(
void* context,
FlipperFormat* flipper_format,
SubGhzRadioPreset* preset);
/**
* Deserialize data SubGhzProtocolDecoderDooya.
* @param context Pointer to a SubGhzProtocolDecoderDooya instance
* @param flipper_format Pointer to a FlipperFormat instance
* @return true On success
*/
bool subghz_protocol_decoder_dooya_deserialize(void* context, FlipperFormat* flipper_format);
/**
* Getting a textual representation of the received data.
* @param context Pointer to a SubGhzProtocolDecoderDooya instance
* @param output Resulting text
*/
void subghz_protocol_decoder_dooya_get_string(void* context, FuriString* output);