#include <AT_CellularDevice.h>

Inherited by GEMALTO_CINTERION, GENERIC_AT3GPP, QUECTEL_BC95, QUECTEL_BG96, QUECTEL_EC2X, QUECTEL_M26, QUECTEL_UG96, RM1000_AT, SARA4_PPP, TELIT_HE910, TELIT_ME910, UBLOX_AT, UBLOX_N2XX, and UBLOX_PPP.

Public Member Functions
virtual nsapi_error_t	clear ()
	Clear modem to a default initial state.
virtual nsapi_error_t	hard_power_on ()
	Sets the modem up for powering on This is equivalent to plugging in the device, i.e., attaching power and serial port.
virtual nsapi_error_t	hard_power_off ()
	Sets the modem in unplugged state.
virtual nsapi_error_t	soft_power_on ()
	Powers up the modem.
virtual nsapi_error_t	soft_power_off ()
	Powers down the modem.
virtual nsapi_error_t	set_pin (const char *sim_pin)
	Open the SIM card by setting the pin code for SIM.
virtual nsapi_error_t	get_sim_state (SimState &state)
	Get SIM card's state.
virtual CellularContext *	create_context (FileHandle fh=NULL, const char apn=NULL, bool cp_req=false, bool nonip_req=false)
	Creates a new CellularContext interface.
virtual CellularContext *	create_context (UARTSerial serial, const char const apn, PinName dcd_pin=NC, bool active_high=false, bool cp_req=false, bool nonip_req=false)
	Creates a new CellularContext interface.
virtual void	delete_context (CellularContext *context)
	Deletes the given CellularContext instance.
virtual CellularNetwork *	open_network (FileHandle *fh=NULL)
	Create new CellularNetwork interface.
virtual CellularInformation *	open_information (FileHandle *fh=NULL)
	Create new CellularInformation interface.
virtual void	close_network ()
	Closes the opened CellularNetwork by deleting the CellularNetwork instance.
virtual void	close_information ()
	Closes the opened CellularInformation by deleting the CellularInformation instance.
virtual void	set_timeout (int timeout)
	Set the default response timeout.
virtual void	modem_debug_on (bool on)
	Turn modem debug traces on.
virtual nsapi_error_t	init ()
	Initialize cellular device must be called right after the module is ready.
virtual nsapi_error_t	shutdown ()
	Shutdown cellular device to minimum functionality.
virtual nsapi_error_t	is_ready ()
	Check whether the device is ready to accept commands.
virtual void	set_ready_cb (Callback< void()> callback)
	Set callback function to listen when device is ready.
virtual nsapi_error_t	set_power_save_mode (int periodic_time, int active_time=0)
	Set power save mode.
virtual ATHandler *	get_at_handler ()
	Get the current ATHandler instance in use for debug purposes etc.
virtual nsapi_error_t	release_at_handler (ATHandler *at_handler)
	Releases the given at_handler.
virtual AT_CellularContext *	create_context_impl (ATHandler &at, const char *apn, bool cp_req=false, bool nonip_req=false)
	Creates new instance of AT_CellularContext or if overridden, modem specific implementation.
virtual AT_CellularNetwork *	open_network_impl (ATHandler &at)
	Create new instance of AT_CellularNetwork or if overridden, modem specific implementation.
virtual AT_CellularInformation *	open_information_impl (ATHandler &at)
	Create new instance of AT_CellularInformation or if overridden, modem specific implementation.
virtual CellularContext *	get_context_list () const
	Get the linked list of CellularContext instances.
virtual nsapi_error_t	set_baud_rate (int baud_rate)
	Sets cellular modem to given baud rate.
virtual CellularSMS *	open_sms (FileHandle *fh=NULL)
	Create new CellularSMS interface.
virtual void	close_sms ()
	Closes the opened CellularSMS by deleting the CellularSMS instance.
virtual AT_CellularSMS *	open_sms_impl (ATHandler &at)
	Create new instance of AT_CellularSMS or if overridden, modem specific implementation.
intptr_t	get_property (CellularProperty key)
	Get value for the given key.
void	set_cellular_properties (const intptr_t *property_array)
	Cellular module need to define an array of cellular properties which defines module supported property values.
virtual events::EventQueue *	get_queue ()
	Get event queue that can be chained to main event queue.
	MBED_DEPRECATED_SINCE ("mbed-os-5.15","Use CellularDevice::shutdown() instead.") void stop()
	Stop the current operation.
FileHandle &	get_file_handle () const
	Get the current FileHandle item used when communicating with the modem.
void	set_sim_pin (const char *sim_pin)
	Set the pin code for SIM card.
void	set_plmn (const char *plmn)
	Plmn to use when registering to cellular network.
nsapi_error_t	set_device_ready ()
	Start the interface.
nsapi_error_t	set_sim_ready ()
	Start the interface.
nsapi_error_t	register_to_network ()
	Start the interface.
nsapi_error_t	attach_to_network ()
	Start the interface.
void	attach (Callback< void(nsapi_event_t, intptr_t)> status_cb)
	Register callback for status reporting.
void	set_retry_timeout_array (const uint16_t timeout[], int array_len)
	Set an array of timeouts to wait before CellularStateMachine retries after failure.
Static Public Member Functions
static CellularDevice *	get_default_instance ()
	Returns singleton instance of CellularDevice, if Mbed target board has a supported onboard modem, or provide-default is defined for a cellular driver in JSON configuration files.
