-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Add Kiosker integration documentation #44656
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.
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
Open
Claeysson
wants to merge
4
commits into
home-assistant:next
Choose a base branch
from
Top-North:kiosker
base: next
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+102
−0
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| --- | ||
| title: Kiosker | ||
| description: Instructions on how to integrate Kiosker with Home Assistant | ||
| ha_category: | ||
| - Sensor | ||
| ha_release: 2026.5.0 | ||
| ha_iot_class: Local Polling | ||
| ha_config_flow: true | ||
| ha_codeowners: | ||
| - '@claeysson' | ||
| ha_domain: kiosker | ||
| ha_platforms: | ||
| - sensor | ||
| ha_integration_type: integration | ||
| ha_dhcp: true | ||
| ha_quality_scale: bronze | ||
| --- | ||
|
|
||
| [Kiosker](https://kiosker.io) is a powerful yet easy-to-use web kiosk for iPad and iPhone. This integration gives you control over your Kiosker app via the Kiosker API. | ||
|
|
||
| ## Requirements | ||
|
|
||
| This integration requires that you have bought Kiosker Pro or have a valid Kiosker subscription. You can try Kiosker, including this integration, free for 7 days. | ||
|
|
||
| You need to enable the API server in Kiosker settings. You also need to generate an access token, and find the IP address of the device. Please refer to the [Kiosker documentation](https://docs.kiosker.io/#/api) for further information on how to configure the Kiosker App. | ||
|
|
||
| ## Supported devices | ||
| You need to run version 26.4.1 or later for this integration to be fully functional. | ||
|
|
||
| {% include integrations/config_flow.md %} | ||
|
|
||
| {% configuration_basic %} | ||
| Host: | ||
| description: The IP address or hostname of the device. | ||
| API Token: | ||
| description: The generated API token from the Kiosker App. | ||
| Use SSL: | ||
| description: Connect to the Kiosker App using HTTPS. The Kiosker API has to be configured for SSL. | ||
| Verify certificate: | ||
| description: Verify SSL certificate. Enable for valid certificates only. | ||
| {% endconfiguration_basic %} | ||
|
|
||
| ## Capabilities | ||
|
|
||
| {% note %} | ||
| Due to Apple's restrictive approach to device control, it's not possible to control any physical features like the screen or device sleep through this integration. | ||
| {% endnote %} | ||
|
|
||
| Available sensors: | ||
|
|
||
| - Battery level | ||
| - Last interaction | ||
| - Last motion (available if a screensaver with motion detection is scheduled or if the camera sensor is enabled) | ||
| - Ambient light (available if a screensaver with motion detection is scheduled or if the camera sensor is enabled) | ||
|
|
||
| ## Data updates | ||
| This integration fetches data from the device every 15 seconds. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### Can’t set up the device | ||
|
|
||
| #### Symptom | ||
| When trying to set up the integration, the form shows an error message. | ||
|
|
||
| ##### Description | ||
| This means that Home Assistant can't connect to the Kiosker App. | ||
|
|
||
| ##### Resolution | ||
|
|
||
| 1. Make sure that Kiosker is running in the foreground. | ||
| 2. Make sure that the API is enabled in the settings. | ||
| 3. Make sure that you have generated an API token. | ||
| 4. Make sure that the host or IP is correct. | ||
| 5. If you have enabled IP-filtering, make sure that your host IP is in the whitelist. | ||
| 6. If you have enabled TLS, make sure that you have installed a valid certificate in the Kiosker App, typically a self-signed certificate. | ||
| 7. If you have enabled `Verify certificate`, make sure that the certificate is valid and that the root certificate is marked as trusted on the host. | ||
|
|
||
| ### Device went unavailable | ||
|
|
||
| #### Symptom | ||
| The device and entities are greyed out. | ||
|
|
||
| ##### Description | ||
| This means that Home Assistant can't connect to the Kiosker App. | ||
|
|
||
| ##### Resolution | ||
|
|
||
| 1. Make sure that Kiosker is running in the foreground. | ||
| 2. Make sure that the API is enabled in the settings. | ||
| 3. Make sure that you have generated an API token and has not changed it. | ||
| 4. Make sure that the host or IP is correct and that it has not changed. | ||
| 5. If you have enabled IP-filtering, make sure that your host IP is in the whitelist. | ||
| 6. If you have enabled TLS, make sure that you have installed a valid certificate in the Kiosker App, typically a self-signed certificate. | ||
| 7. If you have enabled `Verify certificate`, make sure that the certificate is valid and that the root certificate is marked as trusted on the host. | ||
|
|
||
|
|
||
| ## Removing the integration | ||
|
|
||
| This integration follows standard integration removal. No extra steps are required. | ||
|
|
||
| {% include integrations/remove_device_service.md %} | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.