dpyModem Namespace Reference

Deepsy Modem namespace that includes the different enums, structs or method signatures that should be used.

Classes

struct  AccessPointNetwork
 
struct  CallConfig
 Struct to keep call Configuration as configured by the Voice call. More...
 
struct  CallInfo
 Struct to keep info from a call. More...
 
struct  DATE_INFO
 Defines the struct type used to store the DATE_INFO. More...
 
class  ListObserver
 List Observer class. More...
 
struct  ModemInfo
 Defines the structure containing Modem information. More...
 
struct  ModemStatus
 Defines the status information structure that is obtained after a MODEM STATUS report. More...
 
struct  s_SMSInfo
 Defines the structure containing SMS information. More...
 
struct  SimInfo
 Defines the structure containing Sim information. More...
 
struct  UTC_INFO
 Defines the struct type used to store the UTC_INFO. More...
 

Typedefs

typedef boost::function< void(boost::system::error_code, std::list< std::string > modems)> modem_list_handler_function
 Prototype of the handler function for getting available modems. More...
 
typedef boost::function< void(boost::system::error_code, std::list< std::string > sims)> sim_list_handler_function
 Prototype of the handler function for getting available sims. More...
 
typedef boost::function< void(boost::system::error_code error_code, std::string modemid, struct ModemStatus &status)> modem_status_handler_function
 Prototype of the handler function for modem status getter and events. More...
 
typedef boost::function< void(boost::system::error_code, std::string modemid, ListEvent event)> modem_list_event_handler_function
 Prototype of the handler function for subscribing to list events. More...
 
typedef boost::function< void(boost::system::error_code, std::string modemid, dpyModem::ModemWarning warning)> modem_warning_event_handler_function
 Prototype of the handler function for subscribing to modem warnings. More...
 
typedef boost::function< void(boost::system::error_code error_code, std::string modemid, const bool &enabled)> modem_data_connection_status_handler_function
 Prototype of the handler function to receive modem data connection status. More...
 
typedef boost::function< void(boost::system::error_code, ModemInfo modeminfo)> modem_info_handler_function
 Prototype of the handler function used to get a specific modem information. More...
 
typedef boost::function< void(boost::system::error_code, SimInfo siminfo)> sim_info_handler_function
 Prototype of the handler function used to get a specific sim information. More...
 
typedef boost::function< void(boost::system::error_code, std::string modemid, std::string simid, ListEvent event)> sim_list_event_handler_function
 Prototype of the handler function for subscribing to list events. More...
 
typedef boost::function< void(boost::system::error_code, std::string simid, dpyModem::SimStatus status)> simStatus_handler_function
 Prototype of the handler function for sim status getter and events. More...
 
typedef boost::function< void(const bool &available)> service_availability_handler_function
 Prototype of the handler function used to monitor service availability. More...
 
typedef boost::function< void(boost::system::error_code &ec, ModemWarning warning_notif)> warning_handler_function
 Prototype of the handler function for getModemNotifications_S method.
 
typedef boost::function< void(boost::system::error_code error_code, MODEM_INFO type, const std::string &value)> get_info_handler_function
 Prototype of the handler function for getModemInfo method.
 
typedef boost::function< void(boost::system::error_code error_code, const AccessPointNetwork &apn_info, const bool &forced_apn)> get_apn_handler_function
 Prototype of the handler function for obtaining apn information (getCurrentApn or getApnByImsi methods)
 
typedef boost::function< void(boost::system::error_code error_code, const AccessPointNetwork &apn_info)> get_apn_by_imsi_handler_function
 Prototype of the handler function for obtaining apn information (getCurrentApn or getApnByImsi methods)
 
typedef boost::function< void(boost::system::error_code error_code)> result_handler_function
 Prototype of the handler function for obtaining result of the different operations.
 
typedef boost::function< void(boost::system::error_code error_code, const bool &enabled)> data_connection_status_handler_function
 Prototype of the handler function for isDataConnectionEnabled method.
 
