# homebridge-tempstick

> Unofficial Ideal Sciences TempStick homebridge plugin.

Latest version **1.0.6** (published 2024-09-01) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install homebridge-tempstick
pnpm add homebridge-tempstick
yarn add homebridge-tempstick
bun add homebridge-tempstick
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2024-09-01 |
| First published | 2024-07-20 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | gandt |
| Keywords | homebridge-plugin, temp stick, tempstick, ideal sciences |

## Links

- npm: https://www.npmjs.com/package/homebridge-tempstick
- Repository: https://github.com/gorhack/tempstick
- Issues: https://github.com/gorhack/tempstick/issues
- npm.io page: https://npm.io/package/homebridge-tempstick

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.6 (latest) — 2024-09-01
- 1.0.5 — 2024-08-05
- 1.0.4 — 2024-07-24
- 1.0.3 — 2024-07-21
- 1.0.2 — 2024-07-20
- 1.0.1 — 2024-07-20
- 1.0.0 — 2024-07-20

## README

<p align="center">
<img src="https://github.com/homebridge/branding/raw/latest/logos/homebridge-wordmark-logo-vertical.png" width="150">
</p>
<p align="center">
<a href="https://www.npmjs.com/package/homebridge-tempstick"><img title="npm version" src="https://badgen.net/npm/v/homebridge-tempstick?label=stable"></a>
<a href="https://www.npmjs.com/package/homebridge-tempstick"><img title="npm downloads" src="https://badgen.net/npm/dt/homebridge-tempstick"></a>
<a href="https://github.com/gorhack/tempstick/actions/workflows/build.yml"><img title="Node Build" src="https://github.com/gorhack/tempstick/actions/workflows/build.yml/badge.svg"></a>
</p>

# Ideal Sciences Temp Stick Homebridge Plugin

### This is an unofficial plugin to use your [Temp Stick](https://tempstick.com/) sensor with [Homebridge](https://homebridge.io/).

You will need your API key, provided in your [account](https://mytempstick.com/account#developers) settings. This plugin relies on the API provided by Temp
Stick and is dependent on its uptime to retrieve your latest sensors and readings. 

Once loaded, this plugin will display all Temp Stick sensors' ambient temperature and humidity. If you are using a
thermocouple probe, it will also display the probe's temperature. This plugin updates the sensor data at roughly the
same interval set within your account's `Sensor Settings` (once every 15 minutes to 24 hours). Temp Stick, nor this
plugin, will display live Temp Stick readings as the sensor is only active during its `next_checkin`.

If you change any settings or names in your Temp Stick account you may have to reload the plugin to see those changes
reflected and receive timely results.

### Notifications with [Ntfy](https://ntfy.sh/)

#### What you need:
1. Free account at [Ntfy](https://ntfy.sh/) (or another Ntfy instance).
2. Ntfy access token found under /account.
3. Unique topic (temperature/humidity alerts are generally not sensitive in nature).

The easiest way to get notifications through Homekit for sensor data is adding an automation. To do so, go to your sensor
in Homekit and click `Add Automation`. For ambient and probe sensors you can add automations for temperature rising above
or dropping below a specific temperature or humidity. Once you confirm the temperature of humidity, click `Next` and
at the bottom `Convert to Shortcut`. Configure your Shortcut to Get the appropriate sensor's Current Temperature or Humidity
and make a `POST`/`PUT` request to Ntfy to [publish a message](https://docs.ntfy.sh/publish/#__tabbed_29_1).
Add a Header with `Key`=`Authorization` and `Text`=
`Bearer [your access token]`. If you want your notification to have a title, add another Header with the `Key`=`X-Title`
and `Text`=`Your notification's title`.

An example configuration that publishes a notification with a Title and message:

<p align="center">
<img src="./images/TempStickNotificationShortcut.JPEG" width="250">
</p>

### Development Roadmap:
- [x] Discover all sensors and probes
- [x] Ambient temperature, ambient humidity, and probe temperature
- [x] Handle API errors gracefully
- [x] Use offsets (`probe_temp_offset`, `humidity_offset`, `temp_offset`) for calibrated sensors
  - `last_tcTemp`, `last_humidity`, and `last_temp` include any user-set offset
- [x] Request latest readings based on `send_interval` and `next_checkin`
- [ ] Homebridge [verified](https://github.com/homebridge/verified)
- [x] Request updated documentation in [API](https://tempstickapi.com/docs/) for undocumented parameters
(`last_tcTemp` and `groups` for example)
  - Response: "...you don't need to worry about these values as they don't have a direct impact
    on the data readings"
- [ ] User config `groups` of sensors instead of retrieving all sensors

---
_Source: https://npm.io/package/homebridge-tempstick · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
