498ffe8d2c
* subghz: add cli support for packet tx rx * api-hal-subghz: add comments * subghz_cli: fix typo Co-authored-by: あく <alleteam@gmail.com>
106 lines
2.4 KiB
C
106 lines
2.4 KiB
C
#pragma once
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** Radio Presets */
|
|
typedef enum {
|
|
ApiHalSubGhzPresetOokAsync, /** OOK, asynchronous */
|
|
ApiHalSubGhzPreset2FskPacket, /** 2FSK, 115kBaud, variable packet length */
|
|
} ApiHalSubGhzPreset;
|
|
|
|
/** Switchable Radio Paths */
|
|
typedef enum {
|
|
ApiHalSubGhzPathIsolate, /** Isolate Radio from antenna */
|
|
ApiHalSubGhzPath433, /** Center Frquency: 433MHz. Path 1: SW1RF1-SW2RF2, LCLCL */
|
|
ApiHalSubGhzPath315, /** Center Frquency: 315MHz. Path 2: SW1RF2-SW2RF1, LCLCLCL */
|
|
ApiHalSubGhzPath868, /** Center Frquency: 868MHz. Path 3: SW1RF3-SW2RF3, LCLC */
|
|
} ApiHalSubGhzPath;
|
|
|
|
/** Initialize and switch to power save mode
|
|
* Used by internal API-HAL initalization routine
|
|
* Can be used to reinitialize device to safe state and send it to sleep
|
|
*/
|
|
void api_hal_subghz_init();
|
|
|
|
/** Dump info to stdout */
|
|
void api_hal_subghz_dump_state();
|
|
|
|
/** Load registers from preset by preset name
|
|
* @param preset to load
|
|
*/
|
|
void api_hal_subghz_load_preset(ApiHalSubGhzPreset preset);
|
|
|
|
/** Get status */
|
|
uint8_t api_hal_subghz_get_status();
|
|
|
|
/** Load registers
|
|
* @param register-value pairs array, terminated with {0,0}
|
|
*/
|
|
void api_hal_subghz_load_registers(const uint8_t data[][2]);
|
|
|
|
/** Load PATABLE
|
|
* @param data, 8 uint8_t values
|
|
*/
|
|
void api_hal_subghz_load_patable(const uint8_t data[8]);
|
|
|
|
/** Write packet to FIFO
|
|
* @param data, bytes array
|
|
* @param size, size
|
|
*/
|
|
void api_hal_subghz_write_packet(const uint8_t* data, uint8_t size);
|
|
|
|
/** Read packet from FIFO
|
|
* @param data, pointer
|
|
* @param size, size
|
|
*/
|
|
|
|
void api_hal_subghz_read_packet(uint8_t* data, uint8_t* size);
|
|
|
|
/** Flush rx FIFO buffer */
|
|
void api_hal_subghz_flush_rx();
|
|
|
|
/** Shutdown
|
|
* Issue spwd command
|
|
* @warning registers content will be lost
|
|
*/
|
|
void api_hal_subghz_shutdown();
|
|
|
|
/** Reset
|
|
* Issue reset command
|
|
* @warning registers content will be lost
|
|
*/
|
|
void api_hal_subghz_reset();
|
|
|
|
/** Switch to Idle */
|
|
void api_hal_subghz_idle();
|
|
|
|
/** Switch to Recieve */
|
|
void api_hal_subghz_rx();
|
|
|
|
/** Switch to Transmit */
|
|
void api_hal_subghz_tx();
|
|
|
|
/** Get RSSI value in dBm */
|
|
float api_hal_subghz_get_rssi();
|
|
|
|
/** Set frequency
|
|
* @param frequency in herz
|
|
* @return real frequency in herz
|
|
*/
|
|
uint32_t api_hal_subghz_set_frequency(uint32_t value);
|
|
|
|
/** Set path
|
|
* @param radio path to use
|
|
*/
|
|
void api_hal_subghz_set_path(ApiHalSubGhzPath path);
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|