typedef boost::function< void(boost::system::error_code error_code, const std::string &modemId, const std::string &interfaceName, std::map< dpyNetworking::Statistics, uint32_t >statisticsValues, const std::string &interfaceIpAddress)> interface_statistics_function_handler
 Prototype of the handler function for asyncGetInterfaceStatistics method.
 
typedef boost::function< void(boost::system::error_code error_code, std::string modemid, int simSlot)> sim_slot_handler_function
 Prototype of the handler function for get the current sim slot. More...
 
typedef boost::function< void(boost::system::error_code error_code, dpyModem::AccessPointNetwork found_apn)> forced_apn_handler_function
 Prototype of the handler function for get the global forced APN. More...
 

Enumerations

enum  MODEM_INFO {
  MANUFACTURER, MODEL, FW_VERSION, IMEI,
  SIM_IMSI, SIM_ICCID, SIM_OPERATOR, SIM_APN
}
 Defines the possible information that can be queried. More...
 
enum  ModemOperation {
  DISABLE, ENABLE, SLEEP, SW_RESTART,
  HW_RESTART, DISABLE_DATA_CONNECTION, ENABLE_DATA_CONNECTION
}
 Defines the possible operations that can be queried to a modem. More...
 
enum  ListEvent { ADDED = 0, REMOVED = 1 }
 
enum  ModemType {
  MODEMMANAGERGENERIC_USB = 0, MODEMMANAGER_EM7455 = 1, BGS2W_PREINSTALLED = 2, MODEMMANAGER_RC7620 = 3,
  MODEMMANAGER_EC25 = 4, MODEMMANAGER_WP7607 = 5, MODEMMANAGER_RC7611 = 6
}
 Modem types.
 
enum  ModemWarning {
  NOTIFY_UNDERVOLTAGE, NOTIFY_OVERVOLTAGE, NOTIFY_CLOSE_TO_UNDERTEMPERATURE, NOTIFY_CLOSE_TO_OVERTEMPERATURE,
  NOTIFY_UNDERTEMPERATURE, NOTIFY_OVERTEMPERATURE, NOTIFY_BACK_TO_NORMAL_TEMPERATURE, NOTIFY_JAMMING,
  NOTIFY_SHUTDOWN, NOTIFY_RESTARTED
}
 Defines the possible warnings that the modem can report during its operation. More...
 
enum  SimStatus {
  SIM_NOT_INSERTED, SIM_INVALID_OR_UNSUPPORTED, SIM_LOCKED, SIM_LOCKED_PIN,
  SIM_LOCKED_PIN2, SIM_LOCKED_PUK, SIM_READY
}
 Defines the possible states in which SIM card may be. More...
 
enum  CallStatus {
  CALLS_DISABLED = 0, WAITING = 1, RINGING = 2, DIALING = 3,
  CONVERSATION = 4, HELD = 5, FINISHED = 6, ALERTING = 7,
  DROPPED = 8
}
 Defines the possible call status. More...
 
Modem status information

This enumerations and structures give easy access to the main parameters that describe the status of the modem at a given moment

enum  ModemState {
  DISABLED, RESTARTING, SLEEPING, ENABLING_MODEM,
  ENABLED_SIM_READY, SERVICE_AVAILABLE_GOOD_SIGNAL, CELLULAR_NETWORK_REG_HOME, CELLULAR_NETWORK_REG_ROAMING,
  DATA_CONNECTION_NOT_AVAILABLE, DATA_CONNECTION_ENABLED, DATA_CONNECTION_CONNECTING, DATA_CONNECTION_ACTIVE
}
 
enum  ModemPowerStatus { MODEM_DISABLED, MODEM_RESTART, MODEM_SLEEP, MODEM_ON }
 Defines the possible MODEM POWER states that the modem can be in. More...
 
