Kiosker

Kiosker 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 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.

Configuration

To add the Kiosker device to your Home Assistant instance, use this My button:

Kiosker can be auto-discovered by Home Assistant. If an instance was found, it will be shown as Discovered. You can then set it up right away.

Manual configuration steps

If it wasn’t discovered automatically, don’t worry! You can set up a manual integration entry:

Host

The IP address or hostname of the device.

API Token

The generated API token from the Kiosker App.

Use SSL

Connect to the Kiosker App using HTTPS. The Kiosker API has to be configured for SSL.

Verify certificate

Verify SSL certificate. Enable for valid certificates only.

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.

Available sensors:

  • Battery level
  • Charging state
  • 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)
  • Screensaver state
  • Blackout state

Supported functionality

The Kiosker integration provides the following entities.

Sensors

  • Battery level
    • Shows the current battery percentage of your device.
  • Last interaction
    • Shows when your device was last interacted with.
  • Last motion
    • Shows when motion was last detected. This is available if a screensaver with motion detection is scheduled or if the camera sensor is enabled.
  • Ambient light
    • Shows the current ambient light level. This is available if a screensaver with motion detection is scheduled or if the camera sensor is enabled.

Binary sensors

  • Charging state
    • Shows whether the device is connected to a charger
  • Screensaver state
    • Shows whether the screensaver is currently active.
  • Blackout state
    • Shows whether the screen is currently blacked out. Has extra attributes with the blackout data when active.

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.

To remove an integration instance from Home Assistant

  1. Go to Settings > Devices & services and select the integration card.
  2. From the list of devices, select the integration instance you want to remove.
  3. Next to the entry, select the three dots menu. Then, select Delete.