drv::analog Namespace Reference

Namespaces
namespace	anonymous_namespace{adc_task_function.cpp}
namespace	anonymous_namespace{convert.cpp}
namespace	anonymous_namespace{init.cpp}

Classes
struct	CurrentsQueue
struct	TemperatureQueue
struct	VoltagesQueue

Typedefs
using	VoltageMeasurement
using	Voltage
using	CurrentMeasurement
using	Current

Functions
	TASK (adc_task, "drv::analog::adc", 4096uz, ESP_TASK_PRIO_MAX - 2u, APP_CPU_NUM, 200u)
	TASK (temp_task, "drv::analog::temp", 2048uz, tskIDLE_PRIORITY, APP_CPU_NUM, 0u)
void	handle_suspend_resume_on_notify ()
	Handles suspend/resume logic.
void	adc_task_notify_suspend ()
	Suspend ADC task with task notification.
void	adc_task_notify_resume ()
	Resume ADC task with task notification.
void	adc_task_function (void *)
	ADC task function.
Voltage	measurement2mV (VoltageMeasurement meas)
	Convert VoltageMeasurement to Voltage.
VoltageMeasurement	mV2measurement (Voltage mV)
	Convert Voltage to VoltageMeasurement.
Current	measurement2mA (CurrentMeasurement meas)
	Convert CurrentMeasurement to Current.
CurrentMeasurement	mA2measurement (Current mA)
	Convert Current to CurrentMeasurement.
esp_err_t	init ()
	Initialize analog.
void	temp_task_function (void *)
	Temperature task function.

Variables
constexpr auto	ol_on_gpio_num {GPIO_NUM_17}
constexpr auto	voltage_upper_r {14300}
	Voltage divider upper resistor for voltage measurement.
constexpr auto	voltage_lower_r {470}
	Voltage divider lower resistor for voltage measurement.
constexpr auto	current_r {180}
	Current sense resistor.
constexpr auto	current_k {800}
	Current sense ratio.
