Merge pull request #5963 from home-assistant/skalavala-patch-1

new lovelace config generator addition
This commit is contained in:
Vasiley 2018-08-05 19:09:14 -05:00 committed by GitHub
commit 975689e4fe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 107 additions and 57 deletions

View File

@ -142,13 +142,13 @@ social:
# Home Assistant release details
current_major_version: 0
current_minor_version: 75
current_patch_version: 0
date_released: 2018-08-03
current_patch_version: 1
date_released: 2018-08-04
# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.
# Major release:
patch_version_notes: "#"
patch_version_notes: "#release-0751---august-4"
# Minor release (Example #release-0431---april-25):
# Date we moved to Discourse for comments

View File

@ -2,7 +2,7 @@
layout: page
title: "HASS Configurator"
description: "Browser-based configuration file editor for Home Assistant."
date: 2017-09-25 14:00
date: 2018-07-16 14:00
sidebar: true
comments: false
sharing: true
@ -22,16 +22,17 @@ Screenshot of the HASS Configurator.
### {% linkable_title Feature list %}
- Web-based editor to modify your files with syntax highlighting.
- Web-based editor to modify your files with syntax highlighting and YAML linting.
- Upload and download files.
- Stage and commit changes in Git repositories, create and switch between branches, push to remotes.
- Lists of available triggers, events, entities, conditions and services. The selected element gets inserted into the editor at the last cursor position.
- Stage, stash and commit changes in Git repositories, create and switch between branches, push to remotes, view diffs.
- Lists with available entities, triggers, events, conditions and services.
- Restart Home Assistant directly with the click of a button. Reloading groups, automations, etc. can be done as well. An API password is required.
- SSL/TLS support.
- Optional authentication and IP filtering for added security.
- Direct links to Home Assistant documentation and icons.
- Execute shell commands within the add-on container.
- Editor settings are saved in your browser.
- And much more...
### {% linkable_title Add-on Configuration %}
@ -39,27 +40,44 @@ Screenshot of the HASS Configurator.
{
"username": "admin",
"password": "secret",
"ssl": false,
"certfile": "fullchain.pem",
"keyfile": "privkey.pem",
"ssl": false,
"allowed_networks": ["192.168.0.0/16"],
"banned_ips": ["8.8.8.8"],
"verify_hostname": false,
"allowed_networks": [
"192.168.0.0/16",
"172.30.0.0/16"
],
"banned_ips": [
"8.8.8.8"
],
"banlimit": 0,
"ignore_pattern": ["__pycache__"],
"ignore_pattern": [
"__pycache__"
],
"dirsfirst": false,
"sesame": "somesecretnobodycanguess"
"enforce_basepath": false,
"notify_service": "persistent_notification.create",
"ignore_ssl": false
}
```
- **username** (*Required*): Set a username to access your configuration is protected.
- **password** (*Required*): Set a password for access.
- **ssl** (*Optional*): Enable or Disable SSL/TLS for the editor.
- **allowed_networks** (*Optional*): Limit access to the configurator by adding allowed IP addresses/networks to the list.
- **banned_ips** (*Optional*): List of statically banned IP addresses.
- **banlimit** (*Optional*): Ban access from IPs after `banlimit` failed login attempts. The default value `0` disables this feature. Restart the add-on to clear the list of banned IP addresses.
- **ignore_pattern** (*Optional*): Files and folders to ignore in the UI.
- **dirsfirst** (*Optional*): List directories before files in the file browser.
- **sesame** (*Optional*): Secret token to dynamically allow access from the IP the request originates from. Open your bookmark https://hassio.yourdomain.com:8123/somesecretnobodycanguess while `allowed_networks` is set to `[]` and boom! Open Sesame! You can use the _Network status_ menu to revoke IP addresses for which access has been granted.
- **ssl** (*Required*): Enable or Disable SSL/TLS for the editor.
- **certfile** (*Required*): Set the path the your SSL certificate if the ssl-option is set to `true`.
- **keyfile** (*Required*): Set the path the your SSL private key if the ssl-option is set to `true`.
- **allowed_networks** (*Required*): Limit access to the configurator by adding allowed IP addresses/networks to the list.
- **banned_ips** (*Required*): List of statically banned IP addresses.
- **banlimit** (*Required*): Ban access from IPs after `banlimit` failed login attempts. The default value `0` disables this feature. Restart the add-on to clear the list of banned IP addresses.
- **ignore_pattern** (*Required*): Files and folders to ignore in the UI.
- **dirsfirst** (*Required*): List directories before files in the file browser.
- **enforce_basepath** (*Required*): If set to `true`, access is limited to files within the `/config` directory.
- **notify_service** (*Required*): Specify a custom notify-service to be used to push notifications.
- **ignore_ssl** (*Required*): Ignore SSL errors when accessing the Home Assistant API.
- **sesame** (*Optional*): Secret token to dynamically allow access from the IP the request originates from. Open your bookmark https://hassio.yourdomain.com:8123/somesecretnobodycanguess while `allowed_networks` is set to `[]` and your IP will get whitelisted. You can use the _Network status_ menu to revoke IP addresses for which access has been granted. Regular authentication is still required.
- **sesame_totp_secret** (*Optional*): Like the `sesame` option, but instead as Base32 encoded secret string must be provided. This string then can be added to a TOTP App like Google Authenticator. This way you get a 6-digit `sesame` that changes every 30 seconds.
- **loglevel** (*Optional*): You can change the logging level from the default value `info` if you want to. Valid values are: `debug`, `info`, `warning`, `error`, `critical`.
<p class='note warning'>
Be careful when setting up port forwarding to the configurator while embedding into Home Assistant. If you don't restrict access by requiring authentication and/or blocking based on client IP addresses, your configuration will be exposed to the internet!

View File

@ -24,12 +24,12 @@ sensor:
- platform: alpha_vantage
api_key: YOUR_API_KEY
symbols:
- symbol: GOOGL
name: Google
- symbol: GOOGL
name: Google
foreign_exchange:
- name: USD_EUR
from: USD
to: EUR
- name: USD_EUR
from: USD
to: EUR
```
Either a symbol or a foreign exchange must be configured, otherwise you will not get any data.

