From ae419c2c115bde4e714180022739948532e6e67f Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Wed, 13 Feb 2019 23:15:23 +0100 Subject: [PATCH] :pencil2: Spelling, grammar, styling and fixes (#8559) --- .../_components/sensor.wirelesstag.markdown | 1 - source/_components/sensor.worldclock.markdown | 3 +- .../sensor.worldtidesinfo.markdown | 3 +- .../_components/sensor.wunderground.markdown | 17 ++-- .../_components/sensor.xiaomi_aqara.markdown | 2 - source/_components/sensor.zabbix.markdown | 5 +- source/_components/sensor.zestimate.markdown | 10 +- source/_components/shiftr.markdown | 1 - source/_components/shopping_list.markdown | 11 ++- source/_components/smhi.markdown | 5 +- source/_components/snips.markdown | 29 +++--- source/_components/sonos.markdown | 2 - source/_components/sun.markdown | 6 +- .../switch.acer_projector.markdown | 1 - source/_components/switch.arduino.markdown | 2 - source/_components/switch.arest.markdown | 6 +- source/_components/switch.broadlink.markdown | 98 ++++++++++--------- source/_components/switch.deluge.markdown | 1 - .../switch.digitalloggers.markdown | 5 +- source/_components/switch.dlink.markdown | 1 - source/_components/switch.doorbird.markdown | 2 +- source/_components/switch.edimax.markdown | 1 - source/_components/switch.eufy.markdown | 1 - source/_components/switch.fritzdect.markdown | 1 - .../_components/switch.hikvisioncam.markdown | 1 - source/_components/switch.hive.markdown | 4 - source/_components/transmission.markdown | 7 +- source/_components/utility_meter.markdown | 41 ++++---- 28 files changed, 130 insertions(+), 137 deletions(-) diff --git a/source/_components/sensor.wirelesstag.markdown b/source/_components/sensor.wirelesstag.markdown index 33961e0cf18..4613333d801 100644 --- a/source/_components/sensor.wirelesstag.markdown +++ b/source/_components/sensor.wirelesstag.markdown @@ -43,4 +43,3 @@ monitored_conditions: light: description: Brightness in lux (if supported by tag). {% endconfiguration %} - diff --git a/source/_components/sensor.worldclock.markdown b/source/_components/sensor.worldclock.markdown index 3e15096353e..d8236a2809b 100644 --- a/source/_components/sensor.worldclock.markdown +++ b/source/_components/sensor.worldclock.markdown @@ -14,8 +14,9 @@ ha_release: pre 0.7 ha_qa_scale: internal --- +The `worldclock` sensor platform simply displays the current time in a different time zone. -The `worldclock` sensor platform simply displays the current time in a different time zone +## {% linkable_title Configuration %} To enable this sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.worldtidesinfo.markdown b/source/_components/sensor.worldtidesinfo.markdown index 9dcde7eafbc..9392c401e9f 100644 --- a/source/_components/sensor.worldtidesinfo.markdown +++ b/source/_components/sensor.worldtidesinfo.markdown @@ -12,7 +12,7 @@ ha_category: Environment ha_release: 0.52 --- -The `worldtidesinfo` sensor platform uses details from [World Tides](https://www.worldtides.info/) to provide information about the prediction for the tides for any location in the world. +The `worldtidesinfo` sensor platform uses details from [World Tides](https://www.worldtides.info/) to provide information about the prediction for the tides for any location in the world. ## {% linkable_title Setup %} @@ -50,4 +50,3 @@ longitude: type: float default: "The longitude in your `configuration.yaml` file." {% endconfiguration %} - diff --git a/source/_components/sensor.wunderground.markdown b/source/_components/sensor.wunderground.markdown index a8b1b2ffa11..ad6595b491c 100644 --- a/source/_components/sensor.wunderground.markdown +++ b/source/_components/sensor.wunderground.markdown @@ -21,6 +21,8 @@ Obtain a WUnderground API key [here](https://www.wunderground.com/weather/api). Please consider this when using the following information.

+{% linkable_title Configuration %} + To add Wunderground to your installation, add the following to your `configuration.yaml` file: ```yaml @@ -181,28 +183,27 @@ monitored_conditions: description: Text summary of current wind conditions {% endconfiguration %} - All the conditions listed above will be updated every 5 minutes. -### {% linkable_title Forecasts %} +## {% linkable_title Forecasts %} -_12 hour forecasts_ +### {% linkable_title 12 hour forecasts %} Monitored conditions marked above with [12h] are 12 hour forecasts. To get a forecast for different period/daytime replace the `_1d_` part of the sensor name. e.g., `weather_2n` will give you forecast for tomorrow night. Valid values for day are `1` to `4` and valid values for daytime are `d` or `n`. -_Daily forecasts_ +### {% linkable_title Daily forecasts %} Conditions above marked with [1d] are daily forecasts. To get forecast for different day, replace the number in `_1d_` part of the sensor name. Valid values are from `1` to `4`. -_Hourly forecasts_ +### {% linkable_title Hourly forecasts %} Conditions marked with [1h] are hourly forecasts. To get forecast for different hour, replace the number in the `_1h_` part of the sensor name with `1` to `36`. e.g., `weather_24h` will give you weather in 24 hours. -### {% linkable_title Additional examples %} +## {% linkable_title Additional examples %} -#### {% linkable_title Daily forecast %} +### {% linkable_title Daily forecast %} ```yaml sensor: @@ -234,7 +235,7 @@ group: ![Daily Forecast](/images/screenshots/wunderground_daily_forecast.png) -#### {% linkable_title Weather overview %} +### {% linkable_title Weather overview %} ```yaml sensor: diff --git a/source/_components/sensor.xiaomi_aqara.markdown b/source/_components/sensor.xiaomi_aqara.markdown index a69c4f685af..5dfb310c1eb 100644 --- a/source/_components/sensor.xiaomi_aqara.markdown +++ b/source/_components/sensor.xiaomi_aqara.markdown @@ -13,8 +13,6 @@ ha_release: "0.50" ha_iot_class: "Local Push" --- - The `xiaomi aqara` sensor platform allows you to get data from your [Xiaomi](http://www.mi.com/en/) sensors. The requirement is that you have setup [Xiaomi aqara](/components/xiaomi_aqara/). - diff --git a/source/_components/sensor.zabbix.markdown b/source/_components/sensor.zabbix.markdown index 9ac7107bcd3..6ef21a99da8 100644 --- a/source/_components/sensor.zabbix.markdown +++ b/source/_components/sensor.zabbix.markdown @@ -19,6 +19,8 @@ The `zabbix` sensor platform let you monitor the current count of active trigger You must have the [Zabbix component](/components/zabbix/) configured to use those sensors.

+## {% linkable_title Configuration %} + To set it up, add the following information to your `configuration.yaml` file: ```yaml @@ -48,5 +50,4 @@ individual: description: A 'true'/'false' to specify whether we should show individual sensors when a list of hostids is provided. If false, the sensor state will be the count of all triggers for the specified hosts (or all hosts within the Zabbix instance, if hostids isn't provided). required: false type: boolean - {% endconfiguration %} - +{% endconfiguration %} diff --git a/source/_components/sensor.zestimate.markdown b/source/_components/sensor.zestimate.markdown index aa74b086daf..cba781e2330 100644 --- a/source/_components/sensor.zestimate.markdown +++ b/source/_components/sensor.zestimate.markdown @@ -13,13 +13,13 @@ ha_release: 0.65 ha_iot_class: "Cloud Polling" --- -The `zestimate` sensor allows one to track the Zestimate® value of properties using the [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm). According to Zillow's website, a Zestimate® home valuation is Zillow's estimated market value. It is not an appraisal. Use it as a starting point to determine a home's value. The Zestimate® is provided by [Zillow](https://www.zillow.com), a website primarily for listing homes to buy/sell/rent in the United States. +The `zestimate` sensor allows one to track the Zestimate® value of properties using the [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm). According to Zillow's website, a Zestimate® home valuation is Zillow's estimated market value. It is not an appraisal. Use it as a starting point to determine a home's value. The Zestimate® is provided by [Zillow](https://www.zillow.com), a website primarily for listing homes to buy/sell/rent in the United States. This component adds one entity per zpid specified, named `sensor.zestimate` with numbers appended if you choose to track more than one Zestimate. ## {% linkable_title Configuration %} -You will need to sign up for the Zillow API at the following link [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm). You will also need the Zillow property ID for each property you'd like to track. This information is available from the URL of a property you are interested in. If you're the owner of this property, it's recommended to claim the listing and update the property information to help the information be as accurate as possible. +You will need to sign up for the Zillow API at the following link [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm). You will also need the Zillow property ID for each property you'd like to track. This information is available from the URL of a property you are interested in. If you're the owner of this property, it's recommended to claim the listing and update the property information to help the information be as accurate as possible. For example, the White House zpid is 84074482 and can be found in its Zillow URL: [https://www.zillow.com/homedetails/1600-Pennsylvania-Ave-NW-Washington-DC-20006/84074482_zpid/](https://www.zillow.com/homedetails/1600-Pennsylvania-Ave-NW-Washington-DC-20006/84074482_zpid/) @@ -36,11 +36,11 @@ sensor: {% configuration %} api_key: - description: The API key to access the service. Obtain yours using the [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm) + description: The API key to access the service. Obtain yours using the [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm). required: true type: string zpid: - description: Property IDs to track in the front end. Can be found in it's Zillow URL as described above. Include only the numbers, do not include the "_zpid" + description: Property IDs to track in the front end. Can be found in it's Zillow URL as described above. Include only the numbers, do not include the "_zpid". required: true type: list {% endconfiguration %} @@ -59,6 +59,6 @@ These attributes are available: - Currency - Amount -Example screenshot +Example screenshot: diff --git a/source/_components/shiftr.markdown b/source/_components/shiftr.markdown index a3835347043..77997625dec 100644 --- a/source/_components/shiftr.markdown +++ b/source/_components/shiftr.markdown @@ -38,4 +38,3 @@ password: required: true type: string {% endconfiguration %} - diff --git a/source/_components/shopping_list.markdown b/source/_components/shopping_list.markdown index 09597900327..a6fc33835b2 100644 --- a/source/_components/shopping_list.markdown +++ b/source/_components/shopping_list.markdown @@ -15,22 +15,25 @@ ha_qa_scale: internal The `shopping_list` component allows you to keep track of shopping list items. Includes the ability to add items via your voice using the sentence "Add eggs to my shopping list". +## {% linkable_title Configuration %} + ```yaml # Example configuration.yaml entry shopping_list: ``` -### Services +## Services + You can add or remove items on your shopping list by using the following services. -#### {% linkable_title Service `shopping_list.add_item` %} +### {% linkable_title Service `shopping_list.add_item` %} | Service data attribute | Optional | Description | |------------------------|----------|--------------------------------------------------------| | `name` | no | Name of the item to add. Example: "Beer" | -#### {% linkable_title Service `shopping_list.complete_item` %} +### {% linkable_title Service `shopping_list.complete_item` %} | Service data attribute | Optional | Description | |------------------------|----------|--------------------------------------------------------| -| `name` | no | Name of the item to mark as completed. Example: "Beer" | \ No newline at end of file +| `name` | no | Name of the item to mark as completed. Example: "Beer" | diff --git a/source/_components/smhi.markdown b/source/_components/smhi.markdown index 03f7bca7850..a3b1f87e20d 100644 --- a/source/_components/smhi.markdown +++ b/source/_components/smhi.markdown @@ -31,15 +31,14 @@ You can only add locations through the integrations page, not in configuration f Only location close to Sweden can be added. See [SMHI.se area](http://opendata.smhi.se/apidocs/metfcst/geographic_area.html) for more details what locations are supported.

- {% configuration %} latitude: - description: Manually specify latitude. + description: Manually specify latitude. required: false type: number default: Provided by Home Assistant configuration longitude: - description: Manually specify longitude. + description: Manually specify longitude. required: false type: number default: Provided by Home Assistant configuration diff --git a/source/_components/snips.markdown b/source/_components/snips.markdown index 96696c36d84..edb894e6e1d 100644 --- a/source/_components/snips.markdown +++ b/source/_components/snips.markdown @@ -22,7 +22,6 @@ Snips takes voice or text as input and produces *intents* as output, which are e ![Snips Modules](/images/screenshots/snips_nlu.png) - ## {% linkable_title The Snips Voice Platform %} ### {% linkable_title Installation %} @@ -30,18 +29,18 @@ Snips takes voice or text as input and produces *intents* as output, which are e The Snips platform can be installed via the Snips APT/Debian repository. If you prefer to install the platform using the Docker distribution, check out our [Docker Installation Guide](https://github.com/snipsco/snips-platform-documentation/wiki/6.--Miscellaneous#using-docker). ```bash -$ sudo apt-get update -$ sudo apt-get install -y dirmngr -$ sudo bash -c 'echo "deb https://raspbian.snips.ai/$(lsb_release -cs) stable main" > /etc/apt/sources.list.d/snips.list' -$ sudo apt-key adv --keyserver pgp.mit.edu --recv-keys D4F50CDCA10A2849 -$ sudo apt-get update -$ sudo apt-get install -y snips-platform-voice +sudo apt-get update +sudo apt-get install -y dirmngr +sudo bash -c 'echo "deb https://raspbian.snips.ai/$(lsb_release -cs) stable main" > /etc/apt/sources.list.d/snips.list' +sudo apt-key adv --keyserver pgp.mit.edu --recv-keys D4F50CDCA10A2849 +sudo apt-get update +sudo apt-get install -y snips-platform-voice ``` Note that if the keyserver pgp.mit.edu is down then try to use another one in the 4th line, like pgp.surfnet.nl: ```bash -$ sudo apt-key adv --keyserver pgp.surfnet.nl --recv-keys D4F50CDCA10A2849 +sudo apt-key adv --keyserver pgp.surfnet.nl --recv-keys D4F50CDCA10A2849 ``` ### {% linkable_title Creating an assistant %} @@ -51,13 +50,13 @@ Head over to the [Snips Console](https://console.snips.ai) to create your assist The next step is to get the assistant to work on your device. Unzip and copy the `assistant` folder that you downloaded from the web console to the path. Assuming your downloaded `assistant` folder is on your desktop, just run: ```bash -$ scp -r ~/Desktop/assistant pi@:/home/pi/. +scp -r ~/Desktop/assistant pi@:/home/pi/. ``` Now ssh into your Raspberry Pi: ```bash -$ ssh pi@ +ssh pi@ ``` By default, this command is `ssh pi@raspberrypi.local`, if you are using the default Raspberry Pi hostname. @@ -82,7 +81,7 @@ Make sure that a microphone is plugged to the Raspberry Pi. If you are having tr Start the Snips Voice Platform by starting the `snips-*` services: ```bash -$ sudo systemctl start "snips-*" +sudo systemctl start "snips-*" ``` Snips is now ready to take voice commands from the microphone. To trigger the listening, simply say @@ -161,11 +160,11 @@ In the `data_template` block, we have access to special variables, corresponding ### {% linkable_title Special slots %} -Several special values for slots are populated with the `siteId `the intent originated from and the probability value for the intent, the `sessionId` generate by the dialogue manager, and `slote_name` raw which will contain the raw, uninterpreted text of the slot value. +Several special values for slots are populated with the `siteId` the intent originated from and the probability value for the intent, the `sessionId` generate by the dialogue manager, and `slote_name` raw which will contain the raw, uninterpreted text of the slot value. In the above example, the slots are plain strings. However, Snips has a duration builtin value used for setting timers and this will be parsed to a seconds value. -In this example if we had an intent triggered with 'Set a timer for five minutes', `duration:` would equal 300 and `duration_raw:` would be set to 'five minutes'. The duration can be easily used to trigger Home Assistant events and the `duration_raw:` could be used to send a human readable response or alert. +In this example if we had an intent triggered with 'Set a timer for five minutes', `duration:` would equal 300 and `duration_raw:` would be set to 'five minutes'. The duration can be easily used to trigger Home Assistant events and the `duration_raw:` could be used to send a human readable response or alert. {% raw %} ```yaml @@ -185,8 +184,6 @@ SetTimer: ``` {% endraw %} - - ### {% linkable_title Sending TTS Notifications %} You can send TTS notifications to Snips using the `snips.say` and `snips.say_action` services. `say_action` starts a session and waits for user response, "Would you like me to close the garage door?", "Yes, close the garage door". @@ -209,7 +206,6 @@ You can send TTS notifications to Snips using the `snips.say` and `snips.say_act | `can_be_enqueued` | yes | If True, session waits for an open session to end, if False session is dropped if one is running. | | `intent_filter` | yes | Array of Strings - A list of intents names to restrict the NLU resolution to on the first query. | - ### {% linkable_title Snips Support %} There is an active [discord](https://discordapp.com/invite/3939Kqx) channel for further support. @@ -308,4 +304,3 @@ intent_script: and {{ states('sensor.dark_sky_weather_hourly_summary') }} ``` {% endraw %} - diff --git a/source/_components/sonos.markdown b/source/_components/sonos.markdown index 3cbd64e519e..ea08f23eaff 100644 --- a/source/_components/sonos.markdown +++ b/source/_components/sonos.markdown @@ -100,7 +100,6 @@ Night Sound and Speech Enhancement modes are only supported on Sonos PLAYBAR and | `night_sound` | yes | Boolean to control Night Sound mode. | `speech_enhance` | yes | Boolean to control Speech Enhancement mode. - ## {% linkable_title Advanced use %} For advanced uses, there are some manual configuration options available. @@ -140,4 +139,3 @@ sonos: This component is using the [SoCo](https://github.com/SoCo/SoCo) project. To be able to support the Sonos components and features it is mandatory to have TCP port 1400 opened. This port is used to receive events about changes on the Sonos network. For more details please see the [SoCo documentation](https://github.com/SoCo/SoCo) and source code of the SoCo project. - diff --git a/source/_components/sun.markdown b/source/_components/sun.markdown index cc2f933d70b..94da2e561c4 100644 --- a/source/_components/sun.markdown +++ b/source/_components/sun.markdown @@ -19,6 +19,8 @@ below the horizon. The sun can be used within automation as [sun_trigger]: /docs/automation/trigger/#sun-trigger [sun_condition]: /docs/scripts/conditions/#sun-condition +## {% linkable_title Configuration %} + ```yaml # Example configuration.yaml entry sun: @@ -35,7 +37,7 @@ elevation:

-### {% linkable_title Implementation Details %} +## {% linkable_title Implementation Details %} The sun's event listener will call the service when the sun rises or sets with an offset. @@ -52,7 +54,7 @@ which event (sunset or sunrise) and the offset. } ``` -#### {% linkable_title Maintains entity `sun.sun` %} +### {% linkable_title Maintains entity `sun.sun` %} | Possible state | Description | | --------- | ----------- | diff --git a/source/_components/switch.acer_projector.markdown b/source/_components/switch.acer_projector.markdown index 1e5bfb299c0..8e29186e2e8 100644 --- a/source/_components/switch.acer_projector.markdown +++ b/source/_components/switch.acer_projector.markdown @@ -13,7 +13,6 @@ ha_iot_class: "Local Polling" ha_release: 0.19 --- - The `acer_projector` switch platform allows you to control the state of RS232 connected projectors from [Acer](http://www.acer.com). ## {% linkable_title Configuration %} diff --git a/source/_components/switch.arduino.markdown b/source/_components/switch.arduino.markdown index a27907103af..5cc9f87d9b1 100644 --- a/source/_components/switch.arduino.markdown +++ b/source/_components/switch.arduino.markdown @@ -13,7 +13,6 @@ ha_release: pre 0.7 ha_iot_class: "Local Polling" --- - The `arduino` switch platform allows you to control the digital pins of your [Arduino](https://www.arduino.cc/) board. Support for switching pins is limited to high/on and low/off of the digital pins. PWM (pin 3, 5, 6, 9, 10, and 11 on an Arduino Uno) is not supported yet. To enable the Arduino pins with Home Assistant, add the following section to your `configuration.yaml` file: @@ -59,4 +58,3 @@ pins: {% endconfiguration %} The digital pins are numbered from 0 to 13 on a Arduino UNO. The available pins are 2 till 13. For testing purposes you can use pin 13 because with that pin you can control the internal LED. - diff --git a/source/_components/switch.arest.markdown b/source/_components/switch.arest.markdown index 5b7d762d92b..4b27e680d44 100644 --- a/source/_components/switch.arest.markdown +++ b/source/_components/switch.arest.markdown @@ -44,9 +44,10 @@ switch: function1: name: Light Desk ``` + {% configuration %} resource: - description: IP address and schema of the device that is exposing an aREST API, e.g., http://192.168.1.10 (no-trailing slash) + description: IP address and schema of the device that is exposing an aREST API, e.g., `http://192.168.1.10` (no-trailing slash) required: true type: string name: @@ -78,9 +79,8 @@ functions: type: string {% endconfiguration %} -You can still switch your pins with a web browser or a command line tool. Use the URL http://192.168.1.10/digital/8/1 to set pin 8 to high/on, the JSON response will give you the feedback. +You can still switch your pins with a web browser or a command line tool. Use the URL `http://192.168.1.10/digital/8/1` to set pin 8 to high/on, the JSON response will give you the feedback. ```json {"message": "Pin D8 set to 1", "id": "sensor02", "name": "livingroom", "connected": true} ``` - diff --git a/source/_components/switch.broadlink.markdown b/source/_components/switch.broadlink.markdown index 844e6c9715e..760aee5d295 100644 --- a/source/_components/switch.broadlink.markdown +++ b/source/_components/switch.broadlink.markdown @@ -15,6 +15,8 @@ ha_iot_class: "Local Polling" This `Broadlink` switch platform allow to you control Broadlink [devices](http://www.ibroadlink.com/). +## {% linkable_title Configuration %} + To enable it, add the following lines to your `configuration.yaml`: ```yaml @@ -93,7 +95,7 @@ slots: Information about how to install on Windows can be found [here](/components/sensor.broadlink/#microsoft-windows-installation). -### {% linkable_title How to obtain IR/RF packets? %} +## {% linkable_title How to obtain IR/RF packets? %} Choose Call Service from the Developer Tools. Choose the service `switch.broadlink_learn_command` from the list of **Available services:** and hit **CALL SERVICE**. Press the button on your remote with in 20 seconds. The packet will be printed as a persistent notification in the States page of the web interface. @@ -173,7 +175,7 @@ switch: slot_4: 'Speaker slot' ``` -### {% linkable_title Service `broadlink_send_packet` %} +## {% linkable_title Service `broadlink_send_packet` %} You can use the service `switch.broadlink_send_packet` to directly send IR packets without the need to assign a switch entity for each command. @@ -194,7 +196,7 @@ script: - "JgBGAJSTFDUUNhM2ExITEhMSExITEhM2EzYTNhQRFBEUERQRFBEUNRQ2ExITNhMSExITNhMSExITEhM2ExITNhQ1FBEUNhMADQUAAA==" ``` -### {% linkable_title Using E-Control Remotes %} +## {% linkable_title Using E-Control Remotes %} If you already have your remotes learned on E-Control app you can use this method to "copy" them to Home Assistant. @@ -226,65 +228,71 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro 6. Install python-broadlink library: - 1. `git clone https://github.com/mjg59/python-broadlink.git` - 2. `cd python-broadlink` - 3. `sudo python setup.py install` + ```bash + git clone https://github.com/mjg59/python-broadlink.git + cd python-broadlink + sudo python setup.py install + ``` -7. Test the codes -Use the `sendcode` script you have already downloaded to test the codes you got from the device. -You need to edit the script with your RM Pro IP Address and MAC Address and with the code in HEX format. -When run the script, you know the code works when get message . -Code sent... -Not every code works. +7. Test the codes + Use the `sendcode` script you have already downloaded to test the codes you got from the device. + You need to edit the script with your RM Pro IP Address and MAC Address and with the code in HEX format. + When run the script, you know the code works when get message. + Code sent... + Not every code works. -8. Convert the HEX codes to base64 -Use [this](http://tomeko.net/online_tools/hex_to_base64.php?lang=en1) tool to convert the hex codes to base64 for use with Home Assistant. +8. Convert the HEX codes to base64. + Use [this](http://tomeko.net/online_tools/hex_to_base64.php?lang=en1) tool to convert the hex codes to base64 for use with Home Assistant. -### {% linkable_title Using iOS and Windows to Obtain Codes %} +## {% linkable_title Using iOS and Windows to Obtain Codes %} 1. Use the E-Control app to learn the codes from all of your suitable remotes. Depending on the remote, try to add useful names for the buttons and/or the remotes. This will mean that you should only have to run this process once and will help with getting them quickly into Home Assistant. Dump the files in the app by navigating to the hamburger icon, select `share and select`, then choose `Share to other phones on WLAN`. 2. Install Requirements -- Download and install Python 2.7 on your windows PC. -- Run `pip install simplejson`. You must install simplejson in the same python version you will use to run the scripts. You can ensure that the current version is installed by attempting to install again and confirming that you see "Requirement already satisfied". -- Download and install [iBackup Viewer](http://www.imactools.com/iphonebackupviewer/). -- Download [these](https://github.com/NightRang3r/Broadlink-e-control-db-dump) github files. Make sure you place them in the \Python27 path in Windows. Be sure that the getBroadlinkSharedData.py from the download is in this directory. + - Download and install Python 2.7 on your windows PC. + - Run `pip install simplejson`. You must install simplejson in the same python version you will use to run the scripts. You can ensure that the current version is installed by attempting to install again and confirming that you see "Requirement already satisfied". + - Download and install [iBackup Viewer](http://www.imactools.com/iphonebackupviewer/). + - Download [these](https://github.com/NightRang3r/Broadlink-e-control-db-dump) github files. Make sure you place them in the \Python27 path in Windows. Be sure that the getBroadlinkSharedData.py from the download is in this directory. 3. Plug your iphone into your windows PC, open iTunes and create a non-encrypted backup of your device. 4. Open iBackup viewer then select the iOS backup that you created. Navigate to the App icon and then scroll until you find e-control.app, select this. Select and extract the files jsonButton, jsonIrCode and jsonSublr; they will be located in the Documents/SharedData section. Put these in the same location as the getBroadlinkSharedData.py. 5. Now open a Command Prompt and navigate to the directory where the aforementioned files are located e.g. C:\Python27. Now run the command python getBroadlinkSharedData.py, you should see something like this: -```C:\Python27>python getBroadlinkSharedData.py -ID: 1 | Name: TV -ID: 2 | Name: Upstairs -ID: 3 | Name: Sort in order -ID: 4 | Name: Soundbar -ID: 5 | Name: TV -ID: 6 | Name: Xbox One -ID: 7 | Name: User-Defined Aircon -ID: 8 | Name: Sort in order -ID: 9 | Name: User-Defined Aircon -ID: 10 | Name: Kids Fan -ID: 11 | Name: Downstairs -ID: 12 | Name: Ceiling Fan -ID: 13 | Name: Samsung TV -ID: 14 | Name: Xbox One -ID: 15 | Name: SONY SoundBar -ID: 16 | Name: Fire TV -ID: 17 | Name: New RF Remote -``` -6. Select the remote ID you would like to extract: -```Select accessory ID: 5 -[+] You selected: TV -[+] Dumping codes to TV.txt -``` + ```bash + C:\Python27>python getBroadlinkSharedData.py + ID: 1 | Name: TV + ID: 2 | Name: Upstairs + ID: 3 | Name: Sort in order + ID: 4 | Name: Soundbar + ID: 5 | Name: TV + ID: 6 | Name: Xbox One + ID: 7 | Name: User-Defined Aircon + ID: 8 | Name: Sort in order + ID: 9 | Name: User-Defined Aircon + ID: 10 | Name: Kids Fan + ID: 11 | Name: Downstairs + ID: 12 | Name: Ceiling Fan + ID: 13 | Name: Samsung TV + ID: 14 | Name: Xbox One + ID: 15 | Name: SONY SoundBar + ID: 16 | Name: Fire TV + ID: 17 | Name: New RF Remote + ``` -7. Now there should be a file with the name of the remote you chose in the same directory ending in `.txt`. Open that up and it will contain the Base64 code required for Home Assistant. To ensure these codes work correctly you may need to add `==` to the end of the code in your config.yaml file (or wherever you have your switches). + Select the remote ID you would like to extract: -### {% linkable_title Using Windows to Obtain Codes with Broadlink Manager %} + ```bash + Select accessory ID: 5 + [+] You selected: TV + [+] Dumping codes to TV.txt + ``` + +6. Now there should be a file with the name of the remote you chose in the same directory ending in `.txt`. Open that up and it will contain the Base64 code required for Home Assistant. To ensure these codes work correctly you may need to add `==` to the end of the code in your config.yaml file (or wherever you have your switches). + +## {% linkable_title Using Windows to Obtain Codes with Broadlink Manager %} 1. Install Broadlink Manager from this SourceForge link [here](https://sourceforge.net/projects/broadlink-manager/). 2. Open the application and hit "scan" to activate your broadlink device. diff --git a/source/_components/switch.deluge.markdown b/source/_components/switch.deluge.markdown index eba6ed1d106..0d6b41864c2 100644 --- a/source/_components/switch.deluge.markdown +++ b/source/_components/switch.deluge.markdown @@ -13,7 +13,6 @@ ha_release: 0.57 ha_iot_class: "Local Polling" --- - The `deluge` switch platform allows you to control your [Deluge](http://deluge-torrent.org/) client from within Home Assistant. The platform enables you switch all your torrents in pause, and then unpause them all. To add Deluge to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/switch.digitalloggers.markdown b/source/_components/switch.digitalloggers.markdown index 7d28962def6..6b75f331da9 100644 --- a/source/_components/switch.digitalloggers.markdown +++ b/source/_components/switch.digitalloggers.markdown @@ -13,10 +13,9 @@ ha_release: 0.35 ha_iot_class: "Local Polling" --- +The `digitalloggers` switch platform allows you to control the state of your [Digital Loggers](http://www.digital-loggers.com/dinfaqs.html) switches. -The `digitalloggers` switch platform allows you to control the state of your [Digital Loggers](http://www.digital-loggers.com/dinfaqs.html) switches. - -### {% linkable_title Configuration %} +## {% linkable_title Configuration %} To use your digitalloggers switch in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/switch.dlink.markdown b/source/_components/switch.dlink.markdown index 9511792504e..ea148580b77 100644 --- a/source/_components/switch.dlink.markdown +++ b/source/_components/switch.dlink.markdown @@ -13,7 +13,6 @@ ha_iot_class: "Local Polling" ha_release: 0.14 --- - The `dlink` switch platform allows you to control the state of your [D-Link Wi-Fi Smart Plugs](http://us.dlink.com/product-category/home-solutions/connected-home/smart-plugs/). Supported devices (tested): diff --git a/source/_components/switch.doorbird.markdown b/source/_components/switch.doorbird.markdown index f2da16e9629..7c78a4b8a0b 100644 --- a/source/_components/switch.doorbird.markdown +++ b/source/_components/switch.doorbird.markdown @@ -16,7 +16,7 @@ ha_iot_class: "Local Push" The `doorbird` switch platform allows you to power connected relays and trigger the IR array in your [DoorBird](http://www.doorbird.com/) video doorbell device.

- You must have the [DoorBird component](/components/doorbird/) configured to use this switch. +You must have the [DoorBird component](/components/doorbird/) configured to use this switch.

To enable this switch, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/switch.edimax.markdown b/source/_components/switch.edimax.markdown index 7a6611d77ba..77431300df5 100644 --- a/source/_components/switch.edimax.markdown +++ b/source/_components/switch.edimax.markdown @@ -12,7 +12,6 @@ ha_category: Switch ha_release: pre 0.7 --- - This `edimax` switch platform allows you to control the state of your [Edimax](http://www.edimax.com/edimax/merchandise/merchandise_list/data/edimax/global/home_automation_smart_plug/) switches. To use your Edimax switch in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/switch.eufy.markdown b/source/_components/switch.eufy.markdown index 1a79dbd26bd..e96ee77d324 100644 --- a/source/_components/switch.eufy.markdown +++ b/source/_components/switch.eufy.markdown @@ -16,4 +16,3 @@ ha_release: 0.68 The `eufy` platform allows you to control your [Eufy](http://www.eufylife.com) switches from within Home Assistant. They will be automatically discovered if the [Eufy](/components/eufy/) component is enabled. - diff --git a/source/_components/switch.fritzdect.markdown b/source/_components/switch.fritzdect.markdown index 88322c313fe..269cc207b4c 100644 --- a/source/_components/switch.fritzdect.markdown +++ b/source/_components/switch.fritzdect.markdown @@ -13,7 +13,6 @@ ha_iot_class: "Local Polling" ha_release: 0.38 --- - The `fritzdect` switch platform allows you to control the state of your [AVM FRITZ!DECT DECT-based wireless switches](https://en.avm.de/products/fritzdect/). The AVM FRITZ!DECT switches need to be paired to your Fritz!Box and then can be monitored and controlled via Home Assistant. Supported devices (tested): diff --git a/source/_components/switch.hikvisioncam.markdown b/source/_components/switch.hikvisioncam.markdown index 820a8326072..ad1cc040fba 100644 --- a/source/_components/switch.hikvisioncam.markdown +++ b/source/_components/switch.hikvisioncam.markdown @@ -12,7 +12,6 @@ ha_category: Switch ha_release: pre 0.7 --- - This `hikvisioncam` switch platform allows you to control your motion detection setting on your [Hikvision](http://www.hikvision.com/) camera.

diff --git a/source/_components/switch.hive.markdown b/source/_components/switch.hive.markdown index e4ea4837975..9c66e4bb93d 100644 --- a/source/_components/switch.hive.markdown +++ b/source/_components/switch.hive.markdown @@ -13,16 +13,12 @@ ha_release: 0.59 ha_iot_class: "Cloud Polling" --- - The `hive` switch platform integrates your Hive plugs into Home Assistant, enabling control of your devices. The platform supports the following Hive products: - Hive Active Plug -

Full configuration details can be found on the main [Hive component](/components/hive/) page.

- - diff --git a/source/_components/transmission.markdown b/source/_components/transmission.markdown index 1665cc7cc3d..03143c67cb7 100644 --- a/source/_components/transmission.markdown +++ b/source/_components/transmission.markdown @@ -103,9 +103,10 @@ monitored_conditions: The Transmission component is continuously monitoring the status of torrents in the target client. Once a torrent is started or completed, an event is triggered on the Home Assistant Bus, which allows to implement any kind of automation. Possible events are: - - transmission_downloaded_torrent - - transmission_started_torrent - + +- transmission_downloaded_torrent +- transmission_started_torrent + Inside of the event, there is the name of the torrent that is started or completed, as it is seen in the Transmission User Interface. Example of configuration of an automation with completed torrents: diff --git a/source/_components/utility_meter.markdown b/source/_components/utility_meter.markdown index fe67179e7f1..d90b12ee434 100644 --- a/source/_components/utility_meter.markdown +++ b/source/_components/utility_meter.markdown @@ -14,14 +14,14 @@ logo: energy_meter.png ha_qa_scale: internal --- -The `utility meter` component provides functionality to track consumptions of various utilities (e.g., energy, gas, water, heating). +The `utility meter` component provides functionality to track consumptions of various utilities (e.g., energy, gas, water, heating). From a user perspective, utility meters operate in cycles (usually monthly) for billing purposes. This sensor will track a source sensor values, automatically resetting the meter based on the configured cycle. On reset an attribute will store the previous meter value, providing the means for comparison operations (e.g., "did I spend more or less this month?") or billing estimation (e.g., through a sensor template that multiplies the metered value per the charged unit amount). Some utility providers have different tariffs according to time/resource availability/etc. The utility meter enables you to define the various tariffs supported by your utility provider and accounts your consumptions in accordance. When tariffs are defined a new entity will show up indicating the current tariff. In order to change the tariff, the user must call a service, usually through an automation that can be based in time or other external source (eg. a REST sensor).

-Sensors created with this component are persistent, so values are retained across restarts of home assistant. The first cycle for each sensor, will be incomplete; a sensor tracking daily usage, will start to be accurate the next day after the component was activated. A sensor tracking monthly usage, will present accurate data starting the first of the next month after being added to home assistant. +Sensors created with this component are persistent, so values are retained across restarts of home assistant. The first cycle for each sensor, will be incomplete; a sensor tracking daily usage, will start to be accurate the next day after the component was activated. A sensor tracking monthly usage, will present accurate data starting the first of the next month after being added to home assistant.

## {% linkable_title Configuration %} @@ -53,11 +53,11 @@ offset: tariffs: description: List of tariffs supported by the utility meter. required: false - default: [] - type: list + default: [] + type: list {% endconfiguration %} -# {% linkable_title Services %} +## {% linkable_title Services %} ### {% linkable_title Service `utility_meter.reset` %} @@ -69,7 +69,7 @@ Reset the Utility Meter. All sensors tracking tariffs will be reset to 0. ### {% linkable_title Service `utility_meter.next_tariff` %} -Change the current tariff to the next in the list. +Change the current tariff to the next in the list. This service must be called by the user for the tariff switching logic to occur (e.g. using an automation) | Service data attribute | Optional | Description | @@ -78,7 +78,7 @@ This service must be called by the user for the tariff switching logic to occur ### {% linkable_title Service `utility_meter.select_tariff` %} -Change the current tariff to the given tariff. +Change the current tariff to the given tariff. This service must be called by the user for the tariff switching logic to occur (e.g. using an automation) | Service data attribute | Optional | Description | @@ -92,8 +92,8 @@ The following configuration shows an example where 2 utility_meters (`daily_ener Both track the same sensor (`sensor.energy`) which continously monitors the energy consumed. -4 different sensors will be created, 2 per utility meter and corresponding to each tariff. -Sensor `sensor.daily_energy_peak`, `sensor.daily_energy_offpeak`, `sensor.monthly_energy_peak` and `sensor.monthly_energy_offpeak` will automatically be created to track the consumption in each tariff for the given cycle. +4 different sensors will be created, 2 per utility meter and corresponding to each tariff. +Sensor `sensor.daily_energy_peak`, `sensor.daily_energy_offpeak`, `sensor.monthly_energy_peak` and `sensor.monthly_energy_offpeak` will automatically be created to track the consumption in each tariff for the given cycle. `utility_meter.daily_energy` and `utility_meter.monthly_energy` entities will track the current tariff and provide a service to change the tariff. @@ -101,7 +101,7 @@ Sensor `sensor.daily_energy_peak`, `sensor.daily_energy_offpeak`, `sensor.monthl utility_meter: daily_energy: source: sensor.energy - cycle: daily + cycle: daily tariffs: - peak - offpeak @@ -114,8 +114,9 @@ utility_meter: ``` Assuming your energy provider tariffs are time based according to: + - *peak*: from 9h00 to 21h00 -- *offpeak*: from 21h00 to 9h00 next day +- *offpeak*: from 21h00 to 9h00 next day a time based automation can be used: @@ -128,16 +129,18 @@ automation: at: '21:00:00' action: - service: utility_meter.next_tariff - entity_id: utility_meter.daily_energy + entity_id: utility_meter.daily_energy - service: utility_meter.next_tariff entity_id: utility_meter.monthly_energy -``` -# {% linkable_title Advanced Configuration for DSMR users %} +``` -When using the [DSMR component](https://www.home-assistant.io/components/sensor.dsmr/) to get data from the utility meter, each tariff (peak and off-peak) has a separate sensor. Additionally, there is a separate sensor for gas consumption. The meter switches automatically between tariffs, so an automation is not necessary in this case. But, you do have to setup a few more instances of the `utility_meter` component. +## {% linkable_title Advanced Configuration for DSMR users %} + +When using the [DSMR component](https://www.home-assistant.io/components/sensor.dsmr/) to get data from the utility meter, each tariff (peak and off-peak) has a separate sensor. Additionally, there is a separate sensor for gas consumption. The meter switches automatically between tariffs, so an automation is not necessary in this case. But, you do have to setup a few more instances of the `utility_meter` component. If you want to create a daily and monthly sensor for each tariff, you have to track separate sensors: -- `sensor.power_consumption_low` for off-peak power + +- `sensor.power_consumption_low` for off-peak power - `sensor.power_consumption_normal` for peak power - `sensor.gas_consumption` for gas consumption @@ -147,19 +150,19 @@ So, tracking daily and monthly consumption for each sensor, will require setting utility_meter: daily_power_offpeak: source: sensor.power_consumption_low - cycle: daily + cycle: daily daily_power_peak: source: sensor.power_consumption_normal cycle: daily daily_gas: source: sensor.gas_consumption - cycle: daily + cycle: daily monthly_power_offpeak: source: sensor.power_consumption_low cycle: monthly monthly_power_peak: source: sensor.power_consumption_normal - cycle: monthly + cycle: monthly monthly_gas: source: sensor.gas_consumption cycle: monthly