Skip to content

Add kiosk sensors (including screensaver) to iOS Kiosk mode docs #1377

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.

Sign up for GitHub

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
bgoncal wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add kiosk sensors (including screensaver) to iOS Kiosk mode docs #1377

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
08ae9d7
Document kiosk sensors including the new screensaver sensor
claude Jul 12, 2026
f70a05d
List kiosk sensors in the main sensors overview
claude Jul 13, 2026
72460a5
Use entity IDs for kiosk sensors instead of display names
claude Jul 13, 2026
bdba002
Restructure kiosk sensors on the main sensors page per review
claude Jul 22, 2026
ef9392e
Link kiosk mode page to sensors list instead of duplicating it
claude Jul 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/core/sensors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ Not all ![iOS](/assets/iOS.svg) sensors are enabled by default. If you don't see
| `sensor.distance` | None | The estimated distance walked by the user since midnight local time. Units: meters, m |
| `sensor.floors_ascended` | None | The approximate number of floors ascended by walking since midnight local time. |
| `sensor.floors_descended` | None | The approximate number of floors descended by walking. Since |
| [Kiosk Sensors](#kiosk-sensors) | None | Sensors exposed by [Kiosk mode](../integrations/ios-kiosk-mode.md), reflecting the state of the kiosk device. |
| `sensor.location_permission` | None | The current location permission that was selected by the user. The permission can be set via the location permission popup or modified in the iOS settings. |
| `sensor.sim_1` | [See Below](#cellular-provider-sensor) | Name of your cellular provider. |
| `sensor.sim_2` | [See Below](#cellular-provider-sensor) | Name of your cellular provider. |
Expand Down Expand Up @@ -557,6 +558,17 @@ Using the [History Stats Integration](https://www.home-assistant.io/integrations

These sensors will reflect various states from the [Keyguard Manager](https://developer.android.com/reference/android/app/KeyguardManager). You will be able to determine if the device is actively locked, has a password setup or even if the device requires a password to unlock. These sensors will update with the periodic sensor interval.

## Kiosk sensors
![iOS](/assets/iOS.svg)<br />
[Kiosk mode](../integrations/ios-kiosk-mode.md) adds sensors so automations can react to the state of the kiosk device. The `sensor.kiosk_brightness`, `sensor.kiosk_volume`, and `binary_sensor.kiosk_screensaver` sensors are only active while kiosk mode is enabled and turn on and off automatically as you enable or disable it. The `binary_sensor.kiosk_mode` sensor is always available so you can tell whether a device is currently acting as a kiosk. See [Kiosk mode](../integrations/ios-kiosk-mode.md#sensors) for the full description.

@jpelgrom jpelgrom Jul 14, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • What do you mean with turns on/off automatically? Does the state go unavailable/unknown? Does it enable/disable the entire entity (that seems problematic for automations)?
  • There is no additional description on the other page.


| Sensor | Description |
| ------ | ----------- |
| `binary_sensor.kiosk_mode` | `on` while the app is running in kiosk mode, `off` otherwise. |
| `sensor.kiosk_brightness` | The current screen brightness, as a percentage. |
| `sensor.kiosk_volume` | The current device output volume, as a percentage. |
| `binary_sensor.kiosk_screensaver` | `on` while the screensaver is visible on screen, `off` when it is not. |

@jpelgrom jpelgrom Jul 14, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know what this order is, it's not a-z by the first or second part. If you want to have the 'main' on/off sensor for kiosk mode separately maybe a structure like:

Kiosk mode adds sensors...

The `binary_sensor.kiosk_mode` sensor is always available so you can tell whether a device is currently acting as a kiosk (`on`) or running the app normally (`off`).

While kiosk mode is on, additional sensors provide details about the device in kiosk mode:

| Sensor | Description |
| ------ | ----------- |
| `sensor.kiosk_brightness` | ... |
| `binary_sensor.kiosk_screensaver` | ...|
| `sensor.kiosk_volume` | ... |


## Last reboot sensor
![Android](/assets/android.svg)<br />
This sensors state will be the date and time of the last reboot from the device in UTC format. The sensor will update during the normal sensor update interval. The state will be `unavailable` if the timestamp cannot be determined. This sensor uses the [SystemClock](https://developer.android.com/reference/android/os/SystemClock?hl=en) and current [System](https://developer.android.com/reference/java/lang/System?hl=en) time to calculate the timestamp. This sensor offers a deadband setting, that defaults to 1 minute, to account for time calculation issues seen over certain carriers.
Expand Down
13 changes: 13 additions & 0 deletions docs/integrations/ios-kiosk-mode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,19 @@ When **Mode** is set to **Clock**, you can also adjust:

Use the **Preview** button to see the screensaver full-screen with your current settings. Tap anywhere to return to the settings.

## Sensors

Kiosk mode adds sensors so automations can react to the state of the kiosk device. They appear in the app's sensor settings and in the **Sensors** screen inside the kiosk settings. All are iOS-only.

| Sensor | Description |
| ------ | ----------- |
| `binary_sensor.kiosk_mode` | `on` while the app is running in kiosk mode, `off` otherwise. |
| `sensor.kiosk_brightness` | The current screen brightness, as a percentage. |
| `sensor.kiosk_volume` | The current device output volume, as a percentage. |
| `binary_sensor.kiosk_screensaver` | `on` while the screensaver is visible on screen, `off` when it is not. |

The `sensor.kiosk_brightness`, `sensor.kiosk_volume`, and `binary_sensor.kiosk_screensaver` sensors are only active while kiosk mode is enabled — they are turned on and off automatically as you enable or disable kiosk mode. The `binary_sensor.kiosk_mode` sensor is always available so you can tell whether a device is currently acting as a kiosk.

@jpelgrom jpelgrom Jul 14, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Information is now duplicated on both pages. That will lead to inconsistent information in the future, so I'd link to the other page heading from here.


## Remote commands

While kiosk mode is running, you can control it from Home Assistant by sending a notification whose `message` is a kiosk command. This is useful for automations — for example, showing the screensaver at night, or bringing a camera up on a wall panel when motion is detected.
Expand Down