Fix typos, add example usage
This commit is contained in:
parent
5b0b8028ca
commit
513d1d3593
37
README.md
37
README.md
|
@ -1,5 +1,7 @@
|
|||
# Overview
|
||||
|
||||
![aircon.sh in action](https://cube.nethack.net/images/aircon_control.png "aircon.sh in action")
|
||||
|
||||
Script to automate control of an home reverse cycle aircon system based on custom logic and temperature measurements.
|
||||
|
||||
This was originally written for an [AdvantageAir](https://www.advantageair.com.au/) system. It just calls an external script to interface with the aircon, so should be easily adaptable to other systems.
|
||||
|
@ -13,8 +15,8 @@ This was originally written for an [AdvantageAir](https://www.advantageair.com.a
|
|||
- Log temperature measurements to a CSV file or InfluxDB
|
||||
- Control zone temperature by opening/closing its vents
|
||||
- Control zone temperature by opening/closing vents in adjacent zones
|
||||
- Automatically adjust aircon settings based on define temperature thresholds
|
||||
- Turn zones on/off based on ARP table entires for specific MAC addresses
|
||||
- Automatically adjust aircon settings based on defined temperature thresholds
|
||||
- Turn zones on/off based on ARP table entires for specific MAC addresses (for example, if a TV is turned on or a person's phone is detected)
|
||||
- Define temperature rules based on weekday and/or time
|
||||
|
||||
# Usage
|
||||
|
@ -42,7 +44,12 @@ This was originally written for an [AdvantageAir](https://www.advantageair.com.a
|
|||
-y Actually run commands/db inserts. By default, commands are just displayed.
|
||||
|
||||
|
||||
# Examples
|
||||
|
||||
## Sample .rc file
|
||||
|
||||
root@gridbug:~# cat .airconrc
|
||||
|
||||
options -t 0.5
|
||||
|
||||
modelock heat
|
||||
|
@ -75,5 +82,29 @@ This was originally written for an [AdvantageAir](https://www.advantageair.com.a
|
|||
person Beth bethsphone
|
||||
person Brendan brendansphone
|
||||
|
||||
![aircon.sh in action](https://cube.nethack.net/images/aircon_control.png "aircon.sh in action")
|
||||
## Generate ~/.airconrcbased on your a tual aircon zones
|
||||
bash$ aircon.sh -m
|
||||
|
||||
## Log temperature for each zone to csv then exit
|
||||
bash$ aircon.sh -L -o /root/acstats.csv -x /usr/local/bin/pymyair -f /root/.airconrc
|
||||
|
||||
## Preview influxdb inserts for zone temperatures
|
||||
bash$ aircon.sh -I myinfluxdb -y
|
||||
|
||||
## Log temperature for each zone to local influxdb then exit
|
||||
bash$ aircon.sh -I myinfluxdb -y
|
||||
|
||||
## Determine required aircon changes and display them only (dry run)
|
||||
bash$ aircon.sh
|
||||
|
||||
## Make required aircon changes
|
||||
bash$ aircon.sh -y
|
||||
|
||||
## Make required aircon changes and log actions to influxdb
|
||||
bash$ aircon.sh -y -A myinfluxdb
|
||||
|
||||
## Make required aircon changes and only produce output if actions taken (cron mdoe)
|
||||
bash$ aircon.sh -y -c
|
||||
|
||||
|
||||
|
||||
|
|
Loading…
Reference in New Issue