takashi kadono / Mbed OS Nucleo_446

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   ssd1331

Embed: (wiki syntax)

« Back to documentation index

AT_CellularDevice Class Reference
Public Member Functions | Static Public Member Functions | Protected Member Functions

AT_CellularDevice Class Reference

Class AT_CellularDevice. More...

#include <AT_CellularDevice.h>

Inherits mbed::CellularDevice.

Inherited by GEMALTO_CINTERION, QUECTEL_BC95, QUECTEL_BG96, QUECTEL_UG96, SARA4_PPP, TELIT_HE910, UBLOX_AT, and UBLOX_PPP.

Public Member Functions

virtual events::EventQueue * get_queue () const
 Get event queue that can be chained to main event queue.
virtual CellularNetwork * open_network (FileHandle *fh)
 Create new CellularNetwork interface.
virtual CellularSMS * open_sms (FileHandle *fh)
 Create new CellularSMS interface.
virtual CellularPower * open_power (FileHandle *fh)
 Create new CellularPower interface.
virtual CellularSIM * open_sim (FileHandle *fh)
 Create new CellularSIM interface.
virtual CellularInformation * open_information (FileHandle *fh)
 Create new CellularInformation interface.
virtual void close_network ()
 Closes the opened CellularNetwork by deleting the CellularNetwork instance.
virtual void close_sms ()
 Closes the opened CellularSMS by deleting the CellularSMS instance.
virtual void close_power ()
 Closes the opened CellularPower by deleting the CellularPower instance.
virtual void close_sim ()
 Closes the opened CellularSIM by deleting the CellularSIM instance.
virtual void close_information ()
 Closes the opened CellularInformation by deleting the CellularInformation instance.
virtual void set_timeout (int timeout)
 Set the default response timeout.
virtual void modem_debug_on (bool on)
 Turn modem debug traces on.
virtual NetworkStack * get_stack ()
 Get network stack.
virtual nsapi_error_t init_module (FileHandle *fh)
 Initialize cellular module must be called right after module is ready.

Static Public Member Functions

static CellularDevice * get_default_instance ()
 Return singleton instance of CellularDevice if CELLULAR_DEVICE is defined.

Protected Member Functions

void release_at_handler (ATHandler *at_handler)
 Releases the given at_handler.
virtual AT_CellularNetwork * open_network_impl (ATHandler &at)
 Create new instance of AT_CellularNetwork or if overridden, modem specific implementation.
virtual AT_CellularSMS * open_sms_impl (ATHandler &at)
 Create new instance of AT_CellularSMS or if overridden, modem specific implementation.
virtual AT_CellularPower * open_power_impl (ATHandler &at)
 Create new instance of AT_CellularPower or if overridden, modem specific implementation.
virtual AT_CellularSIM * open_sim_impl (ATHandler &at)
 Create new instance of AT_CellularSIM or if overridden, modem specific implementation.
virtual AT_CellularInformation * open_information_impl (ATHandler &at)
 Create new instance of AT_CellularInformation or if overridden, modem specific implementation.

Detailed Description

Class AT_CellularDevice.

A class defines opening and closing of cellular interfaces. Deleting/Closing of opened interfaces can be done only through this class.

Definition at line 38 of file AT_CellularDevice.h.

Member Function Documentation

void close_information (  ) [virtual]

Closes the opened CellularInformation by deleting the CellularInformation instance.

Implements CellularDevice.

Definition at line 257 of file AT_CellularDevice.cpp.

void close_network (  ) [virtual]

Closes the opened CellularNetwork by deleting the CellularNetwork instance.

Implements CellularDevice.

Definition at line 205 of file AT_CellularDevice.cpp.

void close_power (  ) [virtual]

Closes the opened CellularPower by deleting the CellularPower instance.

Implements CellularDevice.

Definition at line 231 of file AT_CellularDevice.cpp.

void close_sim (  ) [virtual]

Closes the opened CellularSIM by deleting the CellularSIM instance.

Implements CellularDevice.

Definition at line 244 of file AT_CellularDevice.cpp.

void close_sms (  ) [virtual]

Closes the opened CellularSMS by deleting the CellularSMS instance.

Implements CellularDevice.

Definition at line 218 of file AT_CellularDevice.cpp.

MBED_WEAK CellularDevice * get_default_instance (  ) [static, inherited]

Return singleton instance of CellularDevice if CELLULAR_DEVICE is defined.

If CELLULAR_DEVICE is not defined then returns NULL. Implementation is marked as weak.

Returns:
CellularDevice* instance if any

Definition at line 29 of file CellularDevice.cpp.

events::EventQueue * get_queue (  ) const [virtual]

Get event queue that can be chained to main event queue.

EventQueue is created in get_default_instance() or given to CELLULAR_DEVICE (for example TELIT_HE910 class).

