Welcome to the Rustboard Keyboard Firmware project! This firmware is designed from the ground up for the ESP32C3 microcontrollers, providing a robust solution for split keyboard layouts. It leverages Bluetooth Low Energy (BLE) for seamless wireless connectivity and is developed using the Rust programming language, ensuring safety and performance.
This project aims to provide a customizable and efficient firmware solution for enthusiasts and developers looking to create their own split keyboard setups. With a focus on modularity and ease of use, you can easily adapt the firmware to suit your specific needs.
- Both halves of the keyboard are connected individually: As of now, both keyboard halves are connected as indipendant keyboards. This will be fixed in the future.
The key 'A' is not being recognized by the OS: The keycode for the 'A' character is not being recognized by the OS- Fixed.Modifier keys are not working: The current implementation of the sending logic is needs to be improved- Fixed.
To compile the firmware, follow these steps:
-
Install Rust: Ensure you have Rust installed on your system. You can install it using rustup.
-
Clone the Repository:
git clone https://github.com/65787978/esp32_rustboard.git cd esp32_rustboard -
Set Up the ESP32 Rust Toolchain: Follow the instructions in the ESP-IDF documentation GitHub to set up the ESP32 Rust toolchain.
-
Build the Firmware: For left half of the keyboard with 'qwerty' layout:
cargo build --release --features "qwerty","left-side"
For right half of the keyboard with 'qwerty' layout:
cargo build --release --features "qwerty","right-side"
-
Flash the Firmware: Connect your ESP32C3 device and use the following command to flash the firmware:
espflash flash ./target/riscv32imc-esp-espidf/release/esp32_rustboard --monitor
We welcome contributions! If you would like to contribute to the project, please fork the repository and submit a pull request. For any questions or discussions, feel free to open an issue.