homeassistant.components.hassio.handler.HassIO Class Reference

Public Member Functions
None	__init__ (self, asyncio.AbstractEventLoop loop, aiohttp.ClientSession websession, str ip)
URL	base_url (self)
Coroutine	get_core_info (self)
Coroutine	get_core_stats (self)
Coroutine	get_host_info (self)
Coroutine	get_info (self)
Coroutine	get_ingress_panels (self)
Coroutine	get_network_info (self)
Coroutine	get_os_info (self)
Coroutine	get_supervisor_info (self)
Coroutine	get_supervisor_stats (self)
Any	send_command (self, str command, str method="post", Any|None payload=None, int|None timeout=10, bool return_text=False, *str source="core.handler")
Coroutine	update_diagnostics (self, bool diagnostics)
def	update_hass_api (self, dict[str, Any] http_config, RefreshToken refresh_token)
Coroutine	update_hass_timezone (self, str timezone)

Public Attributes
	loop
	websession

Private Attributes
	_base_url
	_ip

Detailed Description

Small API wrapper for Hass.io.

Definition at line 146 of file handler.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.hassio.handler.HassIO.__init__	(		self,
		asyncio.AbstractEventLoop	loop,
		aiohttp.ClientSession	websession,
		str	ip
	)

Initialize Hass.io API.

Definition at line 149 of file handler.py.

Member Function Documentation

base_url()

URL homeassistant.components.hassio.handler.HassIO.base_url

(

self

)

Return base url for Supervisor.

Definition at line 163 of file handler.py.

get_core_info()

Coroutine homeassistant.components.hassio.handler.HassIO.get_core_info

(

self

)

Return data for Home Asssistant Core.

This method returns a coroutine.

Definition at line 192 of file handler.py.

get_core_stats()

Coroutine homeassistant.components.hassio.handler.HassIO.get_core_stats

(

self

)

Return stats for the core.

This method returns a coroutine.

Definition at line 216 of file handler.py.

get_host_info()

Coroutine homeassistant.components.hassio.handler.HassIO.get_host_info

(

self

)

Return data for Host.

This method returns a coroutine.

Definition at line 176 of file handler.py.

get_info()

Coroutine homeassistant.components.hassio.handler.HassIO.get_info

(

self

)

Return generic Supervisor information.

This method returns a coroutine.

Definition at line 168 of file handler.py.

get_ingress_panels()

Coroutine homeassistant.components.hassio.handler.HassIO.get_ingress_panels

(

self

)

Return data for Add-on ingress panels.

This method returns a coroutine.

Definition at line 232 of file handler.py.

get_network_info()

Coroutine homeassistant.components.hassio.handler.HassIO.get_network_info

(

self

)

Return data for the Host Network.

This method returns a coroutine.

Definition at line 208 of file handler.py.

get_os_info()

Coroutine homeassistant.components.hassio.handler.HassIO.get_os_info

(

self

)

Return data for the OS.

This method returns a coroutine.

Definition at line 184 of file handler.py.

get_supervisor_info()

Coroutine homeassistant.components.hassio.handler.HassIO.get_supervisor_info

(

self

)

Return data for the Supervisor.

This method returns a coroutine.

Definition at line 200 of file handler.py.

get_supervisor_stats()

Coroutine homeassistant.components.hassio.handler.HassIO.get_supervisor_stats

(

self

)

Return stats for the supervisor.

This method returns a coroutine.

Definition at line 224 of file handler.py.

send_command()

Any homeassistant.components.hassio.handler.HassIO.send_command	(		self,
		str	command,
		str	method = "post",
		Any | None	payload = None,
		int | None	timeout = 10,
		bool	return_text = False,
		*str	source = "core.handler"
	)

Send API command to Hass.io.

This method is a coroutine.

Definition at line 278 of file handler.py.

update_diagnostics()

Coroutine homeassistant.components.hassio.handler.HassIO.update_diagnostics	(		self,
		bool	diagnostics
	)

Update Supervisor diagnostics setting.

This method returns a coroutine.

Definition at line 269 of file handler.py.

update_hass_api()

def homeassistant.components.hassio.handler.HassIO.update_hass_api	(		self,
		dict[str, Any]	http_config,
		RefreshToken	refresh_token
	)

Update Home Assistant API data on Hass.io.

Definition at line 240 of file handler.py.

update_hass_timezone()

Coroutine homeassistant.components.hassio.handler.HassIO.update_hass_timezone	(		self,
		str	timezone
	)

Update Home-Assistant timezone data on Hass.io.

This method returns a coroutine.

Definition at line 261 of file handler.py.

Member Data Documentation

_base_url

homeassistant.components.hassio.handler.HassIO._base_url

private

Definition at line 160 of file handler.py.

_ip

homeassistant.components.hassio.handler.HassIO._ip

private

Definition at line 158 of file handler.py.

loop

homeassistant.components.hassio.handler.HassIO.loop

Definition at line 156 of file handler.py.

websession

homeassistant.components.hassio.handler.HassIO.websession

Definition at line 157 of file handler.py.

---

The documentation for this class was generated from the following file:

• core/homeassistant/components/hassio/handler.py