Synergy Software Package User's Manual

#include <sf_cellular_api.h>

Data Fields

sf_cellular_op_select_mode_t op_select_mode
 Cellular Operator selection mode.
 
sf_cellular_op_t op
 Cellular operator. Valid when operator selection mode is manual.
 
uint16_t num_pref_ops
 Number of preferred operators in the pref_ops array.
 
sf_cellular_op_t pref_ops [SF_CELLULAR_MAX_PREFFERED_OPERATOR_COUNT]
 Array of structures describing preferred operators.
 
sf_cellular_timezone_update_mode_t tz_upd_mode
 TimeZone update mode policy.
 
uint8_t * p_sim_pin
 SIM Pin.
 
uint8_t * p_puk_pin
 PUK Pin.
 
ssp_err_t(* p_prov_callback )(sf_cellular_callback_args_t *p_args)
 
void(* p_recv_callback )(sf_cellular_callback_args_t *p_args)
 
ssp_err_t(* p_read_sim_pin_info_callback )(sf_cellular_sim_pin_info_t *p_args)
 
ssp_err_t(* p_cmd_param_callback )(sf_cellular_command_parameters_info_t **p_args, uint8_t *p_at_cmd_num)
 
void const * p_context
 User defined context passed into callback function.
 
void const * p_extend
 Instance specific configuration.
 
sf_cellular_at_cmd_set_t const * p_cmd_set
 Instance specific command set.
 
sf_cellular_at_cmd_set_tp_modifiable_cmd_set
 Instance specific modifiable command set.
 

Detailed Description

Define the Cellular configuration parameters

Field Documentation

◆ p_cmd_param_callback

ssp_err_t(* sf_cellular_cfg_t::p_cmd_param_callback) (sf_cellular_command_parameters_info_t **p_args, uint8_t *p_at_cmd_num)

Pointer to callback function to configure AT command parameters like retry delay and retry count at runtime

◆ p_prov_callback

ssp_err_t(* sf_cellular_cfg_t::p_prov_callback) (sf_cellular_callback_args_t *p_args)

Pointer to provisioning callback function, used in NSAL

◆ p_read_sim_pin_info_callback

ssp_err_t(* sf_cellular_cfg_t::p_read_sim_pin_info_callback) (sf_cellular_sim_pin_info_t *p_args)

Pointer to callback function to configure the SIM properties at runtime

◆ p_recv_callback

void(* sf_cellular_cfg_t::p_recv_callback) (sf_cellular_callback_args_t *p_args)

This is the receive callback function used by NetX which will take a data packet from the Cellular module and hand it over to NetX for further processing.


The documentation for this struct was generated from the following file: