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.
CellularSIM Class Reference
Class CellularSIM. More...
#include <CellularSIM.h>
Inherited by AT_CellularSIM.
Public Member Functions | |
| virtual nsapi_error_t | set_pin (const char *sim_pin)=0 |
| 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)=0 |
| Change sim pin code. | |
| virtual nsapi_error_t | set_pin_query (const char *sim_pin, bool query_pin)=0 |
| Change is pin query needed after boot. | |
| virtual nsapi_error_t | get_sim_state (SimState &state)=0 |
| Get sim card's state. | |
| virtual nsapi_error_t | get_imsi (char *imsi)=0 |
| Get IMSI from the sim card. | |
Protected Member Functions | |
| virtual | ~CellularSIM () |
| virtual Destructor | |
Detailed Description
Class CellularSIM.
An abstract interface for SIM card handling.
Definition at line 32 of file CellularSIM.h.
Constructor & Destructor Documentation
| virtual ~CellularSIM | ( | ) | [protected, virtual] |
virtual Destructor
Definition at line 41 of file CellularSIM.h.
Member Function Documentation
| virtual nsapi_error_t change_pin | ( | const char * | sim_pin, |
| const char * | new_pin | ||
| ) | [pure virtual] |
Change sim pin code.
- Parameters:
-
sim_pin Current PIN for sim new_pin New PIN for sim
- Returns:
- zero on success
Implemented in AT_CellularSIM.
| virtual nsapi_error_t get_imsi | ( | char * | imsi ) | [pure virtual] |
Get IMSI from the sim card.
- Parameters:
-
imsi preallocated char* which after successful request contains imsi
- Returns:
- zero on success
Implemented in AT_CellularSIM.
| virtual nsapi_error_t get_sim_state | ( | SimState & | state ) | [pure virtual] |
Get sim card's state.
- Parameters:
-
state current state of SIM
- Returns:
- zero on success
Implemented in AT_CellularSIM.
| virtual nsapi_error_t set_pin | ( | const char * | sim_pin ) | [pure virtual] |
Open the SIM card by setting the pin code for SIM.
- Parameters:
-
sim_pin PIN for the SIM card
- Returns:
- zero on success
Implemented in AT_CellularSIM.
| virtual nsapi_error_t set_pin_query | ( | const char * | sim_pin, |
| bool | query_pin | ||
| ) | [pure virtual] |
Change is pin query needed after boot.
- Parameters:
-
sim_pin Valid PIN for SIM card query_pin False is PIN query not needed, True if PIN query needed after boot.
- Returns:
- zero on success
Implemented in AT_CellularSIM.
Generated on Tue Jul 12 2022 14:27:12 by
1.7.2