diy-smarthome / dashboard

Dashboard for DIY-Smarthome

Originally started as an exam in university, now evolved into a fun project for selfmade Smarthome modules in a highly dynamic context. This Dashboard is a optional module with aims to give this Project a web-based UI.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

The proof of concept was achieved with the protoype that was submitted as an university exam. Currently this Dashboard can connect to the kernel and get some data from the meross-module. This function is programmed statically, a dynamic implementation and controlling of modlues and devices is not programmed. Further developments should add a dynamic structur for adding and removing modules/devices and controlling them. As in this PoC-State, this software may have several bugs and problems.

(back to top)

Built With

• JavaScript
• 

(back to top)

Getting Started

Currently, there is no dedicated installer for any module of the DIY-Smarthome ecosystem. You can clone this repository and try the example code (not working atm!) or clone the Dev-Environment and use the module with others.

Prerequisites

You will need NodeJs and npm to use this module.

Installation

1. Clone the Dev-Environment from https://github.com/DIY-Smarthome/Dev-Environment

   git clone https://github.com/DIY-Smarthome/Dev-Environment.git

2. Enter the lib folder
3. Clone the module

   git clone https://github.com/DIY-Smarthome/Dashboard.git

4. Install NPM packages

   npm install

5. Build Dev-Environment and all modules

   npm run build

(back to top)

Usage

We will follow-up with examples for this module.

(back to top)

Roadmap

• Repair Code
• Add functions to add/remove modules
• Add functions to add/remove devices
  • Add functions to control modules
• Improve current implemetation for our energy-module

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPL v3.0 License. See LICENSE.txt for more information.

(back to top)

Contact

• Quisel on Twitter: @Quisel_
• Quisel via Email: [email protected]
• Contact the community on the Discord

Project Link: https://github.com/DIY-Smarthome/Dashboard

(back to top)