VMCM2 Commands

file: vm2curr53.html
18 Sep 2012

VMCM2 Commands - Firmware Version 3.2x (C530 CPU Board)

See VMCM2 OPERATIONS document for instructions on how to hook up the comms link to your PC.
Refer to Latest Version Information for reference info on latest firmware version numbers.

VMCM2 always powers up running and logging in fixed configuration - see 'default' config below
- NOTE: may be placed in WAIT mode by command after startup.

NOTE: Version 3.2x adds additional rotor test commands (TRC, TRI, TRS) and, under the UOK command, the CMP option to power duty-cycle the TCM2 compass for power conservation (note that this results in less than standard once per second compass sampling).

NOTE 2: All other commands are the same as earlier Firmware Version 3.10. Note also that the TRS rotor test command is the same as the TR command in Firmware Version 3.10.

Command Descriptions

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

- Remember: precede all commands with #addr, i.e. #VM001 in address mode
- NOTE: The FULL command set is ONLY available when the VMCM2 is NOT running (see STOP command).

A to echo "address\r\n" - artifact of IMET, simple confirmation of 'life'. The default address for the VMCM2 is VM001.
(see also forgotten address)
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 respond with data from most recent average interval;
Firmware Ver 3.xx displays:
- Ve, Vn (in cm/sec)
- Rotor1, Rotor2 (counts for current interval - each rotation generates 16 counts)
- Compass dir (in degrees 0-359.9)
- Tilt X, Tilt Y (in degrees +/-25 from vertical)
- Thermistor 'Pod' temperature (typically in degrees C)
- ```
typical response: "-46.10  111.64 -2923  1024   48.2   0.1   1.2  22.345\r\n"
```
E respond with extra A/D data from most recent average interval;
Firmware Ver 3.xx displays:
- AD Channel 1, AD_CH2, AD_CH3, Battery Current (AD_CH4), Battery Voltage (AD_CH5)
- ```
typical response: "0.0  0.0  0.0  9.31  13.32\r\n"
```
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 VM2_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 'D' command format plus thermistor resistance, muxed parameter number and muxed parameter value for this record.
- ```
e.g. "-46.10  111.64 -2923  1024  48.2 0.1 1.2  22.345 32134.1 4 11.98\r\n"
  (Note that muxed parameter is #4 (Battery Voltage), value is 11.98 volts)
```
- On completion, i.e., you sent an X to exit, an extra "\r\n" is sent.
- See also Record Format.

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

  Example:

    PCMCIA CARD present - CARD OK!
    FLASH card capacity: 20840436
    Records used: 125; available: 612829

FD display System Info area from FLASH.
The first line is the RTC date and time when the System Info was written, the second line is the record interval (RI) from EEPROM, etc. See System Info Record Format for complete reference.

  Example:

    2003/02/14  11:32:09
    60
    VMCM2 v3.10
    WHOI/GEOFF
    T-1
    11MAR02
    VMTPOD53 v3.00
    WHOI/GEOFF
    201
    06FEB03
    YSI-TYPE123 TEST
    THIS IS A TEST OF THE COMMENT FIELD - 14 FEB 2003

FE erase the System Info area of the FLASH card
This erases the first 128K bytes of the FLASH card ONLY; the data records are untouched. Sampling MUST be STOPPED)
- Requests 'Y' confirmation before proceeding.
- Responds with "Erasing..." followed by another dot after the 128K physical block is erased. This will take a couple of seconds.
- On completion, "System info cleared" terminates the string of dots.
FW write the System Info area of the FLASH card
- On entry, you will be prompted to:
  Enter a comment now - CR to end:
  You may enter up to 127 bytes of information to be written into the "comment" field of the System Info record. See System Info Record Format.
