Documentation
Get started with BLUEHASH
From unboxing to running your first flow in under 10 minutes.
Quick start
1
git clone https://github.com/bluehash-dev/bluehash-compiler
Clone the compiler service (required for code generation)
2
cd bluehash-compiler && npm install && npm run dev
Start the compiler service on port 3001
3
git clone https://github.com/bluehash-dev/bluehash-editor
Clone the editor
4
cd bluehash-editor && npm install && npm run dev
Open the editor at http://localhost:5173 in Chrome
5
Drag nodes → connect → click Flash
Plug in your ESP32-S3, click Compile & Flash, pick the COM port
System requirements
Node.js18 or later (for compiler service)
BrowserChrome or Edge (for Web Serial flash)
HardwareESP32-S3 dev board (DevKitC-1 or XIAO)
PlatformIOInstalled — compiler calls pio internally
OSWindows, macOS, or Linux
No hardware yet?
You can still use the editor and compiler service to generate firmware. Use the “Compile & download .bin” button to get the firmware file without connecting a device.
Documentation
CONCEPTS
How nodes work
Understanding node types, port connections, and how flows compile to firmware.
CONCEPTS
The HAL API
How community programs interact with hardware via the bh_* function library.
CONCEPTS
The compiler pipeline
From flow JSON to C++ to firmware.bin — what happens when you click Flash.
GUIDE
Writing a community program
How to write a program that uses the HAL API, handles exit cleanly, and publishes to the library.
GUIDE
Custom GPIO nodes
How to use digital write, analog read, PWM, I2C, SPI, and UART nodes for external modules.
GUIDE
OTA firmware updates
How to set up WiFi OTA so your device updates itself wirelessly.