2024-03-16 19:45:43 +02:00
|
|
|
# Assist
|
2024-03-17 00:05:55 +02:00
|
|
|
**Inherits:** [RefCounted](https://docs.godotengine.org/de/4.x/classes/class_refcounted.html)
|
2024-03-16 19:45:43 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Properties
|
|
|
|
|
2024-03-17 01:14:31 +02:00
|
|
|
| Name | Type | Default |
|
|
|
|
| ---------------------------------- | ------------------------------------------------------------------------- | ------- |
|
|
|
|
| [api](#prop-api) | [Hass](/reference/lib--home_apis--hass_ws--hass.html) | |
|
|
|
|
| [handler_id](#prop-handler-id) | [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) | `0` |
|
|
|
|
| [pipe_running](#prop-pipe-running) | [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) | `false` |
|
|
|
|
| [stt_message](#prop-stt-message) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `null` |
|
|
|
|
| [tts_message](#prop-tts-message) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `null` |
|
|
|
|
| [tts_sound](#prop-tts-sound) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `null` |
|
|
|
|
| [wake_word](#prop-wake-word) | [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) | `null` |
|
2024-03-16 19:45:43 +02:00
|
|
|
|
|
|
|
## Methods
|
|
|
|
|
|
|
|
| Returns | Name |
|
|
|
|
| ------- | ------------------------------------------------------------------------------------------------------------------------------ |
|
|
|
|
| void | [_init](#-init) ( hass: [Hass](/reference/lib--home_apis--hass_ws--hass.html) ) |
|
|
|
|
| void | [handle_message](#handle-message) ( message: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) |
|
|
|
|
| void | [on_connect](#on-connect) ( ) |
|
|
|
|
| void | [send_data](#send-data) ( data: [PackedByteArray](https://docs.godotengine.org/de/4.x/classes/class_packedbytearray.html) ) |
|
|
|
|
| void | [start_wakeword](#start-wakeword) ( ) |
|
|
|
|
|
2024-03-17 00:05:55 +02:00
|
|
|
## Signals
|
|
|
|
|
|
|
|
### on_error ( ) {#on-error}
|
|
|
|
|
|
|
|
No description provided yet.
|
|
|
|
|
|
|
|
### on_stt_message (message: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) {#on-stt-message}
|
|
|
|
|
|
|
|
No description provided yet.
|
|
|
|
|
|
|
|
### on_tts_message (message: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) {#on-tts-message}
|
|
|
|
|
|
|
|
No description provided yet.
|
|
|
|
|
|
|
|
### on_tts_sound (sound: [AudioStreamMP3](https://docs.godotengine.org/de/4.x/classes/class_audiostreammp3.html) ) {#on-tts-sound}
|
|
|
|
|
|
|
|
No description provided yet.
|
|
|
|
|
|
|
|
### on_wake_word (wake_word: [String](https://docs.godotengine.org/de/4.x/classes/class_string.html) ) {#on-wake-word}
|
|
|
|
|
|
|
|
No description provided yet.
|
|
|
|
|
|
|
|
|
|
|
|
|
2024-03-17 01:14:31 +02:00
|
|
|
## Constants
|
|
|
|
|
2024-03-17 00:05:55 +02:00
|
|
|
### HASS_API = `<Object>` {#const-HASS-API}
|
|
|
|
|
|
|
|
No description provided yet.
|
|
|
|
|
2024-03-16 19:45:43 +02:00
|
|
|
## Property Descriptions
|
|
|
|
|
2024-03-17 01:14:31 +02:00
|
|
|
### api: [Hass](/reference/lib--home_apis--hass_ws--hass.html) {#prop-api}
|
2024-03-16 19:45:43 +02:00
|
|
|
|
|
|
|
No description provided yet.
|
|
|
|
|
2024-03-17 01:14:31 +02:00
|
|
|
### handler_id: [int](https://docs.godotengine.org/de/4.x/classes/class_int.html) {#prop-handler-id}
|
2024-03-16 19:45:43 +02:00
|
|
|
|
|
|
|
No description provided yet.
|
|
|
|
|
2024-03-17 01:14:31 +02:00
|
|
|
### pipe_running: [bool](https://docs.godotengine.org/de/4.x/classes/class_bool.html) {#prop-pipe-running}
|
2024-03-16 19:45:43 +02:00
|
|
|
|
|
|
|
No description provided yet.
|
|
|
|
|
2024-03-17 01:14:31 +02:00
|
|
|
### stt_message: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-stt-message}
|
2024-03-16 19:45:43 +02:00
|
|
|
|
|
|
|
No description provided yet.
|
|
|
|
|
2024-03-17 01:14:31 +02:00
|
|
|
### tts_message: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-tts-message}
|
2024-03-16 19:45:43 +02:00
|
|
|
|
|
|
|
No description provided yet.
|
|
|
|
|
2024-03-17 01:14:31 +02:00
|
|
|
### tts_sound: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-tts-sound}
|
2024-03-16 19:45:43 +02:00
|
|
|
|
|
|
|
No description provided yet.
|
|
|
|
|
2024-03-17 01:14:31 +02:00
|
|
|
### wake_word: [Variant](https://docs.godotengine.org/de/4.x/classes/class_variant.html) {#prop-wake-word}
|
2024-03-16 19:45:43 +02:00
|
|
|
|
|
|
|
No description provided yet.
|
|
|
|
|
|
|
|
## Method Descriptions
|
|
|
|
|
2024-03-17 01:14:31 +02:00
|
|
|
### _init (hass: [Hass](/reference/lib--home_apis--hass_ws--hass.html) ) -> void {#-init}
|
2024-03-16 19:45:43 +02:00
|
|
|
|
|
|
|
No description provided yet.
|
|
|
|
|
2024-03-17 01:14:31 +02:00
|
|
|
### handle_message (message: [Dictionary](https://docs.godotengine.org/de/4.x/classes/class_dictionary.html) ) -> void {#handle-message}
|
2024-03-16 19:45:43 +02:00
|
|
|
|
|
|
|
No description provided yet.
|
|
|
|
|
2024-03-17 01:14:31 +02:00
|
|
|
### on_connect ( ) -> void {#on-connect}
|
2024-03-16 19:45:43 +02:00
|
|
|
|
|
|
|
No description provided yet.
|
|
|
|
|
2024-03-17 01:14:31 +02:00
|
|
|
### send_data (data: [PackedByteArray](https://docs.godotengine.org/de/4.x/classes/class_packedbytearray.html) ) -> void {#send-data}
|
2024-03-16 19:45:43 +02:00
|
|
|
|
|
|
|
No description provided yet.
|
|
|
|
|
2024-03-17 01:14:31 +02:00
|
|
|
### start_wakeword ( ) -> void {#start-wakeword}
|
2024-03-16 19:45:43 +02:00
|
|
|
|
|
|
|
No description provided yet.
|