#include <sf_cellular_api.h>

Data Fields
ssp_err_t(*	open )(sf_cellular_ctrl_t p_ctrl, sf_cellular_cfg_t const const p_cfg)
	Initializes and enables the Cellular module. More...

ssp_err_t(*	close )(sf_cellular_ctrl_t *const p_ctrl)
	Disables the Cellular module. More...

ssp_err_t(*	provisioningGet )(sf_cellular_ctrl_t const p_ctrl, sf_cellular_provisioning_t const p_cellular_provisioning)
	Pointer to function to Get the Cellular module provisioning information. More...

ssp_err_t(*	provisioningSet )(sf_cellular_ctrl_t const p_ctrl, sf_cellular_provisioning_t const const p_cellular_provisioning)
	Pointer to function to Set the Cellular module's provisioning information. More...

ssp_err_t(*	infoGet )(sf_cellular_ctrl_t const p_ctrl, sf_cellular_info_t const p_cellular_info)
	Reads the Cellular module's information. More...

ssp_err_t(*	statisticsGet )(sf_cellular_ctrl_t const p_ctrl, sf_cellular_stats_t const p_cellular_device_stats)
	Returns statistics information of Cellular module. More...

ssp_err_t(*	transmit )(sf_cellular_ctrl_t const p_ctrl, uint8_t const p_buf, uint32_t length)
	Passes packet buffer to PPP stack for transmission. More...

ssp_err_t(*	versionGet )(ssp_version_t *const p_version)
	Gets version and stores it in provided pointer p_version. More...

ssp_err_t(*	networkConnect )(sf_cellular_ctrl_t *const p_ctrl)
	Initiates the Data connection. More...

ssp_err_t(*	networkDisconnect )(sf_cellular_ctrl_t *const p_ctrl)
	Terminates the Data connection. More...

ssp_err_t(*	networkStatusGet )(sf_cellular_ctrl_t const p_ctrl, sf_cellular_network_status_t p_network_status)
	Get Network Status information. More...

ssp_err_t(*	simPinSet )(sf_cellular_ctrl_t const p_ctrl, uint8_t const p_old_pin, uint8_t *const p_new_pin)
	Set SIM Pin. More...

ssp_err_t(*	simLock )(sf_cellular_ctrl_t const p_ctrl, uint8_t const p_pin)
	Locks SIM. More...

ssp_err_t(*	simUnlock )(sf_cellular_ctrl_t const p_ctrl, uint8_t const p_pin)
	Unlocks SIM. More...

ssp_err_t(*	simIDGet )(sf_cellular_ctrl_t const p_ctrl, uint8_t p_sim_id)
	Gets the SIM ID. More...

ssp_err_t(*	commandSend )(sf_cellular_ctrl_t const p_ctrl, sf_cellular_cmd_resp_t const p_input_at_command, sf_cellular_cmd_resp_t *const p_output, uint32_t const timeout)
	Send AT command directly to Cellular Modem. More...

ssp_err_t(*	fotaCheck )(sf_cellular_ctrl_t const p_ctrl, void p_fotacheck)
	Checks for Available Firmware upgrade. More...

ssp_err_t(*	fotaStart )(sf_cellular_ctrl_t const p_ctrl, void p_fotastart)
	Starts the Firmware upgrade. More...

ssp_err_t(*	fotaStop )(sf_cellular_ctrl_t const p_ctrl, void p_fotastop)
	Stops the Firmware upgrade. More...

ssp_err_t(*	reset )(sf_cellular_ctrl_t *const p_ctrl, sf_cellular_reset_type_t reset_type)
	Reset cellular module. This reset() API will only work when module is opened. More...

Detailed Description

Cellular Framework API structure.

Field Documentation

◆ close

ssp_err_t(* sf_cellular_api_t::close) (sf_cellular_ctrl_t *const p_ctrl)

Disables the Cellular module.

Parameters

[in] p_ctrl Pointer to the control block for the Cellular module. .

