Add "Tools and Helper" section (#2114)

This commit is contained in:
Fabian Affolter 2017-02-23 17:21:07 +01:00 committed by GitHub
parent eabad4f1ef
commit 9d709051d9
6 changed files with 67 additions and 12 deletions

View File

@ -9,4 +9,5 @@ sharing: true
footer: true
---
Home Assistant ships a couple of helpers for the command-line and the frontend which simplify common tasks, are helping with migrations, and ensure that Home Assistant runs properly.
Home Assistant ships a couple of helpers for the command-line and the frontend which simplify common tasks, are helping with migrations, and ensure that Home Assistant runs properly.

View File

@ -1,12 +1,25 @@
---
layout: page
title: "Tools"
description: "Description of tools which helps when using Home Assistant."
release_date: 2016-11-13 15:00:00
title: "Development Tools"
description: "Description of the Developer Tools."
release_date: 2017-02-23 11:00:00
sidebar: true
comments: false
sharing: true
footer: true
---
Home Assistant ships a couple of helpers for the command-line and the frontend which simplify common tasks, are helping with migrations, and ensure that Home Assistant runs properly.
The frontend contains a section called "Developer Tools".
<p class='img'>
<img src='/images/screenshots/developer-tools.png' />
Screenshot of Home Assistant's Developer Tools.
</p>
| Section | description |
| ------- | ----- |
| Services | Calls services from components |
| States | Sets the representation of an entity |
| Events | Fires events |
| Templates | Renders templates |
| Info | Details about Home Assistant |

View File

@ -1,15 +1,15 @@
---
layout: page
title: "Hass"
description: "Description of tools which helps when using Home Assistant."
release_date: 2016-11-13 15:00:00
title: "hass"
description: "Description of hass."
release_date: 2017-02-23 11:00:00
sidebar: true
comments: false
sharing: true
footer: true
---
The command-line part of Home Assistant is
The command-line part of Home Assistant is `hass`.
```bash
@ -41,3 +41,5 @@ optional arguments:
--script ... Run one of the embedded scripts
--daemon Run Home Assistant as daemon
```

View File

@ -2,11 +2,43 @@
layout: page
title: "Tools"
description: "Description of tools which helps when using Home Assistant."
release_date: 2016-11-13 15:00:00
release_date: 2017-02-23 11:00:00
sidebar: true
comments: false
sharing: true
footer: true
---
Home Assistant ships a couple of helpers for the command-line and the frontend which simplify common tasks, are helping with migrations, and ensure that Home Assistant runs properly.
The command-line and the frontend which simplify common tasks, are helping with migrations, and ensure that Home Assistant runs properly. Please do not confuse those with with Home Assistant's [script](/docs/scripts/) feature.
### {% linkable_title Configuration check %}
Test any changes to your `configuration.yaml` file before launching Home Assistant. This script allows you to test changes without the need to restart Home Assistant.
```bash
$ hass --script check_config
```
### {% linkable_title Existance of configuration %}
This script checks if the `configuration.yaml` file exists. If the file is not available, one is created.
```bash
$ hass --script ensure_config
```
### {% linkable_title Secrets %}
There is a method to store secrets outside of your `configuration.yaml` file. For further details, please refer to the [Storing Secrets](/docs/configuration/secrets/) documentation.
```bash
$ hass --script keyring
```
### {% linkable_title Old scripts %}
Usally those scripts were only use when a massive update happend and was announced in the release notes.
- `db_migrator`: Migrate an existing SQLite database to the new schema.
- `influxdb_migrator`: Convert an old InfluxDB to the new format.

View File

@ -33,7 +33,6 @@
<li>{% active_link /docs/configuration/basic/ Basic information %}</li>
<li>{% active_link /docs/configuration/devices/ Setting up devices %}</li>
<li>{% active_link /docs/configuration/customizing-devices/ Customizing devices and services %}</li>
<li>{% active_link /docs/configuration/presence-detection/ Presence Detection %}</li>
<li>{% active_link /docs/configuration/troubleshooting/ Troubleshooting %}</li>
<li>{% active_link /docs/configuration/securing/ Security Check Points %}</li>
</ul>
@ -85,6 +84,14 @@
<li>{% active_link /docs/scripts/conditions/ Conditions %}</li>
</ul>
</li>
<li>
{% active_link /docs/tools/ Tools and Helpers %}
<ul>
<li>{% active_link /docs/tools/dev-tools/ Developer Tools %}</li>
<li>{% active_link /docs/tools/hass/ hass %}</li>
<li>{% active_link /docs/tools/scripts/ Scripts %}</li>
</ul>
</li>
<li>
{% active_link /docs/z-wave/ Z-Wave %}
<ul>

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.5 KiB