Commands as currently implemented for 2B OZONE CPU

file: twob_ozone.html
20 Jun 2003

2B OZONECPU Main CPU Commands Version 2.60

- ALL COMMANDS ARE TERMINATED IN CARRIAGE RETURN <cr> - don't forget! It's assumed for all commands below

- mode of operation:

OZONE Main Controller always comes up running and logging in fixed configuration - see 'default' config below
Modified address mode only - PRECEDE ALL COMMANDS WITH # (full address not used)

Instrument Module port assignments (Port 1 thru Port 11 correspond to LOGRIF PC Board P1 thru P11; Ports 12 thru 15 correspond to P20 - P23)

Port 1 - not used
Port 2 - WNDRAIN module
Port 3 - INLET
Port 4 - OUTLET
Port 5 - not used
Port 6 - not used
Port 7 - not used
Port 8 - not used
Port 9 - not used
Port 10 - not used
Port 11 - XMET (met data from external source)
Port 12 - not used
Port 13 - OZONE Main Power control (Relay Power only)
Port 14 - ZERO Check Solenoid Valve Power control
Port 15 - 2B Ozone data input only

Standard commands (precede with # only, i.e. #STAT to get status):

NOTE: The FULL command set is ONLY available when the OZONECPU is NOT running (see STOP command).

A to echo "address\r\n" - artifact of IMET, simple confirmation of 'life'
- NOTE: address is NOT USED currently, but may be set/modified by UOK command below.
CLOCK to see current date/time setting. Responds with "yyyy/mm/dd hh:mm:ss\r\n"
CLOCK=yyyy/mm/dd hh:mm:ss to set date/time; Sampling MUST be STOPPED to set the clock.

D In MetMode = 1 or 2, responds with a single line of data from most recent sample interval;
line is terminated with \r\n

Firmware Ver 2.60 displays:

Ozone Level, Cell Temperature, Cell Pressure, Wind Speed, Rain Detect Flag, elapsed Sample Time, OZONE Running Flag, System Status Byte HEX, MainCPU Status Byte HEX, OZONE Status Byte HEX

Elapsed Sample Time is in minutes;

OZONE Run Flag: 1 = RUNNING; 0 = STOPPED

Status Byte bits (1 = OK or ON) defined as follows:

/* STATUS byte masks - see struct.dec */
/* system_status masks */
#define sample_OK       0x01
#define WIND_OK         0x02
#define RAIN_OK         0x04  /* true = NO rain */
#define ZERO_checking   0x08
#define OZONE_analyzing 0x10
#define XMET_OK		0x20
#define INLET_open      0x40
#define OUTLET_open     0x80
   
/* maincpu_status masks */
#define ZERO_pwr        0x01 
#define WDR_pwr         0x02
#define INLET_pwr       0x04
#define OUTLET_pwr      0x08
#define OZONE_pwr       0x10

/* OZONE_status masks */
#define CELL_temp        0x01
#define CELL_pres        0x02

Typical scan: 67 35.3 980.6 3.21 0 12 1 D7 1E 03

E In MetMode = 1 or 2, responds with data from most recent sample interval on individual lines;
each line is terminated with \r\n
Firmware Ver 2.60 displays Average Wind Speed in m/s and Rain Detect flag value (0 = NO Rain):
```
    WNDAVG: 2.31
    RDET: 0
    
```
FB read 512 byte blocks of memory (HEX-ASCII)
On entry, the prompt "Start block # -> " is displayed; the first block (and default block) is 1; each successive block is 512 bytes farther into the card (note that the first 'record' is written at block 257 - the first 131072 bytes are reserved); enter a value, terminated by \r, to get first block. Enter X to exit, any other key for the next block;
- sampling MUST be STOPPED)
- Blocks are displayed in HEX-ASCII, 32 bytes (64 characters) per line by 16 lines, each terminated "\r\n". A blank line is inserted between successive blocks.
- On completion, i.e., you sent an X to exit, an extra "\r\n" is sent.
FR read records
On entry, the prompt "Start record # -> " is displayed; the first record (and default record) is 1; each successive record is "sizeof LOGR_record" bytes farther into the card (note that the first 'record' is written at block 257 - the first 131072 bytes are reserved); enter a value, terminated by \r, to get first record. Enter X to exit, any other key for the next record;
- sampling MUST be STOPPED)
- Records are currently displayed in "verbose" format, with date & time of record first, as follows:
```
2003/06/20 17:04
WND:   0.20
RDET:  0
2B:  13.7  35.1  1003.7
STAT: 15 01 D7 1E 03
```
- STAT line is same format as D command, less leading wind speed and rain values.
- See also Record Format.
- On completion, i.e., you sent an X to exit, an extra "\r\n" is sent.

FS report current card status (size, used, unused). Each line is terminated in "\r\n".

  Example:

    PCMCIA CARD present - CARD OK!
    FLASH card capacity: 20839680
    Records used: 114; available: 21326

