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

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