ESP-DualKey

[中文]

Note

Please check the silkscreen version number on the main board to confirm your development board version.

This user guide will help you get started with ESP-DualKey and will also provide more in-depth information.

ESP-DualKey is an intelligent dual-key controller development board developed by Espressif based on the ESP32-S3 chip, integrating smart home control, Bluetooth keyboard, USB keyboard and other functions. It can switch between different working modes through physical switches. The development board is equipped with dual buttons, RGB lighting effects, battery management, power monitoring and other functions, providing developers with a complete intelligent button solution.

The ESP-DualKey main controller uses the Espressif ESP32-S3 chip, supporting 2.4 GHz Wi-Fi and Bluetooth 5 (LE) wireless connectivity. In terms of storage, the entire device has 8 MB flash storage space to meet the needs of intelligent button applications. It is equipped with a dual-button matrix and WS2812 RGB lighting effects, providing an intuitive and rich interactive experience.

In terms of power supply, ESP-DualKey supports USB-C power supply and built-in lithium battery power supply, integrating battery management chips and power monitoring functions. In addition, it also integrates a USB-C interface that supports power supply and programming download, while providing multiple working mode switching functions.

ESP-DualKey Front View (Click to enlarge)

ESP-DualKey Front View (Click to enlarge)

The document consists of the following major sections:

Note

For instructions on using the factory firmware, please refer to ESP-DualKey User Guide.

Getting Started

This section provides a brief introduction of ESP-DualKey, instructions on how to do the initial hardware setup and how to flash firmware onto it.

Feature List

The main features of the board are listed below:

Button Matrix Configuration:

  • 2×1 matrix configuration

  • Supports independent button detection

  • Supports combination button functions

RGB LED Features:

  • WS2812 programmable RGB LED

  • Supports multiple lighting effect modes

  • Supports brightness, hue, and saturation adjustment

Mode Switch:

  • Left Position: Bluetooth keyboard mode

  • Middle Position: USB keyboard mode

  • Right Position: Smart home mode (ESP RainMaker)

Description of Components

The key components of the board are described below. For user convenience, the components or interfaces are also labeled on the housing of ESP-DualKey.

Key Component

Description

Main Controller

ESP32-S3

Main controller chip supporting 2.4 GHz Wi-Fi and Bluetooth 5 (LE) connectivity, and featuring 8 MB of integrated flash storage.

Interaction

Dual Buttons

2×1 button matrix, supports independent key detection and combination key functions.

Mode Switch

Three-position switch for toggling between operating modes (Bluetooth keyboard/Wi-Fi Mode/USB keyboard).

RGB Lighting

WS2812 RGB LED

Programmable RGB LED supporting diverse lighting effects, e.g., heat map, breathing effect, flowing effect.

Power Management

Lithium Battery Charging Chip

TP4057 lithium battery charging management, supports USB-C charging.

Interfaces

USB-C Port

USB-C for power, programming/download, debugging, and battery charging.

Two HY2.0-4P Ports

Support auxiliary power output for connecting external sensors.

Other Components

Battery Voltage Monitoring

Real-time battery voltage and charging status monitoring.

VBUS Monitoring

Monitors USB power status.

Deep-sleep

Supports Deep-sleep mode for energy saving.

Start Developing Applications

Before powering up your board, please make sure that it is in good condition with no obvious signs of damage.

Required Hardware

  • ESP-DualKey

  • USB 2.0 cable (Standard-A to Type-C)

  • Computer running Windows, Linux, or macOS

Note

Please ensure you use an appropriate USB data cable. Some cables can only be used for charging and cannot be used for data transmission and programming.

Hardware Setup

Connect ESP-DualKey with the computer using a USB data cable through the USB-C interface for firmware flashing, debugging and power supply.

Software Setup

Please proceed to ESP-IDF Get Started to set up the development environment and flash an application example onto your board.

Note

In most cases USB drivers required to operate the board are already included in Windows, Linux, and macOS operating systems. Some additional port access or security configuration may be required depending on your OS. In case of issues please check documentation on how to establish serial connection with the board. The documentation also includes links to USB drivers applicable to boards produced by Espressif.

Espressif provides Board Support Packages (BSPs) for various Espressif boards that help you initialize and use key onboard peripherals, such as LCD displays, audio chips, buttons, and LEDs, more easily and efficiently. For a complete list of supported boards, please visit esp-bsp.

Development board application examples are stored in the Examples folder.

Hardware Reference

Block Diagram

The block diagram below shows the components of ESP-DualKey and their interconnections.

ESP-DualKey Functional Block Diagram (Click to enlarge)

ESP-DualKey Functional Block Diagram (Click to enlarge)

Power Supply Options

There are two mutually exclusive ways to provide power to the board:

  1. Through USB-C interface power supply

    When using this method for power supply, use a USB Type-C data cable to connect to the USB-C interface on the device.

  2. Through built-in lithium battery power supply

    The device has an integrated lithium battery inside, supporting independent power supply operation.

Mode Switch Circuit

The mode switch circuit diagram of the board is shown below.

Mode Switch Circuit Diagram (Click to enlarge)

Mode Switch Circuit Diagram (Click to enlarge)

Hardware Revision Details

This is the first revision of this board released.