sascha/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2025-03-13 22:28:14 +00:00
Code Issues Releases Wiki Activity

Update mcp4461_output.h

Browse Source 
add comments for header file
This commit is contained in:
Oliver Kleinecke 2025-02-20 11:24:19 +01:00 committed by GitHub
parent 270909350a
commit d89a794d28
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
esphome/components/mcp4461/output/mcp4461_output.h
View File

@ -11,16 +11,26 @@ 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();
void enable_wiper();
void disable_wiper();
/// @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: