summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* doc/mgmt-api: Update documentation for scan_rsp param flagDaniel Winkler2021-03-221-0/+5
| | | | | | | | This patch adds the new scannable flag to the Add Extended Advertising Parameters MGMT API documentation. Reviewed-by: Alain Michaud <alainm@chromium.org> Reviewed-by: Sonny Sasaka <sonnysasaka@chromium.org>
* doc/advertising-api: Add adv SupportedFeatures to docDaniel Winkler2021-03-171-0/+18
| | | | | | Add supported features to advertising dbus api. Reviewed-by: Miao-chen Chou <mcchou@chromium.org>
* doc/mesh-api: Add notion of Device UUID complianceInga Stotland2021-02-161-3/+6
| | | | | | Add requirement that the value of Device UUID supplied in CreateNetwork/Join/Import methods should be compliant with RFC 4122.
* doc/advmon-api: Introduce sampling period propertyArchie Pusaka2021-01-151-25/+53
| | | | | The sampling period is used to align with the new MGMT opcode which also have sampling period.
* doc/mgmt-api: Add opcode for adding advertisement monitor with RSSIArchie Pusaka2020-12-211-0/+52
| | | | | | | | | | This is to leverage the filtering by RSSI feature on those controllers which supports advertisement packet filtering. To avoid changing the existing API and breaking it, a new opcode is required. Reviewed-by: Manish Mandlik <mmandlik@chromium.org> Reviewed-by: Miao-chen Chou <mcchou@chromium.org> Reviewed-by: Yun-Hao Chung <howardchung@google.com>
* doc: Fix qemu unable to mount root fs for test-runnerTedd Ho-Jeong An2020-12-081-0/+1
| | | | | | | | | | | | | | | | | | This patch fixes the kernel panic while loading the kernel image built with the current config for test-runner. Kernel panic - not syncing: VFS: Unable to mount root fs on unknown-block(0,0) CPU: 0 PID: 1 Comm: swapper Not tainted 5.10.0-rc2-702835-ged93facee36e #6 Hardware name: QEMU Standard PC (Q35 + ICH9, 2009), BIOS 1.13.0-1ubuntu1 04/01/2014 Call Trace: panic+0xee/0x27c mount_block_root+0x315/0x324 ? rest_init+0x7a/0x7a prepare_namespace+0x128/0x157 ? rest_init+0x7a/0x7a kernel_init+0x5/0xf6 ret_from_fork+0x22/0x30 Kernel Offset: 0x2a200000 from 0xffffffff81000000 (relocation range: 0xffffffff80000000-0xffffffffbf)
* doc: Add Battery Provider API docSonny Sasaka2020-11-301-0/+55
| | | | | | | | | | This patch add the documentation of the Battery Provider which lets external clients feed battery information to BlueZ if they are able to decode battery reporting via any profile. BlueZ UI clients can then use the org.bluez.Battery1 API as a single source of battery information coming from many different profiles. Reviewed-by: Miao-chen Chou <mcchou@chromium.org>
* doc/adapter-api: Add InProgess error to StartDiscoveryMichael Nosthoff2020-11-091-0/+1
|
* doc: Add tester.configLuiz Augusto von Dentz2020-11-031-0/+48
| | | | | This adds tester.config which can be used as a reference to create kernel images to be run with test-runner.
* adv_monitor: Implement RSSI filtering and content matchingManish Mandlik2020-11-021-0/+5
| | | | | | | This implements the following logic for background scanning. - Implement RSSI tracking based on high/low RSSI thresholds and timers. - Create an entry point in adapter to start the matching of Adv based on all monitors and invoke the RSSI tracking for Adv reporting.
* doc/mgmt-api: Update controller capabilities MGMT command in mgmt-apiDaniel Winkler2020-10-291-6/+15
| | | | | This patch changes Read Security Info MGMT to be called Read Controller Capabilities Command
* doc/mgmt-api: Add new Advertising MGMT interfaces to mgmt-apiDaniel Winkler2020-10-291-0/+217
| | | | | | This patch adds the following to mgmt-api: - Add Extended Advertising Parameters Command - Add Extended Advertising Data Command
* doc/advertising-api: update API with new interfaceDaniel Winkler2020-10-291-0/+48
| | | | | | | | | | | | This updates the advertising documentation to include the following features: LE Advertising Manager: - New SupportedCapabilities property LE Advertisement: - New min/max interval properties - New tx power property
* doc: Add Suspend and Resume eventsAbhishek Pandit-Subedi2020-09-171-0/+48
| | | | | | | | Add Controller Suspend Event and Controller Resume Event to identify suspend or resume of the Bluetooth stack has occurred. Also update Device Disconnected Event to indicate a new disconnect reason: "Connection terminated by local host for suspend"
* doc/gatt-api: Add new error for StartNotifyJoseph Hwang2020-09-161-0/+1
| | | | | When a device is disconnecting, StartNotify is not allowed. This adds a new error type to the doc.
* doc: Update Advertisement Monitor API descriptionMiao-chen Chou2020-09-141-9/+25
| | | | | | | | | This modifies the following description to Advertisement Monitor API. - Add org.bluez.Error.Failed to RegisterMonitor() method. - Add more description about the usage of RegisterMonitor() and UnregisterMonitor() methods. - Add description about the ranges for the fields in property RSSIThresholdsAndTimers.
* doc/media-api: Add Press/Hold/Release methods for MediaPlayer1Archie Pusaka2020-09-041-0/+29
| | | | | | | This allows us to send any passthrough command. The button can also be held for an extended amount of time. Reviewed-by: Michael Sun <michaelfsun@chromium.org>
* doc/mesh-api: Add "options" dictionary to Send/PublishInga Stotland2020-08-261-25/+35
| | | | | | | | | | | | | | | | | | This modifies Send, DevKeySend and Publish methods on mesh.Node interface to include additional argument "options". This new argument is a dictionary that currently has only one new key word defined for Send() and DevKeySend(): "ForceSegmented" - to force small payloads to be sent as one-segment messages In case of Publish(), and additional keyword is defined "Vendor" - 16-bit Company ID as defined by the Bluetooth SIG Other key words may be defined in future to accommodate evolving requirements of Mesh Profile specification. Also, the addition of "options" dictionary to Publish allows to eliminate VendorPublish() method (taken care by "Vendor" keyword).
* doc/device-api: Add WakeAllowedAbhishek Pandit-Subedi2020-07-071-0/+5
| | | | | Add documentation for WakeAllowed, which allows a device to wake the system from suspend.
* doc/mesh-api: Add dictionary to model propertiesInga Stotland2020-07-011-6/+34
| | | | | | | | | | | | | | | | | This changes the signature of "Models" and "VendorModels" properties on org.bluez.mesh.Element1 interface to contain a dictionary with model options. Models: signature change "aq" -> "a(qa{sv})" VendorModels: signature change "a(qq)" -> "a(qqa{sv})" Currently, the defined keywords for the options dictionary are "Publish" - indicates whether the model supports publication mechanism. If not present, publication is enabled. "Subscribe" - indicates whether the model supports subscription mechanism. If not present, subscriptions are enabled. The dictionary allowed to be empty.
* mesh: Replace BeaconFlags with just IvUpdateMichał Lowas-Rzechonek2020-06-181-4/+4
| | | | | | | | To import nodes, applications need just IvIndex and IvUpdate. KeyRefresh phase in under provisioner's control, so we don't need to expose it. Moreover, BeaconFlags property dealt just with the primary net key, and each subnet key is refreshed separately.
* main: Add configurable le autoconnect timeout valueAlain Michaud2020-06-171-0/+1
| | | | This patch adds support for a configurable le autoconnect timer.
* mesh: Rename IVUpdate import flag to IvUpdateMichał Lowas-Rzechonek2020-06-161-1/+1
| | | | Name change for consistency with "IvIndex" property.
* doc: Fix minor typoMarcel Holtmann2020-06-121-1/+1
|
* doc: Describe the new Advertisement Monitor supportMiao-chen Chou2020-06-101-2/+150
| | | | | | | | | | | | This describes the following commands and event. - Read Advertisement Monitor Features command - Add Advertisement Patterns Monitor command - Remove Advertisement Monitor command - Advertisement Monitor Added event - Advertisement Monitor Removed event Note that the content of a monitor can differ based on its type. For now we introduce only pattern-based monitor, so you may find that unlike the command of removing monitor(s), the Add command is tied to a specific type.
* mesh: Add "node is busy" check for Leave() & Attach()Inga Stotland2020-06-101-0/+3
| | | | | | | | | | | | | | | This introduces the following behavior change for those methods on Network interface that specify node token as an input parameter Leave() method: If Leave method is called for a node that is being processed as a result of a Create, Import, Join or Attach method calls in progress, node removal is not allowed and org.bluez.mesh.Error.Busy error is returned. Attach() method: If Attach method is called for a node that is being processed as a result of a Create, Import or Join method calls in progress, node attachment is not allowed and org.bluez.mesh.Error.Busy error is returned.
* mesh: Make "Busy" and "InProgress" to be distinct errorsInga Stotland2020-06-101-1/+1
| | | | | | | | | This separates "Busy" and "InProgress" error codes: MESH_ERROR_IN_PROGRESS maps to org.bluez.mesh.Error.InProgress MESH_ERROR_BUSY maps to org.bluez.mesh.Error.Busy Minor API change: UpdateAppKey() returns "InProgress" error instead of "Busy"
* doc: Fix typo for Set Device Class command descriptionMarcel Holtmann2020-06-101-2/+2
|
* doc: Add commands and event for handling device flagsMarcel Holtmann2020-06-101-1/+98
|
* doc: Add the event for default configuration changesMarcel Holtmann2020-06-101-2/+51
|
* doc: Mention mgmt version 1.18 changesMarcel Holtmann2020-06-101-1/+6
|
* doc: Add commands for reading and changing runtime parametersMarcel Holtmann2020-06-101-0/+64
|
* doc: adding definitions for load default params mgmt opAlain Michaud2020-06-101-0/+90
| | | | | | | | | | | | This change adds the definition for the read/set default parameter commands. In particular, these commands are used to read and set the system default parameters. The use of a TLV format also ensures that parameters are expandable in the future. This will allow bluetoothd to load parameters from a conf file that may be customized for the specific requirements of each platforms.
* doc/settings-storage: Update documentation of EndpointsLuiz Augusto von Dentz2020-05-211-3/+4
| | | | | Add documentation of DelayReporting storage as that has been added to the cache.
* doc/media-api: Add documentation for DelayReportingLuiz Augusto von Dentz2020-05-211-0/+4
| | | | | | The code was expecting the endpoint to expose MediaEndpoint.DelayReporting property in order to expose MediaTransport.Delay property.
* doc: Add information about management version 1.17Marcel Holtmann2020-05-201-1/+6
|
* doc/advertisement-monitor-api: Rename methods and shorten the preset stringsMiao-chen Chou2020-05-181-4/+4
| | | | | | This renames RegisterApplication/UnregisterApplication to RegisterMonitor/UnregisterMonitor and shortens the strings used in some properties.
* doc: Add reading and setting experimental features commandsMarcel Holtmann2020-05-061-0/+97
|
* doc: Update assigned-numbers.txtPali Rohár2020-05-041-0/+2
| | | | Define missing rfcomm channels specified in src/profile.c
* doc: Add missing empty lineMarcel Holtmann2020-05-011-0/+1
|
* doc: Add Advertisement Monitoring APIMiao-chen Chou2020-04-271-0/+137
| | | | | | This patch proposes an Advertisement Monitoring API for an application to register a job of monitoring ADV reports with content filter and RSSI thresholds.
* doc/adapter-api: Add Roles propertyAlain Michaud2020-04-271-0/+8
| | | | | | | This change adds a new property to indicate the support for concurrent roles which means that the controller has reported the appropriate LE_Supported_States (hdev->le_states) and that the controller's driver has reported correctly handling the various reported states.
* doc: Update documentation for HSP and HFP profilesPali Rohár2020-04-141-2/+25
| | | | | Fix information about default rfcomm channel number in HFP HS role (it is 7, not 6) and add documentation about default values.
* doc/mesh: Change API to deliver tokens via JoinCompleteMichał Lowas-Rzechonek2020-04-141-13/+17
| | | | | | | | | If Application is not be able to reliably store the token, the daemon will end up with a uncontrollable node in its database. Let's fix the issue by always delivering tokens using JoinComplete call, and expecting a reply - if the application return an error, daemon will get rid of the node.
* doc: Define bus controller value for VIRTIO transportMarcel Holtmann2020-04-041-0/+1
|
* doc: Add Read Security Information command descriptionMarcel Holtmann2020-04-021-0/+43
|
* doc/mesh-api: OOB Information field is 16 bit, not 32Michał Lowas-Rzechonek2020-04-011-1/+1
|
* doc/mesh-api: Forward compatibility modificationsInga Stotland2020-03-301-7/+21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | The following methods are modified to allow for future development: Interface org.bluez.mesh.Management1: Old: void UnprovisionedScan(uint16 seconds) New: void UnprovisionedScan(dict options) The options parameter is a dictionary with the following keys defined: uint16 Seconds Specifies number of seconds for scanning to be active. If set to 0 or if this key is not present, then the scanning will continue until UnprovisionedScanCancel() or AddNode() methods are called. other keys TBD Old: void AddNode(array{byte}[16] uuid) New: void AddNode(array{byte}[16] uuid, dict options) The options parameter is currently an empty dictionary Interface org.bluez.mesh.Provisioner1 Old: void ScanResult(int16 rssi, array{byte} data) New: void ScanResult(int16 rssi, array{byte} data, dict options) The options parameter is currently an empty dictionary
* doc: Mention the Wideband Speech setting and add new kernel versionMarcel Holtmann2020-03-081-0/+4
|
* doc: Add settings and command for Wideband Speech supportMarcel Holtmann2020-03-041-0/+36
|