mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-16 13:56:29 +00:00
Fix some typos (#679)
This commit is contained in:
parent
e47096e7d5
commit
c67f2bdef7
@ -18,7 +18,7 @@ To summarize, here's how requests should be made:
|
||||
|
||||
## Short note on instance URLs
|
||||
|
||||
Some users have configured Home Assistant to be available outside of their home network using a dynamic DNS service. There are some routers that don't support hairpinning / NAT loopback: a device sending data from inside the routers network, via the externally configured DNS service, to Home Asisstant, which also resides inside the local network.
|
||||
Some users have configured Home Assistant to be available outside of their home network using a dynamic DNS service. There are some routers that don't support hairpinning / NAT loopback: a device sending data from inside the routers network, via the externally configured DNS service, to Home Assistant, which also resides inside the local network.
|
||||
|
||||
To work around this, the app should record which WiFi SSID is the users home network, and use a direct connection when connected to the home WiFi network.
|
||||
|
||||
@ -110,7 +110,7 @@ This message will inform Home Assistant of new location information.
|
||||
| --- | ---- | -----------
|
||||
| `location_name` | string | Name of the zone the device is in.
|
||||
| `gps` | latlong | Current location as latitude and longitude.
|
||||
| `gps_accuracy` | int | GPS accurracy in meters. Must be greater than 0.
|
||||
| `gps_accuracy` | int | GPS accuracy in meters. Must be greater than 0.
|
||||
| `battery` | int | Percentage of battery the device has left. Must be greater than 0.
|
||||
| `speed` | int | Speed of the device in meters per second. Must be greater than 0.
|
||||
| `altitude` | int | Altitude of the device in meters. Must be greater than 0.
|
||||
|
@ -979,7 +979,7 @@ Return information about enabled discoveries.
|
||||
| key | type | description |
|
||||
| --------- | ---------- | ------------------------------------------------------------------------------- |
|
||||
| discovery | list | A list of [Discovery models](api/supervisor/models.md#discovery) |
|
||||
| services | dictionary | A dictionary of services that contains a list of add-ons that have that serive. |
|
||||
| services | dictionary | A dictionary of services that contains a list of add-ons that have that service. |
|
||||
|
||||
**Example response:**
|
||||
|
||||
@ -1464,7 +1464,7 @@ Returns a dict with selected keys from other `/*/info` endpoints.
|
||||
| homeassistant | string | The installed version of Home Assistant |
|
||||
| hassos | string or null | The version of Home Assistant OS or null |
|
||||
| docker | string | The docker version on the host |
|
||||
| hostname | string | The hostname on the hsot |
|
||||
| hostname | string | The hostname on the host |
|
||||
| operating_system | string | The operating system on the host |
|
||||
| features | list | A list ov available features on the host |
|
||||
| machine | string | The machine type |
|
||||
|
@ -45,7 +45,7 @@ These models are describing objects that are getting returned from the superviso
|
||||
|
||||
| key | type | description |
|
||||
| ------------ | ----------- | -------------------------------------------- |
|
||||
| name | string | The descriptnameion of the device |
|
||||
| name | string | The name of the device |
|
||||
| index | int | TODO: What is this? |
|
||||
| description | string | The description of the device |
|
||||
| volume | float | The current volume |
|
||||
|
@ -234,7 +234,7 @@ If the access token is no longer valid, you will get a response with HTTP status
|
||||
|
||||
Sometimes you want a user to make a GET request to Home Assistant to download data. In this case the normal auth system won't do, as we can't link the user to an API with the auth header attached to it. In that case, a signed path can help.
|
||||
|
||||
A signed path is a normal path on our server, like `/api/states`, but with an attached secure authentication signature. The user is able to navigate to this path and will be authorised as the access token that created the signed path. Signed paths can be created via the websocket connection and are meant to be shortlived. The default expiration is 30 seconds.
|
||||
A signed path is a normal path on our server, like `/api/states`, but with an attached secure authentication signature. The user is able to navigate to this path and will be authorized as the access token that created the signed path. Signed paths can be created via the websocket connection and are meant to be shortlived. The default expiration is 30 seconds.
|
||||
|
||||
To get a signed path, send the following command:
|
||||
|
||||
|
@ -10,7 +10,7 @@ The Home Assistant instance contains four objects to help you interact with the
|
||||
|
||||
| Object | Description |
|
||||
| ------ | ----------- |
|
||||
| `hass` | This is the instance of Home Assistant. Allows starting, stopping and enqueing new jobs. [See available methods.](https://dev-docs.home-assistant.io/en/master/api/core.html#homeassistant.core.HomeAssistant)
|
||||
| `hass` | This is the instance of Home Assistant. Allows starting, stopping and enqueuing new jobs. [See available methods.](https://dev-docs.home-assistant.io/en/master/api/core.html#homeassistant.core.HomeAssistant)
|
||||
| `hass.config` | This is the core configuration of Home Assistant exposing location, temperature preferences and config directory path. [See available methods.](https://dev-docs.home-assistant.io/en/master/api/core.html#homeassistant.core.Config)
|
||||
| `hass.states` | This is the StateMachine. It allows you to set states and track when they are changed. [See available methods.](https://dev-docs.home-assistant.io/en/master/api/core.html#homeassistant.core.StateMachine) |
|
||||
| `hass.bus` | This is the EventBus. It allows you to trigger and listen for events. [See available methods.](https://dev-docs.home-assistant.io/en/master/api/core.html#homeassistant.core.EventBus) |
|
||||
|
@ -128,7 +128,7 @@ If you can map exactly one device endpoint to a single entity, you can fetch the
|
||||
|
||||
If your entities need to fetch data before being written to Home Assistant for the first time, pass `True` to the `add_entities` method: `add_entities([MyEntity()], True)`.
|
||||
|
||||
You can control the polling interval for your integration by defining a `SCAN_INTERVAL` constant in your platform. Careful with setting this too low. It will take up resources in Home Assistant, can overwelm the device hosting the API or can get you blocked from cloud APIs.
|
||||
You can control the polling interval for your integration by defining a `SCAN_INTERVAL` constant in your platform. Careful with setting this too low. It will take up resources in Home Assistant, can overwhelm the device hosting the API or can get you blocked from cloud APIs.
|
||||
|
||||
```python
|
||||
from datetime import timedelta
|
||||
|
@ -43,7 +43,7 @@ Region specific translations (`en-US`, `fr-CA`) will only be included if transla
|
||||
|
||||
### Maintainer steps to add a new language
|
||||
|
||||
1. Language tags have to follow [BCP 47](https://tools.ietf.org/html/bcp47). A list of most language tags can be found here: [IANA sutbtag registry](http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry). Examples: `fr`, `fr-CA`, `zh-Hans`. Only include the country code if country specific overrides are being included, and the base language is already translated.
|
||||
1. Language tags have to follow [BCP 47](https://tools.ietf.org/html/bcp47). A list of most language tags can be found here: [IANA subtag registry](http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry). Examples: `fr`, `fr-CA`, `zh-Hans`. Only include the country code if country specific overrides are being included, and the base language is already translated.
|
||||
2. Add the language tag and native name in `src/translations/translationMetadata.json`. Examples: "Français", "Français (CA)"
|
||||
3. Add the new language in Lokalize.
|
||||
Note: Sometimes you have to change the tag in Lokalise (Language -> Language settings -> custom ISO code).
|
||||
|
Loading…
x
Reference in New Issue
Block a user