Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/_components/amcrest.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Configuration variables:
- **sdcard**: Return the SD card usage by reporting the total and used space
- **ptz_preset**: Return the number of PTZ preset positions configured for the given camera
- **switches** array (*Optional*): Switches to display in the frontend. By default, *none* of the switches are shown. The following switches can be monitored.
- **motion_detection**: Enable/disable motion detection setting
- **motion_detection**: Enable/disable motion detection setting
- **motion_recording**: Enable/disable recording on motion detection setting

**Note:** Amcrest cameras with newer firmware no longer have the ability to stream `high` definition video with MJPEG encoding. You may need to use `low` resolution stream or the `snapshot` stream source instead. If the quality seems too poor, lower the `Frame Rate (FPS)` and max out the `Bit Rate` settings in your camera's configuration manager. If you defined the *stream_source* to **mjpeg**, make sure your camera supports *Basic* HTTP authentication. Newer Amcrest firmware may not work, then **rtsp** is recommended instead.
Expand Down
13 changes: 6 additions & 7 deletions source/_components/binary_sensor.axis.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,9 @@ See the [Axis main component](/components/axis/) for configuration instructions.

The following sensor types are supported:


* Motion detection
* Passive IR motion detection
* Sound detection
* Day/night mode
* Tampering detection
* Input port
- Motion detection
- Passive IR motion detection
- Sound detection
- Day/night mode
- Tampering detection
- Input port
1 change: 0 additions & 1 deletion source/_components/bloomsky.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ ha_release: 0.14
ha_iot_class: "Cloud Polling"
---


