Commands as currently implemented for SAMPLER24 CPU

file: sm24_maincpu.html
7 Feb 2004

SAMPLER24 Main CPU Commands Version 1.20

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

- mode of operation:

SAMPLER24 Main Controller always comes up running (sampling) and logging ops data to FLASH in the configuration specified in EEPROM at the Sample # determined by reading the last ops data from FLASH
NOTE!! The system will NOT sample if NO FLASH card is found!
Modified address mode only - PRECEDE ALL COMMANDS WITH # (full address not used)
Whenever the sampling system is STOPPED, a timeout timer is started that will restart the system (GO mode) after 4 hours. Each time the STOP command is issued, the timeout timer is reset for 4 hours. NO RESTART will occur if the system is left in UOK, FB, FR, or TM modes.

Special Service Signal (Hardware Option)

To facilitate maintenance of the filter holders, a pushbutton input allows the system to be stopped, and move filter holders to the maintenance window, beginning with filter #0. The system will restart where it left off after 15 minutes of no pushbutton activityUNLESS at least 24 button pushes have been counted. After 24 button presses, all filters are assumed to have been replaced, and sampling will restart (after the 15 minute timeout) from the beginning. If this is NOT what you want, you MUST attach a console, command a STOP, and handle things via the console

NOTE that if a console is attached and ANY command is sent to the sampling system BEFORE the 15 minute restart occurs, RESTART will be ABORTED and the system will remain STOPPED (until normal timeout restarts system where it left off).

Module port assignments

Port 1 - VWNDRAIN module
Port 2 - not used
Port 3 - SAMPLER24
Port 4 - INLET
Port 5 - not used
Port 6 - not used (future RFLINK??)

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

NOTE: The FULL command set is ONLY available when the SAMPLER24 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 1.20 displays:
Wind Speed, Rain Detect Flag, current Sample Number, elapsed Sample Time, SAMPLER24 Running Flag, System Status Byte HEX, MainCPU Status Byte HEX, Sample Handler Status Word HEX
Rain Detect Flag: 1 = RAIN detected, otherwise 0;
Elapsed Sample Time is in minutes;
SAMPLER24 Run Flag: 1 = RUNNING; 0 = STOPPED;
Status Byte bits are defined in struct.dec in Record Format
Typical scan: 3.21 0 12 734 1 D7 1E 4771
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 1.20 displays Average Wind Speed in m/s and Rain Detect flag value (0 = NO Rain):
```
    WNDAVG: 2.31
    RDET: 0
    
```
If a flow meter is running, an additional line will display flow meter 0 or 1 and its value in liters per minute:
```
    WNDAVG: 2.31
    RDET: 0
    FM0:  12.59
    
```
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/10/20 17:04
WND:   0.20
RDET:  0
CURR: 4 435
LAST: 1 4
STAT: 1 D7 1E 177A
```
- CURR line indicates current sample number and elapsed time on the sample
- LAST line indicates last reported position and sample number from sample handler
  position 0 = home, 1 = intake - see sample handler GOCW command
- 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 the SAMPLER24 is running (GO mode); i.e., only those commands available while running are displayed. To access the full command set, the SAMPLER24 sampling MUST be STOPPED.

   Example of output in STOPPED mode:

   Firmware SAMPLER24 V1.20
   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
       FR - Read data record, formatted
       FS - Status info
   GO - Re-start sampling
   H - Display Help message
   SETUP - Show EEPROM Configuration Settings
   STAT - System status info
   STOP - Stop sampling
   S[nn] - Service Filter #nn at window
   T - Test mode commands:
       TM - MET Module test
       TV - Inlet Valve test
   UOK - Update EEPROM Configuration Constants, etc
   XMODE - XMODEM Dump PCMCIA card via RS232 console

S[nn] to move Filter Holder nn to the servicing window.
- nn may range from 00 to 23.
- If the intake is currently closed, it will be opened first before attempting to rotate the requested Filter Holder into position for service.
- Example: to move Filter Holder #4 to the window, enter S04 (note leading zero)
  - On completion, reports Filter 4 home
- Sampling MUST be STOPPED.
- See also CRF sub-command (under UOK)
SETUP to display EEPROM configuration constants (as set via UOK command)
EEPROM Settings:
Record Interval (RI): 60
MET Mode (MM): Local MET (VWNDRAIN)
Rain Delay (RD): 5
Wind Check (MW): 1
Wind Delay (WD): 5
Wind Max Limit (WMX): 100
Wind Min Limit (WMN): 0
Sample Mode: 1 (cutoff date mode)
Sample Cutoff Year-Day: 100, 105, 110, 115, 120, 125, 130, 135, 140, 145, 150, 155, 160, 165, 170, 175, 180, 185, 190, 195, 200, 205, 210, 215
Sample Times: 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440, 1440
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)
  MetMode: 2 (0 = test, 1 = XMET, 2 = local MET)
  If MetMode = 1, XMET Status (XMET OK or XMET NOT Received!)
  WindChecking: ON (OFF = disabled, ON = enabled)
  If MetMode = 1, XMET Timeout Tick
  Logging Interval and Current Tick
  PCMCIA Card Type present - CARD OK!
  FLASH card capacity: (size in bytes)
  FLASH Records used: (record count); available: (record count)
  Sample Mode 0 (elapsed time mode) or Mode 1 (cutoff date mode)
  Current sample number and elapsed time on sample
  Status values for System, MainCPU, and SampleHandler
  Sampling GO or STOPPED
  SAMPLER 24 Instrument Running or Stopped
  Next 'GO' command will restart sampling at Filter nn (only if the system is in STOP mode AND a CRF command has been initiated.)
```
        Example in MetMode 2:

	SMP24
	Model: SAMPLER24
	SerNum: 101
	CfgDat: 16 Apr 03
	Firmware: SAMPLER24 v1.20
	RTClock: 2003/10/17  15:24:37
	MetMode: 2
	WindCheck: ON
	Logging Interval: 60;  Current Tick: 37
	Intel Type 2+ 20MB PCMCIA CARD present - CARD OK!
	FLASH card capacity: 20840448
	Records used: 464; available: 392752
	Sample Mode: 1 (cutoff date mode)
	Current Sample #: 01    Elapsed Time: 287
	Status - System: D7  MainCPU:  7F  SampHndlr:  7EA5
	Sampling GO
	SAMPLER 24 Running
    
