BA / SerialCom

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.

Fork of OmniWheels by Gustav Atmel

Embed: (wiki syntax)

« Back to documentation index

AT_CellularSIM Class Reference
Public Member Functions

AT_CellularSIM Class Reference

Class AT_CellularSIM. More...

#include <AT_CellularSIM.h>

Inherits mbed::CellularSIM, and mbed::AT_CellularBase.

Inherited by QUECTEL_BC95_CellularSIM.

Public Member Functions

virtual nsapi_error_t set_pin (const char *sim_pin)
 Open the SIM card by setting the pin code for SIM.
virtual nsapi_error_t change_pin (const char *sim_pin, const char *new_pin)
 Change sim pin code.
virtual nsapi_error_t set_pin_query (const char *sim_pin, bool query_pin)
 Change is pin query needed after boot.
virtual nsapi_error_t get_sim_state (SimState &state)
 Get sim card's state.
virtual nsapi_error_t get_imsi (char *imsi)
 Get IMSI from the sim card.
ATHandler & get_at_handler ()
 Getter for at handler.
device_err_t get_device_error () const
 Gets the device error that happened when using AT commands/responses.

Detailed Description

Class AT_CellularSIM.

Class for SIM card handling.

Definition at line 31 of file AT_CellularSIM.h.

Member Function Documentation

nsapi_error_t change_pin ( const char *  sim_pin,
const char *  new_pin 
) [virtual]

Change sim pin code.

Parameters:
sim_pinCurrent PIN for sim
new_pinNew PIN for sim
Returns:
zero on success

Implements CellularSIM.

Definition at line 80 of file AT_CellularSIM.cpp.

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_imsi ( char *  imsi ) [virtual]

Get IMSI from the sim card.

Parameters:
imsipreallocated char* which after successful request contains imsi
Returns:
zero on success

Implements CellularSIM.

Definition at line 118 of file AT_CellularSIM.cpp.

nsapi_error_t get_sim_state ( SimState &  state ) [virtual]

Get sim card's state.

Parameters:
statecurrent state of SIM
Returns:
zero on success

Implements CellularSIM.

Definition at line 33 of file AT_CellularSIM.cpp.

nsapi_error_t set_pin ( const char *  sim_pin ) [virtual]

Open the SIM card by setting the pin code for SIM.

Parameters:
sim_pinPIN for the SIM card
Returns:
zero on success

Implements CellularSIM.

Definition at line 62 of file AT_CellularSIM.cpp.

nsapi_error_t set_pin_query ( const char *  sim_pin,
bool  query_pin 
) [virtual]

Change is pin query needed after boot.

Parameters:
sim_pinValid PIN for SIM card
query_pinFalse is PIN query not needed, True if PIN query needed after boot.
Returns:
zero on success

Implements CellularSIM.

Definition at line 93 of file AT_CellularSIM.cpp.

Generated on Fri Jul 22 2022 04:54:17 by  doxygen 1.7.2