1Floss
2======
3
4TODO: Fill in some more information about the Floss service
5
6# DBus API
7
8## Methods
9
10The Floss DBus API is created by Rust macro and the exact definition is spread
11out across multiple source files. In general, you can find relevant information
12in a few places:
13
14- Destination: this is always `org.chromium.bluetooth`
15- Interface name: these are defined in each service's source file. For example,
16  `BatteryProviderManager` has a DBus definition in
17  `src/iface_battery_provider_manager.rs` and it's interface name is defined
18  above `impl IBatteryProviderManager for IBatteryProviderManagerDBus`
19  (`org.chromium.bluetooth.BatteryProviderManager`).
20- Method name: these are also defined in the service source file, above the Rust
21  method implementation. Following the above example, just before the
22  `register_battery_provider` implementation is the declaration of its
23  corresponding DBus method (`RegisterBatteryProvider`)
24- Object path: these are defined in `src/interface_manager.rs`. For most
25  services this is going to be `/org/chromium/bluetooth/hci{index}/{service}`
26  where `{index}` depends on which adapter is being used and `{service}` is
27  defined in `interface_manager.rs`.
28
29## Objects
30
31TODO: Explain the typical object structure
32
33## Full API
34
35TODO: List out all of the API
36