Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tieske/netatmo.lua

Fetch and push Netatmo data over REST
https://github.com/tieske/netatmo.lua

Last synced: about 1 month ago
JSON representation

Fetch and push Netatmo data over REST

Awesome Lists containing this project

README

        

# netatmo.lua
Lua interface to the [Netatmo API](https://dev.netatmo.com/).
Please checkout [the documentation](https://tieske.github.io/netatmo.lua/index.html) for
instructions.

## Status

Early development, session management works.

## Usage

The NetAtmo api requires an OAuth2 flow to acquire access and refresh token.
There is an example showing how to use the Copas scheduler to set up a webserver.
Or you can use the included docker image to manually get a refresh token.

docker build --tag=netatmo-auth .
docker run --rm -it -e "CLIENT_ID=xxx" -e "CLIENT_SECRET=xxx" netatmo-auth

## License & Copyright

See [LICENSE](https://github.com/Tieske/netatmo.lua/blob/master/LICENSE)

### TODO:

- add more methods
- maybe: add a higher level Lua interface with object based access
- maybe: timer based automatic updates with event/callbacks on changes

## History

### Release instructions:

* update changelog below
* make sure to update the version number in `netatmo/init.lua` twice;
* Doc comments at module level
* the `_VERSION` constant
* add a rockspec for the new version
* render the docs using `ldoc .`
* commit, tag, and push

### 0.2.0, released 12-Oct-2022

* breaking: rewite of auth mechanism since password access is no longer supported

### Version 0.1.0, released 22-Oct-2022

* initial release