ecl-logo Documentation

RecordSensor

RecordSensor[sensor]object

generates a data object containing any data currently being measured by the provided sensor at the time the function is executed.

RecordSensor[sensor, Span[startDate,endDate]]object

generates a data object containing measurements from the sensor from the startDate to the endDate.

RecordSensor[sensor, targetDate]object

generates a data object containing all the measurements from the sensor on the given targetDate.

RecordSensor[instrument|container|sample, sensorType, Span[startDate,endDate]|targetDate]object

generates a data object containing measurements from a sensor of the given sensorType monitoring the provided instrument, container, or sample on the provided targetDate or from the provided startDate to the provided endDate.

RecordSensor[instrument|container|sample, Span[startDate,endDate]|targetDate]object

generates a data object containing measurements from all of the sensors monitoring the provided instrument, container, or sample on the provided targetDate or from the provided startDate to the provided endDate.

Details
  • Read sensor files or parses log files generated by ECL Sensor Array equipment
  • If LocationTracking option is set to False (default):
    - Only historical data from the sensors currently monitoring the 'target' will be returned.
    - Faster to execute.
    If LocationTracking option is set to True:
    - RecordSensor will track the location of the target between the 'startDate' and 'endDate' output data for the sensor monitoring the target at all time.
    Input
    Output
    General Options
    Messages
  • InactiveSensorSensors must be of Active Status in order to record from them. Status of Sensor `1` is currently marked as '`2`'.
    InvalidDailyLogDateCan not record a full daily log of the present day (must be at least one day in the past).
    InvalidDateOrderEnd date has to be later than start date.
    InvalidMaxVariationUnitsUnits for MaxVariation option do not match the output units for that sensor.
    InvalidOption'`1`' does not apply to historical data (only current measurements).
    InvalidSensorFieldNameThere is no '`1`' field in the '`2`' instrument object.
    InvalidTargetDateTarget date has to be in the past.
    NoDataNo sensor data was found for the selected date(s), so the sensor may not have been Active at that time.
    NoEnvironmentalSensorforTargetNo environmental sensors are currently monitoring '`1`'. Report this event to the scientific development team.
    NoNetworkConnectionUnable to establish connection to the network drive. Please double check that the computer has access to the path '`1`' or consult the IT manager.
    NoSensorForLocationUnable to find active sensors of type '`1`' moniting the object '`2`' at the requested time. Perhaps try a different date or sensor type.
    TimeoutReachedTimeout reached. Sensor output did not stabilized within specified parameters during the allocated time. Please file a ticket.
    WebServiceUnavailableThe Twincat Web service cannot be reached from this client. Please consult the IT manager.
  • Basic Examples  (3)

    Record current data from sensor object (singleton) :

    Record data from single sensor over time span :

    Record data at specific time point for one sensor:

    Additional Examples  (10)

    Record current data from sensor packet (singleton) :

    Record current data from sensor objects :

    Record data from multiple sensors over time span :

    Record data at specific time point for multiple sensors:

    Record data for a day for one single sensor:

    Record data for a day for multiple sensors:

    Record live environmental data on a target:

    Record live environmental data on a specific sensor on a target:

    Record environmental data on a target over span:

    Record environmental data on multiple targets over span:

    Options  (11)

    Record environmental data on a specific sensor on a target over span:

    DailyLogObject  (1)

    Record data objects that will eventually be parsed in future queries looking into historical data:

    FastTrack  (1)

    Record data from single sensor over time span using fast track :

    LocationTracking  (1)

    Record data from single sensor over time span using location tracking :

    MaxVariation  (1)

    Record data from instrument sensor, specifying MaxVariation:

    NumberOfReadings  (1)

    Specify NumberOfReading when looking at sensor field :

    Output  (1)

    Output values only over time span:

    ReadingInterval  (1)

    Record data from instrument sensor, specifying Reading Interval and NumberOfReadings:

    SensorField  (1)

    Record environmental data on a specific sensor on a target over span:

    Timeout  (1)

    Record data from instrument sensor, specifying Timeout:

    Upload  (1)

    Upload data object:

    Messages  (14)InactiveSensor  (1)

    Query data from an sensor object that is not Active:

    InvalidDailyLogDate  (1)

    Throw an error if trying to record a daily log of the current day:

    InvalidDateOrder  (1)

    Throw an error if end date is prior to start date:

    InvalidMaxVariationUnits  (2)

    Throw an error if the units specified for MaxVariation is incorrect:

    Throw an error if the units specified for MaxVariation is incorrect:

    InvalidOption  (1)

    Throw an error if options for live data are specified in historical data overload:

    InvalidSensorFieldName  (1)

    Invalid SensorField name:

    InvalidTargetDate  (1)

    Throw an error if target date is not in the past:

    NoData  (1)

    Throw an error if no data for specified date range:

    NoEnvironmentalSensorforTarget  (1)

    There are no sensor monitoring a target:

    NoNetworkConnection  (1)

    User does not have access to the public drive:

    NoSensorForLocation  (1)

    Throw an error if there is no sensor monitoring the target:

    TimeoutReached  (1)

    Throws an error if Timeout is reached before a data is recorded:

    WebServiceUnavailable  (1)

    Throws a relevant message if web service is lost:

    ReadSensor  MonitorSensor

    Made for Mathematica By Emerald Cloud Lab | Last modified in October 2018 | Authored By: guillaume