Skip to content

Commit 157e0a9

Browse files
committed
Update README.md
1 parent 7fb2753 commit 157e0a9

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,35 @@
11
# ComfyUI-Arduino
22

3+
**ComfyUI-Arduino** aims to bridge the gap between ComfyUI's powerful generative AI workflows and the physical world through Arduino. This project allows you to design, code, and interact with Arduino boards directly from your ComfyUI nodes, opening up possibilities for AI-driven robotics, physical generative art, interactive installations, and more.
4+
5+
### Core Features (Roadmap)
6+
7+
Here are the initial goals for the project:
8+
9+
- [ ] **Self-contained Installer Node:** Automatically downloads and manages `arduino-cli` locally. No manual setup required from the user, ensuring a smooth "all-in-one" experience.
10+
- [ ] **Dynamic Upload Node:** Visually build logic with nodes, which will then generate, compile, and upload a custom sketch to your connected Arduino board.
11+
- [ ] **Real-time Communication:** Implement a standard sketch and corresponding nodes to send live data (e.g., servo angles, LED colors) from ComfyUI to a running Arduino without re-uploading.
12+
- [ ] **Example Workflows:** Provide simple, functional examples to help users get started quickly.
13+
14+
### Future Vision
15+
16+
Ideas for the long-term development of the project:
17+
18+
- [ ] **Arduino Library Management:** A node to automatically install required libraries for your sketch using `arduino-cli`.
19+
- [ ] **High-Level Hardware Nodes:** Easy-to-use nodes for common components (servos, sensors, NeoPixel LEDs, etc.) that abstract away the low-level code.
20+
- [ ] **In-Workflow C++ Editor:** A dedicated node to write or paste raw Arduino (C++) code directly within ComfyUI.
21+
- [ ] **Full Sketch Export:** An option to export the generated C++ code and a list of its dependencies, allowing it to be used outside of ComfyUI.
22+
23+
### Installation
24+
25+
1. Navigate to your `ComfyUI/custom_nodes/` directory.
26+
2. Clone this repository: `git clone https://github.com/Juste-Leo2/ComfyUI-Arduino.git`
27+
3. Restart ComfyUI. The necessary dependencies, including `arduino-cli`, should be installed automatically on the first run.
28+
29+
### Contributing
30+
31+
This project is currently in the idea and planning phase. Contributions are highly welcome! Whether it's feature ideas, bug reports, code improvements, or pull requests, your help is greatly appreciated to bring this project to life.
32+
33+
### License
34+
35+
This project is licensed under the Apache 2.0 License.

0 commit comments

Comments
 (0)