diff --git a/README.md b/README.md index e3462d7..37101c9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ # pyenergenie A python interface to the Energenie line of products + +This is a placeholder repo, for the development of an open source set of Python Libraries +to access the Energenie range of power control and monitoring products. + +The Energenie product line uses the HopeRF radio transciever, and the OpenHEMS protocol +from Sentec. Energenie have built a RaspberryPi add-on board that interfaces to the HopeRF +RFM69, and allows both control and monitoring of their products from a Raspberry Pi. + +This code project aims to develop an open source python module, providing access to many or all +of the features of the OpenHEMS, HopeRF and Energenie product line. + +Plans +==== + +1. Write a minimal ctypes wrapper and build process for the existing bcm2835/HopeRF software distribution +2. Create a proof of concept demo application using the Iotic-Labs IoT infrastructure +3. Enhance the library design to support other features such as new message types, new product types +4. Hopefully provide a platform that could be further innovated on using ScratchGPIO + +Purpose +==== + +I have a whole range of plans for building demo applications using the Energenie product line in the future, +and want to help seed further innovations using this technology in schools and in industry. To do this, I believe +that the code needs to be more flexible, accessible to all, and better structured and documented, +so I plan to develop via a series of progressive releases an open source python wrapper that others can fork and further innovate with. + +David Whale + +@whaleygeek + +July 2015