updating Knocki docs (#34654)

* Knocki docs

* fix: removed troubleshooting from this PR

* Remove automtion steps, move some of the steps into prereqs

* Apply suggestions from code review

* feat: automation example and troubleshooting section

* fix: coderabbit suggestions

* fix: remove troubleshooting

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
jgatto1 2024-11-06 03:34:21 -03:00 committed by GitHub
parent bde81adb63
commit 931fee1280
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -16,12 +16,30 @@ ha_platforms:
ha_integration_type: hub
---
The **Knocki** {% term integration %} can receive events for the triggers set up from your [Knocki devices](https://knocki.com/).
The **Knocki** {% term integration %} allows you to trigger your favorite automations simply by tapping custom patterns (such as triple taps) on ordinary surfaces.
## Prerequisites
To use the Knocki integration, you need a Knocki account.
- You must have a [Knocki device](http://knocki.com).
Once you set a trigger in the app, it will show up in Home Assistant to use.
- Completed the setup process in the **Knocki** mobile app, as described in steps 1-7 below.
1. Open the Knocki Mobile App. Its a free download on [iOS](https://apps.apple.com/us/app/knocki/id1238395440) and [Android](https://play.google.com/store/apps/details?id=com.knocki.mobileapp).
2. Using the app, log-in or create a new Knocki account.
3. From the apps home screen, select a Knocki or [add a Knocki](https://support.knocki.com/hc/en-us/articles/12769368448659-How-Do-Add-a-Knocki-to-My-Account).
4. On the apps device screen, select a gesture or [add a gesture](https://support.knocki.com/hc/en-us/articles/360013333634-Creating-a-Gesture).
5. Next, select the [add a task](https://support.knocki.com/hc/en-us/articles/12920956118291-How-do-I-Add-Tasks-to-a-Knocki) option.
6. Scroll down the task menu and select Home Assistant.
7. Follow the in-app instructions to add the Home Assistant task.
{% include integrations/config_flow.md %}
## Automation example
1. Go to {% my automations title="**Settings** > **Automations & scenes**" %} and in the lower right corner, select **Create Automation**.
2. Select **Create new automation**.
3. Select **Add Trigger**, select **Entity** as the trigger type.
- Search for the name of the task (as you named it in the Knocki app). Select the entity with that name appended to it.
- Select **State** as the type of entity change.
4. Select **Add action** and choose whatever action(s) youd like the automation to trigger.
5. Finally, test the action by tapping the associated gesture pattern.