- At the CR, the System info will be written to the FLASH card; on completion, "System info written to FLASH Card" will be sent.
- Sampling MUST be STOPPED) and the System Info area must be erased with the FE command before FW is issued.
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 VMCM2 is running (GO mode); i.e., only those commands available while running are displayed. To access the full command set, the VMCM2 must be STOPPED.

       Example of output in STOPPED mode:

       Firmware VMCM2 v3.2x
       A - Address acknowledge
       CLOCK(=YYYY/MM/DD HH:MM:SS) - Read/Set RT clock date/time
       D - Send latest standard data
       E - Send latest A/D data
       F - FLASH card commands:
           FB - Read any block, hex
           FR - Read data record, formatted
           FS - Card status info
           FD - Display System Info block only
           FE - Erase System Info block only
           FW - Write System Info block only
       GO - Re-start sampling
       H - Display Help message
       LIVE - Send Continuous 1 Second Data (ESC to quit)
       STAT - System Status
       STOP - Stop sampling
       T - Test mode commands:
           TA - AtoD tests
           TB - Battery tests
           TC - Compass tests
           TRx - Rotor tests - C, I, S
           TT - Temperature pod tests
       TPOD - Request TPOD status info
       UOK - Update EEPROM constants
       XMODE - XMODEM Dump PCMCIA card via RS232 console

LIVE dumps continuous data at a 1 second rate until receipt of ESC character (in RS485, may need to send several ESC to catch RS485 transceiver in RECEIVE).
- Data returned is Ve, Vn, Rotor1, Rotor2, Dir, TiltX, TiltY, Temperature\r\n.
  i.e. similar to 'D' command.
- Update rate of Ve, Vn, Rotor1, Rotor2, Dir, TiltX and TiltY is every second.
- Update rate of temperature output is every 2 seconds.
- No data is stored to FLASH card.
- Instrument MUST be STOPPED for this command to function.
STAT reports all current settings in multiline format. If VM is in STOP mode, TPOD information will also be displayed (if installed). On an EEPROM failure, the first line will be "\r\nDEFAULT OPERATION\r\n".
- Normal Operation, GO mode:
  Instrument Address\r\n
  Model\r\n (from EEPROM)
  Serial Number\r\n\ (from EEPROM)
  Latest Checkout/Calibration Date\r\n
  Firmware Name and Version\r\n (from EPROM)
  RTC date and time\r\n (CLOCK command format)
  Averaging Interval and Current Tick\r\n
  Compass Duty Cycle (Power Conservation)\r\n
  PCMCIA CARD present - CARD OK!\r\n
  FLASH card capacity: 20840436\r\n
  FLASH Records used: 56; available: 612898\r\n
  Main Battery Voltage: 11.48\r\n
  TPOD Firmware: name and version from TPOD EPROM
  TPOD Info: serial #, thermistor info, date, model info from TPOD EEPROM
  Sampling GO\r\n
```
        Example (before TPOD command issued):

           VM001
           Model: WHOI VMCM2
           SerNum: 201
           CfgDat: 21Jan03
           Firmware: VMCM2 v3.00
           RTClock: 2003/02/15  16:03:49
           Averaging Interval: 60;  Current Tick: 19
           Compass Ontime=2  Offtime=3
           PCMCIA CARD present - CARD OK!
           FLASH card capacity: 20840436
           Records used: 56; available: 612898
           Main Battery Voltage:  12.48
           No TPOD Installed?
           Sampling GO
    
```
- Normal Operation, STOP mode:
  Instrument Address\r\n
  Model\r\n (from EEPROM)
  Serial Number\r\n\ (from EEPROM)
  Latest Checkout/Calibration Date\r\n
  Firmware Name and Version\r\n (from EPROM)
  RTC date and time\r\n (CLOCK command format)
  Averaging Interval and Current Tick\r\n
  Compass Duty Cycle (Power Conservation)\r\n
  PCMCIA CARD present - CARD OK!\r\n
  FLASH card capacity: 20840436\r\n
  FLASH Records used: 56; available: 612898\r\n
  Main Battery Voltage: 11.48\r\n
  TPOD Firmware: name and version from TPOD EPROM
  TPOD Info: serial #, thermistor info, date, model info from TPOD EEPROM
  Sampling STOPPED\r\n
