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

Unified 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 side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | doc/service-api.txt » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: doc/device-lowlevel-api.txt
diff --git a/doc/device-lowlevel-api.txt b/doc/device-lowlevel-api.txt
index 0b221464da5faecb53a59119d80c159267b86151..d369222d64109280ea937222bf94e821fd807d40 100644
--- a/doc/device-lowlevel-api.txt
+++ b/doc/device-lowlevel-api.txt
@@ -28,11 +28,11 @@ Methods dict GetProperties()
Possible Errors: [service].Error.InvalidArguments
- Object path AddIPConfig(string method)
+ object path AddIPConfig(string method)
Create an IPConfig element of the specified type.
The element is appended to the list of IPConfig
- elements assciated with the device.
+ elements associated with the device.
Possible values for method are:
"ipv4" (fixed IPv4 network state)
@@ -40,8 +40,10 @@ Methods dict GetProperties()
"dhcp" (IPv4 state setup using DHCP)
"bootp" (IPv4 state setup using BOOTP)
"zeroconf" (IPV4 state setup using ZeroConf)
- "dhcp6" (IPv6 state setup using DHCP6)
"ppp" (IPv4 state setup using PPP)
+ *"dhcp6" (IPv6 state setup using DHCP6)
+
+ * Not currently implemented.
Possible Errors: [service].Error.InvalidArguments
@@ -75,7 +77,7 @@ Properties string Name [readonly]
the list of networks in range. All known networks
will be still available via the Networks property.
- Changing this value doesn't change the value of the
+ Changing this value does not change the value of the
Policy property.
The value of this property can be changed by other
@@ -83,6 +85,16 @@ Properties string Name [readonly]
example would be modifications via the "ifconfig"
command line utility.
+ boolean Scanning [readonly]
+
+ Indicates that a device is currently performing a
+ network scan.
+
+ boolean Reconnect [readonly]
+
+ Indicates that the active service on this device should
+ attempt to reconnect when idle.
+
uint16 ScanInterval [readwrite]
The scan interval describes the time in seconds
@@ -96,13 +108,23 @@ Properties string Name [readonly]
of devices. Some might not support background
scanning at all.
- boolean Scanning [readonly]
+ string BgscanMethod [readwrite]
- Indicates if a device is scanning. Not all device
- types might support this. Also some hardware might
- execute background scanning without notifying the
- driver about it. Use this property only for visual
- indication.
+ A string identifying the background scan algorithm.
+ Possible values:
+ "simple" [default]
+ "learn"
+
+ uint16 BgscanShortInterval [readwrite]
+
+ Time in seconds between background scans when actively
+ searching for better APs (e.g., when roaming).
+
+ int32 BgscanSignalThreshold [readwrite]
+
+ Receive signal strength threshold (in dBm), for the
+ currently connected network, below which roaming is
+ triggered.
array{object} Networks [readonly]
@@ -138,3 +160,65 @@ Properties string Name [readonly]
a GSM modem, then this property gives the International
Mobile Subscriber Identity of the SIM card contained in
the modem.
+
+ string Cellular.ESN [readonly]
+
+ If the device type is "cellular", then this property
+ gives the Electronic Serial Number of the modem.
+
+ string Cellular.MDN [readonly]
+
+ If the device type is "cellular", then this property
+ gives the Mobile Directory Number (i.e., phone number)
+ of the modem.
+
+ string Cellular.MIN [readonly]
+
+ If the device type is "cellular", then this property
+ gives the Mobile Identification Number of the modem.
+ The MIN is often the same as the MDN, but may change if
+ a user changes to a different service provider.
+
+ string Cellular.ModelID [readonly]
+
+ If the device type is "cellular", then this property
+ identifies the hardware model of the modem. The
+ contents of this property are unspecified, and are
+ useful primarily as a diagnostic aid.
+
+ string Cellular.Manufacturer [readonly]
+
+ If the device type is "cellular", then this property
+ identifies the manufacturer of the modem. The contents
+ of this property are unspecified, and are useful
+ primarily as a diagnostic aid.
+
+ string Cellular.FirmwareRevision [readonly]
+
+ If the device type is "cellular", then this property
+ gives the revision of firmware that is loaded on the
+ modem. The contents of this property are unspecified,
+ and are useful primarily as a diagnostic aid.
+
+ string Cellular.HardwareRevision [readonly]
+
+ If the device type is "cellular", then this property
+ gives the hardware revision of the modem. The contents
+ of this property are unspecified, and are useful
+ primarily as a diagnostic aid.
+
+ string Cellular.LastDeviceUpdate [readonly]
+
+ If the device type is "cellular", then this property
+ gives the date and time, in ISO 8601 format, of the
+ last over-the-air device update that was performed. If
+ an OTA update has never occurred, this property does
+ not exist.
+
+ int16 Cellular.PRLVersion [readonly]
+
+ If the device type is "cellular", then this property
+ gives the revision of the Preferred Roaming List that
+ is loaded on the modem. It is primarily useful as a
+ diagnostic aid.
+
« 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