# Console Commands
In the Desktop application, using the Console allows you to use commands to directly communicate with the Instrument. It allows you to change settings and display information. We recommend working with these console commands only for advanced users or developers since they can be tricky.
Note
Some of the commands will introduce changes without warning, which could cause the Instrument to malfunction.
# Command Switches
Silent: s+ Sets command console in silent mode. Commands will not send back queries for user input. s+ will remain in effect until reset or user enters v+.
Verbose: v+ Sets command console in verbose mode. When available, commands will send back queries for user input. v+ will remain in effect until reset or user enters s+.
# Available Commands v2.0038
- Command Switches
- Available Commands v2.0038
- 1053
- battery
- compiled
- configure_bluetooth
- device_info
- digital_write
- expr
- flow_calibration_set_point
- flow_calibration_setting
- flow_calibration_value
- flow_off
- flow_v
- get_flow
- hall
- hello
- indicate
- indicate_off
- light
- memory
- on_5v
- p2p
- par_led
- print_all
- print_date
- print_magnetometer
- print_magnetometer_bias
- print_memory
- pulse
- readonce
- reboot
- reset
- reset_flow_calibration
- reset_flow_zero_point
- scan_i2c
- set_accelerometer
- set_accelerometer_bias
- set_colorcal1
- set_colorcal2
- set_colorcal3
- set_colorcal_blanks
- set_cp
- set_dac
- set_date
- set_default_flow_rate
- set_detector1_offset
- set_detector2_offset
- set_detector3_offset
- set_detector4_offset
- set_device_info
- set_energy_save_time
- set_flow
- set_led_par
- set_magnetometer
- set_magnetometer_bias
- set_op
- set_open_closed_positions
- set_par
- set_serial
- set_shutdown_time
- set_thickness
- set_thickness_quick
- set_user_defined
- single_pulse
- sleep
- start_watchdog
- stop_watchdog
- tcs_length
- temp
- testmode
- upgrade
- usb
# Other Versions (Archive)
# 1053
Continuous feed of roll, pitch, compass, direction, tilt and tilt direction. Cancel the command with -1+
Example:
1053
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# battery
Test the instruments battery with load returning the charge state in percent (%)
Example:
battery
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# compiled
Returns date and time for when the Firmware was compiled.
Example:
compiled
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# configure_bluetooth
Set the bluetooth name and baud rate
Example:
configure_bluetooth
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# device_info
Receive information from the Instrument, including name, version, id, battery level, firmware and configuration.
Alias: 1007
Example:
device_info
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# digital_write
Asks for address location and output value (0 or 1) and sets the digital address to this value. This is a dangerous if you do not know what you are doing.
Input: [number]
Values:
- 0 + 1
Example:
digital_write
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# expr
Example:
expr
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# flow_calibration_set_point
Alias: fcsp
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# flow_calibration_setting
Alias: fcv
Example:
flow_calibration_setting
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# flow_calibration_value
Alias: fcv
Example:
flow_calibration_value
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# flow_off
Set air flow to zero
Example:
flow_off
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# flow_v
Example:
flow_v
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# get_flow
Example:
get_flow
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# hall
Continues output of the hall sensor readings. Stop output using the command -1+
Example:
hall
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# hello
Check if your instrument is connected. On success the response is Instrument Ready.
Alias: 1000
Example:
hello
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# indicate
Sets the indicator LED (RGB LED). Values in the range from 0-255 need to be set for the Red, Green and Blue channel.
Input: [number]
Example:
indicate+<Red>+<Green>+<Blue>
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# indicate_off
Turn off indicator LED
Example:
indicate_off
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# light
Turn on 5V to turn on a light. Replace the <light number> with the number of a light, e.g. light1
Example:
light<light number>
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# memory
Returns the memory usage of the instrument.
Example:
memory
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# on_5v
Turn on 5V for 30 seconds
Example:
on_5v
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# p2p
Read multiple pulses with increasing intensity or pulse width for linearity test. With constant DAC value and pulse width, it is good for a pulse-to-pulse stdev test
Example:
p2p
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# par_led
Input: par_led
Example:
par_led
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# print_all
print everything in the eeprom (all values defined in eeprom.h)
Example:
print_all
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# print_date
Print date based on instruments RTC (if available).
e.g.2004-02-12T15:19:21.000Z
Example:
print_date
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# print_magnetometer
Example:
print_magnetometer
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# print_magnetometer_bias
Example:
print_magnetometer_bias
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# print_memory
Print all calibration values as they are saved to the instruments storage (EEPROM). Output is formated as a JSON with a checksum.
Alias: print_calibrations
Example:
print_memory
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# pulse
Example:
pulse
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# readonce
Access write once flash
Example:
readonce
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# reboot
Example:
reboot
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# reset
Reboot the instrument.
Alias: 1027
Example:
reset
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# reset_flow_calibration
Set air flow calibration to factory settings
Example:
reset_flow_calibration
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# reset_flow_zero_point
Example:
reset_flow_zero_point
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# scan_i2c
Scan for available i2c devices.
Example:
scan_i2c
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_accelerometer
Example:
set_accelerometer
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_accelerometer_bias
Example:
set_accelerometer_bias
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_colorcal1
Example:
set_colorcal1
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_colorcal2
Example:
set_colorcal2
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_colorcal3
Example:
set_colorcal3
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_colorcal_blanks
Example:
set_colorcal_blanks
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_cp
Set the close position of the leave clamp.
Example:
set_cp+
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_dac
Set DAC addresses to 1,2,3 assuming addresses are unset and all are factory (0,0,0).
Example:
set_dac
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_date
Set the date of the RTC of the instrument (if available)
Example:
set_date+
hours+min+sec+day+month+year
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_default_flow_rate
Input: [number]
Example:
set_default_flow_rate+<number>
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_detector1_offset
Example:
set_detector1_offset
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_detector2_offset
Example:
set_detector2_offset
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_detector3_offset
Example:
set_detector3_offset
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_detector4_offset
Example:
set_detector4_offset
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_device_info
Set the device name
Alias: 1008
Example:
set_device_info
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_energy_save_time
Input: [number]
Example:
set_energy_save_time+<number>
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_flow
Input: [number]
Example:
set_flow
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_led_par
Example:
set_led_par
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_magnetometer
Example:
set_magnetometer
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_magnetometer_bias
Example:
set_magnetometer_bias
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_op
Set the open position of the leaf clamp.
Example:
set_op+
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_open_closed_positions
Input: set_open_closed_positions
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_par
Example:
set_par
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_serial
Example:
set_serial
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_shutdown_time
Sets the time (in seconds) before the device automatically shuts down to save energy.
Input: [number]
Example:
set_shutdown_time+<seconds>
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_thickness
Example:
set_thickness
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_thickness_quick
Example:
set_thickness_quick
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# set_user_defined
Save a user defined value to the EEPROM. You can abort the input using -1+.
Example:
set_user_defined+<EEPROM Location>+<value>
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# single_pulse
Read and analyze noise on ADC from a single LED pulse (only in testmode).
Example:
single_pulse
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# sleep
Puts instrument into sleep mode. Hold the button for at least 5s to wake it up.
Example:
sleep
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# start_watchdog
Example:
start_watchdog
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# stop_watchdog
Example:
stop_watchdog
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# tcs_length
Example:
tcs_length
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# temp
Return the readings for both BME280 sensors including temperature and relative humidity.
Example:
temp
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# testmode
Example:
testmode
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# upgrade
Start over the air firmware update. The instrument is waiting for the new firmware to be transfered to the instrument.
Alias: 1078
Example:
upgrade
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019
# usb
Check, if the Instrument is connected via USB
Example:
usb
Instruments:
MultispeQ 1 MultispeQ 2
Last Updated: December 17, 2019