Add kiosk sensors (including screensaver) to iOS Kiosk mode docs - #1377
Add kiosk sensors (including screensaver) to iOS Kiosk mode docs#1377bgoncal wants to merge 5 commits into
Conversation
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014bZsB3ashxLB2dgBSnobAt
|
I know the main sensors page is huge but wouldn't it be better to have them listed there so it remains the complete overview, or at least link to it? |
Add the iOS Kiosk mode sensors to the general sensors page so it stays a complete overview, with a cross-link to the Kiosk mode documentation. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014bZsB3ashxLB2dgBSnobAt
Reference the kiosk sensors by their entity IDs (binary_sensor.kiosk_mode, sensor.kiosk_brightness, sensor.kiosk_volume, binary_sensor.kiosk_screensaver) to match the convention used throughout the sensors documentation. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014bZsB3ashxLB2dgBSnobAt
jpelgrom
left a comment
There was a problem hiding this comment.
I see most of this was actually merged weeks ago so a late docs PR home-assistant/iOS#4847
|
|
||
| | 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. |
There was a problem hiding this comment.
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.
|
|
||
| ## Kiosk sensors | ||
| <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. |
There was a problem hiding this comment.
- 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.
| | `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. | |
There was a problem hiding this comment.
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` | ... |
|
You can also delete the AI reply comment but I still read it via email notifications ;) |
|
😂 no matter how many times I set it to not reply in PRs, if it's set to automatically address CI issues it comments sometimes 🫣 |
|
@jpelgrom Where do you prefer to keep the sensors list itself, in the existent sensors table or just a link to kiosk page and then the kiosk sensors table in there? |
|
I'd prefer it on the main page of sensors for now, so where I placed #1377 (comment), to avoid having one set of sensors hidden on a different page. Also easier if you search online or Ctrl + F on the page. |
Break out binary_sensor.kiosk_mode into its own always-available note and list the remaining kiosk sensors in a table ordered alphabetically, keeping the full list on the main sensors page for discoverability. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014bZsB3ashxLB2dgBSnobAt
Remove the duplicated kiosk sensor table from the kiosk mode page and link to the Kiosk sensors section on the sensors page, keeping a single source of truth to avoid the two pages drifting out of sync. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014bZsB3ashxLB2dgBSnobAt
Proposed change
Documents the sensors exposed by iOS Kiosk mode, including the new Kiosk Screensaver binary sensor. The kiosk mode page previously documented settings and remote commands but not the sensors the app exposes. This adds a Sensors section covering Kiosk Mode, Kiosk Brightness, Kiosk Volume, and the newly added Kiosk Screensaver (
onwhile the screensaver is on screen,offotherwise).Companion to app PR: home-assistant/iOS#5063
Type of change
Checklist
Additional information
Generated by Claude Code