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.
CellularConnectionFSM Class Reference
CellularConnectionFSM class. More...
#include <CellularConnectionFSM.h>
Public Types | |
| enum | CellularState |
Cellular connection states. More... | |
Public Member Functions | |
| nsapi_error_t | init () |
| Initialize cellular device. | |
| void | set_serial (UARTSerial *serial) |
| Set serial connection for cellular device. | |
| void | set_callback (mbed::Callback< bool(int, int)> status_callback) |
| Set callback for state update. | |
| events::EventQueue * | get_queue () |
| Get event queue that can be chained to main event queue (or use start_dispatch) | |
| nsapi_error_t | start_dispatch () |
| Start event queue dispatching. | |
| void | stop () |
| Stop event queue dispatching and close cellular interfaces. | |
| CellularNetwork * | get_network () |
| Get cellular network interface. | |
| CellularDevice * | get_device () |
| Get cellular device interface. | |
| CellularSIM * | get_sim () |
| Get cellular sim interface. | |
| nsapi_error_t | continue_to_state (CellularState state) |
| Change cellular connection to the target state. | |
| void | set_sim_pin (const char *sim_pin) |
| Set cellular device SIM PIN code. | |
| void | set_retry_timeout_array (uint16_t timeout[], int array_len) |
| Sets the timeout array for network rejects. | |
Detailed Description
CellularConnectionFSM class.
Finite State Machine for connecting to cellular network
Definition at line 47 of file CellularConnectionFSM.h.
Member Enumeration Documentation
| enum CellularState |
Cellular connection states.
Definition at line 56 of file CellularConnectionFSM.h.
Member Function Documentation
| nsapi_error_t continue_to_state | ( | CellularState | state ) |
Change cellular connection to the target state.
- Parameters:
-
state to continue
- Returns:
- see nsapi_error_t, 0 on success
Definition at line 258 of file CellularConnectionFSM.cpp.
| CellularDevice * get_device | ( | ) |
Get cellular device interface.
- Returns:
- device interface, NULL on failure
Definition at line 546 of file CellularConnectionFSM.cpp.
| CellularNetwork * get_network | ( | ) |
Get cellular network interface.
- Returns:
- network interface, NULL on failure
Definition at line 541 of file CellularConnectionFSM.cpp.
| events::EventQueue * get_queue | ( | ) |
Get event queue that can be chained to main event queue (or use start_dispatch)
- Returns:
- event queue
Definition at line 536 of file CellularConnectionFSM.cpp.
| CellularSIM * get_sim | ( | ) |
Get cellular sim interface.
- Returns:
- sim interface, NULL on failure
Definition at line 551 of file CellularConnectionFSM.cpp.
| nsapi_error_t init | ( | ) |
Initialize cellular device.
- Remarks:
- Must be called before any other methods
- Returns:
- see nsapi_error_t, 0 on success
Definition at line 72 of file CellularConnectionFSM.cpp.
| void set_callback | ( | mbed::Callback< bool(int, int)> | status_callback ) |
Set callback for state update.
- Parameters:
-
status_callback function to call on state changes
Definition at line 531 of file CellularConnectionFSM.cpp.
| void set_retry_timeout_array | ( | uint16_t | timeout[], |
| int | array_len | ||
| ) |
Sets the timeout array for network rejects.
After reject next item is tried and after all items are waited and still fails then current network event will fail.
- Parameters:
-
timeout timeout array using seconds array_len length of the array
Definition at line 561 of file CellularConnectionFSM.cpp.
| void set_serial | ( | UARTSerial * | serial ) |
Set serial connection for cellular device.
- Parameters:
-
serial UART driver
Definition at line 526 of file CellularConnectionFSM.cpp.
| void set_sim_pin | ( | const char * | sim_pin ) |
Set cellular device SIM PIN code.
- Parameters:
-
sim_pin PIN code
Definition at line 117 of file CellularConnectionFSM.cpp.
| nsapi_error_t start_dispatch | ( | ) |
Start event queue dispatching.
- Returns:
- see nsapi_error_t, 0 on success
Definition at line 494 of file CellularConnectionFSM.cpp.
| void stop | ( | void | ) |
Stop event queue dispatching and close cellular interfaces.
Definition at line 515 of file CellularConnectionFSM.cpp.
Generated on Tue Jul 12 2022 13:33:21 by
1.7.2