• Solution
  • Store
  • Software
  • Documentation
  • About Us
  • Contact
    • English
    English
    简体中文
    日本語

    Home Assistant

    Overview

    Home Assistant

    HAOS

    CM4Stack HAOS
    AI Pyramid HAOS Docker

    ESPHome

    ESPHome Usage

    ESPHome CLI Firmware Compilation

    ESPHome Web Flash

    Controller & Devices

    Chain DualKey

    Air Quality v1.1

    PM2.5 Air Quality Kit-SHT30

    StamPLC

    PowerHub

    Station-Bat

    StackChan

    AtomS3U

    Dial

    Atom-Lite

    Cameras

    AtomS3R-M12

    AtomS3R-CAM

    TimerCamera Series

    Unit CamS3-5MP

    Unit PoE CAM-W v1.1

    Components

    Sensors

    Unit ENV-IV
    Unit ENV-Pro
    Unit DLight
    Unit IR
    Unit MQ
    Unit AMeter
    Unit VMeter
    Unit KMeter-ISO
    Unit INA226 10A/1A
    Unit AC Measure
    Unit CO2/CO2L
    Unit Mini TVOC/eCO2
    Unit NCIR
    Unit ToF
    Unit Watering
    Unit Tube Pressure
    Unit TMOS PIR
    Module13.2 Dual Kmeter

    Lighting

    Unit NeoHEX

    Input Devices

    Unit Encoder
    Unit Fader
    Unit Key
    Chain Series
    Unit Scroll
    Unit Step16
    Unit Joystick2

    Switches and Relays

    Atom Socket
    SwitchC6
    Unit 4Relay

    Audio Devices

    Atomic Audio-3.5 Base
    Voice Pyramid

    Interfaces and Expansion

    Unit EXT.IO2 / Stamp IO

    Applications

    Voice Assistant

    CoreS3
    Atom Voice
    Atom VoiceS3R
    AtomS3R + Atomic Voice Base
    AtomS3R + Voice Pyramid

    Media Playback

    AtomS3R + Atomic Audio-3.5 Base

    Dashboard

    Tab5 Home Assistant HMI

    Unit Encoder ESPHome Component

    The Unit Encoder provides encoder values, button status, and RGB LED control over the I2C bus.

    1. Component Overview

    Item Information
    Product name Unit Encoder
    SKU U135
    Main functions Encoder value, button status, and RGB LED control
    Communication interface I2C
    Default I2C address x40
    ESPHome component m5unit_encoder (external component)
    ESPHome version requirement 2026.4.5 or later

    2. Component Details

    Include the External Component

    Add the External Components configuration to your YAML file to load the Unit Encoder component.

    external_components:
  - source: github://m5stack/esphome-yaml/components
    components: [m5unit_encoder]
    refresh: 0s

    Sensor: Encoder Value

    Add a Sensor to read the encoder count. Its id can be referenced by the button and LED output components.

    sensor:
  - platform: m5unit_encoder
    id: unit_encoder_1
    name: "Encoder Value"

    The default unit is steps, the default update interval is 100ms, and the default I2C address is x40.

    Key parameters:

    Parameter Description
    id Component ID referenced by other Unit Encoder components.
    ame Entity name displayed in Home Assistant.

    Binary Sensor: Encoder Button

    Add a Binary Sensor to read the encoder button state. m5unit_encoder_id must reference the ID defined in the Sensor component.

    binary_sensor:
  - platform: m5unit_encoder
    m5unit_encoder_id: unit_encoder_1
    name: "Encoder Button"

    Output: RGB LED Channels

    Add an Output for each red, green, and blue LED channel, then reference these outputs from a Light component.

    output:
  - platform: m5unit_encoder
    m5unit_encoder_id: unit_encoder_1
    led_index: 0
    channel: red
    id: led0_red
  - platform: m5unit_encoder
    m5unit_encoder_id: unit_encoder_1
    led_index: 0
    channel: green
    id: led0_green
  - platform: m5unit_encoder
    m5unit_encoder_id: unit_encoder_1
    led_index: 0
    channel: blue
    id: led0_blue

    Key parameters:

    Parameter Description
    m5unit_encoder_id ID of the associated Sensor component.
    led_index LED index: or 1.
    channel Color channel:
    ed, green, or lue.
    id Output ID referenced by the Light component.

    Light: RGB LED

    Add a Light to combine the three color channels into an RGB light entity.

    light:
  - platform: rgb
    name: "Encoder LED 0"
    red: led0_red
    green: led0_green
    blue: led0_blue

    Key parameters:

    Parameter Description
    ame Light entity name displayed in Home Assistant.
    ed Output ID for the red channel.
    green Output ID for the green channel.
    lue Output ID for the blue channel.

    3. Reference Example

    Next Overview
    Page Tools
    PDF
    On This Page