ADC121C021 Class
- ID: adc121c021
- Name: I2C 12-bit Analog to Digital Converter with Alert Pin
- Other Names: Grove I2C ADC
- Category: electric
- Manufacturer: seeed
- Link: http://www.seeedstudio.com/depot/Grove-I2C-ADC-p-1580.html
- Connection: i2c
UPM module for the ADC121C021 12-bit analog-to-digital converter (ADC). By constantly providing a reference voltage, this sensor helps increase the accuracy of a value collected from an analog sensor.
Item Index
Methods
- ADC121C021
- writeByte
- writeWord
- readByte
- readWord
- value
- valueToVolts
- getAlertStatus
- alertLowTriggered
- alertHighTriggered
- clearAlertStatus
- enableAlertFlag
- enableAlertPin
- enableAlertHold
- enableAlertPinPolarityHigh
- setAutomaticConversion
- setAlertLowLimit
- setAlertHighLimit
- setHysteresis
- getHighestConversion
- getLowestConversion
- clearHighestConversion
- clearLowestConversion
Methods
ADC121C021
-
bus -
address -
vref
ADC121C021 ADC constructor
Parameters:
-
busNumberI2C bus to use
-
addressNumberAddress for this sensor; default is 0x55
-
vrefNumberReference voltage for this sensor; default is 3.0v
Returns:
writeByte
-
reg -
byte
Writes a byte value into the register
Parameters:
-
regNumberRegister location to write into
-
byteNumberByte to write
Returns:
0 (MRAA_SUCCESS) if successful; non-zero otherwise
writeWord
-
reg -
word
Writes a word value into the register
Parameters:
-
regNumberRegister location to write into
-
wordNumberWord to write
Returns:
0 (MRAA_SUCCESS) if successful; non-zero otherwise
readByte
-
reg
Reads the byte value from the register
Parameters:
-
regNumberRegister location to read from
Returns:
Value in the specified register
readWord
-
reg
Reads the word value from the register
Parameters:
-
regNumberRegister location to read from
Returns:
Value in the specified register
value
()
Number
Reads the current value of conversion
Returns:
Current value of conversion
valueToVolts
-
val
Converts a supplied value to voltage based on the set vref
Parameters:
-
valNumberValue of conversion (from value() )
Returns:
Value of conversion in volts
getAlertStatus
()
Boolean
Reads the current status of the alert flag. If the flag is set, the low or high alert indicators are set as appropriate, and you can access these values with alertLowTriggered() or alertHighTriggered() .
Returns:
True if the alert flag is set
alertLowTriggered
()
Boolean
Returns the current value of m_alertLow. You must call getAlertStatus() to update this value.
Returns:
Current status of the alert low flag
alertHighTriggered
()
Boolean
Returns the current value of m_alertHigh. You must call getAlertStatus() to update this value.
Returns:
Current status of the alert high flag
clearAlertStatus
()
Clears the alert low and alert high flags. This also clears the last stored alert values.
enableAlertFlag
-
enable
Enables or disables the alert flag functionality. If enabled, when the measured value exceeds the low or high limits configured, the alert flag is set. Use getAlertStatus() to access these values.
Parameters:
-
enableBooleanIf true, enables the alert flag; otherwise, disables the alert flag
enableAlertPin
-
enable
Enables or disables the alert pin functionality.
Parameters:
-
enableBooleanIf true, enables the alert pin; otherwise, disables the alert pin
enableAlertHold
-
enable
Enables or disables the alert hold functionality. When the alert hold is enabled, the alert status remains until manually cleared via clearAlertStatus() . Otherwise, the alert self-clears when the value moves into the defined limits if alerts are enabled via enableAlertFlag() .
Parameters:
-
enableBooleanIf true, enables the alert hold; otherwise, disables the alert hold
enableAlertPinPolarityHigh
-
enable
If the alert pin is enabled, defines the active polarity of the pin in an alert condition. Enabling this sets the pin to active high in an alert condition; otherwise, active low is used.
Parameters:
-
enableBooleanIf true, the alert pin is active high; otherwise, active low
setAutomaticConversion
-
cycleTime
Enables or disables the automatic conversion mode. When enabled, the ADC samples and updates the conversion value independently. It is disabled by default, so conversion is only done by calling value() .
Parameters:
-
cycleTimeADC121C021_CYCLE_TIME_TSets the cycle time for automatic conversion
setAlertLowLimit
-
limit
Sets the alert low limit. If alerts are enabled and the measured conversion value is lower than the low limit, an alert is triggered.
Parameters:
-
limitNumberAlert low limit
Returns:
0 (MRAA_SUCCESS) if successful; non-zero otherwise
setAlertHighLimit
-
limit
Sets the alert high limit. If alerts are enabled and the measured conversion value is higher than the high limit, an alert is triggered.
Parameters:
-
limitNumberAlert high limit
Returns:
0 (MRAA_SUCCESS) if successful; non-zero otherwise
setHysteresis
-
limit
Sets 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 is set, the alert doesn't self-clear regardless of this value.
Parameters:
-
limitNumberHysteresis limit
Returns:
0 (MRAA_SUCCESS) if successful; non-zero otherwise
getHighestConversion
()
Number
Returns the highest conversion value recorded so far. This value is only updated by the converter when the automatic conversion mode is enabled.
Returns:
Highest conversion value
getLowestConversion
()
Number
Returns the lowest conversion value recorded so far. This value is only updated by the converter when the automatic conversion mode is enabled.
Returns:
Lowest conversion value
clearHighestConversion
()
Mraa_result_t
Clears the highest conversion value recorded so far.
Returns:
0 (MRAA_SUCCESS) if successful; non-zero otherwise
clearLowestConversion
()
Mraa_result_t
Clears the lowest conversion value recorded so far.
Returns:
0 (MRAA_SUCCESS) if successful; non-zero otherwise