Skip to content

Commit

Permalink
update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JuliusH4 committed Oct 12, 2022
1 parent c035c83 commit 3abf1ed
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
# StreamDeck-NetatmoCO2
Unofficial Plugin for an Elgato StreamDeck plugin to display CO2-value form Netatmo weather station.
Unofficial Plugin for an Elgato StreamDeck to display CO2-value form Netatmo weather stations.

>This plugin is currently under development.
Client ID, Client Secret and a refresh token heve to be created manualy (e.g. using [Postman](https://www.postman.com/)). Take a look at the [Netatmo documantaion](https://dev.netatmo.com/apidocumentation/oauth) for further information. This process will be improved in future!
The value will be refreshed every 15 minutes or by pressing the key. (Pay attention, this just updates the value provided by Netatmo, which will not be refreshed every time)

>**This plugin is currently under development**
Client ID, Client Secret and a refresh token have to be created manually (e.g. using [Postman](https://www.postman.com/)). Take a look at the [Netatmo documentation](https://dev.netatmo.com/apidocumentation/oauth) for further information. This process will be improved in future!

## Build
[Distribution Tool](https://developer.elgato.com/documentation/stream-deck/sdk/packaging/) for Windows can be downloaded [here](https://developer.elgato.com/documentation/stream-deck/distributiontool/DistributionToolWindows.zip).
To build the plugin, use the following comand `./DistributionTool.exe -b -i com.juliushenle.netatmo-co2.sdPlugin -o dist`.
The plugin can be build with the official
[Distribution Tool](https://developer.elgato.com/documentation/stream-deck/sdk/packaging/) for Windows, which can be downloaded [here](https://developer.elgato.com/documentation/stream-deck/distributiontool/DistributionToolWindows.zip).
To build the plugin, use the following command: `./DistributionTool.exe -b -i com.juliushenle.netatmo-co2.sdPlugin -o dist`.

## Open Features
- Support of multiple wether stations
- Easy creation of credentials (client_id, client_secret, refresh_token)
- Individual co2 thresholds
- Individual auto-refresh intervall
- Individual auto-refresh interval

0 comments on commit 3abf1ed

Please sign in to comment.