diff --git a/README.md b/README.md new file mode 100644 index 0000000..92c2f5f --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +Bambu.sh +--- + +A (probably terrible) Bash-based client for remote-controlling Bambu Labs 3D printers. + +This is based on [reverse-engineered MQTT message format](https://github.com/Doridian/OpenBambuAPI/blob/main/mqtt.md). + +Only tested on Linux and with my Bambu P1S 3D printer. This might require later firmware versions (mine is `01.06.00.00`) to function. + +Dependencies +--- + +- Bash +- Socat +- Mosquitto (more specifically, `mosquitto_rr` for MQTT messaging) +- jq +- curl + +Installation +--- + +This is a single script program. Download or symlink it anywhere you'd like. + +Configuration +--- + +Put the following content into `$XDG_CONFIG_HOME/bambu.conf.sh`: + +```sh +BAMBU_IP= +BAMBU_SERIAL= +BAMBU_ACCESS_CODE= +``` + +Usage +--- + +For details, run `bambu.sh help`. Some examples: + +To upload a model to `model/` inside the SD card: + +```sh +bambu.sh file put my_great_model.gcode.3mf model +``` + +To start a print using the model uploaded above: + +```sh +bambu.sh print start model/my_great_model.gcode.3mf +```