Knight KE / Mbed OS Game_Master

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.

Embed: (wiki syntax)

« Back to documentation index

AT_CellularInformation Class Reference
Public Types | Public Member Functions | Protected Member Functions | Static Protected Attributes

AT_CellularInformation Class Reference

Class AT_CellularInformation. More...

#include <AT_CellularInformation.h>

Inherits mbed::CellularInformation, and mbed::AT_CellularBase.

Public Types

enum  SerialNumberType
 

Request serial number identification of cellular device.

More...
enum  SupportedFeature
 

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

More...

Public Member Functions

virtual nsapi_error_t get_manufacturer (char *buf, size_t buf_size)
 Request manufacturer identification of cellular device.
virtual nsapi_error_t get_model (char *buf, size_t buf_size)
 Request model identification of cellular device.
virtual nsapi_error_t get_revision (char *buf, size_t buf_size)
 Request revision identification of cellular device.
ATHandler & get_at_handler ()
 Getter for at handler.
device_err_t get_device_error () const
 Gets the device error that happened when using AT commands/responses.

Protected Member Functions

nsapi_error_t get_info (const char *cmd, char *buf, size_t buf_size)
 Request information text from cellular device.

Static Protected Attributes

static const SupportedFeature * _unsupported_features
 Check if some functionality is supported by a cellular module.

Detailed Description

Class AT_CellularInformation.

Class that provides information about cellular device.

Definition at line 31 of file AT_CellularInformation.h.

Member Enumeration Documentation

enum SerialNumberType [inherited]

Request serial number identification of cellular device.

Parameters:
bufserial number as zero terminated string
buf_sizemax length of serial number is 2048 characters
typeserial number type to read
Returns:
zero on success, on failure negative error code

Definition at line 72 of file CellularInformation.h.

enum SupportedFeature [inherited]

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 51 of file AT_CellularBase.h.

Member Function Documentation

ATHandler & get_at_handler (  ) [inherited]

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 [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.

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

Definition at line 32 of file AT_CellularBase.cpp.

nsapi_error_t get_info ( const char *  cmd,
char *  buf,
size_t  buf_size 
) [protected]

Request information text from cellular device.

Parameters:
cmd3gpp command string
bufbuffer for response
buf_sizebuffer size
Returns:
on success read character count, on failure negative error code

Definition at line 67 of file AT_CellularInformation.cpp.

nsapi_error_t get_manufacturer ( char *  buf,
size_t  buf_size 
) [virtual]

Request manufacturer identification of cellular device.

Parameters:
bufmanufacturer identification as zero terminated string
buf_sizemax length of manufacturer identification is 2048 characters
Returns:
zero on success, on failure negative error code

Implements CellularInformation.

Definition at line 32 of file AT_CellularInformation.cpp.

nsapi_error_t get_model ( char *  buf,
size_t  buf_size 
) [virtual]

Request model identification of cellular device.

Parameters:
bufmodel identification as zero terminated string
buf_sizemax length of model identification is 2048 characters
Returns:
zero on success, on failure negative error code

Implements CellularInformation.

Definition at line 37 of file AT_CellularInformation.cpp.

nsapi_error_t get_revision ( char *  buf,
size_t  buf_size 
) [virtual]

Request revision identification of cellular device.

Parameters:
bufrevision identification as zero terminated string
buf_sizemax length of revision identification is 2048 characters
Returns:
zero on success, on failure negative error code

Implements CellularInformation.

Definition at line 42 of file AT_CellularInformation.cpp.

Field Documentation

AT_CellularBase::SupportedFeature const * _unsupported_features [static, protected, inherited]

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 66 of file AT_CellularBase.h.

Generated on Tue Jul 12 2022 12:47:31 by  doxygen 1.7.2