Network Component  
MDK Middleware for IPv4 and IPv6 Networking
 
Loading...
Searching...
No Matches
Modem Driver Functions

Modem driver functions. More...

Data Structures

struct  DRIVER_MODEM
 Access structure of the Modem Driver. More...
 

Enumerations

enum  MODEM_STATUS
 
enum  MODEM_EVENT
 

Functions

MODEM_STATUS Modem_Initialize (Modem_Request_t cb_request, const char *init_string)
 Initialize Modem Device.
 
MODEM_STATUS Modem_Uninitialize (void)
 De-initialize Modem Device.
 
MODEM_STATUS Modem_Listen (void)
 Start Modem Device listening mode.
 
MODEM_STATUS Modem_Dial (const char *dial_num)
 Start dialing target number.
 
MODEM_STATUS Modem_Hangup (void)
 Hangup the line.
 
bool Modem_IsOnline (void)
 Check if modem is online.
 
MODEM_STATUS Modem_Notify (MODEM_EVENT event, const char *response)
 Notify the Modem Driver of completion event.
 
void Modem_Request (const char *command, const char *response, uint32_t timeout, uint32_t retries)
 Request Callback function for the driver.
 

Description

Modem driver functions.

The functions are part of the Network Component and are defined in Modem_Null.c and Modem_Standard.c.


Data Structure Documentation

◆ DRIVER_MODEM

struct DRIVER_MODEM

Access structure of the Modem Driver.

Data Fields
MODEM_STATUS(*)(const char *dial_num) Dial Pointer to Modem_Dial : Start dialing target number.
MODEM_STATUS(*)(void) Hangup Pointer to Modem_Hangup : Hangup the line.
MODEM_STATUS(*)(Modem_Request_t cb_request, const char *init_string) Initialize Pointer to Modem_Initialize : Initialize Modem Device.
bool(*)(void) IsOnline Pointer to Modem_IsOnline : Check if modem is online.
MODEM_STATUS(*)(void) Listen Pointer to Modem_Listen : Start Modem Device listening mode.
void(*)(MODEM_EVENT event, const char *response) Notify Pointer to Modem_Notify : Notify the driver of completion event.
MODEM_STATUS(*)(void) Uninitialize Pointer to Modem_Uninitialize : De-initialize Modem Device.

Enumeration Type Documentation

◆ MODEM_EVENT

Modem Driver Callback Events

◆ MODEM_STATUS

Modem Driver Status

Function Documentation

◆ Modem_Dial()

MODEM_STATUS Modem_Dial ( const char * dial_num)

Start dialing target number.

Parameters
[in]dial_numTarget number, a null-terminated string.
Returns
execution status MODEM_STATUS.

◆ Modem_Hangup()

MODEM_STATUS Modem_Hangup ( void )

Hangup the line.

Returns
execution status MODEM_STATUS.

◆ Modem_Initialize()

MODEM_STATUS Modem_Initialize ( Modem_Request_t cb_request,
const char * init_string )

Initialize Modem Device.

Parameters
[in]cb_requestPointer to Modem_Request.
[in]init_stringPointer to modem initialization string.
Returns
execution status MODEM_STATUS.

◆ Modem_IsOnline()

bool Modem_IsOnline ( void )

Check if modem is online.

Returns
  • true Modem is Online.
  • false Modem is Offline.

◆ Modem_Listen()

MODEM_STATUS Modem_Listen ( void )

Start Modem Device listening mode.

Returns
execution status MODEM_STATUS.

◆ Modem_Notify()

MODEM_STATUS Modem_Notify ( MODEM_EVENT event,
const char * response )

Notify the Modem Driver of completion event.

Parameters
[in]eventNotification event MODEM_EVENT.
[in]responseActual modem response, a null-terminated string.

◆ Modem_Request()

void Modem_Request ( const char * command,
const char * response,
uint32_t timeout,
uint32_t retries )

Request Callback function for the driver.

Parameters
[in]commandCommand to send to modem.
[in]responseExpected response from modem, or "#" for any response.
[in]timeoutResponse timeout in milliseconds.
[in]retriesNumber of retries.
Note
Any response "#" disables internal processing and delivers modem responses in Modem_Notify.

◆ Modem_Uninitialize()

MODEM_STATUS Modem_Uninitialize ( void )

De-initialize Modem Device.

Returns
execution status MODEM_STATUS.