i2c_bus.h

Go to the documentation of this file.

#pragma once
#include <cstddef>
#include <cstdint>
#include <utility>
#include <vector>
 
#include "esphome/core/helpers.h"
 
namespace esphome::i2c {
 
enum ErrorCode {
  NO_ERROR = 0,                
  ERROR_OK = 0,                
  ERROR_INVALID_ARGUMENT = 1,  
  ERROR_NOT_ACKNOWLEDGED = 2,  
  ERROR_TIMEOUT = 3,           
  ERROR_NOT_INITIALIZED = 4,   
  ERROR_TOO_LARGE = 5,         
  ERROR_UNKNOWN = 6,           
  ERROR_CRC = 7,               
};
 
class I2CBus {
 public:
  virtual ~I2CBus() = default;
 
  virtual ErrorCode write_readv(uint8_t address, const uint8_t *write_buffer, size_t write_count, uint8_t *read_buffer,
                                size_t read_count) = 0;
 
  // Legacy functions for compatibility
 
  ErrorCode read(uint8_t address, uint8_t *buffer, size_t len) {
    return this->write_readv(address, nullptr, 0, buffer, len);
  }
 
  ErrorCode write(uint8_t address, const uint8_t *buffer, size_t len, bool stop = true) {
    return this->write_readv(address, buffer, len, nullptr, 0);
  }
 
 protected:
  void i2c_scan_();
  std::vector<std::pair<uint8_t, bool>> scan_results_;  
  bool scan_{false};                                    
};
 
class InternalI2CBus : public I2CBus {
 public:
  virtual int get_port() const = 0;
};
 
}  // namespace esphome::i2c