Updated the README.md

fetchIP
E. Almqvist 4 years ago
parent 01073429a1
commit 52567674a7
  1. 16
      README.md

@ -4,13 +4,12 @@ Room-Computer is a simple room controller and is basically a controller for your
### Installation ### Installation
git clone https://github.com/E-Almqvist/roomcomputer.git git clone https://github.com/E-Almqvist/roomcomputer.git
pip install -r requirements.txt pip install -r requirements.txt
This is written in python, so you will literally only have to clone this repository and install the dependencies.
### Configuration ### Setup and Configuration
Create a copy of the file "default-config.py" and name it "config.py" then configure its contents to your needs. Run the `setup.sh` script in order to copy the necessary files to `~/.config/roomcomputer/`. If you are planning to create a service for the `speech_daemon.py` with systemd; then you can specify its configuration file as the first argument: `speech_daemon.py /path/to/config/config.json`.
#### Hue Light Controller #### HUE Lights presets
You can create presets in the "presets.py" file. Follow this syntax *(and Python syntax of course)*: You can create presets in the `~/.config/roomcomputer/presets.json` file. Follow this syntax *(and JSON syntax of course)*:
```python ```python
PRESETS = { PRESETS = {
"mypreset": { "mypreset": {
@ -22,7 +21,7 @@ PRESETS = {
### Usage ### Usage
#### Hue Light Controller #### HUE Remote
--Help page-- --Help page--
'hue' : Display this help page 'hue' : Display this help page
'hue light (index)' ... : Specify light target, from 1-3 'hue light (index)' ... : Specify light target, from 1-3
@ -42,10 +41,11 @@ PRESETS = {
----------------- -----------------
For convenience, you can create an alias for the script file. Append this to your shells rc file: For convenience, you can create an alias for the script file. Append this to your shells rc file:
alias hue="/path/to/the/cloned/repo/hue_remote.py" `alias hue="/path/to/the/cloned/repo/hue_cmd.py"`
<h3 id="features">Features</h3> <h3 id="features">Features</h3>
* Hue Light Controller *(hue_remote.py)* * HUE Light Controller (command-line) `hue_cmd.py)`
* HUE Light Controller (voice daemon) `speech_daemon.py`
And more to come! And more to come!

Loading…
Cancel
Save