https://github.com/lrusak/py-eagle-200

python library used to interface with an eagle-200 device
https://github.com/lrusak/py-eagle-200

library powermonitor python python3 simulator tox zigbee

Last synced: about 1 month ago
JSON representation

python library used to interface with an eagle-200 device

• Host: GitHub
• URL: https://github.com/lrusak/py-eagle-200
• Owner: lrusak
• License: gpl-2.0
• Created: 2021-01-01T19:01:03.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-16T20:39:50.000Z (6 months ago)
• Last Synced: 2024-05-17T17:44:20.658Z (6 months ago)
• Topics: library, powermonitor, python, python3, simulator, tox, zigbee
• Language: Python
• Homepage:
• Size: 161 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# py-eagle-200

This python library is used to wrap calls to a [Rainforest Automation EAGLE-200 device](https://rainforestautomation.com/rfa-z114-eagle-200-2/).

The library was designed around the API documentation available [here](https://rainforestautomation.com/wp-content/uploads/2017/02/EAGLE-200-Local-API-Manual-v1.0.pdf).

The API uses an awkward xml format with POST request. This library does it's best to wrap this and provide a more python friendly JSON output.

I'm using this library with some other open source tools (grafana, mosquitto, influxdb, telefraf) to build a power monitor dashboard.

![grafana-dashboard](grafana-power.JPG)

## Simulator

A simulator is also provided as I didn't have the device at the time I started this library. I needed a way to test the library to make sure the API calls were correct. Any changes should be validated via tests which may require changes to the simulator as well.

The simulator uses [flask](https://flask.palletsprojects.com/en/1.1.x/) to handle POST requests. The simulator hands out xml data from the examples in the developer API manual.

See [simulator](tests/simulator/eagle200sim.py)

## Usage

See [tests](tests/test_eagle200.py)

See [eagle-200-mqtt](https://github.com/lrusak/eagle-200-mqtt)

## Future

 Make the output more _pythonic_. The output should look similar to what is output by the device but wrapped in a python friendly JSON interface. Currently the output uses an inconsitent and mixed dict/list object.