streamserial

Usage

Security

Open.

Description

If the logger is configured to support streamed data over the serial link, this command can turn the feature on or off, and also configure the behaviour of an auxiliary RS-232 control output, AUX1. If the command is given with no parameters, the value of the state parameter is reported. The operating parameters of the serial link, such as baud rate and mode, are accessed using the serial command. This commands reports the state of the streamed data feature, and optionally turns it on or off. When the feature is on, acquired data is sent over the serial link at the same time it is stored in memory. Refer to the outputformat command for descriptions of the data formats which may be available. When the feature is off, data is not sent. Changing the state of serial streaming while logging is in progress is permitted, but will cause a time-stamped event to be recorded in memory with the sample data.

state [= <state>]
1. on, enables the serial streaming.
2. off, disables the serial streaming.

The aux1_... options configure the behaviour of an auxiliary RS-232 output signal AUX1, if the logger is configured to support it. This signal is available only if the mode of the Serial link is set to RS-232; refer to the serial command for details.

The signal can be used to control an external device such as a modem, but is intended only for the purpose of transmitting streamed data. The logger may activate the signal during other transmissions on the serial link, but it is intended only for enabling a transmitting device for remote monitoring of send-data-only installations. It is not intended to be, and should not be used as, a general purpose flow control signal. Below are the descriptions of the individual command parameters.

aux1_all: a read-only option which causes the values of all the other aux1_... parameters to be reported.
aux1_state [= <state>]: reports the on/off state of the feature, or optionally enables or disables the feature as required. When the feature is disabled, the remaining aux1_... parameters have no effect. The default setting as shipped from the factory is off.
aux1_setup [= <setup_time>]: reports or sets the AUX1 signal set-up time, in milliseconds. When the logger is sampling and is about to stream data over the serial link, this is the time for which AUX1 will be set to the active level before the streaming transmission begins. The valid range of values is 10...120000 (10ms to 2 minutes); the default value as shipped from the factory is 1000ms.
aux1_hold [= <hold_time>]: reports or sets the AUX1 signal hold time, in milliseconds. This is the time for which AUX1 will be held at the active level after the serial streaming transmission has finished. The valid range of values is 10...120000 (10ms to 2 minutes); the default value as shipped from the factory is 1000ms.
aux1_active [= <activelevel>]: reports or sets the active level of the AUX1 signal seen by the external device during the setup time, data transmission and hold time, either high or low. The high and low signal levels are approximately +5V and –5V respectively, compatible with the RS-232 specification. The default setting as shipped from the factory is high.
aux1_sleep [= <sleeplevel>]: reports or sets the level of the AUX1 signal seen by the external device while the logger is asleep, either high, low or tristate. In the high and low states the signal is actively driven to the appropriate level by the logger, which may be necessary for some external devices. The high and low signal levels are approximately +5V and –5V respectively, compatible with the RS-232 specification. However, these two options cause a large increase in the logger's sleep current, and will severely impact the available deployment lifetime when using the logger's internal batteries. These options are not recommended for use unless the logger is run from an external power source for which a high sleep current does not matter. In the tristate condition, the signal is not actively driven, but becomes high impedance. This allows the logger to maintain a very low sleep current, but the external device must be able to enter the appropriate 'off' or 'sleep' state under these conditions. The default setting as shipped from the factory is tristate.

Examples

CODE

>> streamserial
<< streamserial state = off

>> streamserial state = on
<< streamserial state = on

CODE

>> streamserial aux1_all
<< streamserial aux1_state = on, aux1_setup = 2000, aux1_hold = 3000, aux1_active = high, aux1_sleep = tristate

>> streamserial aux1_setup = 500
<< streamserial aux1_setup = 500

Errors

Error E0108 invalid argument to command: '<invalid-argument>'
The supplied argument was not valid or out of place.

Error E0109 feature not available
The logger is not configured to support streaming over the serial link.