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.
Dependents: TYBLE16_simple_data_logger TYBLE16_MP3_Air
CellularInformation Class Reference
[Cellular]
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. | |
| virtual nsapi_error_t | get_imsi (char *imsi, size_t buf_size)=0 |
| Get IMSI from the sim card. | |
| virtual nsapi_error_t | get_iccid (char *buf, size_t buf_size)=0 |
| Get serial number from the SIM card. | |
Protected Member Functions | |
| virtual | ~CellularInformation () |
| virtual Destructor | |
Detailed Description
Class CellularInformation.
An abstract interface that provides information about cellular device.
Definition at line 39 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_PARAMETER if buf is null or buf_size is zero NSAPI_ERROR_UNSUPPORTED if the modem does not support SerialNumberType NSAPI_ERROR_DEVICE_ERROR on other failures
Definition at line 89 of file CellularInformation.h.
Constructor & Destructor Documentation
| virtual ~CellularInformation | ( | ) | [protected, virtual] |
virtual Destructor
Definition at line 46 of file CellularInformation.h.
Member Function Documentation
| virtual nsapi_error_t get_iccid | ( | char * | buf, |
| size_t | buf_size | ||
| ) | [pure virtual] |
Get serial number from the SIM card.
- Parameters:
-
buf SIM ICCID as zero terminated string buf_size max length of SIM ICCID is MAX_ICCID_LENGTH
- Returns:
- NSAPI_ERROR_OK on success NSAPI_ERROR_PARAMETER if buf is null or buf_size is zero NSAPI_ERROR_DEVICE_ERROR on failure
Implemented in AT_CellularInformation.
| virtual nsapi_error_t get_imsi | ( | char * | imsi, |
| size_t | buf_size | ||
| ) | [pure virtual] |
Get IMSI from the sim card.
- Remarks:
- Given imsi buffer length must be 16 or more as imsi max length is 15!
- Parameters:
-
imsi preallocated char* which after successful request contains imsi buf_size size of imsi buffer
- Returns:
- NSAPI_ERROR_OK on success NSAPI_ERROR_PARAMETER if imsi is null or buf_size is zero or buf_size is smaller than MAX_IMSI_LENGTH + 1 NSAPI_ERROR_DEVICE_ERROR on other failures
Implemented in AT_CellularInformation.
| 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_PARAMETER if buf is null or buf_size is zero 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_PARAMETER if buf is null or buf_size is zero 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_PARAMETER if buf is null or buf_size is zero NSAPI_ERROR_DEVICE_ERROR on failure
Implemented in AT_CellularInformation.
Generated on Tue Jul 12 2022 13:55:42 by
1.7.2