libmcm  1.4.0
A client library for Moxa Connection Management
mcm-modem-info.h File Reference
#include "mcm-base-info.h"

Go to the source code of this file.

Enumerations

enum  McmModemState {
  MCM_MODEM_STATE_NOT_READY = 0 , MCM_MODEM_STATE_INITIALIZING = 1 , MCM_MODEM_STATE_PIN_LOCKED = 2 , MCM_MODEM_STATE_PUK_LOCKED = 3 ,
  MCM_MODEM_STATE_RADIO_OFF = 4 , MCM_MODEM_STATE_RADIO_ON = 5 , MCM_MODEM_STATE_SEARCHING = 6 , MCM_MODEM_STATE_REGISTERED = 7 ,
  MCM_MODEM_STATE_CONNECTING = 8 , MCM_MODEM_STATE_CONNECTED = 9 , MCM_MODEM_STATE_NO_SIM = 99
}
 

Functions

int mcm_modem_get_all_properties (char *interfaceName, int *arr_len, mcm_property_info **info_arr)
 A help function for get all ethernet properties. More...
 
int mcm_modem_get_property (char *interfaceName, char *propertyName, char **propertyValue, int cached)
 A help function for get property. More...
 
int mcm_get_modem_info (char *interfaceName, mcm_modem_info *modem_info)
 A help function for get modem information. More...
 

Detailed Description

This library is for Moxa Connection Management

Author
York LY Chang YorkL.nosp@m.Y.Ch.nosp@m.ang@m.nosp@m.oxa..nosp@m.com

Enumeration Type Documentation

◆ McmModemState

McmModemState:

Enumeration of possible connection states.

Enumerator
MCM_MODEM_STATE_NOT_READY 

The modem can't be detected or not inserted, or something undefined by MCM.

MCM_MODEM_STATE_INITIALIZING 

The modem is currently being initialized.

MCM_MODEM_STATE_PIN_LOCKED 

The modem needs to be unlocked SIM_PIN1.

MCM_MODEM_STATE_PUK_LOCKED 

The modem needs to be unlocked SIM_PUK1.

MCM_MODEM_STATE_RADIO_OFF 

The modem radio power is off but sim power may not off.

MCM_MODEM_STATE_RADIO_ON 

The modem radio power is on but idle and not registered, not searching

MCM_MODEM_STATE_SEARCHING 

The modem radio power is on and under searching

MCM_MODEM_STATE_REGISTERED 

The modem is registered with a network provider but without data connections.

MCM_MODEM_STATE_CONNECTING 

The modem is establishing the PDN session.

MCM_MODEM_STATE_CONNECTED 

One or more packet data bearers is active and connected.

MCM_MODEM_STATE_NO_SIM 

SIM missing or unavailable

Function Documentation

◆ mcm_get_modem_info()

int mcm_get_modem_info ( char *  interfaceName,
mcm_modem_info modem_info 
)

A help function for get modem information.

Parameters
interfaceName(input) Interface name.
modem_info(output) A modem infomation structure.
Returns
If get modem properties success return 0. If fail, return error number.

◆ mcm_modem_get_all_properties()

int mcm_modem_get_all_properties ( char *  interfaceName,
int *  arr_len,
mcm_property_info **  info_arr 
)

A help function for get all ethernet properties.

Parameters
interfaceName(input) Interface name.
arr_len(output) Number of properties array.
info_arr(output) Properties array.
Returns
If get ethernet properties success return 0. If fail, return error number.

◆ mcm_modem_get_property()

int mcm_modem_get_property ( char *  interfaceName,
char *  propertyName,
char **  propertyValue,
int  cached 
)

A help function for get property.

Parameters
interfaceName(input) Interface name.
propertyName(input) Property name.
cached(input) Using caeched property value.
propertyValue(output) Property value.
Returns
If get modem property success return 0. If fail, return error number.