#include <CellularInformation.h>

Inheritance diagram for 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

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

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

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, GEMALTO_CINTERION_CellularInformation, QUECTEL_BC95_CellularInformation, QUECTEL_BG96_CellularInformation, and QUECTEL_M26_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, and QUECTEL_BG96_CellularInformation.

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Important Information for this Arm website