#include <AT_CellularNetwork.h>

Inherits mbed::CellularNetwork, and mbed::AT_CellularBase.

Inherited by GEMALTO_CINTERION_CellularNetwork, QUECTEL_BC95_CellularNetwork, QUECTEL_BG96_CellularNetwork, QUECTEL_UG96_CellularNetwork, SARA4_PPP_CellularNetwork, TELIT_HE910_CellularNetwork, UBLOX_AT_CellularNetwork, UBLOX_PPP_CellularNetwork, my_AT_CN, and my_AT_CNipv6.

Public Types
typedef mbed::Callback< void(nsapi_error_t result, SocketAddress *address)	hostbyname_cb_t )
	Hostname translation callback (asynchronous)
enum	SupportedFeature
	Cellular module need to define an array of unsupported features if any, by default all features are supported. More...
Public Member Functions
virtual nsapi_error_t	set_credentials (const char apn, const char username=0, const char *password=0)
	Set the cellular network APN and credentials.
virtual nsapi_error_t	connect (const char apn, const char username=0, const char *password=0)
	Start the interface.
virtual nsapi_error_t	connect ()
	Start the interface.
virtual nsapi_error_t	disconnect ()
	User initiated disconnect.
virtual nsapi_error_t	init ()
	Does all the needed initializations that can fail.
virtual nsapi_error_t	activate_context ()
	Finds the correct PDP context and activates it.
virtual nsapi_error_t	set_registration (const char *plmn=0)
	Request registering to network.
virtual nsapi_error_t	get_network_registering_mode (NWRegisteringMode &mode)
	Get the current network registering mode.
virtual nsapi_error_t	get_registration_status (RegistrationType type, RegistrationStatus &status)
	Gets the network registration status.
virtual nsapi_error_t	get_attach (AttachStatus &status)
	Request attach status from network.
virtual nsapi_error_t	detach ()
	Request detach from a network.
virtual nsapi_error_t	get_rate_control (CellularNetwork::RateControlExceptionReports &reports, CellularNetwork::RateControlUplinkTimeUnit &time_unit, int &uplink_rate)
	Get APN rate control.
virtual nsapi_error_t	get_apn_backoff_timer (int &backoff_timer)
	Get backoff timer value.
virtual nsapi_connection_status_t	get_connection_status () const
	Get the connection status.
virtual nsapi_error_t	set_blocking (bool blocking)
	Set blocking status of connect() which by default should be blocking.
virtual nsapi_error_t	set_access_technology (RadioAccessTechnology rat)
	Sets radio access technology.
virtual nsapi_error_t	get_access_technology (RadioAccessTechnology &rat)
	Get current radio access technology.
virtual nsapi_error_t	scan_plmn (operList_t &operators, int &ops_count)
	Scans for operators module can reach.
virtual nsapi_error_t	set_ciot_optimization_config (Supported_UE_Opt supported_opt, Preferred_UE_Opt preferred_opt)
	Set CIoT optimizations.
virtual nsapi_error_t	get_ciot_optimization_config (Supported_UE_Opt &supported_opt, Preferred_UE_Opt &preferred_opt)
	Get CIoT optimizations.
virtual nsapi_error_t	set_stack_type (nsapi_ip_stack_t stack_type)
	Set the pdn type to be used.
virtual nsapi_ip_stack_t	get_stack_type ()
	Get the pdn type in use.
virtual nsapi_error_t	get_pdpcontext_params (pdpContextList_t &params_list)
	Get the relevant information for an active non secondary PDP context.
virtual nsapi_error_t	get_extended_signal_quality (int &rxlev, int &ber, int &rscp, int &ecno, int &rsrq, int &rsrp)
	Get extended signal quality parameters.
virtual nsapi_error_t	get_signal_quality (int &rssi, int &ber)
	Get signal quality parameters.
virtual nsapi_error_t	get_cell_id (int &cell_id)
	Get cell id.
virtual int	get_3gpp_error ()
	Get the last 3GPP error code.
virtual nsapi_error_t	get_operator_params (int &format, operator_t &operator_params)
	Get the operator parameters.
virtual nsapi_error_t	set_registration_urc (RegistrationType type, bool on)
	Activate/deactivate listening of network events for the given RegistrationType.
virtual nsapi_error_t	get_operator_names (operator_names_list &op_names)
	Read operator names.