◆ commandSend

ssp_err_t(* sf_cellular_api_t::commandSend) (sf_cellular_ctrl_t *const p_ctrl, sf_cellular_cmd_resp_t *const p_input_at_command, sf_cellular_cmd_resp_t *const p_output, uint32_t const timeout)

Send AT command directly to Cellular Modem.

This API will send AT command provided by user to the Cellular Modem and will collect the response from the Modem and will send it back to the user. If Modem is in Data Mode when this API is called then Framework will first switch Modem to Command Mode, then send the AT command and collect the response and then switches the Modem back to Data Mode.

Parameters

[in]	p_ctrl	Pointer to the control block for the Cellular module.
[in]	p_input_at_command	Pointer to structure which contains Modem command to send
[in,out]	p_output	Pointer to buffer in which response will be sent to user, Also user will pass the size of the buffer which is pointed by p_output
[in]	timeout	Timeout for which framework will wait for response

◆ fotaCheck

ssp_err_t(* sf_cellular_api_t::fotaCheck) (sf_cellular_ctrl_t *const p_ctrl, void *p_fotacheck)

Checks for Available Firmware upgrade.

Parameters

[in]	p_ctrl	Pointer to the control block for the Cellular module.
[in]	p_fotacheck	Pointer to fota check specific data structure

◆ fotaStart

ssp_err_t(* sf_cellular_api_t::fotaStart) (sf_cellular_ctrl_t *const p_ctrl, void *p_fotastart)

Starts the Firmware upgrade.

Parameters

[in]	p_ctrl	Pointer to the control block for the Cellular module.
[in]	p_fotastart	Pointer to fota start specific data structure

◆ fotaStop

ssp_err_t(* sf_cellular_api_t::fotaStop) (sf_cellular_ctrl_t *const p_ctrl, void *p_fotastop)

Stops the Firmware upgrade.

Parameters

[in]	p_ctrl	Pointer to the control block for the Cellular module.
[in]	p_fotastop	Pointer to fota stop specific data structure

◆ infoGet

ssp_err_t(* sf_cellular_api_t::infoGet) (sf_cellular_ctrl_t *const p_ctrl, sf_cellular_info_t *const p_cellular_info)

Reads the Cellular module's information.

Parameters

[in]	p_ctrl	Pointer to the control block for the Cellular module.
[out]	p_cellular_info	Pointer to Cellular info structure.

◆ networkConnect

ssp_err_t(* sf_cellular_api_t::networkConnect) (sf_cellular_ctrl_t *const p_ctrl)

Initiates the Data connection.

Parameters

[in] p_ctrl Pointer to the control block for the Cellular module.

◆ networkDisconnect

ssp_err_t(* sf_cellular_api_t::networkDisconnect) (sf_cellular_ctrl_t *const p_ctrl)

Terminates the Data connection.

Parameters

[in] p_ctrl Pointer to the control block for the Cellular module.

◆ networkStatusGet

ssp_err_t(* sf_cellular_api_t::networkStatusGet) (sf_cellular_ctrl_t *const p_ctrl, sf_cellular_network_status_t *p_network_status)

Get Network Status information.

Parameters

[in]	p_ctrl	Pointer to the control block for the Cellular module.
[out]	p_network_status	Pointer to Network Status structure

◆ open

ssp_err_t(* sf_cellular_api_t::open) (sf_cellular_ctrl_t *p_ctrl, sf_cellular_cfg_t const *const p_cfg)

Initializes and enables the Cellular module.

Parameters

[in,out]	p_ctrl	Pointer to user-provided storage for the control block.
[in]	p_cfg	Pointer to Cellular configuration structure.

◆ provisioningGet

ssp_err_t(* sf_cellular_api_t::provisioningGet) (sf_cellular_ctrl_t *const p_ctrl, sf_cellular_provisioning_t *const p_cellular_provisioning)

Pointer to function to Get the Cellular module provisioning information.

Parameters

