diff --git a/source/_components/vacuum.xiaomi_miio.markdown b/source/_components/vacuum.xiaomi_miio.markdown index fbc1a222515..1159d02d9a6 100644 --- a/source/_components/vacuum.xiaomi_miio.markdown +++ b/source/_components/vacuum.xiaomi_miio.markdown @@ -13,7 +13,7 @@ ha_release: 0.51 ha_iot_class: "Local Polling" --- -The `xiaomi miio` vacuum platform allows you to control the state of your [Xiaomi Mi Robot Vacuum](https://www.mi.com/roomrobot/). +The `xiaomi_miio` vacuum platform allows you to control the state of your [Xiaomi Mi Robot Vacuum](https://www.mi.com/roomrobot/). Currently supported services are: @@ -69,39 +69,39 @@ In addition to all of the services provided by the `vacuum` component (`start`, Start the remote control mode of the robot. You can then move it with `remote_control_move`; when done, call `remote_control_stop`. -| Service data attribute | Optional | Description | -|---------------------------|----------|-------------------------------------------------------| -| `entity_id` | yes | Only act on specific robot; default targets all | +| Service data attribute | Optional | Description | +|---------------------------|----------|---------------------------------------------------| +| `entity_id` | yes | Only act on a specific robot; default targets all | ### {% linkable_title Service `vacuum.xiaomi_remote_control_stop` %} Exit the remote control mode of the robot. -| Service data attribute | Optional | Description | -|---------------------------|----------|-------------------------------------------------------| -| `entity_id` | yes | Only act on specific robot; default targets all | +| Service data attribute | Optional | Description | +|---------------------------|----------|---------------------------------------------------| +| `entity_id` | yes | Only act on a specific robot; default targets all | ### {% linkable_title Service `vacuum.xiaomi_remote_control_move` %} Remote control the robot. Please ensure you first set it in remote control mode with `remote_control_start`. -| Service data attribute | Optional | Description | -|---------------------------|----------|-------------------------------------------------------| -| `entity_id` | yes | Only act on specific robot; default targets all | -| `velocity` | no | Speed: between -0.29 and 0.29 | -| `rotation` | no | Rotation: between -179 degrees and 179 degrees | -| `duration` | no | The number of milliseconds that the robot should move for | +| Service data attribute | Optional | Description | +|---------------------------|----------|-----------------------------------------------------------| +| `entity_id` | yes | Only act on a specific robot; default targets all | +| `velocity` | no | Speed: between -0.29 and 0.29 | +| `rotation` | no | Rotation: between -179 degrees and 179 degrees | +| `duration` | no | The number of milliseconds that the robot should move for | ### {% linkable_title Service `vacuum.xiaomi_remote_control_move_step` %} Enter remote control mode, make one move, stop, and exit remote control mode. -| Service data attribute | Optional | Description | -|---------------------------|----------|-------------------------------------------------------| -| `entity_id` | yes | Only act on specific robot; default targets all | -| `velocity` | no | Speed: between -0.29 and 0.29. | -| `rotation` | no | Rotation: between -179 degrees and 179 degrees. | -| `duration` | no | The number of milliseconds that the robot should move for | +| Service data attribute | Optional | Description | +|---------------------------|----------|-----------------------------------------------------------| +| `entity_id` | yes | Only act on a specific robot; default targets all | +| `velocity` | no | Speed: between -0.29 and 0.29 | +| `rotation` | no | Rotation: between -179 degrees and 179 degrees | +| `duration` | no | The number of milliseconds that the robot should move for | ## {% linkable_title Attributes %} @@ -134,23 +134,23 @@ The following table shows the units of measurement for each attribute: ## {% linkable_title Retrieving the Access Token %}
-As per [python-miio issue 185](https://github.com/rytilahti/python-miio/issues/185) the Android Mi Home app no longer stores the token within the database (it's retrieved from Xiaomi servers from version 5.0.31+). Currently the only known fix is to uninstall, then install a downgraded version of the apk. Apkmirror is a trusted source for older versions of the app. [Mi-Home version 5.0.30](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-30-release/) is confirmed as working for the following Android methods. Using older version than 5.0.30 is not recommended as it might lack support for some newer devices like the Roborock S50.
+As per [`python-miio` issue 185](https://github.com/rytilahti/python-miio/issues/185) the Android Mi Home app no longer stores the token within the database (it's retrieved from Xiaomi servers from version 5.0.31+). Currently, the only known fix is to uninstall, then install a downgraded version of the apk. Apkmirror is a trusted source for older versions of the app. [Mi-Home version 5.0.30](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-30-release/) is confirmed as working for the following Android methods. Using an older version than 5.0.30 is not recommended as it might lack support for some newer devices like the Roborock S50.
-The iPhone app still stores the token in the sqlite db as of v4.10.2 (Dec 22, 2018).
+The iPhone app still stores the token in the SQLite db as of v4.10.2 (Dec 22, 2018).
This token (32 hexadecimal characters) is required for the Xiaomi Mi Robot Vacuum, Mi Robot 2 (Roborock) Vacuum, Xiaomi Philips Lights and Xiaomi IR Remote. The Xiaomi Gateway uses another security method and requires a `key` (16 alphanumeric chars), which can be obtained
easily via a hidden menu item at the Mi-Home app or using the `miio` command line tool.
The Unix timestamps can be obtained from the `input_datetime` component. This will allow you to graphically set the start and end date. @@ -56,11 +55,11 @@ The Unix timestamps can be obtained from the `input_datetime` component. This wi ### {% linkable_title Service `econet.delete_vacation` %} -You can use the service `econet.delete_vacation` to remove all vactions from an EcoNet water heater. +You can use the service `econet.delete_vacation` to remove all vacations from an EcoNet water heater. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | -| `entity_id` | yes | The entity id of the water heater to remove the vaction from. +| `entity_id` | yes | The entity id of the water heater to remove the vacation from.
Econet water heaters use to live under the `climate` platform prior to release 0.81. diff --git a/source/_components/water_heater.markdown b/source/_components/water_heater.markdown index 245b6eb67c8..a887470e06b 100644 --- a/source/_components/water_heater.markdown +++ b/source/_components/water_heater.markdown @@ -9,9 +9,8 @@ sharing: true footer: true --- - The `water_heater` component is built for the controlling and monitoring of hot water heaters. - + To enable this component, pick one of the platforms, and add it to your `configuration.yaml`: ```yaml @@ -23,6 +22,7 @@ water_heater: ## {% linkable_title Services %} ### {% linkable_title Water heater control services %} + Available services: `water_heater.set_temperature`, `water_heater.turn_away_mode_on`, `water_heater.turn_away_mode_off`, `water_heater.set_operation_mode`
@@ -31,13 +31,13 @@ Not all water heater services may be available for your platform. Be sure to che ### {% linkable_title Service `water_heater.set_temperature` %} -Set target temperature of water heater device +Sets target temperature of water heater device. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at `entity_id`'s of water heater devices to control. Else targets all. | `temperature` | no | New target temperature for water heater -| `operation_mode` | yes | Operation mode to set temperature to. This defaults to current_operation mode if not set, or set incorrectly. +| `operation_mode` | yes | Operation mode to set the temperature to. This defaults to current_operation mode if not set, or set incorrectly. #### {% linkable_title Automation example %} @@ -63,7 +63,7 @@ Set operation mode for water heater device | `entity_id` | yes | String or list of strings that point at `entity_id`'s of water heater devices to control. Else targets all. | `operation_mode` | no | New value of operation mode -#### {% linkable_title Automation example %} +#### {% linkable_title Automation example %} ```yaml automation: @@ -86,7 +86,7 @@ Turn away mode on or off for water heater device | `entity_id` | yes | String or list of strings that point at `entity_id`'s of water heater devices to control. Else targets all. | `away_mode` | no | New value of away mode. 'on'/'off' or True/False -#### {% linkable_title Automation example %} +#### {% linkable_title Automation example %} ```yaml automation: diff --git a/source/_components/water_heater.wink.markdown b/source/_components/water_heater.wink.markdown index a22084a181f..661c256f39f 100644 --- a/source/_components/water_heater.wink.markdown +++ b/source/_components/water_heater.wink.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Wink Water Heater" -description: "Instructions on how to setup the Wink water heaters within Home Assistant." +description: "Instructions on how to set up the Wink water heaters within Home Assistant." date: 2016-11-01 22:36 sidebar: true comments: false @@ -15,14 +15,12 @@ ha_iot_class: "Cloud Polling" The Wink water heater platform allows you to get data from your [Wink](http://www.wink.com/) Water Heaters. -The requirement is that you have setup [Wink](/components/wink/). +The requirement is that you have set up [Wink](/components/wink/). - -### {% linkable_title Supported water heaters %} +## {% linkable_title Supported water heaters %} - Rheem Econet water heaters (No Wink hub required) -
Wink water heaters use to live under the `climate` platform prior to release 0.81.
diff --git a/source/_components/waterfurnace.markdown b/source/_components/waterfurnace.markdown index 4798cd81ec7..e530d87f9d4 100644 --- a/source/_components/waterfurnace.markdown +++ b/source/_components/waterfurnace.markdown @@ -17,21 +17,20 @@ The `waterfurnace` component communicates with the WaterFurnace Symphony website The sensors provided include: - - Thermostat Setpoint - - Thermostat Current Temp - - Leaving Air Temp - - Entering Water Loop Temp - - Current Humidity - - Current Humidity Setpoint - - Total system power (in Watts) - - Furnace Mode - - Compressor Power - - Fan Power - - Aux Power - - Loop Pump Power - - Compressor Speed - - Fan Speed - +- Thermostat Setpoint +- Thermostat Current Temp +- Leaving Air Temp +- Entering Water Loop Temp +- Current Humidity +- Current Humidity Setpoint +- Total system power (in Watts) +- Furnace Mode +- Compressor Power +- Fan Power +- Aux Power +- Loop Pump Power +- Compressor Speed +- Fan Speed ## {% linkable_title Configuration %} @@ -55,8 +54,8 @@ password: type: string {% endconfiguration %} -#### {% linkable_title Limitations %} +## {% linkable_title Limitations %} -The WebSocket interface used by this module requires active polling, otherwise the server side shuts down the connection. By default, this polling is happening every 10 seconds. All sensors are updated during every polling cycle. +The WebSocket interface used by this module requires active polling to prevent the server side shuts down the connection. By default, this polling is happening every 10 seconds. All sensors are updated during every polling cycle. While this is communicating with a thermostat, geothermal systems operate most efficiently when setbacks are not used, and the home is kept at a constant temperature. It remains useful to collect the data from the system to understand its performance, but a full climate interface won't be implemented. diff --git a/source/_components/watson_iot.markdown b/source/_components/watson_iot.markdown index 0014d5e24da..a13ef02fc63 100644 --- a/source/_components/watson_iot.markdown +++ b/source/_components/watson_iot.markdown @@ -22,10 +22,11 @@ a gateway device in your IoT platform instance. For instructions on how to do this check the [official documentation](https://console.bluemix.net/docs/services/IoT/gateways/dashboard.html#IoT_connectGateway) which provides the details on doing this. After you register the gateway device for your home-assistant you'll need 4 pieces of information: - - Organization ID - - Gateway device Type - - Gateway device ID - - Authentication Token + +- Organization ID +- Gateway device Type +- Gateway device ID +- Authentication Token With this basic information you can configure the component: