components/onc/docs/onc_spec.html - Issue 563643002: Document cellular properties

Unified 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 side-by-side diff with in-line comments

Download patch

Index: components/onc/docs/onc_spec.html

diff --git a/components/onc/docs/onc_spec.html b/components/onc/docs/onc_spec.html

index 8c331d13cb85f4d821ffd4ff3ede7c7ba1cdec1b..2bf09f81376458f2b427c96745709fb5914ae12c 100644

--- a/components/onc/docs/onc_spec.html

+++ b/components/onc/docs/onc_spec.html

@@ -356,6 +356,16 @@

Wi-Fi settings.

</dd>

+ <dt class="field">Cellular</dt>

+ <dd>

+

+ (required if Type is

+ Cellular, otherwise ignored)

+ Cellular

+

+ Cellular settings.

+ </dd>

<dd>

@@ -367,7 +377,7 @@

Allowed values are Cellular,

Ethernet, WiFi,

- and VPN.

+ Cellular and VPN.

Indicates which kind of connection this is.

</dd>

@@ -1854,9 +1864,457 @@

<h1>Cellular Networks</h1>

- This format will eventually also cover configuration of cellular network

- technologies, however they are currently not supported.

+ For Cellular connections, Type must be set to

+ Cellular and the

+ field Cellular must be set to an object of

+ type Cellular. Currently only used for

+ representing an existing configuraiton; ONC configuration of

+ of Cellular networks is not yet supported.

+ Contains the following fields:

+ <dl class="field_list">

+ <dt class="field">APN</dt>

+ <dd>

+ (optional)

+ APN

+

+ 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

+ connections.

+ </dd>

+ <dt class="field">APNList</dt>

+ <dd>

+ (optional, read-only)

+ array of APN

+

+ List of available APN configurations.

+ </dd>

+ <dt class="field">ActivationType</dt>

+ <dd>

+ (optional)

+ string

+

+ Activation type.

+ </dd>

+ <dt class="field">ActivationState</dt>

+ <dd>

+ (optional, read-only)

+ string

+

+ Activation state.

armansito 2014/09/11 17:10:25 Would say "Carrier account activation state"

stevenjb 2014/09/11 17:33:35 Done.

+

+ Allowed values are

+ Activated,

+ Activating,

+ NotActivated,

+ PartiallyActivated

+

+ </dd>

+ <dt class="field">AllowRoaming</dt>

+ <dd>

+ (optional)

+ boolean

+

+ Whether cellular data connections are allowed when the device is roaming.

+ </dd>

+ <dt class="field">Carrier</dt>

+ <dd>

+ (optional, read-only)

+ string

+

+ The name of the carrier for which the device is configured.

+ </dd>

+ <dt class="field">ESN</dt>

+ <dd>

+ (optional, read-only)

+ string

+

+ The Electronic Serial Number of the modem.

+ </dd>

+ <dt class="field">Family</dt>

+ <dd>

+ (optional, read-only)

+ string

+

+ Technology family.

+

+ Allowed values are

+ CDMA,

+ GSM

+

+ </dd>

+ <dt class="field">FirmwareRevision</dt>

+ <dd>

+ (optional, read-only)

+ string

+

+ The revision of firmware that is loaded in the modem.

+ </dd>

+ <dt class="field">FoundNetworks</dt>

+ <dd>

+ (optional, read-only, provided only

+ if Family is GSM)

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

+ array of FoundNetwork

+

+ The list of cellular netwoks found in the most recent scan operation.

+ </dd>

+ <dt class="field">HardwareRevision</dt>

+ <dd>

+ (optional, read-only)

+ string

+

+ 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.

+ </dd>

+ <dt class="field">HomeProvider</dt>

+ <dd>

+ (optional, read-only)

+ array of CellularProvider

+

+ Description of the operator that issued the SIM card currently installed

+ in the modem.

+ </dd>

+ <dt class="field">ICCID</dt>

+ <dd>

+ (optional, read-only, provided only

+ if Family is GSM

+ or NetworkTechnology

+ is LTE)

+ string

+

+ For GSM / LTE modems, the Integrated Circuit Card Identifer of the SIM

+ card installed in the device.

+ </dd>

+ <dt class="field">IMEI</dt>

+ <dd>

+ (optional, read-only)

+ string

+

+ The International Mobile Equipment Identity of the modem.

+ </dd>

+ <dt class="field">IMSI</dt>

+ <dd>

+ (optional, read-only, provided only

+ if Family is GSM)

+ string

+

+ For GSM modems, the International Mobile Subscriber Identity of the SIM

+ card installed in the device.

+ </dd>

+ <dt class="field">LastGoodAPN</dt>

+ <dd>

+ (optional, read-only)

+ APN

+

+ The APN information used in the last successful connection attempt.

+ </dd>

+ <dt class="field">Manufacturer</dt>

+ <dd>

+ (optional, read-only)

+ string

+

+ The manufacturer of the modem.

+ </dd>

+ <dt class="field">MDN</dt>

+ <dd>

+ (optional)

+ string

+

+ The Mobile Directory Number (i.e., phone number) of the device.

+ </dd>

+ <dt class="field">MEID</dt>

+ <dd>

+ (optional, read-only, provided only

+ if Family is CDMA)

+ string

+

+ For CDMA modems, the Mobile Equipment Identifer of the modem.

+ </dd>

+ <dt class="field">MIN</dt>

+ <dd>

+ (optional, read-only)

+ string

+

+ The Mobile Identification Number of the device.

+ </dd>

+ <dt class="field">ModelID</dt>

+ <dd>

+ (optional, read-only)

+ string

+

+ The hardware model of the modem.

