Terminal mode command examples

How to enter a command

Example 1

The following text shows an example of setting up the SkyVue PRO serial port. This example sets the serial port to RS-232 hand shaking at 115200 bps, 8 data bits, no parity and if it was in RS-485 mode, then a 100 ms turn around delay.

serial 0 10 0 100

You could also type the following to obtain the same results as the RS-485 turn around delay is not needed:

serial 0 10 0

To change only the data baud rate, you can replace mode parameter, with a comma (,) as shown below.

serial , 10

Alternatively if you just wished to change the parity to 8-bits no parity, then type the following:

serial , , 0

You do not need to replace the remaining parameters with a comma (,); you only need to replace the ones up to the parameter you wish to edit.

NOTE:

Leave a space character between the command and the parameters as shown in the examples.

Example 2

Entering the MCFG command, as shown below, will set the sensor to send messages at 10 second intervals and to send one message only with the message number 112.

MCFG 10 112 0 0 0 0 (return)

The four zeros indicate that no other message outputs have been set. The MCFG command is described in Summary of the terminal mode commands available.

Summary of the terminal mode commands available

Command

Parameter/
parameter block

Description

ALARMS

Angle

Angle is the threshold tilt angle of the sensor beyond which an alarm will be flagged. The settable range is 0 to 90.0 degrees tilt and the default is 45.0 degrees.

APPLICATION Application_n

Application_n selects pre-configured user settings optimized for a specific application. For the following values of n:

0 = Help

10 = Aviation

20 = Research

40 = Meteorology

225 = User defaults

The default application for the SkyVue PRO is 40, Meteorology. Settings adjusted by the APPLICATION command include settings in BS, MCFG, and UNITS.

BS

(see Measurement and message intervals for more information on compatibility of different parameters)

Attenuated_SCALE

BS_Av_Time,

Noise_Gate,

Measurement_ Period,

Rolling_Average,

Message_Interval

BS_Temporal_ Filter_Mode

Rules for BS command are:

BS_Av_Time <= Measurement_Period-1s.

Message_Interval must be a multiple of Measurement_Period.

Attenuated_SCALE is the scalar for the attenuated backscatter percent. 0.001 to 100% (default 100%)

BS_Av_Time is the backscatter average time in seconds. 1 to 30 (default 2).

Note: Must not be greater than Measurement_Period – 1.0

Noise_Gate controls the noise threshold applied to back-scatter.

Noise_Gate = -1000, all backscatter range is corrected.

Noise_Gate = 0.0 to 1000.0, standard deviation (default 2) for noise threshold. Only backscatter above this is range corrected.

Measurement_Period = 0 or 2 to 600 seconds (default 10). If set to 0 and the SkyVue PRO is polled, it will output the last measurement made. If between 2 and 600 seconds, the SkyVue PRO continually outputs messages. For sky condition output, Campbell Scientific recommends setting the measurement_Period ≤ 30 seconds. If a measurement_Period is greater than 30 seconds, the sky condition algorithm will be less able to resolve coverage for higher layers.

Note: Must be a sub multiple of Message_Interval

Rolling_Average = 1 to 29 (default 1). This is the number of measurement_periods to use in a rolling average of the backscatter.

Message_Interval is the message interval in seconds. Range is 2 to 600 seconds (default 10 s); 0 gives polled messages.

Note: Must be a multiple of Measurement_Period

BS_Temporal_ Filter_Mode allows the selection of backscatter filtering modes.

0 = Averaging

1 = Median signal processing

Default setting is 1, the median mode for aviation.

CLOSE

No parameters

Closes the terminal interface to allow normal message output and saves new settings to flash non-volatile storage.

CLOUDMODE CloudMode_A

CloudMode_A turns on a filter that reports the highest cloud during precipitation to avoid precipitation from being reported as low cloud.

0 = Filter Off

1 = Filter On (default). Reports the highest cloud during precipitation

DEFAULTS

No parameters

Loads factory defaults

GETUSER

 

Reads all user settings as a string of text. Parameters are read in the following order:

user = text user

volVer = user volume version

OS_VER = DSP OS version

PsuOsVer = PSU OS version

TopOsVer = TOP OS version

Id = SkyVue PRO ID

Pw = SkyVue PRO password

terminalCrc = terminal crc mode

terminalTimeout = terminal timeout

unitsTiltMode = units and tilt mode

hoodHBMode = hood heater / fan heater mode

hoodHBTestInt = hood heater / blower test interval in hours

battBoost_mV = boost voltage used for battery charging mV

battCharge_mA = battery charge current mA

psuPresent = PSU present switch

hoodHBNormSpeed = fan voltage for normal speed mV

