SubGhz: refactoring add descriptions (#1012)
* SubGhz: add descriptions * SubGhz: fix syntax Co-authored-by: あく <alleteam@gmail.com>
This commit is contained in:
@@ -13,5 +13,16 @@ struct SubGhzBlockDecoder {
|
||||
uint8_t decode_count_bit;
|
||||
};
|
||||
|
||||
/**
|
||||
* Add data bit when decoding.
|
||||
* @param decoder Pointer to a SubGhzBlockDecoder instance
|
||||
* @param bit data, 1bit
|
||||
*/
|
||||
void subghz_protocol_blocks_add_bit(SubGhzBlockDecoder* decoder, uint8_t bit);
|
||||
|
||||
/**
|
||||
* Getting the hash sum of the last randomly received parcel.
|
||||
* @param decoder Pointer to a SubGhzBlockDecoder instance
|
||||
* @return hash Hash sum
|
||||
*/
|
||||
uint8_t subghz_protocol_blocks_get_hash_data(SubGhzBlockDecoder* decoder, size_t len);
|
||||
|
@@ -19,12 +19,32 @@ struct SubGhzBlockGeneric {
|
||||
uint16_t cnt;
|
||||
};
|
||||
|
||||
/**
|
||||
* Get modulation name.
|
||||
* @param preset modulation,FuriHalSubGhzPreset
|
||||
* @param preset_str Output modulation name
|
||||
* @return true On success
|
||||
*/
|
||||
bool subghz_block_generic_get_preset_name(FuriHalSubGhzPreset preset, string_t preset_str);
|
||||
|
||||
/**
|
||||
* Serialize data SubGhzBlockGeneric.
|
||||
* @param instance Pointer to a SubGhzBlockGeneric instance
|
||||
* @param flipper_format Pointer to a FlipperFormat instance
|
||||
* @param frequency The frequency at which the signal was received, Hz
|
||||
* @param preset The modulation on which the signal was received, FuriHalSubGhzPreset
|
||||
* @return true On success
|
||||
*/
|
||||
bool subghz_block_generic_serialize(
|
||||
SubGhzBlockGeneric* instance,
|
||||
FlipperFormat* flipper_format,
|
||||
uint32_t frequency,
|
||||
FuriHalSubGhzPreset preset);
|
||||
|
||||
/**
|
||||
* Deserialize data SubGhzBlockGeneric.
|
||||
* @param instance Pointer to a SubGhzBlockGeneric instance
|
||||
* @param flipper_format Pointer to a FlipperFormat instance
|
||||
* @return true On success
|
||||
*/
|
||||
bool subghz_block_generic_deserialize(SubGhzBlockGeneric* instance, FlipperFormat* flipper_format);
|
||||
|
@@ -10,4 +10,10 @@
|
||||
#define bit_write(value, bit, bitvalue) (bitvalue ? bit_set(value, bit) : bit_clear(value, bit))
|
||||
#define DURATION_DIFF(x, y) ((x < y) ? (y - x) : (x - y))
|
||||
|
||||
/**
|
||||
* Flip the data bitwise.
|
||||
* @param key In data
|
||||
* @param count_bit number of data bits
|
||||
* @return Reverse data
|
||||
*/
|
||||
uint64_t subghz_protocol_blocks_reverse_key(uint64_t key, uint8_t count_bit);
|
||||
|
Reference in New Issue
Block a user