aruna::driver::ADC Class Reference

Analogue digital converter. More...

#include <ADC.h>

Inheritance diagram for aruna::driver::ADC:

Public Member Functions
template<typename T >
err_t	read_raw (T &raw)
	Read raw value from ADC, convert to voltage yourself. More...
template<typename T >
err_t	read_voltage (T &mV)
	Read voltage level of input. More...
size_t	get_resolution () const
	Get the resolution in bits of the ADC. More...
uint16_t	get_reference () const
	Get the reference voltage in micro Voltage. More...
virtual int32_t	raw_to_voltage (int32_t raw)
	Convert raw data to voltage. More...
template<typename T >
aruna::err_t	read_raw (T &raw)
template<typename T >
aruna::err_t	read_voltage (T &mV)

Protected Member Functions
err_t	set_resolution (size_t bits)
	Set resolution of ADC. More...
err_t	set_reference (uint16_t mV)
	set reference voltage, used to convert raw data to voltage. More...

Private Member Functions
virtual err_t	_read (int32_t &raw)=0
	Read analogue value and convert to 32bit signed resolution. More...

Private Attributes
size_t	resolution = 0
	resolution of the ADC in bits. More...
uint16_t	reference = 0
	ADC voltage refrence, for convertage to voltage. More...

Detailed Description

Analogue digital converter.

Definition at line 19 of file ADC.h.

Member Function Documentation

_read()

virtual err_t aruna::driver::ADC::_read ( int32_t &  raw )

privatepure virtual

Read analogue value and convert to 32bit signed resolution.

Parameters

raw	store result here

Returns

error code

Implemented in aruna::driver::ADS101x.

Here is the caller graph for this function:

get_reference()

uint16_t aruna::driver::ADC::get_reference

(

)

const

Get the reference voltage in micro Voltage.

Returns

micro Voltage, used by the ADC as reference.

Definition at line 40 of file ADC.cpp.

                                          {
            return reference;
        }

get_resolution()

size_t aruna::driver::ADC::get_resolution

(

)

const

Get the resolution in bits of the ADC.

Use this value to pick the right int for the template functions

Returns

resolution of this ADC

Definition at line 23 of file ADC.cpp.

                                         {
            return resolution;
        }

raw_to_voltage()

int32_t aruna::driver::ADC::raw_to_voltage ( int32_t  raw )

virtual

Convert raw data to voltage.

Parameters

raw	data from ADC

Returns

voltage in mV.

Definition at line 27 of file ADC.cpp.

                                               {
            double input, inputLow, inputHigh, outputHigh, outputLow;
            input = raw;
            inputLow = 0;
            inputHigh = INT32_MAX;
            outputHigh = reference;
            outputLow = 0;
// TODO make convert_range function and replace Actuator::convert_range with this
// https://gamedev.stackexchange.com/questions/33441/how-to-convert-a-number-from-one-min-max-set-to-another-min-max-set
            return ((input - inputLow) / (inputHigh - inputLow)) * (outputHigh - outputLow) + outputLow;

        }

Here is the caller graph for this function:

read_raw() [1/2]

template<typename T >

aruna::err_t aruna::driver::ADC::read_raw

(

T &

raw

)

Definition at line 16 of file ADC.hpp.

                                          {
    return _read(raw);
}

Here is the call graph for this function:

read_raw() [2/2]

template<typename T >

err_t aruna::driver::ADC::read_raw

(

T &

raw

)

Read raw value from ADC, convert to voltage yourself.

Parameters

raw	stores result

Returns

errors

Here is the caller graph for this function:

read_voltage() [1/2]

template<typename T >

aruna::err_t aruna::driver::ADC::read_voltage

(

T &

mV

)

Definition at line 21 of file ADC.hpp.

                                             {
    int32_t raw;
    aruna::err_t err;
    err = read_raw(raw);
    if ((bool) err)
        return err;

    mV = raw_to_voltage(raw);
    return aruna::err_t::OK;
}

Here is the call graph for this function:

read_voltage() [2/2]

template<typename T >

err_t aruna::driver::ADC::read_voltage

(

T &

mV

)

Read voltage level of input.

Parameters

mV	int stores microvoltage

Returns

errors

Here is the caller graph for this function:

set_reference()

err_t aruna::driver::ADC::set_reference ( uint16_t  mV )

protected

set reference voltage, used to convert raw data to voltage.

Parameters

mV	micro Voltage

Returns

err_t::OK

Definition at line 18 of file ADC.cpp.

                                            {
            reference = mV;
            return err_t::OK;
        }

Here is the caller graph for this function:

set_resolution()

err_t aruna::driver::ADC::set_resolution ( size_t  bits )

protected

Set resolution of ADC.

All logic still uses 16bit, this is only for reference

Parameters

bits	new resolution

Returns

err_t::OK

Definition at line 13 of file ADC.cpp.

                                             {
            resolution = bits;
            return err_t::OK;
        }

Here is the caller graph for this function:

Member Data Documentation

reference

uint16_t aruna::driver::ADC::reference = 0

private

ADC voltage refrence, for convertage to voltage.

Definition at line 29 of file ADC.h.

resolution

size_t aruna::driver::ADC::resolution = 0

private

resolution of the ADC in bits.

Definition at line 24 of file ADC.h.

---

The documentation for this class was generated from the following files:

• include/aruna/driver/ADC.h
• src/driver/ADC.cpp
• include/aruna/driver/ADC.hpp