ASIMET Sonic Wind Module Version 5.xx with SDHC Command Set

file: asigilwnd24v5_cmd.html
21 Oct 2020

ASIMET SONIC WIND MODULE VERSION 5.xx with SDHC COMMAND SET Preliminary

See ASIMET MODULE OPERATIONS document for instructions on how to hook up the comms link to your PC and RS-485 adapter.
Refer to Latest Version Information for reference info on latest firmware version numbers.

SDHC NOTE 1 - Firmware Ver 5.xx has been tested using SanDisk SDHC cards of 4 GB, 8 GB, 16 GB and 32 GB on WHOI ASIPIC24 Rev A CPU boards.

SDHC NOTE 2 - SDHC cards MUST be initialized using the I command choice in the SDOK command menu. The module serial number MUST also be set via the UOK command. SDHC cards may be read on a PC and will contain 3 files: an ASGILxxx.ID file, an ASGILxxx.INF file, and an ASGILxxx.DAT file, where xxx is the last 3 digit of the serial number. Refer to SDHC Storage Format for details.

Note 1:

        The Gill wind sensor documentation refers to the Gill U axis as "north"
        and the Gill V axis as "east".   In addition, wind blowing TO the east on the
        Gill V (east) axis is negative.

        UOP / Oceanographic convention is as follows:

                Wind TO the EAST is POSITIVE on the U axis
                Wind TO the NORTH is POSITIVE on the V axis

        Thus, the "raw" Gill values are converted before further use in the
        calculations:
                sonic_U_east = -(gill_V);
                sonic_V_north = gill_U;

	The R command below displays the actual U and V values received from the Gill sensor.
	The T command below displays the sonic_U_east and sonic_V_north values corresponding
	to  UOP / Oceanographic convention as described here.

Note 2: This module is compatible with the ASIMET RM Young Wind Module; the 'C' command output is identical in format. The RM Young LastVane parameter is replace by the equivalent the Gill LastXYDir parameter.

Note 3: SDHC Storage - In addition to the one-minute values displayed by the C command below, the Gill sensor values for Speed of Sound and Temperature are logged - see Record Format. Speed of Sound and Temperature may be viewed via the R command below.

Note: commands sent are indicated in BOLD, responses in normal text. <crlf> represents ASCII carriage return and line feed; <crlfetx> represents ASCII carriage return, line feed, ETX (03h).

Command Description

A Address acknowledge
- returns address of module, terminated by <crlfetx>
- example:
  #WND01A WND01<crlfetx>
- NOTE: WND01 is the default address of the WND module; it may be changed by the 'U' command but any failure of EEPROM will result in the use of the default address. In the event of EEPROM failure, a message is sent to the RS- 232 console port on startup. In addition, use of defaults is reported in the 'L' command.
C Output calibrated data
- outputs calibrated value as follows:
  Ve Vn WSavg WSmax WSmin LastXYDir LastComp TiltXAvg TiltYAvg<crlfetx>
- example:
  #WND01C 2.34 1.45 4.9 5.2 4.7 123.1 234.5 0.2 0.3<crlfetx>
- C language format: "%6.2f %6.2f %5.1f %5.1f %5.1f %6.1f %6.1f %6.1f %6.1f\r\n\x03"
D Set RT clock date/time: 'YYYY/MM/DD HH:MM:SS'
- on module startup, the date and time are initialized from the battery-backed RTC on the board. The 'D' command accepts a fixed format string of exactly 19 characters representing date and time. For example, sending the following command:
  - #WND01D2020/02/15 10:35:15
  will set the date to 15 February 2020 at 10:35:15 AM.
- the module returns <crlfetx> in acknowledgement.
- the time will be set at the instant that the last digit is sent; thus you may enter the module address, command and first 16 characters of the date and time, and finally enter the 19th character in sync with your reference clock. The current date and time may be determined using the 'L' command.

H Help

#WND01H - a multiple line response with text similar to the first line of each command description in this document as the help line, with each line terminated <crlf> and final line terminated <crlfetx>, as follows:

    Firmware ASIGIL24 v5.48
    A - Address acknowledge
    C - Output calibrated data
    D - Set RT clock date/time: 'YYYY/MM/DD HH:MM:SS'
    H - Display Help message
    ? - Display Special Help message
    I - Report ID information
    L - Report ID, serial #, firmware, cal info, clocks, SD directory
    O - Report onboard system values: 3.3V, Vbat, Internal Temp
    P - Enter polled test mode
    R - Output raw data
    SD - SD Card access - password 'OK'
    T - Enter test mode
    U - Update EEPROM constants - password 'OK'
    XMODE - XMODEM Dump SD Card via RS232 console

