summaryrefslogtreecommitdiff
path: root/doc/networkmonitor-api.txt
blob: af56f04b1fc2e4059519c6c118e3e9155c8bfa0f (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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
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.

			a{a{sv}} GetNeighbouringCellsInformation()

			Requests the neighbouring cells 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, lte]

	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.

uint16 PhysicalCellId [optional, lte]

    Contains Physical Cell Id.  Valid range of values is 0-503.

uint16 TrackingAreaCode [optional, lte]

	Contains Tracking Area Code.  Valid range of values is 0-65535.

int32 SingalToNoiseRatio [optional, lte]

    Contains Signal To Noise Ratio.  Valid range of values is -200 to +300.
    The value is in 0.1 dB units. (-200 = -20.0 dB, +300 = 30dB)
    Refer to <snr> in 36.101, Section 8.1.1 for more details.