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

Merge pull request #24 from p1ngb4ck/mcp4461_dev

Browse Source 
add missing doxygen @return comments for public functions in mcp4461.h header
This commit is contained in:
Oliver Kleinecke 2025-02-20 15:00:36 +01:00 committed by GitHub
commit c36841504c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
esphome/components/mcp4461/mcp4461.h
View File

@ -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