Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chasenicholl/homebridge-weatherflow-tempest
WeatherFlow Tempest Homebridge Plugin
https://github.com/chasenicholl/homebridge-weatherflow-tempest
homebridge homebridge-plugin homekit tempest tempest-plugins weatherflow
Last synced: about 1 month ago
JSON representation
WeatherFlow Tempest Homebridge Plugin
- Host: GitHub
- URL: https://github.com/chasenicholl/homebridge-weatherflow-tempest
- Owner: chasenicholl
- License: apache-2.0
- Created: 2022-11-01T02:24:57.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-10T16:15:05.000Z (10 months ago)
- Last Synced: 2024-09-26T20:46:52.701Z (about 2 months ago)
- Topics: homebridge, homebridge-plugin, homekit, tempest, tempest-plugins, weatherflow
- Language: TypeScript
- Homepage:
- Size: 998 KB
- Stars: 15
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Homebridge WeatherFlow Tempest Plugin
[](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)   [](https://paypal.me/chasenicholl)
*New* in v4.0.0 Local API Support!
Homebridge Plugin providing basic WeatherFlow Tempest support. Exposing 7 Acessories.
- Temperature Sensor
- Humidity Sensor
- Light Sensor
- Motion Sensor (triggered by user configured value)
- Occupancy Sensor (triggered by user configured value)
- Fan (expressed as Rotation Speed - Wind Speed 0-100mph)
- Battery Sensor (added to `air_temperature` Temperature sensor)
---
NOTE:
It is recommended when upgrading to v3.0 of the plugin from a prior version that you save your configuration information including `token` and `station_id`, uninstall the prior version of the plugin, restart Homebridge to clear the accessory cache, install v3.0 of the plugin, enter your Settings, and finally restart Homebridge to initialize the plugin.
---
### Setup and Parameters
Local API is now supported which requires no authentication. If you choose to use the non-local HTTP API you will need to create an account at https://tempestwx.com/ and then generate a Personal Use Token https://tempestwx.com/settings/tokens.
- `name`: _(Required)_ Must always be set to `WeatherFlow Tempest Platform`.
- `local_api`: _(Required)_ Use the Local API versus HTTP API.
- `token`: _(Required for HTTP API)_ Oauth2 Personal Use Token, create via your tempestwx account.
- `station_id`: _(Required for HTTP API)_ The station ID you are pulling weather data from.
- `interval`: _(Required for HTTP API)_ How often to poll the Tempest REST API. Default 10 seconds. Minimum every second.
- `sensors`: _(Required)_ An array of sensors to create. This is dynamic incase you want to target different temperature or wind speed attributes.
- `sensors[].name`: _(Required)_ Display name of Sensor in Apple Home.
- `sensors[].sensor_type`: _(Required)_ The type of Home Sensor to create. There are 6 options ["Temperature Sensor", "Light Sensor", "Humidity Sensor", "Fan", "Motion Sensor", "Occupancy Sensor"].
- `sensors[].{1}_properties.value_key`: _(Required)_ Which REST API response body key to target for its value. You can find the available value_keys in the table below.
- `sensors[].motion_properties.trigger_value`: _(Required with Motion Sensor)_ At what point (value) to trigger motion detected on/off. Minimum 1.
- `sensors[].occupancy_properties.trigger_value`: _(Required with Occupancy Sensor)_ At what point (value) to trigger occupancy detected on/off. Minimum 0.
`{1}` Replace with Sensor: temperature, humidity, light, fan
sensor_type `{2}` | value_key | metric units | std units | additional_properties | Typ metric trigger | Typ std trigger | Notes
:-- | :--- | :--: | :--: | :--- | :--: | :--: | :---
`Temperature Sensor` | air_temperature | C | F | NA | NA | NA | set by UI preferences
` ` | feels_like | C | F | NA | NA | NA | set by UI preferences
` ` | wind_chill | C | F | NA | NA | NA | set by UI preferences
` ` | dew_point | C | F | NA | NA | NA | set by UI preferences
`Humidity Sensor` | relative_humidity | % | % | NA | NA | NA |
`Light Sensor` | brightness | lux | lux | NA | NA | NA |
`Fan` | wind_avg | m/s | mi/hr | NA | NA | NA | wind_avg speed reported as Fan %
`Motion Sensor` | wind_gust | m/s | mi/hr | motion_trigger_value | 5 | 10 |
`Occupancy Sensor {3}{4}` | barometric_pressure | mb | inHg | occupancy_trigger_value | 1000 | 30 |
` ` | precip | mm/min | in/hr | occupancy_trigger_value | 0.1 | 0.25 |
` ` | precip_accum_local_day | mm | in | occupancy_trigger_value | 25 | 1 | **Not available with Local API**
` ` | solar_radiation | W/m^2 | W/m^2 | occupancy_trigger_value | 1000| 1000 |
` ` | uv | Index | Index | occupancy_trigger_value | 3 | 3 |
` ` | wind_direction | degrees | degrees | occupancy_trigger_value | 360 | 360 |
`{2}` Reference: https://weatherflow.github.io/Tempest/api/swagger/#!/observations/getStationObservation
`{3}` Reference Wiki for details on how to view Occupancy Sensor values with iOS 16.x and MacOS Ventura 13.x.
`{4}` NOTE: There is a current limitation with v3.0.0 of the plug-in in that HomeKit accessory names are set when the accessory is initially added and cannot be dynamically updated. The accessories are correctly displayed and updated in the Homebridge "Accessories" tab of the webpage interface. Occupancy sensors `trigger_value` status is correctly displayed in both HomeKit and Homebridge.
### Local API Config Example
```json
{
"name": "WeatherFlow Tempest Platform",
"local_api": true,
"units": "Standard",
"sensors": [
{
"name": "Temperature",
"sensor_type": "Temperature Sensor",
"temperature_properties": {
"value_key": "air_temperature"
}
},
{
"name": "Relative Humidity",
"sensor_type": "Humidity Sensor",
"humidity_properties": {
"value_key": "relative_humidity"
}
},
{
"name": "Light Level",
"sensor_type": "Light Sensor",
"light_properties": {
"value_key": "brightness"
}
},
{
"name": "Wind Speed",
"sensor_type": "Fan",
"fan_properties": {
"value_key": "wind_avg"
}
},
{
"name": "Wind Gust",
"sensor_type": "Motion Sensor",
"motion_properties": {
"value_key": "wind_gust",
"trigger_value": 10
}
},
{
"name": "Barometer",
"sensor_type": "Occupancy Sensor",
"occupancy_properties": {
"value_key": "barometric_pressure",
"trigger_value": 30
}
},
{
"name": "Solar Radiation",
"sensor_type": "Occupancy Sensor",
"occupancy_properties": {
"value_key": "solar_radiation",
"trigger_value": 1000
}
},
{
"name": "UV",
"sensor_type": "Occupancy Sensor",
"occupancy_properties": {
"value_key": "uv",
"trigger_value": 3
}
},
{
"name": "Precipitation Rate",
"sensor_type": "Occupancy Sensor",
"occupancy_properties": {
"value_key": "precip",
"trigger_value": 0.25
}
},
{
"name": "Precipitation Today",
"sensor_type": "Occupancy Sensor",
"occupancy_properties": {
"value_key": "precip_accum_local_day",
"trigger_value": 1
}
},
{
"name": "Wind Direction",
"sensor_type": "Occupancy Sensor",
"occupancy_properties": {
"value_key": "wind_direction",
"trigger_value": 360
}
}
],
"platform": "WeatherFlowTempest"
}
```
### HTTP API Config Example
```json
{
"name": "WeatherFlow Tempest Platform",
"local_api": false,
"token": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"station_id": 10000,
"interval": 10,
"units": "Standard",
"sensors": [
{
"name": "Temperature",
"sensor_type": "Temperature Sensor",
"temperature_properties": {
"value_key": "air_temperature"
}
},
{
"name": "Feels Like",
"sensor_type": "Temperature Sensor",
"temperature_properties": {
"value_key": "feels_like"
}
},
{
"name": "Dew Point",
"sensor_type": "Temperature Sensor",
"temperature_properties": {
"value_key": "dew_point"
}
},
{
"name": "Relative Humidity",
"sensor_type": "Humidity Sensor",
"humidity_properties": {
"value_key": "relative_humidity"
}
},
{
"name": "Light Level",
"sensor_type": "Light Sensor",
"light_properties": {
"value_key": "brightness"
}
},
{
"name": "Wind Speed",
"sensor_type": "Fan",
"fan_properties": {
"value_key": "wind_avg"
}
},
{
"name": "Wind Gust",
"sensor_type": "Motion Sensor",
"motion_properties": {
"value_key": "wind_gust",
"trigger_value": 10
}
},
{
"name": "Barometer",
"sensor_type": "Occupancy Sensor",
"occupancy_properties": {
"value_key": "barometric_pressure",
"trigger_value": 30
}
},
{
"name": "Solar Radiation",
"sensor_type": "Occupancy Sensor",
"occupancy_properties": {
"value_key": "solar_radiation",
"trigger_value": 1000
}
},
{
"name": "UV",
"sensor_type": "Occupancy Sensor",
"occupancy_properties": {
"value_key": "uv",
"trigger_value": 3
}
},
{
"name": "Precipitation Rate",
"sensor_type": "Occupancy Sensor",
"occupancy_properties": {
"value_key": "precip",
"trigger_value": 0.25
}
},
{
"name": "Precipitation Today",
"sensor_type": "Occupancy Sensor",
"occupancy_properties": {
"value_key": "precip_accum_local_day",
"trigger_value": 1
}
},
{
"name": "Wind Direction",
"sensor_type": "Occupancy Sensor",
"occupancy_properties": {
"value_key": "wind_direction",
"trigger_value": 360
}
}
],
"platform": "WeatherFlowTempest"
}
```