ESPHome  2022.9.2
Public Types | Public Member Functions | Data Fields
esphome::pid::PIDAutotuner::RelayFunction Struct Reference

#include <pid_autotuner.h>

Public Types

enum  RelayFunctionState { RELAY_FUNCTION_INIT, RELAY_FUNCTION_POSITIVE, RELAY_FUNCTION_NEGATIVE }
 

Public Member Functions

float update (float error)
 
float current_target_error () const
 

Data Fields

enum esphome::pid::PIDAutotuner::RelayFunction::RelayFunctionState state = RELAY_FUNCTION_INIT
 
float noiseband = 0.5
 
float output_positive = 1
 
float output_negative = -1
 
uint32_t phase_count = 0
 

Detailed Description

Definition at line 41 of file pid_autotuner.h.

Member Enumeration Documentation

◆ RelayFunctionState

Enumerator
RELAY_FUNCTION_INIT 
RELAY_FUNCTION_POSITIVE 
RELAY_FUNCTION_NEGATIVE 

Definition at line 52 of file pid_autotuner.h.

Member Function Documentation

◆ current_target_error()

float esphome::pid::PIDAutotuner::RelayFunction::current_target_error ( ) const
inline

Definition at line 44 of file pid_autotuner.h.

◆ update()

float esphome::pid::PIDAutotuner::RelayFunction::update ( float  error)

Definition at line 205 of file pid_autotuner.cpp.

Field Documentation

◆ noiseband

float esphome::pid::PIDAutotuner::RelayFunction::noiseband = 0.5

Definition at line 57 of file pid_autotuner.h.

◆ output_negative

float esphome::pid::PIDAutotuner::RelayFunction::output_negative = -1

Definition at line 59 of file pid_autotuner.h.

◆ output_positive

float esphome::pid::PIDAutotuner::RelayFunction::output_positive = 1

Definition at line 58 of file pid_autotuner.h.

◆ phase_count

uint32_t esphome::pid::PIDAutotuner::RelayFunction::phase_count = 0

Definition at line 60 of file pid_autotuner.h.

◆ state

enum esphome::pid::PIDAutotuner::RelayFunction::RelayFunctionState esphome::pid::PIDAutotuner::RelayFunction::state = RELAY_FUNCTION_INIT

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