diff --git a/README.md b/README.md index 19a289f..b312835 100755 --- a/README.md +++ b/README.md @@ -26,32 +26,34 @@ It can also log to an influxdb database for easy integration into Grafana or sim # Usage - root@gridbug:~# scripts/aircon.sh -h - usage: scripts/aircon.sh [options] +```text +root@gridbug:~# scripts/aircon.sh -h +usage: scripts/aircon.sh [options] - Modifies aircon based on configured parameters in /root/.airconrc. + Modifies aircon based on configured parameters in /root/.airconrc. - -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. - -k file If file exists, never change aircon settings (default: /root/.aircon_noaction). - -l num Set number of too hot/cold zones at which to taking action. - -L Log all zone temperatures to CSV file, then exit (see -o). - -o file Specify CSV output file. Default: /root/acstats.csv - -m Generate a config file based on current aircon setup. - -p Profiler mode. - -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. + -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. + -k file If file exists, never change aircon settings (default: /root/.aircon_noaction). + -l num Set number of too hot/cold zones at which to taking action. + -L Log all zone temperatures to CSV file, then exit (see -o). + -o file Specify CSV output file. Default: /root/acstats.csv + -m Generate a config file based on current aircon setup. + -p Profiler mode. + -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