Skip to content

Commit 4084842

Browse files
authored
Update docs to 0.7.0 (#87)
1 parent fa6b49d commit 4084842

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -182,21 +182,26 @@ Currently you can provide the following CLI arguments:
182182

183183
```console
184184
user@pi0w:~ $ bluetooth_2_usb -h
185-
usage: bluetooth_2_usb [-h] [--device_ids DEVICE_IDS] [--auto_discover] [--debug] [--log_to_file] [--log_path LOG_PATH] [--version] [--list_devices]
185+
usage: bluetooth_2_usb.py [-h] [--device_ids DEVICE_IDS] [--auto_discover] [--debug] [--log_to_file] [--log_path LOG_PATH]
186+
[--version] [--list_devices] [--grab_devices]
186187

187-
Bluetooth to USB HID relay. Handles Bluetooth keyboard and mouse events from multiple input devices and translates them to USB using Linux's gadget mode.
188+
Bluetooth to USB HID relay. Handles Bluetooth keyboard and mouse events from multiple input devices and translates them to
189+
USB using Linux's gadget mode.
188190

189191
options:
190192
-h, --help show this help message and exit
191193
--device_ids DEVICE_IDS, -i DEVICE_IDS
192-
Comma-separated list of identifiers for input devices to be relayed. An identifier is either the input device path, the MAC address or any case-insensitive substring of the device name. Default is None. Example: --device_ids '/dev/input/event2,a1:b2:c3:d4:e5:f6,0A-1B-2C-3D-4E-5F,logi'
194+
Comma-separated list of identifiers for input devices to be relayed. An identifier is either the
195+
input device path, the MAC address or any case-insensitive substring of the device name. Default is
196+
None. Example: --device_ids '/dev/input/event2,a1:b2:c3:d4:e5:f6,0A-1B-2C-3D-4E-5F,logi'
193197
--auto_discover, -a Enable auto-discovery mode. All readable input devices will be relayed automatically.
194198
--debug, -d Enable debug mode. Increases log verbosity
195199
--log_to_file, -f Add a handler that logs to file additionally to stdout.
196200
--log_path LOG_PATH, -p LOG_PATH
197201
The path of the log file. Default is /var/log/bluetooth_2_usb/bluetooth_2_usb.log.
198202
--version, -v Display the version number of this software and exit.
199203
--list_devices, -l List all available input devices and exit.
204+
--grab_devices, -g Grab the input devices, i.e., suppress any events on your relay device (RPi).
200205
```
201206

202207
### 5.3. Consuming the API from your Python code

0 commit comments

Comments
 (0)