constexpr auto	vref {1000}
constexpr auto	max_measurement
constexpr auto	voltage_channel {ADC_CHANNEL_2}
constexpr auto	current_channel {ADC_CHANNEL_9}
constexpr auto	attenuation {ADC_ATTEN_DB_0}
constexpr std::array	channels {current_channel, voltage_channel}
constexpr auto	sample_freq_hz {80'000u}
	Sample frequency [Hz] (sample takes 12.5us, conversion frame 20ms)
constexpr auto	conversion_frame_samples {1600uz}
	Number of samples per frame.
constexpr auto	conversion_frame_time
	Time per frame [ms].
constexpr auto	conversion_frame_size
constexpr auto	conversion_frame_samples_per_channel
struct drv::analog::VoltagesQueue	voltages_queue
struct drv::analog::CurrentsQueue	currents_queue
struct drv::analog::TemperatureQueue	temperature_queue
adc_cali_handle_t	cali_handle {}
adc_continuous_handle_t	adc1_handle {}
temperature_sensor_handle_t	temp_sensor {}

Typedef Documentation

Current

using drv::analog::Current

Initial value:

 
  ztl::implicit_wrapper<CurrentMeasurement::value_type, struct CurrentTag>

CurrentMeasurement

using drv::analog::CurrentMeasurement

Initial value:

 
  ztl::implicit_wrapper<ztl::smallest_signed_t<0, max_measurement>,
                        struct CurrentMeasurementTag>

Voltage

using drv::analog::Voltage

Initial value:

 
  ztl::implicit_wrapper<VoltageMeasurement::value_type, struct VoltageTag>

VoltageMeasurement

using drv::analog::VoltageMeasurement

Initial value:

 
  ztl::implicit_wrapper<ztl::smallest_signed_t<0, max_measurement>,
                        struct VoltageMeasurementTag>

Function Documentation

adc_task_function()

void drv::analog::adc_task_function

(

void *

)

Once started, the ADC task runs continuously. It measures voltages and currents at a frequency of 8kHz. A total of 160 samples are recorded within one conversion frame meaning one frame lasts exactly 20ms. All measurements are written to the corresponding voltages or currents queue.

If the measured currents indicate a short circuit, the bug LED is switched on, state is set to short circuit and a ROCO track short circuit message is broadcast.

adc_task_notify_resume()

void drv::analog::adc_task_notify_resume

(

)

adc_task_notify_suspend()

void drv::analog::adc_task_notify_suspend

(

)

handle_suspend_resume_on_notify()

void drv::analog::handle_suspend_resume_on_notify

(

)

Since the ADC task holds a mutex on the continuous mode driver, the only way to stop and start the ADC is to send a task notification. This is done using adc_task_notify_suspend() or adc_task_notify_resume(). The conversion frame then starts again from the beginning and this method can be used to synchronize the ADC.

init()

esp_err_t drv::analog::init

(

)

Initialization takes place in init(). This function performs the following operations:

• Creates queues for raw voltage and current vales as well as temperatures in Si units
• Initializes the ADC in continuous mode and applies a curve fitting calibration
• Initializes the internal temperature sensor
• Creates an ADC and temperature task

mA2measurement()

CurrentMeasurement drv::analog::mA2measurement

(

Current

mA

)

Parameters

mA	Current in [mA]

Returns

CurrentMeasurement

measurement2mA()

Current drv::analog::measurement2mA

(

CurrentMeasurement

meas

)

Parameters

meas	Current measurement

Returns

Current

measurement2mV()

Voltage drv::analog::measurement2mV

(

VoltageMeasurement

meas

)

Parameters

meas	Voltage measurement

Returns

Voltage

mV2measurement()

VoltageMeasurement drv::analog::mV2measurement

(

Voltage

mV

)

Parameters

mV	Voltage in [mV]

Returns

VoltageMeasurement

TASK() [1/2]

drv::analog::TASK ( adc_task , "drv::analog::adc" , 4096uz , ESP_TASK_PRIO_MAX - 2u, APP_CPU_NUM , 200u  )

inline

TASK() [2/2]

drv::analog::TASK ( temp_task , "drv::analog::temp" , 2048uz , tskIDLE_PRIORITY , APP_CPU_NUM , 0u  )

inline

temp_task_function()

void drv::analog::temp_task_function

(

void *

)

Once started, the temperature task runs continuously. The internal temperature sensor is read once per second and the result is converted into degrees Celsius. The result is written to the corresponding queue.

Variable Documentation

adc1_handle

adc_continuous_handle_t drv::analog::adc1_handle {}

inline

attenuation

auto drv::analog::attenuation {ADC_ATTEN_DB_0}

inlineconstexpr

cali_handle

adc_cali_handle_t drv::analog::cali_handle {}

inline

channels

std::array drv::analog::channels {current_channel, voltage_channel}

inlineconstexpr

conversion_frame_samples

auto drv::analog::conversion_frame_samples {1600uz}

inlineconstexpr

conversion_frame_samples_per_channel

auto drv::analog::conversion_frame_samples_per_channel

inlineconstexpr

Initial value:

{
  conversion_frame_samples / size(channels)}

conversion_frame_size

auto drv::analog::conversion_frame_size

inlineconstexpr

Initial value:

{conversion_frame_samples *
                                            SOC_ADC_DIGI_DATA_BYTES_PER_CONV}

conversion_frame_time

auto drv::analog::conversion_frame_time

inlineconstexpr

Initial value:

{(conversion_frame_samples * 1000u) /
                                            sample_freq_hz}

current_channel

auto drv::analog::current_channel {ADC_CHANNEL_9}

inlineconstexpr

current_k

auto drv::analog::current_k {800}

inlineconstexpr

current_r

auto drv::analog::current_r {180}

inlineconstexpr

currents_queue

struct drv::analog::CurrentsQueue drv::analog::currents_queue

max_measurement

auto drv::analog::max_measurement

inlineconstexpr

Initial value:

{smath::pow(2, SOC_ADC_DIGI_MAX_BITWIDTH) -
                                      1}

ol_on_gpio_num

auto drv::analog::ol_on_gpio_num {GPIO_NUM_17}

inlineconstexpr

sample_freq_hz

auto drv::analog::sample_freq_hz {80'000u}

inlineconstexpr

This frequency was chosen explicitly to avoid any beats with the DCC signal (~58/100us).

temp_sensor

temperature_sensor_handle_t drv::analog::temp_sensor {}

inline

temperature_queue

struct drv::analog::TemperatureQueue drv::analog::temperature_queue

voltage_channel

auto drv::analog::voltage_channel {ADC_CHANNEL_2}

inlineconstexpr

voltage_lower_r

auto drv::analog::voltage_lower_r {470}

inlineconstexpr

voltage_upper_r

auto drv::analog::voltage_upper_r {14300}

inlineconstexpr

voltages_queue

struct drv::analog::VoltagesQueue drv::analog::voltages_queue

vref

auto drv::analog::vref {1000}

inlineconstexpr