Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Language fixes to IRK documentation #225

Merged
merged 1 commit into from
Jan 18, 2024
Merged

[DOCS] Language fixes to IRK documentation #225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 18 additions & 11 deletions docs/use/use.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,13 +196,16 @@ If enabled (default), decoded devices publish their configuration to Home Assist
- You can set the discovery name with the `-Dn` or `--discovery_name` command line argument.
- You can filter devices from discovery with the `-Df` or `--discovery_filter` argument which takes a list of device model ID to filter.
<!-- vale off -->
<!-- vale Google.Acronyms = NO -->
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.
:::tip * INFO
Apple Watch, iPhone and iPad are discovered if they're defined with their Identity MAC Address and IRK
:::tip * INFO
Home Assistant discovers an Apple Watch, iPhone, or iPad if you've configured their Identity MAC address and IRK.
:::
<!-- vale Google.Acronyms = YES -->
## Discovered device tracker timeout
:::tip NOTE
`-to TIME_UNTIL, --tracker_timeout` needs to be at least longer than TIME_BETWEEN + SCAN_DURATION to avoid any unwanted temporary offline status messages for discovered trackers.
Expand Down Expand Up @@ -237,7 +240,7 @@ sudo systemctl restart bluetooth.service
```
## Time synchronization
If you have specified the MAC addresses of [supported Bluetooth 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.
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.
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.
Expand Down Expand Up @@ -275,30 +278,34 @@ You can also specify the identity resolving key as a Base64 encoded string, such
## Getting Identity Resolving Key (IRK) for Apple Watch, iPhone and iPad
To get the Bluetooth Identity Address of an Apple device go to ***Settings*** > ***General*** > ***About*** on the device and view the MAC address stated under **Bluetooth**.
<!-- vale Google.Acronyms = NO -->
To get the Bluetooth Identity Address of an Apple device, go to ***Settings*** > ***General*** > ***About*** on the device and view the MAC address stated under **Bluetooth**.
On a Mac associated with your devices open the **Keychain Access** application and search the **login** or **iCloud** Keychain - depending on whether you have iCloud *Password and Keychain* syncing activated or not - for either Bluetooth or the identity address you got for your device as described previously.
<!-- vale Google.Acronyms = YES -->
On a Mac associated with your devices, open the **Keychain Access** application and search the **login** or **iCloud** Keychain - depending on whether you have iCloud *Password and Keychain* syncing activated or not - for either Bluetooth or the identity address you got for your device as described previously.
When you open the Keychain entry, in the Account field it should confirm the identity address as `Public AA:BB:CC:DD:EE:FF`.
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**.
![Remote IRK retrieval](../img/Theengs-IRK-extraction.png)
This remote IRK is used to launch the gateway with the public address of your device tracked.
Now use this remote IRK to launch the gateway with the public address of your device tracked.
Example:
Public address: 11:22:33:44:55:66
IRK: WERknmckjn51464saa==
* Public address: 11:22:33:44:55:66
* IRK: WERknmckjn51464saa==
```
TheengsGateway --identities 11:22:33:44:55:66 WERknmckjn51464saa==
```
As a result you can see your device information published in the connected MQTT broker under `home/TheengsGateway/BTtoMQTT/112233445566`
As a result, you can see your device information published in the connected MQTT broker under `home/TheengsGateway/BTtoMQTT/112233445566`
```
{"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}
```
<!-- vale on -->
You can now enjoy local presence tracking based on your Apple devices.
1 change: 0 additions & 1 deletion vale/styles/config/vocabularies/Theengs/accept.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ iBeacon
iCloud
ioBroker
Jeedom
M[AC|ac]
Mosquitto
MQTT
Python
Expand Down