Update README
This commit is contained in:
parent
b5dd14efdc
commit
338f8f57f3
53
README.md
53
README.md
|
@ -26,7 +26,7 @@ It can also log to an influxdb database for easy integration into Grafana or sim
|
|||
|
||||
# Usage
|
||||
|
||||
root@gridbug:~# scripts/aircon.sh -h
|
||||
root@gridbug:~# scripts/aircon.sh -h
|
||||
usage: scripts/aircon.sh [options]
|
||||
|
||||
Modifies aircon based on configured parameters in /root/.airconrc.
|
||||
|
@ -34,6 +34,7 @@ It can also log to an influxdb database for easy integration into Grafana or sim
|
|||
-h Show this text.
|
||||
-c Cron mode. Only show output if actions were taken.
|
||||
-i x.x.x.x Specify IP address for aircon (default is 10.99.99.1)
|
||||
-D dbhost Specify influxdb hostname for -I and -A options (default: localhost)
|
||||
-I db Log all zone temperatures to given influxdb database, then exit (see -o).
|
||||
-A db Log actions to given influxdb database.
|
||||
-f file Specify an alternate config file.
|
||||
|
@ -43,12 +44,15 @@ It can also log to an influxdb database for easy integration into Grafana or sim
|
|||
-o file Specify CSV output file. Default: /root/acstats.csv
|
||||
-m Generate a config file based on current aircon setup.
|
||||
-p Profiler mode.
|
||||
-w List which zone owners' devices are available then exit.
|
||||
-s Validate config file then exit.
|
||||
-S[H] Show configured rules in human-readable format
|
||||
(HTML if -H given, otherwise ANSI).
|
||||
-w List which people are available then exit.
|
||||
-W List zone-owning devices are available then exit.
|
||||
-t num Specify degrees below min temperature before taking action.
|
||||
-T num Specify degrees above max temperature before taking action.
|
||||
-y Actually run commands/db inserts. By default, commands are just displayed.
|
||||
|
||||
|
||||
# Examples
|
||||
|
||||
## Sample .airconrc file
|
||||
|
@ -164,12 +168,41 @@ It can also log to an influxdb database for easy integration into Grafana or sim
|
|||
## Make required aircon changes and only produce output if actions taken (cron mdoe)
|
||||
bash$ aircon.sh -y -c
|
||||
|
||||
## Show which owners are detected, then exit
|
||||
bash$ aircon.sh -w
|
||||
Person Availability
|
||||
Rob At home
|
||||
Beth At home
|
||||
Mel Out of the house
|
||||
Brendan At home
|
||||
## Show which zone owners are detected, then exit
|
||||
bash$ aircon.sh -W
|
||||
Devices Availability
|
||||
bethsphone Available
|
||||
brendansphone Available
|
||||
lg-wifi Unavailable
|
||||
robsphone Available
|
||||
|
||||
## Dump current rules, showing which ones are active (use -SH for HTML format)
|
||||
root@gridbug:scripts# ./aircon.sh -S
|
||||
>> Querying aircon... ok
|
||||
- Only operate the aircon in heat mode
|
||||
- Close vent in Media if lg-wifi isn't online
|
||||
- Close vent in Study if robsphone isn't online
|
||||
- Close vent in Rob&Beth if one of (robsphone bethsphone) aren't online
|
||||
- Close vent in Brendan if brendansphone isn't online
|
||||
- Ignore Brendan temperature when deciding what to do
|
||||
- Ignore Nursery temperature when deciding what to do
|
||||
- Force the vent in Nursery to be closed
|
||||
- [out-of-hours] From Mon to Fri between 08:30 and 18:00, Close vent in Ben/Sewing if brendanslaptop isn't online
|
||||
- Prevent Nursery from being the MyZone
|
||||
- Prevent Ben/Sewing from being the MyZone
|
||||
- [out-of-hours] From Mon to Tue between 08:30 and 16:30, Force the vent in Nursery to be closed
|
||||
- [out-of-hours] Between 08:30 and 16:30, Force the vent in Nursery to be closed
|
||||
- [ignored] Keep temperature of Nursery between 25-26 degrees
|
||||
- From Sat to Sun, Ignore Study temperature when deciding what to do
|
||||
- [out-of-hours] From Mon to Fri between 08:30 and 18:00, Close vent in Ben/Sewing if brendansphone isn't online
|
||||
- Between 06:00 and 23:59, Keep temperature of Family between 18-21 degrees
|
||||
- [ignored] Keep temperature of Brendan between 18-20 degrees
|
||||
- [out-of-hours] Between 20:00 and 07:00, Keep temperature of Rumpus between 18-22 degrees
|
||||
- Keep temperature of Media between 18-21 degrees
|
||||
- Keep temperature of Rob&Beth between 18-22 degrees
|
||||
- [out-of-hours] From Mon to Fri between 08:30 and 17:30, Keep temperature of Study between 18-22 degrees
|
||||
- [out-of-hours] Between 19:30 and 06:30, Keep temperature of Nursery between 18-19 degrees
|
||||
- [out-of-hours] Between 20:00 and 07:00, Keep temperature of Ben/Sewing between 18-22 degrees
|
||||
- [out-of-hours] From Mon to Fri between 08:30 and 17:30, Keep temperature of Ben/Sewing between 17-22 degrees
|
||||
|
||||
|
||||
|
|
Loading…
Reference in New Issue