mirror of
https://github.com/esphome/esphome.git
synced 2025-03-16 15:48:16 +00:00
Update mcp4461_output.h
add comments for header file
This commit is contained in:
parent
270909350a
commit
d89a794d28
@ -11,16 +11,26 @@ namespace mcp4461 {
|
|||||||
class Mcp4461Wiper : public output::FloatOutput, public Parented<Mcp4461Component> {
|
class Mcp4461Wiper : public output::FloatOutput, public Parented<Mcp4461Component> {
|
||||||
public:
|
public:
|
||||||
Mcp4461Wiper(Mcp4461Component *parent, Mcp4461WiperIdx wiper) : parent_(parent), wiper_(wiper) {}
|
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;
|
void set_state(bool state) override;
|
||||||
|
/// @brief Enables current output
|
||||||
void turn_on() override;
|
void turn_on() override;
|
||||||
|
/// @brief Disables current output
|
||||||
void turn_off() override;
|
void turn_off() override;
|
||||||
|
/// @brief Read current device wiper state without updating internal output state
|
||||||
float read_state();
|
float read_state();
|
||||||
|
/// @brief Update current output state using device wiper state
|
||||||
float update_state();
|
float update_state();
|
||||||
void enable_wiper();
|
/// @brief Increase wiper by 1 tap
|
||||||
void disable_wiper();
|
|
||||||
void increase_wiper();
|
void increase_wiper();
|
||||||
|
/// @brief Decrease wiper by 1 tap
|
||||||
void decrease_wiper();
|
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);
|
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);
|
void disable_terminal(char terminal);
|
||||||
|
|
||||||
protected:
|
protected:
|
||||||
|
Loading…
x
Reference in New Issue
Block a user