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
15 changes: 9 additions & 6 deletions source/_docs/ecosystem/backup/backup_dropbox.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ description: "Instructions on how backup your Home Assistant configuration to Dr
redirect_from: /cookbook/dropboxbackup/
---

Backing up and regularly syncing your Home Assistant configuration to [Dropbox](http://dropbox.com) is similar to [Github Backup](/docs/ecosystem/backup/backup_github/)
Backing up and regularly syncing your Home Assistant configuration to [Dropbox](http://dropbox.com) is similar to [GitHub Backup](/docs/ecosystem/backup/backup_github/)

### Requirements
## Requirements

You need two parts in order to get it working correctly.

Expand All @@ -25,6 +25,7 @@ In the Python script you can specify which files and directories should be exclu
chmod +x dropbox_uploader.sh
./dropbox_uploader.sh
```

Follow the instructions you see on your screen.

### Step 2: Running the Dropbox uploader
Expand All @@ -35,18 +36,20 @@ Go to the folder you have placed `dropbox.py`.
Copy file `dropbox_uploader.sh` to : `.homeassistant/extraconfig/shell_code/` (so the full path would be similar to: `/home/homeassistant/.homeassistant/extraconfig/shell_code/dropbox_uploader.sh`)
- **Option B:**
Edit `dropbox.py`:
Change the following line:
Change the following line:

```txt
uploader = "/home/homeassistant/.homeassistant/extraconfig/shell_code/dropbox_uploader.sh"
```

to where you placed your file: (for example):

```txt
uploader = "/home/homeassistant/MyFolder/dropbox_uploader.sh"
```


```bash
$ python dropbox.py
python dropbox.py
```

The first time can take a lot of time since it will upload all your files!
Expand All @@ -58,5 +61,5 @@ So you just made a full backup, next time you want it to be done automatically.
Add it to your crontab, edit the **path/to** part.

```bash
$ (crontab -l 2>/dev/null; echo "0 3 * * * python /path/to/dropbox.py") | crontab -
(crontab -l 2>/dev/null; echo "0 3 * * * python /path/to/dropbox.py") | crontab -
```
6 changes: 3 additions & 3 deletions source/_docs/z-wave/devices.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: "What you need to know about Z-Wave devices."
redirect_from: /getting-started/z-wave-devices/
---

## Devices, Nodes, Entities, what?
## Devices, Nodes, Entities

The *device* is the hardware, and also used when referring to the node and all its entities. There are 3 main types of devices:

Expand Down Expand Up @@ -65,8 +65,8 @@ Polling needs to be enabled per device, you can control this through the *pollin

The Central Scene command class isn't yet supported in OpenZWave (there is [work in progress](https://github.com/OpenZWave/open-zwave/pull/1125) to provide it it), though Home Assistant has introduced some support with [change 9178](https://github.com/home-assistant/home-assistant/pull/9178) which was part of 0.53 and [documented here](/docs/z-wave/device-specific/#homeseer-switches).

## Is my device supported?
## Supported Devices

You can check to see if OpenZWave supports your particular device by looking at the [OpenZWave 1.4 github](https://github.com/OpenZWave/open-zwave/tree/1.4/config). Be aware that being listed here doesn't mean that it will be supported in Home Assistant, since the version of OpenZWave used by Home Assistant will often lag the github by a few months.
You can check to see if OpenZWave supports your particular device by looking at the [OpenZWave 1.4 GitHub](https://github.com/OpenZWave/open-zwave/tree/1.4/config). Be aware that being listed here doesn't mean that it will be supported in Home Assistant, since the version of OpenZWave used by Home Assistant will often lag the GitHub by a few months.

Even if your device isn't listed there, it's likely that it will still work as expected as long as the device complies with the Z-Wave standards. The OpenZWave wiki describes how [you can add support](https://github.com/OpenZWave/open-zwave/wiki/Adding-Devices) for your device if it isn't listed.
3 changes: 1 addition & 2 deletions source/_faq/missing-documentation.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: "The docs are missing or outdated"
ha_category: Documentation
---


Home Assistant is a FAST moving open source project. This means occasionally the official documentation will not be 100% current or complete. Since this is an open source volunteer project, we would encourage anyone who finds gaps in the documentation to click the `edit this page on Github` link in the top right and submit any corrections/enhancements they may find useful.

In the absence of information, many users find it beneficial to look at other people's configurations to find examples of what they want to accomplish in their own configurations. The easiest way to find these configurations is through this [Github search](https://github.com/search?q=topic%3Ahome-assistant-config&type=Repositories).
In the absence of information, many users find it beneficial to look at other people's configurations to find examples of what they want to accomplish in their own configurations. The easiest way to find these configurations is through this [GitHub search](https://github.com/search?q=topic%3Ahome-assistant-config&type=Repositories).
6 changes: 3 additions & 3 deletions source/_integrations/apcupsd.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ There is currently support for the following device types within Home Assistant:

## Hass.io Installation

Install this [unofficial add-on](https://github.com/korylprince/hassio-apcupsd/) to use this integration with Hass.io. Keep in mind that we can't give you support for this add-on.
Install this [unofficial add-on](https://github.com/korylprince/hassio-apcupsd/) to use this integration with Hass.io. Keep in mind that we can't give you support for this add-on.

After installation, follow the instructions on the Github page to configure the plugin. Then continue to follow the integration configurations below.
After installation, follow the instructions on the GitHub page to configure the plugin. Then continue to follow the integration configurations below.

## Configuration

Expand Down Expand Up @@ -97,7 +97,7 @@ resources:
type: list
{% endconfiguration %}

### Example
### Example

Given the following output from `apcaccess`:

Expand Down
25 changes: 18 additions & 7 deletions source/_integrations/broadlink.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ slots:

Information about how to install on Windows can be found [here](/integrations/broadlink#sensor#microsoft-windows-installation).

### How to obtain IR/RF packets?
### How to obtain IR/RF packets

Choose Call Service from the Developer Tools. Choose the service `broadlink.learn` from the list of **Available services:**, write in "Service Data" JSON with 1 field "host":"your_broadlink_IP" 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.

Expand Down Expand Up @@ -524,7 +524,7 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro
- 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](https://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 [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.

Expand Down Expand Up @@ -570,42 +570,49 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro
3. Hit "Learn New Command" and follow instructions on screen.
4. The "OnRawData Base64" is the value to be used with Home Assistant.


### Using Node-RED to obtain codes

1. Install the Broadlink Control palette in Node-RED (click the Hamburger menu at top right corner> Settings> Palette> Install and type Broadlink. Click install on the node-red-contrib-broadlink-control.
2. Once installed, verify that the new palette titled broadlink is available in the nodes menu.
3. Drag the RM node to an empty flow and double click to configure the node.

```bash
a. give your RM device a name for easy identification
b. click on the pencil to edit the device information
c. enter the MAC address of the Broadlink RM PRO or RM Mini
d. enter the IP address of the Broadlink RM PRO or RM mini
e. leave the Catalog field empty.
```

4. Click Update, and the device field should show the MAC address of the newly added device. If not, just select it.
5. In the Action field, select Learn, then click Done.
6. Drag an Inject node to the left of the RM node and link them. The type of inject doesn't matter. Leave it to the defaults.
7. Drag a Template node on the Flow to the right of the RM node and link it to the RM node.
8. Double click the Template node to edit it, select:

```bash
Property: msg.payload
Format: Mustache template
Template field: enter '{% raw %}{{payload.data}}{% endraw %}'.
Output as: Plain text
```

9. Drag a Debug node to the right of the Template node and link them.
10. Show the debug messages, deploy the flow and click on the inject button.
11. A message will show in the debug window:

```bash
3/23/2019, 9:56:53 AMnode: RM_Mini1
msg : string[47]
"Please tap the remote button within 30 seconds."
```

12. Point the IR remote control at the RM device and click the desired button for about 2 seconds. An array of numbers will show in the debug window. For example:

```bash
'38,0,132,3,19,18,19,18,19,18,19,17,20,54,20,54,20,54,19,18,19,18,19,18,19,17,20,17,20,17,20,54,20,17,19,18,19,18,19,18,19,17,20,17,20,54,20,17,20,54,19,55,19,54,20,54,20,54,19,55,19,0,6,6,150,146,20,54,20,54,20,54,19,18,19,18,19,18,19,17,20,17,20,54,20,54,19,55,19,18,19,17,20,17,20,17,20,17,20,17,20,54,19,18,19,18,19,18,19,17,20,17,20,17,20,54,19,18,19,55,19,54,20,54,20,54,20,54,19,55,19,0,6,6,150,146,20,54,20,54,19,55,19,18,19,17,20,17,20,17,20,17,20,54,19,55,19,54,20,17,20,17,20,17,20,17,20,17,19,18,19,55,19,17,20,17,20,17,20,17,20,17,19,18,19,55,19,18,19,54,20,54,20,54,19,55,19,54,20,54,20,0,6,5,150,146,20,54,20,54,20,54,19,18,19,18,19,18,19,17,20,17,20,54,20,54,19,55,19,18,19,17,20,17,20,17,20,17,20,17,20,54,19,18,19,18,19,18,19,17,20,17,20,17,20,54,19,18,19,55,19,54,20,54,20,54,19,55,19,54,20,0,6,6,149,147,20,54,19,55,19,54,20,17,20,17,20,17,20,17,20,17,19,55,19,54,20,54,20,17,20,17,20,17,19,18,19,18,19,18,19,54,20,17,20,17,20,17,20,17,19,18,19,18,19,54,20,17,20,54,20,54,20,54,19,...'
```

This is the code we need to transmit again to replicate the same remote function.

### Using Node red to Transmit Codes
Expand All @@ -614,6 +621,7 @@ This is the code we need to transmit again to replicate the same remote function
2. In the Action field, select - Set from msg.payload -.
3. Drag an Inject node and give it a meaningful name relevant to the remote control button function, like "TV On" or "TV Source".
4. Drag a template node and double click it to configure:

```bash
Property: msg.payload
Format: Mustache template
Expand All @@ -624,13 +632,16 @@ This is the code we need to transmit again to replicate the same remote function
}'
In the Output as field, "select Parsed JSON".
```

5. Click Done.
6. Drag a debug node and connect it to the output of the RM node.
7. Connect the Inject node to the Template node, and the template node to the RM node.
8. Click Deploy to activate the flow, and then click the inject button. The debug window should show a debug message. For example:

```bash
{"action":"send","data": [38,0,152,0,0,1,39,148,19,18,18,19,18,55,19,18,18,19,18,19,18,19,18,55,18,56,18,19,18,55,18,19,18,56,18,18,19,55,18,19,18,19,18,18,18,56,18,19,18,18,19,55,18,56,18,18,19,18,18,19,18,19,18,55,19,18,18,19,18,19,18,19,18,18,18,19,18,19,18,55,19,55,18,19,18,19,18,18,19,18,18,56,18,19,18,18,19,55,18,56,18,18,19,18,18,19,18,19,18,19,18,18,19,18,18,56,18,55,18,19,18,19,18,19,18,18,19,55,18,19,18,55,19,18,18,56,18,19,18,18,19,18,18,19,18,19,18,19,18,18,18,56,18,0,13,5],"status":"OK"}
```

The "status" : "OK" at the end is a feedback that the Broadlink RM device is connected and has transmitted the payload.

Now you can add as many template nodes, each having a specific code, and add any type of input nodes to activate the template and transmit the code.
Expand All @@ -641,12 +652,12 @@ It is also possible to obtain codes using `broadlink_cli` from [python-broadlink
First use discovery to find your Broadlink device:

```bash
./broadlink_discovery
$ ./broadlink_discovery
Discovering...
###########################################
RM2
# broadlink_cli --type 0x2737 --host 192.168.1.137 --mac 36668342f7c8
Device file data (to be used with --device @filename in broadlink_cli) :
Device file data (to be used with --device @filename in broadlink_cli) :
0x2737 192.168.1.137 36668342nnnn
temperature = 0.0
```
Expand All @@ -671,7 +682,7 @@ For old/awkward devices another possibility is to try to get codes by using data

Assuming that your (or similar) device is in one of these databases:

- https://sourceforge.net/p/lirc-remotes/code/ci/master/tree/
- https://github.com/probonopd/irdb/tree/master/
- <https://sourceforge.net/p/lirc-remotes/code/ci/master/tree/>
- <https://github.com/probonopd/irdb/tree/master/>

You can grab `irdb2broadlinkha.sh` from [irdb2broadlinkha](https://github.com/molexx/irdb2broadlinkha) project and try to convert codes to format suitable for Home Assistant.
2 changes: 1 addition & 1 deletion source/_integrations/limitlessled.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ An archive of the extensive API can be found [here](https://github.com/Fantasmos

### Setup

Before configuring Home Assistant, make sure you can control your bulbs or LEDs with the MiLight mobile application. Next, discover your bridge(s) IP address. You can do this via your router or a mobile application like Fing ([android](https://play.google.com/store/apps/details?id=com.overlook.android.fing&hl=en) or [iTunes](https://itunes.apple.com/us/app/fing-network-scanner/id430921107?mt=8)).
Before configuring Home Assistant, make sure you can control your bulbs or LEDs with the MiLight mobile application. Next, discover your bridge(s) IP address. You can do this via your router or a mobile application like Fing ([Android](https://play.google.com/store/apps/details?id=com.overlook.android.fing&hl=en) or [iTunes](https://itunes.apple.com/us/app/fing-network-scanner/id430921107?mt=8)).

To add `limitlessled` to your installation, add the following to your `configuration.yaml` file:

Expand Down
8 changes: 4 additions & 4 deletions source/_integrations/mysensors.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ha_codeowners:

The [MySensors](https://www.mysensors.org) project combines devices like Arduino, ESP8266, Raspberry Pi, NRF24L01+ and RFM69 to build affordable sensor networks. This integration will automatically add all available devices to Home Assistant, after [presentation](#presentation) is done. That is, you do not need to add anything to your configuration for the devices for them to be added. Go to the **states** section of the developer tools to find the devices that have been identified.

### Configuration
## Configuration

Integrate your Serial, Ethernet (LAN) or MQTT MySensors Gateway by adding the following to your `configuration.yaml` file:

Expand Down Expand Up @@ -96,7 +96,7 @@ Not all features of MySensors 2.x are supported by Home Assistant yet. As more f
If you are using an original Arduino as a serial gateway, the port will be named `ttyACM*`. The exact number can be determined with the command shown below.

```bash
$ ls /dev/ttyACM*
ls /dev/ttyACM*
```

If you are using the MQTT gateway, you also need to have the [MQTT component](/integrations/mqtt/) configured in Home Assistant. See below for a minimum MQTT configuration:
Expand Down Expand Up @@ -249,7 +249,8 @@ Message validation was introduced in version 0.52 of Home Assistant.

### Debug logging

If you experience dropped messages or that a device is not added to Home Assistant, please turn on debug logging for the `mysensors` integration and the `mysensors` package. This will help you see what is going on. Make sure you use these logging settings to collect a log sample if you report an issue about the `mysensors` integration in our github issue tracker.
If you experience dropped messages or that a device is not added to Home Assistant, please turn on debug logging for the `mysensors` integration and the `mysensors` package. This will help you see what is going on. Make sure you use these logging settings to collect a log sample if you report an issue about the `mysensors` integration in our GitHub issue tracker.

```yaml
logger:
default: info
Expand All @@ -258,7 +259,6 @@ logger:
mysensors: debug
```


Visit the [library API][MySensors library api] of MySensors for more information.

[MySensors library API]: https://www.mysensors.org/download
2 changes: 1 addition & 1 deletion source/_integrations/opencv.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ image_processing:
- **source** array (*Required*): List of image sources.
- **entity_id** (*Required*): A camera entity id to get picture from.
- **name** (*Optional*): This parameter allows you to override the name of your `image_processing` entity.
- **classifier** (*Optional*): Dictionary of name to path to the classifier xml file. If this field is not provided, a face classifier will be downloaded from OpenCV's Github repo.
- **classifier** (*Optional*): Dictionary of name to path to the classifier xml file. If this field is not provided, a face classifier will be downloaded from OpenCV's GitHub repo.

**classifier** may also be defined as a dictionary of names to classifier configurations:

Expand Down
8 changes: 4 additions & 4 deletions source/_integrations/rpi_gpio.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The `rpi_gpio` integration is the base for all related GPIO platforms in Home As

The `rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/).

