Cellular Driver
The cellular driver is used to interact with cellular modules.
Type Definitions
Name |
Definition |
Description |
ATMO_CELLULAR_DriverInstance_t |
typedef struct ATMO_CELLULAR_DriverInstance_t ATMO_CELLULAR_DriverInstance_t |
|
Enumerations
enum
ATMO_CELLULAR_Status_t
Name |
Value |
ATMO_CELLULAR_Status_Success |
0x00u |
ATMO_CELLULAR_Status_Fail |
0x01u |
ATMO_CELLULAR_Status_Initialized |
0x02u |
ATMO_CELLULAR_Status_Invalid |
0x03u |
ATMO_CELLULAR_Status_NotSupported |
0x04u |
ATMO_CELLULAR_Status_Unspecified |
0x05u |
enum
ATMO_CELLULAR_ConnectionStatus_t
Name |
Value |
ATMO_CELLULAR_ConnectionStatus_Connected |
|
ATMO_CELLULAR_ConnectionStatus_Disconnected |
|
Functions
ATMO_Status_t ATMO_CELLULAR_AddDriverInstance(const ATMO_CELLULAR_DriverInstance_t *driverInstance, ATMO_DriverInstanceData_t *driverInstanceData, ATMO_DriverInstanceHandle_t *instanceNumber)
This routine will add an instance of a driver for cellular into the cellular driver handler.
Parameter |
Direction |
Type |
instanceNumber |
N/A |
ATMO_DriverInstanceHandle_t * |
driverInstanceData |
N/A |
ATMO_DriverInstanceData_t * |
driverInstance |
N/A |
const ATMO_CELLULAR_DriverInstance_t * |
Return Type |
ATMO_Status_t |
ATMO_CELLULAR_Status_t ATMO_CELLULAR_Init(ATMO_DriverInstanceHandle_t instance)
Initialize the cellular driver.
Parameter |
Direction |
Type |
instance |
in |
ATMO_DriverInstanceHandle_t |
Return Type |
ATMO_CELLULAR_Status_t |
ATMO_CELLULAR_Status_t ATMO_CELLULAR_DeInit(ATMO_DriverInstanceHandle_t instance)
This routine de-initializes the datetime driver.
Parameter |
Direction |
Type |
instance |
in |
ATMO_DriverInstanceHandle_t |
Return Type |
ATMO_CELLULAR_Status_t |
ATMO_CELLULAR_Status_t ATMO_CELLULAR_GetConnectionStatus(ATMO_DriverInstanceHandle_t instance, ATMO_CELLULAR_ConnectionStatus_t *status)
Get current cellular Internet connection status.
Parameter |
Direction |
Type |
status |
N/A |
ATMO_CELLULAR_ConnectionStatus_t * |
instance |
N/A |
ATMO_DriverInstanceHandle_t |
Return Type |
ATMO_CELLULAR_Status_t |