Provided by: aurora_1.7.3-0ubuntu1_amd64 bug

NAME

       aurora - communicate with an Magnetek Aurora Photovoltaic (solar) Power Inverter

SYNOPSIS

       aurora [Options] -a InverterAddress Device

REQUIRED PARAMETERS

       -a, --address=num
              Inverter address. 1-31 on older inverters, 1-63 on newer inverters.

       Device Serial Device.  Example, /dev/ttyUSB0 or /dev/ttyS0.

OPTIONS

       -A, --last-alarms
              Get last four alarms (once displayed FIFO queue is cleared)

       -b, --verbose
              Verbose mode. For maximum effectiveness should be the first option on the command line

       -C, --calc-value=<num[:$]>
              Calculate  monetary  value  using  <num>  * kWh. ":$" is optional and if included the character(s)
              represented by the "$" will be used to denote monetary type in the output. Defaults to "$"

       -c, --columnize
              Output data in columns --> for -d, -e, -D, -E, -t options only, will disable all other options  --
              if value ends with an "*" reporting of that item may not be in inverters firmware

       -d <num>, --get-dsp=<num>
              Get DSP data. <num> indicates string to get data for. 0 indicates both, 1 for only string 1, 2 for
              only  string  2.  <num>  is required for short option and <num> is optional for long option and if
              omitted for long option then data for both input strings will be retrieved.

       -D, --get-dsp-extended
              Get more DSP data

       -e, --get-energy
              Get Cumulated Energy readings

       -E, --get-dsp-3phase
              Get 3-Phase DSP data

       -f, --firmware-ver
              Query for Firmware Version string

       -g, --mfg-date
              Query for Inverter Manufacturing Date

       -h, --help
              This text

       -i, --get-count
              Display Inverter Time Counters

       -j, --get-joules
              Display Energy accumulated in the last 10 seconds

       -k, --daily-kwh=<num> ** Experimental **
              Get past daily KWH for <num> days (1-366) <num> is optional for long option and if omitted all 366
              days or as many that are found will be displayed. It is suggested that the -Y option be used  with
              this due to the extensive length of time it takes to get all the data from the inverter

       -L, --adjust-time=<num>
              Automatically  adjust the inverter time if it differs from the computer time. If <num> is 0 (zero)
              do a Daylight Savings Time check. If <num> is >= 1 change the inverter time if it differs by <num>
              or more seconds. See the README for more information and the constraints this option uses  to  the
              determine if the time should be changed due to Daylight Savings Time

       -l, --delay=<num>
              Serial port timeout in for read. <num> in 1/10ths seconds. Default is 1 (0.1 sec)

       -m, --get-conf
              Query for Inverter System Configuration

       -n, --serial-number
              Query for Inverter Serial Number

       -o, --output-file=<filename>
              Append data to file (Created if nonexistant)

       -p, --part-number
              Query for Inverter Part Number

       -P, --comm-pause=<num>
              Wait <num> uS between sending commands to inverter (1-1000000)

       -q <num>, --energy-sent=<num> ** Experimental **
              Get  past  energy delivered to the grid in 10 second intervals for <num> minutes (1-1440) starting
              with the oldest data available. <num> is optional for long option and if  omitted  all  data,  ~24
              hours  worth  will  be  reported.  It is suggested that the -Y option be used with this due to the
              extensive length of time it takes to get all the data from the inverter. See the README  file  for
              important information on this option

       -R, --read-timeout=<num>
              Timeout value when reading data from the Inverter (mS)

       -r, --calc-grid-power
              Calc  Grid power using Grid Voltage * Grid Current, instead of reporting the Inverter's value. -->
              for -d option only, ignored when used with -c option.  (Inverter typically reports a lower  value.
              This affects Inverter conversion efficiency value.)

       -S, --set-time
              Set Inverter Date/Time to system time

       -s, --get-state
              Get Inverter State

       -T, --get-loctime
              Display computer Date/Time

       -t, --get-invtime
              Display Inverter Date/Time

       -U, --read-pause=<num>
              Pause  <num> milli-seconds after sending command to inverter before reading response from inverter
              (1-10000)

       -u, --rpt-read-pause
              Report when/that pausing before read

       -V, --version
              Aurora communications program version

       -v, --inv-version
              Query for Version string

       -w, --lock-wait
              Seconds to wait to lock serial port. (1-30)

       -X, --rts-cts
              Enable RTS/CTS on the serial port.

       -x, --xon-xoff
              Enable XON/XOFF on the serial port.

       -Y, --retries=<num>
              Retry failed communications with inverter up to <num> times (1-100)

       -y, --rpt-retries
              Report the number of retires done

DESCRIPTION

       aurora is a program that communicates with Aurora Magnetek Photovoltaic (solar) Power  Inverters  written
       by Curt Blank.  It can retrieve data and statistics from a variety of Aurora Inverters through either USB
       or Serial interfaces.

EXAMPLES

       aurora -T -c -e -d -a 2 -w 15 /dev/ttyS0

       aurora -Y 100 -T -a 2 -w 10 -e /dev/ttyUSB0

SEE ALSO

       http://www.curtronics.com/Solar/AuroraData.html

AUTHOR

       This  manpage  was  written  by  Dustin  Kirkland  <kirkland@canonical.com>  and  updated  by  Curt Blank
       <solar@curtronics.com> for Ubuntu systems (but may be used by others).  Permission is  granted  to  copy,
       distribute  and/or  modify  this  document  under  the terms of the GNU General Public License, Version 2
       published by the Free Software Foundation.

       On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-
       licenses/GPL.

aurora                                             13 Mar 2010                                         aurora(1)