diff --git a/docs/core/sensors.md b/docs/core/sensors.md index 172f8aea133..85e45b167be 100644 --- a/docs/core/sensors.md +++ b/docs/core/sensors.md @@ -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. | @@ -557,6 +558,20 @@ 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)
+[Kiosk mode](../integrations/ios-kiosk-mode.md) adds sensors so automations can react to the state of the kiosk device. + +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` | The current screen brightness, as a percentage. | +| `binary_sensor.kiosk_screensaver` | `on` while the screensaver is visible on screen, `off` when it is not. | +| `sensor.kiosk_volume` | The current device output volume, as a percentage. | + ## Last reboot sensor ![Android](/assets/android.svg)
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. diff --git a/docs/integrations/ios-kiosk-mode.md b/docs/integrations/ios-kiosk-mode.md index 49b9f4da1f2..3423b1e1d3a 100644 --- a/docs/integrations/ios-kiosk-mode.md +++ b/docs/integrations/ios-kiosk-mode.md @@ -87,6 +87,12 @@ 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. + +For the full list of these sensors and what each one reports, see [Kiosk sensors](../core/sensors.md#kiosk-sensors) on the sensors page. + ## 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.