View File

@ -60,8 +60,8 @@ sensor:
description: "Host to which Smartmeter is connected (default: '' (connected via serial or USB, see **port**)). For remote connections, use IP address of host to connect to (i.e. 192.168.1.13)."
required: false
type: string
name:
description: "Version of DSMR used by meter. Choices: 2.2, 3, 4, 5. Defaults to 2.2."
dsmr_version:
description: "Version of DSMR used by meter. Choices: 2.2, 4, 5. Defaults to 2.2."
required: false
type: string
{% endconfiguration %}

View File

@ -46,6 +46,8 @@ $ bluetoothctl
[NEW] C4:D3:8C:12:4C:57 Flower mate
```
If you can't use `hcitool` or `bluetoothctl` but have access to an Android phone you can try `BLE Scanner` or similar scanner applications from the Play Store to easily find your sensor MAC address.
# Configure
To use your Mi Flora plant sensor in your installation, add the following to your `configuration.yaml` file:

View File

@ -24,4 +24,4 @@ sensor:
- platform: moon
```
This sensor will return one of the following values:
`New moon`, `Waxing crescent`, `First quarter`, `Waxing gibbous`, `Full moon`, `Waning gibbous`, `Last quarter` or `Waning crescent` .
`new_moon`, `waxing_crescent`, `first_quarter`, `waxing_gibbous`, `full_moon`, `waning_gibbous`, `last_quarter` or `waning_crescent` .

View File

