immersive-home/docs/reference/lib--globals--home_api.md

# HomeApi
**Inherits:** [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html)
    
## Description

Manages the connection to the home automation system and provides a unified interface to the different home automation systems.

## Properties

| Name                   | Type                                                                      | Default |
| ---------------------- | ------------------------------------------------------------------------- | ------- |
| [api](#prop-api)       | [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html)       |         |
| [groups](#prop-groups) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) |         |

## Methods

| Returns                                                                   | Name                                                                                                                                                                                                                                                                                       |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| void                                                                      | [_on_connect](#-on-connect) (  )                                                                                                                                                                                                                                                           |
| void                                                                      | [_on_disconnect](#-on-disconnect) (  )                                                                                                                                                                                                                                                     |
| void                                                                      | [_ready](#-ready) (  )                                                                                                                                                                                                                                                                     |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [get_device](#get-device) ( id: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) )                                                                                                                                                                                  |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [get_devices](#get-devices) (  )                                                                                                                                                                                                                                                           |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [get_history](#get-history) ( entity_id: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), start: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), end: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) )     |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [get_state](#get-state) ( entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) )                                                                                                                                                                                |
| [VoiceHandler](/reference/lib--home_apis--voice_handler.html)             | [get_voice_assistant](#get-voice-assistant) (  )                                                                                                                                                                                                                                           |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [has_connected](#has-connected) (  )                                                                                                                                                                                                                                                       |
| [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html)       | [has_integration](#has-integration) (  )                                                                                                                                                                                                                                                   |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [set_state](#set-state) ( entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), state: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), attributes: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) |
| void                                                                      | [start_adapter](#start-adapter) ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), url: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), token: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) )            |
| void                                                                      | [update_room](#update-room) ( room: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) )                                                                                                                                                                              |
| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | [watch_state](#watch-state) ( entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), callback: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) )                                                                                     |

## Signals

### on_connect ( ) {#on-connect}

Emitted when the connection to the home automation system is established

### on_disconnect ( ) {#on-disconnect}

Emitted when the connection to the home automation system is lost


## Constants

### Hass = `<Object>` {#const-Hass}

No description provided yet.

### EntityGroups = `<Object>` {#const-EntityGroups}

No description provided yet.

### HassWebSocket = `<Object>` {#const-HassWebSocket}

No description provided yet.

### VoiceAssistant = `<Object>` {#const-VoiceAssistant}

No description provided yet.

### apis = `{"hass": <Object>, "hass_ws": <Object>}` {#const-apis}

No description provided yet.

### methods = `[
  "get_devices",
  "get_device",
  "get_state",
  "set_state",
  "watch_state"
]` {#const-methods}

No description provided yet.

## Property Descriptions

### api: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#prop-api}

The current home automation system adapter

### groups: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-groups}

No description provided yet.

## Method Descriptions

###  _on_connect ( ) -> void {#-on-connect}

No description provided yet.

###  _on_disconnect ( ) -> void {#-on-disconnect}

No description provided yet.

###  _ready ( ) -> void {#-ready}

No description provided yet.

###  get_device (id: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html)  ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#get-device}

Get a single device by id

###  get_devices ( ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#get-devices}

Get a list of all devices

###  get_history (entity_id: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) , start: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) , end: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html)  ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#get-history}

No description provided yet.

###  get_state (entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html)  ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#get-state}

Returns the current state of an entity

###  get_voice_assistant ( ) -> [VoiceHandler](/reference/lib--home_apis--voice_handler.html) {#get-voice-assistant}

Returns the VoiceHandler if the adapter has a voice assistant

###  has_connected ( ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#has-connected}

Returns true if the adapter is connected to the home automation system

###  has_integration ( ) -> [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#has-integration}

Returns true if the adapter has an integration in the home automation system allowing to send the room position of the headset.

###  set_state (entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) , state: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) , attributes: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html)  ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#set-state}

Updates the state of the entity and returns the resulting state

###  start_adapter (type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) , url: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) , token: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html)  ) -> void {#start-adapter}

Starts the adapter for the given type and url

###  update_room (room: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html)  ) -> void {#update-room}

Updates the room position of the headset in the home automation system

###  watch_state (entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) , callback: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html)  ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#watch-state}

Watches the state and each time it changes, calls the callback with the changed state, returns a function to stop watching the state
add initial docs 2024-03-16 19:45:43 +02:00			`# HomeApi`
Add user & dev docs, update reference docs 2024-03-17 00:05:55 +02:00			`Inherits: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html)`
add initial docs 2024-03-16 19:45:43 +02:00
update and fix reference docs 2024-03-17 01:14:31 +02:00			`## Description`
add initial docs 2024-03-16 19:45:43 +02:00
update and fix reference docs 2024-03-17 01:14:31 +02:00			`Manages the connection to the home automation system and provides a unified interface to the different home automation systems.`
add initial docs 2024-03-16 19:45:43 +02:00
			`## Properties`

update docs 2024-04-26 18:41:52 +03:00			`\| Name \| Type \| Default \|`
			`\| ---------------------- \| ------------------------------------------------------------------------- \| ------- \|`
			`\| [api](#prop-api) \| [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) \| \|`
			`\| [groups](#prop-groups) \| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) \| \|`
add initial docs 2024-03-16 19:45:43 +02:00
			`## Methods`

			`\| Returns \| Name \|`
			`\| ------------------------------------------------------------------------- \| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ \|`
			`\| void \| [_on_connect](#-on-connect) ( ) \|`
			`\| void \| [_on_disconnect](#-on-disconnect) ( ) \|`
			`\| void \| [_ready](#-ready) ( ) \|`
			`\| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) \| [get_device](#get-device) ( id: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) \|`
			`\| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) \| [get_devices](#get-devices) ( ) \|`
update docs 2024-04-26 18:41:52 +03:00			`\| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) \| [get_history](#get-history) ( entity_id: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), start: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), end: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) \|`
add initial docs 2024-03-16 19:45:43 +02:00			`\| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) \| [get_state](#get-state) ( entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) \|`
update docs 2024-03-18 14:30:37 +02:00			`\| [VoiceHandler](/reference/lib--home_apis--voice_handler.html) \| [get_voice_assistant](#get-voice-assistant) ( ) \|`
add initial docs 2024-03-16 19:45:43 +02:00			`\| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) \| [has_connected](#has-connected) ( ) \|`
update docs 2024-03-18 14:30:37 +02:00			`\| [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) \| [has_integration](#has-integration) ( ) \|`
add initial docs 2024-03-16 19:45:43 +02:00			`\| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) \| [set_state](#set-state) ( entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), state: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html), attributes: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) \|`
			`\| void \| [start_adapter](#start-adapter) ( type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), url: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), token: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) \|`
update docs 2024-03-18 14:30:37 +02:00			`\| void \| [update_room](#update-room) ( room: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) \|`
add initial docs 2024-03-16 19:45:43 +02:00			`\| [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) \| [watch_state](#watch-state) ( entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html), callback: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) ) \|`

Add user & dev docs, update reference docs 2024-03-17 00:05:55 +02:00			`## Signals`

			`### on_connect ( ) {#on-connect}`

update and fix reference docs 2024-03-17 01:14:31 +02:00			`Emitted when the connection to the home automation system is established`
Add user & dev docs, update reference docs 2024-03-17 00:05:55 +02:00
			`### on_disconnect ( ) {#on-disconnect}`

update and fix reference docs 2024-03-17 01:14:31 +02:00			`Emitted when the connection to the home automation system is lost`
Add user & dev docs, update reference docs 2024-03-17 00:05:55 +02:00


update and fix reference docs 2024-03-17 01:14:31 +02:00			`## Constants`

Add user & dev docs, update reference docs 2024-03-17 00:05:55 +02:00			### Hass = `<Object>` {#const-Hass}

			`No description provided yet.`

update docs 2024-04-26 18:41:52 +03:00			### EntityGroups = `<Object>` {#const-EntityGroups}

			`No description provided yet.`

Add user & dev docs, update reference docs 2024-03-17 00:05:55 +02:00			### HassWebSocket = `<Object>` {#const-HassWebSocket}

			`No description provided yet.`

update docs 2024-03-18 14:30:37 +02:00			### VoiceAssistant = `<Object>` {#const-VoiceAssistant}

			`No description provided yet.`

Add user & dev docs, update reference docs 2024-03-17 00:05:55 +02:00			### apis = `{"hass": <Object>, "hass_ws": <Object>}` {#const-apis}

			`No description provided yet.`

update and fix reference docs 2024-03-17 01:14:31 +02:00			### methods = `[
			`"get_devices",`
			`"get_device",`
			`"get_state",`
			`"set_state",`
			`"watch_state"`
			]` {#const-methods}
Add user & dev docs, update reference docs 2024-03-17 00:05:55 +02:00
			`No description provided yet.`

add initial docs 2024-03-16 19:45:43 +02:00			`## Property Descriptions`

update and fix reference docs 2024-03-17 01:14:31 +02:00			`### api: [Node](https://docs.godotengine.org/de/4.x/classes/class_node.html) {#prop-api}`
add initial docs 2024-03-16 19:45:43 +02:00
update and fix reference docs 2024-03-17 01:14:31 +02:00			`The current home automation system adapter`
add initial docs 2024-03-16 19:45:43 +02:00
update docs 2024-04-26 18:41:52 +03:00			`### groups: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-groups}`

			`No description provided yet.`

add initial docs 2024-03-16 19:45:43 +02:00			`## Method Descriptions`

update and fix reference docs 2024-03-17 01:14:31 +02:00			`### _on_connect ( ) -> void {#-on-connect}`
add initial docs 2024-03-16 19:45:43 +02:00
			`No description provided yet.`

update and fix reference docs 2024-03-17 01:14:31 +02:00			`### _on_disconnect ( ) -> void {#-on-disconnect}`
add initial docs 2024-03-16 19:45:43 +02:00
			`No description provided yet.`

update and fix reference docs 2024-03-17 01:14:31 +02:00			`### _ready ( ) -> void {#-ready}`
add initial docs 2024-03-16 19:45:43 +02:00
			`No description provided yet.`

update and fix reference docs 2024-03-17 01:14:31 +02:00			`### get_device (id: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#get-device}`
add initial docs 2024-03-16 19:45:43 +02:00
			`Get a single device by id`

update and fix reference docs 2024-03-17 01:14:31 +02:00			`### get_devices ( ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#get-devices}`
add initial docs 2024-03-16 19:45:43 +02:00
			`Get a list of all devices`

update docs 2024-04-26 18:41:52 +03:00			`### get_history (entity_id: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) , start: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) , end: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#get-history}`

			`No description provided yet.`

update and fix reference docs 2024-03-17 01:14:31 +02:00			`### get_state (entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#get-state}`
add initial docs 2024-03-16 19:45:43 +02:00
			`Returns the current state of an entity`

update docs 2024-03-18 14:30:37 +02:00			`### get_voice_assistant ( ) -> [VoiceHandler](/reference/lib--home_apis--voice_handler.html) {#get-voice-assistant}`

			`Returns the VoiceHandler if the adapter has a voice assistant`

update and fix reference docs 2024-03-17 01:14:31 +02:00			`### has_connected ( ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#has-connected}`
add initial docs 2024-03-16 19:45:43 +02:00
update and fix reference docs 2024-03-17 01:14:31 +02:00			`Returns true if the adapter is connected to the home automation system`
add initial docs 2024-03-16 19:45:43 +02:00
update docs 2024-03-18 14:30:37 +02:00			`### has_integration ( ) -> [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#has-integration}`

			`Returns true if the adapter has an integration in the home automation system allowing to send the room position of the headset.`

update and fix reference docs 2024-03-17 01:14:31 +02:00			`### set_state (entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) , state: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) , attributes: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#set-state}`
add initial docs 2024-03-16 19:45:43 +02:00
			`Updates the state of the entity and returns the resulting state`

update and fix reference docs 2024-03-17 01:14:31 +02:00			`### start_adapter (type: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) , url: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) , token: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) -> void {#start-adapter}`
add initial docs 2024-03-16 19:45:43 +02:00
update and fix reference docs 2024-03-17 01:14:31 +02:00			`Starts the adapter for the given type and url`
add initial docs 2024-03-16 19:45:43 +02:00
update docs 2024-03-18 14:30:37 +02:00			`### update_room (room: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) -> void {#update-room}`

			`Updates the room position of the headset in the home automation system`

update and fix reference docs 2024-03-17 01:14:31 +02:00			`### watch_state (entity: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) , callback: [Callable](https://docs.godotengine.org/de/4.x/classes/class_callable.html) ) -> [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#watch-state}`
add initial docs 2024-03-16 19:45:43 +02:00
			`Watches the state and each time it changes, calls the callback with the changed state, returns a function to stop watching the state`