The `bloomsky` component allows you to access your [BloomSky](https://www.bloomsky.com/) weather station's [sensors](/components/sensor.bloomsky), [binary sensors](/components/binary_sensor.bloomsky), and [camera](/components/camera.bloomsky) from Home Assistant.

Obtain your API key from your [BloomSky dashboard](https://dashboard.bloomsky.com). Click `developers` in the bottom left of the screen.
Expand Down
10 changes: 4 additions & 6 deletions source/_components/camera.xeoma.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ ha_iot_class: "Local Polling"
ha_release: 0.62
---


The `Xeoma` camera platform allows you to view the video feeds from a [Xeoma](http://felenasoft.com/xeoma) video surveillance server.

To enable Xeoma camera feeds, add the following lines to your `configuration.yaml`:
Expand Down Expand Up @@ -48,7 +47,7 @@ cameras:
required: false
type: list
keys:
image_name:
image_name:
description: The name of the JPEG image for this camera as configured in Xeoma (without .jpg extension).
required: true
type: string
Expand Down Expand Up @@ -82,8 +81,7 @@ camera:
```

To use this platform, you must have the Xeoma Web Server module enabled in at least one of your camera chains.

This platform will parse the Xeoma web interface to find all enabled cameras and add them all to Home Assistant. You can
hide individual cameras using the platform configuration.


This platform will parse the Xeoma web interface to find all enabled cameras and add them all to Home Assistant. You can hide individual cameras using the platform configuration.

The `image_name` configuration value for each camera should match the name supplied to the Xeoma Web Server configuration (under _Path to access images_) with the _.jpg_ extension removed.
19 changes: 8 additions & 11 deletions source/_components/cover.opengarage.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ ha_category: Cover
ha_release: 0.44
---


The `opengarage` cover platform lets you control the open-source [OpenGarage.io](https://opengarage.io/) device through Home Assistant.
The `opengarage` cover platform lets you control the open-source [OpenGarage.io](https://opengarage.io/) device through Home Assistant.

To enable OpenGarage Covers in your installation, add the following to your `configuration.yaml` file:

Expand All @@ -36,12 +35,10 @@ Configuration variables:

- **covers** array (*Required*): List of your doors.
- **identifier** (*Required*): Name of the cover as slug. Multiple entries are possible.
- **host** (*Required*): IP address of device.
- **port** (*Optional*): HTTP Port. Default is `80`.
- **device_key** (*Required*): Access key to control device. Default is `opendoor`.
- **name** (*Optional*): Name to use in the Frontend. If not provided, it will use name configured in device.


- **host** (*Required*): IP address of device.
- **port** (*Optional*): HTTP Port. Default is `80`.
- **device_key** (*Required*): Access key to control device. Default is `opendoor`.
- **name** (*Optional*): Name to use in the Frontend. If not provided, it will use name configured in device.

**Example with more detail:**
<p class='img'>
Expand All @@ -53,7 +50,7 @@ Configuration variables:
cover:
platform: opengarage
covers:
garage:
garage:
host: 192.168.1.12
device_key: opendoor
name: honda
Expand Down Expand Up @@ -93,12 +90,12 @@ sensor:
{% endif %}'{% endraw %}

group:
garage:
garage:
name: Garage
entities:
- cover.honda
- sensor.garage_status
- sensor.garage_car_present
- sensor.garage_car_present

customize:
cover.honda:
Expand Down
5 changes: 2 additions & 3 deletions source/_components/device_tracker.linksys_smart.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,11 @@ logo: linksys.png
ha_release: 0.48
---

The `linksys_smart` platform offers presence detection by looking at connected devices to a Linksys Smart Wifi based router.
The `linksys_smart` platform offers presence detection by looking at connected devices to a Linksys Smart Wifi based router.

Tested routers:
Tested routers:
LINKSYS WRT3200ACM MU-MIMO Gigabit Wi-Fi Wireless Router
LINKSYS WRT1900ACS Dual-band Wi-Fi Router


<p class='note'>
For this platform to work correctly, it is necessary to disable the "Access via wireless" feature in the Local Management Access section of the router administration page. If "Access via wireless" is not disabled, a connectivity conflict arises because the Home Assistant integration is trying to pass userid and password, but the router is only expecting a password.
Expand Down
7 changes: 3 additions & 4 deletions source/_components/device_tracker.ubus.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -70,14 +70,13 @@ Configuration variables:
- **password** (*Required*): The password for your given account.
- **dhcp_software** (*Optional*): The DHCP software used in your router: `dnsmasq`, `dhcpd`, or `none`. Defaults to `dnsmasq`.


See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

## Troubleshooting
## {% linkable_title Troubleshooting %}

If you find that this never creates `known_devices.yaml`, or if you need more information on the communication chain between Home Assistant and OpenWRT, follow these steps to grab the packet stream and gain insight into what's happening.

### Increase Log Level
### {% linkable_title Increase Log Level %}

1. On your Home Assistant device, stop Home Assistant
2. Adjust `configuration.yaml` to log more detail for the `device_tracker` component
Expand Down Expand Up @@ -167,6 +166,6 @@ Connection: keep-alive
```
11. In this case we are actually receiving a valid response with no data. The request says that we are looking for ARP information from `hostapd.*`, which is the access point on the router. In my environment I don't use the AP on the router, and so it was correctly returning no data. Armed with this information, I know that I cannot use this component for device tracking or presence.

### Cleanup
### {% linkable_title Cleanup %}

When you're done troubleshooting, remember to reset your logging configuration and delete any capture files that contain sensitive information.
23 changes: 11 additions & 12 deletions source/_components/ecobee.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -14,34 +14,33 @@ ha_release: 0.9
ha_iot_class: "Cloud Push"
---


The `ecobee` component lets you control a thermostats and view sensor data from [ecobee](https://ecobee.com) thermostats.

You will need to obtain an API key from ecobee's [developer site](https://www.ecobee.com/developers/) to use this component. To get the key, first you need to register your thermostat which should be done as part of the ecobee installation. Once you have done that perform the following steps.

1. Click on the **Become a developer** link on the [developer site](https://www.ecobee.com/developers/).
1. Click on the **Become a developer** link on the [developer site](https://www.ecobee.com/developers/).
2. Login with your ecobee credentials.
3. Accept the SDK agreement.
4. Fill in the fields.
5. Click **save**.
5. Click **save**.

Now login to the regular consumer portal, and in the hamburger menu there will be a new option **Developer**. Now we can create the Application to hook up to Home Assistant.

1. Select the Developer option.
2. Select **Create New**.
3. Give your app a name (it appears to need to be unique across all users, as I tried 'home-assistant' and it said it was already in use. Try <yournameoralias>-home-assistant) and a summary (neither of these are important as they are not used anywhere).
4. For Authorization method select **ecobee PIN**.
5. You don't need an Application Icon or Detailed Description.
6. Click **Create**.
1. Select the Developer option.
2. Select **Create New**.
3. Give your app a name (it appears to need to be unique across all users, as I tried 'home-assistant' and it said it was already in use. Try <yournameoralias>-home-assistant) and a summary (neither of these are important as they are not used anywhere).
4. For Authorization method select **ecobee PIN**.
5. You don't need an Application Icon or Detailed Description.
6. Click **Create**.

Now under the Name and Summary Section you will have an API key. Copy this key and use it in you configuration section below. Click the **X** to close the Developer section.

The first time you run Home Assistant with this component it will give you a PIN code that you need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by clicking **Add Application** in the **My Apps** section in the sidebar.

The PIN can be found from the Home Assistant portal on the Ecobee card or from the **configurator.ecobee** entity in states in the portal.

- If you do not have an ecobee card, you may be using groups with `default_view` that don't show the card. To get around this you can temporarily comment out the `default_view` section or add the `configurator.ecobee` component to your `default_view` and restart Home Assistant.
- If you do not have an ecobee card, you may be using groups with `default_view` that don't show the card. To get around this you can temporarily comment out the `default_view` section or add the `configurator.ecobee` component to your `default_view` and restart Home Assistant.

Once you enter the PIN on the ecobee site, wait approximately 5 minutes and then click on the **I have authorized the app** link at the bottom of the ecobee pop-up window. If everything worked correctly, you should now be able to restart Home Assistant again to see the full ecobee card with all of the sensors populated or see the list of sensors in the developer tools. Now you can re-enable your `default_view` (if you had to disable it) and add the ecobee sensors to a group and/or view.

To set it up, add the following information to your `configuration.yaml` file:
Expand All @@ -62,4 +61,4 @@ Configuration variables:
<img src='{{site_root}}/images/screenshots/ecobee-thermostat-card.png' />
</p>

If for whatever reason you delete and re-create your ecobee app at ecobee.com such that your developer API key changes, you will need to delete your `/conf/ecobee.conf file`. You will also need to update the `api_key:` in the `configuration.yaml` or `secrets.yaml` file.
If for whatever reason you delete and re-create your ecobee app at ecobee.com such that your developer API key changes, you will need to delete your `/conf/ecobee.conf file`. You will also need to update the `api_key:` in the `configuration.yaml` or `secrets.yaml` file.
66 changes: 33 additions & 33 deletions source/_components/fan.xiaomi_miio.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@ The `xiaomi_miio` fan platform allows you to control the Xiaomi Air Purifier and

### Air Purifier 2 et al.

* Power (on, off)
* Operation modes (auto, silent, favorite, idle)
* Buzzer (on, off)
* Child lock (on, off)
* LED (on, off), LED brightness (bright, dim, off)
* Favorite Level (0...16)
* Attributes
- Power (on, off)
- Operation modes (auto, silent, favorite, idle)
- Buzzer (on, off)
- Child lock (on, off)
- LED (on, off), LED brightness (bright, dim, off)
- Favorite Level (0...16)
- Attributes
- model
- temperature
- humidity
Expand Down Expand Up @@ -53,12 +53,12 @@ The `xiaomi_miio` fan platform allows you to control the Xiaomi Air Purifier and

### Air Purifier Pro (zhimi.airpurifier.v6)

* Power (on, off)
* Operation modes (auto, silent, favorite)
* Child lock (on, off)
* LED (on, off)
* Favorite Level (0...16)
* Attributes
- Power (on, off)
- Operation modes (auto, silent, favorite)
- Child lock (on, off)
- LED (on, off)
- Favorite Level (0...16)
- Attributes
- model
- temperature
- humidity
Expand Down Expand Up @@ -89,11 +89,11 @@ The `xiaomi_miio` fan platform allows you to control the Xiaomi Air Purifier and

### Air Purifier V3 (zhimi.airpurifier.v3)

* Power (on, off)
* Operation modes (auto, silent, favorite, idle, medium, high, strong)
* Child lock (on, off)
* LED (on, off)
* Attributes
- Power (on, off)
- Operation modes (auto, silent, favorite, idle, medium, high, strong)
- Child lock (on, off)
- LED (on, off)
- Attributes
- model
- aqi
- mode
Expand Down Expand Up @@ -121,13 +121,13 @@ The `xiaomi_miio` fan platform allows you to control the Xiaomi Air Purifier and

### Air Humidifier (zhimi.humidifier.v1)

* On, Off
* Operation modes (silent, medium, high)
* Buzzer (on, off)
* Child lock (on, off)
* LED brightness (bright, dim, off)
* Target humidity (30, 40, 50, 60, 70, 80)
* Attributes
- On, Off
- Operation modes (silent, medium, high)
- Buzzer (on, off)
- Child lock (on, off)
- LED brightness (bright, dim, off)
- Target humidity (30, 40, 50, 60, 70, 80)
- Attributes
- model
- temperature
- humidity
Expand All @@ -143,14 +143,14 @@ The `xiaomi_miio` fan platform allows you to control the Xiaomi Air Purifier and

### Air Humidifier CA (zhimi.humidifier.ca1)

* On, Off
* Operation modes (silent, medium, high, auto)
* Buzzer (on, off)
* Child lock (on, off)
* LED brightness (bright, dim, off)
* Target humidity (30, 40, 50, 60, 70, 80)
* Dry mode (on, off)
* Attributes
- On, Off
- Operation modes (silent, medium, high, auto)
- Buzzer (on, off)
- Child lock (on, off)
- LED brightness (bright, dim, off)
- Target humidity (30, 40, 50, 60, 70, 80)
- Dry mode (on, off)
- Attributes
- model
- temperature
- humidity
Expand Down
Loading