@ -97,7 +97,7 @@ Send a location.
|---------------------------|----------|--------------------------------------------------|
| `latitude` | no | The latitude to send. |
| `longitude` | no | The longitude to send. |
| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed chat_id. |
| `target` | yes | An array of pre-authorized chat_ids or user_ids to send the notification to. Defaults to the first allowed `chat_id`. |
| `disable_notification` | yes | True/false for send the message silently. iOS users and web users will not receive a notification, Android users will receive a notification with no sound. Defaults to False. |
| `keyboard` | yes | List of rows of commands, comma-separated, to make a custom keyboard. Example: `["/command1, /command2", "/command3"]` |
| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` |
@ -108,7 +108,7 @@ Edit a previously sent message in a conversation.
| Service data attribute | Optional | Description |
|---------------------------|----------|--------------------------------------------------|
| `message_id` | no | Id of the message to edit. When answering a callback from a pressed button, the id of the origin message is in: `{{ trigger.event.data.message.message_id }}`. You can use `"last"` to refer to the last message sent to `chat_id`. |
| `message_id` | no | Id of the message to edit. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. |
| `chat_id` | no | The chat_id where to edit the message. |
| `message` | no | Message body of the notification. |
| `title` | yes | Optional title for your notification. Will be composed as '%title\n%message'. |
@ -122,7 +122,7 @@ Edit the caption of a previously sent message.
| Service data attribute | Optional | Description |
|---------------------------|----------|--------------------------------------------------|
| `message_id` | no | Id of the message to edit. When answering a callback from a pressed button, the id of the origin message is in: `{{ trigger.event.data.message.message_id }}`. You can use `"last"` to refer to the last message sent to `chat_id`. |
| `message_id` | no | Id of the message to edit. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. |
| `chat_id` | no | The chat_id where to edit the caption. |
| `caption` | no | Message body of the notification. |
| `disable_web_page_preview`| yes | True/false for disable link previews for links in the message. |
@ -134,7 +134,7 @@ Edit the inline keyboard of a previously sent message.
| Service data attribute | Optional | Description |
|---------------------------|----------|--------------------------------------------------|
| `message_id` | no | Id of the message to edit. When answering a callback from a pressed button, the id of the origin message is in: `{{ trigger.event.data.message.message_id }}`. You can use `"last"` to refer to the last message sent to `chat_id`. |
| `message_id` | no | Id of the message to edit. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. |
| `chat_id` | no | The chat_id where to edit the reply_markup. |
| `disable_web_page_preview`| yes | True/false for disable link previews for links in the message. |
| `inline_keyboard` | yes | List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with associated callback data. Example: `["/button1, /button2", "/button3"]` or `[[["Text btn1", "/button1"], ["Text btn2", "/button2"]], [["Text btn3", "/button3"]]]` |
@ -146,7 +146,7 @@ Respond to a callback query originated by clicking on an online keyboard button.
| Service data attribute | Optional | Description |
|---------------------------|----------|--------------------------------------------------|
| `message` | no | Unformatted text message body of the notification. |
| `callback_query_id` | no | Unique id of the callback response. In the `telegram_callback` event data: `{{ trigger.event.data.id }}` |
| `callback_query_id` | no | Unique id of the callback response. In the `telegram_callback` event data: {% raw %}`{{ trigger.event.data.id }}`{% endraw %} |
| `show_alert` | yes | True/false for show a permanent notification. Defaults to False. |
### {% linkable_title Service `telegram_bot.delete_message` %}
@ -154,7 +154,7 @@ Delete a previously sent message in a conversation.
| Service data attribute | Optional | Description |
|---------------------------|----------|--------------------------------------------------|
| `message_id` | no | Id of the message to delete. When answering a callback from a pressed button, the id of the origin message is in: `{{ trigger.event.data.message.message_id }}`. You can use `"last"` to refer to the last message sent to `chat_id`. |
| `message_id` | no | Id of the message to delete. When answering a callback from a pressed button, the id of the origin message is in: {% raw %}`{{ trigger.event.data.message.message_id }}`{% endraw %}. You can use `"last"` to refer to the last message sent to `chat_id`. |
| `chat_id` | no | The chat_id where to delete the message. |
## {% linkable_title `telegram` notification platform %}
@ -172,7 +172,7 @@ notify:
## {% linkable_title Event triggering %}
A command looks like `/thecommand`, or `/othercommand with some args`.
A command looks like `/thecommand` or `/othercommand with some args`.
When received by Home Assistant it will fire a `telegram_command` event on the event bus with the following `event_data`:

View File

@ -28,7 +28,7 @@ tuya:
{% configuration %}
username:
description: Your username to login to Tuya.
description: Your username to login to Tuya. This may be your phone number.
required: true
type: string
password:
@ -36,7 +36,7 @@ password:
required: true
type: string
country_code:
description: Your account country code (i.e.,1 for USA and 86 for China).
description: "Your account [country code](https://www.countrycode.org/) (e.g., 1 for USA or 86 for China)."
required: true
type: string
{% endconfiguration %}

View File

@ -35,7 +35,7 @@ The `zwave` component exposes multiple services to help maintain the network. Al
| stop_network | Stops the Z-Wave network. |
| test_network | Tells the controller to send no-op commands to each node and measure the time for a response. In theory, this can also bring back nodes which have been marked "presumed dead." |
| test_node | Tells the controller to send no-op command(s) to a specific node. Requires `node_id` field. You can specify amount of test_messages to send by specifying it with `messages` field. In theory, this could bring back nodes marked as "presumed dead"
| update_config | Attempt to update OZW configuration files from git to support newer devices. After you run this, wait a few minutes then stop Home Assistant. You can now back up your `zwcfg_*.xml` file, then delete the relevant entries from your `zwcfg_*.xml` (between `<Node id="?">` and `</Node>`), and finally start Home Assistant. |
| update_config | Attempt to update OZW configuration files from git to support newer devices. After you run this, wait a few minutes then stop Home Assistant. You can now back up your `zwcfg_*.xml` file, then delete the relevant entries from your `zwcfg_*.xml` (between and including `<Node id="?">` and `</Node>`), and finally start Home Assistant. |
The `soft_reset` and `heal_network` commands can be used as part of an automation script to help keep a Z-Wave network running reliably as shown in the example below. By default, Home Assistant will run a `heal_network` at midnight. This is a configuration option for the `zwave` component. The option defaults to `true` but can be disabled by setting `autoheal` to false. If you're having issues with your Z-Wave network, try disabling this automation.

View File

@ -24,7 +24,6 @@ Screenshot of the new user interface to change entity IDs.
This release also includes a bunch more Tuya integrations thanks to [@huangyupeng]. And thanks to [@peternijssen] we're now also able to talk with Spider thermostats and plugs.
## {% linkable_title New Platforms %}
- Add Tuya climate platform ([@huangyupeng] - [#15500]) ([tuya docs]) ([climate.tuya docs]) (new-platform)
@ -39,6 +38,12 @@ This release also includes a bunch more Tuya integrations thanks to [@huangyupen
- Add a component for Sisyphus Kinetic Art Tables ([@jkeljo] - [#14472]) ([sisyphus docs]) ([light.sisyphus docs]) ([media_player.sisyphus docs]) (new-platform)
- Add Genie Aladdin Connect cover component ([@shoejosh] - [#15699]) ([cover.aladdin_connect docs]) (new-platform)
## {% linkable_title Release 0.75.1 - August 4 %}
- Upgrade Adafruit-DHT to 1.3.3 ([@superpuffin] - [#15706]) ([sensor.dht docs])
- Fix rfxtrx device id matching ([@Danielhiversen] - [#15819]) ([rfxtrx docs])
- Fix custom panel and Hass.io panel ([@balloob])
## {% linkable_title If you need help... %}
...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks.
@ -395,3 +400,9 @@ Experiencing issues introduced by this release? Please report them in our [issue
[websocket_api docs]: /components/websocket_api/
[wemo docs]: /components/wemo/
[zwave docs]: /components/zwave/
[#15706]: https://github.com/home-assistant/home-assistant/pull/15706
[#15819]: https://github.com/home-assistant/home-assistant/pull/15819
[@Danielhiversen]: https://github.com/Danielhiversen
[@superpuffin]: https://github.com/superpuffin
[rfxtrx docs]: /components/rfxtrx/
[sensor.dht docs]: /components/sensor.dht/

View File

@ -19,32 +19,45 @@ On the SSH command line, you can use the `hassio` command to retrieve logs, chec
Home Assistant:
```bash
$ hassio homeassistant info
$ hassio homeassistant logs
$ hassio homeassistant restart
$ hassio homeassistant stop
$ hassio homeassistant start
$ hassio homeassistant update
$ hassio homeassistant check
$ hassio homeassistant restart
$ hassio homeassistant start
$ hassio homeassistant stop
$ hassio homeassistant update
```
Supervisor:
```bash
$ hassio supervisor info
$ hassio supervisor logs
$ hassio supervisor reload
$ hassio supervisor update
```
Host:
```bash
$ hassio host hardware
$ hassio host reboot
$ hassio host shutdown
$ hassio host update
```
Supervisor
Hardware:
```bash
$ hassio supervisor logs
$ hassio supervisor info
$ hassio supervisor reload
$ hassio supervisor update
$ hassio hardware info
$ hassio hardware audio
```
To update Home Assistant to a specific version, use the command:
```bash
hassio homeassistant update --options version=x.y.z
```
Replace x.y.z with the desired version like `version=0.74.2`
You can get a better description of the CLI capabilities by typing `hassio help`:
```bash
@ -55,7 +68,7 @@ USAGE:
hassio [global options] command [command options] [arguments...]
VERSION:
1.2.1
1.3.1
AUTHOR:
Home-Assistant <hello@home-assistant.io>
@ -63,7 +76,8 @@ AUTHOR:
COMMANDS:
homeassistant, ha info, logs, check, restart, start, stop, update
supervisor, su info, logs, reload, update
host, ho hardware, reboot, shutdown, update
host, ho reboot, shutdown, update
hardware, hw info, audio
network, ne info, options
snapshots, sn list, info, reload, new, restore, remove
addons, ad list, info, logo, changelog, logs, stats,