[in]	p_ctrl	Pointer to the control block for the Cellular module.
[out]	p_cellular_provisioning	Pointer to Cellular provisioning structure.

◆ provisioningSet

ssp_err_t(* sf_cellular_api_t::provisioningSet) (sf_cellular_ctrl_t *const p_ctrl, sf_cellular_provisioning_t const *const p_cellular_provisioning)

Pointer to function to Set the Cellular module's provisioning information.

Parameters

[in]	p_ctrl	Pointer to the control block for the Cellular module.
[in]	p_cellular_provisioning	Pointer to Cellular provisioning structure.

◆ reset

ssp_err_t(* sf_cellular_api_t::reset) (sf_cellular_ctrl_t *const p_ctrl, sf_cellular_reset_type_t reset_type)

Reset cellular module. This reset() API will only work when module is opened.

Parameters

[in]	p_ctrl	Pointer to the control block for the Cellular module.
[in]	reset_type	Reset type

◆ simIDGet

ssp_err_t(* sf_cellular_api_t::simIDGet) (sf_cellular_ctrl_t *const p_ctrl, uint8_t *p_sim_id)

Gets the SIM ID.

Parameters

[in]	p_ctrl	Pointer to the control block for the Cellular module.
[out]	p_sim_id	SIM ID

◆ simLock

ssp_err_t(* sf_cellular_api_t::simLock) (sf_cellular_ctrl_t *const p_ctrl, uint8_t *const p_pin)

Locks SIM.

Parameters

[in]	p_ctrl	Pointer to the control block for the Cellular module.
[in]	p_pin	PIN number to lock the SIM

◆ simPinSet

ssp_err_t(* sf_cellular_api_t::simPinSet) (sf_cellular_ctrl_t *const p_ctrl, uint8_t *const p_old_pin, uint8_t *const p_new_pin)

Set SIM Pin.

Parameters

[in]	p_ctrl	Pointer to the control block for the Cellular module.
[in]	p_old_pin	Pointer to char array containing current 4 digit pin.
[in]	p_new_pin	Pointer to char array containing new 4 digit pin.

◆ simUnlock

ssp_err_t(* sf_cellular_api_t::simUnlock) (sf_cellular_ctrl_t *const p_ctrl, uint8_t *const p_pin)

Unlocks SIM.

Parameters

[in]	p_ctrl	Pointer to the control block for the Cellular module.
[in]	p_pin	PIN number to unlock the SIM

◆ statisticsGet

ssp_err_t(* sf_cellular_api_t::statisticsGet) (sf_cellular_ctrl_t *const p_ctrl, sf_cellular_stats_t *const p_cellular_device_stats)

Returns statistics information of Cellular module.

Parameters

[in]	p_ctrl	Pointer to the control block for the Cellular module.
[out]	p_cellular_device_stats	Pointer to Cellular statistics information structure.

◆ transmit

ssp_err_t(* sf_cellular_api_t::transmit) (sf_cellular_ctrl_t *const p_ctrl, uint8_t *const p_buf, uint32_t length)

Passes packet buffer to PPP stack for transmission.

Parameters

[in]	p_ctrl	Pointer to the control block for the Cellular module.
[in]	p_buf	Pointer to packet buffer to transmit
[in]	length	Length of packet buffer

◆ versionGet

ssp_err_t(* sf_cellular_api_t::versionGet) (ssp_version_t *const p_version)

Gets version and stores it in provided pointer p_version.

Parameters

[out] p_version pointer to memory location to return version number

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

sf_cellular_api.h

Data Fields

Detailed Description

Field Documentation

◆ close

◆ commandSend

◆ fotaCheck

◆ fotaStart

◆ fotaStop

◆ infoGet

◆ networkConnect

◆ networkDisconnect

◆ networkStatusGet

◆ open

◆ provisioningGet

◆ provisioningSet

◆ reset

◆ simIDGet

◆ simLock

◆ simPinSet

◆ simUnlock

◆ statisticsGet

◆ transmit

◆ versionGet