Skip to content

Commit 8d20536

Browse files
authored
[DOCS] Add IRK screenshot (#224)
1 parent edc682b commit 8d20536

File tree

2 files changed

+23
-2
lines changed

2 files changed

+23
-2
lines changed

docs/img/Theengs-IRK-extraction.png

141 KB
Loading

docs/use/use.md

+23-2
Original file line numberDiff line numberDiff line change
@@ -196,10 +196,11 @@ If enabled (default), decoded devices publish their configuration to Home Assist
196196
- You can set the discovery name with the `-Dn` or `--discovery_name` command line argument.
197197
- You can filter devices from discovery with the `-Df` or `--discovery_filter` argument which takes a list of device model ID to filter.
198198
199-
The `IBEACON` and random MAC devices (`APPLE`*, `MS-CDP` and `GAEN`) are not discovered as their addresses (IDs) change over time resulting in multiple discoveries.
199+
<!-- vale off -->
200+
The `IBEACON` and random MAC devices (`APPLE`*, `MS-CDP` and `GAEN`) aren't discovered as their addresses (IDs) change over time resulting in multiple discoveries.
200201
201202
:::tip * INFO
202-
Apple Watch, iPhone and iPad will be discovered if they are defined with their Identity MAC Address and IRK
203+
Apple Watch, iPhone and iPad are discovered if they're defined with their Identity MAC Address and IRK
203204
:::
204205
205206
## Discovered device tracker timeout
@@ -281,3 +282,23 @@ On a Mac associated with your devices open the **Keychain Access** application a
281282
When you open the Keychain entry, in the Account field it should confirm the identity address as `Public AA:BB:CC:DD:EE:FF`.
282283
283284
Tick the **Show Password** checkbox and enter your macOS password to then select and copy the *whole* content of the field. Paste the content into an empty TextEdit document and look for the **Remote IRK**.
285+
286+
![Remote IRK retrieval](../img/Theengs-IRK-extraction.png)
287+
288+
This remote IRK is used to launch the gateway with the public address of your device tracked.
289+
290+
Example:
291+
Public address: 11:22:33:44:55:66
292+
IRK: WERknmckjn51464saa==
293+
294+
```
295+
TheengsGateway --identities 11:22:33:44:55:66 WERknmckjn51464saa==
296+
```
297+
298+
As a result you can see your device information published in the connected MQTT broker under `home/TheengsGateway/BTtoMQTT/112233445566`
299+
300+
```
301+
{"manufacturerdata": "2c0q1006191e7v30x6fa", "id": "11:22:33:44:55:66", "rssi": -42, "brand": "Apple", "model": "Apple iPhone/iPad", "model_id": "APPLEDEVICE", "type": "TRACK", "track": true, "unlocked": false, "distance": 0.03341741003670675}
302+
```
303+
<!-- vale on -->
304+
You can now enjoy local presence tracking based on your Apple devices.

0 commit comments

Comments
 (0)