import esphome.codegen as cg import esphome.config_validation as cv import esphome.final_validate as fv from esphome import pins from esphome.const import ( CONF_FREQUENCY, CONF_TIMEOUT, CONF_ID, CONF_INPUT, CONF_OUTPUT, CONF_SCAN, CONF_SCL, CONF_SDA, CONF_ADDRESS, CONF_I2C_ID, PLATFORM_ESP32, PLATFORM_ESP8266, PLATFORM_RP2040, ) from esphome.core import coroutine_with_priority, CORE CODEOWNERS = ["@esphome/core"] i2c_ns = cg.esphome_ns.namespace("i2c") I2CBus = i2c_ns.class_("I2CBus") ArduinoI2CBus = i2c_ns.class_("ArduinoI2CBus", I2CBus, cg.Component) IDFI2CBus = i2c_ns.class_("IDFI2CBus", I2CBus, cg.Component) I2CDevice = i2c_ns.class_("I2CDevice") CONF_SDA_PULLUP_ENABLED = "sda_pullup_enabled" CONF_SCL_PULLUP_ENABLED = "scl_pullup_enabled" MULTI_CONF = True def _bus_declare_type(value): if CORE.using_arduino: return cv.declare_id(ArduinoI2CBus)(value) if CORE.using_esp_idf: return cv.declare_id(IDFI2CBus)(value) raise NotImplementedError pin_with_input_and_output_support = pins.internal_gpio_pin_number( {CONF_OUTPUT: True, CONF_INPUT: True} ) CONFIG_SCHEMA = cv.All( cv.Schema( { cv.GenerateID(): _bus_declare_type, cv.Optional(CONF_SDA, default="SDA"): pin_with_input_and_output_support, cv.SplitDefault(CONF_SDA_PULLUP_ENABLED, esp32_idf=True): cv.All( cv.only_with_esp_idf, cv.boolean ), cv.Optional(CONF_SCL, default="SCL"): pin_with_input_and_output_support, cv.SplitDefault(CONF_SCL_PULLUP_ENABLED, esp32_idf=True): cv.All( cv.only_with_esp_idf, cv.boolean ), cv.Optional(CONF_FREQUENCY, default="50kHz"): cv.All( cv.frequency, cv.Range(min=0, min_included=False) ), cv.Optional(CONF_TIMEOUT): cv.positive_time_period, cv.Optional(CONF_SCAN, default=True): cv.boolean, } ).extend(cv.COMPONENT_SCHEMA), cv.only_on([PLATFORM_ESP32, PLATFORM_ESP8266, PLATFORM_RP2040]), ) @coroutine_with_priority(1.0) async def to_code(config): cg.add_global(i2c_ns.using) var = cg.new_Pvariable(config[CONF_ID]) await cg.register_component(var, config) cg.add(var.set_sda_pin(config[CONF_SDA])) if CONF_SDA_PULLUP_ENABLED in config: cg.add(var.set_sda_pullup_enabled(config[CONF_SDA_PULLUP_ENABLED])) cg.add(var.set_scl_pin(config[CONF_SCL])) if CONF_SCL_PULLUP_ENABLED in config: cg.add(var.set_scl_pullup_enabled(config[CONF_SCL_PULLUP_ENABLED])) cg.add(var.set_frequency(int(config[CONF_FREQUENCY]))) cg.add(var.set_scan(config[CONF_SCAN])) if CONF_TIMEOUT in config: cg.add(var.set_timeout(int(config[CONF_TIMEOUT].total_microseconds))) if CORE.using_arduino: cg.add_library("Wire", None) def i2c_device_schema(default_address): """Create a schema for a i2c device. :param default_address: The default address of the i2c device, can be None to represent a required option. :return: The i2c device schema, `extend` this in your config schema. """ schema = { cv.GenerateID(CONF_I2C_ID): cv.use_id(I2CBus), cv.Optional("multiplexer"): cv.invalid( "This option has been removed, please see " "the tca9584a docs for the updated way to use multiplexers" ), } if default_address is None: schema[cv.Required(CONF_ADDRESS)] = cv.i2c_address else: schema[cv.Optional(CONF_ADDRESS, default=default_address)] = cv.i2c_address return cv.Schema(schema) async def register_i2c_device(var, config): """Register an i2c device with the given config. Sets the i2c bus to use and the i2c address. This is a coroutine, you need to await it with a 'yield' expression! """ parent = await cg.get_variable(config[CONF_I2C_ID]) cg.add(var.set_i2c_bus(parent)) cg.add(var.set_i2c_address(config[CONF_ADDRESS])) def final_validate_device_schema( name: str, *, min_frequency: cv.frequency = None, max_frequency: cv.frequency = None, min_timeout: cv.time_period = None, max_timeout: cv.time_period = None, ): hub_schema = {} if (min_frequency is not None) and (max_frequency is not None): hub_schema[cv.Required(CONF_FREQUENCY)] = cv.Range( min=cv.frequency(min_frequency), min_included=True, max=cv.frequency(max_frequency), max_included=True, msg=f"Component {name} requires a frequency between {min_frequency} and {max_frequency} for the I2C bus", ) elif min_frequency is not None: hub_schema[cv.Required(CONF_FREQUENCY)] = cv.Range( min=cv.frequency(min_frequency), min_included=True, msg=f"Component {name} requires a minimum frequency of {min_frequency} for the I2C bus", ) elif max_frequency is not None: hub_schema[cv.Required(CONF_FREQUENCY)] = cv.Range( max=cv.frequency(max_frequency), max_included=True, msg=f"Component {name} cannot be used with a frequency of over {max_frequency} for the I2C bus", ) if (min_timeout is not None) and (max_timeout is not None): hub_schema[cv.Required(CONF_TIMEOUT)] = cv.Range( min=cv.time_period(min_timeout), min_included=True, max=cv.time_period(max_timeout), max_included=True, msg=f"Component {name} requires a timeout between {min_timeout} and {max_timeout} for the I2C bus", ) elif min_timeout is not None: hub_schema[cv.Required(CONF_TIMEOUT)] = cv.Range( min=cv.time_period(min_timeout), min_included=True, msg=f"Component {name} requires a minimum timeout of {min_timeout} for the I2C bus", ) elif max_timeout is not None: hub_schema[cv.Required(CONF_TIMEOUT)] = cv.Range( max=cv.time_period(max_timeout), max_included=True, msg=f"Component {name} cannot be used with a timeout of over {max_timeout} for the I2C bus", ) return cv.Schema( {cv.Required(CONF_I2C_ID): fv.id_declaration_match_schema(hub_schema)}, extra=cv.ALLOW_EXTRA, )