Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/makerm0/magiclick-esp32s3
A Mechanical Macro Keyboard with Disp, based on ESP32-S3 Ver2.x
https://github.com/makerm0/magiclick-esp32s3
arduino circuitpython esp32 keyboard macropad
Last synced: 4 days ago
JSON representation
A Mechanical Macro Keyboard with Disp, based on ESP32-S3 Ver2.x
- Host: GitHub
- URL: https://github.com/makerm0/magiclick-esp32s3
- Owner: MakerM0
- Created: 2023-06-21T07:59:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-15T05:03:23.000Z (4 months ago)
- Last Synced: 2024-10-29T21:55:21.249Z (3 months ago)
- Topics: arduino, circuitpython, esp32, keyboard, macropad
- Language: C
- Homepage: https://www.elecrow.com/magiclick-open-source-multifunctional-programmable-mechanical.html
- Size: 81.8 MB
- Stars: 137
- Watchers: 6
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
https://github.com/user-attachments/assets/02206fc1-4ecb-459a-b24e-a9fd3fc22468
# MagiClick S3
## Supported modules & chips
- ESP32-S3-MINI-1-N4R2 (for Hardware v2.0)
- ESP32-S3-MINI-1-N8 (for Hardware v2.0)
- ESP32-S3FN8 (for Hardware v2.3)
# Purchase
[you can conveniently purchase it from here](https://www.elecrow.com/magiclick-open-source-multifunctional-programmable-mechanical.html).
| HW 2.0 | [HW 2.3b ](hardware) | [HW 2.3c](hardware) |
| ---------------------------- | -------------------------------- | ---------------------------- |
|  |  |  |
# Specifications
A single-button keyboard, based on ESP32-S3, with a color screen.
CircuitPython is used by default. You can also use MicroPython, Arduino.
- 0.85-inch color screen, 128x128 resolution
- esp32-s3, which supports WiFi, flash and RAM large enough to help add more functional scripts
- The overall operation is mainly based on the mechanical axis buttons in the middle, and the left and right sides of the fuselage are generally used as auxiliaries
- The keyboard axis uses a pluggable design, and you can freely choose the silent axis or others
- Built-in a small speaker, listening to a sound is so easy
- An on-board 6-axis motion sensor
- There is an expansion port on the rear side of the fuselage
- USB Type-C interface
- One reset button at the bottom
- On-board colorful LEDs
# Hardware
### v2.3
### Difference between v2.0 and v2.3
| | v2.0 | v2.3 |
| ---------------------------------------- | :----------------------------------------------------------: | :----------------------------------------------------------: |
| Display Driver | GC9107 | NV3023 |
| | 
| 
|
| Battery(with a protection circuit board) | 801230 | 602025 or 802025 |
| | 
| |
| Keyboard switch | 
| 
|
| | | |
# Software
Supports development using Arduino, CircuitPython, and MicroPython.
The "software" and "firmware" folders in this repository primarily contains the source code related to the hardware version 2.0.
When you update the circuitpython firmware of the 2.0 hardware to version 9.x, the contents of the 2.3 software [here](https://github.com/MakerM0/MagiClick-S3-Single) folder can then be used by the 2.0 hardware.
For version 2.3, please click [here](https://github.com/MakerM0/MagiClick-S3-Single).
### Guide
1. Use the Flash Download Tool to burn the Combined .bin in the Firmware folder to the board
2. After rebooting, Then copy the **.uf2** file to a USB stick
3. After rebooting, copy the contents of the softerware folder to the displayed USB stick
[help](documents/如何下载固件.pdf)
##### Settings.toml
modify your wifi information, know the weather key (need to go to the official website to apply) and city
The main button is used to access the function options
The side button or flip button can exit the current function and return to the home page
##### How to add new features
Add the .py file to the app folder
# Mechanical
#### 3D Printings
Makeronline
- [2.3](https://www.makeronline.com/en/model/magiclick%20macropad%20keyboard%20%E7%A5%9E%E5%A5%87%E6%8C%89%E9%92%AE/113241.html)
- [PACKAGING BOX](https://makeronline.com/en/model/product%20packaging%20box/48433.html)
Makerworld
- [2.0](https://makerworld.com/zh/models/404976#profileId-306794)
- [2.3](https://makerworld.com/zh/models/440612#profileId-346290)
- [2.3](https://makerworld.com/zh/models/584488#profileId-505582)
## How to contribute
Please use PR to submit contributions
In the **thirdparty** folder, create a project folder according to your own content, the naming needs to be intuitive and easy to understand, and the open source license should be added according to your own wishes
Please add a summary of the contributions in the file **contributer.md**, Add it at the end
## Images
|  |  |  |
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|  | 
|  |
|  |  | 
|
|  |  |  |
|  |  | |
# Extra
The most icons is from https://icons8.com/.
Other resource files come from the internet.
If there are copyright issues involved, please contact me to delete them.
# License
(documents/hardware/mechanical)[Creative Commons — Attribution-NonCommercial-ShareAlike 4.0 International — CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)