NAV Navbar
Logo
cpp python shell

Introduction

The ISE (Ion Specific Electrode) Probe Interface can be used to read any probe that outputs a voltage in the range of -2.5 volts to 2.5 volts. pH and ORP are supported with specific libraries, but it is very easy to use another voltage based probe by extending the library.

Multiple ISE interface boards can be connected to a controlling device at the same time. They do not interfere with each other. For example, a pH and ORP probe can be connected to the same device and in the same solution to be measured without causing cross-probe interference.

Characteristics

Connections

I2C Connections

Connection to the device is as follows:

ISE Probe Interface Master device
GND GND
SCL SCL
SDA SDA
3.3/5v 3.3 - 5V

Temperature Probe Connections

The temperature probe comes with a 3-wire header; any 3-wire DS18B20 will work. The VCC pin is labeled with a triangle:

EC Salinity Probe Temperature Probe
▲ (VCC ▲
(Data) (pin 2)
(GND) (pin 3)

Getting Started

To start developing with the device, you need to install a library. Three are provided, one for the Arduino framework, one for python3 on the Raspberry Pi, and one for MicroPython.

Raspberry Pi

Before you can run anything, you will need to enable software I2C, as the Pi’s hardware implementation has a clock-stretching bug that will prevent it from working with the pH probe.

  1. sudo nano /boot/config.txt and scroll to the bottom
  2. Add

dtoverlay=i2c-gpio,i2c_gpio_sda=<pin>,i2c_gpio_scl=<pin

replacing <pin> with whatever pin you’d like to use. Refer here for the pin functions, you will need to use the orange GPIO xx labels in the picture to locate the pins. As an example, to use GPIO 17 as SDA and GPIO 27 as SCL, your line will look like this

dtoverlay=i2c-gpio,i2c_gpio_sda=17,i2c_gpio_scl=27

Alternatively, you can choose to use the existing I2C pins, but using a software implementation of I2C, by pasting dtoverlay=i2c-gpio. If you go this route, you will need to edit line #4 from

ph = phprobe(3), to ph = phprobe(1)

  1. ctrl + x to exit, y to save, and enter to confirm the filename.
  2. Reboot

The shell Example

An interactive shell interface is provided and is a quick and easy way to get started using the device. You will find the equivalent commands in the code area to the right when applicable. Upload it to your master device and start a serial terminal. You will be presented with a > prompt where you can enter commands and receive a response, similar to a shell command line or REPL. It is often quicker to experiment this way rather than rewriting, compiling, and uploading new versions every time.

Changing the I2C Address

If needed, the I2C address can be changed by calling setI2CAddress(). The device will permanently change it’s address and continue to use it after a power reset. If you forget the new address, you will need to use an I2C bus scanner to locate it again.

Calibration

There are two calibration options, single point and dual point. Single point calibration is a simple offset to the measured value and uses the following equation: adjusted value = measured value - (measured value * offset). It is best suited for a sensor that displays linear measurements. Dual point calibration is used when the probe results are not linear over the entire range. Two points are selected, the high and low end of expected measurements. The formula is essentially the Arduino’s map() function.

Single Point

ISE_Probe ISE;

ISE.calibrateSingle(20);

from iseprobe import iseprobe

ISE = iseprobe(3)

ISE.calibrateSingle(20)

  cal 7.0

Single point calibration is done in the mV unit. To begin a single point calibration, submerge the probe and wait for the readings to stabilize. Then call calibrateSingle and pass the value the probe should be reading in mV. After calling it, the results are saved in the device’s EEPROM and used automatically.

As an example, if an ORP probe is reading 200 mV in a 300 mV solution, call calibrateSingle(300).

Dual Point

Alternatively, you can use dual point calibration between two predesignated points. Two calibration solutions are required, the low and high values in mV you expect to measure between.

ISE.calibrateProbeLow(0);  // after measurement, clean probe and place in high solution
ISE.calibrateProbeHigh(140);
ISE.useDualPoint(true);

ISE.calibrateProbeLow(0) # after measurement, clean probe and place in high solution
ISE.calibrateProbeHigh(140)
ISE.useDualPoint(True)

  low 0
  high 140
  dp 1
  1. Determine the lowest and highest measurement you expect. For example, the lowest level you might measure would be 0 mV and the highest might be 140 mV. These points will be referred to as referenceLow and referenceHigh
  2. Put the probe in a calibration solution at referenceLow and wait for readings to stabilize, call calibrateProbeLow(0). Do the same for referenceHigh by calling calibrateProbeHigh(140).
  3. By default, the device does not use dual points. A call to useDualPoint() must be made to enable it. Once set, it will continue to use it automatically.

You can also set all four values directly using setDualPointCalibration().

ISE.useDualPoint(false);

ISE.useDualPoint(False)

  dp 1

Use

Temperature Compensation

ISE.useTempCompensation(true);

ISE.useTempCompensation(True)

  tc 1
  tc 0

Temperature compensation can be used to adjust for the temperature effect on the probe. The device itself doesn’t contain any firmware that adjusts the readings, that is left to be implemented by the probe-specific libraries. However, this is a saved setting on the device. The pH library checks this value and if true, will take a temperature reading and adjust the measured pH accordingly.

Measurement Time

A mV measurement takes 1.5 seconds. A temperature measurement takes 750ms.

Probe Maintenance

Probes require regular care. There is a fluid junction that makes an electrical connection with the solution to be measured. If a probe is left continuously submerged, the junction could potentially leak the buffer fluid from inside the probe. The concentration of sodium chloride could change over time, slowly decreasing accuracy. This can be compensated for by recalibrating the probe, but eventually, the probe will no longer be serviceable.

The junction can become clogged by debris or buildup. To clear a clogged junction, soak the probe in a 1:1 bleach solution. You can also use vinegar to help remove deposits on the probe.

More Help

If you have any questions, find a bug, or have any suggestions on improvements, go to this project’s GitHub page and submit an Issue or Pull Request. Or you can send an email to questions@ufire.co.

Class Members

public float tempC

Temperature in C

public float tempF

Temperature in F

public long mV

Milli-volts from pH probe

Class Functions

float measuremV()

Starts a mV measurement.

ISE_Probe::measuremV();

ISE.measuremV()

mv

Returns

the measured result in mV

float measureTemp()

Starts a temperature measurement.

ISE_Probe::measureTemp();

ISE.measureTemp()

temp

tempC and tempF are updated

A value of -127 means the device is not connected.

Returns

temperature in C

void calibrateSingle(float solutionmV)

Calibrates the probe using a single point using a mV value.

ISE_Probe::calibrateSingle(200);

ISE.calibrateSingle(200)

cal 200

The result will be saved in the device’s EEPROM and used automatically.

void calibrateProbeLow(float solutionmV)

Calibrates the dual-point values for the low reading, in mV, and saves them in the devices’s EEPROM.

ISE_Probe::calibrateProbeLow(0);

ISE.calibrateProbeLow(0)

low 0

Parameters

void calibrateProbeHigh(float solutionmV)

Calibrates the dual-point values for the high reading, in mV, and saves them in the devices’s EEPROM.

ISE_Probe::calibrateProbeHigh(200);

ISE.calibrateProbeHigh(200)

high 200

Parameters

void setDualPointCalibration(float refLow,float refHigh,float readLow,float readHigh)

Sets all the values, in mV, for dual point calibration and saves them in the devices’s EEPROM.

ISE_Probe::setDualPointCalibration(0, 200, 3, 230);

ISE.setDualPointCalibration(0, 200, 3, 230)

Parameters

float getCalibrateOffset()

Returns the single-point offset from the device.

float offset = ISE_Probe::getCalibrateOffset();

offset = ISE.getCalibrateOffset()

cal

Returns

the probe’s offset

void useTemperatureCompensation(bool b)

Configures the device to use temperature compensation.

ISE_Probe::useTemperatureCompensation(true);

ISE.useTemperatureCompensation(True)

tc 1

Parameters

bool usingTemperatureCompensation()

Determines if temperature compensation is being used.

bool usingTemp = ISE_Probe::usingTemperatureCompensation();

usingTemp = ISE.usingTemperatureCompensation()

tc

Returns

true if using compensation, false otherwise

void useDualPoint(bool b)

Configures device to use dual-point calibration.

ISE_Probe::useDualPoint(true);

ISE.useDualPoint(True);
```shell
dp 1

Parameters

bool usingDualPoint()

Determines if dual point calibration is being used.

bool usingTemp = ISE_Probe::usingDualPoint();

usingTemp = ISE.usingDualPoint()

dp

Returns

true if using compensation, false otherwise

float getCalibrateHighReference()

Returns the dual-point calibration high reference value.

float calHigh = ISE_Probe::getCalibrateHighReference();

calHigh = ISE.getCalibrateHighReference()

high

Returns

the dual-point calibration high reference value

float getCalibrateLowReference()

Returns the dual-point calibration low reference value.

float calLow = ISE_Probe::getCalibrateLowReference();

calLow = ISE.getCalibrateLowReference()

low

Returns

the dual-point calibration low reference value

uint8_t getVersion()

Returns the firmware version of the device.

uint8_t version = ISE_Probe::getVersion();

version = ISE.getVersion()

version

Returns

version of firmware

void reset()

Resets all the stored calibration information.

pH Measurement

The ISE Probe Interface can measure pH with a pH probe attached. Including #include "ISE_pH.h" will give access to all of the previously described API functions, in addition to measurepH(). calibrateSingle(), calibrateProbeLow(), and calibrateProbeHigh() take a pH unit value rather than a mV value if using the pH library.

float measurepH()

Starts a pH measurement.

ISE_pH::measurepH();

pH.measurepH()

Returns

the measured result in pH

-1 is returned if there is an error

void calibrateSingle(float solutionpH)

Calibrates the probe using a single point using a pH value.

ISE_pH::calibrateSingle(7.0);

pH.calibrateSingle(7.0)

cal 7.0

The result will be saved in the device’s EEPROM and used automatically.

void calibrateProbeLow(float solutionpH)

Calibrates the dual-point values for the low reading, in pH, and saves them in the devices’s EEPROM.

ISE_pH::calibrateProbeLow(4.0);

pH.calibrateProbeLow(4.0)

low 4.0

Parameters

void calibrateProbeHigh(float solutionpH)

Calibrates the dual-point values for the high reading, in pH, and saves them in the devices’s EEPROM.

ISE_pH::calibrateProbeHigh(10.0);

pH.calibrateProbeHigh(10.0)

high 10.0

Parameters

ORP Measurement

The ISE Probe Interface can measure ORP with an ORP probe attached. Including #include "ISE_ORP.h" will give access to all of the previously described API functions, in addition to measureORP(). Additionally, Eh is calculated; two methods are included for Eh, setProbePotential() and getProbePotential().

float measureORP()

Starts an ORP measurement. ISE_ORP::ORP and ISE_ORP::Eh are updated.

ISE_ORP::measureORP();

ORP.measureORP()

Returns

the measured result in mV

void setProbePotential(uint32_t probePotential)

Saves the connected probe’s potential in EEPROM so that Eh can be calculated. After setting this value, the class member ISE_ORP::Eh is automatically updated with each call to measureORP().

ISE_ORP::setProbePotential(195);

ORP.setProbePotential(195)

uint32_t getProbePotential()

Returns the saved probe potential from EEPROM.

ISE_ORP::getProbePotential();

ORP.getProbePotential()

Returns

the probe potential

cpp python shell