VMCM2 Commands as currently implemented

file: vm2curr53.html
10 Apr 2002

VMCM2 Commands - Version 2.xx (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.

Instrument always comes up running and logging in fixed configuration - see 'default' config below

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'
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 2.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 2.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.
FC read current record configuration; currently responds with "Defaults Only\r\n"
See Record Format.
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.

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

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 v2.xx
    A - Address acknowledge
    CLOCK(=YYYY/MM/DD HH:MM:SS) - Read/Set RT clock date/time
    D - Send latest calibrated 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
    LIVE - Dump 1 second live data continuously (until ESC)
    STAT - System status info
    STOP - Stop sampling
    T - Test mode commands:
        TA - AtoD tests
        TB - Battery tests
        TC - Compass tests
        TR - Rotor tests
        TT - Temperature pod tests
    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. On a EEPROM failure, the first line will be "\r\nDEFAULT OPERATION\r\n".
- Normal Operation:
  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
  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
  Sampling GO\r\n
```
    Example:

    VM001
    Model: WHOI VMCM2
    SerNum: 201
    CfgDat: 23May01
    Firmware: VMCM2 v2.xx
    RTClock: 2001/07/02  16:03:49
    Averaging Interval: 60;  Current Tick: 19
    PCMCIA CARD present - CARD OK!
    FLASH card capacity: 20840436
    Records used: 56; available: 612898
    Main Battery Voltage:  12.48
    Sampling GO
    
```
STOP to stop sampling and allow configuration changes or testing. Responds with "Sampling STOP\r\n".
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.
TR Test rotors.
- 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:
"\r\n Rotor 1 -> 192\r\n"
"Rotor 2 -> 192\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.
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>
- Remain 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.
  - 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.
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 FLASH Card Reading Instructions
- 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.