Class AT_CellularNetwork. More...
#include <AT_CellularNetwork.h>
Public Types |
Public Member Functions | |
virtual nsapi_error_t | set_registration (const char *plmn=0) |
Request registering to network. More... | |
virtual nsapi_error_t | get_network_registering_mode (NWRegisteringMode &mode) |
Get the current network registering mode. More... | |
virtual nsapi_error_t | set_attach () |
Request attach to network. More... | |
virtual nsapi_error_t | get_attach (AttachStatus &status) |
Request attach status from network. More... | |
virtual nsapi_error_t | detach () |
Request detach and deregister from a network. More... | |
virtual void | attach (Callback< void(nsapi_event_t, intptr_t)> status_cb) |
Register callback for status reporting. More... | |
virtual nsapi_error_t | scan_plmn (operList_t &operators, int &ops_count) |
Scans for operators module can reach. More... | |
virtual nsapi_error_t | set_ciot_optimization_config (CIoT_Supported_Opt supported_opt, CIoT_Preferred_UE_Opt preferred_opt, Callback< void(CIoT_Supported_Opt)> network_support_cb) |
Set CIoT optimizations. More... | |
virtual nsapi_error_t | get_ciot_ue_optimization_config (CIoT_Supported_Opt &supported_opt, CIoT_Preferred_UE_Opt &preferred_opt) |
Get UE CIoT optimizations. More... | |
virtual nsapi_error_t | get_ciot_network_optimization_config (CIoT_Supported_Opt &supported_network_opt) |
Get Network CIoT optimizations. More... | |
virtual int | get_3gpp_error () |
Get the last 3GPP error code. More... | |
virtual nsapi_error_t | get_operator_params (int &format, operator_t &operator_params) |
Get the operator parameters. More... | |
virtual nsapi_error_t | set_registration_urc (RegistrationType type, bool on) |
Activate/deactivate listening of network events for the given RegistrationType. More... | |
virtual nsapi_error_t | get_operator_names (operator_names_list &op_names) |
Read operator names. More... | |
virtual bool | is_active_context (int *number_of_active_contexts=NULL, int cid=-1) |
Check if there is any PDP context active. More... | |
virtual nsapi_error_t | get_registration_params (registration_params_t ®_params) |
Gets the latest received registration parameters from the network: type, status, access technology, cell_id, lac, active_time, periodic_tau. More... | |
virtual nsapi_error_t | get_registration_params (RegistrationType type, registration_params_t ®_params) |
Gets the current network registration parameters from the network with type: status, access technology, cell_id, lac, active_time, periodic_tau. More... | |
virtual nsapi_error_t | set_packet_domain_event_reporting (bool on) |
Sets the packet domain network reporting. More... | |
virtual nsapi_error_t | set_access_technology (RadioAccessTechnology rat)=0 |
Sets radio access technology. More... | |
ATHandler & | get_at_handler () |
Getter for at handler. More... | |
device_err_t | get_device_error () const |
Gets the device error that happened when using AT commands/responses. More... | |
Static Public Member Functions | |
static void | set_cellular_properties (const intptr_t *property_array) |
Cellular module need to define an array of cellular properties which defines module supported property values. More... | |
static intptr_t | get_property (CellularProperty key) |
Get value for the given key. More... | |
Protected Member Functions | |
virtual nsapi_error_t | set_access_technology_impl (RadioAccessTechnology op_rat) |
Sets access technology to be scanned. More... | |
virtual void | get_context_state_command () |
Sends a command to query the active state of the PDP contexts. More... | |
nsapi_error_t | clear () |
Clear the network and contexts to a known default state. More... | |
Class AT_CellularNetwork.
Class for attaching to a network and getting information from it.
Definition at line 37 of file AT_CellularNetwork.h.
|
inherited |
Set discontinuous reception time on cellular device.
mode | disable or enable the use of eDRX |
act_type | type of access technology |
edrx_value | requested edxr value. Extended DRX parameters information element. |
Definition at line 379 of file CellularNetwork.h.
|
inherited |
Network registering mode.
Definition at line 156 of file CellularNetwork.h.
|
inherited |
Get signal quality parameters.
rssi | signal strength level as defined in 3GPP TS 27.007, range -113..-51 dBm or SignalQualityUnknown |
ber | bit error rate as RXQUAL as defined in 3GPP TS 45.008, range 0..7 or SignalQualityUnknown |
Definition at line 297 of file CellularNetwork.h.
|
virtual |
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.
status_cb | The callback for status changes |
Implements CellularNetwork.
|
protected |
Clear the network and contexts to a known default state.
|
virtual |
Request detach and deregister from a network.
Implements CellularNetwork.
|
virtual |
|
inherited |
|
virtual |
Request attach status from network.
status | see AttachStatus values |
Implements CellularNetwork.
|
virtual |
Get Network CIoT optimizations.
supported_network_opt | Supported CIoT EPS optimizations. CIOT_OPT_MAX will be returned, if the support is not known |
Implements CellularNetwork.
|
virtual |
Get UE CIoT optimizations.
supported_opt | Supported CIoT EPS optimizations. |
preferred_opt | Preferred CIoT EPS optimizations. |
Implements CellularNetwork.
|
protectedvirtual |
Sends a command to query the active state of the PDP contexts.
Can be overridden by the target class.
|
inherited |
Gets the device error that happened when using AT commands/responses.
This is at error returned by the device. Returned CME/CMS errors can be found from 3gpp documents 27007 and 27005.
|
virtual |
Get the current network registering mode.
mode | on successful return contains the current network registering mode |
Implements CellularNetwork.
|
virtual |
Read operator names.
op_names | on successful return contains linked list of operator names. |
Implements CellularNetwork.
|
virtual |
Get the operator parameters.
format | format of the operator field |
operator_params | applicable operator param fields filled |
Implements CellularNetwork.
|
staticinherited |
Get value for the given key.
key | key for value to be fetched |
|
virtual |
Gets the latest received registration parameters from the network: type, status, access technology, cell_id, lac, active_time, periodic_tau.
reg_params | see registration_params_t |
Implements CellularNetwork.
|
virtual |
Gets the current network registration parameters from the network with type: status, access technology, cell_id, lac, active_time, periodic_tau.
type | see RegistrationType values |
reg_params | see registration_params_t |
Implements CellularNetwork.
|
virtual |
Check if there is any PDP context active.
If cid is given, then check is done only for that cid.
number_of_active_contexts | If given then in return contains the number of all active contexts |
cid | If given then check if the context with this cid is active |
Implements CellularNetwork.
|
virtual |
Scans for operators module can reach.
operators | Container of reachable operators and their access technologies |
ops_count | Number of found operators |
Implements CellularNetwork.
|
pure virtualinherited |
Sets radio access technology.
rat | Radio access technology |
|
protectedvirtual |
Sets access technology to be scanned.
Modem specific implementation.
op_rat | Access technology |
|
virtual |
Request attach to network.
Implements CellularNetwork.
|
staticinherited |
Cellular module need to define an array of cellular properties which defines module supported property values.
property_array | array of module properties |
|
virtual |
Set CIoT optimizations.
supported_opt | Supported CIoT EPS optimizations (the HW support can be checked with get_ciot_ue_optimization_config). |
preferred_opt | Preferred CIoT EPS optimizations. |
network_support_cb | This callback will be called when CIoT network optimization support is known |
Implements CellularNetwork.
|
virtual |
Sets the packet domain network reporting.
Useful for getting events when detached from the network. When detach event arrives it is propagated as NSAPI_STATUS_DISCONNECTED to callback set with attach(...).
on | true for enabling event reporting, false for disabling |
Reimplemented from CellularNetwork.
|
virtual |
Request registering to network.
plmn | format is in numeric format or 0 for automatic network registration |
Implements CellularNetwork.
|
virtual |
Activate/deactivate listening of network events for the given RegistrationType.
This should be called after network class is created and ready to receive AT commands. After successful call network class starts to get information about network changes like registration statue, access technology, cell id...
type | RegistrationType to set urc on/off |
on | Controls are urc active or not |
Implements CellularNetwork.