```
STOP to stop sampling and allow configuration changes or testing. Responds with "Sampling STOP\r\n".
TM to test MET module (VWNDRAIN only in Ver 1.20)
- Sampling MUST be STOPPED.
- responds with average wind speed and rain detect flag value; 0 = NO rain.
- example: VWNDRAIN: 3.27 0
- note: remember that the VWNDRAIN module only updates once per minute.
TV to test INLET valve
- Sampling MUST be STOPPED.
- On entry, opens inlet valve, and prompts for ESC to exit.
- On ESC, closes valve and sends Done message.
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.
  - CRFnn to setup for sampling restart at Filter nn (0 - 23) upon next GO command. This command is intended for restarting the sampling system after filters have been serviced using the S[nn] command. Requests 'Y' confirmation before proceeding.
    If 'Y' is received, responds "Next 'GO' command will restart sampling at Filter nn"
    If 'N' is received, responds "Cancelling arbitrary restart command"
    Cycling system power or issuing another CRF command and answering 'N' at confirmation BEFORE the next GO command will cancel the restart.
  - 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
  - * 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)
    NOTE: LOCKED at 60 SECONDS on 7 Feb 2004 - ops at other intervals untested/unsafe
  - * SCnn=xxx to set sampling cutoff day for Sample nn (0 - 23) to a particular Julian year-day
    - ONLY applicable if Sample Mode is 1 (cutoff date mode)
    - year-day 001 to 366 - the LAST day of the selected sample
    - minimal error checking, always enter 3 digits, leading zeroes if needed - get it right!
    - NOTE: Ver 1.20 will NOT WORK across a new year boundary!!! Special for 2004 test on BTM.
  - * SM=x to set Sample Mode
    - Sample Mode 0 (SM=0) is elapsed time mode; each sample duration determined by STnn setting.
    - Sample Mode 1 (SM=1) is cutoff date mode; each sample runs during a "window" of total duration determined by SCnn, the Julian year-day marking the last day of the current sample. Within the sample "window", the STnn value determines the sampling time within the "window". For example, Sample #12 can be set for 36 hours of total sampling within a 5 day sampling "window".
  - * STnn=xxxxx to set sampling time for Sample nn (0 - 23) to xxxxx minutes (e.g. 1440 = 1 day)
    - typically 1 to 4 days
    - in Sample Mode 0, next sample starts as soon as current sample time elapses.
    - in Sample Mode 1, sampling stops when current sample time elapses, but new sample does not start until end of cutoff day set by SCnn above.
  - * 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 SAMPLER24 CPU 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, SAMPLER24 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, SAMPLER24 will send a "\r\n"
  - Ignore occasional gibberish when changing baud rates!
  - See also Record Format.

SAMPLER24 Main CPU Commands Version 1.20

NOTE!! The system will NOT sample if NO FLASH card is found!

Special Service Signal (Hardware Option)