hoodHBHighSpeed = fan voltage for high speed mV

hoodHBLowSpeed = fan voltage for low speed mV

intHMode = internal heater mode

message[0] = fields for message 0

message[1] = fields for message 1

message[2] = fields for message 2

message[3] = fields for message 3

message[4] = fields for message 4

messagePeriod = output message period in seconds

heightOffset= height offset meters

bsAvTime= backscatter average time in seconds

laserMode = laser operation mode

laserPower = laser power

laserHeater = laser heater mode

attenuatedSCALE = attenuated backscatter scaling factor

logInterval = debug logging interval

measurementPeriod = measurement interval in seconds

serMode = serial port mode

baudSel = serial port baud rate mode

dataParityStop = serial port parity mode

rx2txTimeout = serial port RX to TX turnaround time

snrMarginBoundary = onset of backscatter detection threshold

snrMarginDetector = cloud detection threshold

alphaGuessEnd = cloud alpha guess at boundary

alphaMin = cloud detection alpha minimum

Vcld_D = cloud detection

delta_Vcld_D = cloud detection

vis_Av_T = cloud detection

alphaGuess = visibility initial alpha guess

ratioLevel = visibility ratio

alphaMin = visibility alpha minimum

cap = visibility cap in meters

tiltLimit = tilt limit in degrees used by alarms

noiseGate = attenuated backscatter noise gate mode

vvLimit_percent = sky condition report vertical visibility %

alphaGuessStart= cloud detection alpha guess at lowest height bin

dt = mixing layer height temporal filter in minutes

dr = mixing layer height range filter in meters

q1threshold = mixing layer height quality threshold 1

q2threshold = mixing layer height quality threshold 2

q3threshold = mixing layer height quality threshold 3

stdWidth = mixing layer height standard deviation width meters

cloudMode = cloud detector mode parameter (03072019a)

CRC = 4-digit character. CRC calculated from the u up to but not including the CRC using the standard CRC-16.

Note: Many parameters are not adjusted. This command allows a reliable technique for copying full settings from one SkyVue PRO to another with the SETUSER command.

A typical response to the GETUSER command is:

>>>>> COPY FROM START OF NEXT LINE >>>>>

user 7 007638-6da 106 510 0 , 0 10 2 0 1 14520 400 1 1000 1000 2000 0 1 0 0 0 0 10 0.000E+00 2.000E+00 1 1.000E+00 0 1.000E+00 0 10 1 0 10 0 100 4.000E+00 6.000E+00 2.000E-03 2.500E-04 1.000E+03 2.200E+01 4.800E+03 1.000E-01 9.000E-01 2.500E-04 2.000E+03 4.500E+01 2.000E+00 50 2.00E-03 3.000E+01 1.500E+02 1.800E+00 5.000E+00 1.000E+01 150 98b2

<<<<< TO START OF THIS LINE <<<<<

HEATERS

Hood

Internal

Laser

Test_interval

Sets or reads heater settings as follows:

Hood = 0, Hood blower and heater OFF

Hood = 1, Hood blower ON and heater OFF

Hood = 2, Hood blower ON and heater ON

Hood = 3, Hood blower and heater AUTO (default) – (see note (1) below).

Internal = 0, Internal heater OFF

Internal = 1, Internal heater ON

Internal = 2, Internal heater AUTO (default)

Laser = 0, laser heater off

Laser = 1, laser heater on (default)

Test_interval = 1 to 168 hours (default 24 hours). Heater/Blower test interval

HELP

No parameters

Calls up a list of user commands with brief descriptions

HOFFSET

Height_offset

Height_offset is the offset to be added or subtracted in the range of ±1000 m (±3281 ft). Positive values are added to measured height and negative values are subtracted from measured height. The default is 0.

ID

Sensor_ID

Reads or sets the sensor ID, a single character, 0-9, a - z or A - Z, case sensitive. Default ID = 0.

Note: Lower case letters are not allowed if using a CT25K message.

LASER

Laser

Laser_Power

Laser = 0, laser off after power up (user must switch laser on)

Laser = 1, laser on after power up (default)

Laser_Power = 20% to 100%, default 100%

LASEROFF

No parameters

Instructs the SkyVue PRO to turn the laser off until either a power cycle or the sensor is instructed to turn the laser back on.

LASERON

No parameters

Instructs the SkyVue PRO to try and turn the laser on

LOADOS

Module

Loads new operating system into modules as follows:

Module =1, DSP.

Note: Operating systems earlier than 4 will need the boot loader updating. Refer to Loading a new operating system (OS) for more information.

Module =2

Module =3, PSU

