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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: components/onc/docs/onc_spec.html

Issue 563643002: Document cellular properties (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@issue_279351_internet_options_9c
Patch Set: Created 6 years, 3 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
« no previous file with comments | « chromeos/network/onc/onc_translation_tables.cc ('k') | components/onc/onc_constants.h » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html> 1 <!DOCTYPE html>
2 <html> 2 <html>
3 <head> 3 <head>
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <link rel="stylesheet" href="onc_spec.css" > 5 <link rel="stylesheet" href="onc_spec.css" >
6 <script src="onc_spec.js"></script> 6 <script src="onc_spec.js"></script>
7 <title>Open Network Configuration Format</title> 7 <title>Open Network Configuration Format</title>
8 </head> 8 </head>
9 <body> 9 <body>
10 10
(...skipping 338 matching lines...) Expand 10 before | Expand all | Expand 10 after
349 <dt class="field">WiFi</dt> 349 <dt class="field">WiFi</dt>
350 <dd> 350 <dd>
351 <span class="field_meta"> 351 <span class="field_meta">
352 (required if <span class="field">Type</span> is 352 (required if <span class="field">Type</span> is
353 <span class="value">WiFi</span>, otherwise ignored) 353 <span class="value">WiFi</span>, otherwise ignored)
354 <span class="type">WiFi</span> 354 <span class="type">WiFi</span>
355 </span> 355 </span>
356 Wi-Fi settings. 356 Wi-Fi settings.
357 </dd> 357 </dd>
358 358
359 <dt class="field">Cellular</dt>
360 <dd>
361 <span class="field_meta">
362 (required if <span class="field">Type</span> is
363 <span class="value">Cellular</span>, otherwise ignored)
364 <span class="type">Cellular</span>
365 </span>
366 Cellular settings.
367 </dd>
368
359 <dt class="field">Type</dt> 369 <dt class="field">Type</dt>
360 <dd> 370 <dd>
361 <span class="field_meta"> 371 <span class="field_meta">
362 (required if <span class="field">Remove</span> is 372 (required if <span class="field">Remove</span> is
363 <span class="value">false</span>, otherwise ignored) 373 <span class="value">false</span>, otherwise ignored)
364 <span class="type">string</span> 374 <span class="type">string</span>
365 </span> 375 </span>
366 <span class="rule"> 376 <span class="rule">
367 <span class="rule_id"></span> 377 <span class="rule_id"></span>
368 Allowed values are <span class="value">Cellular</span>, 378 Allowed values are <span class="value">Cellular</span>,
369 <span class="value">Ethernet</span>, <span class="value">WiFi</span>, 379 <span class="value">Ethernet</span>, <span class="value">WiFi</span>,
370 and <span class="value">VPN</span>. 380 <span class="value">Cellular</span> and <span class="value">VPN</span>.
371 </span> 381 </span>
372 Indicates which kind of connection this is. 382 Indicates which kind of connection this is.
373 </dd> 383 </dd>
374 384
375 <dt class="field">ConnectionState</dt> 385 <dt class="field">ConnectionState</dt>
376 <dd> 386 <dd>
377 <span class="field_meta"> 387 <span class="field_meta">
378 (optional, read-only) 388 (optional, read-only)
379 <span class="type">string</span> 389 <span class="type">string</span>
380 </span> 390 </span>
(...skipping 1466 matching lines...) Expand 10 before | Expand all | Expand 10 after
1847 1857
1848 <p class="rule"> 1858 <p class="rule">
1849 <span class="rule_id"></span> 1859 <span class="rule_id"></span>
1850 At most one of <span class="field">ServerCARefs</span> and <span class="fiel d">ServerCARef</span> can be set. 1860 At most one of <span class="field">ServerCARefs</span> and <span class="fiel d">ServerCARef</span> can be set.
1851 </p> 1861 </p>
1852 </section> 1862 </section>
1853 1863
1854 <section> 1864 <section>
1855 <h1>Cellular Networks</h1> 1865 <h1>Cellular Networks</h1>
1856 <p> 1866 <p>
1857 This format will eventually also cover configuration of cellular network 1867 For Cellular connections, <span class="field">Type</span> must be set to
1858 technologies, however they are currently not supported. 1868 <span class="value">Cellular</span> and the
1869 field <span class="field">Cellular</span> must be set to an object of
1870 type <span class="type">Cellular</span>. Currently only used for
1871 representing an existing configuraiton; ONC configuration of
1872 of <span class="field">Cellular</span> networks is not yet supported.
1873 Contains the following fields:
1859 </p> 1874 </p>
1875
1876 <dl class="field_list">
1877 <dt class="field">APN</dt>
1878 <dd>
1879 <span class="field_meta">(optional)
1880 <span class="type">APN</span>
1881 </span>
1882 Currently active APN to be used with a GSM carrier for making data
armansito 2014/09/11 17:10:25 Spell out "Access Point Name"
stevenjb 2014/09/11 17:33:35 Except it's not just the Name, it's the "APN objec
1883 connections.
1884 </dd>
1885
1886 <dt class="field">APNList</dt>
1887 <dd>
1888 <span class="field_meta">(optional, read-only)
1889 <span class="type">array of APN</span>
1890 </span>
1891 List of available APN configurations.
1892 </dd>
1893
1894 <dt class="field">ActivationType</dt>
1895 <dd>
1896 <span class="field_meta">(optional)
1897 <span class="type">string</span>
1898 </span>
1899 Activation type.
1900 </dd>
1901
1902 <dt class="field">ActivationState</dt>
1903 <dd>
1904 <span class="field_meta">(optional, read-only)
1905 <span class="type">string</span>
1906 </span>
1907 Activation state.
armansito 2014/09/11 17:10:25 Would say "Carrier account activation state"
stevenjb 2014/09/11 17:33:35 Done.
1908 <span class="rule">
1909 <span class="rule_id"></span>Allowed values are
1910 <span class="value">Activated</span>,
1911 <span class="value">Activating</span>,
1912 <span class="value">NotActivated</span>,
1913 <span class="value">PartiallyActivated</span>
1914 </span>
1915 </dd>
1916
1917 <dt class="field">AllowRoaming</dt>
1918 <dd>
1919 <span class="field_meta">(optional)
1920 <span class="type">boolean</span>
1921 </span>
1922 Whether cellular data connections are allowed when the device is roaming.
1923 </dd>
1924
1925 <dt class="field">Carrier</dt>
1926 <dd>
1927 <span class="field_meta">(optional, read-only)
1928 <span class="type">string</span>
1929 </span>
1930 The name of the carrier for which the device is configured.
1931 </dd>
1932
1933 <dt class="field">ESN</dt>
1934 <dd>
1935 <span class="field_meta">(optional, read-only)
1936 <span class="type">string</span>
1937 </span>
1938 The Electronic Serial Number of the modem.
1939 </dd>
1940
1941 <dt class="field">Family</dt>
1942 <dd>
1943 <span class="field_meta">(optional, read-only)
1944 <span class="type">string</span>
1945 </span>
1946 Technology family.
1947 <span class="rule"><span class="rule_id"></span>
1948 Allowed values are
1949 <span class="value">CDMA</span>,
1950 <span class="value">GSM</span>
1951 </span>
1952 </dd>
1953
1954 <dt class="field">FirmwareRevision</dt>
1955 <dd>
1956 <span class="field_meta">(optional, read-only)
1957 <span class="type">string</span>
1958 </span>
1959 The revision of firmware that is loaded in the modem.
1960 </dd>
1961
1962 <dt class="field">FoundNetworks</dt>
1963 <dd>
1964 <span class="field_meta">(optional, read-only, provided only
1965 if <span class="field">Family</span> is <span class="value">GSM</span>)
armansito 2014/09/11 17:10:25 Isn't this also true for LTE during roaming?
stevenjb 2014/09/11 17:33:35 You tell me :) I based this off of what is in devi
armansito 2014/09/11 17:41:04 :) I think it should apply to LTE as well. Probabl
1966 <span class="type">array of FoundNetwork</span>
1967 </span>
1968 The list of cellular netwoks found in the most recent scan operation.
1969 </dd>
1970
1971 <dt class="field">HardwareRevision</dt>
1972 <dd>
1973 <span class="field_meta">(optional, read-only)
1974 <span class="type">string</span>
1975 </span>
1976 The hardware revision of the modem.
armansito 2014/09/11 17:10:25 "modem" -> "cellular modem"?
stevenjb 2014/09/11 17:33:35 Done throughout.
1977 </dd>
1978
1979 <dt class="field">HomeProvider</dt>
1980 <dd>
1981 <span class="field_meta">(optional, read-only)
1982 <span class="type">array of CellularProvider</span>
1983 </span>
1984 Description of the operator that issued the SIM card currently installed
1985 in the modem.
1986 </dd>
1987
1988 <dt class="field">ICCID</dt>
1989 <dd>
1990 <span class="field_meta">(optional, read-only, provided only
1991 if <span class="field">Family</span> is <span class="value">GSM</span>
1992 or <span class="field">NetworkTechnology</span>
1993 is <span class="value">LTE</span>)
1994 <span class="type">string</span>
1995 </span>
1996 For GSM / LTE modems, the Integrated Circuit Card Identifer of the SIM
1997 card installed in the device.
1998 </dd>
1999
2000 <dt class="field">IMEI</dt>
2001 <dd>
2002 <span class="field_meta">(optional, read-only)
2003 <span class="type">string</span>
2004 </span>
2005 The International Mobile Equipment Identity of the modem.
2006 </dd>
2007
2008 <dt class="field">IMSI</dt>
2009 <dd>
2010 <span class="field_meta">(optional, read-only, provided only
2011 if <span class="field">Family</span> is <span class="value">GSM</span>)
2012 <span class="type">string</span>
2013 </span>
2014 For GSM modems, the International Mobile Subscriber Identity of the SIM
2015 card installed in the device.
2016 </dd>
2017
2018 <dt class="field">LastGoodAPN</dt>
2019 <dd>
2020 <span class="field_meta">(optional, read-only)
2021 <span class="type">APN</span>
2022 </span>
2023 The APN information used in the last successful connection attempt.
2024 </dd>
2025
2026 <dt class="field">Manufacturer</dt>
2027 <dd>
2028 <span class="field_meta">(optional, read-only)
2029 <span class="type">string</span>
2030 </span>
2031 The manufacturer of the modem.
2032 </dd>
2033
2034 <dt class="field">MDN</dt>
2035 <dd>
2036 <span class="field_meta">(optional)
2037 <span class="type">string</span>
2038 </span>
2039 The Mobile Directory Number (i.e., phone number) of the device.
2040 </dd>
2041
2042 <dt class="field">MEID</dt>
2043 <dd>
2044 <span class="field_meta">(optional, read-only, provided only
2045 if <span class="field">Family</span> is <span class="value">CDMA</span>)
2046 <span class="type">string</span>
2047 </span>
2048 For CDMA modems, the Mobile Equipment Identifer of the modem.
2049 </dd>
2050
2051 <dt class="field">MIN</dt>
2052 <dd>
2053 <span class="field_meta">(optional, read-only)
2054 <span class="type">string</span>
2055 </span>
2056 The Mobile Identification Number of the device.
2057 </dd>
2058
2059 <dt class="field">ModelID</dt>
2060 <dd>
2061 <span class="field_meta">(optional, read-only)
2062 <span class="type">string</span>
2063 </span>
2064 The hardware model of the modem.
2065 </dd>
2066
2067 <dt class="field">NetworkTechnology</dt>
2068 <dd>
2069 <span class="field_meta">(optional, read-only)
2070 <span class="type">string</span>
2071 </span>
2072 If the modem is registered on a network, then this is set to the
2073 network technology currently in use.
2074 <span class="rule"><span class="rule_id"></span>
2075 Allowed values are
2076 <span class="value">1xRTT</span>, <span class="value">EVDO</span>,
2077 <span class="value">GPRS</span>, <span class="value">EDGE</span>,
2078 <span class="value">UMTS</span>,
2079 <span class="value">HSPA</span>, <span class="value">HSPA+</span>,
2080 <span class="value">LTE</span>, <span class="value">LTE Advanced</span>
2081 </span>
2082 </dd>
2083
2084 <dt class="field">PRLVersion</dt>
2085 <dd>
2086 <span class="field_meta">(optional, read-only)
2087 <span class="type">integer</span>
2088 </span>
2089 The revision of the Preferred Roaming List that is loaded in the modem.
2090 </dd>
2091
2092 <dt class="field">ProviderRequiresRoaming</dt>
2093 <dd>
2094 <span class="field_meta">(optional, read-only)
2095 <span class="type">boolean</span>
2096 </span>
2097 Indicates that the cellular provider (determined based on IMSI and SPN)
2098 requires roaming.
2099 </dd>
2100
2101 <dt class="field">RoamingState</dt>
2102 <dd>
2103 <span class="field_meta">(optional, read-only)
2104 <span class="type">string</span>
2105 </span>
2106 The roaming status of the modem on the current network.
2107 </dd>
2108
2109 <dt class="field">ServingOperator</dt>
2110 <dd>
2111 <span class="field_meta">(optional, read-only, provided only
2112 if <span class="field">Family</span> is <span class="value">GSM</span>)
2113 <span class="type">CellularProvider</span>
2114 </span>
2115 Description of the operator on whose network the modem is currently
2116 registered
2117 </dd>
2118
2119 <dt class="field">SIMLockStatus</dt>
2120 <dd>
2121 <span class="field_meta">(optional, read-only, provided only
2122 if <span class="field">Family</span> is <span class="value">GSM</span>)
2123 <span class="type">SIMLockStatus</span>
2124 </span>
2125 For GSM modems, a dictionary containing two properties describing the
2126 state of the SIM card lock.
2127 </dd>
2128
2129 <dt class="field">SIMPresent</dt>
2130 <dd>
2131 <span class="field_meta">(optional, read-only, provided only
2132 if <span class="field">Family</span> is <span class="value">GSM</span>
2133 or <span class="field">NetworkTechnology</span>
2134 is <span class="value">LTE</span>)
2135 <span class="type">boolean</span>
2136 </span>
2137 For GSM or LTE modems, indicates whether a SIM card is present or not.
2138 </dd>
2139
2140 <dt class="field">SupportNetworkScan</dt>
2141 <dd>
2142 <span class="field_meta">(optional, read-only)
2143 <span class="type">boolean</span>
2144 </span>
2145 True if the cellular network supports scanning.
2146 </dd>
2147
2148 <dt class="field">SupportedCarriers</dt>
2149 <dd>
2150 <span class="field_meta">(optional, read-only)
2151 <span class="type">array of string</span>
2152 </span>
2153 A list of supported carriers.
2154 </dd>
2155
2156 </dl>
2157
2158 <p><span class="type">APN</span> type contains the following:</p>
2159 <dl class="field_list">
2160 <dt class="field">AccessPointName</dt>
2161 <dd>
2162 <span class="field_meta">(required)
2163 <span class="type">string</span>
2164 </span>
2165 The access point name used when making connections.
2166 </dd>
2167
2168 <dt class="field">Name</dt>
2169 <dd>
2170 <span class="field_meta">(optional)
2171 <span class="type">string</span>
2172 </span>
2173 Description of the APN.
2174 </dd>
2175
2176 <dt class="field">LocalizedName</dt>
2177 <dd>
2178 <span class="field_meta">(optional)
2179 <span class="type">string</span>
2180 </span>
2181 Localized description of the APN.
2182 </dd>
2183
2184 <dt class="field">Username</dt>
2185 <dd>
2186 <span class="field_meta">(optional)
2187 <span class="type">string</span>
2188 </span>
2189 Username for making connections if required.
2190 </dd>
2191
2192 <dt class="field">Password</dt>
2193 <dd>
2194 <span class="field_meta">(optional)
2195 <span class="type">string</span>
2196 </span>
2197 Password for making connections if required.
2198 </dd>
2199
2200 <dt class="field">Language</dt>
2201 <dd>
2202 <span class="field_meta">(optional, rquired if <span class="field">
2203 LocalizedName</span> is provided)
2204 <span class="type">string</span>
2205 </span>
2206 Two letter language code for Localizedname if provided.
2207 </dd>
2208 </dl>
2209
2210 <p><span class="type">FoundNetwork</span> type contains the following:</p>
2211 <dl class="field_list">
2212 <dt class="field">Status</dt>
2213 <dd>
2214 <span class="field_meta">(required)
2215 <span class="type">string</span>
2216 </span>
2217 The availability of the network.
2218 </dd>
2219
2220 <dt class="field">NetworkId</dt>
2221 <dd>
2222 <span class="field_meta">(required)
2223 <span class="type">string</span>
2224 </span>
2225 The network id in the form MCC/MNC (without the '/').
2226 </dd>
2227
2228 <dt class="field">Technology</dt>
2229 <dd>
2230 <span class="field_meta">(required)
2231 <span class="type">string</span>
2232 </span>
2233 Access technology used by the network,
2234 e.g. "GSM", "UMTS", "EDGE", "HSPA", etc.
2235 </dd>
2236
2237 <dt class="field">ShortName</dt>
2238 <dd>
2239 <span class="field_meta">(optional)
2240 <span class="type">string</span>
2241 </span>
2242 Short-format name of the network operator.
2243 </dd>
2244
2245 <dt class="field">LongName</dt>
2246 <dd>
2247 <span class="field_meta">(optional)
2248 <span class="type">string</span>
2249 </span>
2250 Long-format name of the network operator.
2251 </dd>
2252 </dl>
2253
2254 <p><span class="type">CellularProvider</span> type contains the following:</p>
2255 <dl class="field_list">
2256 <dt class="field">Name</dt>
2257 <dd>
2258 <span class="field_meta">(required)
2259 <span class="type">string</span>
2260 </span>
2261 The operator name.
2262 </dd>
2263
2264 <dt class="field">Code</dt>
2265 <dd>
2266 <span class="field_meta">(required)
2267 <span class="type">string</span>
2268 </span>
2269 The network id in the form MCC/MNC (without the '/').
2270 </dd>
2271
2272 <dt class="field">Country</dt>
2273 <dd>
2274 <span class="field_meta">(optional)
2275 <span class="type">string</span>
2276 </span>
2277 The two-letter country code.
2278 </dd>
2279 </dl>
2280
2281 <p><span class="type">SIMLockStatus</span> type contains the following:</p>
2282 <dl class="field_list">
2283 <dt class="field">LockType</dt>
2284 <dd>
2285 <span class="field_meta">(required)
2286 <span class="type">string</span>
2287 </span>
2288 Specifies the type of lock in effect, or an empty string if unlocked.
2289 <span class="rule"><span class="rule_id"></span>
2290 Allowed values are
2291 <span class="value">sim-pin</span>,
2292 <span class="value">sim-puk</span>
2293 </span>
2294 </dd>
2295
2296 <dt class="field">LockEnabled</dt>
2297 <dd>
2298 <span class="field_meta">(required)
2299 <span class="type">boolean</span>
2300 </span>
2301 Indicates whether SIM locking is enabled
2302 </dd>
2303
2304 <dt class="field">RetriesLeft</dt>
2305 <dd>
2306 <span class="field_meta">(optional)
2307 <span class="type">integer</span>
2308 </span>
2309 If <span class="field">LockType</span> is empty
2310 or <span class="value">sim-pin</span>, then this property represents
2311 the number of attempts remaining to supply a correct PIN before the
2312 PIN becomes blocked, at which point a PUK provided by the carrier would
2313 be necessary to unlock the SIM (and <span class="field">LockType</span>
2314 changes to <span class="value">sim-puk</span>).
2315 </dd>
2316 </dl>
2317
1860 </section> 2318 </section>
1861 2319
1862 <section> 2320 <section>
1863 <h1>Bluetooth / WiFi Direct Networks</h1> 2321 <h1>Bluetooth / WiFi Direct Networks</h1>
1864 <p> 2322 <p>
1865 This format will eventually also cover configuration of Bluetooth and Wi-Fi 2323 This format will eventually also cover configuration of Bluetooth and Wi-Fi
1866 Direct network technologies, however they are currently not supported. 2324 Direct network technologies, however they are currently not supported.
1867 </p> 2325 </p>
1868 </section> 2326 </section>
1869 2327
(...skipping 522 matching lines...) Expand 10 before | Expand all | Expand 10 after
2392 is transmitted or saved to disk should be secure. On client device, when 2850 is transmitted or saved to disk should be secure. On client device, when
2393 user names for connections that are user-specific are persisted to disk, 2851 user names for connections that are user-specific are persisted to disk,
2394 they should be stored in a location that is encrypted. Users can also opt in 2852 they should be stored in a location that is encrypted. Users can also opt in
2395 these cases to not save their user credentials in the config file and will 2853 these cases to not save their user credentials in the config file and will
2396 instead be prompted when they are needed. 2854 instead be prompted when they are needed.
2397 </p> 2855 </p>
2398 </section> 2856 </section>
2399 </section> 2857 </section>
2400 </body> 2858 </body>
2401 </html> 2859 </html>
OLDNEW
« no previous file with comments | « chromeos/network/onc/onc_translation_tables.cc ('k') | components/onc/onc_constants.h » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698