1
0
mirror of https://github.com/esphome/esphome.git synced 2025-04-18 00:30:29 +01:00
Oliver Kleinecke d89a794d28
Update mcp4461_output.h
add comments for header file
2025-02-20 11:24:19 +01:00

46 lines
1.6 KiB
C++

#pragma once
#include "../mcp4461.h"
#include "esphome/core/component.h"
#include "esphome/components/output/float_output.h"
#include "esphome/components/i2c/i2c.h"
namespace esphome {
namespace mcp4461 {
class Mcp4461Wiper : public output::FloatOutput, public Parented<Mcp4461Component> {
public:
Mcp4461Wiper(Mcp4461Component *parent, Mcp4461WiperIdx wiper) : parent_(parent), wiper_(wiper) {}
/// @brief Enables/Disables current output using bool parameter
/// @param[state] boolean var representing desired state (true=ON, false=OFF)
void set_state(bool state) override;
/// @brief Enables current output
void turn_on() override;
/// @brief Disables current output
void turn_off() override;
/// @brief Read current device wiper state without updating internal output state
float read_state();
/// @brief Update current output state using device wiper state
float update_state();
/// @brief Increase wiper by 1 tap
void increase_wiper();
/// @brief Decrease wiper by 1 tap
void decrease_wiper();
/// @brief Enable given terminal
/// @param[terminal] single char parameter defining desired terminal to enable, one of { 'a', 'b', 'w', 'h' }
void enable_terminal(char terminal);
/// @brief Disable given terminal
/// @param[terminal] single char parameter defining desired terminal to disable, one of { 'a', 'b', 'w', 'h' }
void disable_terminal(char terminal);
protected:
void write_state(float state) override;
Mcp4461Component *parent_;
Mcp4461WiperIdx wiper_;
float state_;
optional<uint16_t> initial_value_;
};
} // namespace mcp4461
} // namespace esphome