GO to start sampling (power up default - only used to restart after STOP for testing, new configuration, etc.) Responds with "Sampling GO\r\n". Sampling MUST be STOPPED.

HELP displays a brief list of all the commands. Each line is terminated in "\r\n". A truncated HELP output is displayed when OZONECPU is running (GO mode); i.e., only those commands available while running are displayed. To access the full command set, the OZONECPU sampling MUST be STOPPED.

   Example of output in STOPPED mode:

   Firmware TWOBCPU V2.60
   A - Address acknowledge
   CLOCK(=YYYY/MM/DD HH:MM:SS) - Read/Set RT clock date/time
   D - Send latest standard data
   E - Send latest extended data
   F - FLASH card commands:
       FB - Read any block, hex
       FC - Current record configuration
       FR - Read data record, formatted
       FS - Status info
   GO - Re-start sampling
   H - Display Help message
   O - Send latest OZONE data
   R - Send recent records in HEX
   SETUP - Show EEPROM Configuration Settings
   STAT - System status info
   STOP - Stop sampling
   T - Test mode commands:
       TM - MET Module tests
   UOK - Update EEPROM Configuration Constants
   XMODE - XMODEM Dump PCMCIA card via RS232 console

O to display latest 2B data stream
- data is updated once per minute while OZONE is analyzing (2B running)
R to HEX dump the most recent 512 records of data written to FLASH
- The OZONECPU board uses 16K of spare RAM as a circular buffer to keep the most recent 1 minute records written to FLASH. If set for an R-interval of 1, that allows the most recent 8.5 hours to be dumped to the console as HEX-ASCII. At 9600 baud, this takes about 40 seconds.
- One 32 byte record is dumped per line; this means 64 HEX characters per line.
- This data may be dumped without STOPping the logger.
- Data is in volatile RAM; if power is lost, all existing recent data in the RAM buffer is lost. (Of course, it still remains stored in FLASH for later retrieval).
- See Record Format to decode the HEX dump.
- See UOK command below to set R-interval for the RAM buffer.
SETUP to display EEPROM configuration constants (as set via UOK command)
STAT reports all current settings in multiline format. On an EEPROM failure, the first line will be "\r\nDEFAULT OPERATION\r\n".
Each line terminated \r\n
- Normal Operation:
  Instrument Address (not used)
  Model
  Serial Number
  Latest Checkout/Calibration Date
  Firmware Name and Version\r\n (from EPROM)
  RTC date and time (CLOCK command format) (LinuxClock when GO in MetMode = 1)
  If ZERO check enabled, and ZERO check multiplier NOT 60 minutes, display WARNING MESSAGE
  MetMode: 0 (0 = test, 1 = XMET, 2 = local MET)
  If MetMode = 1, XMET Status (XMET OK or XMET NOT Received!)
  WindCheck Status: 1 (0 = disabled, 1 = enabled)
  If MetMode = 1, XMET Timeout Tick; otherwise Logging Interval and Current Tick
  R-interval for RAM buffer
  PCMCIA Card Type present - CARD OK!
  FLASH card capacity: (size in bytes)
  FLASH Records used: (record count); available: (record count)
  Sampling GO or STOPPED
  2B OZONE Instrument Running or Stopped
  If 2B Running AND ZERO checking enabled, display Minutes til ZERO Check or ZERO Check in Progress
  If ZERO Check in progress, display minutes til complete