Module =4, DSP, TOP, and PSU as one file. Only supported from operating system.

MCFG

Message_Interval

Message_ID_A

Message_ID_B

Message_ID_C

Message_ID_D

Message_ID_E

Set or read message configuration

Message_Interval is the message interval in seconds. Range is 2 to 600 s (default 10); 0 gives polled messages.

Note: This command may affect measurement parameters within the BS command. See Measurement and message intervals.

Message_ID is the message type to output between 0 and 999 (default 001). If Message_ID = 0, no message type is output. Up to five messages can be set (refer to MCFG command message types).

MLH (if available)

Temporal_Filter

Range_Filter

Std_Width

Q1_Threshold

Q2_Threshold

Q3_Threshold

Sets or reads parameters used in identifying mixing layer heights

Temporal_Filter = temporal filter half width used to filter data used by mixing layer height algorithm in minutes. Range is 1 to 40 minutes (default 30 minutes)

Range_Filter = range filter half width used to smooth data used by mixing layer height algorithm in meters or feet. Range is 15 m to 600 m or 49 ft to 1969 ft (default 150 m or 492 ft).

Std_Width = range half width used to calculate standard deviation of the slope in meters or feet. Range is 10 m to 400 m or 33 ft to 1312 ft (default 150 m or 492 ft).

Q1_Threshold = SNR threshold for quality level 1 mixing layer height output. Range is 1.0 to 30.0 (default 1.8)

Q2_Threshold = SNR threshold for quality level 2 mixing layer height output. Range is 1.0 to 30.0 (default 5.0).

Q3_Threshold = SNR threshold for quality level 3 mixing layer height output. Range is 1.0 to 30.0 (default 10.0).

OPEN

ID

Password

Opens the SkyVue PRO terminal mode

ID = Sensor ID as per the terminal ID command.

AnySkyVue PRO with OS OS2 or newer will respond to global ID = 99, regardless of its own ID number.

Password = The sensors user password as per the terminal PASSWORD command. The default is no password.

PASSWORD

Password

Sets or clears a password from 1 to 10 characters in length. Valid characters, 0-9, a - z or A – Z, and letters are case sensitive. Typing the PASSWORD command without any parameters clears the password. The default is no password.

POLL

Sensor_ID

Message_ID

Requests Message_ID from Sensor_ID.

Refer to Message polling for more information on this command

Note: If Message_ID is omitted, the SkyVue PRO outputs the message configured by MCFG.

POWEROFF

No parameters

Prepares the PSU to power down the SkyVue PRO even if the battery is connected. As soon as the mains supply is disconnected, the SkyVue PRO will power off and NOT run on battery back-up. The SkyVue PRO can be re-activated with battery back-up enabled by reconnecting the mains supply. You will be asked to confirm.

REBOOT

No parameters

Forces a system reboot. This will restore previously saved user settings. Any unsaved changes will be lost. (Settings are saved in the terminal mode when the CLOSE command is typed, which exits the terminal mode).

SCCAL

No parameters but user interaction required

Stratocumulus backscatter calibration.

This requires a human observer to confirm a stable Stratocumulus cloud layer between 250 m to 2500 m without holes, precipitation or reduced visibility and has been stable for at least 10 minutes prior to running this command. See Stratocumulus backscatter calibration for more information.

SERIAL

Mode

Baud

Bits_Parity

Delay

Set or read the serial port.

Mode = 0, RS-232, full duplex (default)

Mode = 1, RS-232, half duplex

Mode = 2, RS-485, full duplex

Mode = 3, RS-485, half duplex

Mode = 4, reserved

Mode = 5, RS-422, full duplex

Baud = 0, 300 baud

Baud = 1, 600 baud

Baud = 2, 1200 baud

Baud = 3, 2400 baud

Baud = 4, 4800 baud

Baud = 5, 9600 baud

Baud = 6, 19200 baud

Baud = 7, 38400 baud

Baud = 8, 57600 baud

Baud = 9, 76800 baud

Baud = 10, 115200 baud (default)

Bits_Parity = 0, 8 bits, no parity, 1 stop bit (default)

Bits_Parity = 1, 7 bits, even parity, 1 stop bit

Bits_Parity = 2, 7 bits, odd parity, 1 stop bit

Delay = delay time, in milliseconds, before transmitting (RS-485 half-duplex mode only). Range: 0 to 100 ms (default 100 ms).

SERVICE

No parameters but user intervention required

Performs a service procedure

SETUSER

String

Load all user settings as a string of text.

(not changed) = parameter will not be updated and the previously set value will persist.

String = user (not changed)

volVer = user volume version (not changed)

OS_VER = DSP OS version (not changed)

