Network Component  Version 7.1
MDK Middleware for IPv4 and IPv6 Networking
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Modem Driver Functions

Modem driver functions. More...

Structures

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

Enumerations

enum  MODEM_STATUS {
  MODEM_OK = 0,
  MODEM_ERROR = 1
}
 
enum  MODEM_EVENT {
  MODEM_EVENT_OK,
  MODEM_EVENT_TIMEOUT,
  MODEM_EVENT_RESPONSE,
  MODEM_EVENT_ERROR
}
 

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

struct DRIVER_MODEM

Access structure of the Modem Driver.

Data Fields

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

Field Documentation

MODEM_STATUS(* Dial)(const char *dial_num)

Pointer to Modem_Dial : Start dialing target number.

MODEM_STATUS(* Hangup)(void)

Pointer to Modem_Hangup : Hangup the line.

MODEM_STATUS(* Initialize)(Modem_Request_t cb_request, const char *init_string)

Pointer to Modem_Initialize : Initialize Modem Device.

bool(* IsOnline)(void)

Pointer to Modem_IsOnline : Check if modem is online.

MODEM_STATUS(* Listen)(void)

Pointer to Modem_Listen : Start Modem Device listening mode.

void(* Notify)(MODEM_EVENT event, const char *response)

Pointer to Modem_Notify : Notify the driver of completion event.

MODEM_STATUS(* Uninitialize)(void)

Pointer to Modem_Uninitialize : De-initialize Modem Device.

Enumeration Type Documentation

Modem Driver Callback Events

Enumerator:
MODEM_EVENT_OK 
MODEM_EVENT_TIMEOUT 
MODEM_EVENT_RESPONSE 
MODEM_EVENT_ERROR 

Modem Driver Status

Enumerator:
MODEM_OK 

Modem Status: Operation succeeded.

MODEM_ERROR 

Modem Status: Unspecified error.

Function Documentation

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_STATUS Modem_Hangup ( void  )

Hangup the line.

Returns
execution status MODEM_STATUS
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
bool Modem_IsOnline ( void  )

Check if modem is online.

Returns
  • true Modem is Online
  • false Modem is Offline
MODEM_STATUS Modem_Listen ( void  )

Start Modem Device listening mode.

Returns
execution status MODEM_STATUS
void 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
Returns
None
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
Returns
None
Note
Any response "#" disables internal processing and delivers modem responses in Modem_Notify.
MODEM_STATUS Modem_Uninitialize ( void  )

De-initialize Modem Device.

Returns
execution status MODEM_STATUS