#include <OnboardCellularInterface.h>

Public Types
typedef mbed::Callback< void(nsapi_error_t result, SocketAddress *address)	hostbyname_cb_t )
	Hostname translation callback (asynchronous)
Public Member Functions
	MBED_DEPRECATED_SINCE ("mbed-os-5.9","This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularPower.h instead.") OnboardCellularInterface(bool debug
	Constructor.
	MBED_DEPRECATED_SINCE ("mbed-os-5.9","This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularPower.h instead.") virtual ~OnboardCellularInterface()
	Destructor.
	MBED_DEPRECATED_SINCE ("mbed-os-5.9","This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.") UARTCellularInterface(PinName tx
	Constructor.
	MBED_DEPRECATED_SINCE ("mbed-os-5.9","This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.") virtual void set_credentials(const char *apn
	Set the Cellular network credentials.
virtual void	set_credentials (const char apn, const char uname=0, const char *pwd=0)=0
	Set the Cellular network credentials.
virtual void	set_sim_pin (const char *sim_pin)=0
	Set the pin code for SIM card.
virtual nsapi_error_t	connect (const char sim_pin, const char apn=0, const char uname=0, const char pwd=0)=0
	Start the interface.
virtual nsapi_error_t	connect ()=0
	Start the interface.
virtual nsapi_error_t	disconnect ()=0
	Stop the interface.
virtual bool	is_connected ()=0
	Check if the connection is currently established or not.
virtual const char *	get_ip_address ()=0
	Get the local IP address.
virtual const char *	get_netmask ()=0
	Get the local network mask.
virtual const char *	get_gateway ()=0
	Get the local gateways.
virtual const char *	get_mac_address ()
	Get the local MAC address.
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 void	attach (mbed::Callback< void(nsapi_event_t, intptr_t)> status_cb)
	Register callback for status reporting.
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 EthInterface *	ethInterface ()
	Dynamic downcast to an EthInterface.
virtual WiFiInterface *	wifiInterface ()
	Dynamic downcast to a WiFiInterface.
virtual MeshInterface *	meshInterface ()
	Dynamic downcast to a MeshInterface.
virtual EMACInterface *	emacInterface ()
	Dynamic downcast to an EMACInterface.
Static Public Member Functions
static CellularBase *	get_default_instance ()
	Get the default Cellular interface.
Protected Member Functions
	MBED_DEPRECATED_SINCE ("mbed-os-5.9","This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularPower.h instead.") virtual void modem_init()
	Sets the modem up for powering on.
	MBED_DEPRECATED_SINCE ("mbed-os-5.9","This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularPower.h instead.") virtual void modem_deinit()
	Sets the modem in unplugged state.
	MBED_DEPRECATED_SINCE ("mbed-os-5.9","This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularPower.h instead.") virtual void modem_power_up()
	Powers up the modem.
	MBED_DEPRECATED_SINCE ("mbed-os-5.9","This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularPower.h instead.") virtual void modem_power_down()
	Powers down the modem.
virtual void	enable_hup (bool enable)
	Enable or disable hang-up detection.
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.
virtual NetworkStack *	get_stack ()
	Provide access to the underlying stack.
bool	nwk_registration (uint8_t nwk_type=PACKET_SWITCHED)
	Starts network registration process.
Static Protected Member Functions
static CellularBase *	get_target_default_instance ()
	Get the target's default Cellular interface.
Friends
class	InternetSocket
class	UDPSocket
class	TCPSocket

Detailed Description

OnboardCellularInterface class.

This interface serves as the controller/driver for an onboard modem implementing onboard_modem_api.h.

Depending on the type of on-board modem, OnboardCellularInterface could be derived from different implementation classes. Portable applications should only rely on it being a CellularBase.

Definition at line 39 of file OnboardCellularInterface.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 Function Documentation

nsapi_error_t add_dns_server ( const SocketAddress & address ) [virtual, inherited]

Add a domain name server to list of servers to query.

Parameters:

address Destination for the host address

Returns:: 0 on success, negative error code on failure

Definition at line 73 of file NetworkInterface.cpp.

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

Register callback for status reporting.

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

Parameters:

status_cb The callback for status changes

Definition at line 78 of file NetworkInterface.cpp.

virtual nsapi_error_t connect ( ) [pure virtual, inherited]

Start the interface.

Attempts to connect to a Cellular network. If the SIM requires a PIN, and it is not set/invalid, NSAPI_ERROR_AUTH_ERROR is returned.

Returns:: NSAPI_ERROR_OK on success, or negative error code on failure

Implemented in EasyCellularConnection.

virtual nsapi_error_t connect	(	const char *	sim_pin,
		const char *	apn = `0`,
		const char *	uname = `0`,
		const char *	pwd = `0`
	)		`[pure virtual, inherited]`

Start the interface.

Attempts to connect to a Cellular network.

Parameters:

sim_pin	PIN for the SIM card
apn	optionally, access point name
uname	optionally, Username
pwd	optionally, password

Returns:: NSAPI_ERROR_OK on success, or negative error code on failure

Implemented in EasyCellularConnection.

virtual nsapi_error_t disconnect ( ) [pure virtual, inherited]

Stop the interface.

Returns:: 0 on success, or error code on failure

Implemented in EasyCellularConnection.

virtual EMACInterface* emacInterface ( ) [virtual, inherited]

Dynamic downcast to an EMACInterface.

Definition at line 271 of file NetworkInterface.h.

void enable_hup ( bool enable ) [protected, virtual, inherited]

Enable or disable hang-up detection.

When in PPP data pump mode, it is helpful if the FileHandle will signal hang-up via POLLHUP, e.g., if the DCD line is deasserted on a UART. During command mode, this signaling is not desired. enable_hup() controls whether this function should be active.

Meant to be overridden.

Definition at line 278 of file PPPCellularInterface.cpp.

virtual EthInterface* ethInterface ( ) [virtual, inherited]

Dynamic downcast to an EthInterface.

Definition at line 247 of file NetworkInterface.h.

nsapi_connection_status_t get_connection_status ( ) const [virtual, inherited]

Get the connection status.

Returns:: The connection status according to ConnectionStatusType

Definition at line 82 of file NetworkInterface.cpp.

MBED_WEAK CellularBase * get_default_instance ( ) [static, inherited]

Get the default Cellular interface.

This is provided as a weak method so applications can override. Default behaviour is to get the target's default interface, if any.

Returns:: pointer to interface, if any

Definition at line 43 of file NetworkInterfaceDefaults.cpp.

virtual const char* get_gateway ( ) [pure virtual, inherited]

Get the local gateways.

Returns:: Null-terminated representation of the local gateway or null if no network mask has been received

Implemented in EasyCellularConnection.

virtual const char* get_ip_address ( ) [pure virtual, inherited]

Get the local IP address.

Returns:: Null-terminated representation of the local IP address or null if no IP address has been received

Implemented in EasyCellularConnection.

const char * get_mac_address ( ) [virtual, inherited]

Get the local MAC address.

Provided MAC address is intended for info or debug purposes and may not be provided if the underlying network interface does not provide a MAC address

Returns:: Null-terminated representation of the local MAC address or null if no MAC address is available

Definition at line 23 of file NetworkInterface.cpp.

virtual const char* get_netmask ( ) [pure virtual, inherited]

Get the local network mask.

Returns:: Null-terminated representation of the local network mask or null if no network mask has been received

Implemented in EasyCellularConnection.

NetworkStack * get_stack ( void ) [protected, virtual, inherited]

Provide access to the underlying stack.

Get a pointer to the underlying network stack.

Returns:: The underlying network stack

Definition at line 824 of file PPPCellularInterface.cpp.

MBED_WEAK CellularBase * get_target_default_instance ( ) [static, protected, inherited]

Get the target's default Cellular interface.

This is provided as a weak method so targets can override. The default implementation configures and returns the OnBoardModemInterface if available.

Returns:: pointer to interface, if any

Definition at line 67 of file OnboardCellularInterface.cpp.

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

Translates a hostname to an IP address with specific version.

The hostname may be either a domain name or an IP address. If the hostname is an IP address, no network transactions will be performed.

If no stack-specific DNS resolution is provided, the hostname will be resolve using a UDP socket on the stack.

Parameters:

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)

Returns:: 0 on success, negative error code on failure

Definition at line 58 of file NetworkInterface.cpp.

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

Translates a hostname to an IP address (asynchronous)

The hostname may be either a domain name or an IP address. If the hostname is an IP address, no network transactions will be performed.

If no stack-specific DNS resolution is provided, the hostname will be resolve using a UDP socket on the stack.

Call is non-blocking. Result of the DNS operation is returned by the callback. If this function returns failure, callback will not be called. In case result is success (IP address was found from DNS cache), callback will be called before function returns.

Parameters:

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)

Returns:: 0 on immediate success, negative error code on immediate failure or a positive unique id that represents the hostname translation operation and can be passed to cancel

Definition at line 63 of file NetworkInterface.cpp.

nsapi_error_t gethostbyname_async_cancel ( int id ) [virtual, inherited]

Cancels asynchronous hostname translation.

When translation is cancelled, callback will not be called.

Parameters:

id	Unique id of the hostname translation operation

Returns:: 0 on success, negative error code on failure

Definition at line 68 of file NetworkInterface.cpp.

virtual bool is_connected ( ) [pure virtual, inherited]

Check if the connection is currently established or not.

Returns:: true/false If the cellular module have successfully acquired a carrier and is connected to an external packet data network using PPP, isConnected() API returns true and false otherwise.

Implemented in EasyCellularConnection.

MBED_DEPRECATED_SINCE	(	"mbed-os-5.9"	,
		"This API will be	deprecated,
		use mbed-os/features/cellular/framework/API/CellularPower.h instead."
	)

Destructor.

Use mbed-os/features/cellular/framework/API/CellularPower.h instead.

MBED_DEPRECATED_SINCE	(	"mbed-os-5.9"	,
		"This API will be	deprecated,
		use mbed-os/features/cellular/framework/API/CellularPower.h instead."
	)

Constructor.

Use mbed-os/features/cellular/framework/API/CellularPower.h instead.

MBED_DEPRECATED_SINCE	(	"mbed-os-5.9"	,
		"This API will be	deprecated,
		use mbed-os/features/cellular/framework/API/CellularPower.h instead."
	)		`[protected]`

Sets the modem in unplugged state.

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

MBED_DEPRECATED_SINCE	(	"mbed-os-5.9"	,
		"This API will be	deprecated,
		use mbed-os/features/cellular/framework/API/CellularPower.h instead."
	)		`[protected]`

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 target provides the implementation of onboard_modem_api.

MBED_DEPRECATED_SINCE	(	"mbed-os-5.9"	,
		"This API will be	deprecated,
		use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead."
	)		const `[inherited]`

Set the Cellular network credentials.

Please check documentation of connect() for default behaviour of APN settings.

Parameters:

apn	Access point name
uname	optionally, Username
pwd	optionally, password

MBED_DEPRECATED_SINCE	(	"mbed-os-5.9"	,
		"This API will be	deprecated,
		use mbed-os/features/cellular/framework/API/CellularPower.h instead."
	)		`[protected]`

Powers down the modem.

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

MBED_DEPRECATED_SINCE	(	"mbed-os-5.9"	,
		"This API will be	deprecated,
		use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead."
	)		`[inherited]`

Constructor.

Reimplemented from PPPCellularInterface.

MBED_DEPRECATED_SINCE	(	"mbed-os-5.9"	,
		"This API will be	deprecated,
		use mbed-os/features/cellular/framework/API/CellularPower.h instead."
	)		`[protected]`

Sets the modem up for powering on.

modem_init() is equivalent to plugging in the device, for example, attaching power and serial port. Uses onboard_modem_api.h where the target provides the implementation of onboard_modem_api.

virtual MeshInterface* meshInterface ( ) [virtual, inherited]

Dynamic downcast to a MeshInterface.

Definition at line 259 of file NetworkInterface.h.

void modem_deinit ( ) [protected, virtual, inherited]

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. It is meant to be overridden. If the modem is on-board, an implementation of onboard_modem_api.h will override this. If the the modem is a plugged-in device (i.e., a shield type component), the driver deriving from this class will override.

Definition at line 288 of file PPPCellularInterface.cpp.

void modem_init ( ) [protected, virtual, inherited]

Sets the modem up for powering on.

modem_init() is equivalent to plugging in the device, e.g., attaching power and serial port. It is meant to be overridden. If the modem is on-board, an implementation of onboard_modem_api.h will override this. If the the modem is a plugged-in device (i.e., a shield type component), the driver deriving from this class will override.

Definition at line 283 of file PPPCellularInterface.cpp.

void modem_power_down ( ) [protected, virtual, inherited]

Powers down the modem.

modem_power_down() is equivalent to turning off the modem by button press. It is meant to be overridden. If the modem is on-board, an implementation of onboard_modem_api.h will override this. If the the modem is a plugged-in device (i.e., a shield type component), the driver deriving from this class will override.

Definition at line 298 of file PPPCellularInterface.cpp.

void modem_power_up ( ) [protected, virtual, inherited]

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. It is meant to be overridden. If the modem is on-board, an implementation of onboard_modem_api.h will override this. If the the modem is a plugged-in device (i.e., a shield type component), the driver deriving from this class will override.

Definition at line 293 of file PPPCellularInterface.cpp.

bool nwk_registration ( uint8_t nwk_type = PACKET_SWITCHED ) [protected, inherited]

Starts network registration process.

Potential users could be subclasses who are not network interface but would like to use CellularBase infrastructure to register with a cellular network, e.g., an SMS extension to CellularBase.

Parameters:

nwk_type type of network to connect, defaults to packet switched network

Returns:: true if registration is successful

Definition at line 335 of file PPPCellularInterface.cpp.

nsapi_error_t set_blocking ( bool blocking ) [virtual, inherited]

Set blocking status of connect() which by default should be blocking.

Parameters:

blocking true if connect is blocking

Returns:: 0 on success, negative error code on failure

Definition at line 87 of file NetworkInterface.cpp.

virtual void set_credentials	(	const char *	apn,
		const char *	uname = `0`,
		const char *	pwd = `0`
	)		`[pure virtual, inherited]`

Set the Cellular network credentials.

Please check documentation of connect() for default behaviour of APN settings.

Parameters:

apn	Access point name
uname	optionally, Username
pwd	optionally, password

Implemented in EasyCellularConnection.

nsapi_error_t set_dhcp ( bool dhcp ) [virtual, inherited]

Enable or disable DHCP on the network.

Enables DHCP on connecting the network. Defaults to enabled unless a static IP address has been assigned. Requires that the network is disconnected.

Parameters:

dhcp	True to enable DHCP

Returns:: 0 on success, negative error code on failure

Definition at line 48 of file NetworkInterface.cpp.

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

Set a static IP address.

Configures this network interface to use a static IP address. Implicitly disables DHCP, which can be enabled in set_dhcp. Requires that the network is disconnected.

Parameters:

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

Returns:: 0 on success, negative error code on failure

Definition at line 43 of file NetworkInterface.cpp.

virtual void set_sim_pin ( const char * sim_pin ) [pure virtual, inherited]

Set the pin code for SIM card.

Parameters:

sim_pin PIN for the SIM card

Implemented in EasyCellularConnection.

virtual WiFiInterface* wifiInterface ( ) [virtual, inherited]

Dynamic downcast to a WiFiInterface.

Definition at line 253 of file NetworkInterface.h.

Type:	Program
Mbed OS support:	Mbed OS
Created:	11 Oct 2018
Imports:	23
Forks:	0
Commits:	4
Dependents:	0
Dependencies:	1
Followers:	1

Important changes to repositories hosted on mbed.com

OnboardCellularInterface Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Important changes to repositories hosted on mbed.com

OnboardCellularInterface Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning