pw_analog

Pigweed AI summary: The pw_analog module is currently under construction and may not be ready for use. It contains interfaces and utility functions for using the ADC, including the common interfaces for obtaining ADC and voltage samples. Users will need to supply their own ADC driver implementation and manage multithreaded access to the ADC driver if it services multiple channels. The module also includes gMock interfaces for testing and mocking out the AnalogInput and MicrovoltInput.

Warning

This module is under construction and may not be ready for use.

pw_analog contains interfaces and utility functions for using the ADC.

Features

Pigweed AI summary: This paragraph describes the features of the pw::analog library, specifically the AnalogInput and MicrovoltInput interfaces. These interfaces allow users to obtain ADC samples and voltage samples in microvolts, respectively. Users must provide their own ADC driver implementation and manage multithreaded access to the ADC driver if necessary. The library also includes gMock versions of these interfaces for testing and mocking purposes.

pw::analog::AnalogInput

Pigweed AI summary: The pw::analog::AnalogInput is a standard interface for obtaining ADC samples from a single analog input or channel. Users must provide their own ADC driver implementation to configure and enable the ADC peripheral. Additionally, users are responsible for managing multithreaded access to the ADC driver if the ADC services multiple channels.

The common interface for obtaining ADC samples. This interface represents a single analog input or channel. Users will need to supply their own ADC driver implementation in order to configure and enable the ADC peripheral. Users are responsible for managing multithreaded access to the ADC driver if the ADC services multiple channels.

pw::analog::MicrovoltInput

Pigweed AI summary: The pw::analog::MicrovoltInput is an interface for obtaining voltage samples in microvolts. Users must provide their own ADC driver implementation to configure and enable the ADC peripheral for reference voltages and to manage multithreaded access to the ADC driver if it services multiple channels.

The common interface for obtaining voltage samples in microvolts. This interface represents a single voltage input or channel. Users will need to supply their own ADC driver implementation in order to configure and enable the ADC peripheral in order to provide the reference voltages and to configure and enable the ADC peripheral where needed. Users are responsible for managing multithreaded access to the ADC driver if the ADC services multiple channels.

pw::analog::GmockAnalogInput

Pigweed AI summary: This paragraph describes a gMock of AnalogInput that is used for testing and mocking out the AnalogInput.

gMock of AnalogInput used for testing and mocking out the AnalogInput.

pw::analog::GmockMicrovoltInput

Pigweed AI summary: This paragraph describes a gMock of MicrovoltInput that is used for testing and mocking out the MicrovoltInput.

gMock of MicrovoltInput used for testing and mocking out the MicrovoltInput.