enum  SignalQuality {
  ANTENNA_NOT_DETECTED, POOR_SIGNAL_STRENGTH, FAIR_SIGNAL_STRENGTH, GOOD_SIGNAL_STRENGTH,
  EXCELLENT_SIGNAL_STRENGTH
}
 Defines the possible SIGNAL QUALITY results that that can be obtained. More...
 
enum  NetworkStatus {
  NOT_REGISTERED, SEARCHING_OPERATOR, REGISTERED_HOME_NET, REGISTERED_ROAMING,
  REGISTRATION_DENIED
}
 Defines the possible Cellular network registration status that can be reported. Note that this field informs only about network registration, not modem status. More...
 
enum  GPRS_NETWORK_STATUS {
  GPRS_NOT_REGISTERED, GPRS_SEARCHING_OPERATOR, GPRS_REGISTERED_HOME_NET, GPRS_REGISTERED_ROAMING,
  GPRS_REGISTRATION_DENIED
}
 Defines the possible GPRS network registration status that can be reported. Note that this field informs only about network registration, not modem status. More...
 
enum  NetworkMode {
  MODE_NONE = 0, MODE_CS = 1, MODE_2G = 2, MODE_3G = 4,
  MODE_4G = 8, MODE_ANY = 16
}
 Defines the possible network modes. More...
 
enum  AccessTechnology {
  NONE, POTS, GSM, GPRS,
  EDGE, UMTS, HSPA, HSDPA,
  HSUPA, CDMA, LTE
}
 Defines the possible network access technologies a modem can make use of in order to communicate with the network. More...
 
Sim related types

This enumerations and structures give easy access to the main parameters that describe the status of a SIM at a given moment

enum  SmsEvent { SENT, RECEIVED, DELETED, STORAGE_FULL }
 Defines the possible sms notifications that a sim can report. More...
 
enum  CallDir { DIR_OUTGOING = 0, DIR_INCOMING = 1, DIR_UNKNOWN = 2 }
 Direction. More...
 
enum  CallStat {
  STAT_ACTIVE = 0, STAT_HELD = 1, STAT_DIALING = 2, STAT_ALERTING = 3,
  STAT_INCOMING = 4, STAT_WAITING = 5, STAT_TERMINATING = 6, STAT_DROPPED = 7
}
 State. More...
 
enum  CallSourceStatus { NOT_AVAILABLE = 0, IDLE = 1, BUSY = 2 }
 Defines the possible status that a voice call source can report regarding calls. More...
 
enum  CallMode {
  MODE_VOICE = 0, MODE_DATA = 1, MODE_FAX = 2, MODE_VOICE_DATA = 3,
  MODE_VOICE_ALT_DATA = 4, MODE_VOICE_ALT_FAX = 5, MODE_DATA_VOICE = 6, MODE_DATA_ALT_VOICE = 7,
  MODE_FAX_ALT_VOICE = 8, MODE_UNKNOWN = 9
}
 Mode. More...
 
enum  CallMpty { MPTY_INACTIVE = 0, MPTY_ACTIVE = 1 }
 Multiparty. More...
 
enum  CallTrafficChannel { TRAFFIC_CHANNEL_NOT_ASSIGNED = 0, TRAFFIC_CHANNEL_ASSIGNED = 1 }
 Traffic channel assigned. More...
 
enum  CallType {
  TYPE_RESTRICTED_NUM = 0, TYPE_INTERNATIONAL_CODE = 1, TYPE_NATIONAL_NUM = 2, TYPE_SUPPLEM_SERVICE_CODE = 3,
  TYPE_OTHERWISE = 4
}
 Type of address octet as defined by 3GPP. More...
 

Typedef Documentation

