C++ API for the ADC121C021 I2C ADC.
More...
UPM module for the ADC121C021 12 bit Analog to Digital (ADC) converter. By providing a constant reference voltage, this sensor helps to increase the accuracy of a value collected from an analog sensor.
ADC121C021_DEFAULT_I2C_ADDR);
while (shouldRun)
{
uint16_t val = adc->
value();
cout << "ADC value: " << val << " Volts = "
usleep(50000);
}
| ADC121C021 |
( |
int |
bus, |
|
|
uint8_t |
address = ADC121C021_DEFAULT_I2C_ADDR, |
|
|
float |
vref = ADC121C021_DEFAULT_VREF |
|
) |
| |
adc121c021 ADC constructor
- Parameters
-
| bus | i2c bus to use |
| address | the address for this sensor; default is 0x55 |
| vref | reference voltage for this sensor; default is 3.0 |
| mraa_result_t writeByte |
( |
uint8_t |
reg, |
|
|
uint8_t |
byte |
|
) |
| |
Write byte value into register
- Parameters
-
| reg | register location to write into |
| byte | byte to write |
- Returns
- 0 (MRAA_SUCCESS) if successful; non-zero otherwise
| mraa_result_t writeWord |
( |
uint8_t |
reg, |
|
|
uint16_t |
word |
|
) |
| |
Write word value into register
- Parameters
-
| reg | register location to write into |
| word | word to write |
- Returns
- 0 (MRAA_SUCCESS) if successful; non-zero otherwise
| uint8_t readByte |
( |
uint8_t |
reg | ) |
|
Read byte value from register
- Parameters
-
| reg | register location to read from |
- Returns
- value at specified register
| uint16_t readWord |
( |
uint8_t |
reg | ) |
|
Read word value from register
- Parameters
-
| reg | register location to read from |
- Returns
- value at specified register
Read current value of conversion
- Returns
- current conversion value
| float valueToVolts |
( |
uint16_t |
val | ) |
|
Convert a supplied value to voltage based on set VREF
- Parameters
-
| val | value of conversion (from value()) |
- Returns
- conversion value in volts
Read current status of the alert flag. If the flag is set, the lower or upper alert indicators will be set as appropriate, and you can access these values with alertLowTriggered() or alertHighTriggered().
- Returns
- true if the alert flag is set
| bool alertLowTriggered |
( |
| ) |
|
|
inline |
Return the current value of m_alertLow. You must call getAlertStatus() to update this value.
- Returns
- current alert low status
| bool alertHighTriggered |
( |
| ) |
|
|
inline |
Return the current value of m_alertHigh. You must call getAlertStatus() to update this value.
- Returns
- current alert high status
| void clearAlertStatus |
( |
| ) |
|
Clear the alert low and high flags. This will also clear the last stored alert values.
| void enableAlertFlag |
( |
bool |
enable | ) |
|
Enable or disable the Alert Flag functionality. If enabled, then when the measured value exceeds the low or high limits configured, the alert flag will be set. Use getAlertStatus() to access these values.
- Parameters
-
| enable | if true, enables Alert Flag; otherwise, disables Alert Flag |
| void enableAlertPin |
( |
bool |
enable | ) |
|
Enable or disable the Alert Pin functionality.
- Parameters
-
| enable | if true, enables Alert Pin; otherwise, disables Alert Pin |
| void enableAlertHold |
( |
bool |
enable | ) |
|
Enable or disable the Alert Hold functionality. When Alert Hold is enabled, the alert status remains until manually cleared via clearAlertStatus(). Otherwise, the alert will self clear when the value moves into the defined limits if alerts are enabled via enableAlertFlag().
- Parameters
-
| enable | if true, enables Alert Hold; otherwise, disables Alert Hold |
| void enableAlertPinPolarityHigh |
( |
bool |
enable | ) |
|
If the Alert Pin fnctionality is enabled, define the active polarity of the pin in an alert condition. Enabling this sets the pin to active high in an alert condition, otherwise an active low is used.
- Parameters
-
| enable | if true, Alert Pin is active high, else active low |
| void setAutomaticConversion |
( |
ADC121C021_CYCLE_TIME_T |
cycleTime | ) |
|
Enable or disable Automatic Conversion mode. When enabled, the ADC will sample and update the conversion value independently. This is disabled by default, and a conversion is only done by calling value().
- Parameters
-
| cycleTime | set the Cycle Time for automatic conversion |
| mraa_result_t setAlertLowLimit |
( |
uint16_t |
limit | ) |
|
Set the Alert Low Limit. If Alerts are enabled and the measured conversion value is lower than this, an alert will be triggered.
- Parameters
-
- Returns
- 0 (MRAA_SUCCESS) if successful; non-zero otherwise
| mraa_result_t setAlertHighLimit |
( |
uint16_t |
limit | ) |
|
Set the Alert High Limit. If Alerts are enabled and the measured conversion value is higher than this, an alert will be triggered.
- Parameters
-
| limit | the High Alert Limit |
- Returns
- 0 (MRAA_SUCCESS) if successful; non-zero otherwise
| mraa_result_t setHysteresis |
( |
uint16_t |
limit | ) |
|
Set the Hysteresis value. If a high or low alert condition is triggered, the conversion result must move within the high or low limit by more than this value to clear the alert condition. If the Alert Hold bit is set, then the alert will not self clear regardless of this value.
- Parameters
-
- Returns
- 0 (MRAA_SUCCESS) if successful; non-zero otherwise
| uint16_t getHighestConversion |
( |
| ) |
|
Return the Highest Conversion value sampled so far. This value is only updated by the converter when automatic conversion mode is enabled.
- Returns
- the highest conversion value recorded
| uint16_t getLowestConversion |
( |
| ) |
|
Return the Lowest Conversion value sampled so far. This value is only updated by the converter when automatic conversion mode is enabled.
- Returns
- the lowest conversion value recorded
| mraa_result_t clearHighestConversion |
( |
| ) |
|
Clear the Highest Conversion value sampled so far.
- Returns
- 0 (MRAA_SUCCESS) if successful; non-zero otherwise
| mraa_result_t clearLowestConversion |
( |
| ) |
|
Clear the Lowest Conversion value sampled so far.
- Returns
- 0 (MRAA_SUCCESS) if successful; non-zero otherwise
The documentation for this class was generated from the following files:
- /var/lib/jenkins/workspace/upm-doc-stable/src/adc121c021/adc121c021.h
- /var/lib/jenkins/workspace/upm-doc-stable/src/adc121c021/adc121c021.cxx
1.8.9.1