- NOTE: If a TPOD is NOT found on the first STAT request after STOP, a "No TPOD installed?" line will replace the TPOD lines in the subsequent responses. Issuing a GO command followed by a STOP command will cause the STAT command to look for the TPOD again on the next "first" STAT request.
```
        Example (after TPOD command issued):

           VM001
           Model: WHOI VMCM2
           SerNum: 201
           CfgDat: 15Feb03
           Firmware: VMCM2 v3.00
           RTClock: 2003/02/15  16:03:49
           Averaging Interval: 60;  Current Tick: 19
           Compass Ontime=2  Offtime=3
           PCMCIA CARD present - CARD OK!
           FLASH card capacity: 20840436
           Records used: 56; available: 612898
           Main Battery Voltage:  12.48
           TPOD Firmware: VMTPOD53 v3.00
           TPOD Info: 201,YSI-1234,11FEB03,WHOI-DGE
           Sampling STOPPED
    
```
STOP to stop sampling and allow configuration changes or testing. Responds with "Sampling STOP\r\n".
- When the VMCM2 is STOPPED, a 4 hour activity timer starts counting; if there is no console activity for 4 hours, the VMCM2 will restart as if a normal GO command has been issued.
TA Test all 5 AD channels (continuous until ESC)
- On entry, displays "AtoD test command", then continuous lines of 5 pairs of calibrated and raw count values of channels 1 to 5, each pair separated by semi-colon, each line terminated "\r\n".
```
Example:
  4095.000 4095; 4095.000 4095; 4095.000 4095;   0.000    0;  11.443 2934
  4095.000 4095; 4095.000 4095; 4095.000 4095;   0.000    0;  11.439 2933
  4095.000 4095; 4095.000 4095; 4095.000 4095;   0.000    0;  11.446 2935
                
```
- To quit, hit ESC.
- NOTE: 3 decimal places are displayed on calibrated values, but remember that it's only a 12-bit A/D.
TB Test main battery voltage and current (continuous until ESC)
- On entry, displays "Battery test command", then continuous lines of "vv.vv VDC, aa.a MA\r\n" where vv.vv is the battery voltage in VDC, and aa.a is the battery current in MA. Cals are set by Cal Constant sets 4 and 5. Current is 4th, voltage is 5th A/D channel.
- To quit, hit ESC.
TC Test compass (get direction and tilts continuous until ESC)
- On entry, displays "Compass test command", then continuous lines of direction, tiltx, tilty (in degrees), terminated "\r\n". All values are displayed in degrees to 1 decimal place.
Example: 53.1 -0.4 1.2
- To quit, hit ESC.
TRC Test rotors - continuous 1 second updates
- On entry, displays counts per second continuosly:
Rotor 1 -> 12
Rotor 2 -> 7
- all lines terminated "\r\n"
- To quit, hit ESC
TRI Test rotors - interval of 1,2,3 or 4 minutes
- On entry, prompts with "Rotor 1 & 2 counts per interval - enter interval 1 to 4 minutes or 0 to exit".
- For example, enter "1" to count for one minute, and immediate response is:
Timing 1 minute interval

- and at the end of the period, displays the counts and another prompt:
Rotor 1 -> 524
Rotor 2 -> 0
Rotor 1 & 2 counts per interval - enter interval 1 to 4 minutes or 0 to exit

- all lines terminated "\r\n"
- enter '0' to exit
TRS Test rotors - single sample
- On entry, displays "Rotor 1 & 2 test command -hit ESC key to read counts and exit".
- After cranking rotors (both 12 times positive, for example) and hitting ESC, responds with:
Rotor 1 -> 192
Rotor 2 -> 192