Note: 'SDOK' and 'XMODE' are not present unless an SD Card is installed.

? Special Help

#WND01? - a multiple line response with text similar to Note 1 earlier in this document, with each line terminated <crlf> and final line terminated <crlfetx>, as follows:

    The Gill wind sensor documentation refers to the Gill U axis as "north"
    and the Gill V axis as "east".   In addition, wind blowing TO the east on the
    Gill V (east) axis is negative.

    UOP / Oceanographic convention is as follows:

            Wind TO the EAST is POSITIVE on the U axis
            Wind TO the NORTH is POSITIVE on the V axis

    Thus, the "raw" Gill values are converted before further use in the
    calculations:
            sonic_U_east = -(gill_V);
            sonic_V_north = gill_U;

    The R command below displays the actual U and V values received from the Gill sensor.
    The T command below displays the sonic_U_east and sonic_V_north values corresponding
    to  UOP / Oceanographic convention as described here.

I Report ID information

#WND01I - displays the text information stored in EEPROM, with headers as follows, each line terminated in crlf:

    MODADR: ( 5 bytes text)         module address
    MODMFG: (16 bytes text)         module manufacturer
    MODMOD: (16 bytes text)         model number
    MODSER: ( 8 bytes text)         serial number
    MODDAT: ( 8 bytes text)         manufacture date
    SENMFG: (16 bytes text)         sensor manufacturer
    SENMOD: (16 bytes text)         model number
    SENSER: ( 8 bytes text)         serial number
    SENDAT: ( 8 bytes text)         manufacture date
    IFBRDREV: (16 bytes text)       interface board & rev
    IFSFTREV: (24 bytes text)       interface software name & rev
    IFSERNUM: ( 8 bytes text)       interface serial number
    IFDATE: ( 8 bytes text)         interface software revision date
    CALFAC: (16 bytes text)         calibration facility
    CALPER: (16 bytes text)         calibration technician
    CALDAT: ( 8 bytes text)         calibration date
    DATFRM: (64 bytes text)         calibrated data output format
    DATDES: (64 bytes text)         calibrated data description
    DATUNI: (64 bytes text)         calibrated data units
    RAWFRM: (64 bytes text)         raw data output format
    RAWDES: (64 bytes text)         raw data description
    RAWUNI: (64 bytes text)         raw data units

the last scan sent is terminated by <crlfetx>.
NOTE: this information resides in EEPROM. Most items are completed at time of manufacturing test, but may be modified using the UOK command. Only module address is necessary for correct module operation.

L Report ID, serial #, cal info, etc.
- the 'L' command provides miscellaneous status information about the module in a multi-line response. The number of lines in the response may vary depending upon the EEPROM and SD card status. Normally, after an initial <crlf>, these lines of info are provided, as follows:
  #WND01L
```
    module id from EEPROM<crlf>
    module serial number from EEPROM<crlf>
    firmware name and version from program EPROM<crlf>
    calibration date from EEPROM<crlf>
    current date and time from PIC24 RTCC<crlf>
    current date and time from DS3232 battery-backed RTC<crlf>
    SD Card present? <crlf>
    3 lines of directory info if SD card is found & is formatted<crlf>
    If SD card found, shows card status<crlf>


    - example normal response (with SD card installed):
    WND01
    001
    ASIGIL24 v5.48
    -
    RTCC: 2019/12/17 11:23:35
    DS3232: 2019/12/17 11:23:36
    SD Card found
    2019-12-12 10:51:58             512 ASGIL001.INF
    2019-12-14 11:59:00           18180 ASGIL001.DAT
    2019-12-12 10:51:56             216 ASGIL001.ID
    SD Card formatted for this ASIMET module!
	
```
- the last line is terminated by <crlfetx>.
- NOTE 1: if an SD card is installed, a message will indicate this and either OK: "SD Card formatted for this ASIMET module!"
  or NOT LOGGING: "WARNING! SD Card NOT formatted for this ASIMET module - NOT LOGGING!" status
