Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(83)

Side by Side Diff: doc/device-lowlevel-api.txt

Issue 3547005: Documentation update: device-lowlevel-api and service-api (Closed) Base URL: ssh://git@gitrw.chromium.org:9222/flimflam.git
Patch Set: Minor typo Created 10 years, 2 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « no previous file | doc/service-api.txt » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 Device hierarchy 1 Device hierarchy
2 ================ 2 ================
3 3
4 Service org.chromium.flimflam 4 Service org.chromium.flimflam
5 Interface org.chromium.flimflam.Device 5 Interface org.chromium.flimflam.Device
6 Object path [variable prefix]/{device0,device1,...} 6 Object path [variable prefix]/{device0,device1,...}
7 7
8 Methods dict GetProperties() 8 Methods dict GetProperties()
9 9
10 Returns properties for the device object. See 10 Returns properties for the device object. See
(...skipping 10 matching lines...) Expand all
21 21
22 Possible Errors: [service].Error.InvalidArguments 22 Possible Errors: [service].Error.InvalidArguments
23 [service].Error.InvalidProperty 23 [service].Error.InvalidProperty
24 24
25 void ProposeScan() 25 void ProposeScan()
26 26
27 Proposes to trigger a scan transaction. 27 Proposes to trigger a scan transaction.
28 28
29 Possible Errors: [service].Error.InvalidArguments 29 Possible Errors: [service].Error.InvalidArguments
30 30
31 » » Object path AddIPConfig(string method) 31 » » object path AddIPConfig(string method)
32 32
33 Create an IPConfig element of the specified type. 33 Create an IPConfig element of the specified type.
34 The element is appended to the list of IPConfig 34 The element is appended to the list of IPConfig
35 » » » elements assciated with the device. 35 » » » elements associated with the device.
36 36
37 Possible values for method are: 37 Possible values for method are:
38 "ipv4" (fixed IPv4 network state) 38 "ipv4" (fixed IPv4 network state)
39 "ipv6" (fixed IPv6 network state) 39 "ipv6" (fixed IPv6 network state)
40 "dhcp" (IPv4 state setup using DHCP) 40 "dhcp" (IPv4 state setup using DHCP)
41 "bootp" (IPv4 state setup using BOOTP) 41 "bootp" (IPv4 state setup using BOOTP)
42 "zeroconf" (IPV4 state setup using ZeroConf) 42 "zeroconf" (IPV4 state setup using ZeroConf)
43 "dhcp6" (IPv6 state setup using DHCP6)
44 "ppp" (IPv4 state setup using PPP) 43 "ppp" (IPv4 state setup using PPP)
44 *"dhcp6" (IPv6 state setup using DHCP6)
45
46 * Not currently implemented.
45 47
46 Possible Errors: [service].Error.InvalidArguments 48 Possible Errors: [service].Error.InvalidArguments
47 49
48 Signals PropertyChanged(string name, variant value) 50 Signals PropertyChanged(string name, variant value)
49 51
50 This signal indicates a changed value of the given 52 This signal indicates a changed value of the given
51 property. 53 property.
52 54
53 Properties string Name [readonly] 55 Properties string Name [readonly]
54 56
(...skipping 13 matching lines...) Expand all
68 70
69 This value is for pure informational purposes. It 71 This value is for pure informational purposes. It
70 is not guaranteed that it is always present. 72 is not guaranteed that it is always present.
71 73
72 boolean Powered [readwrite] 74 boolean Powered [readwrite]
73 75
74 Switch a device on or off. This will also modify 76 Switch a device on or off. This will also modify
75 the list of networks in range. All known networks 77 the list of networks in range. All known networks
76 will be still available via the Networks property. 78 will be still available via the Networks property.
77 79
78 » » » Changing this value doesn't change the value of the 80 » » » Changing this value does not change the value of the
79 Policy property. 81 Policy property.
80 82
81 The value of this property can be changed by other 83 The value of this property can be changed by other
82 parts of the system (including the kernel). An 84 parts of the system (including the kernel). An
83 example would be modifications via the "ifconfig" 85 example would be modifications via the "ifconfig"
84 command line utility. 86 command line utility.
85 87
88 boolean Scanning [readonly]
89
90 Indicates that a device is currently performing a
91 network scan.
92
93 boolean Reconnect [readonly]
94
95 Indicates that the active service on this device should
96 attempt to reconnect when idle.
97
86 uint16 ScanInterval [readwrite] 98 uint16 ScanInterval [readwrite]
87 99
88 The scan interval describes the time in seconds 100 The scan interval describes the time in seconds
89 between automated scan attempts. Setting this 101 between automated scan attempts. Setting this
90 value to 0 will disable the background scanning. 102 value to 0 will disable the background scanning.
91 103
92 The default value is 300 and so every 5 minutes 104 The default value is 300 and so every 5 minutes
93 a scan procedure will be triggered. 105 a scan procedure will be triggered.
94 106
95 This property is not available with all types 107 This property is not available with all types
96 of devices. Some might not support background 108 of devices. Some might not support background
97 scanning at all. 109 scanning at all.
98 110
99 » » boolean Scanning [readonly] 111 » » string BgscanMethod [readwrite]
100 112
101 » » » Indicates if a device is scanning. Not all device 113 » » » A string identifying the background scan algorithm.
102 » » » types might support this. Also some hardware might 114 » » » Possible values:
103 » » » execute background scanning without notifying the 115 » » » » "simple" [default]
104 » » » driver about it. Use this property only for visual 116 » » » » "learn"
105 » » » indication. 117
118 » » uint16 BgscanShortInterval [readwrite]
119
120 » » » Time in seconds between background scans when actively
121 » » » searching for better APs (e.g., when roaming).
122
123 » » int32 BgscanSignalThreshold [readwrite]
124
125 » » » Receive signal strength threshold (in dBm), for the
126 » » » currently connected network, below which roaming is
127 » » » triggered.
106 128
107 array{object} Networks [readonly] 129 array{object} Networks [readonly]
108 130
109 List of networks objects paths. Every object path 131 List of networks objects paths. Every object path
110 represents a network in range or a known network. 132 represents a network in range or a known network.
111 133
112 array{object} IPConfigs [readonly] 134 array{object} IPConfigs [readonly]
113 135
114 List of IPConfig objects paths. Every object path 136 List of IPConfig objects paths. Every object path
115 represents a Layer 3 configuration record. 137 represents a Layer 3 configuration record.
(...skipping 15 matching lines...) Expand all
131 If the device type is "cellular", then this property 153 If the device type is "cellular", then this property
132 gives the International Mobile Equipment Identity 154 gives the International Mobile Equipment Identity
133 of the modem. 155 of the modem.
134 156
135 string Cellular.IMSI [readonly] 157 string Cellular.IMSI [readonly]
136 158
137 If the device type is "cellular", and the device is 159 If the device type is "cellular", and the device is
138 a GSM modem, then this property gives the International 160 a GSM modem, then this property gives the International
139 Mobile Subscriber Identity of the SIM card contained in 161 Mobile Subscriber Identity of the SIM card contained in
140 the modem. 162 the modem.
163
164 string Cellular.ESN [readonly]
165
166 If the device type is "cellular", then this property
167 gives the Electronic Serial Number of the modem.
168
169 string Cellular.MDN [readonly]
170
171 If the device type is "cellular", then this property
172 gives the Mobile Directory Number (i.e., phone number)
173 of the modem.
174
175 string Cellular.MIN [readonly]
176
177 If the device type is "cellular", then this property
178 gives the Mobile Identification Number of the modem.
179 The MIN is often the same as the MDN, but may change if
180 a user changes to a different service provider.
181
182 string Cellular.ModelID [readonly]
183
184 If the device type is "cellular", then this property
185 identifies the hardware model of the modem. The
186 contents of this property are unspecified, and are
187 useful primarily as a diagnostic aid.
188
189 string Cellular.Manufacturer [readonly]
190
191 If the device type is "cellular", then this property
192 identifies the manufacturer of the modem. The contents
193 of this property are unspecified, and are useful
194 primarily as a diagnostic aid.
195
196 string Cellular.FirmwareRevision [readonly]
197
198 If the device type is "cellular", then this property
199 gives the revision of firmware that is loaded on the
200 modem. The contents of this property are unspecified,
201 and are useful primarily as a diagnostic aid.
202
203 string Cellular.HardwareRevision [readonly]
204
205 If the device type is "cellular", then this property
206 gives the hardware revision of the modem. The contents
207 of this property are unspecified, and are useful
208 primarily as a diagnostic aid.
209
210 string Cellular.LastDeviceUpdate [readonly]
211
212 If the device type is "cellular", then this property
213 gives the date and time, in ISO 8601 format, of the
214 last over-the-air device update that was performed. If
215 an OTA update has never occurred, this property does
216 not exist.
217
218 int16 Cellular.PRLVersion [readonly]
219
220 If the device type is "cellular", then this property
221 gives the revision of the Preferred Roaming List that
222 is loaded on the modem. It is primarily useful as a
223 diagnostic aid.
224
OLDNEW
« no previous file with comments | « no previous file | doc/service-api.txt » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698