- all lines terminated "\r\n"
TT Test Thermistor 'POD'
- On entry, displays "Temperature Pod test command", then continuous lines of calibrated temperature and raw resistance(as returned by TPOD), terminated "\r\n"
- If no response from TPOD, -5.0 and 0 will be returned.
- To quit, hit ESC.
- Test commands will display calibrated and raw values where appropriate. Sampling MUST be STOPPED to use any test command.
TPOD request TPOD system info
Requests EPROM version and EEPROM text info from the attached VMTPOD
- initially responds with Requesting TPOD status info..., powers up the TPOD for 2 seconds, then issues a series of S commands to retrieve the info.
- completes the response with OK if a TPOD is found; otherwise responds TPOD not found.
- the TPOD info is displayed in the STAT command output once the TPOD command has been issued successfully.
- Sampling MUST be STOPPED.
UOK enter configuration update mode (held in EEPROM)
- 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>
- Remains in update mode until ABORT or WRTOK command.
- Sampling MUST be STOPPED to enter update mode.
  - 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 VM001). Address must be alpha-numeric.
    NOTE: Address change does NOT take effect until power is cycled!
  - * CALxy=floating point number, where x = cal constants set from 1 to 5, and y = constant from A to D. Used to cal A/D channels 1 to 5.
    A 3rd order polynomial calibration (form is A + Bx + Cx^2 + Dx^3) is applied to the raw A/D counts (0 - 4095).
    - (see TB command also)
    - Example: to check constant B from the 3rd set of cal constants, enter CAL3B followed by <cr>; response will be CAL3B = 2.3456e+01, for example.
    - To set cal constant A from the first set of cal constants, enter CAL1A=9.12345e-4; new value will be echoed as in example above.
  - * CD=xxxxxxx to set a free format, 7 characters max, calibration or checkout date. For reference only, not used internally by instrument. Displayed in STAT command.
  - * CMP=xx to set TCM2 compass power OFFTIME. Used for power conservation by duty-cycling TCM2 compass.
    - Minimum OFFTIME is 2 seconds, maximum OFFTIME is 13 seconds. ONTIME is always 2 seconds.
    - In duty-cycle mode, TCM2 compass is sampled one every 4 to 15 seconds depending on OFFTIME.
    - To disable duty-cycling and sample TCM2 compass every second, set CMP=0
    - Current OFFTIME setting displayed in STAT command.
  - FEOK erase entire FLASH memory card (required if changing recorded parameters). 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.
    - Responds with "Erasing FLASH Card" followed by a dot after each 128K physical block is erased. This will take a couple of minutes.
    - On completion, "Cleared" terminates the string of dots and you may ABORT to leave the UOK command.
  - FE1OK erase first 1/2 MB of FLASH memory card.
    *** FOR TESTING ONLY - ERASE ENTIRE CARD BEFORE DEPLOYMENT ***
    *** OTHERWISE, BAD DATA WILL RESULT!!!!! ***
    - Proceeds as for FEOK but completes in a few seconds.
  - * RI=integer from 15 to 3600. Sets 'record interval' (i.e. the averaging interval) to 15 seconds through 3600 seconds (1 hour) in 15 second increments only.
    Default is 60 seconds.
  - WRTOK to write all EEPROM parameters. Update mode exits upon completion of write.
WAITnnnn Wait for delayed start
- Wait for delayed start nnnn hours from now (240 to 2400 hour range) in lower power standby mode (no logging, no transmitted comms, approx. 5 MA at 15VDC)
- Sampling MUST be STOPPED to enter WAIT time
Example:
- Now only timeout or receipt of ESC character will return VMCM2 to normal operation.
  
  If time expires, and an RS232 terminal is attached, message ...starting... will appear on console. VMCM2 will return to GO mode, begin logging data, and respond to normal commands.
  If ESC is used to abort early, Aborting delayed start - entering STOP mode will be displayed on RS232 console. The VMCM2 will return to STOP mode, and 4 hour timeout will begin counting - see STOP command.
  There is NO response to any commands except the ESC to exit the WAIT - remember this if you put the VMCM2 in WAIT and disconnect the console!!
XMODE XMODEM Dump PCMCIA card via RS232 console
Standard 20MB FLASH cards will take FOREVER to read this way - the preferred method of reading data is to remove the FLASH card from the VMCM2 and read it on a Linux-based laptop with PCCard slot per Linux PCMCIA FLASH Card Reading
- Sampling MUST be STOPPED to dump data.
- 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.
- Typical example - the following description assumes PCPLUS for terminal software, but any terminal program capable of XMODEM transfer should work.
- On entry, VMCM2 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, VMCM2 will send a "\r\n"
- Ignore occasional gibberish when changing baud rates!
- See also Record Format.