aboutsummaryrefslogtreecommitdiff
path: root/introspection/org.freedesktop.ModemManager1.Modem.Signal.xml
blob: 094cbcf8fc0549e440cc03565192d743215b798d (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
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
<?xml version="1.0" encoding="UTF-8" ?>

<!--
 ModemManager 0.8 Interface Specification

   Copyright (C) 2013 Aleksander Morgado <aleksander@gnu.org>
-->

<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.
  -->
  <interface name="org.freedesktop.ModemManager1.Modem.Signal">

    <!--
        Setup:
        @rate: refresh rate to set, in seconds. 0 to disable retrieval.

        Setup extended signal quality information retrieval.
    -->
    <method name="Setup">
      <arg name="rate" type="u" direction="in" />
    </method>

    <!--
        Rate:

        Refresh rate for the extended signal quality information updates,
        in seconds. A value of 0 disables the retrieval of the values.
    -->
    <property name="Rate" type="u" 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>
        </variablelist>
    -->
    <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>
        </variablelist>
    -->
    <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>
        </variablelist>
    -->
    <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>"ecio"</literal></term>
          <listitem>
            <para>
              The UMTS Ec/Io, in dBm, given as a floating point value
              (signature <literal>"d"</literal>).
            </para>
          </listitem>
        </varlistentry>
        </variablelist>
    -->
    <property name="Umts" type="a{sv}" access="read" />

    <!--
        Lte:

        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 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>
        </variablelist>
    -->
    <property name="Lte" type="a{sv}" access="read" />

  </interface>
</node>