mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-09 18:36:29 +00:00
Fixes some Typos in the Documentation (#678)
* Fixing typo on development_enviornment.md * Fixing various typos throughout the docs, it's not much but it's honest work
This commit is contained in:
parent
8ae682b98d
commit
e47096e7d5
@ -213,7 +213,7 @@ You can pass the following optional GET parameters:
|
||||
- `filter_entity_id=<entity_ids>` to filter on one or more entities - comma separated.
|
||||
- `end_time=<timestamp>` to choose the end of the period in URL encoded format (defaults to 1 day).
|
||||
- `minimal_response` to only return `last_changed` and `state` for states other than the first and last state (much faster).
|
||||
- `significant_changes_only` to only return signifcant state changes.
|
||||
- `significant_changes_only` to only return significant state changes.
|
||||
|
||||
Example without `minimal_response`
|
||||
```json
|
||||
@ -458,7 +458,7 @@ curl -X GET -H "Authorization: Bearer ABCDEFGH" \
|
||||
Updates or creates a state. You can create any state that you want, it does not have to be backed by an entity in Home Assistant.
|
||||
|
||||
:::info
|
||||
This endpoint sets the representation of a device within Home Asistant and will not communicate with the actual device. To communicate with the device, use the [POST /api/services/<domain>/<service>](#post-apiservicesltdomainltservice) endpoint.
|
||||
This endpoint sets the representation of a device within Home Assistant and will not communicate with the actual device. To communicate with the device, use the [POST /api/services/<domain>/<service>](#post-apiservicesltdomainltservice) endpoint.
|
||||
:::
|
||||
|
||||
Expects a JSON object that has at least a state attribute:
|
||||
|
@ -31,7 +31,7 @@ Our library will consist of two different parts:
|
||||
|
||||
## Trying your library inside Home Assistant
|
||||
|
||||
You will need to run an editable version of your library if you want to try your library in Home Assistant before it is publised to PyPI.
|
||||
You will need to run an editable version of your library if you want to try your library in Home Assistant before it is published to PyPI.
|
||||
|
||||
Do so by going to your Home Assistant development environment, activating the virtual environment and typing:
|
||||
|
||||
|
@ -68,4 +68,4 @@ In this example, user will first select from `homeassistant` or `legacy_api_pass
|
||||
|
||||
## Validation session
|
||||
|
||||
Not like auth provider, auth module use session to manage the validation. After auth provider validated, mfa module will create a validation session, include an experiation time and user_id from auth provider validate result. Mutli-factor auth module will not only verify the user input, but also verify the session is not expired. The validation session data is stored in your configuration directory.
|
||||
Not like auth provider, auth module use session to manage the validation. After auth provider validated, mfa module will create a validation session, include an expiration time and user_id from auth provider validate result. Multi-factor auth module will not only verify the user input, but also verify the session is not expired. The validation session data is stored in your configuration directory.
|
||||
|
@ -33,7 +33,7 @@ Auth providers shall extend the following methods of `LoginFlow` class.
|
||||
## async_step_init of LoginFlow
|
||||
|
||||
:::info
|
||||
We may change this inteface in near future.
|
||||
We may change this interface in near future.
|
||||
:::
|
||||
|
||||
`LoginFlow` extends `data_entry_flow.FlowHandler`. The first step of data entry flow is hard coded as `init`, so each flow has to implement `async_step_init` method. The pattern of `async_step_init` likes following pseudo-code:
|
||||
|
@ -113,7 +113,7 @@ To check a permission, you will need to have access to the user object. Once you
|
||||
|
||||
```python
|
||||
from homeassistant.exceptions import Unauthorized
|
||||
from homeasistant.permissions.const import POLICY_READ, POLICY_CONTROL, POLICY_EDIT
|
||||
from homeassistant.permissions.const import POLICY_READ, POLICY_CONTROL, POLICY_EDIT
|
||||
|
||||
# Raise error if user is not an admin
|
||||
if not user.is_admin:
|
||||
@ -142,7 +142,7 @@ await hass.services.async_call(
|
||||
|
||||
### If a permission check fails
|
||||
|
||||
When you detect an anauthorized action, you should raise the `homeassistant.exceptions.Unauthorized` exception. This exception will cancel the current action and notifies the user that their action is unauthorized.
|
||||
When you detect an unauthorized action, you should raise the `homeassistant.exceptions.Unauthorized` exception. This exception will cancel the current action and notifies the user that their action is unauthorized.
|
||||
|
||||
The `Unauthorized` exception has various parameters, to identify the permission check that failed. All fields are optional.
|
||||
|
||||
@ -258,7 +258,7 @@ user via `connection.user`. If you need to check admin access, you can use the
|
||||
built-in `@require_admin` decorator.
|
||||
|
||||
```python
|
||||
from homeassistant.compnents import websocket_api
|
||||
from homeassistant.components import websocket_api
|
||||
|
||||
|
||||
async def async_setup(hass, config):
|
||||
|
@ -61,7 +61,7 @@ The HVAC action describes the _current_ action. This is different from the mode,
|
||||
| `CURRENT_HVAC_OFF` | Device is turned off. |
|
||||
| `CURRENT_HVAC_HEAT` | Device is heating. |
|
||||
| `CURRENT_HVAC_COOL` | Device is cooling. |
|
||||
| `CURRENT_HVAC_DRY` | Device is dring. |
|
||||
| `CURRENT_HVAC_DRY` | Device is drying. |
|
||||
| `CURRENT_HVAC_IDLE` | Device is idle. |
|
||||
|
||||
### Presets
|
||||
|
@ -23,7 +23,7 @@ A light entity controls the brightness, hue and saturation color value, white va
|
||||
|
||||
## Support Feature
|
||||
|
||||
| Constant | Description
|
||||
| Constant | Description
|
||||
|----------|-----------------------
|
||||
| `SUPPORT_BRIGHTNESS` | Controls the brightness of a light source
|
||||
| `SUPPORT_COLOR` | Controls the color a light source shows
|
||||
|
@ -20,14 +20,14 @@ Properties should always only return information from memory and not do I/O (lik
|
||||
| sound_mode | string | None | The current sound mode of the media player
|
||||
| sound_mode_list | list | None | Dynamic list of available sound modes (set by platform, empty means sound mode not supported)
|
||||
| source | string | None | The currently selected input source for the media player.
|
||||
| source_list | list | None | The list of possible input sources for the media player. (This list should contain human readable names, suitible for frontend display)
|
||||
| source_list | list | None | The list of possible input sources for the media player. (This list should contain human readable names, suitable for frontend display)
|
||||
| media_image_url | string | None | URL that represents the current image.
|
||||
| media_image_remotely_accessible | boolean | False | Return `True` if property `media_image_url` is accessible outside of the home network.
|
||||
| device_class | string | `None` | Type of media player.
|
||||
|
||||
## Supported Features
|
||||
|
||||
| Constant | Description
|
||||
| Constant | Description
|
||||
| -------- | -----------
|
||||
| `SUPPORT_CLEAR_PLAYLIST` | Entity allows clearing the active playlist.
|
||||
| `SUPPORT_NEXT_TRACK` | Entity allows skipping to the next media track.
|
||||
|
@ -14,7 +14,7 @@ Properties should always only return information from memory and not do I/O (lik
|
||||
|
||||
## Supported Features
|
||||
|
||||
| Constant | Description
|
||||
| Constant | Description
|
||||
| -------- | -----------
|
||||
| `SUPPORT_LEARN_COMMAND` | Entity allows learning commands from devices.
|
||||
|
||||
|
@ -31,7 +31,7 @@ When you open this repository with Visual Studio code you are asked to "Reopen i
|
||||
|
||||
### Tasks
|
||||
|
||||
The devcontainter comes with some useful tasks to help you with development, you can start these tasks by opening the command palette and select `Tasks: Run Task` then select the task you want to run.
|
||||
The devcontainer comes with some useful tasks to help you with development, you can start these tasks by opening the command palette and select `Tasks: Run Task` then select the task you want to run.
|
||||
|
||||
When a task is currently running (like `Preview` for the docs), it can be restarted by opening the command palette and selecting `Tasks: Restart Running Task`, then select the task you want to restart.
|
||||
|
||||
|
@ -24,11 +24,11 @@ Running `tox` will run unit tests against the locally available Python releases,
|
||||
|
||||
`tox` uses virtual environments under the hood to create isolated testing environments. The `tox` virtual environments will get out-of-date when requirements change, causing test errors. Run `tox -r` to tell `tox` to recreate the virtual environments.
|
||||
|
||||
macOS users may see an `Error creating virtualenv` when runnng `tox`. If this occurs, install the [tox-venv](https://pypi.org/project/tox-venv/) package using the command `pip install tox-venv` and try again.
|
||||
macOS users may see an `Error creating virtualenv` when running `tox`. If this occurs, install the [tox-venv](https://pypi.org/project/tox-venv/) package using the command `pip install tox-venv` and try again.
|
||||
|
||||
### Adding new dependencies to test environment
|
||||
|
||||
If you are working on tests for an integeration and you need the dependencies available inside the `tox` environment, update the list inside `script/gen_requirements_all.py`. Then run the script and then run `tox -r` to recreate the virtual environments.
|
||||
If you are working on tests for an integration and you need the dependencies available inside the `tox` environment, update the list inside `script/gen_requirements_all.py`. Then run the script and then run `tox -r` to recreate the virtual environments.
|
||||
|
||||
### Running single tests using `tox`
|
||||
|
||||
|
@ -42,7 +42,7 @@ Supported features constants are combined using the bitwise or (`|`) operator.
|
||||
|
||||
| Name | Description |
|
||||
| ------------------------- | ------------------------------------------ |
|
||||
| `SUPPORT_MODES` | The device supports defferent modes. |
|
||||
| `SUPPORT_MODES` | The device supports different modes. |
|
||||
|
||||
|
||||
## Methods
|
||||
|
@ -243,7 +243,7 @@ Your card can also define a `getStubConfig` method that returns a default card c
|
||||
Home Assistant will call the `setConfig` method of the config element on setup.
|
||||
Home Assistant will update the `hass` property of the config element on state changes, and the `lovelace` element, which contains information about the lovelace configuration.
|
||||
|
||||
Changes to the configuration are comunicated back to lovelace by dispatching an `config-changed` event with the new configuration in it's detail.
|
||||
Changes to the configuration are communicated back to lovelace by dispatching an `config-changed` event with the new configuration in it's detail.
|
||||
|
||||
To have your card displayed in the card picker dialog in Lovelace, add an object describing it to the array `window.customCards`. Required properties of the object are `type` and `name` (see example below).
|
||||
|
||||
|
@ -8,4 +8,4 @@ Resources can be registered from the "Resources" tab of the Lovelace Configurati
|
||||
|
||||
This tab is only available when the active user's profile has "advanced mode" enabled.
|
||||
|
||||

|
||||

|
||||
|
@ -31,7 +31,7 @@ ssh root@homeassistant.local -p 22222
|
||||
|
||||
If you have an older installation or have changed your hostname, you may need to use a different hostname in the command above. You can check the correct hostname to use in the System page of the Supervisor interface in Home Assistant.
|
||||
|
||||
You will initially be logged in to Home Assistant CLI for HassOS where you can perform normal [CLI functions]. If you need access to the host system use the 'login' command. [Home Assistant OS] is a hypervisor for Docker. See the [Supervisor Architecture] documentation for information regarding the supervisor. The supervisor offers an API to manage the host and running the Docker containers. Home Assistant itself and all installed addon's run in separate Docker containers.
|
||||
You will initially be logged in to Home Assistant CLI for HassOS where you can perform normal [CLI functions]. If you need access to the host system use the 'login' command. [Home Assistant OS] is a hypervisor for Docker. See the [Supervisor Architecture] documentation for information regarding the supervisor. The supervisor offers an API to manage the host and running the Docker containers. Home Assistant itself and all installed addons run in separate Docker containers.
|
||||
|
||||
[CLI functions]: https://www.home-assistant.io/hassio/commandline/
|
||||
[Home Assistant OS]: https://github.com/home-assistant/hassos
|
||||
|
Loading…
x
Reference in New Issue
Block a user