UbloxCellularBase class. More...

#include <UbloxCellularBase.h>

Data Structures
struct	DeviceInfo
	Info about the modem. More...
Public Types
enum	NetworkRegistrationStatusCsd
	Circuit Switched network registration status (CREG Usage). More...
enum	NetworkRegistrationStatusPsd
	Packet Switched network registration status (CGREG Usage). More...
enum	NetworkRegistrationStatusEps
	EPS network registration status (CEREG Usage). More...
enum	RAT
	RAT values for +URAT command R412M only supports value 7 (CatM1), 8 (NB1), and 9 (GPRS) More...
enum	MNOProfile
	Supported MNO profiles for SARA-R4. More...
Public Member Functions
bool	init (const char *pin=0)
	Initialise the modem, ready for use.
bool	nwk_registration ()
	Perform registration with the network.
bool	is_registered_csd ()
	True if the modem is registered for circuit switched data, otherwise false.
bool	is_registered_psd ()
	True if the modem is registered for packet switched data, otherwise false.
bool	is_registered_eps ()
	True if the modem is registered for enhanced packet switched data (i.e.
bool	nwk_deregistration ()
	Perform deregistration from the network.
void	deinit ()
	Put the modem into its lowest power state.
void	set_pin (const char *pin)
	Set the PIN code for the SIM card.
bool	sim_pin_check_enable (bool enableNotDisable)
	Enable or disable SIM pin checking.
bool	change_sim_pin (const char *new_pin)
	Change the SIM pin.
	MBED_DEPRECATED ("This method is now replaced by const char * imei(), please use that instead") bool get_imei(char *imei_to_send
	Get the IMEI.
const char *	imei ()
	Get the IMEI of the module.
const char *	meid ()
	Get the Mobile Equipment ID (which may be the same as the IMEI).
const char *	imsi ()
	Get the IMSI of the SIM.
const char *	iccid ()
	Get the ICCID of the SIM.
int	rssi ()
	Get the RSSI.
bool	set_mno_profile (MNOProfile profile=DEFAULT_MNO_PROFILE)
	Reads the current MNO profile from modem and sets it to user specified profile.
bool	get_mno_profile (MNOProfile *profile)
	Get current MNO profile.
bool	set_modem_rat (RAT selected_rat, RAT preferred_rat=NOT_USED, RAT second_preferred_rat=NOT_USED)
	Set Radio Access Technology on modem.
bool	get_modem_rat (RAT selected_rat, RAT preferred_rat, RAT *second_preferred_rat)
	Get last saved values for RAT using +URAT read command.
bool	reboot_modem ()
	reboot the modem using AT+CFUN=15.
Protected Types
enum	DeviceType
	Supported u-blox modem variants. More...
enum	RadioAccessNetworkType
	Network registration status. More...
Protected Member Functions
virtual void	modem_init ()
	Sets the modem up for powering on.
virtual void	modem_deinit ()
	Sets the modem in unplugged state.
virtual void	modem_power_up ()
	Powers up the modem.
virtual void	modem_power_down ()
	Powers down the modem.
void	baseClassInit (PinName tx=MDMTXD, PinName rx=MDMRXD, int baud=MBED_CONF_UBLOX_CELL_BAUD_RATE, bool debug_on=false)
	Initialise this class.
void	at_set_timeout (int timeout)
	Set the AT parser timeout.
int	read_at_to_char (char *buf, int size, char end)
	Read up to size characters from buf or until the character "end" is reached, overwriting the newline with 0 and ensuring a terminator in all cases.
bool	power_up ()
	Powers up the modem.
void	power_down ()
	Power down the modem.
void	lock (void)
	Lock a mutex when accessing the modem.
void	unlock (void)
	Unlock the modem when done accessing it.
bool	set_device_identity (DeviceType *dev)
	Set the device identity in _dev_info based on the ATI string returned by the module.
bool	device_init (DeviceType dev)
	Perform any modem initialisation that is specialised by device type.
bool	initialise_sim_card ()
	Set up the SIM.
Protected Attributes
ATCmdParser *	_at
	Point to the instance of the AT parser in use.
int	_at_timeout
	The current AT parser timeout value.
FileHandle *	_fh
	File handle used by the AT parser.
Mutex	_mtx
	The mutex resource.
DeviceInfo	_dev_info
	General info about the modem as a device.
const char *	_pin
	The SIM PIN to use.
bool	_debug_trace_on
	Set to true to spit out debug traces.
int	_baud
	The baud rate to the modem.
bool	_modem_initialised
	True if the modem is ready register to the network, otherwise false.
bool	_sim_pin_check_enabled
	True it the SIM requires a PIN, otherwise false.
char	_plmn [PLMN_SIZE+1]
	PLMN for manual registration.

Detailed Description

UbloxCellularBase class.

This class provides all the base support for generic u-blox modems on C030 and C027 boards: module identification, power-up, network registration, etc.

Definition at line 35 of file UbloxCellularBase.h.

Member Enumeration Documentation

enum DeviceType [protected]

Supported u-blox modem variants.

Definition at line 287 of file UbloxCellularBase.h.

enum MNOProfile

Supported MNO profiles for SARA-R4.

Definition at line 198 of file UbloxCellularBase.h.

enum NetworkRegistrationStatusCsd

Circuit Switched network registration status (CREG Usage).

UBX-13001820 - AT Commands Example Application Note (Section 7.10.3).

Definition at line 41 of file UbloxCellularBase.h.

enum NetworkRegistrationStatusEps

EPS network registration status (CEREG Usage).

UBX-13001820 - AT Commands Example Application Note (Section 18.36.3).

Definition at line 69 of file UbloxCellularBase.h.

enum NetworkRegistrationStatusPsd

Packet Switched network registration status (CGREG Usage).

UBX-13001820 - AT Commands Example Application Note (Section 18.27.3).

Definition at line 56 of file UbloxCellularBase.h.

enum RadioAccessNetworkType [protected]

Network registration status.

UBX-13001820 - AT Commands Example Application Note (Section 4.1.4.5).

Definition at line 302 of file UbloxCellularBase.h.

enum RAT

RAT values for +URAT command R412M only supports value 7 (CatM1), 8 (NB1), and 9 (GPRS)

Definition at line 181 of file UbloxCellularBase.h.

Member Function Documentation

void at_set_timeout ( int timeout ) [protected]

Set the AT parser timeout.

Definition at line 505 of file UbloxCellularBase.cpp.

void baseClassInit	(	PinName	tx = `MDMTXD`,
		PinName	rx = `MDMRXD`,
		int	baud = `MBED_CONF_UBLOX_CELL_BAUD_RATE`,
		bool	debug_on = `false`
	)		`[protected]`

Initialise this class.

Parameters:

tx	the UART TX data pin to which the modem is attached.
rx	the UART RX data pin to which the modem is attached.
baud	the UART baud rate.
debug_on	true to switch AT interface debug on, otherwise false.

Note: it would be more natural to do this in the constructor however, to avoid the diamond of death, this class is only every inherited virtually. Classes that are inherited virtually do not get passed parameters in their constructor and hence classInit() must be called separately by the first one to wake the beast.

Definition at line 463 of file UbloxCellularBase.cpp.

bool change_sim_pin ( const char * new_pin )

Change the SIM pin.

Parameters:

new_pin the new PIN to use.

Returns:: true if successful, otherwise false.

Definition at line 936 of file UbloxCellularBase.cpp.

void deinit ( )

Put the modem into its lowest power state.

Definition at line 894 of file UbloxCellularBase.cpp.

bool device_init ( DeviceType dev ) [protected]

Perform any modem initialisation that is specialised by device type.

Returns:: true if successful, otherwise false.

Definition at line 665 of file UbloxCellularBase.cpp.

bool get_mno_profile ( MNOProfile * profile )

Get current MNO profile.

Parameters:

profile pointer to variable that can hold the value for returned profile

Returns:: true if operation was successful, false if there was an error

Definition at line 1192 of file UbloxCellularBase.cpp.

bool get_modem_rat	(	RAT *	selected_rat,
		RAT *	preferred_rat,
		RAT *	second_preferred_rat
	)

Get last saved values for RAT using +URAT read command.

Note: The current selected RAT is indicated by DeviceInfo.rat

Parameters:

selected_rat	pointer to variable that can hold the value for selected_rat
preferred_rat	pointer to variable that can hold the value for preferred_rat
second_preferred_rat	pointer to variable that can hold the value for second_preferred_rat

Note: NOT_USED will be returned in the variables if dual or tri modes are not enabled.

Returns:: true if successful, otherwise false.

Definition at line 1099 of file UbloxCellularBase.cpp.

const char * iccid ( )

Get the ICCID of the SIM.

Returns:: a pointer to the ICCID as a null-terminated string.

Definition at line 999 of file UbloxCellularBase.cpp.

const char * imei ( )

Get the IMEI of the module.

Returns:: a pointer to the IMEI as a null-terminated string.

Definition at line 978 of file UbloxCellularBase.cpp.

const char * imsi ( )

Get the IMSI of the SIM.

Returns:: a pointer to the IMSI as a null-terminated string.

Definition at line 990 of file UbloxCellularBase.cpp.

bool init ( const char * pin = 0 )

Initialise the modem, ready for use.

Parameters:

pin	PIN for the SIM card.

Returns:: true if successful, otherwise false.

Definition at line 740 of file UbloxCellularBase.cpp.

bool initialise_sim_card ( ) [protected]

Set up the SIM.

Returns:: true if successful, otherwiss false.

Definition at line 685 of file UbloxCellularBase.cpp.

bool is_registered_csd ( )

True if the modem is registered for circuit switched data, otherwise false.

Definition at line 855 of file UbloxCellularBase.cpp.

bool is_registered_eps ( )

True if the modem is registered for enhanced packet switched data (i.e.

LTE and beyond), otherwise false.

Definition at line 868 of file UbloxCellularBase.cpp.

bool is_registered_psd ( )

True if the modem is registered for packet switched data, otherwise false.

Definition at line 862 of file UbloxCellularBase.cpp.

void lock ( void ) [protected]

Lock a mutex when accessing the modem.

Definition at line 460 of file UbloxCellularBase.h.

MBED_DEPRECATED	(	"This method is now replaced by const char *	imei(),
		please use that instead"
	)

Get the IMEI.

Returns:: true if successful, otherwise false.

const char * meid ( )

Get the Mobile Equipment ID (which may be the same as the IMEI).

Returns:: a pointer to the Mobile Equipment ID as a null-terminated string.

Definition at line 984 of file UbloxCellularBase.cpp.

void modem_deinit ( ) [protected, virtual]

Sets the modem in unplugged state.

modem_deinit() will be equivalent to pulling the plug off of the device, i.e., detaching power and serial port. This puts the modem in lowest power state. Uses onboard_modem_api.h where the implementation of onboard_modem_api is provided by the target.

Definition at line 397 of file UbloxCellularBase.cpp.

void modem_init ( ) [protected, virtual]

Sets the modem up for powering on.

modem_init() is equivalent to plugging in the device, e.g., attaching power and serial port. Uses onboard_modem_api.h where the implementation of onboard_modem_api is provided by the target.

Definition at line 392 of file UbloxCellularBase.cpp.

void modem_power_down ( ) [protected, virtual]

Powers down the modem.

modem_power_down() is equivalent to turning off the modem by button press. Uses onboard_modem_api.h where the implementation of onboard_modem_api is provided by the target.

Definition at line 407 of file UbloxCellularBase.cpp.

void modem_power_up ( ) [protected, virtual]

Powers up the modem.

modem_power_up() is equivalent to pressing the soft power button. The driver may repeat this if the modem is not responsive to AT commands. Uses onboard_modem_api.h where the implementation of onboard_modem_api is provided by the target.

Definition at line 402 of file UbloxCellularBase.cpp.

bool nwk_deregistration ( )

Perform deregistration from the network.

Returns:: true if successful, otherwise false.

Definition at line 875 of file UbloxCellularBase.cpp.

bool nwk_registration ( )

Perform registration with the network.

Returns:: true if successful, otherwise false.

Definition at line 781 of file UbloxCellularBase.cpp.

void power_down ( ) [protected]

Power down the modem.

Definition at line 603 of file UbloxCellularBase.cpp.

bool power_up ( ) [protected]

Powers up the modem.

Returns:: true if successful, otherwise false.

Definition at line 543 of file UbloxCellularBase.cpp.

int read_at_to_char	(	char *	buf,
		int	size,
		char	end
	)		`[protected]`

Read up to size characters from buf or until the character "end" is reached, overwriting the newline with 0 and ensuring a terminator in all cases.

Parameters:

buf	the buffer to write to.
size	the size of the buffer.
end	the character to stop at.

Returns:: the number of characters read, not including the terminator.

Definition at line 515 of file UbloxCellularBase.cpp.

bool reboot_modem ( )

reboot the modem using AT+CFUN=15.

Returns:: true if successful, otherwise false.

Definition at line 1132 of file UbloxCellularBase.cpp.

int rssi ( )

Get the RSSI.

Returns:: the RSSI in dBm. If it is not possible to obtain an RSSI reading at the time (e.g. because the modem is in data mode rather than AT command mode) then 0 is returned.

Definition at line 1008 of file UbloxCellularBase.cpp.

bool set_device_identity ( DeviceType * dev ) [protected]

Set the device identity in _dev_info based on the ATI string returned by the module.

Returns:: true if dev is a known value, otherwise false.

Definition at line 631 of file UbloxCellularBase.cpp.

bool set_mno_profile ( MNOProfile profile = DEFAULT_MNO_PROFILE )

Reads the current MNO profile from modem and sets it to user specified profile.

User can also specify profile in mbed_lib.json file and call set_mno_profile without any arguments.

Note: MNO profile should only be set in detached state and a reboot is required for settings to take effect

Parameters:

profile MNO profile to use

Returns:: true if operation was successful, false if there was an error

Definition at line 1160 of file UbloxCellularBase.cpp.

bool set_modem_rat	(	RAT	selected_rat,
		RAT	preferred_rat = `NOT_USED`,
		RAT	second_preferred_rat = `NOT_USED`
	)

Set Radio Access Technology on modem.

Note: RAT should only be set in detached state and a reboot is required for settings to take effect

Parameters:

selected_rat	Radio Access Technology to use
preferred_rat	Radio Access Technology to use if selected_rat is not available
second_preferred_rat	Radio Access Technology to use if selected_rat and preferred_rat are not available

Returns:: true if successful, otherwise false.

Definition at line 1066 of file UbloxCellularBase.cpp.

void set_pin ( const char * pin )

Set the PIN code for the SIM card.

Parameters:

pin	PIN for the SIM card.

Definition at line 901 of file UbloxCellularBase.cpp.

bool sim_pin_check_enable ( bool enableNotDisable )

Enable or disable SIM pin checking.

Parameters:

enableNotDisable true if SIM PIN checking is to be enabled, otherwise false.

Returns:: true if successful, otherwise false.

Definition at line 906 of file UbloxCellularBase.cpp.

void unlock ( void ) [protected]

Unlock the modem when done accessing it.

Definition at line 468 of file UbloxCellularBase.h.

Field Documentation

ATCmdParser* _at [protected]

Point to the instance of the AT parser in use.

Definition at line 337 of file UbloxCellularBase.h.

int _at_timeout [protected]

The current AT parser timeout value.

Definition at line 341 of file UbloxCellularBase.h.

int _baud [protected]

The baud rate to the modem.

Definition at line 365 of file UbloxCellularBase.h.

bool _debug_trace_on [protected]

Set to true to spit out debug traces.

Definition at line 361 of file UbloxCellularBase.h.

DeviceInfo _dev_info [protected]

General info about the modem as a device.

Definition at line 353 of file UbloxCellularBase.h.

FileHandle* _fh [protected]

File handle used by the AT parser.

Definition at line 345 of file UbloxCellularBase.h.

bool _modem_initialised [protected]

True if the modem is ready register to the network, otherwise false.

Definition at line 370 of file UbloxCellularBase.h.

Mutex _mtx [protected]

The mutex resource.

Definition at line 349 of file UbloxCellularBase.h.

const char* _pin [protected]

The SIM PIN to use.

Definition at line 357 of file UbloxCellularBase.h.

char _plmn[PLMN_SIZE+1] [protected]

PLMN for manual registration.

Definition at line 498 of file UbloxCellularBase.h.

bool _sim_pin_check_enabled [protected]

True it the SIM requires a PIN, otherwise false.

Definition at line 374 of file UbloxCellularBase.h.

Type:	Library
Created:	21 Mar 2019
Imports:	0
Forks:	0
Commits:	23
Dependents:	0
Dependencies:	0
Followers:	1

Important changes to repositories hosted on mbed.com

UbloxCellularBase Class Reference

Data Structures

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Field Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Important changes to repositories hosted on mbed.com

UbloxCellularBase Class Reference

Data Structures

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Field Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning