Telematics SDK - Interface Specification
v1.21.0
|
Data Structures | |
class | telux::tel::GsmCellIdentity |
class | telux::tel::CdmaCellIdentity |
class | telux::tel::LteCellIdentity |
class | telux::tel::WcdmaCellIdentity |
class | telux::tel::TdscdmaCellIdentity |
class | telux::tel::CellInfo |
class | telux::tel::GsmCellInfo |
class | telux::tel::CdmaCellInfo |
class | telux::tel::LteCellInfo |
class | telux::tel::WcdmaCellInfo |
class | telux::tel::TdscdmaCellInfo |
struct | telux::tel::ECallMsdOptionals |
struct | telux::tel::ECallMsdControlBits |
struct | telux::tel::ECallVehicleIdentificationNumber |
struct | telux::tel::ECallVehiclePropulsionStorageType |
struct | telux::tel::ECallVehicleLocation |
struct | telux::tel::ECallVehicleLocationDelta |
struct | telux::tel::ECallOptionalPdu |
struct | telux::tel::ECallMsdData |
struct | telux::tel::ECallModeInfo |
class | telux::tel::IPhone |
This class allows getting system information and registering for system events. Each Phone instance is associated with a single SIM. So on a dual SIM device you would have 2 Phone instances. More... | |
class | telux::tel::ISignalStrengthCallback |
Interface for Signal strength callback object. Client needs to implement this interface to get single shot responses for commands like get signal strength. More... | |
class | telux::tel::IVoiceServiceStateCallback |
Interface for voice service state callback object. Client needs to implement this interface to get single shot responses for commands like request voice radio technology. More... | |
struct | telux::tel::SimRatCapability |
struct | telux::tel::CellularCapabilityInfo |
class | telux::tel::IPhoneListener |
A listener class for monitoring changes in specific telephony states on the device, including service state and signal strength. Override the methods for the state that you wish to receive updates for. More... | |
class | telux::tel::IPhoneManager |
Phone Manager creates one or more phones based on SIM slot count, it allows clients to register for notification of system events. Clients should check if the subsystem is ready before invoking any of the APIs. More... | |
class | telux::tel::ICellularCapabilityCallback |
class | telux::tel::IOperatingModeCallback |
class | telux::tel::SignalStrength |
class | telux::tel::LteSignalStrengthInfo |
class | telux::tel::GsmSignalStrengthInfo |
class | telux::tel::CdmaSignalStrengthInfo |
class | telux::tel::WcdmaSignalStrengthInfo |
class | telux::tel::TdscdmaSignalStrengthInfo |
class | telux::tel::VoiceServiceInfo |
This section contains APIs related to Phone, Signal Strength and interfaces to register global listeners to event notifications.
class telux::tel::GsmCellIdentity |
GsmCellIdentity class provides methods to get mobile country code, mobile network code, location area code, cell identity, absolute RF channel number and base station identity code.
Public Member Functions | |
GsmCellIdentity (int mcc, int mnc, int lac, int cid, int arfcn, int bsic) | |
const int | getMcc () |
const int | getMnc () |
const int | getLac () |
const int | getIdentity () |
const int | getArfcn () |
const int | getBaseStationIdentityCode () |
telux::tel::GsmCellIdentity::GsmCellIdentity | ( | int | mcc, |
int | mnc, | ||
int | lac, | ||
int | cid, | ||
int | arfcn, | ||
int | bsic | ||
) |
const int telux::tel::GsmCellIdentity::getMcc | ( | ) |
Get the Mobile Country Code.
const int telux::tel::GsmCellIdentity::getMnc | ( | ) |
Get the Mobile Network Code.
const int telux::tel::GsmCellIdentity::getLac | ( | ) |
Get the location area code.
const int telux::tel::GsmCellIdentity::getIdentity | ( | ) |
Get the cell identity.
const int telux::tel::GsmCellIdentity::getArfcn | ( | ) |
Get the absolute RF channel number.
const int telux::tel::GsmCellIdentity::getBaseStationIdentityCode | ( | ) |
Get the base station identity code.
class telux::tel::CdmaCellIdentity |
CdmaCellIdentity class provides methods to get the network identifier, system identifier, base station identifier, longitude and latitude.
Public Member Functions | |
CdmaCellIdentity (int networkId, int systemId, int baseStationId, int longitude, int latitude) | |
const int | getNid () |
const int | getSid () |
const int | getBaseStationId () |
const int | getLongitude () |
const int | getLatitude () |
telux::tel::CdmaCellIdentity::CdmaCellIdentity | ( | int | networkId, |
int | systemId, | ||
int | baseStationId, | ||
int | longitude, | ||
int | latitude | ||
) |
const int telux::tel::CdmaCellIdentity::getNid | ( | ) |
Get the network identifier.
const int telux::tel::CdmaCellIdentity::getSid | ( | ) |
Get the system identifier.
const int telux::tel::CdmaCellIdentity::getBaseStationId | ( | ) |
Get the base station identifier.
const int telux::tel::CdmaCellIdentity::getLongitude | ( | ) |
Get the longitude.
const int telux::tel::CdmaCellIdentity::getLatitude | ( | ) |
Get the latitude.
class telux::tel::LteCellIdentity |
LteCellIdentity class provides methods to get the mobile country code, mobile network code, cell identity, physical cell identifier, tracking area code and absolute Rf channel number.
Public Member Functions | |
LteCellIdentity (int mcc, int mnc, int ci, int pci, int tac, int earfcn) | |
const int | getMcc () |
const int | getMnc () |
const int | getIdentity () |
const int | getPhysicalCellId () |
const int | getTrackingAreaCode () |
const int | getEarfcn () |
telux::tel::LteCellIdentity::LteCellIdentity | ( | int | mcc, |
int | mnc, | ||
int | ci, | ||
int | pci, | ||
int | tac, | ||
int | earfcn | ||
) |
const int telux::tel::LteCellIdentity::getMcc | ( | ) |
Get the Mobile Country Code.
const int telux::tel::LteCellIdentity::getMnc | ( | ) |
Get the Mobile Network Code.
const int telux::tel::LteCellIdentity::getIdentity | ( | ) |
Get the cell identity.
const int telux::tel::LteCellIdentity::getPhysicalCellId | ( | ) |
Get the physical cell identifier.
const int telux::tel::LteCellIdentity::getTrackingAreaCode | ( | ) |
Get the tracking area code.
const int telux::tel::LteCellIdentity::getEarfcn | ( | ) |
Get the absolute RF channel number.
class telux::tel::WcdmaCellIdentity |
WcdmaCellIdentity class provides methods to get the mobile country code, mobile network code, location area code, cell identitifier, primary scrambling code and absolute RF channel number.
Public Member Functions | |
WcdmaCellIdentity (int mcc, int mnc, int lac, int cid, int psc, int uarfcn) | |
const int | getMcc () |
const int | getMnc () |
const int | getLac () |
const int | getIdentity () |
const int | getPrimaryScramblingCode () |
const int | getUarfcn () |
telux::tel::WcdmaCellIdentity::WcdmaCellIdentity | ( | int | mcc, |
int | mnc, | ||
int | lac, | ||
int | cid, | ||
int | psc, | ||
int | uarfcn | ||
) |
const int telux::tel::WcdmaCellIdentity::getMcc | ( | ) |
Get the Mobile Country Code.
const int telux::tel::WcdmaCellIdentity::getMnc | ( | ) |
Get the Mobile Network Code.
const int telux::tel::WcdmaCellIdentity::getLac | ( | ) |
Get the location area code.
const int telux::tel::WcdmaCellIdentity::getIdentity | ( | ) |
Get the cell identity.
const int telux::tel::WcdmaCellIdentity::getPrimaryScramblingCode | ( | ) |
Get the primary scrambling code.
const int telux::tel::WcdmaCellIdentity::getUarfcn | ( | ) |
Get the absolute RF channel number.
class telux::tel::TdscdmaCellIdentity |
TdscdmaCellIdentity class provides methods to get the mobile country code, mobile network code, location area code, cell identity and cell parameters identifier.
Public Member Functions | |
TdscdmaCellIdentity (int mcc, int mnc, int lac, int cid, int cpid) | |
const int | getMcc () |
const int | getMnc () |
const int | getLac () |
const int | getIdentity () |
const int | getParametersId () |
telux::tel::TdscdmaCellIdentity::TdscdmaCellIdentity | ( | int | mcc, |
int | mnc, | ||
int | lac, | ||
int | cid, | ||
int | cpid | ||
) |
const int telux::tel::TdscdmaCellIdentity::getMcc | ( | ) |
Get the Mobile Country Code.
const int telux::tel::TdscdmaCellIdentity::getMnc | ( | ) |
Get the Mobile Network Code.
const int telux::tel::TdscdmaCellIdentity::getLac | ( | ) |
Get the location area code
const int telux::tel::TdscdmaCellIdentity::getIdentity | ( | ) |
Get the cell identity.
const int telux::tel::TdscdmaCellIdentity::getParametersId | ( | ) |
Get the cell parameters identifier.
class telux::tel::CellInfo |
CellInfo class provides cell info type and checks whether the current cell is registered or not.
Public Member Functions | |
virtual CellType | getType () |
virtual bool | isRegistered () |
Protected Attributes | |
CellType | type_ |
int | registered_ |
|
virtual |
Get the cell type.
|
virtual |
Checks whether the current cell is registered or not.
|
protected |
|
protected |
class telux::tel::GsmCellInfo |
GsmCellInfo class provides methods to get cell type, cell registration status, cell identity and signal strength information.
Public Member Functions | |
GsmCellInfo (int registered, GsmCellIdentity id, GsmSignalStrengthInfo ssInfo) | |
GsmCellIdentity | getCellIdentity () |
GsmSignalStrengthInfo | getSignalStrengthInfo () |
Public Member Functions inherited from telux::tel::CellInfo | |
virtual CellType | getType () |
virtual bool | isRegistered () |
Additional Inherited Members | |
Protected Attributes inherited from telux::tel::CellInfo | |
CellType | type_ |
int | registered_ |
telux::tel::GsmCellInfo::GsmCellInfo | ( | int | registered, |
GsmCellIdentity | id, | ||
GsmSignalStrengthInfo | ssInfo | ||
) |
GsmCellInfo constructor.
[in] | registered | - Registration status of the cell. |
[in] | id | - GSM cell identity. |
[in] | ssInfo | - GSM cell signal strength. |
GsmCellIdentity telux::tel::GsmCellInfo::getCellIdentity | ( | ) |
Get GSM cell identity information.
GsmSignalStrengthInfo telux::tel::GsmCellInfo::getSignalStrengthInfo | ( | ) |
Get GSM cell signal strength information.
class telux::tel::CdmaCellInfo |
CdmaCellInfo class provides methods to get cell type, cell registration status, cell identity and signal strength information.
Public Member Functions | |
CdmaCellInfo (int registered, CdmaCellIdentity id, CdmaSignalStrengthInfo ssInfo) | |
CdmaCellIdentity | getCellIdentity () |
CdmaSignalStrengthInfo | getSignalStrengthInfo () |
Public Member Functions inherited from telux::tel::CellInfo | |
virtual CellType | getType () |
virtual bool | isRegistered () |
Additional Inherited Members | |
Protected Attributes inherited from telux::tel::CellInfo | |
CellType | type_ |
int | registered_ |
telux::tel::CdmaCellInfo::CdmaCellInfo | ( | int | registered, |
CdmaCellIdentity | id, | ||
CdmaSignalStrengthInfo | ssInfo | ||
) |
CdmaCellInfo constructor
[in] | registered | - Registration status of the cell. |
[in] | id | - CDMA cell identity. |
[in] | ssInfo | - CDMA cell signal strength. |
CdmaCellIdentity telux::tel::CdmaCellInfo::getCellIdentity | ( | ) |
Get CDMA cell identity information.
CdmaSignalStrengthInfo telux::tel::CdmaCellInfo::getSignalStrengthInfo | ( | ) |
Get CDMA cell signal strength information.
class telux::tel::LteCellInfo |
LteCellInfo class provides methods to get cell type, cell registration status, cell identity and signal strength information.
Public Member Functions | |
LteCellInfo (int registered, LteCellIdentity id, LteSignalStrengthInfo ssInfo) | |
LteCellIdentity | getCellIdentity () |
LteSignalStrengthInfo | getSignalStrengthInfo () |
Public Member Functions inherited from telux::tel::CellInfo | |
virtual CellType | getType () |
virtual bool | isRegistered () |
Additional Inherited Members | |
Protected Attributes inherited from telux::tel::CellInfo | |
CellType | type_ |
int | registered_ |
telux::tel::LteCellInfo::LteCellInfo | ( | int | registered, |
LteCellIdentity | id, | ||
LteSignalStrengthInfo | ssInfo | ||
) |
LteCellInfo constructor.
[in] | registered | - Registration status of the cell. |
[in] | id | - LTE cell identity class. |
[in] | ssInfo | - LTE cell signal strength. |
LteCellIdentity telux::tel::LteCellInfo::getCellIdentity | ( | ) |
Get LTE cell identity information.
LteSignalStrengthInfo telux::tel::LteCellInfo::getSignalStrengthInfo | ( | ) |
Get LTE cell signal strength information.
class telux::tel::WcdmaCellInfo |
WcdmaCellInfo class provides methods to get cell type, cell registration status, cell identity and signal strength information.
Public Member Functions | |
WcdmaCellInfo (int registered, WcdmaCellIdentity id, WcdmaSignalStrengthInfo ssInfo) | |
WcdmaCellIdentity | getCellIdentity () |
WcdmaSignalStrengthInfo | getSignalStrengthInfo () |
Public Member Functions inherited from telux::tel::CellInfo | |
virtual CellType | getType () |
virtual bool | isRegistered () |
Additional Inherited Members | |
Protected Attributes inherited from telux::tel::CellInfo | |
CellType | type_ |
int | registered_ |
telux::tel::WcdmaCellInfo::WcdmaCellInfo | ( | int | registered, |
WcdmaCellIdentity | id, | ||
WcdmaSignalStrengthInfo | ssInfo | ||
) |
WcdmaCellInfo constructor.
[in] | registered | - Registration status of the cell. |
[in] | id | - WCDMA cell identity. |
[in] | ssInfo | - WCDMA cell signal strength. |
WcdmaCellIdentity telux::tel::WcdmaCellInfo::getCellIdentity | ( | ) |
Get WCDMA cell identity information.
WcdmaSignalStrengthInfo telux::tel::WcdmaCellInfo::getSignalStrengthInfo | ( | ) |
Get WCDMA cell signal strength information.
class telux::tel::TdscdmaCellInfo |
TdscdmaCellInfo class provides methods to get cell type, cell registration status, cell identity and signal strength information.
Public Member Functions | |
TdscdmaCellInfo (int registered, TdscdmaCellIdentity id, TdscdmaSignalStrengthInfo ssInfo) | |
TdscdmaCellIdentity | getCellIdentity () |
TdscdmaSignalStrengthInfo | getSignalStrengthInfo () |
Public Member Functions inherited from telux::tel::CellInfo | |
virtual CellType | getType () |
virtual bool | isRegistered () |
Additional Inherited Members | |
Protected Attributes inherited from telux::tel::CellInfo | |
CellType | type_ |
int | registered_ |
telux::tel::TdscdmaCellInfo::TdscdmaCellInfo | ( | int | registered, |
TdscdmaCellIdentity | id, | ||
TdscdmaSignalStrengthInfo | ssInfo | ||
) |
TdscdmaCellInfo constructor.
[in] | registered | - Registration status of the cell |
[in] | id | - TDSCDMA cell identity. |
[in] | ssInfo | - TDSCDMA cell signal strength. |
TdscdmaCellIdentity telux::tel::TdscdmaCellInfo::getCellIdentity | ( | ) |
Get TDSCDMA cell identity information.
TdscdmaSignalStrengthInfo telux::tel::TdscdmaCellInfo::getSignalStrengthInfo | ( | ) |
Get TDSCDMA cell signal strength information.
struct telux::tel::ECallMsdOptionals |
Represents MsdOptionals class as per European eCall MSD standard. i.e. EN 15722.
Data Fields | ||
---|---|---|
ECallOptionalDataType | optionalDataType |
Type of optional data |
bool | optionalDataPresent |
Availability of Optional data: true - Present or false - Absent |
bool | recentVehicleLocationN1Present |
Availability of Recent Vehicle Location N1 data: true - Present or false - Absent |
bool | recentVehicleLocationN2Present |
Availability of Recent Vehicle Location N2 data: true - Present or false - Absent |
bool | numberOfPassengersPresent |
Availability of number of seat belts fastened data: true - Present or false - Absent |
struct telux::tel::ECallMsdControlBits |
Represents ECallMsdControlBits structure as per European eCall MSD standard. i.e. EN 15722.
Data Fields | ||
---|---|---|
bool | automaticActivation |
auto / manual activation |
bool | testCall |
test / emergency call |
bool | positionCanBeTrusted |
false if coincidence < 95% of reported pos within +/- 150m |
ECallVehicleType | vehicleType: 5 |
Represents a vehicle class as per EN 15722 |
struct telux::tel::ECallVehicleIdentificationNumber |
Represents VehicleIdentificationNumber structure as per European eCall MSD standard. i.e. EN 15722. Vehicle Identification Number confirming ISO3779.
struct telux::tel::ECallVehiclePropulsionStorageType |
Represents VehiclePropulsionStorageType structure as per European eCall MSD standard. i.e. EN 15722. Vehicle Propulsion type (energy storage): True- Present, False - Absent
struct telux::tel::ECallVehicleLocation |
struct telux::tel::ECallVehicleLocationDelta |
Represents VehicleLocationDelta structure as per European eCall MSD standard. i.e. EN 15722. Delta with respect to Current Vehicle location.
Data Fields | ||
---|---|---|
int16_t | latitudeDelta |
( 1 Unit = 100 milliarcseconds, range: -512 to 511) |
int16_t | longitudeDelta |
( 1 Unit = 100 milliarcseconds, range: -512 to 511) |
struct telux::tel::ECallOptionalPdu |
struct telux::tel::ECallMsdData |
Data structure to hold all details required to construct an MSD
Data Fields | ||
---|---|---|
ECallMsdOptionals | optionals |
Indicates presence of optionals in ECall MSD |
uint8_t | messageIdentifier |
Starts with 1 for each new , increment on retransmission |
ECallMsdControlBits | control |
ECallMsdControlBits structure as per European standard i.e. EN 15722 |
ECallVehicleIdentificationNumber | vehicleIdentificationNumber |
VIN (vehicle identification number) according to ISO3779 |
ECallVehiclePropulsionStorageType | vehiclePropulsionStorage |
VehiclePropulsionStorageType structure as per European standard i.e. EN 15722 |
uint32_t | timestamp |
Seconds elapsed since midnight 01.01.1970 UTC |
ECallVehicleLocation | vehicleLocation |
VehicleLocation structure as per European standard. i.e. EN 15722 |
uint8_t | vehicleDirection |
Direction of travel in 2 degrees steps from magnetic north |
ECallVehicleLocationDelta | recentVehicleLocationN1 |
Change in latitude and longitude compared to the last MSD transmission |
ECallVehicleLocationDelta | recentVehicleLocationN2 |
Change in latitude and longitude compared to the last but one MSD transmission |
uint8_t | numberOfPassengers |
Number of occupants in the vehicle |
ECallOptionalPdu | optionalPdu |
Optional information for the emergency rescue service (103 bytes, ASN.1 encoded); may also point to an address, where this information is locatedOptional information for the emergency rescue service |
struct telux::tel::ECallModeInfo |
Represents eCall operating mode information
Data Fields | ||
---|---|---|
ECallMode | mode |
Represents eCall operating mode |
ECallModeReason | reason |
Represents eCall operating mode change reason |
class telux::tel::IPhone |
This class allows getting system information and registering for system events. Each Phone instance is associated with a single SIM. So on a dual SIM device you would have 2 Phone instances.
|
virtual |
|
pure virtual |
Get the Phone ID corresponding to phone.
[out] | phoneId | Unique identifier for the phone |
|
pure virtual |
Get Radio state of device.
|
pure virtual |
Request for Radio technology type (3GPP/3GPP2) used for voice.
[in] | callback | callback pointer to get the response of radio power request telux::tel::VoiceRadioTechResponseCb |
|
pure virtual |
|
pure virtual |
Request for voice service state to get the information of phone serving states
[in] | callback | callback pointer to get the response of voice service state telux::tel::IVoiceServiceStateCallback. |
|
pure virtual |
Set the radio power on or off.
[in] | enable | Flag that determines whether to turn radio on or off |
[in] | callback | Optional callback pointer to get the response of set radio power request |
|
pure virtual |
Get the cell information about current serving cell and neighboring cells.
[in] | callback | Callback to get the response of cell info request tel::CellInfoCallback |
|
pure virtual |
Set the minimum time in milliseconds between when the cell info list should be received.
[in] | timeInterval | Value of 0 means receive cell info list when any info changes. Value of INT_MAX means never receive cell info list even on change. Default value is 0 |
[in] | callback | Callback to get the response for set cell info list rate. |
|
pure virtual |
Get current signal strength of the associated network.
[in] | callback | Optional callback pointer to get the response of signal strength request |
|
pure virtual |
Sets the eCall operating mode
[in] | eCallMode | - ECallMode |
[in] | callback | - Callback function to get the response for set eCall operating mode request. |
|
pure virtual |
Get the eCall operating mode
[in] | callback | - Callback function to get the response of eCall operating mode request |
class telux::tel::ISignalStrengthCallback |
Interface for Signal strength callback object. Client needs to implement this interface to get single shot responses for commands like get signal strength.
The methods in callback can be invoked from multiple different threads. The implementation should be thread safe.
Public Member Functions | |
virtual void | signalStrengthResponse (std::shared_ptr< SignalStrength > signalStrength, telux::common::ErrorCode error) |
virtual | ~ISignalStrengthCallback () |
Public Member Functions inherited from telux::common::ICommandCallback | |
virtual | ~ICommandCallback () |
|
virtual |
|
virtual |
This function is called with the response to requestSignalStrength API.
[in] | signalStrength | Pointer to signal strength object |
[in] | error | Return code for whether the operation succeeded or failed SUCCESS RADIO_NOT_AVAILABLE |
class telux::tel::IVoiceServiceStateCallback |
Interface for voice service state callback object. Client needs to implement this interface to get single shot responses for commands like request voice radio technology.
The methods in callback can be invoked from multiple different threads. The implementation should be thread safe.
Public Member Functions | |
virtual void | voiceServiceStateResponse (const std::shared_ptr< VoiceServiceInfo > &serviceInfo, telux::common::ErrorCode error) |
virtual | ~IVoiceServiceStateCallback () |
Public Member Functions inherited from telux::common::ICommandCallback | |
virtual | ~ICommandCallback () |
|
virtual |
|
virtual |
This function is called with the response to requestVoiceServiceState API.
[in] | serviceInfo | Pointer to voice service info object telux::tel::VoiceServiceInfo |
[in] | error | Return code for whether the operation succeeded or failed |
struct telux::tel::SimRatCapability |
Structure contains slotID and RAT capabilities corresponding to slot.
Data Fields | ||
---|---|---|
int | slotId | |
RATCapabilitiesMask | capabilities |
struct telux::tel::CellularCapabilityInfo |
Structure contains information about device capability.
Data Fields | ||
---|---|---|
VoiceServiceTechnologiesMask | voiceServiceTechs |
Indicates voice support capabilities |
int | simCount |
The maximum number of SIMs that can be supported simultaneously |
int | maxActiveSims |
The maximum number of SIMs that can be simultaneously active. If this number is less than numberofSims, it implies that any combination of the SIMs can be active and the remaining can be in standby. |
vector< SimRatCapability > | simRatCapabilities |
An array of struct which contains mask of RAT capabilities and slotId corresponding to each SIM |
class telux::tel::IPhoneListener |
A listener class for monitoring changes in specific telephony states on the device, including service state and signal strength. Override the methods for the state that you wish to receive updates for.
The methods in listener can be invoked from multiple different threads. The implementation should be thread safe.
Public Member Functions | |
virtual void | onServiceStateChanged (int phoneId, ServiceState state) |
virtual void | onSignalStrengthChanged (int phoneId, std::shared_ptr< SignalStrength > signalStrength) |
virtual void | onCellInfoListChanged (int phoneId, std::vector< std::shared_ptr< CellInfo >> cellInfoList) |
virtual void | onRadioStateChanged (int phoneId, RadioState radioState) |
virtual void | onVoiceRadioTechnologyChanged (int phoneId, RadioTechnology radioTech) |
virtual void | onVoiceServiceStateChanged (int phoneId, const std::shared_ptr< VoiceServiceInfo > &serviceInfo) |
virtual void | onOperatingModeChanged (OperatingMode mode) |
virtual void | onECallOperatingModeChange (int phoneId, telux::tel::ECallModeInfo info) |
virtual | ~IPhoneListener () |
|
virtual |
|
virtual |
This function is called when device service state changes.
[in] | phoneId | Unique id of the phone on which service state changed. |
[in] | state | Service state of the phone ServiceState |
|
virtual |
This function is called when network signal strength changes.
[in] | phoneId | Unique id of the phone on which signal strength state changed. |
[in] | signalStrength | Pointer to signal strength object |
|
virtual |
This function is called when info pertaining to current or neighboring cells change.
[in] | phoneId | Unique id of the phone on which cell info changed. |
[in] | cellInfoList | vector of shared pointers to cell info object |
|
virtual |
This function is called when radio state changes on phone
[in] | phone | Unique id of the phone on which radio state changed |
[in] | radioState | Radio state of the phone RadioState |
|
virtual |
This function is called when the radio technology for voice service changes
[in] | phone | Unique id of the phone on which radio technology changed |
[in] | radioTech | Radio state of the phone telux::tel::RadioTechnology |
|
virtual |
This function is called when the service state for voice service changes
[in] | phone | Unique id of the phone on which radio technology changed |
[in] | serviceInfo | pointer of voice service state info object telux::tel::VoiceServiceInfo |
|
virtual |
This function is called when the operating mode changes
[in] | mode | Operating mode OperatingMode. |
|
virtual |
This function is called when eCall operating mode changes.
[in] | phoneId | - Unique Id of phone for which eCall operating mode changed |
[in] | info | - Indicates eCall operating mode change reason ECallModeInfo |
class telux::tel::IPhoneManager |
Phone Manager creates one or more phones based on SIM slot count, it allows clients to register for notification of system events. Clients should check if the subsystem is ready before invoking any of the APIs.
Public Member Functions | |
virtual bool | isSubsystemReady ()=0 |
virtual std::future< bool > | onSubsystemReady ()=0 |
virtual telux::common::Status | getPhoneIds (std::vector< int > &phoneIds)=0 |
virtual int | getPhoneIdFromSlotId (int slotId)=0 |
virtual int | getSlotIdFromPhoneId (int phoneId)=0 |
virtual std::shared_ptr< IPhone > | getPhone (int phoneId=DEFAULT_PHONE_ID)=0 |
virtual telux::common::Status | requestCellularCapabilityInfo (std::shared_ptr< ICellularCapabilityCallback > callback=nullptr)=0 |
virtual telux::common::Status | requestOperatingMode (std::shared_ptr< IOperatingModeCallback > callback=nullptr)=0 |
virtual telux::common::Status | setOperatingMode (OperatingMode operatingMode, telux::common::ResponseCallback callback=nullptr)=0 |
virtual telux::common::Status | registerListener (std::weak_ptr< IPhoneListener > listener)=0 |
virtual telux::common::Status | removeListener (std::weak_ptr< IPhoneListener > listener)=0 |
virtual | ~IPhoneManager () |
|
virtual |
|
pure virtual |
Checks the status of telephony subsystems and returns the result.
|
pure virtual |
Wait for telephony subsystem to be ready.
|
pure virtual |
Retrieves a list of Phone Ids. Each id is unique per phone. For example: on a dual SIM device, there would be 2 Phones.
[out] | phoneIds | List of phone ids |
|
pure virtual |
Get the Phone Id for a given Slot Id.
[in] | slotId | SIM Card Slot Id |
|
pure virtual |
Get the SIM Slot Id for a given Phone Id.
[in] | phoneId | Phone Id of the phone |
|
pure virtual |
Get the phone instance for a given phone identifier.
[in] | phoneId | Identifier for phone instance, retrieved from getPhoneIds API |
|
pure virtual |
Get the information about cellular capability.
[in] | callback | Optional callback pointer to get the response of cellular capability. |
|
pure virtual |
Get current operating mode of the device.
[in] | callback | Optional callback pointer to get the response of operating mode request |
|
pure virtual |
Set the operating mode of the device. Only valid transitions allowed from one mode to another.
[in] | operatingMode | Operating Mode to be set |
[in] | callback | Optional callback pointer to get the response of set operatingmode request. In callback following error is returned. |
|
pure virtual |
Register a listener for specific events in the telephony subsystem.
[in] | listener | Pointer to Phone Listener object that processes the notification |
|
pure virtual |
Remove a previously added listener.
[in] | listener | Pointer to Phone Listener object that needs to be removed |
class telux::tel::ICellularCapabilityCallback |
Interface for callback corresponding to cellular capability request. Client needs to implement this interface to get single shot responses for commands like get cellular capability.
The methods in callback can be invoked from multiple different threads. The implementation should be thread safe.
Public Member Functions | |
virtual void | cellularCapabilityResponse (CellularCapabilityInfo capabilityInfo, telux::common::ErrorCode error) |
virtual | ~ICellularCapabilityCallback () |
Public Member Functions inherited from telux::common::ICommandCallback | |
virtual | ~ICommandCallback () |
|
virtual |
|
virtual |
This function is called with the response to requestCellularCapabilityInfo API.
[in] | capabilityInfo | Cellular capability information. |
[in] | error | Return code for whether the operation succeeded or failed |
class telux::tel::IOperatingModeCallback |
Interface for operating mode callback object. Client needs to implement this interface to get single shot responses for commands like request current operating mode.
The methods in callback can be invoked from multiple different threads. The implementation should be thread safe.
Public Member Functions | |
virtual void | operatingModeResponse (OperatingMode operatingMode, telux::common::ErrorCode error) |
virtual | ~IOperatingModeCallback () |
Public Member Functions inherited from telux::common::ICommandCallback | |
virtual | ~ICommandCallback () |
|
virtual |
|
virtual |
This function is called with the response to requestOperatingMode API.
[in] | operatingMode | OperatingMode |
[in] | error | Return code for whether the operation succeeded or failed |
class telux::tel::SignalStrength |
SignalStrength class provides access to LTE, GSM, CDMA, WCDMA, TDSCDMA signal strengths.
Public Member Functions | |
SignalStrength (std::shared_ptr< LteSignalStrengthInfo > lteSignalStrengthInfo, std::shared_ptr< GsmSignalStrengthInfo > gsmSignalStrengthInfo, std::shared_ptr< CdmaSignalStrengthInfo > cdmaSignalStrengthInfo, std::shared_ptr< WcdmaSignalStrengthInfo > wcdmaSignalStrengthInfo, std::shared_ptr< TdscdmaSignalStrengthInfo > tdscdmaSignalStrengthInfo) | |
std::shared_ptr < LteSignalStrengthInfo > | getLteSignalStrength () |
std::shared_ptr < GsmSignalStrengthInfo > | getGsmSignalStrength () |
std::shared_ptr < CdmaSignalStrengthInfo > | getCdmaSignalStrength () |
std::shared_ptr < WcdmaSignalStrengthInfo > | getWcdmaSignalStrength () |
std::shared_ptr < TdscdmaSignalStrengthInfo > | getTdscdmaSignalStrength () |
telux::tel::SignalStrength::SignalStrength | ( | std::shared_ptr< LteSignalStrengthInfo > | lteSignalStrengthInfo, |
std::shared_ptr< GsmSignalStrengthInfo > | gsmSignalStrengthInfo, | ||
std::shared_ptr< CdmaSignalStrengthInfo > | cdmaSignalStrengthInfo, | ||
std::shared_ptr< WcdmaSignalStrengthInfo > | wcdmaSignalStrengthInfo, | ||
std::shared_ptr< TdscdmaSignalStrengthInfo > | tdscdmaSignalStrengthInfo | ||
) |
std::shared_ptr<LteSignalStrengthInfo> telux::tel::SignalStrength::getLteSignalStrength | ( | ) |
Gives LTE signal strength instance.
std::shared_ptr<GsmSignalStrengthInfo> telux::tel::SignalStrength::getGsmSignalStrength | ( | ) |
Gives GSM signal strength instance.
std::shared_ptr<CdmaSignalStrengthInfo> telux::tel::SignalStrength::getCdmaSignalStrength | ( | ) |
Gives CDMA signal strength instance.
std::shared_ptr<WcdmaSignalStrengthInfo> telux::tel::SignalStrength::getWcdmaSignalStrength | ( | ) |
Gives WCDMA signal strength instance.
std::shared_ptr<TdscdmaSignalStrengthInfo> telux::tel::SignalStrength::getTdscdmaSignalStrength | ( | ) |
Gives TDSWCDMA signal strength instance.
class telux::tel::LteSignalStrengthInfo |
LTE signal strength class provides methods to get details of lte signals like dbm, signal level, reference signal-to-noise ratio, channel quality indicator and signal strength.
Public Member Functions | |
LteSignalStrengthInfo (int lteSignalStrength, int lteRsrp, int lteRsrq, int lteRssnr, int lteCqi, int timingAdvance) | |
const SignalStrengthLevel | getLevel () const |
const int | getDbm () const |
const int | getLteSignalStrength () const |
const int | getLteReferenceSignalReceiveQuality () const |
const int | getLteReferenceSignalSnr () const |
const int | getLteChannelQualityIndicator () const |
const int | getTimingAdvance () const |
telux::tel::LteSignalStrengthInfo::LteSignalStrengthInfo | ( | int | lteSignalStrength, |
int | lteRsrp, | ||
int | lteRsrq, | ||
int | lteRssnr, | ||
int | lteCqi, | ||
int | timingAdvance | ||
) |
const SignalStrengthLevel telux::tel::LteSignalStrengthInfo::getLevel | ( | ) | const |
Get signal level in the range.
const int telux::tel::LteSignalStrengthInfo::getDbm | ( | ) | const |
Get the signal strength as dBm.
const int telux::tel::LteSignalStrengthInfo::getLteSignalStrength | ( | ) | const |
Get the LTE signal strength. Range:(0, 63) > 63 is invalid.
const int telux::tel::LteSignalStrengthInfo::getLteReferenceSignalReceiveQuality | ( | ) | const |
Get LTE reference signal receive quality in dB.
const int telux::tel::LteSignalStrengthInfo::getLteReferenceSignalSnr | ( | ) | const |
Get LTE reference signal signal-to-noise ratio in 0.1 dB units. Range: -200 to +300 (-200 = -20.0 dB, +300 = 30dB).
const int telux::tel::LteSignalStrengthInfo::getLteChannelQualityIndicator | ( | ) | const |
Get LTE channel quality indicator. Range: 0 to 15.
const int telux::tel::LteSignalStrengthInfo::getTimingAdvance | ( | ) | const |
Get the timing advance in micro seconds. Range: 0 to 0x7FFFFFFE.
class telux::tel::GsmSignalStrengthInfo |
GSM signal strength provides methods to get GSM signal strength in dBm and GSM signal level.
Public Member Functions | |
GsmSignalStrengthInfo (int gsmSignalStrength, int gsmBitErrorRate, int timingAdvance) | |
const SignalStrengthLevel | getLevel () const |
const int | getDbm () const |
const int | getGsmSignalStrength () const |
const int | getGsmBitErrorRate () const |
const int | getTimingAdvance () |
telux::tel::GsmSignalStrengthInfo::GsmSignalStrengthInfo | ( | int | gsmSignalStrength, |
int | gsmBitErrorRate, | ||
int | timingAdvance | ||
) |
const SignalStrengthLevel telux::tel::GsmSignalStrengthInfo::getLevel | ( | ) | const |
Get signal level in the range.
const int telux::tel::GsmSignalStrengthInfo::getDbm | ( | ) | const |
Get the signal strength as dBm.
const int telux::tel::GsmSignalStrengthInfo::getGsmSignalStrength | ( | ) | const |
Get the GSM signal strength.
const int telux::tel::GsmSignalStrengthInfo::getGsmBitErrorRate | ( | ) | const |
Get the GSM bit error rate (0-7, 99).
const int telux::tel::GsmSignalStrengthInfo::getTimingAdvance | ( | ) |
Get the timing advance in bit periods
class telux::tel::CdmaSignalStrengthInfo |
CDMA signal strength provides methods to get details of Cdma and Evdo like signal strength in dBm and signal level.
Public Member Functions | |
CdmaSignalStrengthInfo (int cdmaDbm, int cdmaEcio, int evdoDbm, int evdoEcio, int evdoSignalNoiseRatio) | |
const SignalStrengthLevel | getLevel () const |
const int | getDbm () const |
const int | getCdmaEcio () const |
const int | getEvdoEcio () const |
const int | getEvdoSignalNoiseRatio () const |
telux::tel::CdmaSignalStrengthInfo::CdmaSignalStrengthInfo | ( | int | cdmaDbm, |
int | cdmaEcio, | ||
int | evdoDbm, | ||
int | evdoEcio, | ||
int | evdoSignalNoiseRatio | ||
) |
const SignalStrengthLevel telux::tel::CdmaSignalStrengthInfo::getLevel | ( | ) | const |
Get signal level in the range.
const int telux::tel::CdmaSignalStrengthInfo::getDbm | ( | ) | const |
Get the signal strength as dBm.
const int telux::tel::CdmaSignalStrengthInfo::getCdmaEcio | ( | ) | const |
Get the Cdma Ec/Io value in dB*10.
const int telux::tel::CdmaSignalStrengthInfo::getEvdoEcio | ( | ) | const |
Get the Evdo Ec/Io value in dB*10.
const int telux::tel::CdmaSignalStrengthInfo::getEvdoSignalNoiseRatio | ( | ) | const |
Get the Evdo signal noise ratio and values are 0-8. 8 is the highest signal to noise ratio.
class telux::tel::WcdmaSignalStrengthInfo |
Wcdma signal strength provides methods to get Wcdma signal strength in dBm and Wcdma signal level.
Public Member Functions | |
WcdmaSignalStrengthInfo (int signalStrength, int bitErrorRate) | |
const SignalStrengthLevel | getLevel () const |
const int | getDbm () const |
const int | getSignalStrength () const |
const int | getBitErrorRate () const |
telux::tel::WcdmaSignalStrengthInfo::WcdmaSignalStrengthInfo | ( | int | signalStrength, |
int | bitErrorRate | ||
) |
const SignalStrengthLevel telux::tel::WcdmaSignalStrengthInfo::getLevel | ( | ) | const |
Get signal level in the range.
const int telux::tel::WcdmaSignalStrengthInfo::getDbm | ( | ) | const |
Get the signal strength as dBm.
const int telux::tel::WcdmaSignalStrengthInfo::getSignalStrength | ( | ) | const |
Get the Wcdma signal strength (0-31, 99).
const int telux::tel::WcdmaSignalStrengthInfo::getBitErrorRate | ( | ) | const |
Get the Wcdma bit error rate (0-7, 99).
class telux::tel::TdscdmaSignalStrengthInfo |
Tdscdma signal strength provides methods to get received signal code power.
Public Member Functions | |
TdscdmaSignalStrengthInfo (int rscp) | |
const int | getRscp () const |
telux::tel::TdscdmaSignalStrengthInfo::TdscdmaSignalStrengthInfo | ( | int | rscp | ) |
const int telux::tel::TdscdmaSignalStrengthInfo::getRscp | ( | ) | const |
Get TdScdma received signal code power in dBm.
class telux::tel::VoiceServiceInfo |
VoiceServiceInfo is a container class for obtaining serving state details like phone is registered to home network, roaming, in service, out of service or only emergency calls allowed.
Public Member Functions | |
VoiceServiceInfo (VoiceServiceState voiceServiceState, VoiceServiceDenialCause denialCause) | |
VoiceServiceState | getVoiceServiceState () |
VoiceServiceDenialCause | getVoiceServiceDenialCause () |
bool | isEmergency () |
bool | isInService () |
bool | isOutOfService () |
telux::tel::VoiceServiceInfo::VoiceServiceInfo | ( | VoiceServiceState | voiceServiceState, |
VoiceServiceDenialCause | denialCause | ||
) |
VoiceServiceState telux::tel::VoiceServiceInfo::getVoiceServiceState | ( | ) |
Get voice service state.
VoiceServiceDenialCause telux::tel::VoiceServiceInfo::getVoiceServiceDenialCause | ( | ) |
Get Voice service denial cause
bool telux::tel::VoiceServiceInfo::isEmergency | ( | ) |
Check if phone service is in emergency mode (i.e Only emergency numbers are allowed)
bool telux::tel::VoiceServiceInfo::isInService | ( | ) |
Check if phone is registered to home network or roaming network, phone is in service mode
bool telux::tel::VoiceServiceInfo::isOutOfService | ( | ) |
check if phone not registered, phone is in out of service mode
|
strong |
|
strong |
ECall Variant
|
strong |
|
strong |
|
strong |
Represents a vehicle class as per European eCall MSD standard. i.e. EN 15722.
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
Defines the service states
|
strong |
Defines all available radio access technologies
|
strong |
|
strong |
|
strong |
Defines operating modes of the device.
|
strong |
Defines all the signal levels that SignalStrength class can return where level 1 is low and level 5 is high.
Enumerator | |
---|---|
LEVEL_1 | |
LEVEL_2 | |
LEVEL_3 | |
LEVEL_4 | |
LEVEL_5 | |
LEVEL_UNKNOWN |
|
strong |
Defines the voice service states
|
strong |
Defines the voice service denial cause why voice service state registration was denied See 3GPP TS 24.008, 10.5.3.6 and Annex G.