takashi kadono / Mbed OS Nucleo446_SSD1331

Dependencies:   ssd1331

Embed: (wiki syntax)

« Back to documentation index

AT_CellularBase Class Reference

Class AT_CellularBase. More...

#include <AT_CellularBase.h>

Inherited by AT_CellularInformation, AT_CellularNetwork, AT_CellularPower, AT_CellularSIM, AT_CellularSMS, AT_CellularStack, and my_base.

Public Types

enum  SupportedFeature
 

Cellular module need to define an array of unsupported features if any, by default all features are supported.

More...

Public Member Functions

ATHandlerget_at_handler ()
 Getter for at handler.
device_err_t get_device_error () const
 Gets the device error that happened when using AT commands/responses.

Static Protected Attributes

static const SupportedFeature_unsupported_features
 Check if some functionality is supported by a cellular module.

Detailed Description

Class AT_CellularBase.

A base class for AT-classes.

Definition at line 29 of file AT_CellularBase.h.


Member Enumeration Documentation

Cellular module need to define an array of unsupported features if any, by default all features are supported.

Parameters:
featuresArray of type SupportedFeature with last element FEATURE_END_MARK

Definition at line 50 of file AT_CellularBase.h.


Member Function Documentation

ATHandler & get_at_handler (  )

Getter for at handler.

Common method for all AT-classes.

Returns:
reference to ATHandler

Definition at line 27 of file AT_CellularBase.cpp.

device_err_t get_device_error (  ) const

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.

Returns:
at error (CME/CMS) while communicating with the device

Definition at line 32 of file AT_CellularBase.cpp.


Field Documentation

Check if some functionality is supported by a cellular module.

For example, most of standard AT commands are optional and not implemented by all cellular modules.

Parameters:
featurecheck for feature to support
Returns:
true on supported, otherwise false

Definition at line 67 of file AT_CellularBase.h.