Aetrius / Bambulabs-Exporter

BambuLabs Prometheus Exporter by Aetrius

BAMBULABS EXPORTER

This is an exporter for all the data peeps that want to know all the things about their awesome BambuLabs 3D Printer. This was only tested on the X1C.

Supported BambuLabs X1 Firmware: 1.04.01.00

GO, DOCKER, & PROMETHEUS ⚡ Powered

This is an MQTT Exporter powered by Go & Docker. https://hub.docker.com/r/aetrius/bambulabs-exporter

Prometheus Metrics Available

• *annotates recent changes or additions

Sample Metrics Here

Metric	Description	Examples
ams_humidity_metric	Humdity of the Enclosure, includes the AMS Number 0-many
ams_temp_metric	*Temperature of the AMS, includes the AMS Number 0-many
ams_tray_color_metric	*Filament color in the AMS, includes the AMS Number 0-many & Tray Numbers 0-4
ams_bed_temp_metric	*Temperature of the AMS bed, includes the AMS Number 0-many & Tray Numbers 0-4
big_fan1_speed_metric	Big1 Fan Speed
big_fan2_speed_metric	Big2 Fan Speed
chamber_temper_metric	Temperature of the Bambu Enclosure
cooling_fan_speed_metric	Print Head Cooling Fan Speed
fail_reason_metric	Failure Print Reason Code
fan_gear_metric	Fan Gear
layer_number_metric	GCode Layer Number of the Print
mc_percent_metric	Print Progress in Percentage
mc_print_error_code_metric	Print Progress Error Code
mc_print_stage_metric	Print Progress Stage
mc_print_sub_stage_metric	Print Progress Sub Stage
mc_remaining_time_metric	Print Progress Remaining Time in minutes
nozzle_target_temper_metric	Nozzle Target Temperature Metric
nozzle_temper_metric	Nozzle Temperature Metric
print_error_metric	Print Error reported by the Control board
wifi_signal_metric	Wifi Signal Strength in dBm

---

Steps to run the exporter

Exporter Setup Video

Step 0: Prereqs

Step 1: Create the env file

Step 2: Clone the Repo

Step 3: Run Docker Compose

---

Step 0: Prereqs

This project assumes you have a Grafana/Prometheus Setup. You would point your Prometheus instance to the (host:9101) endpoint. This is not a tutorial on Prometheus / Grafana. Click here for a full stack that includes Prometheus + Grafana + exporter for this.

This program/container would run on a virtual host, raspberry pi, or a computer that has access to the BambuLabs printer. IT is possible to port forward your printer and host this in AWS or off-premise.

• Install Git (only for windows)
• Install Docker
• Install Docker-Compose

---

Step 1: env File

Create an .env file. Add the Printer IP you configured when you setup your printer. Add the Printer Password from the Printer Network Settings Menu. Add the MQTT_TOPIC for your printer. This can be achived by loading up an MQTT Application such as MQTT Explorer.

• You must Enable (TLS), use the protocol mqtt://, add the port 8883, username bblp, and the password on your printer.
• *Please note you can regenerate a password on the device manually.
• Collect the MQTT_TOPIC by expanding the "Device", "Serial Number", "Report". The result should look similar to "device/00M00A2B08124765/report"

# EXAMPLE .ENV FILE
BAMBU_PRINTER_IP=""
USERNAME="bblp"
PASSWORD=""
MQTT_TOPIC="device/00M00A2B08124765/report"

Step 2: Clone the repo

git clone https://github.com/Aetrius/Bambulabs-Exporter.git

Step 3: Run Docker Compose

cd Bambulabs-Exporter
docker-compose up -d

---

(Important Notes)

You will need to likely run an MQTT program to test your connection. You can pull the password from the printer interface manually, or reset it on the printer itself.

Prometheus Ingestion

Setup prometheus to scrape the node and setup the ports to pull from port 9101.

Bugs

• 3/4/2023 - Exporter loses connection during firmware upgrade or powercycle. (Temp solution to restart the docker container). Adding restart always to the docker-compose fixes this for now or throwing this into a kubernetes manifest works as it will restart to recover.

---

Feature Changes

• 5/28/2023 - Added Healthz endpoint
• 3/31/2023 - Added support for passing env vars to the container instead of the .env file. This helps when using a docker-compose file to pass vars OR in a kubernetes manifest to pass the vars. More to come on documentation.
• 3/4/2023 - Added new Metrics ams_humidity, ams_temp, ams_tray_color, ams_bed_temp. These include ams number and tray numbers to be dynamic depending on how many AMS's are included. Will push new container to dockerhub later today 3/4/23
• 2/28/2023 - Initial Metrics released. Further re-work needed to account for all the useful metrics available.

---

Future Development

• Add Kubernetes Configs
• Add Grafana Dashboard changes for AMS

---

Credit

Give me a shout if you utilize this code base (Anywhere!)

---

Support Questions

[e-mail]