diff --git a/source/_integrations/kiosker.markdown b/source/_integrations/kiosker.markdown new file mode 100644 index 000000000000..790642033737 --- /dev/null +++ b/source/_integrations/kiosker.markdown @@ -0,0 +1,102 @@ +--- +title: Kiosker +description: Instructions on how to integrate Kiosker with Home Assistant +ha_category: + - Sensor +ha_release: 2026.5 +ha_iot_class: Local Polling +ha_config_flow: true +ha_codeowners: + - '@claeysson' +ha_domain: kiosker +ha_platforms: + - sensor +ha_integration_type: integration +ha_zeroconf: 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 %} \ No newline at end of file