Returns:
event queue

Reimplemented from CellularDevice.

Definition at line 53 of file AT_CellularDevice.cpp.

NetworkStack * get_stack (  ) [virtual]

Get network stack.

Returns:
network stack

Implements CellularDevice.

Definition at line 297 of file AT_CellularDevice.cpp.

nsapi_error_t init_module ( FileHandle *  fh ) [virtual]

Initialize cellular module must be called right after module is ready.

For example, when multiple modules are supported in a single AT driver this function detects and adapts to an actual module at runtime.

Parameters:
fhfile handle used in communication to modem.
Returns:
0 on success

Implements CellularDevice.

Definition at line 305 of file AT_CellularDevice.cpp.

void modem_debug_on ( bool  on ) [virtual]

Turn modem debug traces on.

Parameters:
onset true to enable debug traces

Implements CellularDevice.

Definition at line 286 of file AT_CellularDevice.cpp.

CellularInformation * open_information ( FileHandle *  fh ) [virtual]

Create new CellularInformation interface.

Parameters:
fhfile handle used in communication to modem. Can be for example UART handle.
Returns:
New instance of interface CellularInformation.

Implements CellularDevice.

Definition at line 166 of file AT_CellularDevice.cpp.

AT_CellularInformation * open_information_impl ( ATHandler &  at ) [protected, virtual]

Create new instance of AT_CellularInformation or if overridden, modem specific implementation.

Parameters:
atATHandler reference for communication with the modem.
Returns:
new instance of class AT_CellularInformation

Definition at line 200 of file AT_CellularDevice.cpp.

CellularNetwork * open_network ( FileHandle *  fh ) [virtual]

Create new CellularNetwork interface.

Parameters:
fhfile handle used in communication to modem. Can be for example UART handle.
Returns:
New instance of interface CellularNetwork.

Implements CellularDevice.

Definition at line 110 of file AT_CellularDevice.cpp.

AT_CellularNetwork * open_network_impl ( ATHandler &  at ) [protected, virtual]

Create new instance of AT_CellularNetwork or if overridden, modem specific implementation.

Parameters:
atATHandler reference for communication with the modem.
Returns:
new instance of class AT_CellularNetwork

Definition at line 180 of file AT_CellularDevice.cpp.

CellularPower * open_power ( FileHandle *  fh ) [virtual]

Create new CellularPower interface.

Parameters:
fhfile handle used in communication to modem. Can be for example UART handle.
Returns:
New instance of interface CellularPower.

Implements CellularDevice.

Definition at line 152 of file AT_CellularDevice.cpp.

AT_CellularPower * open_power_impl ( ATHandler &  at ) [protected, virtual]

Create new instance of AT_CellularPower or if overridden, modem specific implementation.

Parameters:
atATHandler reference for communication with the modem.
Returns:
new instance of class AT_CellularPower

Definition at line 190 of file AT_CellularDevice.cpp.

CellularSIM * open_sim ( FileHandle *  fh ) [virtual]

Create new CellularSIM interface.

Parameters:
fhfile handle used in communication to modem. Can be for example UART handle.
Returns:
New instance of interface CellularSIM.

Implements CellularDevice.

Definition at line 138 of file AT_CellularDevice.cpp.

AT_CellularSIM * open_sim_impl ( ATHandler &  at ) [protected, virtual]

Create new instance of AT_CellularSIM or if overridden, modem specific implementation.

Parameters:
atATHandler reference for communication with the modem.
Returns:
new instance of class AT_CellularSIM

Definition at line 195 of file AT_CellularDevice.cpp.

CellularSMS * open_sms ( FileHandle *  fh ) [virtual]

Create new CellularSMS interface.

Parameters:
fhfile handle used in communication to modem. Can be for example UART handle.
Returns:
New instance of interface CellularSMS.

Implements CellularDevice.

Definition at line 124 of file AT_CellularDevice.cpp.

AT_CellularSMS * open_sms_impl ( ATHandler &  at ) [protected, virtual]

Create new instance of AT_CellularSMS or if overridden, modem specific implementation.

Parameters:
atATHandler reference for communication with the modem.
Returns:
new instance of class AT_CellularSMS

Definition at line 185 of file AT_CellularDevice.cpp.

void release_at_handler ( ATHandler *  at_handler ) [protected]

Releases the given at_handler.

If last reference to at_hander then it's deleted.

Parameters:
at_handler

Definition at line 83 of file AT_CellularDevice.cpp.

void set_timeout ( int  timeout ) [virtual]

Set the default response timeout.

Parameters:
timeoutmilliseconds to wait response from modem

Implements CellularDevice.

Definition at line 270 of file AT_CellularDevice.cpp.

Generated on Tue Aug 9 2022 00:37:38 by  doxygen 1.7.2