run_csis_servers: Update usage and add docs entry

Amends the usage of the script and the example that show when executed incorrectly.
Adds basic information to the `examples` section of the documentation.
This commit is contained in:
Wojciech Pietraszewski
2024-09-27 17:09:08 +02:00
parent 7b34bb4050
commit 669bb3f3a8
2 changed files with 5 additions and 5 deletions

View File

@@ -42,6 +42,9 @@ An app that connected to a device (BLE) and encrypts the connection.
## `run_controller.py`
Creates two linked controllers, attaches one to a transport, and the other to a local host with a GATT server application. This can be used, for example, to attach a virtual controller to a native stack, like BlueZ on Linux, and use the native tools, like `bluetoothctl`, to scan and connect to the GATT server included in the example.
## `run_csis_servers.py`
Runs CSIS servers on two devices to form a Coordinated Set. **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_gatt_client_and_server.py`
Runs a local GATT server and GATT client, connected to each other. The GATT client discovers and logs all the services and characteristics exposed by the GATT server

View File

@@ -38,13 +38,10 @@ from bumble.transport import open_transport_or_link
async def main() -> None:
if len(sys.argv) < 3:
print(
'Usage: run_cig_setup.py <config-file>'
'Usage: run_csis_servers.py <config-file> '
'<transport-spec-for-device-1> <transport-spec-for-device-2>'
)
print(
'example: run_cig_setup.py device1.json'
'tcp-client:127.0.0.1:6402 tcp-client:127.0.0.1:6402'
)
print('example: run_csis_servers.py device1.json ' 'hci-socket:0 hci-socket:1')
return
print('<<< connecting to HCI...')