DEKI/ENGINE docs
deki-i2c 0.19.0
Deki package reference
deki-i2c

I²C bus peripheral interface with an editor-configurable bus component

Repository: github.com/dekiengine/deki-i2c · Latest release: 0.19.0 · Needs engine 0.19.0+

Install with DekiEditor --packages-add deki-i2c <project>, or from the Package Manager. The engine's own components and C++ API are in the Deki docs.

Shown in the editor as I2C.

Components

Component Category Description
I2CBusComponent System Starts one I2C bus at boot. Every chip on that bus shares it.

Component reference

I2CBusComponent

Starts one I2C bus at boot. Every chip on that bus shares it.

Inspector name: I2C Bus Component · Category: System · Type: DekiI2c::I2CBusComponent

Property Type Default Constraints Description
i2cPort int32 0 0 to 3 Which of the chip's I2C controllers to use. Most boards only wire one, so 0 unless your schematic says otherwise.
sdaPin int32 21 0 to 48 GPIO carrying the I2C data line (SDA). Must match how the sensors are wired; every device on this bus shares it.
sclPin int32 22 0 to 48 GPIO carrying the I2C clock line (SCL). Shared by every device on this bus, like SDA.
i2cHz int32 400000 10000 to 1e+06 Bus speed. 100 kHz is the safe standard mode, 400 kHz the usual fast mode. Long wires or many devices need the lower figure; too high shows up as reads that intermittently fail.

Changelog

0.19.0

Changed

  • minEngine 0.19.0: built against engine 0.19.0, whose component metadata records the package each class is in. A build of this package from before does not load and is rebuilt.

Added

  • Japanese, Simplified Chinese and Korean: editor/lang/ja.json, zh.json and ko.json translate the names, tooltips and enum values this package's components show in the Inspector.

0.18.0

Changed

  • minEngine 0.18.0. Reflection ABI 21: the package must be rebuilt.
  • Names follow the code style (deki-engine/docs/codestyle): types, functions and enum values are PascalCase, constants kPascalCase, members m_PascalCase, locals and parameters camelCase. The code is formatted with clang-format 22.
  • The functions the editor finds by name are PascalCase: DekiI2CRegisterComponents, DekiI2CGetAutoComponentCount, DekiI2CEnsureRegistered and the rest. Built against engine ABI 21; a build of this package from before does not load and is rebuilt.

Removed

  • The former names from before 0.16.0 (bare class names, and deki-gpio's DekiEsp32::ESP32PinSetup). A scene that old is upgraded with 0.17 first.

Earlier releases: CHANGELOG.md.


Generated from the package's reflection data (engine 0.19.0). Property names are the keys used in scene files. Renames keep an alias (compatibility).