Nicolas Borla / Mbed OS BBR_1Ebene
Embed: (wiki syntax)

« Back to documentation index

AT_CellularInformation Class Reference

AT_CellularInformation Class Reference

Class AT_CellularInformation. More...

#include <AT_CellularInformation.h>

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

Public Member Functions

virtual nsapi_size_or_error_t get_manufacturer (char *buf, size_t buf_size)
 Request manufacturer identification of cellular device.
virtual nsapi_size_or_error_t get_model (char *buf, size_t buf_size)
 Request model identification of cellular device.
virtual nsapi_size_or_error_t get_revision (char *buf, size_t buf_size)
 Request revision identification of cellular device.
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.

Protected Member Functions

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

Detailed Description

Class AT_CellularInformation.

Class that provides information about cellular device.

Definition at line 31 of file AT_CellularInformation.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
bufmanufacturer identification
buf_sizemax length of manufacturer identification is 2048 characters
Returns:
on success read character count, on failure negative error code

Definition at line 45 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
buf_sizemax length of manufacturer identification is 2048 characters
Returns:
on success read character count, on failure negative error code

Implements CellularInformation.

Definition at line 30 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
buf_sizemax length of model identification is 2048 characters
Returns:
on success read character count, on failure negative error code

Implements CellularInformation.

Definition at line 35 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
buf_sizemax length of revision identification is 2048 characters
Returns:
on success read character count, on failure negative error code

Implements CellularInformation.

Definition at line 40 of file AT_CellularInformation.cpp.