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.
CellularInformation Class Reference
Class CellularInformation. More...
#include <CellularInformation.h>
Inherited by AT_CellularInformation.
Public Types | |
enum | SerialNumberType |
Request serial number identification of cellular device. More... | |
Public Member Functions | |
virtual nsapi_error_t | get_manufacturer (char *buf, size_t buf_size)=0 |
Request manufacturer identification of cellular device. | |
virtual nsapi_error_t | get_model (char *buf, size_t buf_size)=0 |
Request model identification of cellular device. | |
virtual nsapi_error_t | get_revision (char *buf, size_t buf_size)=0 |
Request revision identification of cellular device. | |
Protected Member Functions | |
virtual | ~CellularInformation () |
virtual Destructor |
Detailed Description
Class CellularInformation.
An abstract interface that provides information about cellular device.
Definition at line 31 of file CellularInformation.h.
Member Enumeration Documentation
enum SerialNumberType |
Request serial number identification of cellular device.
- Parameters:
-
buf serial number as zero terminated string buf_size max length of serial number is 2048 characters type serial number type to read
- Returns:
- NSAPI_ERROR_OK on success NSAPI_ERROR_UNSUPPORTED if the modem does not support SerialNumberType NSAPI_ERROR_DEVICE_ERROR on other failures
Definition at line 77 of file CellularInformation.h.
Constructor & Destructor Documentation
virtual ~CellularInformation | ( | ) | [protected, virtual] |
virtual Destructor
Definition at line 38 of file CellularInformation.h.
Member Function Documentation
virtual nsapi_error_t get_manufacturer | ( | char * | buf, |
size_t | buf_size | ||
) | [pure virtual] |
Request manufacturer identification of cellular device.
- Parameters:
-
buf manufacturer identification as zero terminated string buf_size max length of manufacturer identification is 2048 characters
- Returns:
- NSAPI_ERROR_OK on success NSAPI_ERROR_DEVICE_ERROR on failure
Implemented in AT_CellularInformation.
virtual nsapi_error_t get_model | ( | char * | buf, |
size_t | buf_size | ||
) | [pure virtual] |
Request model identification of cellular device.
- Parameters:
-
buf model identification as zero terminated string buf_size max length of model identification is 2048 characters
- Returns:
- NSAPI_ERROR_OK on success NSAPI_ERROR_DEVICE_ERROR on failure
Implemented in AT_CellularInformation.
virtual nsapi_error_t get_revision | ( | char * | buf, |
size_t | buf_size | ||
) | [pure virtual] |
Request revision identification of cellular device.
- Parameters:
-
buf revision identification as zero terminated string buf_size max length of revision identification is 2048 characters
- Returns:
- NSAPI_ERROR_OK on success NSAPI_ERROR_DEVICE_ERROR on failure
Implemented in AT_CellularInformation.
Generated on Tue Aug 9 2022 00:37:38 by