+ </dd>

+ <dt class="field">NetworkTechnology</dt>

+ <dd>

+ (optional, read-only)

+ string

+

+ If the modem is registered on a network, then this is set to the

+ network technology currently in use.

+

+ Allowed values are

+ 1xRTT, EVDO,

+ GPRS, EDGE,

+ UMTS,

+ HSPA, HSPA+,

+ LTE, LTE Advanced

+

+ </dd>

+ <dt class="field">PRLVersion</dt>

+ <dd>

+ (optional, read-only)

+ integer

+

+ The revision of the Preferred Roaming List that is loaded in the modem.

+ </dd>

+ <dt class="field">ProviderRequiresRoaming</dt>

+ <dd>

+ (optional, read-only)

+ boolean

+

+ Indicates that the cellular provider (determined based on IMSI and SPN)

+ requires roaming.

+ </dd>

+ <dt class="field">RoamingState</dt>

+ <dd>

+ (optional, read-only)

+ string

+

+ The roaming status of the modem on the current network.

+ </dd>

+ <dt class="field">ServingOperator</dt>

+ <dd>

+ (optional, read-only, provided only

+ if Family is GSM)

+ CellularProvider

+

+ Description of the operator on whose network the modem is currently

+ registered

+ </dd>

+ <dt class="field">SIMLockStatus</dt>

+ <dd>

+ (optional, read-only, provided only

+ if Family is GSM)

+ SIMLockStatus

+

+ For GSM modems, a dictionary containing two properties describing the

+ state of the SIM card lock.

+ </dd>

+ <dt class="field">SIMPresent</dt>

+ <dd>

+ (optional, read-only, provided only

+ if Family is GSM

+ or NetworkTechnology

+ is LTE)

+ boolean

+

+ For GSM or LTE modems, indicates whether a SIM card is present or not.

+ </dd>

+ <dt class="field">SupportNetworkScan</dt>

+ <dd>

+ (optional, read-only)

+ boolean

+

+ True if the cellular network supports scanning.

+ </dd>

+ <dt class="field">SupportedCarriers</dt>

+ <dd>

+ (optional, read-only)

+ array of string

+

+ A list of supported carriers.

+ </dd>

+ </dl>

+ APN type contains the following:

+ <dl class="field_list">

+ <dt class="field">AccessPointName</dt>

+ <dd>

+ (required)

+ string

+

+ The access point name used when making connections.

+ </dd>

+ <dt class="field">Name</dt>

+ <dd>

+ (optional)

+ string

+

+ Description of the APN.

+ </dd>

+ <dt class="field">LocalizedName</dt>

+ <dd>

+ (optional)

+ string

+

+ Localized description of the APN.

+ </dd>

+ <dt class="field">Username</dt>

+ <dd>

+ (optional)

+ string

+

+ Username for making connections if required.

+ </dd>

+ <dt class="field">Password</dt>

+ <dd>

+ (optional)

+ string

+

+ Password for making connections if required.

+ </dd>

+ <dt class="field">Language</dt>

+ <dd>

+ (optional, rquired if

+ LocalizedName is provided)

+ string

+

+ Two letter language code for Localizedname if provided.

+ </dd>

+ </dl>

+ FoundNetwork type contains the following:

+ <dl class="field_list">

+ <dt class="field">Status</dt>

+ <dd>

+ (required)

+ string

+

+ The availability of the network.

+ </dd>

+ <dt class="field">NetworkId</dt>

+ <dd>

+ (required)

+ string

+

+ The network id in the form MCC/MNC (without the '/').

+ </dd>

+ <dt class="field">Technology</dt>

+ <dd>

+ (required)

+ string

+

+ Access technology used by the network,

+ e.g. "GSM", "UMTS", "EDGE", "HSPA", etc.

+ </dd>

+ <dt class="field">ShortName</dt>

+ <dd>

+ (optional)

+ string

+

+ Short-format name of the network operator.

+ </dd>

+ <dt class="field">LongName</dt>

+ <dd>

+ (optional)

+ string

+

+ Long-format name of the network operator.

+ </dd>

+ </dl>

+ CellularProvider type contains the following:

+ <dl class="field_list">

+ <dt class="field">Name</dt>

+ <dd>

+ (required)

+ string

+

+ The operator name.

+ </dd>

+ <dt class="field">Code</dt>

+ <dd>

+ (required)

+ string

+

+ The network id in the form MCC/MNC (without the '/').

+ </dd>

+ <dt class="field">Country</dt>

+ <dd>

+ (optional)

+ string

+

+ The two-letter country code.

+ </dd>

+ </dl>

+ SIMLockStatus type contains the following:

+ <dl class="field_list">

+ <dt class="field">LockType</dt>

+ <dd>

+ (required)

+ string

+

+ Specifies the type of lock in effect, or an empty string if unlocked.

+

+ Allowed values are

+ sim-pin,

+ sim-puk

+

+ </dd>

+ <dt class="field">LockEnabled</dt>

+ <dd>

+ (required)

+ boolean

+

+ Indicates whether SIM locking is enabled

+ </dd>

+ <dt class="field">RetriesLeft</dt>

+ <dd>

+ (optional)

+ integer

+

+ If LockType is empty

+ or sim-pin, then this property represents

+ the number of attempts remaining to supply a correct PIN before the

+ PIN becomes blocked, at which point a PUK provided by the carrier would

+ be necessary to unlock the SIM (and LockType

+ changes to sim-puk).

+ </dd>

+ </dl>

</section>

« no previous file with comments | « chromeos/network/onc/onc_translation_tables.cc ('k') | components/onc/onc_constants.h » ('j') | no next file with comments »