chromium/src
0
Fork 0
Code Activity

[CrOS Network] Update Shill/Hermes API links in README

Browse Source 
We now link directly to the API definitions instead of to documentation.
Additionally, we add links to the Hermes interfaces.

Change-Id: I2d27abd899828c8b6cb943fd8e848b9715c9da3e
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3315641
Auto-Submit: Kyle Horimoto <khorimoto@chromium.org>
Commit-Queue: Azeem Arshad <azeemarshad@chromium.org>
Reviewed-by: Azeem Arshad <azeemarshad@chromium.org>
Cr-Commit-Position: refs/heads/main@{#948234}
This commit is contained in:
Kyle Horimoto
2021-12-03 23:54:23 +00:00
committed by Chromium LUCI CQ
parent f201c80a46
commit 75e0cc8f45
1 changed files with 11 additions and 10 deletions

21
chromeos/network/README.md

@ -33,27 +33,27 @@ for VPNs.
Shill exposes 5 key interfaces used by Chrome: Shill exposes 5 key interfaces used by Chrome:
* [`flimflam.Manager`](https://source.corp.google.com/chromeos_public/src/platform2/shill/doc/manager-api.txt): * [`flimflam.Manager`](https://source.corp.google.com/chromeos_public/src/platform2/shill/dbus_bindings/org.chromium.flimflam.Manager.dbus-xml):
Allows Chrome to enable/disable a technology (e.g., turning Wi-Fi on or Allows Chrome to enable/disable a technology (e.g., turning Wi-Fi on or
off), perform a scan (e.g., look for nearby Wi-Fi networks), and configure a off), perform a scan (e.g., look for nearby Wi-Fi networks), and configure a
network (e.g., attempt to set up a Wi-Fi network with a password). network (e.g., attempt to set up a Wi-Fi network with a password).
* [`flimflam.Device`](https://source.corp.google.com/chromeos_public/src/platform2/shill/doc/device-api.txt): * [`flimflam.Device`](https://source.corp.google.com/chromeos_public/src/platform2/shill/dbus_bindings/org.chromium.flimflam.Device.dbus-xml):
A Shill "Device" refers to a connection medium (Wi-Fi, Cellular, and A Shill "Device" refers to a connection medium (Wi-Fi, Cellular, and
Ethernet are all Shill Devices). This interface allows Chrome to get or set Ethernet are all Shill Devices). This interface allows Chrome to get or set
properties of each connection medium as well as perform operations on each properties of each connection medium as well as perform operations on each
connection medium (e.g., unlocking the Cellular Device when it has a locked connection medium (e.g., unlocking the Cellular Device when it has a locked
SIM). SIM).
* [`flimflam.Service`](https://source.corp.google.com/chromeos_public/src/platform2/shill/doc/service-api.txt): * [`flimflam.Service`](https://source.corp.google.com/chromeos_public/src/platform2/shill/dbus_bindings/org.chromium.flimflam.Service.dbus-xml):
A Shill "Service" refers to an individual network (a Wi-Fi network or a A Shill "Service" refers to an individual network (a Wi-Fi network or a
cellular SIM are Shill services). This interface allows Chrome to get or set cellular SIM are Shill services). This interface allows Chrome to get or set
properties for a given network as well as initiate connections and properties for a given network as well as initiate connections and
disconnections. disconnections.
* [`flimflam.Profile`](https://source.corp.google.com/chromeos_public/src/platform2/shill/doc/profile-api.txt): * [`flimflam.Profile`](https://source.corp.google.com/chromeos_public/src/platform2/shill/dbus_bindings/org.chromium.flimflam.Profile.dbus-xml):
A Shill "Profile" refers to a grouping of services corresponding to a A Shill "Profile" refers to a grouping of services corresponding to a
logged-in user. Chrome OS allows configuration of networks as part of the logged-in user. Chrome OS allows configuration of networks as part of the
"default" (i.e., shared) Profile which is available to all users or as part "default" (i.e., shared) Profile which is available to all users or as part
of individual (i.e., per-user) Profiles. of individual (i.e., per-user) Profiles.
* [`flimflam.IPConfig`](https://source.corp.google.com/chromeos_public/src/platform2/shill/doc/ipconfig-api.txt): * [`flimflam.IPConfig`](https://source.corp.google.com/chromeos_public/src/platform2/shill/dbus_bindings/org.chromium.flimflam.IPConfig.dbus-xml):
Allows Chrome to configure IP addresses (e.g., DNS and DHCP). Allows Chrome to configure IP addresses (e.g., DNS and DHCP).
### Hermes ### Hermes
@ -71,12 +71,13 @@ been downloaded to a EUICC.
Hermes exposes 3 key interfaces used by Chrome: Hermes exposes 3 key interfaces used by Chrome:
* `Hermes.Manager`: Allows Chrome to retrieve the list of all EUICCs and to * [`Hermes.Manager`](https://source.chromium.org/chromiumos/chromiumos/codesearch/+/main:src/platform2/hermes/dbus_bindings/org.chromium.Hermes.Manager.xml): Allows Chrome to retrieve the list of all EUICCs and to
observe changes to this list. observe changes to this list.
* `Hermes.Euicc`: Allows Chrome to request pending or installed profiles for a * [`Hermes.Euicc`](https://source.chromium.org/chromiumos/chromiumos/codesearch/+/main:src/platform2/hermes/dbus_bindings/org.chromium.Hermes.Euicc.xml):
given EUICC; additionally, exposes functionality for installing and Allows Chrome to request pending or installed profiles for a given EUICC;
uninstalling profiles. additionally, exposes functionality for installing and uninstalling
* `Hermes.Profile`: Allows Chrome to enable or disable an individual profile. profiles.
* [`Hermes.Profile`](https://source.chromium.org/chromiumos/chromiumos/codesearch/+/main:src/platform2/hermes/dbus_bindings/org.chromium.Hermes.Profile.xml): Allows Chrome to enable or disable an individual profile.
A profile must be enabled in order to be used for a connection. A profile must be enabled in order to be used for a connection.
## TODO: Finish README ## TODO: Finish README