mirror of git://git.sysmocom.de/ofono
151 lines
4.3 KiB
Plaintext
151 lines
4.3 KiB
Plaintext
Network Monitor hierarchy
|
|
=========================
|
|
|
|
Service org.ofono
|
|
Interface org.ofono.NetworkMonitor
|
|
Object path [variable prefix]/{modem0,modem1,...}
|
|
|
|
Methods a{sv} GetServingCellInformation()
|
|
|
|
Requests the latest serving cell information and basic
|
|
measurements from oFono. The returned value is a
|
|
dictionary with the possible key / values documented
|
|
below. The type of cell is given by the 'Technology'
|
|
property.
|
|
|
|
Based on the type of cell, the dictionary will contain
|
|
additional key/value pairs. If a given key/value pair
|
|
is not present, then it is not known or unsupported
|
|
by the underlying driver.
|
|
|
|
Refer to the sections below for which property types
|
|
are available, their valid value ranges and
|
|
applicability to different cell types.
|
|
|
|
void RegisterAgent(object path)
|
|
|
|
Registers an agent which will be called whenever the
|
|
modem registers to or moves to a new cell.
|
|
|
|
void UnregisterAgent(object path)
|
|
|
|
Unregisters an agent.
|
|
|
|
NetworkMonitorAgent Hierarchy [experimental]
|
|
=============================
|
|
|
|
Service unique name
|
|
Interface org.ofono.NetworkMonitorAgent
|
|
Object path freely definable
|
|
|
|
Methods void ServingCellInformationChanged(a{sv}) [noreply]
|
|
|
|
This method is called whenever the serving cell
|
|
information has been updated.
|
|
|
|
Possible Errors: None
|
|
|
|
void Release() [noreply]
|
|
|
|
Agent is being released, possibly because of oFono
|
|
terminating, NetworkMonitor interface is being torn
|
|
down or modem off. No UnregisterAgent call is needed.
|
|
|
|
Network Monitor Property Types
|
|
==============================
|
|
|
|
string Technology
|
|
|
|
Contains the cell type. Possible values are:
|
|
"gsm", "umts", "lte"
|
|
|
|
uint16 LocationAreaCode [optional, gsm, umts]
|
|
|
|
Contains the current location area code. Valid range of values is
|
|
0-65535.
|
|
|
|
uint32 CellId [optional, gsm, umts]
|
|
|
|
Contains the current network cell id. Valid range of values is
|
|
0-65535 for gsm and 0-268435455 in umts.
|
|
|
|
string MobileNetworkCode [optional, gsm, umts]
|
|
|
|
Contains the MNC of the cell.
|
|
|
|
string MobileCountryCode [optional, gsm, umts]
|
|
|
|
Contains the MCC of the cell.
|
|
|
|
uint16 ARFCN [optional, gsm]
|
|
|
|
Contains the Absolute Radio Frequency Channel Number. Valid range of
|
|
values is 0-1023.
|
|
|
|
byte ReceivedSignalStrength [optional, gsm]
|
|
|
|
Contains the received signal strength level in dBm. Refer to <rxlev>
|
|
in 27.007, Section 8.69 for more details. Valid range of values is
|
|
0-63.
|
|
|
|
byte BSIC [optional, gsm]
|
|
|
|
Contains the Base Station Identity Code. Valid range of values is 0-63.
|
|
|
|
byte BitErrorRate [optional, gsm]
|
|
|
|
Contains the bit error rate. Refer to <ber> in 27.007, Section 8.69
|
|
for more details. Valid range of values is 0-7.
|
|
|
|
uint16 PrimaryScramblingCode [optional, umts]
|
|
|
|
Contains the scrambling code. Valid range of values is 0-512.
|
|
|
|
byte TimingAdvance [optional, gsm]
|
|
|
|
Contains the Timing Advance. Valid range of values is 0-219.
|
|
|
|
byte Strength [optional, gsm, umts, lte]
|
|
|
|
Contains the signal strength. Valid values are 0-31. Refer to <rssi>
|
|
in 27.007, Section 8.5.
|
|
|
|
byte ReceivedSignalCodePower [optional, umts]
|
|
|
|
Contains the Received Signal Code Power. Valid range of values
|
|
is 0-96. Refer to <rscp> in 27.007, Section 8.69 for more details.
|
|
|
|
byte ReceivedEnergyRatio [optional, umts]
|
|
|
|
Contains the Ratio of received energy per PN chip to the total
|
|
received power spectral density. Valid range of values is 0-49.
|
|
Refer to <ecno> in 27.007, Section 8.69 for more details.
|
|
|
|
byte ReferenceSignalReceivedQuality [optional, lte]
|
|
|
|
Contains the Reference Signal Received Quality. Valid range of
|
|
values is 0-34. Refer to <rsrq> in 27.007, Section 8.69 for more
|
|
details.
|
|
|
|
byte ReferenceSignalReceivedPower [optional, lte]
|
|
|
|
Contains the Reference Signal Received Power. Valid range of values
|
|
is 0-97. Refer to <rsrp> in 27.007, Section 8.69 for more details.
|
|
|
|
uint16 EARFCN [optional, lte]
|
|
|
|
Contains E-UTRA Absolute Radio Frequency Channel Number. Valid
|
|
range of values is 0-65535. Refer to Carrier frequency and
|
|
EARFCN in 36.101, Section 5.7.3 for more details.
|
|
|
|
byte EBand [optional, lte]
|
|
|
|
Contains E-UTRA operating Band. Valid range of values is 1-43.
|
|
Refer to Operating bands in 36.101, Section 5.5 for more
|
|
details.
|
|
|
|
byte ChannelQualityIndicator [optional, lte]
|
|
|
|
Contains Channel Quality Indicator. Refer to Channel Quality
|
|
Indicator definition in 36.213, Section 7.2.3 for more details.
|