Skip to content

Commit 2aae46b

Browse files
authored
[DOCS] MAC address clarification (#289)
1 parent d66821e commit 2aae46b

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/use/use.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -114,9 +114,9 @@ options:
114114
Bluetooth adapter (e.g. hci1 on Linux)
115115
-b BLE, --ble BLE Enable (1) or disable (0) BLE (default: 1)
116116
-bk ADDRESS [BINDKEY ...], --bindkeys ADDRESS [BINDKEY ...]
117-
Device addresses and their bindkeys: ADDR1 KEY1 ADDR2 KEY2
117+
Device MAC addresses and their bindkeys: ADDR1 KEY1 ADDR2 KEY2
118118
-bl ADDRESS [ADDRESS ...], --blacklist ADDRESS [ADDRESS ...]
119-
Addresses of Bluetooth devices to ignore, all other devices are allowed
119+
MAC addresses of Bluetooth devices to ignore, all other devices are allowed
120120
-c CONFIG, --config CONFIG
121121
Path to the configuration file (default: ~/theengsgw.conf)
122122
-D DISCOVERY, --discovery DISCOVERY
@@ -131,7 +131,7 @@ options:
131131
Enable (1) or disable (0) general present/absent presence when --discovery: 0
132132
-H HOST, --host HOST MQTT host address
133133
-id ADDRESS [IRK ...], --identities ADDRESS [IRK ...]
134-
Identity addresses and their IRKs: ADDR1 IRK1 ADDR2 IRK2
134+
Identity MAC addresses and their IRKs: ADDR1 IRK1 ADDR2 IRK2
135135
-Lt LWT_TOPIC, --lwt_topic LWT_TOPIC
136136
MQTT LWT topic
137137
-ll {DEBUG,INFO,WARNING,ERROR,CRITICAL}, --log_level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
@@ -168,13 +168,13 @@ options:
168168
-tls ENABLE_TLS, --enable_tls ENABLE_TLS
169169
Enable (1) or disable (0) TLS (default: 0)
170170
-ts TIME_SYNC [TIME_SYNC ...], --time_sync TIME_SYNC [TIME_SYNC ...]
171-
Addresses of Bluetooth devices to synchronize the time
171+
MAC addresses of Bluetooth devices to synchronize the time
172172
-to TIME_UNTIL, --tracker_timeout TIME_UNTIL
173173
Seconds after which a discovered device tracker not being received is published as offline/away
174174
(default: 120)
175175
-u USER, --user USER MQTT username
176176
-wl ADDRESS [ADDRESS ...], --whitelist ADDRESS [ADDRESS ...]
177-
Addresses of Bluetooth devices to allow, all other devices are ignored
177+
MAC addresses of Bluetooth devices to allow, all other devices are ignored
178178
-ws ENABLE_WEBSOCKET, --enable_websocket ENABLE_WEBSOCKET
179179
Enable (1) or disable (0) WebSocket (default: 0)
180180
```
@@ -299,7 +299,7 @@ sudo systemctl restart bluetooth.service
299299
```
300300
301301
## Time synchronization
302-
If you have specified the Bluetooth addresses of [supported clocks](https://bluetooth-clocks.readthedocs.io/en/latest/devices.html) with the `--time_sync` argument, Theengs Gateway automatically synchronizes their time once a day. Therefore, make sure to correctly set your gateway's time.
302+
If you have specified the Bluetooth MAC addresses of [supported clocks](https://bluetooth-clocks.readthedocs.io/en/latest/devices.html) with the `--time_sync` argument, Theengs Gateway automatically synchronizes their time once a day. Therefore, make sure to correctly set your gateway's time.
303303
304304
Some Bluetooth clocks let you choose between 12-hour (AM/PM) and 24-hour format to show their time. Use the argument `--time_format 0` (default) for 24-hour format and `--time_format 1` for 12-hour format.
305305
@@ -316,7 +316,7 @@ bluetooth-clocks discover
316316
Theengs Gateway installs the `bluetooth-clocks` command as part of its dependencies.
317317
318318
## Reading encrypted advertisements
319-
If you want to read encrypted advertisements, you need to add a bindkey for each device address with the `--bindkeys` argument. For example:
319+
If you want to read encrypted advertisements, you need to add a bindkey for each device MAC address with the `--bindkeys` argument. For example:
320320
321321
```
322322
TheengsGateway --bindkeys 00:11:22:33:44:55:66 0dc540f3025b474b9ef1085e051b1add AA:BB:CC:DD:EE:FF 6385424e1b0341109942ad2a6bb42e58
@@ -325,7 +325,7 @@ TheengsGateway --bindkeys 00:11:22:33:44:55:66 0dc540f3025b474b9ef1085e051b1add
325325
Theengs Gateway then uses the bindkey `0dc540f3025b474b9ef1085e051b1add` to decrypt all advertisements from device `00:11:22:33:44:55:66` and bindkey `6385424e1b0341109942ad2a6bb42e58` for all advertisements from device `AA:BB:CC:DD:EE:FF`.
326326
327327
## Resolving random private addresses
328-
If you want to resolve random private addresses into a device's identity address, you need to add an Identity Resolving Key (IRK) for each identity address with the `--identities` argument. For example:
328+
If you want to resolve random private MAC addresses into a device's identity MAC address, you need to add an Identity Resolving Key (IRK) for each identity address with the `--identities` argument. For example:
329329
330330
```
331331
TheengsGateway --identities 00:11:22:33:44:55:66 0dc540f3025b474b9ef1085e051b1add AA:BB:CC:DD:EE:FF 6385424e1b0341109942ad2a6bb42e58
@@ -357,7 +357,7 @@ Now use this remote IRK to launch the gateway with the public address of your de
357357
358358
Example:
359359
360-
* Public address: 11:22:33:44:55:66
360+
* Public MAC address: 11:22:33:44:55:66
361361
* IRK: WERknmckjn51464saa==
362362
363363
```

0 commit comments

Comments
 (0)