Ledda/climate-server
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
Daniel Ledda
2023-07-30 17:57:03 +02:00
parent 65f8d8567e
commit 2008e054db
3 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -7,16 +7,19 @@ Linux packages (apt)
Python3 packages (pip3) Python3 packages (pip3)
> adafruit-circuitpython-dht mh-z19 > adafruit-circuitpython-dht mh-z19
The setup script installs these for you. The setup script installs the python packages for you, you will have to install the apt packages yourself.
## Setup ## Setup
1. Pull the repository. 1. Clone the repository.
1. Fill out your specific config options in `./server/.env` 1. Fill out your specific config options in `./server/.env`
1. Ensure `./server/scripts/climate-pinger.py` has the correct pin for your adafruit-dht22 device and/or edit the script for your specific setup. 1. Ensure `./server/scripts/climate-pinger.py` has the correct pin for your adafruit-dht22 device and/or edit the script for your specific setup.
1. Run `./setup.sh` as administrator 1. Run `sudo apt-get install python3 libgpiod2 npm mariadb-server`
1. Run `sh ./setup.sh` as user for the server
1. Make sure the server user has access to MySQL/MariaDB, and is in the groups `gpio` and `dialout`.
1. Start the server: 1. Start the server:
> npm start > npm start
1. Have fun!
## Usage ## Usage

6
server/.env
View File

@@ -1,7 +1,7 @@
PORT=4040 PORT=4000
SERVER_ROOT=/climate SERVER_ROOT=/climate
MYSQL_ADDRESS=localhost MYSQL_ADDRESS=localhost
MYSQL_USERNAME=admin MYSQL_USERNAME=claypi
MYSQL_PW= MYSQL_PW=climate
SENSOR_PING_INTERVAL=30 SENSOR_PING_INTERVAL=30
DEV=false DEV=false

1
setup.sh
View File

@@ -1,6 +1,5 @@
#!/bin/sh #!/bin/sh
apt-get install python3 libgpiod2 npm mariadb-server
pip3 install adafruit-circuitpython-dht mh-z19 pip3 install adafruit-circuitpython-dht mh-z19
npm install npm install
(cd ./server && npm install) & (cd ./dashboard && npm install && npm run build) (cd ./server && npm install) & (cd ./dashboard && npm install && npm run build)