dev-console-fan.yaml

substitutions:
  friendly_name: Console Fan

esphome:
  name: console-fan-v2
  # includes:
  #   - pid_simulator.h

# custom_component:
#   - lambda: |-
#       auto *my_component = new esphome::pid::PIDSimulator();
#       App.register_component(my_component);
#       return {my_component};

globals:
  - id: dhttemp
    type: float
    restore_value: yes
    initial_value: "0"

#########################
# ESP32 AND NETWORK SETUP
  
esp32:
  board: nodemcu-32s
  framework:
    type: arduino

# pid climate log update is noisy, dial it back to warn
logger:
  level: DEBUG
  logs:
    climate: ERROR
    dht: WARN

# default HA integration, OTA updater and backup http web portal
api:
ota:
captive_portal:

wifi:
  # Read the wifi/pass from secrets.yaml:
  # wifi_ssid: "My Wifi XX"
  # wifi_password: "XXXXXXX"
  ssid: !secret wifi_ssid
  password: !secret wifi_password

  # Enable fallback hotspot (captive portal) in case wifi connection fails
  ap:
    ssid: "console-fan-ap"
    password: ""

    # on_press:
    #   then:
    #   - lambda: !lambda |-
    #       id(slider_helper).publish_state(false);
    #       id(slider1).update();

number:
  ## RECEIVE kp,ki and kd parameters from input_text.kx helpers in
  # Home Assistant. See the PID controller below
  # These helper values will get saved to flash thus permanently over-riding
  # the initial values set in the PID below.

  # KP
  - platform: template
    name: $friendly_name kp
    icon: mdi:chart-bell-curve
    optimistic: true
    min_value: 0
    max_value: 50
    step: 0.001
    set_action:
      lambda: id(console_thermostat).set_kp( x );

  # KI
  - platform: template
    name: $friendly_name ki
    icon: mdi:chart-bell-curve
    restore_value: true
    min_value: 0
    max_value: 50
    step: 0.0001
    set_action:
      lambda: id(console_thermostat).set_ki( x );

  # KD
  - platform: template
    name: $friendly_name kd
    icon: mdi:chart-bell-curve
    restore_value: true
    min_value: -50
    max_value: 50
    step: 0.001
    set_action:
      lambda: id(console_thermostat).set_kd( x );

  # Starting Integral Term
  - platform: template
    name: $friendly_name starting integral
    icon: mdi:chart-bell-curve
    restore_value: true
    min_value: -100
    max_value: 100
    step: 0.1
    set_action:
      lambda: id(console_thermostat).set_starting_integral_term( -x/100 );

  # output samples
  - platform: template
    name: $friendly_name output samples
    icon: mdi:chart-bell-curve
    restore_value: true
    min_value: 1
    max_value: 50
    step: 1
    set_action:
      lambda: id(console_thermostat).set_output_samples( x );

  # deadband_threshold
  - platform: template
    name: $friendly_name deadband threshold high
    icon: mdi:chart-bell-curve
    restore_value: true
    min_value: 0
    max_value: 50
    step: 0.1
    set_action:
      lambda: id(console_thermostat).set_threshold_high( x );

  - platform: template
    name: $friendly_name deadband threshold low
    icon: mdi:chart-bell-curve
    restore_value: true
    min_value: -50
    max_value: 0
    step: 0.1
    set_action:
      lambda: id(console_thermostat).set_threshold_low( x );

  - platform: template
    name: $friendly_name kp multiplier
    icon: mdi:chart-bell-curve
    restore_value: true
    min_value: 0
    max_value: .1
    step: 0.001
    set_action:
      lambda: id(console_thermostat).set_kp_multiplier( x );
  - platform: template
    name: $friendly_name ki multiplier
    icon: mdi:chart-bell-curve
    restore_value: true
    min_value: 0
    max_value: .1
    step: 0.001
    set_action:
      lambda: id(console_thermostat).set_ki_multiplier( x );
  - platform: template
    name: $friendly_name kd multiplier
    icon: mdi:chart-bell-curve
    restore_value: true
    min_value: 0
    max_value: .1
    step: 0.001
    set_action:
      lambda: id(console_thermostat).set_kd_multiplier( x );

  - platform: template
    name: $friendly_name deadband output samples
    icon: mdi:chart-bell-curve
    restore_value: true
    min_value: 0
    max_value: 50
    step: 1
    set_action:
      lambda: id(console_thermostat).set_deadband_output_samples( x );