View File

@ -75,12 +75,12 @@ A detailed guide about running Hass.io as a virtual machine is available in the
[etcher]: https://etcher.io/
[Virtual Appliance]: https://github.com/home-assistant/hassos/blob/dev/Documentation/boards/ova.md
[hassos-network]: https://github.com/home-assistant/hassos/blob/dev/Documentation/network.md
[pi0-w]: https://github.com/home-assistant/hassos/releases/download/1.7/hassos_rpi0-w-1.7.img.gz
[pi1]: https://github.com/home-assistant/hassos/releases/download/1.7/hassos_rpi-1.7.img.gz
[pi2]: https://github.com/home-assistant/hassos/releases/download/1.7/hassos_rpi2-1.7.img.gz
[pi3-32]: https://github.com/home-assistant/hassos/releases/download/1.7/hassos_rpi3-1.7.img.gz
[pi3-64]: https://github.com/home-assistant/hassos/releases/download/1.7/hassos_rpi3-64-1.7.img.gz
[vmdk]: https://github.com/home-assistant/hassos/releases/download/1.8/hassos_ova-1.8.vmdk
[pi0-w]: https://github.com/home-assistant/hassos/releases/download/1.9/hassos_rpi0-w-1.9.img.gz
[pi1]: https://github.com/home-assistant/hassos/releases/download/1.9/hassos_rpi-1.9.img.gz
[pi2]: https://github.com/home-assistant/hassos/releases/download/1.9/hassos_rpi2-1.9.img.gz
[pi3-32]: https://github.com/home-assistant/hassos/releases/download/1.9/hassos_rpi3-1.9.img.gz
[pi3-64]: https://github.com/home-assistant/hassos/releases/download/1.9/hassos_rpi3-64-1.9.img.gz
[vmdk]: https://github.com/home-assistant/hassos/releases/download/1.9/hassos_ova-1.9.vmdk
[linux]: https://github.com/home-assistant/hassio-build/tree/master/install#install-hassio
[local]: http://hassio.local:8123
[samba]: /addons/samba/

