ModularSensors > Classes > Sensor > ExternalVoltage
ModularSensors > Modules > TI ADS1x15 External Voltage Sensor > ExternalVoltage


ExternalVoltage class

The Sensor sub-class for the external votlage as measured by TI ADS1115 or ADS1015.

Base classes

class Sensor
The "Sensor" class is used for all sensor-level operations - waking, sleeping, and taking measurements.

Constructors, destructors, conversion operators

ExternalVoltage(int8_t powerPin, uint8_t adsChannel, float gain = 1, uint8_t i2cAddress = ADS1115_ADDRESS, uint8_t measurementsToAverage = 1)
Construct a new External Voltage object - need the power pin and the data channel on the ADS1x15.
~ExternalVoltage()
Destroy the External Voltage object.

Public functions

String getSensorLocation(void ) override
Get the pin or connection location between the mcu and the sensor.
bool addSingleMeasurementResult(void ) override
Get the results from a single measurement.

Function documentation

ExternalVoltage(int8_t powerPin, uint8_t adsChannel, float gain = 1, uint8_t i2cAddress = ADS1115_ADDRESS, uint8_t measurementsToAverage = 1)

Construct a new External Voltage object - need the power pin and the data channel on the ADS1x15.

Parameters
powerPin The pin on the mcu controlling power to the sensor Use -1 if it is continuously powered.
adsChannel The ADS channel of interest (0-3).
gain The gain multiplier, if a voltage divider is used.
i2cAddress The I2C address of the ADS 1x15, default is 0x48 (ADDR = GND)
measurementsToAverage The number of measurements to take and average before giving a "final" result from the sensor; optional with a default value of 1.

The gain value, I2C address, and number of measurements to average are optional. If nothing is given a 1x gain is used.


StringgetSensorLocation(void ) override

Get the pin or connection location between the mcu and the sensor.

Returns String Text describing how the sensor is attached to the mcu.

booladdSingleMeasurementResult(void ) override

Get the results from a single measurement.

Returns bool True if the function completed successfully.

This asks the sensor for a new result, verifies that it passes sanity range checks, and then adds the value to the result array.

This also un-sets the _millisMeasurementRequested timestamp (sets _millisMeasurementRequested to 0) and updates the _sensorStatus.