Skip to content

Commit

Permalink
update changelog and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chasenicholl committed Oct 30, 2024
1 parent 5457dce commit bd1ac5a
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file. This projec
## v4.1.1
* Update README.md to correctly display "Tempest" logo.
* Update README.md to include `station_id` in "Local API Config Example".
* Added _optional_ multicast enablement with dgram socket reuseAddr.
* Added _optional_ multicast enablement with dgram socket reuseAddr. Will reuse the address, even if another process has already bound a socket on it, but only one socket can receive the data.
* Added new optional configuration `local_api_shared` to support turning on the above.

## v4.1.0
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Local API is now supported which requires no authentication. If you choose to us
- `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.
- `local_api_shared`: _(Optional)_ enable multicast. Will reuse the address, even if another process has already bound a socket on it, but only one socket can receive the data. Default: False.
- `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"].
Expand Down Expand Up @@ -80,6 +81,7 @@ sensor_type `{2}` | value_key | metric units | std units | additional_properties
"local_api": true,
"station_id": 10000,
"units": "Standard",
"local_api_shared": false,
"sensors": [
{
"name": "Temperature",
Expand Down Expand Up @@ -180,6 +182,7 @@ sensor_type `{2}` | value_key | metric units | std units | additional_properties
"station_id": 10000,
"interval": 10,
"units": "Standard",
"local_api_shared": false,
"sensors": [
{
"name": "Temperature",
Expand Down

0 comments on commit bd1ac5a

Please sign in to comment.