View File

@ -31,6 +31,10 @@ this tool is to help give you something to start playing with right away.
The [Lovelace Config Generator][config-generator] by [@thomasloven] provides
you with the ability to split your Lovelace configuration into multiple files.
### {% linkable_title Lovelace Config Generator (Jinja2 Script) %}
The [Lovelace Jinja2 Script][lovelace-jinja] by [@skalavala] is a simple Jinja2 script that you run in the template editor to generate lovelace configuration based on the entities that are already setup.
<p class='note'>
Split configuration is currently possible directly in Lovelace, but it
is expected to be removed in the near future due to fact that Home Assistant
@ -54,10 +58,11 @@ mobile browser. (@Toast)
[@dale3h]: https://github.com/dale3h
[@thomasloven]: https://github.com/thomasloven
[@skalavala]: https://github.com/skalavala
[config-generator]: https://github.com/thomasloven/homeassistant-lovelace-gen
[header-stacks]: https://gist.github.com/dale3h/37b34aebb0c336ffd5fb877c2651097a
[horizontal-stack]: /lovelace/horizontal-stack/
[migration-script]: https://github.com/dale3h/python-lovelace
[picture-elements]: /lovelace/picture-elements/
[vertical-stack]: /lovelace/vertical-stack/
[lovelace-jinja]: https://sharethelove.io/tools/jinja-magic-scripts