summaryrefslogtreecommitdiff
path: root/introspection/nm-device-wifi.xml
blob: b94aae846128383f836bfba0e3e45db36e716a4f (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
<?xml version="1.0" encoding="UTF-8" ?>

<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
  <interface name="org.freedesktop.NetworkManager.Device.Wireless">
    <annotation name="org.gtk.GDBus.C.Name" value="DeviceWifi"/>

    <method name="GetAccessPoints">
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_device_get_access_points"/>
      <arg name="access_points" type="ao" direction="out">
        <tp:docstring>
          List of access point object paths.
        </tp:docstring>
      </arg>
      <tp:docstring>
        DEPRECATED.  Get the list of access points visible to this device.  Note
        that this list does not include access points which hide their SSID.  To
        retrieve a list of all access points (including hidden ones) use the
        GetAllAccessPoints() method.
      </tp:docstring>
    </method>

    <method name="GetAllAccessPoints">
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_device_get_all_access_points"/>
      <arg name="access_points" type="ao" direction="out">
        <tp:docstring>
          List of access point object paths.
        </tp:docstring>
      </arg>
      <tp:docstring>
        Get the list of all access points visible to this device, including
        hidden ones for which the SSID is not yet known.
      </tp:docstring>
    </method>

    <method name="RequestScan">
      <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_device_request_scan"/>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="options" type="a{sv}" direction="in">
        <tp:docstring>
          Options of scan.
          Currently 'ssids' option with value of "aay" type is supported.
        </tp:docstring>
      </arg>
      <tp:docstring>
        Request the device to scan
      </tp:docstring>
    </method>

    <property name="HwAddress" type="s" access="read">
      <tp:docstring>
        The active hardware address of the device.
      </tp:docstring>
    </property>

    <property name="PermHwAddress" type="s" access="read">
      <tp:docstring>
        The permanent hardware address of the device.
      </tp:docstring>
    </property>

    <property name="Mode" type="u" access="read" tp:type="NM_802_11_MODE">
      <tp:docstring>
        The operating mode of the wireless device.
      </tp:docstring>
    </property>

    <property name="Bitrate" type="u" access="read">
      <tp:docstring>
        The bit rate currently used by the wireless device, in kilobits/second (Kb/s).
      </tp:docstring>
    </property>

    <property name="AccessPoints" type="ao" access="read">
      <tp:docstring>
        List of object paths of access point visible to this wireless device.
      </tp:docstring>
    </property>

    <property name="ActiveAccessPoint" type="o" access="read">
      <tp:docstring>
        Object path of the access point currently used by the wireless device.
      </tp:docstring>
    </property>

    <property name="WirelessCapabilities" type="u" access="read" tp:type="NM_802_11_DEVICE_CAP">
      <tp:docstring>
        The capabilities of the wireless device.
      </tp:docstring>
    </property>

    <signal name="PropertiesChanged">
        <arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
            <tp:docstring>
                A dictionary containing the FIXME: check changed parameters.
            </tp:docstring>
        </arg>
        <tp:docstring>
            Emitted when the wireless device's properties changed.
        </tp:docstring>
    </signal>

    <signal name="AccessPointAdded">
        <arg name="access_point" type="o">
            <tp:docstring>
                The object path of the newly found access point.
            </tp:docstring>
        </arg>
        <tp:docstring>
            Emitted when a new access point is found by the device.
        </tp:docstring>
    </signal>

    <signal name="AccessPointRemoved">
      <arg name="access_point" type="o">
            <tp:docstring>
                The object path of the access point that has disappeared.
            </tp:docstring>
        </arg>
        <tp:docstring>
            Emitted when an access point disappears from view of the device.
        </tp:docstring>
    </signal>

    <tp:flags name="NM_802_11_DEVICE_CAP" type="u">
      <tp:docstring>
        Flags describing the capabilities of a wireless device.
      </tp:docstring>
      <tp:flag suffix="NONE" value="0x0">
        <tp:docstring>Null capability - syntactic sugar for no capabilities supported.  Do not AND this with other capabilities!</tp:docstring>
      </tp:flag>
      <tp:flag suffix="CIPHER_WEP40" value="0x1">
        <tp:docstring>The device supports the 40-bit WEP cipher.</tp:docstring>
      </tp:flag>
      <tp:flag suffix="CIPHER_WEP104" value="0x2">
        <tp:docstring>The device supports the 104-bit WEP cipher.</tp:docstring>
      </tp:flag>
      <tp:flag suffix="CIPHER_TKIP" value="0x4">
        <tp:docstring>The device supports the TKIP cipher.</tp:docstring>
      </tp:flag>
      <tp:flag suffix="CIPHER_CCMP" value="0x8">
        <tp:docstring>The device supports the CCMP cipher.</tp:docstring>
      </tp:flag>
      <tp:flag suffix="WPA" value="0x10">
        <tp:docstring>The device supports the WPA encryption/authentication protocol.</tp:docstring>
      </tp:flag>
      <tp:flag suffix="RSN" value="0x20">
        <tp:docstring>The device supports the RSN encryption/authentication protocol.</tp:docstring>
      </tp:flag>
      <tp:flag suffix="AP" value="0x40">
        <tp:docstring>The device supports Access Point mode.</tp:docstring>
      </tp:flag>
      <tp:flag suffix="ADHOC" value="0x80">
        <tp:docstring>The device supports Ad-Hoc mode.</tp:docstring>
      </tp:flag>
      <tp:flag suffix="FREQ_VALID" value="0x100">
	<tp:docstring>
	  The device properly reports information about supported
	  frequencies and thus both NM_802_11_DEVICE_CAP_FREQ_2GHZ and
	  NM_802_11_DEVICE_CAP_FREQ_5GHZ are valid.
	</tp:docstring>
      </tp:flag>
      <tp:flag suffix="FREQ_2GHZ" value="0x200">
        <tp:docstring>
          The device supports 2.4GHz frequencies.
        </tp:docstring>
      </tp:flag>
      <tp:flag suffix="FREQ_5GHZ" value="0x400">
        <tp:docstring>
          The device supports 5GHz frequencies.
        </tp:docstring>
      </tp:flag>
    </tp:flags>
  </interface>
</node>