diff --git a/docs/core/entity/number.md b/docs/core/entity/number.md index 4ea3f7b3..cb1728d3 100644 --- a/docs/core/entity/number.md +++ b/docs/core/entity/number.md @@ -1,5 +1,5 @@ --- -title: Number Entity +title: Number entity sidebar_label: Number --- diff --git a/docs/core/entity/remote.md b/docs/core/entity/remote.md index 2237c3b1..8f159bec 100644 --- a/docs/core/entity/remote.md +++ b/docs/core/entity/remote.md @@ -1,5 +1,5 @@ --- -title: Remote Entity +title: Remote entity sidebar_label: Remote --- @@ -25,7 +25,7 @@ Properties should always only return information from memory and not do I/O (lik An activity is a predefined activity or macro that puts the remote in a specific state. For example, a "Watch TV" activity may turn on multiple devices and change the channel to a specific channel. -## Supported Features +## Supported features Supported features are defined by using values in the `RemoteEntityFeature` enum and are combined using the bitwise or (`|`) operator. @@ -38,7 +38,7 @@ and are combined using the bitwise or (`|`) operator. ## Methods -### Turn On Command +### Turn on command ```python class MyRemote(RemoteEntity): @@ -50,7 +50,7 @@ class MyRemote(RemoteEntity): """Send the power on command.""" ``` -### Turn Off Command +### Turn off command ```python class MyRemote(RemoteEntity): @@ -62,7 +62,7 @@ class MyRemote(RemoteEntity): """Send the power off command.""" ``` -### Toggle Command +### Toggle command ```python class MyRemote(RemoteEntity): @@ -74,7 +74,7 @@ class MyRemote(RemoteEntity): """Toggle a device.""" ``` -### Send Command +### Send command ```python class MyRemote(RemoteEntity): @@ -86,7 +86,7 @@ class MyRemote(RemoteEntity): """Send commands to a device.""" ``` -### Learn Command +### Learn command Only implement this method if the flag `SUPPORT_LEARN_COMMAND` is set. @@ -100,7 +100,7 @@ class MyRemote(RemoteEntity): """Learn a command from a device.""" ``` -### Delete Command +### Delete command Only implement this method if the flag `SUPPORT_DELETE_COMMAND` is set. diff --git a/docs/core/entity/scene.md b/docs/core/entity/scene.md index 956f3aaf..024f6776 100644 --- a/docs/core/entity/scene.md +++ b/docs/core/entity/scene.md @@ -1,5 +1,5 @@ --- -title: Scene Entity +title: Scene entity sidebar_label: Scene --- diff --git a/docs/core/entity/select.md b/docs/core/entity/select.md index 0194c3bc..481d3c89 100644 --- a/docs/core/entity/select.md +++ b/docs/core/entity/select.md @@ -1,5 +1,5 @@ --- -title: Select Entity +title: Select entity sidebar_label: Select --- diff --git a/docs/core/entity/sensor.md b/docs/core/entity/sensor.md index b094d5be..d907afdd 100644 --- a/docs/core/entity/sensor.md +++ b/docs/core/entity/sensor.md @@ -1,5 +1,5 @@ --- -title: Sensor Entity +title: Sensor entity sidebar_label: Sensor --- diff --git a/docs/core/entity/siren.md b/docs/core/entity/siren.md index da546e41..018202d2 100644 --- a/docs/core/entity/siren.md +++ b/docs/core/entity/siren.md @@ -1,5 +1,5 @@ --- -title: Siren Entity +title: Siren entity sidebar_label: Siren --- diff --git a/docs/core/entity/stt.md b/docs/core/entity/stt.md index b8cde52c..ca41f5f0 100644 --- a/docs/core/entity/stt.md +++ b/docs/core/entity/stt.md @@ -1,11 +1,11 @@ --- -title: Speech To Text Entity -sidebar_label: Speech To Text +title: Speech-to-text entity +sidebar_label: Speech-to-text --- -A speech to text (STT) entity allows other integrations or applications to stream speech data to the STT API and get text back. +A speech-to-text (STT) entity allows other integrations or applications to stream speech data to the STT API and get text back. -A speech to text entity is derived from the [`homeassistant.components.stt.SpeechToTextEntity`](https://github.com/home-assistant/core/blob/dev/homeassistant/components/stt/__init__.py). +A speech-to-text entity is derived from the [`homeassistant.components.stt.SpeechToTextEntity`](https://github.com/home-assistant/core/blob/dev/homeassistant/components/stt/__init__.py). ## Properties diff --git a/docs/core/entity/switch.md b/docs/core/entity/switch.md index 8e1e15e0..b348746c 100644 --- a/docs/core/entity/switch.md +++ b/docs/core/entity/switch.md @@ -1,5 +1,5 @@ --- -title: Switch Entity +title: Switch entity sidebar_label: Switch --- @@ -17,7 +17,7 @@ Properties should always only return information from memory and not do I/O (lik | ---- | ---- | ------- | ----------- | is_on | boolean | `None` | If the switch is currently on or off. -## Deprecated Properties +## Deprecated properties The following properties are deprecated and should not be used by new integrations. Provide them as sensors instead. @@ -28,7 +28,7 @@ Name | Type | Default | Description ## Methods -### Turn On +### Turn on Turn the switch on. @@ -43,7 +43,7 @@ class MySwitch(SwitchEntity): """Turn the entity on.""" ``` -### Turn Off +### Turn off Turn the switch off. diff --git a/docs/core/entity/text.md b/docs/core/entity/text.md index 97a448ad..fcbb1fed 100644 --- a/docs/core/entity/text.md +++ b/docs/core/entity/text.md @@ -1,5 +1,5 @@ --- -title: Text Entity +title: Text entity sidebar_label: Text --- diff --git a/docs/core/entity/time.md b/docs/core/entity/time.md index f0ff2350..3c7bf12f 100644 --- a/docs/core/entity/time.md +++ b/docs/core/entity/time.md @@ -1,5 +1,5 @@ --- -title: Time Entity +title: Time entity sidebar_label: Time --- diff --git a/docs/core/entity/todo.md b/docs/core/entity/todo.md index 4b224372..450dc82d 100644 --- a/docs/core/entity/todo.md +++ b/docs/core/entity/todo.md @@ -1,6 +1,6 @@ --- -title: To-do List Entity -sidebar_label: To-do List +title: To-do list entity +sidebar_label: To-do list --- A To-do list entity is an entity that represents a To-do list. A To-do list contains @@ -20,7 +20,7 @@ Properties should only return information from memory and not do I/O (like netwo A `TodoListEntity` state is the count of incomplete items in the To-do list. -## Supported Features +## Supported features Supported features are defined by using values in the `TodoListEntityFeature` enum and are combined using the bitwise or (`|`) operator. @@ -37,10 +37,9 @@ and are combined using the bitwise or (`|`) operator. ## Methods +### Create to-do items -### Create To-do items - -A To-do list entity may support creating To-do items by specifying the `CREATE_TODO_ITEM` +A to-do list entity may support creating to-do items by specifying the `CREATE_TODO_ITEM` supported feature. ```python @@ -52,9 +51,9 @@ class MyTodoListEntity(TodoListEntity): """Add an item to the To-do list.""" ``` -### Delete To-do items +### Delete to-do items -A To-do list entity may support deleting To-do items by specifying the `DELETE_TODO_ITEM` +A To-do list entity may support deleting to-do items by specifying the `DELETE_TODO_ITEM` supported feature. Integrations must support deleting multiple items. ```python @@ -66,9 +65,9 @@ class MyTodoListEntity(TodoListEntity): """Delete an item from the to-do list.""" ``` -### Update To-do items +### Update to-do items -A To-do list entity may support updating To-do items by specifying the `UPDATE_TODO_ITEM` +A to-do list entity may support updating to-do items by specifying the `UPDATE_TODO_ITEM` supported feature. The `TodoItem` field `uid` is always present and indicates which item should be updated. The item passed to update is a copy of the original item with fields updated or cleared. @@ -82,12 +81,12 @@ class MyTodoListEntity(TodoListEntity): """Add an item to the To-do list.""" ``` -### Move To-do items +### Move to-do items -A To-do list entity may support re-ordering To-do items in the list by specifying -the `MOVE_TODO_ITEM` supported feature. The To-do item with the specified `uid` +A to-do list entity may support re-ordering to-do items in the list by specifying +the `MOVE_TODO_ITEM` supported feature. The to-do item with the specified `uid` should be moved to the position in the list after the one specified by `previous_uid` (`None` means move to the first -position in the To-do list). +position in the to-do list). ```python from homeassistant.components.todo import TodoListEntity diff --git a/docs/core/entity/tts.md b/docs/core/entity/tts.md index 85d6e1ca..598a57d4 100644 --- a/docs/core/entity/tts.md +++ b/docs/core/entity/tts.md @@ -1,6 +1,6 @@ --- -title: Text To Speech Entity -sidebar_label: Text To Speech +title: Text-to-speech entity +sidebar_label: Text-to-speech --- A text-to-speech (TTS) entity enables Home Assistant to speak to you. diff --git a/docs/core/entity/update.md b/docs/core/entity/update.md index 2e3b0822..33f203ee 100644 --- a/docs/core/entity/update.md +++ b/docs/core/entity/update.md @@ -1,5 +1,5 @@ --- -title: Update Entity +title: Update entity sidebar_label: Update --- @@ -33,7 +33,7 @@ Properties should always only return information from memory and not do I/O (lik Other properties that are common to all entities such as `device_class`, `entity_category`, `icon`, `name` etc are still applicable. -## Supported Features +## Supported features Supported features are defined by using values in the `UpdateEntityFeature` enum. diff --git a/docs/core/entity/vacuum.md b/docs/core/entity/vacuum.md index f65d7155..9129b22b 100644 --- a/docs/core/entity/vacuum.md +++ b/docs/core/entity/vacuum.md @@ -1,5 +1,5 @@ --- -title: Vacuum Entity +title: Vacuum entity sidebar_label: Vacuum --- @@ -35,7 +35,7 @@ Properties should always only return information from memory and not do I/O (lik | `STATE_RETURNING` | The vacuum is done cleaning and is currently returning to the dock, but not yet docked. | `STATE_ERROR` | The vacuum encountered an error while cleaning. -## Supported Features +## Supported features Supported features are defined by using values in the `VacuumEntityFeature` enum and are combined using the bitwise or (`|`) operator. diff --git a/docs/core/entity/valve.md b/docs/core/entity/valve.md index 13236fd6..932dc0d1 100644 --- a/docs/core/entity/valve.md +++ b/docs/core/entity/valve.md @@ -1,5 +1,5 @@ --- -title: Valve Entity +title: Valve entity sidebar_label: Valve --- @@ -19,7 +19,7 @@ Properties should always only return information from memory and not do I/O (lik | is_opening | bool | None | `None` | If the valve is opening or not. Used to determine `state`. | reports_position | bool | **Required** | If the valve knows its position or not. -### Device Classes +### Device classes | Constant | Description |----------|-----------------------| @@ -36,7 +36,7 @@ Properties should always only return information from memory and not do I/O (lik | `STATE_CLOSING` | The valve is in the process of closing to reach a set position. | `STATE_CLOSED` | The valve has reach the closed position. -## Supported Features +## Supported features Supported features are defined by using values in the `ValveEntityFeature` enum and are combined using the bitwise or (`|`) operator. diff --git a/docs/core/entity/wake_word.md b/docs/core/entity/wake_word.md index b48cdd31..b1f97c4d 100644 --- a/docs/core/entity/wake_word.md +++ b/docs/core/entity/wake_word.md @@ -1,6 +1,6 @@ --- -title: Wake Word Detection Entity -sidebar_label: Wake Word Detection +title: Wake word detection entity +sidebar_label: Wake word detection --- A wake word detection entity allows other integrations or applications to detect wake words (also called hotwords) in an audio stream. diff --git a/docs/core/entity/water-heater.md b/docs/core/entity/water-heater.md index cfa9f085..f8dd08a4 100644 --- a/docs/core/entity/water-heater.md +++ b/docs/core/entity/water-heater.md @@ -1,6 +1,6 @@ --- -title: Water Heater Entity -sidebar_label: Water Heater +title: Water heater entity +sidebar_label: Water heater --- Derive entity platforms from [`homeassistant.components.water_heater.WaterHeaterEntity`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/water_heater/__init__.py) @@ -41,7 +41,7 @@ Properties have to follow the units defined in the `temperature_unit`. | `STATE_GAS` | Gas only mode, uses the most energy. | `STATE_OFF` | The water heater is off. -## Supported Features +## Supported features Supported features are defined by using values in the `WaterHeaterEntityFeature` enum and are combined using the bitwise or (`|`) operator. diff --git a/docs/core/entity/weather.md b/docs/core/entity/weather.md index db5de795..4047fbea 100644 --- a/docs/core/entity/weather.md +++ b/docs/core/entity/weather.md @@ -1,5 +1,5 @@ --- -title: Weather Entity +title: Weather entity sidebar_label: Weather --- @@ -32,7 +32,7 @@ Properties should always only return information from memory and not do I/O (lik | uv_index | float | `None` | The current [UV index](https://en.wikipedia.org/wiki/Ultraviolet_index). | wind_bearing | float or string | `None` | The current wind bearing in azimuth angle (degrees) or 1-3 letter cardinal direction. -### Unit Conversion +### Unit conversion Properties have to follow the units mentioned on the respective unit of measurement in the table. @@ -64,7 +64,7 @@ These weather conditions are included in our translation files and also show the This means that the `weather` platforms don't need to support languages. -## Supported Features +## Supported features Supported features are defined by using values in the `WeatherEntityFeature` enum and are combined using the bitwise or (`|`) operator. diff --git a/docs/core/llm/index.md b/docs/core/llm/index.md index 7f94f6af..f7bfa2c9 100644 --- a/docs/core/llm/index.md +++ b/docs/core/llm/index.md @@ -15,7 +15,7 @@ The Assist API is equivalent to the capabilities and exposed entities that are a The LLM API needs to be integrated in two places in your integration. Users need to be able to configure which API should be used, and the tools offered by the API should be passed to the LLM when interacting with it. -### Options Flow +### Options flow The chosen API should be stored in the config entry options. It should hold a string reference to the API id. If no API is selected, the key must be omitted. diff --git a/docs/core/platform/application_credentials.md b/docs/core/platform/application_credentials.md index d63a3c5e..8d05bece 100644 --- a/docs/core/platform/application_credentials.md +++ b/docs/core/platform/application_credentials.md @@ -1,5 +1,5 @@ --- -title: "Application Credentials" +title: "Application credentials" --- Integrations may support [Configuration via OAuth2](/docs/config_entries_config_flow_handler#configuration-via-oauth2) allowing diff --git a/docs/core/platform/raising_exceptions.md b/docs/core/platform/raising_exceptions.md index 8376282e..c4201ac3 100644 --- a/docs/core/platform/raising_exceptions.md +++ b/docs/core/platform/raising_exceptions.md @@ -1,8 +1,8 @@ --- -title: "Raising Exceptions" +title: "Raising exceptions" --- -## Raising Exceptions in service handlers +## Raising exceptions in service handlers Operations like service calls and entity methods (e.g. *Set HVAC Mode*) should raise exceptions properly. @@ -10,6 +10,6 @@ Integrations should raise `ServiceValidationError` (instead of `ValueError`) in For other failures such as a problem communicating with a device, `HomeAssistantError` should be raised. Note that the exception stack trace will be printed to the log in this case. -## Localizing Exceptions +## Localizing exceptions Home Assistant [supports localization](/docs/internationalization/core/#exceptions) for `HomeAssistantError` and its subclasses like `ServiceValidationError`. diff --git a/docs/core/platform/reproduce_state.md b/docs/core/platform/reproduce_state.md index 13931830..d769f9c9 100644 --- a/docs/core/platform/reproduce_state.md +++ b/docs/core/platform/reproduce_state.md @@ -1,5 +1,5 @@ --- -title: "Reproduce State" +title: "Reproduce state" --- Home Assistant has support for scenes. Scenes are a collection of (partial) entity states. When a scene is activated, Home Assistant will try to call the right services to get the specified scenes in their specified state. diff --git a/docs/core/platform/significant_change.md b/docs/core/platform/significant_change.md index 404017bf..1955c635 100644 --- a/docs/core/platform/significant_change.md +++ b/docs/core/platform/significant_change.md @@ -1,5 +1,5 @@ --- -title: "Significant Change" +title: "Significant change" --- Home Assistant doesn't only collect data, it also exports data to various services. Not all of these services are interested in every change. To help these services filter insignificant changes, your entity integration can add significant change support.