diff options
| author | Gilles Boccon-Gibod <boccongibod@google.com> | 2024-02-12 21:22:14 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-02-12 21:22:14 -0800 |
| commit | de8f3d9c1e682fb8076f3785c8011bb1c0c2b1bd (patch) | |
| tree | e36e26e9b7ae563fd7992b10029f21644018e548 | |
| parent | 02180088b3898fa1f5889cdfaeb1abaf67720f6e (diff) | |
| parent | cde6d48690eabb2590ffb3d8c7503cd1b031477b (diff) | |
| download | bumble-de8f3d9c1e682fb8076f3785c8011bb1c0c2b1bd.tar.gz | |
Merge pull request #426 from akuker/patch-1
Add clarification to short circuit list feature
| -rw-r--r-- | docs/mkdocs/src/apps_and_tools/hci_bridge.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/mkdocs/src/apps_and_tools/hci_bridge.md b/docs/mkdocs/src/apps_and_tools/hci_bridge.md index d0ea1fc..9b39c94 100644 --- a/docs/mkdocs/src/apps_and_tools/hci_bridge.md +++ b/docs/mkdocs/src/apps_and_tools/hci_bridge.md @@ -12,12 +12,25 @@ a host that send custom HCI commands that the controller may not understand. ``` python hci_bridge.py <host-transport-spec> <controller-transport-spec> [command-short-circuit-list] ``` + The command-short-circuit-list field is specified by a series of comma separated Opcode Group + Field (OGF) : OpCode Command Field (OCF) pairs. The OGF/OCF values are specified in the Blutooth + core specification. + + For the commands that are listed in the short-circuit-list, the HCI bridge will always generate + a Command Complete Event for the specified op code. The return parameter will be HCI_SUCCESS. + + This feature can only be used for commands that return Command Complete. Other events will not be + generated by the HCI bridge tool. !!! example "UDP to Serial" ``` python hci_bridge.py udp:0.0.0.0:9000,127.0.0.1:9001 serial:/dev/tty.usbmodem0006839912171,1000000 0x3f:0x0070,0x3f:0x0074,0x3f:0x0077,0x3f:0x0078 ``` + In this example, the short circuit list is specified to respond to the Vendor-specific Opcode Group + Field (0x3f) commands 0x70, 0x74, 0x77, 0x78 with Command Complete. The short circuit list can be + used where the Host uses some HCI commands that are not supported/implemented by the Controller. + !!! example "PTY to Link Relay" ``` python hci_bridge.py serial:emulated_uart_pty,1000000 link-relay:ws://127.0.0.1:10723/test @@ -28,3 +41,4 @@ a host that send custom HCI commands that the controller may not understand. (through which the communication with other virtual controllers will be mediated). NOTE: this assumes you're running a Link Relay on port `10723`. + |