First rough sketch of the overall readme

This commit is contained in:
GHOSCHT 2022-02-06 16:27:58 +01:00
parent 6643a2952f
commit 358b17ae2c
No known key found for this signature in database
GPG key ID: A35BD466B8871994

View file

@ -8,13 +8,30 @@
<img src="https://img.shields.io/badge/Figma-F24E1E?style=flat&logo=figma&logoColor=white" />
</a>
Uses: https://github.com/GHOSCHT/simple-electron-react-boilerplate
It just takes two standing lights which are too far away to reach, to make turning on and off desk lights a chore. Heliox aims to make desk lighting as easy as possible.
Dashboard: node-gyp fails on sqlite3 build -> set default pyhton version to python 2
```
node-gyp --python /path/to/python2.7/python.exe
```
or
```
npm config set python /path/to/executable/python2.7
```
## About Heliox
Heliox consists of a combination of multiple modules that attacht to or fully replace parts of your lighing setup. The modularity allows you to mix and match in order to suit each person's special needs. CAD files and custom PCB files are included with the intent to make the footprint as slim as possible.
## Modules
### [Switching Module](/Devices/Module/Hardware)
The switching module is the heart of this project. It sits right in the body of each lamp and contains the necessary transistors to control and even dim the light bulbs.
### [Controller](/Devices/Control)
The controller is the centerpiece of communication. It sits between the switching module, console and dashboard. USB C ports allow for easy connection.
### [Console](/Devices/Console) (Optional)
The console is a slim device with rotary encoders and a status led that connects to the control board via USB C.
### [Dashboard](/Dashboard) (Optional)
The dashboard is the software counterpart of the console which allows users to control the lights right from the PC.
## License
Distributed under the MIT License. See `LICENSE` for more information.