- NOTE 2: if no SD card present, the last two lines will be replaced by "No SD card installed" message.
- NOTE 3: if the EEPROM compass flag value, COMP_FLAG, is 1 (see Enable/Disable Compass under the UOK command for info), Compass use disabled! will be displayed between the serial number and firmware version lines.
- NOTE 4: the RTCC clock is the internal clock used by the module during operation. The DS3232 clock is the battery-backed clock used to set the RTCC upon module power up.
O Report onboard system values: 3.3V, Vbat, Internal Temp
- responds with several system values measured via the PIC24 on-board A/D converter. Displays the value of the 3.3 VDC rail, incoming power to the module (typically the external battery voltage), and the approximate internal temperature of the module from the board-mounted temperature sensor. For example:
  #WND01O
```
3.31v, 13.62vbat,  22.8 degC :  827,  613,  364

	
```
- the line is terminated by <crlfetx>.
- the three values following the colon are the raw 10-bit A/D values; calibration for all values is hard-coded in the firmware currently.
P Enter polled test mode
- responds with individual scans of data in the 'T' command response format (see below). Upon receipt of any character except ESC, another scan of WND data is sent.
- data is VE (m/s), VN (m/s), compass degrees, tilt-x degrees, tilt-y degrees, speed (m/s), wind direction degrees
  For example:
  #WND01P
```
    -0.34    0.30    44.2   -3.2    2.0    0.45    355.62<crlf>
                   send <cr> (or other character)
    -0.10   -0.02    40.7    0.8    1.7    0.10    299.39<crlf>
                   send <cr> (or other character)
    -0.03    0.00    40.7    0.7    1.6    0.03    310.72<crlf>
    .
    .
		
```
- the command terminates on receipt of an ASCII ESC (1Bh) character. The last scan sent is terminated by <crlfetx>.
R Output raw value
- outputs raw data values, as follows:
  Gill_U, Gill_V, Gill_SOS, Gill_TMP, Compass degrees, TiltX, TiltY<crlfetx>
- example:
  #WND01R 3.12 1.23 313.12 21.45 213.7 0.2 -0.3<crlfetx>
- C language format: "%7.2f %7.2f %7.2f %7.2f %6.1f %6.1f %6.1f\r\n\x03"
SDOK Menu-driven SDHC card command operations
- Upon SDOK command entry, and between each command, you will see a prompt:
  Enter SD Card Cmnd, ? or H for Help:
- a request for Help returns this message followed by another prompt:
```
    SD Card Help (All commands end with Enter)

    D - Read the card Directory
    E - Erase a file
    F[W,R] - Write or Read the Info File
    H{?} - Help menu
    I - Initialize the SD Card for this module
    Q - Quit Flash operations
    S - Show ID file (HEX then ASCII)

    Enter SD Card Cmnd, ? or H for Help:
    
```
- description of SDOK Menu Commands:
  - D - displays a card directory (for module serial number 001)
```
2020-01-20 11:34:38             216 ASGIL001.ID
2020-02-04 12:59:00            7168 ASGIL001.DAT
2020-02-04 09:25:52             512 ASGIL001.INF
       
```
  - E - erases a file. Prompts with:
    Erase a file (8.3 format max) ->
    Enter aborts; type a valid filename and enter to erase the file.
  - FR - reads the free-format ASCII contents of the info file, ASGIL001.INF
  - FW - prompts for up to 500 characters of user info; CTRL-C terminates entry into the info file, ASGIL001.INF
  - I - initializes the SD Card for use in the module. You must answer Y at the prompt or this command will abort. This initialization must be performed before the module will recognize the card and use it for data storage.
  - Q - quit Flash ops and return to logger command mode
  - S - display the contents of the ID file in HEX then ASCII. This file contains the current firmware version from program FLASH on the PIC24 micro, plus miscellaneous info from the EEPROM (as set via UOK command and displayed via I command). The current firmware version from program FLASH is compared with the version in the ID file to determine if the SD Card is initialized for use in the module.
- New SD Card Prep - when installing an SD Card for the first time, it must be initialized for use in the module. The "I" command, Initialize the SD Card for this module is used to prepare the SD Card for use. Three files will be created: ASGILxxx.ID, ASGILxxx.INF, and ASGILxxx.DAT, where xxx is the last 3 digits of the module serial number. The serial number must be set first via the UOK command. Once initialization is complete, you can get a directory with a "D" command, or write user info into the ASGILxxx.INF file with the "FW" command, then read the info file back with the "FR" command.

T Enter test mode

responds with continuous scans of data following initial 'Wait...' message, except <crlf> terminator only (no ETX).
scans occur every 5 seconds

