ModularSensors > Files > sensors / YosemitechY532.h

YosemitechY532.h file

Contains the YosemitechY532 sensor subclass and the variable subclasses YosemitechY532_pH, YosemitechY532_Temp, and YosemitechY532_Voltage.

These are for the Yosemitech Y532 pH sensor.

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 YosemitechY532
The Sensor sub-class for the Yosemitech Y532-A digital pH sensor.
class YosemitechY532_pH
The Variable sub-class used for the pH output from a Yosemitech Y532-A digital pH sensor.
class YosemitechY532_Temp
The Variable sub-class used for the temperature output from a Yosemitech Y532-A digital pH sensor.
class YosemitechY532_Voltage
The Variable sub-class used for the electrode electrical potential output from a Yosemitech Y532-A digital pH sensor.

Defines

#define Y532_NUM_VARIABLES = 3
Sensor::_numReturnedValues; the Y532 can report 3 values.

Sensor Timing

The sensor timing for a Yosemitch Y532

#define Y532_WARM_UP_TIME_MS = 500
Sensor::_warmUpTime_ms; time before sensor responds after power - 500ms.
#define Y532_STABILIZATION_TIME_MS = 4500
Sensor::_stabilizationTime_ms; time between "StartMeasurement" command and stable reading - 4.5sec (4500ms).
#define Y532_MEASUREMENT_TIME_MS = 1800
Sensor::_measurementTime_ms; the Y532 takes ~1800ms to complete a measurement.

pH

The pH variable from a Yosemitch Y532

  • Range is 2 to 12 pH units
  • Accuracy is ± 0.1 pH units

YosemitechY532_pH(YosemitechY532* parentSense, const char* uuid = "", const char* varCode = Y532_PH_DEFAULT_CODE) explicit

Construct a new YosemitechY532_pH object.

Parameters
parentSense The parent YosemitechY532 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 "Y532pH".

#define Y532_PH_RESOLUTION = 2
Decimals places in string representation; pH should have 2 - resolution is 0.01 pH units.
#define Y532_PH_VAR_NUM = 0
Sensor variable number; pH is stored in sensorValues[0].
#define Y532_PH_VAR_NAME = "pH"
Variable name in ODM2 controlled vocabulary; "pH".
#define Y532_PH_UNIT_NAME = "pH"
Variable unit name in ODM2 controlled vocabulary; "pH" (dimensionless pH units)
#define Y532_PH_DEFAULT_CODE = "Y532pH"
Default variable short code; "Y532pH".

Temperature

The temperature variable from a Yosemitch Y532

  • Range is 0°C to + 50°C
  • Accuracy is ± 0.2°C

YosemitechY532_Temp(YosemitechY532* parentSense, const char* uuid = "", const char* varCode = Y532_TEMP_DEFAULT_CODE) explicit

Construct a new YosemitechY532_Temp object.

Parameters
parentSense The parent YosemitechY532 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 "Y532Temp".

#define Y532_TEMP_RESOLUTION = 1
Decimals places in string representation; temperature should have 1 - resolution is 0.1°C.
#define Y532_TEMP_VAR_NUM = 1
Sensor variable number; temperature is stored in sensorValues[1].
#define Y532_TEMP_VAR_NAME = "temperature"
Variable name in ODM2 controlled vocabulary; "temperature".
#define Y532_TEMP_UNIT_NAME = "degreeCelsius"
Variable unit name in ODM2 controlled vocabulary; "degreeCelsius" (°C)
#define Y532_TEMP_DEFAULT_CODE = "Y532Temp"
Default variable short code; "Y532Temp".

Voltage

The voltage variable from a Yosemitch Y532

  • Range is -999 ~ 999 mV
  • Accuracy is ± 20 mV

YosemitechY532_Voltage(YosemitechY532* parentSense, const char* uuid = "", const char* varCode = Y532_VOLTAGE_DEFAULT_CODE) explicit

Construct a new YosemitechY532_Voltage object.

Parameters
parentSense The parent YosemitechY532 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 "Y532Potential".

#define Y532_VOLTAGE_RESOLUTION = 0
Decimals places in string representation; voltage should have 0 - resolution is 1mV.
#define Y532_VOLTAGE_VAR_NUM = 2
Sensor variable number; voltage is stored in sensorValues[2].
#define Y532_VOLTAGE_VAR_NAME = "voltage"
Variable name in ODM2 controlled vocabulary; "voltage".
#define Y532_VOLTAGE_UNIT_NAME = "millivolt"
Variable unit name in ODM2 controlled vocabulary; "millivolt" (mV)
#define Y532_VOLTAGE_DEFAULT_CODE = "Y532Potential"
Default variable short code; "Y532Potential".