Skip to content

Commit 2575914

Browse files
frenckklaasnicolaas
andcommitted
Spelling and Markdown fixes: Part 2 (home-assistant#11900)
* Spelling and Markdown fixes: Part 2 * ✏️ Fix table Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com>
1 parent f554e73 commit 2575914

File tree

12 files changed

+213
-200
lines changed

12 files changed

+213
-200
lines changed

source/_docs/ecosystem/backup/backup_dropbox.markdown

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ description: "Instructions on how backup your Home Assistant configuration to Dr
44
redirect_from: /cookbook/dropboxbackup/
55
---
66

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

9-
### Requirements
9+
## Requirements
1010

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

@@ -25,6 +25,7 @@ In the Python script you can specify which files and directories should be exclu
2525
chmod +x dropbox_uploader.sh
2626
./dropbox_uploader.sh
2727
```
28+
2829
Follow the instructions you see on your screen.
2930

3031
### Step 2: Running the Dropbox uploader
@@ -35,18 +36,20 @@ Go to the folder you have placed `dropbox.py`.
3536
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`)
3637
- **Option B:**
3738
Edit `dropbox.py`:
38-
Change the following line:
39+
Change the following line:
40+
3941
```txt
4042
uploader = "/home/homeassistant/.homeassistant/extraconfig/shell_code/dropbox_uploader.sh"
4143
```
44+
4245
to where you placed your file: (for example):
46+
4347
```txt
4448
uploader = "/home/homeassistant/MyFolder/dropbox_uploader.sh"
4549
```
4650

47-
4851
```bash
49-
$ python dropbox.py
52+
python dropbox.py
5053
```
5154

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

6063
```bash
61-
$ (crontab -l 2>/dev/null; echo "0 3 * * * python /path/to/dropbox.py") | crontab -
64+
(crontab -l 2>/dev/null; echo "0 3 * * * python /path/to/dropbox.py") | crontab -
6265
```

source/_docs/z-wave/devices.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "What you need to know about Z-Wave devices."
44
redirect_from: /getting-started/z-wave-devices/
55
---
66

7-
## Devices, Nodes, Entities, what?
7+
## Devices, Nodes, Entities
88

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

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

6666
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).
6767

68-
## Is my device supported?
68+
## Supported Devices
6969

70-
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.
70+
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.
7171

7272
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.

source/_faq/missing-documentation.markdown

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ description: "The docs are missing or outdated"
44
ha_category: Documentation
55
---
66

7-
87
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.
98

10-
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).
9+
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).

source/_integrations/apcupsd.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ There is currently support for the following device types within Home Assistant:
1919

2020
## Hass.io Installation
2121

22-
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.
22+
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.
2323

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

2626
## Configuration
2727

@@ -97,7 +97,7 @@ resources:
9797
type: list
9898
{% endconfiguration %}
9999

100-
### Example
100+
### Example
101101

102102
Given the following output from `apcaccess`:
103103

source/_integrations/broadlink.markdown

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,7 @@ slots:
362362

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

365-
### How to obtain IR/RF packets?
365+
### How to obtain IR/RF packets
366366

367367
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.
368368

@@ -524,7 +524,7 @@ First get or learn all the remotes you want to add to Home Assistant in E-Contro
524524
- Download and install Python 2.7 on your windows PC.
525525
- 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".
526526
- Download and install [iBackup Viewer](https://www.imactools.com/iphonebackupviewer/).
527-
- 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.
527+
- 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.
528528

529529
3. Plug your iphone into your windows PC, open iTunes and create a non-encrypted backup of your device.
530530

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

573-
574573
### Using Node-RED to obtain codes
575574

576575
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.
577576
2. Once installed, verify that the new palette titled broadlink is available in the nodes menu.
578577
3. Drag the RM node to an empty flow and double click to configure the node.
578+
579579
```bash
580580
a. give your RM device a name for easy identification
581581
b. click on the pencil to edit the device information
582582
c. enter the MAC address of the Broadlink RM PRO or RM Mini
583583
d. enter the IP address of the Broadlink RM PRO or RM mini
584584
e. leave the Catalog field empty.
585585
```
586+
586587
4. Click Update, and the device field should show the MAC address of the newly added device. If not, just select it.
587588
5. In the Action field, select Learn, then click Done.
588589
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.
589590
7. Drag a Template node on the Flow to the right of the RM node and link it to the RM node.
590591
8. Double click the Template node to edit it, select:
592+
591593
```bash
592594
Property: msg.payload
593595
Format: Mustache template
594596
Template field: enter '{% raw %}{{payload.data}}{% endraw %}'.
595597
Output as: Plain text
596598
```
599+
597600
9. Drag a Debug node to the right of the Template node and link them.
598601
10. Show the debug messages, deploy the flow and click on the inject button.
599602
11. A message will show in the debug window:
603+
600604
```bash
601605
3/23/2019, 9:56:53 AMnode: RM_Mini1
602606
msg : string[47]
603607
"Please tap the remote button within 30 seconds."
604608
```
609+
605610
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:
611+
606612
```bash
607613
'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,...'
608614
```
615+
609616
This is the code we need to transmit again to replicate the same remote function.
610617

611618
### Using Node red to Transmit Codes
@@ -614,6 +621,7 @@ This is the code we need to transmit again to replicate the same remote function
614621
2. In the Action field, select - Set from msg.payload -.
615622
3. Drag an Inject node and give it a meaningful name relevant to the remote control button function, like "TV On" or "TV Source".
616623
4. Drag a template node and double click it to configure:
624+
617625
```bash
618626
Property: msg.payload
619627
Format: Mustache template
@@ -624,13 +632,16 @@ This is the code we need to transmit again to replicate the same remote function
624632
}'
625633
In the Output as field, "select Parsed JSON".
626634
```
635+
627636
5. Click Done.
628637
6. Drag a debug node and connect it to the output of the RM node.
629638
7. Connect the Inject node to the Template node, and the template node to the RM node.
630639
8. Click Deploy to activate the flow, and then click the inject button. The debug window should show a debug message. For example:
640+
631641
```bash
632642
{"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"}
633643
```
644+
634645
The "status" : "OK" at the end is a feedback that the Broadlink RM device is connected and has transmitted the payload.
635646

636647
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.
@@ -641,12 +652,12 @@ It is also possible to obtain codes using `broadlink_cli` from [python-broadlink
641652
First use discovery to find your Broadlink device:
642653

643654
```bash
644-
./broadlink_discovery
655+
$ ./broadlink_discovery
645656
Discovering...
646657
###########################################
647658
RM2
648659
# broadlink_cli --type 0x2737 --host 192.168.1.137 --mac 36668342f7c8
649-
Device file data (to be used with --device @filename in broadlink_cli) :
660+
Device file data (to be used with --device @filename in broadlink_cli) :
650661
0x2737 192.168.1.137 36668342nnnn
651662
temperature = 0.0
652663
```
@@ -671,7 +682,7 @@ For old/awkward devices another possibility is to try to get codes by using data
671682

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

674-
- https://sourceforge.net/p/lirc-remotes/code/ci/master/tree/
675-
- https://github.com/probonopd/irdb/tree/master/
685+
- <https://sourceforge.net/p/lirc-remotes/code/ci/master/tree/>
686+
- <https://github.com/probonopd/irdb/tree/master/>
676687

677688
You can grab `irdb2broadlinkha.sh` from [irdb2broadlinkha](https://github.com/molexx/irdb2broadlinkha) project and try to convert codes to format suitable for Home Assistant.

source/_integrations/limitlessled.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ An archive of the extensive API can be found [here](https://github.com/Fantasmos
1818

1919
### Setup
2020

21-
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)).
21+
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)).
2222

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

source/_integrations/mysensors.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ha_codeowners:
1212

1313
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.
1414

15-
### Configuration
15+
## Configuration
1616

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

@@ -96,7 +96,7 @@ Not all features of MySensors 2.x are supported by Home Assistant yet. As more f
9696
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.
9797

9898
```bash
99-
$ ls /dev/ttyACM*
99+
ls /dev/ttyACM*
100100
```
101101

102102
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:
@@ -249,7 +249,8 @@ Message validation was introduced in version 0.52 of Home Assistant.
249249

250250
### Debug logging
251251

252-
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.
252+
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.
253+
253254
```yaml
254255
logger:
255256
default: info
@@ -258,7 +259,6 @@ logger:
258259
mysensors: debug
259260
```
260261

261-
262262
Visit the [library API][MySensors library api] of MySensors for more information.
263263

264264
[MySensors library API]: https://www.mysensors.org/download

source/_integrations/opencv.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ image_processing:
3030
- **source** array (*Required*): List of image sources.
3131
- **entity_id** (*Required*): A camera entity id to get picture from.
3232
- **name** (*Optional*): This parameter allows you to override the name of your `image_processing` entity.
33-
- **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.
33+
- **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.
3434

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

source/_integrations/rpi_gpio.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The `rpi_gpio` integration is the base for all related GPIO platforms in Home As
1717

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

20-
## Configuration
20+
### Configuration
2121

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

@@ -72,7 +72,7 @@ It uses two pins on the Raspberry Pi.
7272

7373
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).
7474

75-
## Configuration
75+
### Configuration
7676

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

@@ -145,13 +145,13 @@ cover:
145145

146146
## Remote Raspberry Pi Cover
147147

148-
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.
148+
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.
149149

150150
## Switch
151151

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

154-
## Configuration
154+
### Configuration
155155

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

0 commit comments

Comments
 (0)