virtual nsapi_error_t	set_credentials (const char apn, AuthenticationType type, const char username=0, const char *password=0)=0
	Set the cellular network APN and credentials.
	MBED_DEPRECATED_SINCE ("mbed-os-5.9","Parameter timeout will be deprecated. Use mbed-os/features/cellular/framework/API/CellularDevice.h set_timeout instead.") virtual nsapi_error_t set_attach(int timeout
	Request attach to network.
virtual void	attach (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)=0
	Register callback for status reporting.
virtual const char *	get_mac_address ()
	Get the local MAC address.
virtual const char *	get_netmask ()
	Get the local network mask.
virtual const char *	get_gateway ()
	Get the local gateway.
virtual nsapi_error_t	set_network (const char ip_address, const char netmask, const char *gateway)
	Set a static IP address.
virtual nsapi_error_t	set_dhcp (bool dhcp)
	Enable or disable DHCP on the network.
virtual nsapi_error_t	gethostbyname (const char host, SocketAddress address, nsapi_version_t version=NSAPI_UNSPEC)
	Translates a hostname to an IP address with specific version.
virtual nsapi_value_or_error_t	gethostbyname_async (const char *host, hostbyname_cb_t callback, nsapi_version_t version=NSAPI_UNSPEC)
	Translates a hostname to an IP address (asynchronous)
virtual nsapi_error_t	gethostbyname_async_cancel (int id)
	Cancels asynchronous hostname translation.
virtual nsapi_error_t	add_dns_server (const SocketAddress &address)
	Add a domain name server to list of servers to query.
virtual EthInterface *	ethInterface ()
	Dynamic downcast to an EthInterface.
virtual WiFiInterface *	wifiInterface ()
	Dynamic downcast to a WiFiInterface.
virtual MeshInterface *	meshInterface ()
	Dynamic downcast to a MeshInterface.
virtual CellularBase *	cellularBase ()
	Dynamic downcast to a CellularBase.
virtual EMACInterface *	emacInterface ()
	Dynamic downcast to an EMACInterface.
ATHandler &	get_at_handler ()
	Getter for at handler.
device_err_t	get_device_error () const
	Gets the device error that happened when using AT commands/responses.
Static Public Member Functions
static NetworkInterface *	get_default_instance ()
	Return the default network interface.
Protected Types
enum	RegistrationMode
	Check if modem supports given registration type. More...
Protected Member Functions
virtual bool	get_modem_stack_type (nsapi_ip_stack_t requested_stack)
	Check if modem supports the given stack type.
virtual nsapi_error_t	set_access_technology_impl (RadioAccessTechnology op_rat)
	Sets access technology to be scanned.
virtual nsapi_error_t	do_user_authentication ()
	APN user authentication.
Static Protected Member Functions
static NetworkInterface *	get_target_default_instance ()
	Get the target's default network instance.
Static Protected Attributes
static const SupportedFeature *	_unsupported_features
	Check if some functionality is supported by a cellular module.
Friends
class	InternetSocket
class	UDPSocket
class	TCPSocket

Detailed Description

Class AT_CellularNetwork.

Class for connecting to a network and getting information from it.

Definition at line 34 of file AT_CellularNetwork.h.

Member Typedef Documentation

typedef mbed::Callback<void (nsapi_error_t result, SocketAddress *address) hostbyname_cb_t) [inherited]

Hostname translation callback (asynchronous)

Callback will be called after DNS resolution completes or a failure occurs.

Callback should not take more than 10ms to execute, otherwise it might prevent underlying thread processing. A portable user of the callback should not make calls to network operations due to stack size limitations. The callback should not perform expensive operations such as socket recv/send calls or blocking operations.

Parameters:

status	0 on success, negative error code on failure
address	On success, destination for the host SocketAddress

Definition at line 180 of file NetworkInterface.h.

Member Enumeration Documentation

enum RegistrationMode [protected]

Check if modem supports given registration type.

Parameters:

reg_type enum RegistrationType

Returns:: mode supported on given reg_type as per 3GPP TS 27.007, 0 when unsupported

Definition at line 134 of file AT_CellularNetwork.h.

enum SupportedFeature [inherited]

Cellular module need to define an array of unsupported features if any, by default all features are supported.

Parameters:

features Array of type SupportedFeature with last element FEATURE_END_MARK

Definition at line 50 of file AT_CellularBase.h.

Member Function Documentation

nsapi_error_t activate_context ( ) [virtual]

Finds the correct PDP context and activates it.

If correct PDP context is not found, one is created. Given APN (or not given) and stack type (IPv4/IPv6/dual) are influencing when finding the PDP context.

Returns:: NSAPI_ERROR_OK on success NSAPI_ERROR_NO_CONNECTION if fails to find suitable context to activate or activation failed (if not already activated) NSAPI_ERROR_UNSUPPORTED if NetworkStack was not found NSAPI_ERROR_AUTH_FAILURE if password and username were provided and authentication to network failed