## Configuration
### Configuration

To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file:

Expand Down Expand Up @@ -72,7 +72,7 @@ It uses two pins on the Raspberry Pi.

Although you do not need Andrews Hilliday's software controller when you run Home Assistant, he has written clear instructions on how to hook your garage door and sensors up to your Raspberry Pi, which can be found [here](https://github.com/andrewshilliday/garage-door-controller#hardware-setup).

## Configuration
### Configuration

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

Expand Down Expand Up @@ -145,13 +145,13 @@ cover:

## Remote Raspberry Pi Cover

If you don't have Home Assistant running on your Raspberry Pi and you want to use it as a remote cover instead, there is a project called [GarageQTPi](https://github.com/Jerrkawz/GarageQTPi) that will work remotely with the [MQTT Cover Component](/integrations/cover.mqtt/). Follow the Github instructions to install and configure GarageQTPi and once configured follow the Home Assistant instructions to configure the MQTT Cover.
If you don't have Home Assistant running on your Raspberry Pi and you want to use it as a remote cover instead, there is a project called [GarageQTPi](https://github.com/Jerrkawz/GarageQTPi) that will work remotely with the [MQTT Cover Component](/integrations/cover.mqtt/). Follow the GitHub instructions to install and configure GarageQTPi and once configured follow the Home Assistant instructions to configure the MQTT Cover.

## Switch

The `rpi_gpio` switch platform allows you to control the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/).

## Configuration
### Configuration

To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file:

Expand Down
Loading