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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
|
<?xml version="1.0" encoding="UTF-8" ?>
<!--
ModemManager 0.8 Interface Specification
Copyright (C) 2013-2021 Aleksander Morgado <aleksander@aleksander.es>
Copyright (C) 2021 Intel Corporation
-->
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
<!--
org.freedesktop.ModemManager1.Modem.Signal:
@short_description: The ModemManager Signal interface.
This interface provides access to extended signal quality information.
This interface will only be functional once the modem is ready to be
registered in the cellular network. 3GPP devices will require a valid
unlocked SIM card before any of the features in the interface can be
used.
There are two different ways defined to use the interface: either enabling
periodic polling (with the Setup() method), or configuring the device with
thresholds so that it reports the value updates automatically (with the
SetupThresholds() method, since 1.20).
Both Setup() and SetupThresholds() can also be used at the same time if
required, e.g. if they report different signal quality measurement types.
The thresholds and polling setup will only be in effect if the modem is
in enabled state. Changing the settings with Setup() or SetupThresholds()
is also possible while in disabled state, though.
-->
<interface name="org.freedesktop.ModemManager1.Modem.Signal">
<!--
Setup:
@rate: refresh rate to set, in seconds. Use 0 to disable periodic polling.
Enable or disable the extended signal quality information retrieval via
periodic polling.
Polling is less than optimal; a better way to be notified of extended
signal quality updates is to configure the modem to trigger the reports
when the signal changes, i.e. with SetupThresholds().
Since: 1.2
-->
<method name="Setup">
<arg name="rate" type="u" direction="in" />
</method>
<!--
SetupThresholds:
@settings: threshold values to set.
Setup thresholds so that the device itself decides when to report the
extended signal quality information updates.
The thresholds configured via this method specify the delta between
specific signal quality measurements that would trigger a report by the
modem. For example, the user may want to be notified every time the
signal RSSI changes more than 10dBm, so a value of 10 would be
configured as <literal>"rssi-threshold"</literal>.
The device may not support this kind of threshold setting, and instead
support fixed signal levels as thresholds (e.g. trigger reports when
signal RSSI crosses -90dBm). On these devices, the threshold configured
by the user as a difference between measurements is converted to fixed
signal levels automatically, depending on the expected range for each of
the configured values. E.g. if the user configures 10dBm as
<literal>"rssi-threshold"</literal>, the fixed signal levels could be
automatically set to -100dBm, -90dBm, -80dBm, -70dBm and -60dBm.
<variablelist>
<varlistentry><term><literal>"rssi-threshold"</literal></term>
<listitem>
The difference of signal RSSI measurements, in dBm, that should
trigger a signal quality report update, given as an unsigned
integer (signature <literal>"u"</literal>). Use 0 to disable this
threshold.
</listitem>
</varlistentry>
<varlistentry><term><literal>"error-rate-threshold"</literal></term>
<listitem>
A boolean value, indicating whether signal quality report updates
should be triggered when error rate measurements change (signature
<literal>"b"</literal>).
</listitem>
</varlistentry>
</variablelist>
If any of the settings is not given as input, the corresponding threshold
will be considered disabled, and device defaults will apply.
Since: 1.20
-->
<method name="SetupThresholds">
<arg name="settings" type="a{sv}" direction="in" />
</method>
<!--
Rate:
Refresh rate, in seconds, for the extended signal quality information
periodic polling, as configured via the Setup() method.
A value of 0 indicates the periodic polling is disabled.
Since: 1.2
-->
<property name="Rate" type="u" access="read" />
<!--
RssiThreshold:
The difference of signal RSSI measurements, in dBm, that should trigger
a signal quality report update.
A value of 0 indicates the threshold is disabled.
Since: 1.20
-->
<property name="RssiThreshold" type="u" access="read" />
<!--
ErrorRateThreshold:
Flag indicating whether signal quality report updates should be triggered
on error rate measurement changes.
Since: 1.20
-->
<property name="ErrorRateThreshold" type="b" access="read" />
<!--
Cdma:
Dictionary of available signal information for the CDMA1x access
technology.
This dictionary is composed of a string key, with an associated data
which contains type-specific information.
<variablelist>
<varlistentry><term><literal>"rssi"</literal></term>
<listitem>
<para>
The CDMA1x RSSI (Received Signal Strength Indication), in dBm,
given as a floating point value (signature <literal>"d"</literal>).
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>"ecio"</literal></term>
<listitem>
<para>
The CDMA1x Ec/Io, in dBm, given as a floating point value
(signature <literal>"d"</literal>).
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>"error-rate"</literal></term>
<listitem>
<para>
Frame error rate, in percentage value, given as a
floating point value (signature <literal>"d"</literal>).
Since: 1.20.
</para>
</listitem>
</varlistentry>
</variablelist>
Since: 1.2
-->
<property name="Cdma" type="a{sv}" access="read" />
<!--
Evdo:
Dictionary of available signal information for the CDMA EV-DO access
technology.
This dictionary is composed of a string key, with an associated data
which contains type-specific information.
<variablelist>
<varlistentry><term><literal>"rssi"</literal></term>
<listitem>
<para>
The CDMA EV-DO RSSI (Received Signal Strength Indication), in dBm,
given as a floating point value (signature <literal>"d"</literal>).
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>"ecio"</literal></term>
<listitem>
<para>
The CDMA EV-DO Ec/Io, in dBm, given as a floating point value
(signature <literal>"d"</literal>).
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>"sinr"</literal></term>
<listitem>
<para>
CDMA EV-DO SINR level, in dB, given as a floating point value
(signature <literal>"d"</literal>).
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>"io"</literal></term>
<listitem>
<para>
The CDMA EV-DO Io, in dBm, given as a floating point value
(signature <literal>"d"</literal>).
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>"error-rate"</literal></term>
<listitem>
<para>
Packet error rate, in percentage value, given as a
floating point value (signature <literal>"d"</literal>).
Since: 1.20.
</para>
</listitem>
</varlistentry>
</variablelist>
Since: 1.2
-->
<property name="Evdo" type="a{sv}" access="read" />
<!--
Gsm:
Dictionary of available signal information for the GSM/GPRS access
technology.
This dictionary is composed of a string key, with an associated data
which contains type-specific information.
<variablelist>
<varlistentry><term><literal>"rssi"</literal></term>
<listitem>
<para>
The GSM RSSI (Received Signal Strength Indication), in dBm,
given as a floating point value (signature <literal>"d"</literal>).
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>"error-rate"</literal></term>
<listitem>
<para>
Bit error rate (BER), in percentage value, given as a
floating point value (signature <literal>"d"</literal>).
Since: 1.20.
</para>
</listitem>
</varlistentry>
</variablelist>
Since: 1.2
-->
<property name="Gsm" type="a{sv}" access="read" />
<!--
Umts:
Dictionary of available signal information for the UMTS (WCDMA) access
technology.
This dictionary is composed of a string key, with an associated data
which contains type-specific information.
<variablelist>
<varlistentry><term><literal>"rssi"</literal></term>
<listitem>
<para>
The UMTS RSSI (Received Signal Strength Indication), in dBm,
given as a floating point value (signature <literal>"d"</literal>).
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>"rscp"</literal></term>
<listitem>
<para>
The UMTS RSCP (Received Signal Code Power), in dBm, given as a
floating point value (signature <literal>"d"</literal>).
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>"ecio"</literal></term>
<listitem>
<para>
The UMTS Ec/Io, in dB, given as a floating point value
(signature <literal>"d"</literal>).
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>"error-rate"</literal></term>
<listitem>
<para>
Block error rate (BLER), in percentage value, given as a
floating point value (signature <literal>"d"</literal>).
Since: 1.20.
</para>
</listitem>
</varlistentry>
</variablelist>
Since: 1.2
-->
<property name="Umts" type="a{sv}" access="read" />
<!--
Lte:
Dictionary of available signal information for the LTE access
technology.
This dictionary is composed of a string key, with an associated data
which contains type-specific information.
<variablelist>
<varlistentry><term><literal>"rssi"</literal></term>
<listitem>
<para>
The LTE RSSI (Received Signal Strength Indication), in dBm,
given as a floating point value (signature <literal>"d"</literal>).
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>"rsrq"</literal></term>
<listitem>
<para>
The LTE RSRQ (Reference Signal Received Quality), in dB, given as
a floating point value (signature <literal>"d"</literal>).
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>"rsrp"</literal></term>
<listitem>
<para>
The LTE RSRP (Reference Signal Received Power), in dBm, given as
a floating point value (signature <literal>"d"</literal>).
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>"snr"</literal></term>
<listitem>
<para>
The LTE S/R ratio, in dB, given as
a floating point value (signature <literal>"d"</literal>).
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>"error-rate"</literal></term>
<listitem>
<para>
Block error rate (BLER), in percentage value, given as a
floating point value (signature <literal>"d"</literal>).
Since: 1.20.
</para>
</listitem>
</varlistentry>
</variablelist>
Since: 1.2
-->
<property name="Lte" type="a{sv}" access="read" />
<!--
Nr5g:
Dictionary of available signal information for the 5G access
technology.
This dictionary is composed of a string key, with an associated data
which contains type-specific information.
<variablelist>
<varlistentry><term><literal>"rsrq"</literal></term>
<listitem>
<para>
The 5G RSRQ (Reference Signal Received Quality), in dB, given as
a floating point value (signature <literal>"d"</literal>).
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>"rsrp"</literal></term>
<listitem>
<para>
The 5G RSRP (Reference Signal Received Power), in dBm, given as
a floating point value (signature <literal>"d"</literal>).
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>"snr"</literal></term>
<listitem>
<para>
The 5G S/R ratio, in dB, given as
a floating point value (signature <literal>"d"</literal>).
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>"error-rate"</literal></term>
<listitem>
<para>
Block error rate (BLER), in percentage value, given as a
floating point value (signature <literal>"d"</literal>).
Since: 1.20.
</para>
</listitem>
</varlistentry>
</variablelist>
Since: 1.16
-->
<property name="Nr5g" type="a{sv}" access="read" />
</interface>
</node>
|
