instrument

Usage

>> instrument dump

>> instrument factory reset

>> instrument outputformat

>> instrument power [internal external]

>> instrument reboot

Security

Open.

Description

Reports some general information about the instrument:

state=<state>: the state of the instrument. The possible states are:
- disabled: The instrument has not been enabled. It is not actively running a deployment.
- enabled: The enable command has been issued and the instrument is now running a deployment.
sn=<serial_number> serial number is always reported using six digits, padded with leading zeroes if necessary; for example 092431.
model, model name of the instrument; for example, RBRconcerto4.
pn=<part_number>: The RBR part number of the instrument
fwversion, firmware version in <major>.<minor>.<patch>format; for example, 1.14.5.
fwlock=<on|off>: Indicates if firmware can be updated on the instrument or if it is locked to a specific version.
- The fwlock parameter is set at the factory, and for most instruments it is off, which means that the standard method of updating instrument firmware using the Ruskin software can be used. For some OEM applications requiring that the version of firmware does not change, the fwlock is set to on, which prevents firmware updates by the standard method. If necessary, a special procedure can be used to override this 'locked' state; please contact RBR Ltd if you believe you need to do this.
datatype is the numeric format used to store data values in the memory for all channels. For normal deployments this will be either float32 (IEEE single precision floating point) or float64 (IEEE double precision floating point). This setting is factory configured; most instruments will use float32, but an instrument with very high precision sensors may use float64 to maintain the necessary level of resolution.
There is a third format used for calibration purposes, calfloat64; this format is the same numerically as float64, but no calibration equation is applied to the data. It is presented as a ratio compared to nominal full-scale, so the expected range is nominally 0.0 to 1.0. The full theoretical range is -2.0 to +2.0 but the output of most channels will remain within or close to the expected nominal range. The format calfloat64 will be reported only during a deployment that was enabled using storagemode=calibration; refer to the enable command for more details.

fwtype=<firmware_type> is a read-only parameter giving the firmware type code. Possible values are:
- 120 for L3.5 instruments

Examples

TEXT

>> instrument
<< instrument state=disabled sn=210000 model=RBRconcerto3 pn=L3-M13-F15-BEC12-INT12-SCT16-SP11 fwversion=2.1.0 fwtype=120 fwlock=off datatype=float32

The instrument has not been enabled. It is not actively running a deployment. The firmware is not locked to a specific version.

TEXT

>> enable config=profiling dataset=Trial_2
<< enable config=profiling dataset=Trial_2 storagemode=normal state=enabled
>> instrument
<< instrument state=enabled sn=210000 model=RBRconcerto3 pn=L3-M13-F15-BEC12-INT12-SCT16-SP11 fwversion=2.1.0 fwtype=120 fwlock=off datatype=float32

The enable command has been issued and the instrument is now running a deployment. The firmware is not locked to a specific version.

TEXT

>> instrument
<< instrument state=enabled sn=210000 model=RBRconcerto3 pn=L3-M13-F15-BEC12-INT12-SCT16-SP11 fwversion=2.1.0 fwtype=120 fwlock=off datatype=float32

>> disable
<< disable state=disabled

>> instrument
<< instrument state=disabled sn=210000model=RBRconcerto3 pn=L3-M13-F15-BEC12-INT12-SCT16-SP11 fwversion=2.1.0 fwtype=120 fwlock=off datatype=float32

The instrument was enabled, the disable command was issued and the instrument transitioned to the disabled state. The instrument is no longer running a deployment.

CODE

>> instrument
<< instrument state=disabled sn=210000 model=RBRconcerto3 pn=L3-M13-F15-BEC12-INT12-SCT16-SP11 fwversion=2.1.0 fwtype=120 fwlock=on datatype=float32

The instrument has not been enabled. It is not actively running a deployment. The firmware is locked to a specific version so Ruskin will not be allowed to update it.