Driver Types

Public enums, result payloads, and helper utilities. More...

Modules
	GPIO Bit Masks
	Bit masks for GPIO pin addressing.
	Channel Mask Helpers
	Helpers and constants for Auto-1 sequence mask construction.
	Conversion Helpers
	Lightweight utility functions for engineering-unit conversion.

Files
file	ads7952_types.hpp
	Type definitions for the ADS7952 driver.

Classes
struct	ads7952::GPIOConfig
struct	ads7952::ReadResult
struct	ads7952::ChannelReadings

Enumerations
enum class	ads7952::Mode : uint8_t { ads7952::Mode::Manual , ads7952::Mode::Auto1 , ads7952::Mode::Auto2 }
enum class	ads7952::Range : uint8_t { ads7952::Range::Vref , ads7952::Range::TwoVref }
enum class	ads7952::PowerDown : uint8_t { ads7952::PowerDown::Normal , ads7952::PowerDown::PowerDown }
enum class	ads7952::AlarmBound : uint8_t { ads7952::AlarmBound::Low = 0 , ads7952::AlarmBound::High = 1 }
enum class	ads7952::Error : uint8_t {   ads7952::Error::Ok = 0 , ads7952::Error::NotInitialized , ads7952::Error::InvalidChannel , ads7952::Error::SpiError ,   ads7952::Error::ProgrammingFailed , ads7952::Error::ModeChangeFailed , ads7952::Error::Timeout }
enum class	ads7952::GPIO01AlarmMode : uint8_t {   ads7952::GPIO01AlarmMode::GPIO = 0 , ads7952::GPIO01AlarmMode::GPIO0_HighAndLowAlarm = 1 , ads7952::GPIO01AlarmMode::GPIO0_HighAlarm = 2 , ads7952::GPIO01AlarmMode::GPIO1_LowAlarm = 4 ,   ads7952::GPIO01AlarmMode::GPIO1_LowAlarm_GPIO0_HighAlarm = 6 , ads7952::GPIO01AlarmMode::GPIO1_HighAlarm = GPIO1_LowAlarm }
	GPIO0/GPIO1 alarm functions, the DI06:04 codes of the GPIO program register (SLAS605C Table 11). Alarm outputs are active high. The chip has no GPIO1 high-alarm code: GPIO1 can only be the low-alarm output. More...

Detailed Description

Public enums, result payloads, and helper utilities.

Enumeration Type Documentation

AlarmBound

enum class ads7952::AlarmBound : uint8_t

strong

Enumerator
Low	Low alarm threshold register.
High	High alarm threshold register.

Definition at line 54 of file ads7952_types.hpp.

Error

enum class ads7952::Error : uint8_t

strong

Enumerator
Ok	Operation succeeded.
NotInitialized	Driver not initialized.
InvalidChannel	Channel number out of range (0-11)
SpiError	SPI transfer failure.
ProgrammingFailed	Device programming did not complete.
ModeChangeFailed	Mode transition did not complete.
Timeout	Operation timed out waiting for data.

Definition at line 63 of file ads7952_types.hpp.

GPIO01AlarmMode

enum class ads7952::GPIO01AlarmMode : uint8_t

strong

GPIO0/GPIO1 alarm functions, the DI06:04 codes of the GPIO program register (SLAS605C Table 11). Alarm outputs are active high. The chip has no GPIO1 high-alarm code: GPIO1 can only be the low-alarm output.

Enumerator
GPIO	000: both as general-purpose I/O
GPIO0_HighAndLowAlarm	xx1: GPIO0 = combined high-or-low alarm output
GPIO0_HighAlarm	010: GPIO0 = high alarm output
GPIO1_LowAlarm	100: GPIO1 = low alarm output
GPIO1_LowAlarm_GPIO0_HighAlarm	110: GPIO1 = low alarm, GPIO0 = high alarm
GPIO1_HighAlarm	Deprecated: Misnamed: code 100 makes GPIO1 the low alarm output. Use GPIO1_LowAlarm.

Definition at line 82 of file ads7952_types.hpp.

Mode

enum class ads7952::Mode : uint8_t

strong

Enumerator
Manual	Host selects channel each frame.
Auto1	Device sequences through programmed channel mask.
Auto2	Device sequences channels 0 to last_channel.

Definition at line 26 of file ads7952_types.hpp.

PowerDown

enum class ads7952::PowerDown : uint8_t

strong

Enumerator
Normal	Normal operation.
PowerDown	Device enters power-down.

Definition at line 45 of file ads7952_types.hpp.

Range

enum class ads7952::Range : uint8_t

strong

Enumerator
Vref	0 to Vref (RANGE bit = 0)
TwoVref	0 to 2*Vref, clamped to VA (RANGE bit = 1)

Definition at line 36 of file ads7952_types.hpp.