Skip to content

Commit

Permalink
docs/examples: Add run_cig_setup description
Browse files Browse the repository at this point in the history
Adds basic information to the `examples` section of the documentation.
  • Loading branch information
wpiet committed Oct 2, 2024
1 parent 2fa8075 commit e16be1a
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/mkdocs/src/examples/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ An app that implements a virtual Bluetooth speaker that can receive audio.
## `run_advertiser.py`
An app that runs a simple device that just advertises (BLE).

## `run_cig_setup.py`
An app that creates a simple CIG containing two CISes. **Note**: If using the example config file (e.g. `device1.json`), the `address` needs to be removed, so that the devices are given different random addresses.

## `run_classic_connect.py`
An app that connects to a Bluetooth Classic device and prints its services.

Expand Down

0 comments on commit e16be1a

Please sign in to comment.