72ca6b25e9
* SubGhz: add error protocol * WS: add error protocol * SubGhz: error processing * SubGhz: more stringent CAME protocol restrictions * SubGhz: fix header duration CAME protocol * SubGhz: delete comments * SubGhz: sync SubGhzProtocolStatus with FuriStatus * SubGhz: update documentation and bump api_version Co-authored-by: あく <alleteam@gmail.com>
110 lines
3.8 KiB
C
110 lines
3.8 KiB
C
#pragma once
|
|
|
|
#include "base.h"
|
|
|
|
#define SUBGHZ_PROTOCOL_MAGELLAN_NAME "Magellan"
|
|
|
|
typedef struct SubGhzProtocolDecoderMagellan SubGhzProtocolDecoderMagellan;
|
|
typedef struct SubGhzProtocolEncoderMagellan SubGhzProtocolEncoderMagellan;
|
|
|
|
extern const SubGhzProtocolDecoder subghz_protocol_magellan_decoder;
|
|
extern const SubGhzProtocolEncoder subghz_protocol_magellan_encoder;
|
|
extern const SubGhzProtocol subghz_protocol_magellan;
|
|
|
|
/**
|
|
* Allocate SubGhzProtocolEncoderMagellan.
|
|
* @param environment Pointer to a SubGhzEnvironment instance
|
|
* @return SubGhzProtocolEncoderMagellan* pointer to a SubGhzProtocolEncoderMagellan instance
|
|
*/
|
|
void* subghz_protocol_encoder_magellan_alloc(SubGhzEnvironment* environment);
|
|
|
|
/**
|
|
* Free SubGhzProtocolEncoderMagellan.
|
|
* @param context Pointer to a SubGhzProtocolEncoderMagellan instance
|
|
*/
|
|
void subghz_protocol_encoder_magellan_free(void* context);
|
|
|
|
/**
|
|
* Deserialize and generating an upload to send.
|
|
* @param context Pointer to a SubGhzProtocolEncoderMagellan instance
|
|
* @param flipper_format Pointer to a FlipperFormat instance
|
|
* @return status
|
|
*/
|
|
SubGhzProtocolStatus
|
|
subghz_protocol_encoder_magellan_deserialize(void* context, FlipperFormat* flipper_format);
|
|
|
|
/**
|
|
* Forced transmission stop.
|
|
* @param context Pointer to a SubGhzProtocolEncoderMagellan instance
|
|
*/
|
|
void subghz_protocol_encoder_magellan_stop(void* context);
|
|
|
|
/**
|
|
* Getting the level and duration of the upload to be loaded into DMA.
|
|
* @param context Pointer to a SubGhzProtocolEncoderMagellan instance
|
|
* @return LevelDuration
|
|
*/
|
|
LevelDuration subghz_protocol_encoder_magellan_yield(void* context);
|
|
|
|
/**
|
|
* Allocate SubGhzProtocolDecoderMagellan.
|
|
* @param environment Pointer to a SubGhzEnvironment instance
|
|
* @return SubGhzProtocolDecoderMagellan* pointer to a SubGhzProtocolDecoderMagellan instance
|
|
*/
|
|
void* subghz_protocol_decoder_magellan_alloc(SubGhzEnvironment* environment);
|
|
|
|
/**
|
|
* Free SubGhzProtocolDecoderMagellan.
|
|
* @param context Pointer to a SubGhzProtocolDecoderMagellan instance
|
|
*/
|
|
void subghz_protocol_decoder_magellan_free(void* context);
|
|
|
|
/**
|
|
* Reset decoder SubGhzProtocolDecoderMagellan.
|
|
* @param context Pointer to a SubGhzProtocolDecoderMagellan instance
|
|
*/
|
|
void subghz_protocol_decoder_magellan_reset(void* context);
|
|
|
|
/**
|
|
* Parse a raw sequence of levels and durations received from the air.
|
|
* @param context Pointer to a SubGhzProtocolDecoderMagellan instance
|
|
* @param level Signal level true-high false-low
|
|
* @param duration Duration of this level in, us
|
|
*/
|
|
void subghz_protocol_decoder_magellan_feed(void* context, bool level, uint32_t duration);
|
|
|
|
/**
|
|
* Getting the hash sum of the last randomly received parcel.
|
|
* @param context Pointer to a SubGhzProtocolDecoderMagellan instance
|
|
* @return hash Hash sum
|
|
*/
|
|
uint8_t subghz_protocol_decoder_magellan_get_hash_data(void* context);
|
|
|
|
/**
|
|
* Serialize data SubGhzProtocolDecoderMagellan.
|
|
* @param context Pointer to a SubGhzProtocolDecoderMagellan instance
|
|
* @param flipper_format Pointer to a FlipperFormat instance
|
|
* @param preset The modulation on which the signal was received, SubGhzRadioPreset
|
|
* @return status
|
|
*/
|
|
SubGhzProtocolStatus subghz_protocol_decoder_magellan_serialize(
|
|
void* context,
|
|
FlipperFormat* flipper_format,
|
|
SubGhzRadioPreset* preset);
|
|
|
|
/**
|
|
* Deserialize data SubGhzProtocolDecoderMagellan.
|
|
* @param context Pointer to a SubGhzProtocolDecoderMagellan instance
|
|
* @param flipper_format Pointer to a FlipperFormat instance
|
|
* @return status
|
|
*/
|
|
SubGhzProtocolStatus
|
|
subghz_protocol_decoder_magellan_deserialize(void* context, FlipperFormat* flipper_format);
|
|
|
|
/**
|
|
* Getting a textual representation of the received data.
|
|
* @param context Pointer to a SubGhzProtocolDecoderMagellan instance
|
|
* @param output Resulting text
|
|
*/
|
|
void subghz_protocol_decoder_magellan_get_string(void* context, FuriString* output);
|