text_sensor:
  # Send IP Address
  - platform: wifi_info
    ip_address:
      name: $friendly_name IP Address

  # Send Uptime in raw seconds
  - platform: template
    name: $friendly_name Uptime
    id: uptime_human
    icon: mdi:clock-start


sensor:

  # Send WiFi signal strength & uptime to HA
  - platform: wifi_signal
    name: $friendly_name WiFi Strength
    update_interval: 60s

  # This is a bit of overkill. It sends a human readable
  # uptime string
  # 1h 41m 32s instead of 6092 seconds
  - platform: uptime
    name: $friendly_name Uptime
    id: uptime_sensor
    update_interval: 60s
    on_raw_value:
      then:
        - text_sensor.template.publish:
            id: uptime_human
            # Custom C++ code to generate the result
            state: !lambda |-
              int seconds = round(id(uptime_sensor).raw_state);
              int days = seconds / (24 * 3600);
              seconds = seconds % (24 * 3600);
              int hours = seconds / 3600;
              seconds = seconds % 3600;
              int minutes = seconds /  60;
              seconds = seconds % 60;
              return (
                (days ? to_string(days) + "d " : "") +
                (hours ? to_string(hours) + "h " : "") +
                (minutes ? to_string(minutes) + "m " : "") +
                (to_string(seconds) + "s")
              ).c_str();

  ########################################################
  # START THE FAN CONTROLLER SETUP

  - platform: template
    name: $friendly_name kp
    id: kp
    accuracy_decimals: 4

  - platform: template
    name: $friendly_name ki
    id: ki
    accuracy_decimals: 4

  - platform: template
    name: $friendly_name kd
    id: kd
    accuracy_decimals: 4

  - platform: template
    name: $friendly_name p term
    id: p_term
    unit_of_measurement: "%"
    accuracy_decimals: 2

  - platform: template
    name: $friendly_name i term
    id: i_term
    unit_of_measurement: "%"
    accuracy_decimals: 2

  - platform: template
    name: $friendly_name d term
    id: d_term
    unit_of_measurement: "%"
    accuracy_decimals: 2

  - platform: template
    name: $friendly_name output value
    unit_of_measurement: "%"
    id: o_term
    accuracy_decimals: 2

  - platform: template
    name: $friendly_name error value
    id: e_term
    accuracy_decimals: 2

  - platform: template
    name: $friendly_name is in deadband
    id: in_deadband_term
    accuracy_decimals: 0

  - platform: template
    name: $friendly_name zero
    id: zero_value
    update_interval: 60s
    lambda: |-
      return 0;

  - platform: template
    name: $friendly_name zero percent
    unit_of_measurement: "%"
    id: zero_value_percent
    update_interval: 60s
    lambda: |-
      return 0;

  # - platform: template
  #   name: $friendly_name deadband
  #   id: db_term
  #   accuracy_decimals: 2
  # - platform: template
  #   name: $friendly_name derivative samples
  #   id: ds_term
  #   accuracy_decimals: 0
  # - platform: template
  #   name: $friendly_name deadband multiplier
  #   id: pdm_term
  #   accuracy_decimals: 2

  - platform: template
    name: $friendly_name output samples
    id: os_term
    accuracy_decimals: 0

  # deadband sensor outputs
  - platform: template
    name: $friendly_name deadband threshold low
    id: tl_term
    accuracy_decimals: 2

  - platform: template
    name: $friendly_name deadband threshold high
    id: th_term
    accuracy_decimals: 2

  - platform: template
    name: $friendly_name deadband kp multiplier
    id: dkpm_term
    accuracy_decimals: 2
  - platform: template
    name: $friendly_name deadband ki multiplier
    id: dkim_term
    accuracy_decimals: 2
  - platform: template
    name: $friendly_name deadband kd multiplier
    id: dkdm_term
    accuracy_decimals: 2
  - platform: template
    name: $friendly_name deadband output samples
    id: dos_term
    accuracy_decimals: 0

  # GET TEMP/HUMIDITY FROM DHT11
  - platform: dht
    pin:
      number: 33
      mode:
        input: true
        pullup: true

    temperature:
      name: "Temperature"
      id: console_fan_temperature
      accuracy_decimals: 3

      # If you don't smooth the output readings
      # the PID controller over reacts to small changes.
      filters:
        # - sliding_window_moving_average:
        #     window_size: 6
        #     send_every: 1
        #     send_first_at: 1
        - exponential_moving_average:
            alpha: 0.1
            send_every: 1

    humidity:
      name: "Humidity"
      id: console_fan_humidity

    # the DHT11 can only be read every 1s. Use 1.3s to be safe.
    # Note that 15 x 1.3s means that the true temperature may
    # take 19.5s to emerge
    update_interval: 1.3s

  # Take the "COOL" value of the pid and send
  # it to the frontend to graph the output voltage
  - platform: pid
    name: "Fan Speed (PWM Voltage)"
    climate_id: console_thermostat
    type: COOL