static CellularDevice *	get_target_default_instance ()
	Return target onboard instance of CellularDevice.
Protected Member Functions
virtual void	cellular_callback (nsapi_event_t ev, intptr_t ptr, CellularContext *ctx=NULL)
	Cellular callback to be attached to Network and CellularStateMachine classes.
void	get_retry_timeout_array (uint16_t *timeout, int &array_len) const
	Get the retry array from the CellularStateMachine.

Detailed Description

Class AT_CellularDevice.

A class defines opening and closing of cellular interfaces. Deleting/Closing of opened interfaces can be done only through this class.

Definition at line 37 of file AT_CellularDevice.h.

Member Function Documentation

void attach ( Callback< void(nsapi_event_t, intptr_t)> status_cb ) [inherited]

Register callback for status reporting.

The specified status callback function will be called on the network and cellular device status changes. The parameters on the callback are the event type and event-type dependent reason parameter.

Remarks:: deleting CellularDevice/CellularContext in callback not allowed.; Allocating/adding lots of traces not recommended as callback is called mostly from State machines thread which is now 2048. You can change to main thread for example via EventQueue.

Parameters:

status_cb The callback for status changes.

Definition at line 175 of file CellularDevice.cpp.

nsapi_error_t attach_to_network ( ) [inherited]

Start the interface.

Attempts to attach the device to cellular network. API is asynchronous. Application can get results from CellularContext callback, which is set with attach(...), or callback, which is set by attach(...), in this class.

Returns:: NSAPI_ERROR_OK on success NSAPI_ERROR_NO_MEMORY on case of memory failure

Definition at line 117 of file CellularDevice.cpp.

void cellular_callback	(	nsapi_event_t	ev,
		intptr_t	ptr,
		CellularContext *	ctx = `NULL`
	)		`[protected, virtual]`

Cellular callback to be attached to Network and CellularStateMachine classes.

CellularContext calls this when in PPP mode to provide network changes. This method will broadcast to every interested classes: CellularContext (might be many) and CellularStateMachine if available.

Reimplemented from CellularDevice.

Definition at line 628 of file AT_CellularDevice.cpp.

nsapi_error_t clear ( ) [virtual]

Clear modem to a default initial state.

Clear persistent user data from the modem, such as PDP contexts.

Precondition:: All open network services on modem, such as contexts and sockets, must be closed.

Postcondition:: Modem power off/on may be needed to clear modem's runtime state.

Remarks:: CellularStateMachine calls this on connect when `cellular.clear-on-connect: true`.

Returns:: NSAPI_ERROR_OK on success, otherwise modem may be need power cycling

Reimplemented from CellularDevice.

Definition at line 644 of file AT_CellularDevice.cpp.

void close_information ( ) [virtual]

Closes the opened CellularInformation by deleting the CellularInformation instance.

CellularContext * create_context	(	UARTSerial *	serial,
		const char *const	apn,
		PinName	dcd_pin = `NC`,
		bool	active_high = `false`,
		bool	cp_req = `false`,
		bool	nonip_req = `false`
	)		`[virtual]`

serial	UARTSerial used in communication to modem. If null then the default file handle is used.
apn	access point to use with context, can be null.
dcd_pin	Pin used to set data carrier detect on/off for the given UART
active_high	a boolean set to true if DCD polarity is active low
cp_req	Flag indicating if EPS control plane optimization is required
nonip_req	Flag indicating if this context is required to be Non-IP

CellularContext * create_context	(	FileHandle *	fh = `NULL`,
		const char *	apn = `NULL`,
		bool	cp_req = `false`,
		bool	nonip_req = `false`
	)		`[virtual]`

fh	file handle used in communication to modem. This can be, for example, UART handle. If null, then the default file handle is used.
apn	access point to use with context, can be null.
cp_req	flag indicating if EPS control plane optimization is required
nonip_req	flag indicating if this context is required to be Non-IP

AT_CellularContext * create_context_impl	(	ATHandler &	at,
		const char *	apn,
		bool	cp_req = `false`,
		bool	nonip_req = `false`
	)		`[virtual]`

at	ATHandler reference for communication with the modem.
apn	access point to use with context
cp_req	flag indicating if control plane EPS optimization needs to be setup
nonip_req	flag indicating if PDP context needs to be Non-IP

void get_retry_timeout_array	(	uint16_t *	timeout,
		int &	array_len
	)		const `[protected, inherited]`

timeout	timeout array containing seconds for retry logic. Must have space for CELLULAR_RETRY_ARRAY_SIZE (defined in CellularCommon.h)
array_len	length of the timeout array on return

MBED_DEPRECATED_SINCE	(	"mbed-os-5.15"	,
		"Use CellularDevice::shutdown() instead."
	)		`[inherited]`

nsapi_error_t set_power_save_mode	(	int	periodic_time,
		int	active_time = `0`
	)		`[virtual]`

periodic_time	in seconds to enable power save, or zero to disable
active_time	in seconds to wait before entering power save mode

void set_retry_timeout_array	(	const uint16_t	timeout[],
		int	array_len
	)		`[inherited]`

timeout	timeout array using seconds
array_len	length of the array

Important changes to repositories hosted on mbed.com

AT_CellularDevice Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning