Skip to content

Commit c2bd869

Browse files
authored
Fix README.md
Fix image paths Add entity_friendly_name_prefix to yaml examples
1 parent 52f4467 commit c2bd869

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ The main instance connects to the Websocket APIs of the remote instances (alread
1919

2020
After the connection is completed, the remote states get populated into the master instance.
2121
The entity ids can optionally be prefixed via the `entity_prefix` parameter.
22+
2223
The entity friendly names can optionally be prefixed via the `entity_friendly_name_prefix` parameter.
2324

2425
The component keeps track which objects originate from which instance. Whenever a service is called on an object, the call gets forwarded to the particular remote instance.
@@ -58,29 +59,29 @@ This is not needed on the main instance.
5859
5960
1. Add a new Remote Home-Assistant integration
6061
61-
<img src="img/setup.png" height="400"/>
62+
<img src="https://raw.githubusercontent.com/lukas-hetzenecker/home-assistant-remote/master/img/setup.png" height="400"/>
6263
6364
2. Specify the connection details to the remote instance
6465
65-
<img src="img/device.png" height="400"/>
66+
<img src="https://raw.githubusercontent.com/lukas-hetzenecker/home-assistant-remote/master/img/device.png" height="400"/>
6667
6768
You can generate an access token in the by logging into your remote instance, clicking on your user profile icon, and then selecting "Create Token" under "Long-Lived Access Tokens".
6869
6970
Check "Secure" if you want to connect via a secure (https/wss) connection
7071
7172
3. After the instance is added, you can configure additional Options by clicking the "Options" button.
7273
73-
<img src="img/options.png" height="200"/>
74+
<img src="https://raw.githubusercontent.com/lukas-hetzenecker/home-assistant-remote/master/img/options.png" height="200"/>
7475
7576
4. You can configure an optional prefix that gets prepended to all remote entities (if unsure, leave this blank).
7677
77-
<img src="img/step1.png" height="200"/>
78+
<img src="https://raw.githubusercontent.com/lukas-hetzenecker/home-assistant-remote/master/img/step1.png" height="200"/>
7879
7980
Click "Submit" to proceed to the next step.
8081
8182
5. You can also define filters, that include/exclude specified entities or domains from the remote instance.
8283
83-
<img src="img/step2.png" height="200"/>
84+
<img src="https://raw.githubusercontent.com/lukas-hetzenecker/home-assistant-remote/master/img/step2.png" height="200"/>
8485
8586
8687
@@ -116,6 +117,7 @@ remote_homeassistant:
116117
verify_ssl: false
117118
access_token: !secret access_token
118119
entity_prefix: "instance02_"
120+
entity_friendly_name_prefix: "Instance02 "
119121
include:
120122
domains:
121123
- sensor
@@ -177,6 +179,10 @@ entity_prefix:
177179
description: Prefix for all entities of the remote instance.
178180
required: false
179181
type: string
182+
entity_friendly_name_prefix:
183+
description: Prefix for all entity friendly names of the remote instance.
184+
required: false
185+
type: string
180186
include:
181187
description: Configures what should be included from the remote instance. Values set by the exclude lists will take precedence.
182188
required: false

0 commit comments

Comments
 (0)