typedef boost::function<void(boost::system::error_code error_code, dpyModem::AccessPointNetwork found_apn)> forced_apn_handler_function
Parameters
error_codeerror code (if any)
found_apnAccess Point Network information
typedef boost::function<void(boost::system::error_code error_code,std::string modemid, const bool &enabled)> modem_data_connection_status_handler_function
Parameters
error_codeerror code (if any)
modemidmodem id
enabledstatus of the data connection flag
typedef boost::function<void(boost::system::error_code, ModemInfo modeminfo)> modem_info_handler_function
Parameters
error_codeerror code (if any)
modeminfomodem related information
typedef boost::function<void(boost::system::error_code, std::string modemid, ListEvent event)> modem_list_event_handler_function
Parameters
error_codeerror code (if any)
modemidmodem id
eventin the list (ADDED,REMOVED)
typedef boost::function<void(boost::system::error_code, std::list<std::string> modems)> modem_list_handler_function
Parameters
error_codeerror code (if any)
modemslist of modem ids
typedef boost::function<void(boost::system::error_code error_code,std::string modemid, struct ModemStatus& status)> modem_status_handler_function
Parameters
error_codeerror code (if any)
modemidmodem id
statusstructure describing the current status of the modem
typedef boost::function<void(boost::system::error_code, std::string modemid, dpyModem::ModemWarning warning)> modem_warning_event_handler_function
Parameters
error_codeerror code (if any)
modemidmodem id
warningnotification received
typedef boost::function<void(const bool &available)> service_availability_handler_function
Parameters
availabletrue if the service is available, false otherwise
typedef boost::function<void(boost::system::error_code, SimInfo siminfo)> sim_info_handler_function
Parameters
error_codeerror code (if any)
siminfosim related information
typedef boost::function<void(boost::system::error_code, std::string modemid, std::string simid, ListEvent event)> sim_list_event_handler_function
Parameters
error_codeerror code (if any)
modemidmodem id
simidsim id
eventin the list (ADDED,REMOVED)
typedef boost::function<void(boost::system::error_code, std::list<std::string> sims)> sim_list_handler_function
Parameters
error_codeerror code (if any)
simslist of sim ids
typedef boost::function<void(boost::system::error_code error_code, std::string modemid, int simSlot)> sim_slot_handler_function
Parameters
error_codeerror code (if any)
modemidmodem id
simSlotcurrent sim slot in use
typedef boost::function<void(boost::system::error_code, std::string simid, dpyModem::SimStatus status)> simStatus_handler_function
Parameters
error_codeerror code (if any)
simidsim id
statusthe sim status

Enumeration Type Documentation

Enumerator
NONE 

Not using any technology (modem disabled, sleep or being enabled) or technology is unknown.

POTS 

Plain old telephone service.

GSM 

GSM (2G network)

GPRS 

GPRS (2G network)

EDGE 

EDGE (2G network)

UMTS 

UMTS (3G network)

HSPA 

HSPA (3G network)

HSDPA 

HSDPA (3G network)

HSUPA 

HSUPA (3G network)

CDMA 

CDMA2000 (2G - 3G network)

LTE 

LTE (4G network)

enum CallDir
Enumerator
DIR_OUTGOING 

0 -> Mobile originated call (MOC)

DIR_INCOMING 

1 -> Mobile terminated call (MTC)

DIR_UNKNOWN 

2 -> Mobile terminated call (MTC)

enum CallMode
Enumerator
MODE_VOICE 

Voice.

MODE_DATA 

Data.

MODE_FAX 

Fax.

MODE_VOICE_DATA 

Voice followed by data, voice mode (only in connection with single numbering scheme AT+CSNS)

MODE_VOICE_ALT_DATA 

Alternating voice/data, voice mode (only in connection with single numbering scheme AT+CSNS)

MODE_VOICE_ALT_FAX 

Alternating voice/fax, voice mode (only in connection with single numbering scheme AT+CSNS)

MODE_DATA_VOICE 

Voice followed by data, data mode (only in connection with single numbering scheme AT+CSNS)

MODE_DATA_ALT_VOICE 

