mirror of
https://github.com/esphome/esphome.git
synced 2025-03-13 22:28:14 +00:00
Update mcp4461.h
This commit is contained in:
Oliver Kleinecke
GitHub
parent
c143219736
commit
4f5e2cbfc4
@ -101,6 +101,80 @@ class Mcp4461Component : public Component, public i2c::I2CDevice {
|
||||
/// @param[terminal] terminal to disable, one of { 'a', 'b', 'w', 'h' }
|
||||
void initialize_terminal_disabled(Mcp4461WiperIdx wiper, char terminal);
|
||||
|
||||
protected:
|
||||
friend class Mcp4461Wiper;
|
||||
/// @brief update write protection status of device
|
||||
void update_write_protection_status_();
|
||||
/// @brief fetch wiper address for given wiper
|
||||
/// @param[in] wiper - Wiper to fetch address for, int in range 0-7
|
||||
/// @return wiper - Address from Mcp4461Addresses
|
||||
uint8_t get_wiper_address_(uint8_t wiper);
|
||||
/// @brief internal i2c function to read given wiper value
|
||||
/// @return uint16_t - Value in range 0-256 representing current wiper state/level
|
||||
uint16_t read_wiper_level_(uint8_t wiper);
|
||||
/// @brief fetch device status register values
|
||||
/// @return uint8_t - Status register value - see datasheet for bit values
|
||||
uint8_t get_status_register_();
|
||||
/// @brief read current level/state of given wiper with validation checks
|
||||
/// @return uint16_t - Value in range 0-256 representing current wiper state/level
|
||||
uint16_t get_wiper_level_(Mcp4461WiperIdx wiper);
|
||||
/// @brief set level/state of given wiper
|
||||
/// @return bool - True on success, false on error/warning
|
||||
bool set_wiper_level_(Mcp4461WiperIdx wiper, uint16_t value);
|
||||
/// @brief update current level/state of given wiper
|
||||
/// @return bool - True on success, false on error/warning
|
||||
bool update_wiper_level_(Mcp4461WiperIdx wiper);
|
||||
/// @brief enable given wiper
|
||||
/// @param[in] wiper - The wiper to enable
|
||||
void enable_wiper_(Mcp4461WiperIdx wiper);
|
||||
/// @brief disable given wiper
|
||||
/// @param[in] wiper - The wiper to disable
|
||||
void disable_wiper_(Mcp4461WiperIdx wiper);
|
||||
/// @brief increase given wiper
|
||||
/// @param[in] wiper - Wiper to increase
|
||||
/// @return bool - True on success, false on error/warning
|
||||
bool increase_wiper_(Mcp4461WiperIdx wiper);
|
||||
/// @brief increase given wiper
|
||||
/// @param[in] wiper - Wiper to decrease
|
||||
/// @return bool - True on success, false on error/warning
|
||||
bool decrease_wiper_(Mcp4461WiperIdx wiper);
|
||||
/// @brief enable terminal of wiper
|
||||
/// @param[in] wiper - The desired wiper for which the terminal shall be enabled
|
||||
/// @param[in] terminal - The terminal that is to be enabled for given wiper
|
||||
void enable_terminal_(Mcp4461WiperIdx wiper, char terminal);
|
||||
/// @brief disable terminal of wiper
|
||||
/// @param[in] wiper - The desired wiper for which the terminal shall be disabled
|
||||
/// @param[in] terminal - The terminal that is to be enabled for given wiper
|
||||
void disable_terminal_(Mcp4461WiperIdx, char terminal);
|
||||
/// @brief check if device is still busy writing to eeprom
|
||||
/// @return bool - true if device is currently writing to eeprom
|
||||
bool is_writing_();
|
||||
/// @brief wait until timeout if device is busy
|
||||
/// @param[in] wait_if_not_ready - Set to true to wait until timeout again, if previous write timed out already
|
||||
/// @return bool - true if device eeprom still busy, false if rdy for write to nonvolatile wiper/eeprom
|
||||
bool is_eeprom_ready_for_writing_(bool wait_if_not_ready);
|
||||
/// @brief set wiper level
|
||||
/// @param[in] wiper - The wiper for which the new state shall be set
|
||||
/// @param[in] value - The int value in range 0-256 the wiper shall be set to
|
||||
void write_wiper_level_(uint8_t wiper, uint16_t value);
|
||||
/// @brief internal i2c write function
|
||||
/// @return bool - True write successful, false if not
|
||||
bool mcp4461_write_(uint8_t addr, uint16_t data, bool nonvolatile = false);
|
||||
/// @brief calculate correct terminal register values
|
||||
/// @return uint8_t - Calculated terminal register value for current internal terminal states
|
||||
uint8_t calc_terminal_connector_byte_(Mcp4461TerminalIdx terminal_connector);
|
||||
/// @brief internal function to update terminal registers
|
||||
void update_terminal_register_(Mcp4461TerminalIdx terminal_connector);
|
||||
/// @brief internal function to get terminal register values
|
||||
/// @return uint8_t - Get terminal register value of specified terminal
|
||||
uint8_t get_terminal_register_(Mcp4461TerminalIdx terminal_connector);
|
||||
/// @brief internal function to set terminal registers
|
||||
/// @return bool - True if write successful, false if not
|
||||
bool set_terminal_register_(Mcp4461TerminalIdx terminal_connector, uint8_t data);
|
||||
/// @brief get error code
|
||||
/// @param[in] status - The int status code
|
||||
int get_status_code(int status);
|
||||
|
||||
/// @brief available/required status codes
|
||||
enum ErrorCode {
|
||||
MCP4461_STATUS_OK = 0, // CMD completed successfully
|
||||
@ -115,76 +189,7 @@ class Mcp4461Component : public Component, public i2c::I2CDevice {
|
||||
MCP4461_WIPER_DISABLED, // The wiper is disabled - all actions for this wiper will be aborted/discarded
|
||||
MCP4461_WIPER_LOCKED, // The wiper is locked using WiperLock-technology - all actions for this wiper will be
|
||||
// aborted/discarded
|
||||
} error_code{MCP4461_STATUS_OK};
|
||||
|
||||
protected:
|
||||
friend class Mcp4461Wiper;
|
||||
/// @brief update write protection status of device
|
||||
void update_write_protection_status_();
|
||||
/// @brief fetch wiper address for given wiper
|
||||
/// @param[wiper] wiper to fetch address for, int in range 0-7
|
||||
/// @return wiper address from Mcp4461Addresses
|
||||
uint8_t get_wiper_address_(uint8_t wiper);
|
||||
/// @brief internal i2c function to read given wiper value
|
||||
/// @return uint16_t value in range 0-256 representing current wiper state/level
|
||||
uint16_t read_wiper_level_(uint8_t wiper);
|
||||
/// @brief fetch device status register values
|
||||
/// @return uint8_t status register value - see datasheet for bit values
|
||||
uint8_t get_status_register_();
|
||||
/// @brief read current level/state of given wiper with validation checks
|
||||
/// @return uint16_t value in range 0-256 representing current wiper state/level
|
||||
uint16_t get_wiper_level_(Mcp4461WiperIdx wiper);
|
||||
/// @brief set level/state of given wiper
|
||||
/// @return bool - true on success, false on error/warning
|
||||
bool set_wiper_level_(Mcp4461WiperIdx wiper, uint16_t value);
|
||||
/// @brief update current level/state of given wiper
|
||||
/// @return bool - true on success, false on error/warning
|
||||
bool update_wiper_level_(Mcp4461WiperIdx wiper);
|
||||
/// @brief enable given wiper
|
||||
/// @param[in] wiper The wiper to enable
|
||||
void enable_wiper_(Mcp4461WiperIdx wiper);
|
||||
/// @brief disable given wiper
|
||||
/// @param[in] wiper The wiper to disable
|
||||
void disable_wiper_(Mcp4461WiperIdx wiper);
|
||||
/// @brief increase given wiper
|
||||
/// @param[wiper] wiper to increase
|
||||
/// @return bool - true on success, false on error/warning
|
||||
bool increase_wiper_(Mcp4461WiperIdx wiper);
|
||||
/// @brief increase given wiper
|
||||
/// @param[wiper] wiper to increase
|
||||
/// @return bool - true on success, false on error/warning
|
||||
bool decrease_wiper_(Mcp4461WiperIdx wiper);
|
||||
/// @brief enable terminal of wiper
|
||||
/// @param[wiper] desired wiper for which the terminal shall be enabled
|
||||
void enable_terminal_(Mcp4461WiperIdx wiper, char terminal);
|
||||
/// @brief disable terminal of wiper
|
||||
/// @param[wiper] desired wiper for which the terminal shall be disabled
|
||||
void disable_terminal_(Mcp4461WiperIdx, char terminal);
|
||||
/// @brief check if device is still busy writing to eeprom
|
||||
/// @return bool - true if device is currently writing to eeprom
|
||||
bool is_writing_();
|
||||
/// @brief wait until timeout if device is busy
|
||||
/// @param[wait_if_not_ready] set to true to wait until timeout again, if previous write timed out already
|
||||
/// @return bool - true if device eeprom still busy, false if rdy for write to nonvolatile wiper/eeprom
|
||||
bool is_eeprom_ready_for_writing_(bool wait_if_not_ready);
|
||||
/// @brief set wiper level
|
||||
/// @param[wiper] wiper for which the new state shall be set
|
||||
/// @param[value] the int value in range 0-256 the wiper shall be set to
|
||||
void write_wiper_level_(uint8_t wiper, uint16_t value);
|
||||
/// @brief internal i2c write function
|
||||
/// @return bool - true write successful, false if not
|
||||
bool mcp4461_write_(uint8_t addr, uint16_t data, bool nonvolatile = false);
|
||||
/// @brief calculate correct terminal register values
|
||||
/// @return uint8_t - calculated terminal register value for current internal terminal states
|
||||
uint8_t calc_terminal_connector_byte_(Mcp4461TerminalIdx terminal_connector);
|
||||
/// @brief internal function to update terminal registers
|
||||
void update_terminal_register_(Mcp4461TerminalIdx terminal_connector);
|
||||
/// @brief internal function to get terminal register values
|
||||
/// /// @return uint8_t - get terminal register value of specified terminal
|
||||
uint8_t get_terminal_register_(Mcp4461TerminalIdx terminal_connector);
|
||||
/// @brief internal function to set terminal registers
|
||||
/// @return bool - true if write successful, false if not
|
||||
bool set_terminal_register_(Mcp4461TerminalIdx terminal_connector, uint8_t data);
|
||||
} error_code_{MCP4461_STATUS_OK};
|
||||
|
||||
WiperState reg_[8];
|
||||
void begin_();
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user