Mistake on this page?
Report an issue in GitHub or email us
Public Types | Public Member Functions | Protected Member Functions
CellularInformation Class Referenceabstract

Class CellularInformation. More...

#include <CellularInformation.h>

Inheritance diagram for CellularInformation:
AT_CellularInformation

Public Types

Public Member Functions

virtual nsapi_error_t get_manufacturer (char *buf, size_t buf_size)=0
 Request manufacturer identification of cellular device. More...
 
virtual nsapi_error_t get_model (char *buf, size_t buf_size)=0
 Request model identification of cellular device. More...
 
virtual nsapi_error_t get_revision (char *buf, size_t buf_size)=0
 Request revision identification of cellular device. More...
 
virtual nsapi_error_t get_imsi (char *imsi, size_t buf_size)=0
 Get IMSI from the sim card. More...
 
virtual nsapi_error_t get_iccid (char *buf, size_t buf_size)=0
 Get serial number from the SIM card. More...
 

Protected Member Functions

virtual ~CellularInformation ()
 virtual Destructor More...
 

Detailed Description

Class CellularInformation.

An abstract interface that provides information about cellular device.

Definition at line 39 of file CellularInformation.h.

Member Enumeration Documentation

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
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 ( )
protectedvirtual

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
bufSIM ICCID as zero terminated string
buf_sizemax 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
imsipreallocated char* which after successful request contains imsi
buf_sizesize 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
bufmanufacturer identification as zero terminated string
buf_sizemax 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
bufmodel identification as zero terminated string
buf_sizemax 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
bufrevision identification as zero terminated string
buf_sizemax 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.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.