Skip to content

Commit a9fe716

Browse files
committed
Provide details on how to add notifications through Homekit with Ntfy.
1 parent 7b578a8 commit a9fe716

2 files changed

Lines changed: 23 additions & 3 deletions

File tree

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
<p align="center">
2-
32
<img src="https://github.com/homebridge/branding/raw/latest/logos/homebridge-wordmark-logo-vertical.png" width="150">
4-
5-
3+
</p>
64
<p align="center">
75
<a href="https://www.npmjs.com/package/homebridge-tempstick"><img title="npm version" src="https://badgen.net/npm/v/homebridge-tempstick?label=stable"></a>
86
<a href="https://www.npmjs.com/package/homebridge-tempstick"><img title="npm downloads" src="https://badgen.net/npm/dt/homebridge-tempstick"></a>
@@ -24,6 +22,28 @@ plugin, will display live Temp Stick readings as the sensor is only active durin
2422
If you change any settings or names in your Temp Stick account you may have to reload the plugin to see those changes
2523
reflected and receive timely results.
2624

25+
### Notifications with [Ntfy](https://ntfy.sh/)
26+
27+
#### What you need:
28+
1. Free account at [Ntfy](https://ntfy.sh/) (or another Ntfy instance).
29+
2. Ntfy access token found under /account.
30+
3. Unique topic (temperature/humidity alerts are generally not sensitive in nature).
31+
32+
The easiest way to get notifications through Homekit for sensor data is adding an automation. To do so, go to your sensor
33+
in Homekit and click `Add Automation`. For ambient and probe sensors you can add automations for temperature rising above
34+
or dropping below a specific temperature or humidity. Once you confirm the temperature of humidity, click `Next` and
35+
at the bottom `Convert to Shortcut`. Configure your Shortcut to Get the appropriate sensor's Current Temperature or Humidity
36+
and make a `POST`/`PUT` request to Ntfy to [publish a message](https://docs.ntfy.sh/publish/#__tabbed_29_1).
37+
Add a Header with `Key`=`Authorization` and `Text`=
38+
`Bearer [your access token]`. If you want your notification to have a title, add another Header with the `Key`=`X-Title`
39+
and `Text`=`Your notification's title`.
40+
41+
An example configuration that publishes a notification with a Title and message:
42+
43+
<p align="center">
44+
<img src="./images/TempStickNotificationShortcut.JPEG" width="250">
45+
</p>
46+
2747
### Development Roadmap:
2848
- [x] Discover all sensors and probes
2949
- [x] Ambient temperature, ambient humidity, and probe temperature
71.5 KB
Loading

0 commit comments

Comments
 (0)