summaryrefslogtreecommitdiff
path: root/doc/networkmonitor-api.txt
blob: 0d2fe3fd8d96365401ce834aaa8850bdb7cf02fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
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.


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]

	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.