PsuOsVer = PSU OS version (not changed)

TopOsVer = TOP OS version (not changed)

Id = SkyVue PRO ID (not changed)

Pw = SkyVue PRO password (not changed)

terminalCrc = terminal crc mode

terminalTimeout = terminal timeout

unitsTiltMode = units and tilt mode

hoodHBMode = hood heater / fan heater mode

hoodHBTestInt = hood heater / blower test interval in hours

battBoost_mV = boost voltage used for battery charging mV

battCharge_mA = battery charge current mA

psuPresent = PSU present switch

hoodHBNormSpeed = Fan voltage for normal speed, mV

hoodHBHighSpeed = Fan voltage for high speed, mV

hoodHBLowSpeed = Fan voltage for low speed, mV

intHMode = internal heater mode

message[0] = fields for message 0

message[1] = fields for message 1

message[2] = fields for message 2

message[3] = fields for message 3

message[4] = fields for message 4

messagePeriod = output message period in seconds

heightOffset = height offset meters

bsAvTime = backscatter average time in seconds

laserMode = laser operation mode

laserPower = laser power

laserHeater = laser heater mode

attenuatedSCALE = attenuated backscatter scaling factor

logInterval = debug logging interval

measurementPeriod = measurement interval in seconds

serMode = serial port mode

baudSel = serial port baud rate mode

dataParityStop = serial port parity mode

rx2txTimeout = serial port RX to TX turnaround time

snrMarginBoundary = onset of back-scatter detection threshold

snrMarginDetector = cloud detection threshold

alphaGuessEnd = cloud alpha guess at boundary

alphaMin = cloud detection alpha minimum

Vcld_D = cloud detection

delta_Vcld_D = cloud detection

vis_Av_T = cloud detection

alphaGuess = visibility initial alpha guess

ratioLevel = visibility ratio

alphaMin = visibility alpha minimum

cap = visibility cap in meters

tiltLimit = tilt limit in degrees used by alarms

noiseGate = attenuated backscatter noise gate mode

vvLimit_percent = sky condition report vertical visibility %

alphaGuessStart = cloud detection alpha guess at lowest height bin

dt

dr

q1threshold = mixing layer height quality threshold 1

q2threshold = mixing layer height quality threshold 2

q3threshold = mixing layer height quality threshold 3

stdWidth = mixing layer height standard deviation width in meters

cloudMode = cloud detector mode parameter (03072019a)

CRC = 4-digit character. CRC calculated from the u up to but not including the CRC using the standard CRC‑16.

Note: String is added as text and should be cut and pasted from a stored file.

STATUS

No parameters

Outputs SkyVue PRO, serial number, ID, DSP OS version, Time and Date, DSP version, TOP OS version, PSU OS version, watch dog counts, serial parameters, blower heater mode, internal heater mode, message parameters, tilt angle, units, temperature/humidity, temperatures, supply voltages, height offset, visibility cap, laser run days, window parameters, backscatter parameters, MLH parameters, features, alarms, warnings, and status.

Note: Refer to Status command for more information on this command

TERMINAL

Terminal

Timeout

Sets the user terminal time out.

Timeout is the delay in minutes from 1 to 15 where the terminal will automatically close if no characters are sent to the SkyVue PRO. The default is 10 minutes.

TIME

Date_Time

Date is in the format yyyy/mm/dd

Time is in the format hh:mm:ss

yyyy=year, mm=month, dd=day

hh=hours, mm=minutes, ss=seconds

For example: time 2013/05/25 10:00:00, sets the date and time to May 25, 2013 at 10:00:00)

Note: The set time could drift by up to ±14 seconds a day.

UNITS

Units

Sets measurement units and tilt correction

Units = 0, meters corrected by tilt

Units = 1, meters not corrected by tilt

Units = 2, feet corrected by tilt (default)

Units = 3, feet not corrected by tilt

UNLOCK

Key

Key = a 12 digit key purchased from Campbell Scientific. The key unlocks features such as Mixing Layer Height assessment.

The key is specific to the individual SkyVue PRO and only has to be entered once.

VIS

Cap

Cap is the vertical visibility maximum range 100 to 10000 in meters or 328 to 32808 in feet (default 2000 m or 6561 ft).

NOTE:

If AUTO is set, then the heater / blower will heat to 80 °C if (sky condition > 1 okta coverage) or (cloud height < 3 km (9842 ft) AND sky condition > 1 okta coverage) OR window Tx < 80% OR precipitation detected. When the event has passed, the blower/heater will remain active at 80 °C for a further 15 minutes before going into a fan-off state and the heater temperature drops to an average of approximately 40 °C, ready to be activated again.