```
    Example in MetMode 2:

    OZONE
    Model: OZONECPU
    SerNum: 101
    CfgDat: 16 Apr 03
    Firmware: TWOBCPU V2.60
    RTClock: 2003/04/17  15:24:00
    MetMode: 2
    WindCheck: 1
    R-interval 2
    Intel Type 2+ 20MB PCMCIA CARD present - CARD OK!
    FLASH card capacity: 20840448
    Records used: 464; available: 392752
    Sampling GO
    2B OZONE Running
    Minutes until ZERO Check - 1344
    
```
STOP to stop sampling and allow configuration changes or testing. Responds with "Sampling STOP\r\n".
TM to test MET modules (WNDRAIN only in Ver 2.60)
- Sampling MUST be STOPPED.
- responds with average wind speed and rain detect flag value; 0 = NO rain.
- example: WNDRAIN: 3.27 0
- note: remember that the WNDRAIN module only updates once per minute.
UOK enter configuration update mode (held in EEPROM)
- Sampling MUST be STOPPED to enter update mode.
- Commands tagged with * will respond individually with their current settings if terminated immediately with <cr>; i.e. to see the current address, send ADR<cr>
- Remain in update mode until ABORT or WRTOK command.
  - ABORT to quit this mode without update; responds with "quitting...\r\n" after restoring original settings.
  - * ADR=xxxxx to set 1 to 5 character address (default is LOG01). These must be alpha-numeric. NOT USED in Ver 2.x
  - * CD=xxxxxxx to set a free format, 7 characters max, configuration date. For reference only, not used internally by instrument. Displayed in STAT command.
  - FEOK erase entire FLASH memory card. NOTE that this command has nothing to do with EEPROM; it's here to make it harder to do accidently! After erasing FLASH memory you may exit the UOK command by using ABORT.
    Requests 'Y' confirmation before proceeding.
  - FE1OK erase first 1/2 MB of FLASH memory card. QUICK FOR USE IN TESTING!!! If you aren't sure whether data has been written past the 1/2 MB point, use FEOK above! NOTE that this command has nothing to do with EEPROM; it's here to make it harder to do accidently! After erasing FLASH memory you may exit the UOK command by using ABORT.
    Requests 'Y' confirmation before proceeding.
  - * MM=x to set MetMode;
    0 = test (Rain Detect and Wind always OK)
    1 = XMET (external MET from XRF Sampler)
    2 = Normal MET (local instruments)
  - * MW=x to set Wind Check;
    0 = no checking
    1 = check wind for good range
  - * OP[0 - 9]=x to set Operating Parameter 0 to 9
    - e.g. OP2=30 to set over-temperature off-time to 30 minutes
    - The following parameters may be set:
      - 0 - CELL over-temperature limit (float value - typically about ?? degrees)
      - 1 - CELL over-pressure limit (float value - typically about ?? mbar)
      - 2 - Off-time after over-temp error (1 - 255 minutes)
      - 3 - Off-time after over-pressure error (1 - 255 minutes)
      - 4 - R-interval for RAM buffer (1 - 255 minutes)
      - 5 - ZERO check interval (5 - 255 hours, 0 disables) (if OP9 = 60)
      - 6 - ZERO check duration in minutes (5 - 255 minutes)
      - 9 - ZERO check interval multiplier in minutes (1 - 255 minutes, normally 60)
    - Note: R-interval determines how often a data record is put into the RAM buffer for the R command. For example, an R-interval of 1 puts every data record into the RAM buffer, allowing about 8 1/2 hours maximum of data to be buffered. An R-interval of 3 puts every 3rd data record into the buffer, so about a whole day of data will be buffered, at 3 minute intervals.
    - parameters 7 and 8 currently not used
  - * RD=xxx to set rain restart delay in minutes (1 - 60; typically 5 minutes)
  - * RI=xxxxx to set record interval in seconds (typically 60 seconds)
  - * WD=xxx to set Wind "Delay" in minutes (1 - 60; typically 5 samples = 5 minutes);
    This value actually sets the number of samples to average (one per minute)
  - * WMX=xxx to set Wind Speed Max value (0 - 255 = 0.0 to 25.5 m/s)
    typically 100 (= 10.0 m/s)
  - * WMN=xxx to set Wind Speed Min value (0 - 255 = 0.0 to 25.5 m/s)
    typically set to 0 to disable
  - WRTOK to write all EEPROM parameters. Update mode exits upon completion of write.
XMODE XMODEM Dump PCMCIA card via RS232 console
- Standard 20MB and 40MB FLASH cards will take FOREVER to read this way - the preferred method of reading data is to remove the FLASH card from the OZONECPU and read it on a Linux-based laptop with PCCard slot per Linux FLASH Card Reading Instructions
- Sampling MUST be STOPPED to enter update mode.
- This command is rudimentary; if you must dump data this way, use the FR command to display any record and see if it's where you wish to begin. Records are currently 32 bytes long, so you'll get 32768 records per dump request.
- Command dumps up to 1 MB of data from the requested starting record. The dump will end after the last valid record is reached, so if there is not actually 1 MB of data after the requested start record, the dump will stop (saves you time - you'd want it that way!)
- On command entry, requests: Start record # (0 aborts) ->
  - i.e. to get first MB of data (32768 records -> about 22 days), enter 1 as start record
  - add 32768 to your start record number to find the start of subsequent 1 MB blocks of data; i.e. if you entered 1 to start at the first record on the FLASH card, subsequent 1 MB blocks of data start at 32769, 65537, etc...
- Typical example - the following description assumes PCPLUS for terminal software, but any terminal program capable of XMODEM transfer should work.\
  - On entry, OZONECPU will prompt:
    Start record # (0 aborts) ->
    Enter a valid record # (see discussion above)
  - Next, you'll be prompted:
    Set terminal speed for 38400 then hit any key
  - After setting speed and hitting a key, you will see:
    XMODEM Send Function
    Waiting for start...
  - Start a transfer (PgDn in PCPLUS) - on completion, you will see something like:
    Sent 238 blocks - done
    Restore terminal speed to 9600 then hit any key
    NOTE:"blocks" here are XMODEM blocks of 128 bytes each
  - After resetting speed to 9600 baud and hitting a key, OZONECPU will send a "\r\n"
  - Ignore occasional gibberish when changing baud rates!
  - See also Record Format.