uvled

Usage

>> uvled

[ id | scheduled | powerondelay | poweroffdelay | interval | duration | command | timetoepisode | startimmediate | operatingtime | episodelog ]

Security

Description

This is a specialized command available in firmware versions 1.130 or later.  It is used to return information about, and to allow some control over, the UV-LED antifouling device used in the RBRconcerto³ CTD|UV data logger, and other instruments equipped with the UV antifouling feature.  If the command is sent to an instrument that does not have the UV antifouling feature, the instrument will respond with an error message:

Error E0114 feature not supported by hardware

The following options are available for use with this command.

• id reports (read-only) the type of UV-device configured to be used with the instrument.
  
• scheduled [= true | false] reports or sets whether or not the UV-LED schedule is enabled for use.  The UV-LEDs can always be operated by user commands at any time, provided adequate power is available.
  
  • true: the UV-LED schedule is enabled for the current or next deployment.

  • false: the UV-LED schedule is not enabled.  This is the as-shipped factory default, for safety reasons when shipping.

• powerondelay reports (read-only) the startup time for the UV-LEDs in milliseconds.  

• poweroffdelay reports (read-only) the shut down time for the UV-LEDs in milliseconds.  

• interval [= <milliseconds>] reports or sets the interval between UV-LED episodes in milliseconds.
  • Minimum interval is 60000, or 1 minute. 
  • The maximum interval is 3888000000, corresponding to 45 days.
  • Only values rounded to the minute are valid, so the number must be a multiple of 60000. 
  • The interval must be greater than the duration. 
  • The as-shipped factory default value is 600000ms, or 10 minutes.
• duration [= <milliseconds>] reports or sets the duration of an UV-LED episode in milliseconds.
  • Minimum duration is 1000 (1 second).
  • Maximum is 86400000 milliseconds, which corresponds to 1 day.
  • The duration must be less than the interval period. 
  • Only values rounded to the second are valid, so the number must be a multiple of 1000.
  • The factory default value is 1000ms, or 1 second.

• command [= <command>] sends a particular command to the UV-LED device; <command> can be one of the following options.  In all cases, the system typically responds within 1 second.

  • activate, turns the UV-LEDs ON.

  • deactivate, turns the UV-LEDs OFF.

  • status, reports the current ON/OFF state of the UV-LEDs.
    - activated
    - deactivated
    

• timetoepisode reports (read-only) the time remaining until the start of the next scheduled UV-LED episode.  The value is reported in milliseconds, but only to a resolution of one second.  If the UV-LED schedule is not enabled, the response is uvled timetoepisode = n/a.  During an active schedule, the value reported can range from 1000 up to interval milliseconds.  If the schedule is enabled but logging has not yet started, the reported value will reflect the time until the start of the first episode, correctly accounting for the setting of the startimmediate parameter (see below).  This reported value may be longer than the interval, of course.
• startimmediate [= true | false] reports or sets the point in the schedule at which the first UV-LED episode will occur.
  • true: this is the factory default; a UV-LED episode will occur at the start of the schedule, or following a reset.  Normally, there may be a delay of up to 1 minute, because episodes are constrained to start on a 1-minute boundary according to the instrument's internal clock.  However in some situations it is possible for an episode to start immediately the instrument is enabled for sampling.

  • false: the first UV-LED episode will be delayed by one interval after the start of the schedule or a reset. 

• operatingtime reports (read-only) in milliseconds the cumulative time for which the UV-LEDs have been energized since configuration at the Factory.  The optical output power of the UV-LEDs reduces over time, and this parameter can be used to make decisions about whether the LEDs should be refurbished or replaced.

• episodelog [= on | off ] can be used to enable, disable, or report whether UV-LED events will be recorded in the instrument's memory when data logging is enabled.  Events occurring outside the data logging deployment are never recorded.  When episodelog = on, an event will be recorded in memory during the deployment each time an attempt is made to change the state of the UV-LEDs, whether successful or not.  This applies to both scheduled events and manually commanded events.  Each event contains information to show whether the UV-LEDs were turned on, or turned off, or whether some error occurred in the attempt.  The default setting of this parameter is episodelog = on, and it is recommended to keep this setting in normal circumstances so that a record of UV-LED activity is preserved.  If desired, it can be turned off for test purposes, or at very low sample rates where the number of episode events is comparable to the number of samples.

Examples