data is VE (m/s), VN (m/s), compass degrees, tilt-x degrees, tilt-y degrees, speed (m/s), wind direction degrees
example:
#WND01T

    Wait...
    -0.34    0.30    44.2   -3.2    2.0    0.45    355.62<crlf>
    -0.10   -0.02    40.7    0.8    1.7    0.10    299.39<crlf>
    -0.03    0.00    40.7    0.7    1.6    0.03    310.72<crlf>
    -0.08    0.04    40.5    0.7    1.5    0.09    337.07<crlf>
    -0.03    0.06    40.4    0.5    1.5    0.07     13.83<crlf>
    -0.09    0.08    40.5    0.5    1.5    0.12    352.13<crlf>
     0.09    0.08    40.4    0.6    1.5    0.12     88.77<crlf>
     0.01    0.06    40.5    0.7    1.4    0.06     49.96<crlf>
    .
    .

the command terminates on receipt of an ASCII ESC (1Bh) character. The last scan sent is terminated by <crlfetx>.

UOK Update EEPROM contents
- enters the update mode after confirmation of 'OK' password. New EEPROM values may be entered in this mode.
- upon initial entry, you must send the letters OK after the command or the command is ignored, e.g. #WND01UOK. Upon receipt of the correct password, a set of prompts will be issued to allow entry of new module address, module manufacturer's info, sensor info, software info, calibration facility info, raw and calibrated output format info, display entire info area, and exit with or without update.
- Enable/Disable Compass use in vector calculations. A special configuration setting allows compass use to be disabled in all calculations while still displaying the current compass values and logging the compass data to SD card. This option is typically used for testing purposes on ship-mounted systems only. This option is NOT listed in the EEPROM menu.
  - At the "Enter selection ->" prompt following the standard menu, hit C followed by <cr> to get the current compass flag value and the prompt to change it, as below:
```
    COMP_FLAG: 0
    Enter 0 or 1 ->
```
  - Enter 0 (ZERO) to enable the use of the compass during calculations (NORMAL OPERATION).
  - Enter 1 (ONE) to disable the use of the compass during calculations.
  - Don't forget to "Exit and update EEPROM" with menu choice 9 when done, then cycle power for the new setting to take effect.
  - Note that the L command will display Compass use disabled! if the COMP_FLAG value is 1.
- the '0' choice for 'Exit without update' leaves the module RAM and EEPROM in its original state.
- all responses to prompts must be terminated with <cr> (Enter)
  The final response from the module upon exit is <crlfetx>
- NOTE 1: Upon completion, the newly updated module address and the compass enable/disable setting will not take effect until the next reset or power-up.
XMODE XMODEM Dump SD Card via console
- XMODE command only works in RS232 mode and only if an SD Card is installed
- SD Cards will take a LONG TIME to read this way - the preferred method of reading a large .DAT data file is to remove the SD Card from the module and read it on a PC. Three files will be recognized by the PC, the ASGILxxx.ID containing ID info, the ASGILxxx.INF INFO file which can contain up to 500 characters of user information, and the ASGILxxx.DAT DATA file which contains the module data records. See the SDOK command above.
- This command is somewhat rudimentary; if you must dump data this way, use the L command to display the current directory and file sizes on the SD Card.
- On command entry, requests: Start record # (1 is first, 0 aborts) -> followed by: Number of records (default is 512) ->
  - i.e. to get first week of data (168 records -> 1 week), enter 1 as the start record, and 168 for the number of records.
  - add 168 to your start record number to find the start of subsequent week-long portions of data; i.e. if you entered 1 to start at the first record on the SD Card, subsequent weeks of data start at record 169, 337, 505, etc...
- Typical example - any terminal program capable of XMODEM transfer should work.
  - On entry, module will first prompt for start record:
    Start record # (1 is first, 0 aborts) ->
    Enter a valid record # (see discussion above)
  - followed by a prompt for number of records:
    Number of records (default is 512) ->
    Enter a valid sector count (see discussion above)
  - Next, you'll be prompted:
    Set terminal speed for 115200 then hit any key
  - After setting speed and hitting a key, you will see:
    XMODEM Send Function
    Waiting for start...
  - Start a transfer - on completion, you will see something like:
    Sent 25 records (100 xmodem 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, module will send a "\r\n"
  - Ignore occasional gibberish when changing baud rates!
- If you request more records than the data file contains, you will see a "Reached EOF" message before the final record and block tally.
- Note: Only the ASGIL001.DAT data file from the SD Card is dumped via XMODEM; Refer to SDHC Storage Format.

Revision history:

Original Release - V5.01 (first instruments with SD Card capability)