radio_cli_app.h

Go to the documentation of this file.

 
 
#ifndef _CLI_APP_H_
#define _CLI_APP_H_
 
#include <zpal_power_manager.h>
#include <zpal_radio.h>
#include <zpal_radio_private.h>
#include <zpal_init.h>
 
/****************************************************************************/
/*                             EXPORTED DEFINES                             */
/****************************************************************************/
#define CLI_MAJOR_VERSION       0 
#define CLI_MINOR_VERSION       7 
#define CLI_PATCH_VERSION       1 
 
#define RADIO_CLI_SCRIPT_VERSION  1 
 
/****************************************************************************/
/*                              EXPORTED DATA                               */
/****************************************************************************/
 
#define APPLICATION_TASK_STACK              4*1024
#define APPLICATION_TASK_PRIORITY_STACK     ( TASK_PRIORITY_MAX - 10 )  
 
#define DEFAULT_TX_DELAY_MS                 100
 
typedef void (*tx_callback_t)(uint16_t success, uint16_t failed, uint16_t failed_lbt);
 
typedef void (*rx_callback_t)(uint16_t success, uint16_t failed);
 
typedef void (*event_handler_script_callback_t)(void);
 
typedef struct {
  uint8_t destid;                     
  uint32_t frame_repeat;              
  bool wait_ack;                      
  bool lbt;                           
  int8_t power;                       
  zpal_radio_zwave_channel_t channel; 
  uint32_t delay;                     
  uint8_t *payload_buffer;            
  uint8_t payload_length;             
  tx_callback_t tx_callback;          
} radio_cli_tx_frame_config_t;
 
typedef struct _scriptline_t_ {
  char entry[128];                    
} scriptline_t;
 
/****************************************************************************/
/*                            EXPORTED FUNCTIONS                            */
/****************************************************************************/
void ZwaveCliTask(void* unused_prt);
 
void cli_radio_version_print(void);
 
void cli_radio_status_get(const radio_cli_tx_frame_config_t *const tx_frame_config);
 
void cli_radio_setup(zpal_radio_region_t eRegion);
 
bool cli_radio_change_region(zpal_radio_region_t new_region);
 
void cli_radio_region_list(zpal_radio_region_t region);
 
void cli_radio_set_homeid(uint32_t home_id);
 
void cli_radio_set_nodeid(node_id_t node_id);
 
bool cli_radio_transmit_frame(const radio_cli_tx_frame_config_t *const tx_frame_config);
 
bool cli_radio_transmit_beam_frame(const radio_cli_tx_frame_config_t *const tx_frame_config);
 
bool cli_radio_start_receive(bool start_receive);
 
uint16_t cli_radio_get_rx_count(void);
 
bool cli_radio_set_lbt_level(uint8_t channel_id, int8_t level);
 
void cli_radio_set_tx_max_power_20dbm(bool max_tx_power_20dbm);
 
bool cli_radio_get_tx_max_power_20dbm(void);
 
int8_t cli_radio_get_tx_min_power(uint8_t channel_id);
 
int8_t cli_radio_get_tx_max_power(uint8_t channel_id);
 
bool cli_radio_tx_power_index_set(uint8_t channel_id, int8_t txpower, uint8_t power_index);
 
void cli_radio_tx_power_index_list(uint8_t channel_id);
 
void cli_radio_set_fixed_channel(uint8_t enable_fixed_channel, uint8_t channel);
 
uint8_t cli_radio_region_channel_count_get(void);
 
zpal_radio_network_stats_t* cli_radio_get_stats(void);
 
void cli_radio_clear_stats(bool clear_tx_timers_stat);
 
bool cli_radio_initialized(void);
 
typedef enum {
                SCRIPT_LIST = 0,      
                SCRIPT_START,         
                SCRIPT_STOP,          
                SCRIPT_RUN,           
                SCRIPT_AUTORUN_ON,    
                SCRIPT_AUTORUN_OFF,   
                SCRIPT_CLEAR          
} radio_cli_script_cmd_t;
 
void cli_radio_script(radio_cli_script_cmd_t script_state_request, int8_t script_number);
 
void cli_radio_script_state_transition_event(void);
 
void cli_radio_wait(uint32_t time_ms);
 
void cli_radio_timestamp_set(bool enable);
 
bool cli_radio_timestamp_get(void);
 
void cli_radio_tx_continues_set(bool enable, radio_cli_tx_frame_config_t *frame);
 
bool cli_radio_tx_option_set(uint8_t option, uint8_t enable);
 
void cli_radio_rf_debug_set(bool rf_state_enable);
 
void cli_radio_calibration_set(uint8_t boardno);
 
void cli_radio_calibration_list(void);
 
void cli_radio_rf_debug_reg_setting_list(bool listallreg);
 
void cli_radio_rssi_get(uint8_t channel_id);
 
void cli_radio_print_statistics(bool print_extended);
 
void cli_radio_set_payload_default(radio_cli_tx_frame_config_t *frame);
 
zpal_radio_lr_channel_config_t internal_region_to_channel_config(zpal_radio_region_t region);
 
zpal_radio_region_t cli_radio_region_current_get(void);
 
char *cli_radio_region_current_description_get(void);
 
uint8_t cli_radio_convert_zpal_channel_to_internal(zpal_radio_zwave_channel_t zwave_channel_id);
 
zpal_reset_reason_t cli_radio_reset_reason_get(void);
 
void cli_radio_reset_reason_set(zpal_reset_reason_t reset_reason);
 
void cli_system_dumpft();
 
void cli_system_dumpmp();
 
void cli_calibration_change_xtal(uint16_t xtal_value);
 
void cli_calibration_store_xtal(uint16_t xtal_cal);
 
#endif  /* _CLI_APP_H_ */