Appstate's networked energy appliance translator (NEAT).
Appalachian State University as of 2016 is considered by AASHE to have the best sustainable campus out of their selection pool.1 In order to achieve this, Appstate has had to mount renewable energy appliances (along with sensors) across their campus in order to ensure their devices are functioning optimally. Along with this, several machines have been set up to continually pipe the sensory information provided by these devices to a simple file server. Because these devices come from different vendors and from various time periods, it becomes increasingly difficult to store the actually useful sensory information provided by these devices as more and more of them are added to the network.
The goal of the NEAT system, is to take sensory output from the already present renewable energy appliances applying translation, simplification, and optimal storage of the data into a real-time database.
We hope to provide a modular enough architecture to be built upon horizontally in a fashion which is easy for novice and experienced developers to "get their hands dirty" using the system as soon as possible. Removing as much complexity as possible from the developer trying to retrieve useful data, greatly eases the ability for future visualization and analysis.
This project is licensed by the GNU GPLv3 license. This is a strong copyleft license which basically means that permissions are conditioned on making available complete source code of licensed works and modifications (including larger works). This license was chosen with upmost care as we feel that the potential of this project may encourage future use of renewable energy appliances in conjunction with this system. We found our decision on the basis that any form of software built to aid the future of renewable energy adoption should be free and open to the public for consumption.
Documentation for such a project is vital. Unfortunately, since the team performing starting work on this project have only a single cycle of 10 weeks for development (meeting for less than 10 hours a week) there isn't much time to build an exceptional product. Because of this, we have put a heavy focus on documentation (as opposed to our belief in Agile development). Because potentially different teams of students will be taking up the reigns of this project every semester, it is important to convey as much useful information as possible to the current developing team. For our documentation purposes, we have decided to utilize both the GitHub repositories wiki as well as in-code Sphinx documentation.
For an overview of development standards to adhere to, please thoroughly read through our CONTRIBUTING.md.
The following people are listed contributors of this project. Note, that there may be people who aided greatly in the development cycles of this project but have not been listed for various reasons.
- Sierra Milosh <SierraMilosh> ([email protected])
- Stephen Bunn <ritashugisha> ([email protected])
- Nathan Davis <Kanthalon> ([email protected])
- James Ward <thehunte199> ([email protected])