English
English
简体中文
日本語

Chain Key ESPHome Component

Chain Key is a single-button input node in the M5Stack Chain series. The button uses a hot-swappable mechanical keyboard switch design with a strong tactile Cyan switch, and it also integrates a programmable RGB LED. It is suitable for human-machine interaction, smart home control, and other applications.

Note
To use Chain series nodes, a compatible host is required for UART communication and control, such as the Chain DualKey host, or an Atom series device paired with the Atomic ToChain Base.

1. Component Overview

Item Information
Expansion module Chain Key (U206)
Main functions Provides button input
Communication interface Chain Bus / UART
ESPHome components m5_chain_base, m5_chain_key (external components)
ESPHome version requirement 2026.9.0 or later

2. Component Details

Include External Components

Configuration Example

  • Configure the host UART pins (using the Chain DualKey as an example)
uart:
  - id: chain_uart_right
    tx_pin: GPIO6
    rx_pin: GPIO5
    baud_rate: 115200

  - id: chain_uart_left
    tx_pin: GPIO47
    rx_pin: GPIO48
    baud_rate: 115200
  • Include the external components
external_components:
  - source: github://m5stack/esphome@feat-m5-chain
    components: [m5_chain_base, m5_chain_key]
    refresh: 0s
  • Add the Chain Key
m5_chain_key:
  id: chain_key
  uart_id: chain_uart_right
  chain_index: 1
  update_interval: 50ms
Note
Set the correct index according to the actual position of the Chain.
  • Add the Chain Key binary sensor
binary_sensor:
  - platform: m5_chain_key
    m5_chain_key_id: chain_key
    name: Chain Key
  • Add the Chain Key RGB LED
output:
  - platform: m5_chain_key
    id: chain_key_red
    m5_chain_key_id: chain_key
    channel: rgb_red
  - platform: m5_chain_key
    id: chain_key_green
    m5_chain_key_id: chain_key
    channel: rgb_green
  - platform: m5_chain_key
    id: chain_key_blue
    m5_chain_key_id: chain_key
    channel: rgb_blue

light:
  - platform: rgb
    name: "Chain Key Light"
    red: chain_key_red
    green: chain_key_green
    blue: chain_key_blue

3. Reference Example

After the Chain Key expansion module is connected, you can view the corresponding Binary Sensor and Light entities on the device page:

Dashboard card example

Page Tools
PDF
On This Page