nsapi_error_t connect	(	const char *	apn,
		const char *	username = `0`,
		const char *	password = `0`
	)		`[virtual]`

apn	Optional name of the network to connect to
username	Optional username for your APN
password	Optional password for your APN

nsapi_error_t get_ciot_optimization_config	(	Supported_UE_Opt &	supported_opt,
		Preferred_UE_Opt &	preferred_opt
	)		`[virtual]`

supported_opt	Supported CIoT EPS optimizations.
preferred_opt	Preferred CIoT EPS optimizations.

nsapi_error_t get_extended_signal_quality	(	int &	rxlev,
		int &	ber,
		int &	rscp,
		int &	ecno,
		int &	rsrq,
		int &	rsrp
	)		`[virtual]`

rxlev	signal strength level
ber	bit error rate
rscp	signal code power
ecno	ratio of the received energy per PN chip to the total received power spectral density
rsrq	signal received quality
rsrp	signal received power

nsapi_error_t get_operator_params	(	int &	format,
		operator_t &	operator_params
	)		`[virtual]`

format	format of the operator field
operator_params	applicable operator param fields filled

nsapi_error_t get_rate_control	(	CellularNetwork::RateControlExceptionReports &	reports,
		CellularNetwork::RateControlUplinkTimeUnit &	time_unit,
		int &	uplink_rate
	)		`[virtual]`

reports	Additional exception reports at maximum rate reached are allowed to be sent [optional]
time_unit	Uplink time unit with values 0=unrestricted, 1=minute, 2=hour, 3=day, 4=week [optional]
uplink_rate	Maximum number of messages per timeUnit [optional]

nsapi_error_t get_registration_status	(	RegistrationType	type,
		RegistrationStatus &	status
	)		`[virtual]`

type	see RegistrationType values
status	see RegistrationStatus values

nsapi_error_t get_signal_quality	(	int &	rssi,
		int &	ber
	)		`[virtual]`

nsapi_error_t gethostbyname	(	const char *	host,
		SocketAddress *	address,
		nsapi_version_t	version = `NSAPI_UNSPEC`
	)		`[virtual, inherited]`

host	Hostname to resolve
address	Destination for the host SocketAddress
version	IP version of address to resolve, NSAPI_UNSPEC indicates version is chosen by the stack (defaults to NSAPI_UNSPEC)

nsapi_value_or_error_t gethostbyname_async	(	const char *	host,
		hostbyname_cb_t	callback,
		nsapi_version_t	version = `NSAPI_UNSPEC`
	)		`[virtual, inherited]`

host	Hostname to resolve
callback	Callback that is called for result
version	IP version of address to resolve, NSAPI_UNSPEC indicates version is chosen by the stack (defaults to NSAPI_UNSPEC)

MBED_DEPRECATED_SINCE	(	"mbed-os-5.9"	,
		"Parameter timeout will be deprecated. Use mbed-os/features/cellular/framework/API/CellularDevice.h set_timeout instead."
	)		`[inherited]`

nsapi_error_t scan_plmn	(	operList_t &	operators,
		int &	ops_count
	)		`[virtual]`

operators	Container of reachable operators and their access technologies
ops_count	Number of found operators

Important changes to repositories hosted on mbed.com

AT_CellularNetwork Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Static Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Member Function Documentation

Field Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning

nsapi_error_t set_ciot_optimization_config	(	Supported_UE_Opt	supported_opt,
		Preferred_UE_Opt	preferred_opt
	)		`[virtual]`

virtual nsapi_error_t set_credentials	(	const char *	apn,
		AuthenticationType	type,
		const char *	username = `0`,
		const char *	password = `0`
	)		`[pure virtual, inherited]`

apn	Name of the network to connect to
type	Authentication type to use
username	Optional username for the APN
password	Optional password fot the APN

nsapi_error_t set_credentials	(	const char *	apn,
		const char *	username = `0`,
		const char *	password = `0`
	)		`[virtual]`

nsapi_error_t set_network	(	const char *	ip_address,
		const char *	netmask,
		const char *	gateway
	)		`[virtual, inherited]`

ip_address	Null-terminated representation of the local IP address
netmask	Null-terminated representation of the local network mask
gateway	Null-terminated representation of the local gateway

nsapi_error_t set_registration_urc	(	RegistrationType	type,
		bool	on
	)		`[virtual]`

type	RegistrationType to set urc on/off
on	Controls are urc active or not