Skip to content

Commit c314088

Browse files
authored
Update README.md
1 parent b464f94 commit c314088

File tree

1 file changed

+29
-3
lines changed

1 file changed

+29
-3
lines changed

README.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
This <a href="https://www.home-assistant.io" target="_blank">Home Assistant</a> integration allows you to send notifications to <a href="https://github.com/LAB02-Research/HASS.Agent" target="_blank">HASS.Agent</a>, a Windows-based Home Assistant client.
88

9-
Note: it won't be of much use if you don't have HASS.Agent installed & configured on at least one device.
9+
Note: it won't be of much use if you don't have HASS.Agent installed & configured on at least one PC (or Windows based device).
1010

1111
----
1212

@@ -15,6 +15,7 @@ Note: it won't be of much use if you don't have HASS.Agent installed & configure
1515
* [Functionality](#functionality)
1616
* [Installation](#installation)
1717
* [Configuration](#configuration)
18+
* [Installation and Configuration Summary](#installation-and-configuration-summary)
1819
* [Usage](#usage)
1920
* [Wishlist](#wishlist)
2021
* [License](#license)
@@ -46,16 +47,29 @@ notify:
4647
resource: http://{device_ip}:5115/notify
4748
```
4849
49-
Replace `{device_ip}` with the IP of the device that has an HASS.Agent instance running. Optionally replace `5115` if you've configured a different port.
50+
Replace `{device_ip}` with the IP of the device that has an HASS.Agent instance running. To find your IP, run `ipconfig` in a command prompt on your PC. Look for the value after `IPv4 Address`. Optionally replace `5115` if you've configured a different port, normally you shouldn't have to.
5051

5152
Restart Home Assistant to load your configuration.
5253

53-
The port needs to be open on the target device. To do so, you can run this command in an elevated prompt:
54+
The port needs to be open on the target device. HASS.Agent will offer to do this for you during the onboarding process.
55+
To do so manually, you can run this command in an elevated prompt:
5456

5557
`netsh advfirewall firewall add rule name="HASS.Agent Notifier" dir=in action=allow protocol=TCP localport=5115`
5658

5759
----
5860

61+
### Installation and Configuration Summary
62+
63+
Quick summary to get things working:
64+
65+
- Install **HASS.Agent-Notifier** integration, either through HACS or manually
66+
- Reboot Home Assistant
67+
- Create a `notify` entity, make sure you enter the right IP for your PC
68+
- Reboot Home Assistant
69+
- Start adding the new entity to your automations & scripts :)
70+
71+
----
72+
5973
### Usage
6074

6175
#### General
@@ -99,6 +113,18 @@ Currently, there are four variables you can set:
99113
image: "http://10.0.0.6:1234/jpeg/image.jpg"
100114
```
101115

116+
#### Script GUI examples
117+
118+
This is the sequence part of a test script to send a text-only message, created through the Home Assistant GUI:
119+
120+
![Script Test Notification](https://raw.githubusercontent.com/LAB02-Research/HASS.Agent/main/Images/notifier_script_example.png)
121+
122+
This is the same script, but with an image added to the notification:
123+
124+
![Script Test Image Notification](https://raw.githubusercontent.com/LAB02-Research/HASS.Agent/main/Images/notifier_script_image_example.png)
125+
126+
You can use the new <a href="https://www.home-assistant.io/lovelace/button/" target="_blank">Button Card</a> to trigger your test scripts.
127+
102128
----
103129

104130
### Wishlist

0 commit comments

Comments
 (0)