output:
  # Wire this pin (15) into the PWM pin of your 12v fan
  # ledc is the name of the pwm output system on an esp32
  - platform: ledc
    id: console_fan_speed
    pin: GPIO25

  - platform: ledc
    id: console_heat_speed
    pin: GPIO27

    # 25KHz is standard PC fan frequency, minimises buzzing
    frequency: "25000 Hz"

    # my fans stop working below 13% powerful.
    # also they're  powerful and loud, cap their max speed to 80%
    min_power: 13%
    max_power: 80%

# Good for debugging, you can manually set the fan speed.
fan:
  - platform: speed
    output: console_fan_speed
    name: "Console Fan Speed"

# Expose a PID-controlled Thermostat
# Manual: https://esphome.io/components/climate/pid.html
climate:
  - platform: pid
    name: "Console Fan Thermostat"
    id: console_thermostat
    sensor: console_fan_temperature

    # It is summer right now, so 30c is a decent target.
    default_target_temperature: 30°C
    cool_output: console_fan_speed

    on_state:
      - sensor.template.publish:
          id: kp
          state: !lambda "return id(console_thermostat).get_kp();"
      - sensor.template.publish:
          id: ki
          state: !lambda "return id(console_thermostat).get_ki();"
      - sensor.template.publish:
          id: kd
          state: !lambda "return id(console_thermostat).get_kd();"

      - sensor.template.publish:
          id: p_term
          state: !lambda "return -id(console_thermostat).get_proportional_term() * 100.0;"
      - sensor.template.publish:
          id: i_term
          state: !lambda "return -id(console_thermostat).get_integral_term()* 100.0;"
      - sensor.template.publish:
          id: d_term
          state: !lambda "return -id(console_thermostat).get_derivative_term()* 100.0;"
      - sensor.template.publish:
          id: o_term
          state: !lambda "return -id(console_thermostat).get_output_value()* 100.0;"
      - sensor.template.publish:
          id: e_term
          state: !lambda "return -id(console_thermostat).get_error_value();"
      - sensor.template.publish:
          id: in_deadband_term
          state: !lambda "return id(console_thermostat).in_deadband();"
      - sensor.template.publish:
          id: os_term
          state: !lambda "return id(console_thermostat).get_output_samples();"
      - sensor.template.publish:
          id: tl_term
          state: !lambda "return id(console_thermostat).get_threshold_low();"
      - sensor.template.publish:
          id: th_term
          state: !lambda "return id(console_thermostat).get_threshold_high();"
      - sensor.template.publish:
          id: dkpm_term
          state: !lambda "return id(console_thermostat).get_kp_multiplier();"
      - sensor.template.publish:
          id: dkim_term
          state: !lambda "return id(console_thermostat).get_ki_multiplier();"
      - sensor.template.publish:
          id: dkdm_term
          state: !lambda "return id(console_thermostat).get_kd_multiplier();"
      - sensor.template.publish:
          id: dos_term
          state: !lambda "return id(console_thermostat).get_deadband_output_samples();"

    # dummy heater. enable this if using autotune
    heat_output: console_heat_speed

    # The extents of the HA Thermostat
    visual:
      min_temperature: 20 °C
      max_temperature: 50 °C

    # See the README for setting up these parameters.
    control_parameters:
      kp: 0.3
      ki: 0.0015
      kd: 0
      max_integral: 0.0
      output_averaging_samples: 1
      derivative_averaging_samples: 5

    deadband_parameters:
      threshold_high: 0.4°C
      threshold_low: -1.0°C
      kp_multiplier: 0.0
      ki_multiplier: 0.04
      kd_multiplier: 0.0
      deadband_output_averaging_samples: 15

switch:
  # Expose an ESP32 restart button to HA
  - platform: restart
    name: "Console Fan ESP32 Restart"

  - platform: template
    name: $friendly_name Reset Integral
    turn_on_action:
      - climate.pid.reset_integral_term: console_thermostat

button:
  - platform: template
    name: "PID Climate Autotune"
    on_press:
      - climate.pid.autotune: console_thermostat