mirror of
https://github.com/DarkFlippers/unleashed-firmware
synced 2024-11-27 15:00:46 +00:00
366 lines
9.3 KiB
C
366 lines
9.3 KiB
C
#pragma once
|
|
|
|
#include "subghz_types.h"
|
|
|
|
#include <lib/subghz/subghz_worker.h>
|
|
#include <lib/subghz/subghz_setting.h>
|
|
#include <lib/subghz/receiver.h>
|
|
#include <lib/subghz/transmitter.h>
|
|
#include <lib/subghz/protocols/raw.h>
|
|
#include <lib/subghz/devices/devices.h>
|
|
|
|
typedef struct SubGhzTxRx SubGhzTxRx;
|
|
|
|
typedef void (*SubGhzTxRxNeedSaveCallback)(void* context);
|
|
|
|
typedef enum {
|
|
SubGhzTxRxStartTxStateOk,
|
|
SubGhzTxRxStartTxStateErrorOnlyRx,
|
|
SubGhzTxRxStartTxStateErrorParserOthers,
|
|
} SubGhzTxRxStartTxState;
|
|
|
|
/**
|
|
* Allocate SubGhzTxRx
|
|
*
|
|
* @return SubGhzTxRx* pointer to SubGhzTxRx
|
|
*/
|
|
SubGhzTxRx* subghz_txrx_alloc(void);
|
|
|
|
/**
|
|
* Free SubGhzTxRx
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
*/
|
|
void subghz_txrx_free(SubGhzTxRx* instance);
|
|
|
|
/**
|
|
* Check if the database is loaded
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @return bool True if the database is loaded
|
|
*/
|
|
bool subghz_txrx_is_database_loaded(SubGhzTxRx* instance);
|
|
|
|
/**
|
|
* Set preset
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @param preset_name Name of preset
|
|
* @param frequency Frequency in Hz
|
|
* @param preset_data Data of preset
|
|
* @param preset_data_size Size of preset data
|
|
*/
|
|
void subghz_txrx_set_preset(
|
|
SubGhzTxRx* instance,
|
|
const char* preset_name,
|
|
uint32_t frequency,
|
|
uint8_t* preset_data,
|
|
size_t preset_data_size);
|
|
|
|
/**
|
|
* Get name of preset
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @param preset String of preset
|
|
* @return const char* Name of preset
|
|
*/
|
|
const char* subghz_txrx_get_preset_name(SubGhzTxRx* instance, const char* preset);
|
|
|
|
/**
|
|
* Get of preset
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @return SubGhzRadioPreset Preset
|
|
*/
|
|
SubGhzRadioPreset subghz_txrx_get_preset(SubGhzTxRx* instance);
|
|
|
|
/**
|
|
* Get string frequency and modulation
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @param frequency Pointer to a string frequency
|
|
* @param modulation Pointer to a string modulation
|
|
*/
|
|
void subghz_txrx_get_frequency_and_modulation(
|
|
SubGhzTxRx* instance,
|
|
FuriString* frequency,
|
|
FuriString* modulation,
|
|
bool long_name);
|
|
|
|
/**
|
|
* Start TX CC1101
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @param flipper_format Pointer to a FlipperFormat
|
|
* @return SubGhzTxRxStartTxState
|
|
*/
|
|
SubGhzTxRxStartTxState subghz_txrx_tx_start(SubGhzTxRx* instance, FlipperFormat* flipper_format);
|
|
|
|
/**
|
|
* Start RX CC1101
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
*/
|
|
void subghz_txrx_rx_start(SubGhzTxRx* instance);
|
|
|
|
/**
|
|
* Stop TX/RX CC1101
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
*/
|
|
void subghz_txrx_stop(SubGhzTxRx* instance);
|
|
|
|
/**
|
|
* Set sleep mode CC1101
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
*/
|
|
void subghz_txrx_sleep(SubGhzTxRx* instance);
|
|
|
|
/**
|
|
* Update frequency CC1101 in automatic mode (hopper)
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @param stay_threshold RSSI theshold over which to stay before hopping
|
|
*/
|
|
void subghz_txrx_hopper_update(SubGhzTxRx* instance, float stay_threshold);
|
|
|
|
/**
|
|
* Get state hopper
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @return SubGhzHopperState
|
|
*/
|
|
SubGhzHopperState subghz_txrx_hopper_get_state(SubGhzTxRx* instance);
|
|
|
|
/**
|
|
* Set state hopper
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @param state State hopper
|
|
*/
|
|
void subghz_txrx_hopper_set_state(SubGhzTxRx* instance, SubGhzHopperState state);
|
|
|
|
/**
|
|
* Unpause hopper
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
*/
|
|
void subghz_txrx_hopper_unpause(SubGhzTxRx* instance);
|
|
|
|
/**
|
|
* Set pause hopper
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
*/
|
|
void subghz_txrx_hopper_pause(SubGhzTxRx* instance);
|
|
|
|
/**
|
|
* Speaker on
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
*/
|
|
void subghz_txrx_speaker_on(SubGhzTxRx* instance);
|
|
|
|
/**
|
|
* Speaker off
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
*/
|
|
void subghz_txrx_speaker_off(SubGhzTxRx* instance);
|
|
|
|
/**
|
|
* Speaker mute
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
*/
|
|
void subghz_txrx_speaker_mute(SubGhzTxRx* instance);
|
|
|
|
/**
|
|
* Speaker unmute
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
*/
|
|
void subghz_txrx_speaker_unmute(SubGhzTxRx* instance);
|
|
|
|
/**
|
|
* Set state speaker
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @param state State speaker
|
|
*/
|
|
void subghz_txrx_speaker_set_state(SubGhzTxRx* instance, SubGhzSpeakerState state);
|
|
|
|
/**
|
|
* Get state speaker
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @return SubGhzSpeakerState
|
|
*/
|
|
SubGhzSpeakerState subghz_txrx_speaker_get_state(SubGhzTxRx* instance);
|
|
|
|
/**
|
|
* load decoder by name protocol
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @param name_protocol Name protocol
|
|
* @return bool True if the decoder is loaded
|
|
*/
|
|
bool subghz_txrx_load_decoder_by_name_protocol(SubGhzTxRx* instance, const char* name_protocol);
|
|
|
|
/**
|
|
* Get decoder
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @return SubGhzProtocolDecoderBase* Pointer to a SubGhzProtocolDecoderBase
|
|
*/
|
|
SubGhzProtocolDecoderBase* subghz_txrx_get_decoder(SubGhzTxRx* instance);
|
|
|
|
/**
|
|
* Set callback for save data
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @param callback Callback for save data
|
|
* @param context Context for callback
|
|
*/
|
|
void subghz_txrx_set_need_save_callback(
|
|
SubGhzTxRx* instance,
|
|
SubGhzTxRxNeedSaveCallback callback,
|
|
void* context);
|
|
|
|
/**
|
|
* Get pointer to a load data key
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @return FlipperFormat*
|
|
*/
|
|
FlipperFormat* subghz_txrx_get_fff_data(SubGhzTxRx* instance);
|
|
|
|
/**
|
|
* Get pointer to a SugGhzSetting
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @return SubGhzSetting*
|
|
*/
|
|
SubGhzSetting* subghz_txrx_get_setting(SubGhzTxRx* instance);
|
|
|
|
/**
|
|
* Is it possible to save this protocol
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @return bool True if it is possible to save this protocol
|
|
*/
|
|
bool subghz_txrx_protocol_is_serializable(SubGhzTxRx* instance);
|
|
|
|
/**
|
|
* Is it possible to send this protocol
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @return bool True if it is possible to send this protocol
|
|
*/
|
|
bool subghz_txrx_protocol_is_transmittable(SubGhzTxRx* instance, bool check_type);
|
|
|
|
/**
|
|
* Set filter, what types of decoder to use
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @param filter Filter
|
|
*/
|
|
void subghz_txrx_receiver_set_filter(SubGhzTxRx* instance, SubGhzProtocolFlag filter);
|
|
|
|
/**
|
|
* Set callback for receive data
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @param callback Callback for receive data
|
|
* @param context Context for callback
|
|
*/
|
|
void subghz_txrx_set_rx_callback(
|
|
SubGhzTxRx* instance,
|
|
SubGhzReceiverCallback callback,
|
|
void* context);
|
|
|
|
/**
|
|
* Set callback for Raw decoder, end of data transfer
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @param callback Callback for Raw decoder, end of data transfer
|
|
* @param context Context for callback
|
|
*/
|
|
void subghz_txrx_set_raw_file_encoder_worker_callback_end(
|
|
SubGhzTxRx* instance,
|
|
SubGhzProtocolEncoderRAWCallbackEnd callback,
|
|
void* context);
|
|
|
|
/* Checking if an external radio device is connected
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @param name Name of external radio device
|
|
* @return bool True if is connected to the external radio device
|
|
*/
|
|
bool subghz_txrx_radio_device_is_external_connected(SubGhzTxRx* instance, const char* name);
|
|
|
|
/* Set the selected radio device to use
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @param radio_device_type Radio device type
|
|
* @return SubGhzRadioDeviceType Type of installed radio device
|
|
*/
|
|
SubGhzRadioDeviceType
|
|
subghz_txrx_radio_device_set(SubGhzTxRx* instance, SubGhzRadioDeviceType radio_device_type);
|
|
|
|
/* Get the selected radio device to use
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @return SubGhzRadioDeviceType Type of installed radio device
|
|
*/
|
|
SubGhzRadioDeviceType subghz_txrx_radio_device_get(SubGhzTxRx* instance);
|
|
|
|
/* Get RSSI the selected radio device to use
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @return float RSSI
|
|
*/
|
|
float subghz_txrx_radio_device_get_rssi(SubGhzTxRx* instance);
|
|
|
|
/* Get name the selected radio device to use
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @return const char* Name of installed radio device
|
|
*/
|
|
const char* subghz_txrx_radio_device_get_name(SubGhzTxRx* instance);
|
|
|
|
/* Get intelligence whether frequency the selected radio device to use
|
|
*
|
|
* @param instance Pointer to a SubGhzTxRx
|
|
* @return bool True if the frequency is valid
|
|
*/
|
|
bool subghz_txrx_radio_device_is_frequency_valid(SubGhzTxRx* instance, uint32_t frequency);
|
|
|
|
bool subghz_txrx_radio_device_is_tx_allowed(SubGhzTxRx* instance, uint32_t frequency);
|
|
|
|
void subghz_txrx_set_debug_pin_state(SubGhzTxRx* instance, bool state);
|
|
bool subghz_txrx_get_debug_pin_state(SubGhzTxRx* instance);
|
|
|
|
void subghz_txrx_reset_dynamic_and_custom_btns(SubGhzTxRx* instance);
|
|
|
|
SubGhzReceiver* subghz_txrx_get_receiver(SubGhzTxRx* instance); // TODO use only in DecodeRaw
|
|
|
|
/**
|
|
* @brief Set current preset AM650 without additional params
|
|
*
|
|
* @param instance - instance Pointer to a SubGhzTxRx
|
|
* @param frequency - frequency of preset, if pass 0 then taking default frequency 433.92MHz
|
|
*/
|
|
void subghz_txrx_set_default_preset(SubGhzTxRx* instance, uint32_t frequency);
|
|
|
|
/**
|
|
* @brief Set current preset by index
|
|
*
|
|
* @param instance - instance Pointer to a SubGhzTxRx
|
|
* @param frequency - frequency of new preset
|
|
* @param index - index of preset taken from SubGhzSetting
|
|
* @return const char* - name of preset
|
|
*/
|
|
const char*
|
|
subghz_txrx_set_preset_internal(SubGhzTxRx* instance, uint32_t frequency, uint8_t index);
|