file: asirmywnd24v5_cmd.html
11 May 2015
ASIMET 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 2 GB, 4 GB, and 8 GB on WHOI ASIPIC24 Rev - CPU boards.
SDHC NOTE 2 - SDHC cards MUST be initialized using the I command choice in the SDOK command menu. SDHC cards may be read on a PC and will contain 3 files: an ASRMY???.ID file, an ASRMY???.INF file, and an ASRMY???.DAT file. ??? will be replaced in the filename with the first 3 digits of the serial number specified in the UOK command under Menu #2 - MODSER.
Refer to SDHC Storage Format for details.
Note 1: This module uses the PICWND type of sensor front-end with RM Young Wind Vane. Reference the
PICWND Front-End Module Command Set document.
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 LastVane 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:
- #WND01D2013/02/18 10:35:15
will set the date to 18 Feb 2013 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 ASIRMY24 v5.01
A - Address acknowledge
C - Output calibrated data
D - Set RT clock date/time: 'YYYY/MM/DD HH:MM:SS'
H - Display 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.
- I Report ID information
- 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
ASIRMY24 v5.01
-
RTCC: 2012/12/17 11:23:35
DS3232: 2012/12/17 11:23:36
SD Card found
2012-12-12 10:51:58 512 ASIRMY24.INF
2012-12-14 11:59:00 18180 ASIRMY24.DAT
2012-12-12 10:51:56 216 ASIRMY24.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.
- NOTE 5: if the NOAA/SEAS flag value is 1 (see Enable/Disable
NOAA/SEAS-Compatible message under the UOK command for info),
AUTOIMET NOAA-SEAS message enabled! will be displayed between the serial number and firmware version lines.
- 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
- same as 'T' command below, except after initial scan, waits
for any character (except ESC) to send next scan.
- R Output raw value
- outputs raw data values, as follows:
sample_time, pulse_count, compass degrees, east vector
(m/s), north vector (m/s)<crlfetx>
- example:
#WND01R 5.0 248 302.7 -0.968 0.250<crlfetx>
- C language format: "%5.2f %6d %5.1f %6.3f %6.3f\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:
- 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: ASIRMY24.ID, ASIRMY24.INF, and ASIRMY24.DAT. Once initialization is complete, you can get a directory with a "D" command, or write user info into the ASIRMY24.INF file with the "FW" command, then read the info file back with the "FR" command.
- T Enter test mode
- 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.
- Enable/Disable NOAA/SEAS-Compatible message allows an ASIMET WND module
to be substituted for a complete AUTOIMET shipboard system, providing date, time, and
Ve and Vn values in a string that is broadcast out the console port once per minute.
The format is compatible with the standard AUTOIMET message, with other ASIMET
module values set to zero. This option will only broadcast the message if the
WND module is set for RS232 comms.
- 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, the compass enable/disable setting,
and the NOAA/SEAS message 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 ASIRMY24.ID containing ID info, the ASIRMY24.INF INFO file which can contain up to 500 characters of user information, and the ASIRMY24.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 ASIRMY24.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)