BA / SerialCom

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.

Fork of OmniWheels by Gustav Atmel

Embed: (wiki syntax)

« Back to documentation index

AT_CellularDevice Class Reference
Public Member Functions | Protected Member Functions

AT_CellularDevice Class Reference

Class AT_CellularDevice. More...

#include <AT_CellularDevice.h>

Inherits mbed::CellularDevice.

Inherited by QUECTEL_BC95, QUECTEL_BG96, TELIT_HE910, and UBLOX_LISA_U.

Public Member Functions

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 CellularNetwork by deleting the CellularSMS instance.
virtual void close_power ()
 Closes the opened CellularNetwork by deleting the CellularPower instance.
virtual void close_sim ()
 Closes the opened CellularNetwork by deleting the CellularSIM instance.
virtual void close_information ()
 Closes the opened CellularNetwork 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.

Protected Member Functions

void release_at_handler (ATHandler *at_handler)
 Releases the given at_handler.

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 40 of file AT_CellularDevice.h.

Member Function Documentation

void close_information (  ) [virtual]

Closes the opened CellularNetwork by deleting the CellularInformation instance.

Implements CellularDevice.

Definition at line 208 of file AT_CellularDevice.cpp.

void close_network (  ) [virtual]

Closes the opened CellularNetwork by deleting the CellularNetwork instance.

Implements CellularDevice.

Definition at line 173 of file AT_CellularDevice.cpp.

void close_power (  ) [virtual]

Closes the opened CellularNetwork by deleting the CellularPower instance.

Implements CellularDevice.

Definition at line 190 of file AT_CellularDevice.cpp.

void close_sim (  ) [virtual]

Closes the opened CellularNetwork by deleting the CellularSIM instance.

Implements CellularDevice.

Definition at line 199 of file AT_CellularDevice.cpp.

void close_sms (  ) [virtual]

Closes the opened CellularNetwork by deleting the CellularSMS instance.

Implements CellularDevice.

Definition at line 182 of file AT_CellularDevice.cpp.

NetworkStack * get_stack (  ) [virtual]

Get network stack.

Returns:
network stack

Implements CellularDevice.

Definition at line 239 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 228 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 159 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 103 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 145 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 131 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 117 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 75 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 217 of file AT_CellularDevice.cpp.

Generated on Fri Jul 22 2022 04:54:17 by  doxygen 1.7.2