lr1110_radio.h

Go to the documentation of this file.

 
#ifndef LR1110_RADIO_H
#define LR1110_RADIO_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * -----------------------------------------------------------------------------
 * --- DEPENDENCIES ------------------------------------------------------------
 */
 
#include "transceiver/lr1110_radio_types.h"
#include "common/lr1110_types.h"
#include "common/lr1110_hal.h"
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC MACROS -----------------------------------------------------------
 */
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC CONSTANTS --------------------------------------------------------
 */
 
#define LR1110_RADIO_GFSK_SYNC_WORD_LENGTH 8
 
#define LR11110_RADIO_GFSK_SYNC_WORD_DEFAULT           \
    {                                                  \
        0x97, 0x23, 0x52, 0x25, 0x56, 0x53, 0x65, 0x64 \
    }
    
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC TYPES ------------------------------------------------------------
 */
 
/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC FUNCTIONS PROTOTYPES ---------------------------------------------
 */
 
err_t lr1110_radio_reset_stats( lriot_t *ctx );
 
err_t lr1110_radio_get_gfsk_stats( lriot_t *ctx, lr1110_radio_stats_gfsk_t* stats );
 
err_t lr1110_radio_get_lora_stats( lriot_t *ctx, lr1110_radio_stats_lora_t* stats );
 
err_t lr1110_radio_get_pkt_type( lriot_t *ctx, uint8_t* pkt_type );
 
err_t lr1110_radio_get_rx_buffer_status( lriot_t *ctx, lr1110_radio_rx_buffer_status_t* rx_buffer_status );
 
err_t lr1110_radio_get_gfsk_pkt_status( lriot_t *ctx, lr1110_radio_pkt_status_gfsk_t* pkt_status );
 
err_t lr1110_radio_get_lora_pkt_status( lriot_t *ctx, lr1110_radio_pkt_status_lora_t* pkt_status );
 
err_t lr1110_radio_get_rssi_inst( lriot_t *ctx, int8_t* rssi_in_dbm );
 
err_t lr1110_radio_set_gfsk_sync_word( lriot_t *ctx, uint8_t gfsk_sync_word[LR1110_RADIO_GFSK_SYNC_WORD_LENGTH] );
 
err_t lr1110_radio_set_lora_sync_word( lriot_t *ctx, uint8_t sync_word );
 
err_t lr1110_radio_set_lora_public_network( lriot_t *ctx, lr1110_radio_lora_network_type_t network_type );
 
err_t lr1110_radio_set_rx( lriot_t *ctx, uint32_t timeout_in_ms );
 
err_t lr1110_radio_set_rx_with_timeout_in_rtc_step( lriot_t *ctx, uint32_t timeout_in_rtc_step );
 
err_t lr1110_radio_set_tx( lriot_t *ctx, uint32_t timeout_in_ms );
 
err_t lr1110_radio_set_tx_with_timeout_in_rtc_step( lriot_t *ctx, uint32_t timeout_in_rtc_step );
 
err_t lr1110_radio_set_rf_freq( lriot_t *ctx, uint32_t freq_in_hz );
 
err_t lr1110_radio_auto_tx_rx( lriot_t *ctx, uint32_t delay, lr1110_radio_intermediary_mode_t intermediary_mode,
                               uint32_t timeout );
 
err_t lr1110_radio_set_cad_params( lriot_t *ctx, lr1110_radio_cad_params_t* cad_params );
 
err_t lr1110_radio_set_pkt_type( lriot_t *ctx, uint8_t pkt_type );
 
err_t lr1110_radio_set_gfsk_mod_params( lriot_t *ctx, lr1110_radio_mod_params_gfsk_t* mod_params );
 
err_t lr1110_radio_set_lora_mod_params( lriot_t *ctx, lr1110_radio_mod_params_lora_t* mod_params );
 
err_t lr1110_radio_set_gfsk_pkt_params( lriot_t *ctx, lr1110_radio_pkt_params_gfsk_t* pkt_params );
 
err_t lr1110_radio_set_lora_pkt_params( lriot_t *ctx, lr1110_radio_pkt_params_lora_t* pkt_params );
 
err_t lr1110_radio_set_tx_params( lriot_t *ctx, int8_t pwr_in_dbm, lr1110_radio_ramp_time_t ramp_time );
 
err_t lr1110_radio_set_pkt_address( lriot_t *ctx, uint8_t node_address, uint8_t broadcast_address );
 
err_t lr1110_radio_set_rx_tx_fallback_mode( lriot_t *ctx, lr1110_radio_fallback_modes_t fallback_mode );
 
err_t lr1110_radio_set_rx_duty_cycle( lriot_t *ctx, uint32_t rx_period_in_ms, uint32_t sleep_period_in_ms,
                                      lr1110_radio_rx_duty_cycle_mode_t mode );
 
err_t lr1110_radio_set_rx_duty_cycle_with_timings_in_rtc_step( lriot_t *ctx,uint32_t rx_period_in_rtc_step,
                                                               uint32_t sleep_period_in_rtc_step,
                                                               lr1110_radio_rx_duty_cycle_mode_t mode );
 
err_t lr1110_radio_set_pa_cfg( lriot_t *ctx, lr1110_radio_pa_cfg_t* pa_cfg );
 
err_t lr1110_radio_stop_timeout_on_preamble( lriot_t *ctx, bool stop_timeout_on_preamble );
 
err_t lr1110_radio_set_cad( lriot_t *ctx );
 
err_t lr1110_radio_set_tx_cw( lriot_t *ctx );
 
err_t lr1110_radio_set_tx_infinite_preamble( lriot_t *ctx );
 
err_t lr1110_radio_set_lora_sync_timeout( lriot_t *ctx, uint8_t nb_symbol );
 
err_t lr1110_radio_set_gfsk_crc_params( lriot_t *ctx, uint32_t seed, uint32_t polynomial );
 
err_t lr1110_radio_set_gfsk_whitening_seed( lriot_t *ctx, uint16_t seed );
 
err_t lr1110_radio_cfg_rx_boosted( lriot_t *ctx, bool enable_boost_mode );
 
err_t lr1110_radio_get_gfsk_rx_bandwidth( uint32_t bw_in_hz, lr1110_radio_gfsk_bw_t* bw_parameter );
 
uint32_t lr1110_radio_get_lora_time_on_air_numerator( lr1110_radio_pkt_params_lora_t* pkt_p,
                                                      lr1110_radio_mod_params_lora_t* mod_p );
 
uint32_t lr1110_radio_get_lora_bw_in_hz( lr1110_radio_lora_bw_t bw );
 
uint32_t lr1110_radio_get_lora_time_on_air_in_ms( lr1110_radio_pkt_params_lora_t* pkt_p,
                                                  lr1110_radio_mod_params_lora_t* mod_p );
 
uint32_t lr1110_radio_get_gfsk_time_on_air_numerator( lr1110_radio_pkt_params_gfsk_t* pkt_p );
 
uint32_t lr1110_radio_get_gfsk_time_on_air_in_ms( lr1110_radio_pkt_params_gfsk_t* pkt_p,
                                                  lr1110_radio_mod_params_gfsk_t* mod_p );
 
uint32_t lr1110_radio_convert_time_in_ms_to_rtc_step( uint32_t time_in_ms );
 
 
err_t lr1110_radio_get_lora_rx_info( lriot_t *ctx, bool* is_crc_present, uint8_t* cr );
 
#ifdef __cplusplus
}
#endif
 
#endif  // LR1110_RADIO_H
 
/* --- EOF ------------------------------------------------------------------ */