Alternating voice/data, data mode (only in connection with single numbering scheme AT+CSNS)

MODE_FAX_ALT_VOICE 

Alternating voice/fax, fax mode (only in connection with single numbering scheme AT+CSNS)

MODE_UNKNOWN 

Unknown.

enum CallMpty
Enumerator
MPTY_INACTIVE 

Call is not one of multiparty (conference) call parties.

MPTY_ACTIVE 

Call is one of multiparty (conference) call parties.

Enumerator
NOT_AVAILABLE 

Not available.

IDLE 

Ready to perform calls.

BUSY 

Resource is busy, a call may be in progress.

enum CallStat
Enumerator
STAT_ACTIVE 

The call is active.

STAT_HELD 

The call is held.

STAT_DIALING 

Dialing (MOC)

STAT_ALERTING 

Alerting (MOC)

STAT_INCOMING 

Incoming (MTC)

STAT_WAITING 

Waiting (MTC)

STAT_TERMINATING 

The call is not active anymore, but inband information is still available.

STAT_DROPPED 

The call has been suspended by the network, but may resumed later.

Enumerator
TRAFFIC_CHANNEL_NOT_ASSIGNED 

No traffic channel assigned. Transmission of DTMF tones not possible.

TRAFFIC_CHANNEL_ASSIGNED 

Traffic channel is assigned and the progress indicator IE has been received(call setup) or a voice connection has an active state. The parameter indicates that the audio path is activated. DTMF tones can be sent with AT+VTS.

enum CallType
Enumerator
TYPE_RESTRICTED_NUM 

Number is restricted.

TYPE_INTERNATIONAL_CODE 

Dialing string number includes international access code character '+'.

TYPE_NATIONAL_NUM 

National number.

TYPE_SUPPLEM_SERVICE_CODE 

Dialing string number contains "*", "#" characters for Supplementary Services codes. Network support of this type is optional.

TYPE_OTHERWISE 

Otherwise.

Enumerator
GPRS_NOT_REGISTERED 

Modem not registered in the GPRS mobile network.

GPRS_SEARCHING_OPERATOR 

Modem searching for a operator for the GPRS mobile network.

GPRS_REGISTERED_HOME_NET 

Modem has been able to register in the GPRS Home network.

GPRS_REGISTERED_ROAMING 

Modem has been able to register in the GPRS Roaming network (i.e., an external network)

GPRS_REGISTRATION_DENIED 

Modem has not been able to register either in Home or Roaming networks.

enum ListEvent
Enumerator
ADDED 

ADDED.

REMOVED 

REMOVED.

enum MODEM_INFO
Enumerator
MANUFACTURER 

Modem Manufacturer.

MODEL 

Modem Model.

FW_VERSION 

Modem firmware version.

IMEI 

Modem IMEI (International Mobile Equipment Identity)

SIM_IMSI 

SIM card IMSI (International Mobile Subscriber Identity)

SIM_ICCID 

SIM card ICCID (Integrated Circuit Card Identifier)

SIM_OPERATOR 

Current operator used by the SIM card.

SIM_APN 

APN that is being used by the SIM card to perform data connections.

Enumerator
DISABLE 

Operation that shuts down the modem completely.

ENABLE 

Operation that enables the modem (modem enabled by default)

SLEEP 

Operation that sets the modem sleep mode.

SW_RESTART 

Operation that generates a software modem restart.

HW_RESTART 

Operation that generates a hardware modem restart.

DISABLE_DATA_CONNECTION 

Operation that disables the data connections performed with the modem.

ENABLE_DATA_CONNECTION 

Operation that enables the data connections performed with the modem (modem data connection enabled by default)

Enumerator
MODEM_DISABLED 

Modem functions are not available.

MODEM_RESTART 

Modem is being restarted.

MODEM_SLEEP 

Modem low consumption mode.

MODEM_ON 

Modem full functionality mode.

