mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-27 03:06:30 +00:00
docs-e-t: apply sentence-style capitalization to headings (#2193)
- to comply with MS Style Guide on [capitalization](https://learn.microsoft.com/en-us/style-guide/capitalization)
This commit is contained in:
parent
6323868d0e
commit
dff111c236
@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
title: Entity Registry and disabling entities
|
title: Entity registry and disabling entities
|
||||||
sidebar_label: Disabling entities
|
sidebar_label: Disabling entities
|
||||||
---
|
---
|
||||||
|
|
||||||
@ -7,7 +7,7 @@ The entity registry tracks all entities with unique IDs. For each entity, the re
|
|||||||
|
|
||||||
When `disabled_by` is set and not `None`, the entity will not be added to Home Assistant when the integration passes it to `async_add_entities`.
|
When `disabled_by` is set and not `None`, the entity will not be added to Home Assistant when the integration passes it to `async_add_entities`.
|
||||||
|
|
||||||
## Integration Architecture
|
## Integration architecture
|
||||||
|
|
||||||
Integrations will need to make sure that they work correctly when their entities get disabled. If your integration is keeping references to the created entity objects, it should register those references only inside the entity's lifecycle method `async_added_to_hass`. This lifecycle method is only called if the entity is actually added to Home Assistant (and so it's not disabled).
|
Integrations will need to make sure that they work correctly when their entities get disabled. If your integration is keeping references to the created entity objects, it should register those references only inside the entity's lifecycle method `async_added_to_hass`. This lifecycle method is only called if the entity is actually added to Home Assistant (and so it's not disabled).
|
||||||
|
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
title: Entity Registry
|
title: Entity registry
|
||||||
---
|
---
|
||||||
|
|
||||||
The entity registry is a registry where Home Assistant keeps track of entities. Any entity that is added to Home Assistant which specifies the [`unique_id` attribute](/core/entity.md#generic-properties) will be registered in the registry.
|
The entity registry is a registry where Home Assistant keeps track of entities. Any entity that is added to Home Assistant which specifies the [`unique_id` attribute](/core/entity.md#generic-properties) will be registered in the registry.
|
||||||
|
@ -1,10 +1,10 @@
|
|||||||
---
|
---
|
||||||
title: "Fetching Data"
|
title: "Fetching data"
|
||||||
---
|
---
|
||||||
|
|
||||||
Your integration will need to fetch data from an API to be able to provide this to Home Assistant. This API can be available over the web (local or cloud), sockets, serial ports exposed via USB sticks, etc.
|
Your integration will need to fetch data from an API to be able to provide this to Home Assistant. This API can be available over the web (local or cloud), sockets, serial ports exposed via USB sticks, etc.
|
||||||
|
|
||||||
## Push vs Poll
|
## Push vs poll
|
||||||
|
|
||||||
APIs come in many different shapes and forms but at its core they fall in two categories: push and poll.
|
APIs come in many different shapes and forms but at its core they fall in two categories: push and poll.
|
||||||
|
|
||||||
@ -164,7 +164,7 @@ If you have an API endpoint that pushes data, you can still use the data update
|
|||||||
|
|
||||||
When new data arrives, use `coordinator.async_set_updated_data(data)` to pass the data to the entities. If this method is used on a coordinator that polls, it will reset the time until the next time it will poll for data.
|
When new data arrives, use `coordinator.async_set_updated_data(data)` to pass the data to the entities. If this method is used on a coordinator that polls, it will reset the time until the next time it will poll for data.
|
||||||
|
|
||||||
## Request Parallelism
|
## Request parallelism
|
||||||
|
|
||||||
:::info
|
:::info
|
||||||
This is an advanced topic.
|
This is an advanced topic.
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
title: "Integration Quality Scale"
|
title: "Integration quality scale"
|
||||||
---
|
---
|
||||||
|
|
||||||
The Integration Quality Scale scores each integration based on the code quality and user experience. Each level of the quality scale consists of a list of requirements. If an integration matches all requirements, it's considered to have reached that level.
|
The Integration Quality Scale scores each integration based on the code quality and user experience. Each level of the quality scale consists of a list of requirements. If an integration matches all requirements, it's considered to have reached that level.
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
title: "Handling Setup Failures"
|
title: "Handling setup failures"
|
||||||
---
|
---
|
||||||
|
|
||||||
Your integration may not be able to be set up for a variety of reasons. The most common cases are because the device or service is offline or the credentials are no longer valid. Your integration must retry setup so it can recover as soon as reasonably possible when the device or service is back online without the user having to restart Home Assistant.
|
Your integration may not be able to be set up for a variety of reasons. The most common cases are because the device or service is offline or the credentials are no longer valid. Your integration must retry setup so it can recover as soon as reasonably possible when the device or service is back online without the user having to restart Home Assistant.
|
||||||
|
@ -37,7 +37,7 @@ The following input fields are available:
|
|||||||
| `conversation_id` | string | Optional. Unique id to [track conversation](#conversation-id). Generated by Home Assistant. |
|
| `conversation_id` | string | Optional. Unique id to [track conversation](#conversation-id). Generated by Home Assistant. |
|
||||||
|
|
||||||
|
|
||||||
## Conversation Response
|
## Conversation response
|
||||||
|
|
||||||
The JSON response from `/api/conversation/process` contains information about the effect of the fired intent, for example:
|
The JSON response from `/api/conversation/process` contains information about the effect of the fired intent, for example:
|
||||||
|
|
||||||
@ -91,9 +91,9 @@ The following properties are available in the `"response"` object:
|
|||||||
The [conversation id](#conversation-id) is returned alongside the conversation response.
|
The [conversation id](#conversation-id) is returned alongside the conversation response.
|
||||||
|
|
||||||
|
|
||||||
## Response Types
|
## Response types
|
||||||
|
|
||||||
### Action Done
|
### Action done
|
||||||
|
|
||||||
The intent produced an action in Home Assistant, such as turning on a light. The `data` property of the response contains a `targets` list, where each target looks like:
|
The intent produced an action in Home Assistant, such as turning on a light. The `data` property of the response contains a `targets` list, where each target looks like:
|
||||||
|
|
||||||
@ -149,7 +149,7 @@ Most intents end up with 0, 1 or 2 targets. 3 targets currenly only happens when
|
|||||||
* 3 targets: `area:kitchen`, `domain:cover`, `device_class:blind`
|
* 3 targets: `area:kitchen`, `domain:cover`, `device_class:blind`
|
||||||
|
|
||||||
|
|
||||||
### Query Answer
|
### Query answer
|
||||||
|
|
||||||
The response is an answer to a question, such as "what is the temperature?". See the [speech](#speech) property for the answer text.
|
The response is an answer to a question, such as "what is the temperature?". See the [speech](#speech) property for the answer text.
|
||||||
|
|
||||||
@ -286,7 +286,7 @@ POST with the next input sentence:
|
|||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Pre-loading Sentences
|
## Pre-loading sentences
|
||||||
|
|
||||||
Sentences for a language can be pre-loaded using the WebSocket API:
|
Sentences for a language can be pre-loaded using the WebSocket API:
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: "Networking and Discovery"
|
title: "Networking and discovery"
|
||||||
sidebar_label: "Networking and Discovery"
|
sidebar_label: "Networking and discovery"
|
||||||
---
|
---
|
||||||
|
|
||||||
Some integrations may need to discover devices on the network via [mDNS/Zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking), [SSDP](https://en.wikipedia.org/wiki/Simple_Service_Discovery_Protocol), or another method once they have been enabled. The primary use case is to find devices that do not have a known fixed IP Address or for integrations that can dynamically add and remove any number of compatible discoverable devices.
|
Some integrations may need to discover devices on the network via [mDNS/Zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking), [SSDP](https://en.wikipedia.org/wiki/Simple_Service_Discovery_Protocol), or another method once they have been enabled. The primary use case is to find devices that do not have a known fixed IP Address or for integrations that can dynamically add and remove any number of compatible discoverable devices.
|
||||||
|
@ -33,7 +33,7 @@ Home Assistant.
|
|||||||
|
|
||||||
## Before creating your PR
|
## Before creating your PR
|
||||||
|
|
||||||
**Comply with Architectural Decisions.**
|
**Comply with architectural decisions.**
|
||||||
|
|
||||||
All architectural decisions around the Home Assistant project are recorded in
|
All architectural decisions around the Home Assistant project are recorded in
|
||||||
the [ADR folder](https://github.com/home-assistant/architecture/tree/master/adr).
|
the [ADR folder](https://github.com/home-assistant/architecture/tree/master/adr).
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
title: "Contributing Translation"
|
title: "Contributing translation"
|
||||||
---
|
---
|
||||||
|
|
||||||
Translations for Home Assistant are managed through [Lokalise](https://lokalise.com/), an online translation management tool. Our translations are split between four projects: a backend project for platform-specific translations, a frontend project for UI translations, and two for the official companion apps. Click the links below to join the projects! Even if your language is completely translated, extra proofreading is a big help! Please feel free to review the existing translations, and vote for alternatives that might be more appropriate.
|
Translations for Home Assistant are managed through [Lokalise](https://lokalise.com/), an online translation management tool. Our translations are split between four projects: a backend project for platform-specific translations, a frontend project for UI translations, and two for the official companion apps. Click the links below to join the projects! Even if your language is completely translated, extra proofreading is a big help! Please feel free to review the existing translations, and vote for alternatives that might be more appropriate.
|
||||||
@ -51,13 +51,16 @@ Region specific translations (`en-US`, `fr-CA`) will only be included if transla
|
|||||||
Note: Sometimes you have to change the tag in Lokalise (Language -> Language settings -> custom ISO code).
|
Note: Sometimes you have to change the tag in Lokalise (Language -> Language settings -> custom ISO code).
|
||||||
|
|
||||||
## Language specific guidelines
|
## Language specific guidelines
|
||||||
|
|
||||||
Most languages have multiple possible translations of a sentence. Please take a look at the guidelines for your language here, where you can also find some typical mistakes to prevent.
|
Most languages have multiple possible translations of a sentence. Please take a look at the guidelines for your language here, where you can also find some typical mistakes to prevent.
|
||||||
The sections are written in their corresponding languages, as this makes explaining the grammar easier and only native speakers should submit translations (see [Rules](#rules)).
|
The sections are written in their corresponding languages, as this makes explaining the grammar easier and only native speakers should submit translations (see [Rules](#rules)).
|
||||||
|
|
||||||
### German
|
### German
|
||||||
|
|
||||||
- Du/Sie: Duze in den Übersetzungen, und verwende nicht das formale "Sie".
|
- Du/Sie: Duze in den Übersetzungen, und verwende nicht das formale "Sie".
|
||||||
|
|
||||||
#### Typische Fehler
|
#### Typische Fehler
|
||||||
|
|
||||||
- Achte auf den richtigen Imperativ. Der Imperativ ist die Befehlsform, z. B. "Gib mir das Wasser". Falsch wäre hier: "Gebe mir das Wasser" (siehe [Bildung des Imperativs](https://www.duden.de/sprachwissen/sprachratgeber/Bildung-des-Imperativs)).
|
- Achte auf den richtigen Imperativ. Der Imperativ ist die Befehlsform, z. B. "Gib mir das Wasser". Falsch wäre hier: "Gebe mir das Wasser" (siehe [Bildung des Imperativs](https://www.duden.de/sprachwissen/sprachratgeber/Bildung-des-Imperativs)).
|
||||||
|
|
||||||
### French
|
### French
|
||||||
|
Loading…
x
Reference in New Issue
Block a user