PPPCellularInterface Class Reference

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.

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.

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.

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.

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.

Stop the interface.

Returns:

0 on success, or error code on failure

Implemented in EasyCellularConnection.

Dynamic downcast to an EMACInterface.

Definition at line 271 of file NetworkInterface.h.

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.

Dynamic downcast to an EthInterface.

Definition at line 247 of file NetworkInterface.h.

Get the connection status.

Returns:

The connection status according to ConnectionStatusType

Definition at line 82 of file NetworkInterface.cpp.

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.

Get the local gateways.

Returns:

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

Implemented in EasyCellularConnection.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Destructor.

Reimplemented in UARTCellularInterface, UARTCellularInterface, and UARTCellularInterface.

Attempt to disconnect from the network.

Brings down the network interface. Shuts down the PPP interface of the underlying network stack. Does not bring down the Radio network

Returns:

0 on success, negative error code on failure

Reimplemented in UARTCellularInterface, UARTCellularInterface, and UARTCellularInterface.

Get the connection status.

Returns:

The connection status according to nsapi_connection_status_t

Adds or removes a SIM facility lock.

Can be used to enable or disable SIM pin check at device startup. This API sets up flags for the driver which would either enable or disable SIM pin checking depending upon the user provided argument while establishing connection. It doesn't do anything immediately other than setting up flags.

Parameters:

set	can be set to true if the SIM pin check is supposed to be enabled and vice versa.

Reimplemented in UARTCellularInterface, UARTCellularInterface, and UARTCellularInterface.

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

Reimplemented in UARTCellularInterface, UARTCellularInterface, and UARTCellularInterface.

Set the pin code for SIM card.

Parameters:

sim_pin

PIN for the SIM card

Change the pin for the SIM card.

Provide the new pin for your SIM card with this API. Old pin code will be assumed to be set using set_SIM_pin() API. This API have no immediate effect. While establishing connection, driver will change the SIM pin for the next boot.

Parameters:

new_pin

new pin to be used in string format

Constructor for a generic modem, using a single FileHandle for commands and PPP data.

The file handle pointer is not accessed within the constructor, only recorded for later use - this permits a derived class to pass a pointer to a not-yet-constructed member object.

Reimplemented in UARTCellularInterface, UARTCellularInterface, and UARTCellularInterface.

Start the interface.

Attempts to connect to a Cellular network. This driver is written mainly for data network connections as CellularBase is NetworkInterface. That's why connect() call internally calls nwk_registration() method with parameter PACKET_SWITCHED network. Circuit switched hook and registration process is implemented and left in the driver for future extension/subclass support,e.g., an SMS or GPS extension.

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

Get the local network mask.

Returns:

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

Get the local IP address.

Returns:

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

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

Attempt to connect to the Cellular network.

Brings up the network interface. Connects to the Cellular Radio network and then brings up the underlying network stack to be used by the cellular modem over PPP interface.

If the SIM requires a PIN, and it is not set/invalid, NSAPI_ERROR_AUTH_ERROR is returned. For APN setup, default behaviour is to use 'internet' as APN string and assuming no authentication is required, i.e., username and password are not set. Optionally, a database lookup can be requested by turning on the APN database lookup feature. In order to do so, add 'MBED_CONF_PPP_CELL_IFACE_APN_LOOKUP' in your mbed_app.json. APN database is by no means exhaustive. It contains a short list of some public APNs with publicly available usernames and passwords (if required) in some particular countries only. Lookup is done using IMSI (International mobile subscriber identifier). Please note that even if 'MBED_CONF_PPP_CELL_IFACE_APN_LOOKUP' config option is set, 'set_credentials()' api still gets the precedence. If the aforementioned API is not used and the config option is set but no match is found in the lookup table then the driver tries to resort to default APN settings.

Preferred method is to setup APN using 'set_credentials()' API.

Returns:

0 on success, negative error code on failure

Reimplemented in UARTCellularInterface, UARTCellularInterface, and UARTCellularInterface.

Get the local gateways.

Returns:

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

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.

Reimplemented in UARTCellularInterface, UARTCellularInterface, and UARTCellularInterface.

Turn modem debug traces on.

Parameters:

on	set true to enable debug traces

Reimplemented in UARTCellularInterface, UARTCellularInterface, and UARTCellularInterface.

Register callback for status reporting.

Parameters:

status_cb

The callback for status changes

Reimplemented in UARTCellularInterface, UARTCellularInterface, and UARTCellularInterface.

Dynamic downcast to a MeshInterface.

Definition at line 259 of file NetworkInterface.h.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Set the pin code for SIM card.

Parameters:

sim_pin

PIN for the SIM card

Implemented in EasyCellularConnection.

Dynamic downcast to a WiFiInterface.

Definition at line 253 of file NetworkInterface.h.