enum ModemState

Defines the MODEM STATES that the modem can be in

Enumerator
DISABLED 

Modem is off, modem functionalities are not available.

RESTARTING 

Modem is being restarted, modem functionalities are not available.

SLEEPING 

Modem low consumption mode, modem functionalities are not available.

ENABLING_MODEM 

Modem Cellular network capabilities are being enabled but cellular network may not be available yet.

ENABLED_SIM_READY 

Modem is enabled and SIM card is ready.

SERVICE_AVAILABLE_GOOD_SIGNAL 

Modem signal quality is good enough to perform communications.

CELLULAR_NETWORK_REG_HOME 

Modem is registered in the Cellular network : home network.

CELLULAR_NETWORK_REG_ROAMING 

Modem is registered in the Cellular network : roaming network.

DATA_CONNECTION_NOT_AVAILABLE 

Modem Data connection system is being initiated.

DATA_CONNECTION_ENABLED 

Modem Data connection has been configured and enabled.

DATA_CONNECTION_CONNECTING 

Modem has configured the device for data connections and it's trying to connect.

DATA_CONNECTION_ACTIVE 

Modem is ready to perform data connections, a network interface should be available for use.

Enumerator
NOTIFY_UNDERVOLTAGE 

Supply voltage is close to the undervoltage threshold. If the voltage continues to decrease until it drops below the threshold a controlled shutdown will be initiated.

NOTIFY_OVERVOLTAGE 

Supply voltage is close to the overvoltage threshold. If the voltage continues to increase until it crosses the threshold a controlled shutdown will be initiated.

NOTIFY_CLOSE_TO_UNDERTEMPERATURE 

Modem module is close to undertemperature limit.

NOTIFY_CLOSE_TO_OVERTEMPERATURE 

Modem module is close to overtemperature limit.

NOTIFY_UNDERTEMPERATURE 

Modem module is below undertemperature limit, imminent switch off.

NOTIFY_OVERTEMPERATURE 

Modem module is above overtemperature limit, imminent switch off.

NOTIFY_BACK_TO_NORMAL_TEMPERATURE 

Modem module is back to normal temperature.

NOTIFY_JAMMING 

Modem Jamming has been detected in the module.

NOTIFY_SHUTDOWN 

Indicates that the power-off procedure is finished and the modem will be switched off in less than 1 second.

NOTIFY_RESTARTED 

Indicates that the modem restart is finished and the modem is again available.

Enumerator
MODE_NONE 

No mode.

MODE_CS 

CSD, GSM and circuit-switched.

MODE_2G 

2G mode

MODE_3G 

3G mode

MODE_4G 

4G mode

MODE_ANY 

Any mode,select to go back to default network mode.

Enumerator
NOT_REGISTERED 

Modem not registered in the Cellular network.

SEARCHING_OPERATOR 

Modem searching for a operator for the Cellular network.

REGISTERED_HOME_NET 

Modem has been able to register in the Cellular Home network.

REGISTERED_ROAMING 

Modem has been able to register in the Cellular Roaming network (i.e. an external network)

REGISTRATION_DENIED 

Modem has not been able to register either in Home or Roaming networks.

Enumerator
ANTENNA_NOT_DETECTED 

Modem Antenna is not connected to the device.

POOR_SIGNAL_STRENGTH 

Signal quality is not adequate and this can affect performance.

FAIR_SIGNAL_STRENGTH 

Signal quality should be enough to perform communications.

GOOD_SIGNAL_STRENGTH 

Signal quality is good enough to perform communications.

EXCELLENT_SIGNAL_STRENGTH 

Signal quality is high.

enum SmsEvent
Enumerator
SENT 

Modem module has just sent an SMS.

RECEIVED 

Modem module has just received a SMS.

DELETED 

Modem SMS has been deleted from memory.

STORAGE_FULL 

Modem module SMS storage is full, some SMS should be deleted.