remi/GarminHomeAssistant
1
0
Fork 0
mirror of https://github.com/house-of-abbey/GarminHomeAssistant.git synced 2025-06-15 19:08:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

preliminary doc changes

Browse Source
This commit is contained in:
Matthias Oesterheld
2024-11-12 19:35:15 +01:00
parent 0ac8e11287
commit 51d4f68688
2 changed files with 5 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -131,8 +131,7 @@ Example schema:
"name": "TV Lights Scene",
"type": "tap",
"tap_action": {
"service": "scene.turn_on",
"pin": "1234"
"service": "scene.turn_on"
}
}
]

29
examples/Templates.md
View File

@ -103,6 +103,10 @@ Here we also use the else clause as well to give proper text instead of just `on
However, users are doing this **against our advice** and asking how to operate 'covers'. This is an example of toggling a garage door open and closed with confirmation. *Do this at your own risk*.
In order to provide some additional security, users with touch devices can now choose to use a PIN confirmation when using actions annotated with `"confirm": true`.
This is activated once a PIN is configured in the application settings. The PIN needs to be a 4-digit number.
The user has 5 attempts to provide a valid PIN within 2 minutes. If too many failures have been detected during this time, the PIN dialog will be locked for 10 minutes.
Note: Only when you use the `tap_action` field do you also need to include the `entity` field. This is a change to a previous version of the application, hence the presence of the `entity` field will be ignored for backwards compatibility, and the schema will provide a warning only.
```json
@ -118,31 +122,6 @@ Note: Only when you use the `tap_action` field do you also need to include the `
}
```
In order to provide at least some kind of additional security, users with touch devices can now choose to use a PIN confirmation when using the `tap_action` field. Please be aware that the dashboard configuration is hosted on your Home assistant server without authentication, making the PIN publicly available for everyone accessing your configuration.
The PIN can be a string of arbitrary length consisting only of the digits 1-4.
The user has 5 attempts to provide a valid PIN within 2 minutes. If too many failures have been detected in this time, the PIN dialog will be locked for 10 minutes.
```json
{
"entity": "cover.garage_door",
"name": "Garage Door",
"type": "template",
"content": "{% if is_state('binary_sensor.garage_connected', 'on') %}{{state_translated('cover.garage_door')}} - {{state_attr('cover.garage_door', 'current_position')}}%{%else%}Unconnected{% endif %}",
"tap_action": {
"service": "cover.toggle",
"pin": "1234"
}
}
```
In order to further strengthen the PIN, you can add a PIN mask to your app settings (in Garmin IQ). This PIN mask will transcode each digit of your PIN on the Garmin device, effectively scrambling the publicly available PIN. Think of it like turning the discs of a combination lock n times for each digit at the same position as the mask digit. If no mask is provided or if the mask is shorter than the pin, the corresponding digits won't be transcoded.
```
PIN: 1234
|||| -> PIN to be entered: 3311
Mask: 2121
```
## Group and Toggle Menu Items
Both `group` and `toggle` menu items accept an optional `content` field as of v2.19. This allows the use of templates to present status information.