ModularSensors > Files > sensors / YosemitechY550.h

YosemitechY550.h file

Contains the YosemitechY550 sensor subclass and the variable subclasses YosemitechY550_COD, YosemitechY550_Temp, and YosemitechY550_Turbidity.

These are for the Yosemitech Y550 COD sensor with wiper.

This depends on the YosemitechParent super class.

Documentation for the Modbus Protocol commands and responses can be found within the documentation in the YosemitechModbus library at: https://github.com/EnviroDIY/YosemitechModbus

Classes

class YosemitechY550
The Sensor sub-class for the Yosemitech Y550-B UV254/COD sensor with wiper.
class YosemitechY550_COD
The Variable sub-class used for the carbon oxygen demand (COD) output from a Yosemitech Y550-B UV254/COD sensor with wiper.
class YosemitechY550_Temp
The Variable sub-class used for the temperature output from a Yosemitech Y550-B UV254/COD sensor with wiper.
class YosemitechY550_Turbidity
The Variable sub-class used for the turbidity output from a Yosemitech Y550-B UV254/COD sensor with wiper.

Defines

#define Y550_NUM_VARIABLES = 2
Sensor::_numReturnedValues; the Y550 can report 2 values.

Sensor Timing

The sensor timing for a Yosemitch Y550

#define Y550_WARM_UP_TIME_MS = 1500
Sensor::_warmUpTime_ms; time before sensor responds after power - 1500ms.
#define Y550_STABILIZATION_TIME_MS = 2000
Sensor::_stabilizationTime_ms; time between "StartMeasurement" command and stable reading - 2sec.
#define Y550_MEASUREMENT_TIME_MS = 2000
Sensor::_measurementTime_ms; the Y550 takes ~2000ms to complete a measurement.

Carbon Oxygen Demand

The COD variable from a Yosemitch Y550

  • Range is:
    • 0.75 to 370 mg/L COD (equiv. KHP)
    • 0.2 to 150 mg/L TOC (equiv. KHP)
  • Accuracy is not reported on sensor datasheet

YosemitechY550_COD(YosemitechY550* parentSense, const char* uuid = "", const char* varCode = Y550_COD_DEFAULT_CODE) explicit

Construct a new YosemitechY550_COD object.

Parameters
parentSense The parent YosemitechY550 providing the result values.
uuid A universally unique identifier (UUID or GUID) for the variable; optional with the default value of an empty string.
varCode A short code to help identify the variable in files; optional with a default value of "Y550COD".

#define Y550_COD_RESOLUTION = 2
Decimals places in string representation; cod should have 2 - resolution is 0.01 mg/L COD.
#define Y550_COD_VAR_NUM = 0
Sensor variable number; COD is stored in sensorValues[0].
#define Y550_COD_VAR_NAME = "COD"
Variable name in ODM2 controlled vocabulary; "COD".
#define Y550_COD_UNIT_NAME = "milligramPerLiter"
Variable unit name in ODM2 controlled vocabulary; "milligramPerLiter" (mg/L)
#define Y550_COD_DEFAULT_CODE = "Y550COD"
Default variable short code; "Y550COD".

Temperature

The temperature variable from a Yosemitch Y550

  • Range is 5°C to + 45°C
  • Accuracy is ± 0.2°C

YosemitechY550_Temp(YosemitechY550* parentSense, const char* uuid = "", const char* varCode = Y550_TEMP_DEFAULT_CODE) explicit

Construct a new YosemitechY550_Temp object.

Parameters
parentSense The parent YosemitechY550 providing the result values.
uuid A universally unique identifier (UUID or GUID) for the variable; optional with the default value of an empty string.
varCode A short code to help identify the variable in files; optional with a default value of "Y550Temp".

#define Y550_TEMP_RESOLUTION = 2
Decimals places in string representation; temperature should have 2 - resolution is 0.01°C.
#define Y550_TEMP_VAR_NUM = 1
Sensor variable number; temperature is stored in sensorValues[1].
#define Y550_TEMP_VAR_NAME = "temperature"
Variable name in ODM2 controlled vocabulary; "temperature".
#define Y550_TEMP_UNIT_NAME = "degreeCelsius"
Variable unit name in ODM2 controlled vocabulary; "degreeCelsius" (°C)
#define Y550_TEMP_DEFAULT_CODE = "Y550Temp"
Default variable short code; "Y550Temp".

Turbidity

The turbidity variable from a Yosemitch Y550

  • Range is 0.1~1000 NTU
  • Accuracy is <5% or 0.3NTU

YosemitechY550_Turbidity(YosemitechY550* parentSense, const char* uuid = "", const char* varCode = Y550_TURB_DEFAULT_CODE) explicit

Construct a new YosemitechY550_Turbidity object.

Parameters
parentSense The parent YosemitechY550 providing the result values.
uuid A universally unique identifier (UUID or GUID) for the variable; optional with the default value of an empty string.
varCode A short code to help identify the variable in files; optional with a default value of "Y550Turbidity".

#define Y550_TURB_RESOLUTION = 2
Decimals places in string representation; turbidity should have 2 - resolution is 0.01 NTU.
#define Y550_TURB_VAR_NUM = 2
Sensor variable number; turbidity is stored in sensorValues[2].
#define Y550_TURB_VAR_NAME = "turbidity"
Variable name in ODM2 controlled vocabulary; "turbidity".
#define Y550_TURB_UNIT_NAME = "nephelometricTurbidityUnit"
Variable unit name in ODM2 controlled vocabulary; "nephelometricTurbidityUnit" (NTU)
#define Y550_TURB_DEFAULT_CODE = "Y550Turbidity"
Default variable short code; "Y550Turbidity".