Data Structures | |
class | CellularContext |
CellularContext is CellularInterface/NetworkInterface with extensions for cellular connectivity. More... | |
class | CellularDevice |
Class CellularDevice. More... | |
class | CellularInformation |
Class CellularInformation. More... | |
class | CellularNetwork |
An abstract interface for connecting to a network and getting information from it. More... | |
class | CellularInterface |
Common interface that is shared between cellular interfaces. More... | |
class | ControlPlane_netif |
Implements support for data transfer using Control Plane CIoT EPS optimization specified in 3GPP 23.401(4.10), 3GPP 23.682(4.5.14). More... | |
Functions | |
static CellularInterface * | get_default_instance () |
Get the default cellular interface. More... | |
virtual void | set_credentials (const char *apn, const char *uname=0, const char *pwd=0)=0 |
Set the cellular network credentials. More... | |
virtual void | set_plmn (const char *plmn)=0 |
Set the plmn. More... | |
virtual void | set_sim_pin (const char *sim_pin)=0 |
Set the PIN code for SIM card. More... | |
virtual nsapi_error_t | connect (const char *sim_pin, const char *apn=0, const char *uname=0, const char *pwd=0)=0 |
Attempt to connect to a cellular network with a PIN and credentials. More... | |
nsapi_error_t | connect () override=0 |
Attempt to connect to a cellular network. More... | |
nsapi_error_t | disconnect () override=0 |
Stop the interface. More... | |
virtual bool | is_connected ()=0 |
Check if the connection is currently established. More... | |
nsapi_error_t | get_ip_address (SocketAddress *address) override=0 |
Get the local IP address. More... | |
CellularInterface * | cellularInterface () final |
Return pointer to a CellularInterface. More... | |
void | set_default_parameters () override |
defined(DOXYGEN_ONLY) More... | |
|
finalvirtual |
Return pointer to a CellularInterface.
Reimplemented from NetworkInterface.
Definition at line 103 of file CellularInterface.h.
|
pure virtual |
Attempt to connect to a cellular network with a PIN and credentials.
sim_pin | PIN for the SIM card. |
apn | Access point name (optional). |
uname | Username (optional). |
pwd | Password (optional). |
Implemented in CellularContext, and AT_CellularContext.
|
overridepure virtual |
Attempt to connect to a cellular network.
If the SIM requires a PIN, and it is invalid or not set, NSAPI_ERROR_AUTH_ERROR is returned.
Implements NetworkInterface.
Implemented in CellularContext, and AT_CellularContext.
|
overridepure virtual |
Stop the interface.
Implements NetworkInterface.
Implemented in CellularContext, and AT_CellularContext.
|
static |
Get the default cellular interface.
This is provided as a weak method so applications can override. Default behavior is to get the target's default interface, if any.
|
overridepure virtual |
Get the local IP address.
address | SocketAddress representation of the local IP address |
NSAPI_ERROR_OK | on success |
NSAPI_ERROR_UNSUPPORTED | if this feature is not supported |
NSAPI_ERROR_PARAMETER | if the provided pointer is invalid |
NSAPI_ERROR_NO_ADDRESS | if the address cannot be obtained from stack |
Reimplemented from NetworkInterface.
Implemented in CellularContext, and AT_CellularContext.
|
pure virtual |
Check if the connection is currently established.
true
if the cellular module have successfully acquired a carrier and is connected to an external packet data network using PPP, false
otherwise. Implemented in CellularContext, and AT_CellularContext.
|
pure virtual |
Set the cellular network credentials.
Please check documentation of connect() for default behavior of APN settings.
apn | Access point name. |
uname | Username (optional). |
pwd | Password (optional). |
Implemented in CellularContext, and AT_CellularContext.
|
overridevirtual |
defined(DOXYGEN_ONLY)
Set default parameters on a cellular interface.
A cellular interface instantiated directly or using CellularInterface::get_default_instance() is initially unconfigured. This call can be used to set the default parameters that would have been set if the interface had been requested using NetworkInterface::get_default_instance() (see nsapi JSON configuration).
Reimplemented from NetworkInterface.
|
pure virtual |
Set the plmn.
PLMN controls to what network device registers.
plmn | user to force what network to register. |
Implemented in CellularContext, and AT_CellularContext.
|
pure virtual |
Set the PIN code for SIM card.
sim_pin | PIN for the SIM card. |
Implemented in CellularContext, and AT_CellularContext.