diff --git a/esphome/components/mcp4461/mcp4461.h b/esphome/components/mcp4461/mcp4461.h index b4c5f6ec8b..c44665ed99 100644 --- a/esphome/components/mcp4461/mcp4461.h +++ b/esphome/components/mcp4461/mcp4461.h @@ -84,10 +84,12 @@ class Mcp4461Component : public Component, public i2c::I2CDevice { float get_setup_priority() const override { return setup_priority::HARDWARE; } void loop() override; /// @brief get user-data value from eeprom location - /// @param[location] location to fetch data from, valid is uint8_t in range of 0-4 for 5x 9 bits of user-data + /// @param[location] location to fetch data from, valid is uint8_t in range of 0-4 for 5x 9 bits (=max int of 511) of user-data + /// @return uint16_t - returns the eeprom value stored in given eeprom user-data location uint16_t get_eeprom_value(Mcp4461EepromLocation location); /// @brief set user-data value from eeprom location /// @param[location] location to write data to, valid is uint8_t in range of 0-4 for 5x 9 bits of user-data + /// @return bool - return true on successful write, false on error/warning bool set_eeprom_value(Mcp4461EepromLocation location, uint16_t value); /// @brief set initial value for wiper /// @param[wiper] wiper for which initial_value shall be set