Entity Reference¶

This page is auto-generated by scripts/generate_docs.py. Do not edit manually.

This page provides a comprehensive reference of all entities and services exposed by the Kiosker integration.

Overview¶

Entities are created per kiosk device from the data returned by the Kiosker API. Each entity uses a unique ID of the form <device_id>_<entity_key> and derives its name from the entity description.

Data payloads¶

Status payload¶

The status payload is fetched from the status endpoint and provides the fields below.

Field	Type
device_id	str
app_version	str \| None
app_name	str \| None
os_version	str \| None
model	str \| None
date	datetime \| None
ambient_light	float \| None
battery_level	int \| None
battery_state	str \| None
last_interaction	datetime \| None
last_motion	datetime \| None

Screensaver payload¶

Field	Type
visible	bool \| None
disabled	bool \| None

Blackout payload¶

Field	Type
visible	bool \| None
text	str \| None
background	str \| None
foreground	str \| None
icon	str \| None
expire	int \| None

Sensors¶

Name	Key	Description	Device Class	Unit	State Class	Category	Icon	Source
Ambient Light	ambient_light	Value from `status.ambient_light`.	Illuminance	lux	Measurement	Primary	-	status.ambient_light
App Version	app_version	Value from `status.app_version`.	-	-	-	Primary	mdi:application	status.app_version
Battery Level	battery_level	Value from `status.battery_level`.	Battery	%	Measurement	Primary	-	status.battery_level
Battery State	battery_state	Value from `status.battery_state`.	Enum	-	-	Primary	dynamic (battery level)	status.battery_state
Device Model	model	Value from `status.model`.	-	-	-	Primary	mdi:tablet	status.model
Last Interaction	last_interaction	Value from `status.last_interaction`.	Timestamp	-	-	Diagnostic	-	status.last_interaction
Last Motion	last_motion	Value from `status.last_motion`.	Timestamp	-	-	Diagnostic	-	status.last_motion
OS Version	os_version	Value from `status.os_version`.	-	-	-	Primary	mdi:apple-ios	status.os_version

Binary sensors¶

Name	Key	Description	Category	Icon	Source
Blackout Active	blackout_active	True when `blackout.visible if blackout else None` is truthy.	Primary	mdi:cancel	blackout.visible if blackout else None
Screensaver Active	screensaver_visible	True when `screensaver.visible if screensaver else None` is truthy.	Primary	mdi:sleep	screensaver.visible if screensaver else None
Screensaver Disabled	screensaver_disabled	True when `screensaver.disabled if screensaver else None` is truthy.	Diagnostic	mdi:sleep-off	screensaver.disabled if screensaver else None

Buttons¶

Name	Key	Action	Category	Icon	API Call(s)
Clear Cache	clear_cache	clear_cache	Configuration	mdi:cached	async_clear_cache
Clear Cookies	clear_cookies	clear_cookies	Configuration	mdi:cookie-alert-outline	async_clear_cookies
Dismiss Screensaver	screensaver_interact	screensaver_interact	Primary	mdi:sleep-off	async_screensaver_interact
Go Back	backward	backward	Primary	mdi:arrow-left	async_navigate_backward
Go Forward	forward	forward	Primary	mdi:arrow-right	async_navigate_forward
Go Home	home	home	Primary	mdi:home-export-outline	async_navigate_home
Ping	ping	ping	Diagnostic	mdi:lan-pending	async_ping, async_navigate_refresh
Print Page	print	print	Primary	mdi:printer	async_print
Refresh Page	refresh	refresh	Primary	mdi:refresh	async_navigate_refresh

Services¶

All services are registered under the kiosker domain. Use device_id when multiple kiosks are configured.

`kiosker.navigate_url`¶

Navigate the kiosk browser to a specific URL.

Field	Required	Description	Example	Selector
device_id	no	The Kiosker device to target.	-	device
url	yes	Target URL to open in the kiosk browser.	https://www.example.com	text (type=url)

`kiosker.set_blackout`¶

Show or hide the blackout overlay and optionally customize its appearance.

Field	Required	Description	Example	Selector
device_id	no	The Kiosker device to target.	-	device
visible	yes	Set to true to show the blackout overlay; false to hide it.	-	boolean
text	no	Optional text to display on the blackout overlay.	-	text (multiline=True)
background	no	Hex color code for the blackout background (e.g. #000000).	-	text
foreground	no	Hex color code for the text (e.g. #FFFFFF).	-	text
icon	no	Optional SF Symbol / icon name to display (e.g. wrench.and.screwdriver.fill).	-	text
expire	no	Optional duration before the blackout automatically clears.	-	number (mode=box, min=0, unit_of_measurement=s)

`kiosker.set_screensaver`¶

Enable or disable the screensaver and optionally set its visibility.

Field	Required	Description	Example	Selector
device_id	no	The Kiosker device to target.	-	device
disabled	yes	Disable (true) or enable (false) the screensaver.	-	boolean
visible	no	Optional visibility toggle. Leave empty to keep the current visibility.	-	boolean

`kiosker.set_start_url`¶

Update the kiosk start page URL used on launch or reset.

Field	Required	Description	Example	Selector
device_id	no	The Kiosker device to target.	-	device
url	yes	URL to set as the kiosk start page.	https://intranet.local	text (type=url)

Entity naming and IDs¶

Kiosker entities use Home Assistant's entity naming with has_entity_name, so entity names are derived from the device name and the entity description. Unique IDs are created from the kiosk device ID and the entity key: device_id_<key>.

Diagnostics¶

Use Settings -> Devices & Services -> Kiosker -> Download diagnostics to capture a sanitized snapshot of the latest payloads.