All messages on the MQTT broker are JSON encoded
There is two ways to connect to the MQTT broker
URL: mqtt://us.mqtt.bambulab.com:8883
TLS: yes
Authentication: required
Username: u_{USER_ID}, where the user id can be grabbed by cracking your own {ACCESS_TOKEN} (which is a JWT) and reading its preferred_username field.
Password: {ACCESS_TOKEN} (the entire JWT, no prefix or suffix)
URL: mqtt://{PRINTER_IP}:8883
TLS: yes
Authentication: required
Username: bblp
Password: dev_access_code from a Device object (aka the LAN access code).
Wildcard subscriptions with # possible
For information from the device to the slicer, including responses to commands
For commands to the device from the slicer
Request structure
{
"{TYPE}": {
"sequence_id": "0", // Incremented by 1 on each command
"command": "{COMMAND}",
...
}
}Report structure
{
"{TYPE}": {
"sequence_id": "0", // Same as the one sent in the request
"command": "{COMMAND}",
"result": "success", // Case insensitive!
"reason": "", // Might not be present for some commands
... // All parameters from the original command
}
}Get current version of printer
Request
{
"info": {
"sequence_id": "0",
"command": "get_version"
}
}Report
{
"info": {
"command": "get_version",
"module": [
{
"hw_ver": "",
"name": "ota",
"sn": "",
"sw_ver": "01.01.01.00"
},
{
"hw_ver": "AP05",
"name": "rv1126",
"sn": "[REDACTED]",
"sw_ver": "00.00.14.74"
},
{
"hw_ver": "TH07",
"name": "th",
"sn": "[REDACTED]",
"sw_ver": "00.00.03.79"
},
{
"hw_ver": "MC07",
"name": "mc",
"sn": "[REDACTED]",
"sw_ver": "00.00.10.48/00.00.10.48"
},
{
"hw_ver": "",
"name": "xm",
"sn": "",
"sw_ver": "00.00.00.00"
}
],
"sequence_id": "0"
}
}Reports the complete status of the printer.
This is unnecessary for the X1 series since it already transmits the full object each time. However, the P1 series only sends the values that have been updated compared to the previous report.
Caution
As a rule of thumb, refrain from executing this command at intervals less than 5 minutes on the P1P, as it may cause lag due to its hardware limitations.
Request
{
"pushing": {
"sequence_id": "0",
"command": "pushall",
"version": 1,
"push_target": 1
}
}Report
{
"print": {
"ams": {
"ams": [
{
"humidity": "4",
"id": "0",
"temp": "22.7",
"tray": [
{
"id": "0" // an empty tray
},
{
"bed_temp": "0",
"bed_temp_type": "0",
"cols": [
"000000FF"
],
"drying_temp": "0",
"drying_time": "0",
"id": "1",
"nozzle_temp_max": "240",
"nozzle_temp_min": "190",
"remain": 0,
"tag_uid": "0000000000000000",
"tray_color": "000000FF",
"tray_diameter": "0.00",
"tray_id_name": "",
"tray_info_idx": "GFA00",
"tray_sub_brands": "",
"tray_type": "PLA",
"tray_uuid": "00000000000000000000000000000000",
"tray_weight": "0",
"xcam_info": "000000000000000000000000"
},
{
"bed_temp": "0",
"bed_temp_type": "0",
"cols": [
"DFE2E3FF"
],
"drying_temp": "0",
"drying_time": "0",
"id": "2",
"nozzle_temp_max": "240",
"nozzle_temp_min": "190",
"remain": 0,
"tag_uid": "0000000000000000",
"tray_color": "DFE2E3FF",
"tray_diameter": "0.00",
"tray_id_name": "",
"tray_info_idx": "GFA05",
"tray_sub_brands": "",
"tray_type": "PLA",
"tray_uuid": "00000000000000000000000000000000",
"tray_weight": "0",
"xcam_info": "000000000000000000000000"
},
{
"bed_temp": "0",
"bed_temp_type": "0",
"cols": [
"F95959FF"
],
"drying_temp": "0",
"drying_time": "0",
"id": "3",
"nozzle_temp_max": "240",
"nozzle_temp_min": "190",
"remain": 0,
"tag_uid": "0000000000000000",
"tray_color": "F95959FF",
"tray_diameter": "0.00",
"tray_id_name": "",
"tray_info_idx": "GFL00",
"tray_sub_brands": "",
"tray_type": "PLA",
"tray_uuid": "00000000000000000000000000000000",
"tray_weight": "0",
"xcam_info": "000000000000000000000000"
}
]
}
],
"ams_exist_bits": "1",
"insert_flag": true,
"power_on_flag": false,
"tray_exist_bits": "e",
"tray_is_bbl_bits": "e",
"tray_now": "255", // 254 if external spool / vt_tray, otherwise is ((ams_id * 4) + tray_id) for current tray (ams 2 tray 2 would be (1*4)+1 = 5)
"tray_pre": "255",
"tray_read_done_bits": "e",
"tray_reading_bits": "0",
"tray_tar": "255",
"version": 4
},
"ams_rfid_status": 6,
"ams_status": 0,
"aux_part_fan": true, // is aux fan installed
"bed_target_temper": 25.0,
"bed_temper": 25.0,
"big_fan1_speed": "0", // Auxilliary fan
"big_fan2_speed": "0", // Chamber fan
"chamber_temper": 24.0,
"command": "push_status",
"cooling_fan_speed": "0", // Part Cooling fan
"fail_reason": "0",
"fan_gear": 0,
"filam_bak": [],
"force_upgrade": false,
"gcode_file": "",
"gcode_file_prepare_percent": "0",
"gcode_start_time": "0",
"gcode_state": "IDLE",
"heatbreak_fan_speed": "0",
"hms": [],
"home_flag": 0,
"hw_switch_state": 1,
"ipcam": {
"ipcam_dev": "1",
"ipcam_record": "disable",
"resolution": "1080p",
"timelapse": "disable"
},
"layer_num": 0,
"lifecycle": "product",
"lights_report": [
{
"mode": "on",
"node": "chamber_light"
},
{
"mode": "flashing",
"node": "work_light"
}
],
"maintain": 3,
"mc_percent": 0,
"mc_print_error_code": "0",
"mc_print_stage": "1",
"mc_print_sub_stage": 0,
"mc_remaining_time": 0,
"mess_production_state": "active",
"nozzle_diameter": "0.4",
"nozzle_target_temper": 25.0,
"nozzle_temper": 25.0,
"online": {
"ahb": false,
"rfid": false,
"version": 9
},
"print_error": 0,
"print_gcode_action": 0,
"print_real_action": 0,
"print_type": "",
"profile_id": "",
"project_id": "",
"queue_number": 0,
"sdcard": true,
"sequence_id": "2021",
"spd_lvl": 2,
"spd_mag": 100,
"stg": [],
"stg_cur": -1,
"subtask_id": "",
"subtask_name": "",
"task_id": "",
"total_layer_num": 0,
"upgrade_state": {
"ahb_new_version_number": "",
"ams_new_version_number": "",
"consistency_request": false,
"dis_state": 0,
"err_code": 0,
"force_upgrade": false,
"message": "",
"module": "null",
"new_version_state": 2,
"ota_new_version_number": "",
"progress": "0",
"sequence_id": 0,
"status": "IDLE"
},
"upload": {
"file_size": 0,
"finish_size": 0,
"message": "Good",
"oss_url": "",
"progress": 0,
"sequence_id": "0903",
"speed": 0,
"status": "idle",
"task_id": "",
"time_remaining": 0,
"trouble_id": ""
},
"vt_tray": { // external spool
"bed_temp": "0",
"bed_temp_type": "0",
"cols": [
"00000000"
],
"drying_temp": "0",
"drying_time": "0",
"id": "254",
"nozzle_temp_max": "0",
"nozzle_temp_min": "0",
"remain": 0,
"tag_uid": "0000000000000000",
"tray_color": "00000000",
"tray_diameter": "0.00",
"tray_id_name": "",
"tray_info_idx": "",
"tray_sub_brands": "",
"tray_type": "",
"tray_uuid": "00000000000000000000000000000000",
"tray_weight": "0",
"xcam_info": "000000000000000000000000"
},
"wifi_signal": "-45dBm",
"xcam": {
"allow_skip_parts": false,
"buildplate_marker_detector": false,
"first_layer_inspector": true,
"halt_print_sensitivity": "medium",
"print_halt": true,
"printing_monitor": true,
"spaghetti_detector": true
},
"xcam_status": "0"
}
}Part of firmware upgrade process
Request
{
"upgrade": {
"sequence_id": "0",
"command": "upgrade_confirm",
"src_id": 1 // src_id is always 1 for the slicer
}
}Report
TODO
Part of firmware upgrade process
Request
{
"upgrade": {
"sequence_id": "0",
"command": "consistency_confirm",
"src_id": 1 // src_id is always 1 for the slicer
}
}Report
TODO
Part of firmware upgrade process
Request
{
"upgrade": {
"sequence_id": "0",
"command": "start",
"src_id": 1, // src_id is always 1 for the slicer
"url": "...",
"module": "ota", // ota or ams
"version": "",
}
}Report
TODO
Return the firmware history of the printer
Request
{
"upgrade": {
"sequence_id": "0",
"command": "get_history"
}
}Report
{
"upgrade": {
"command": "get_history",
"firmware_optional": [
{
"ams": [
{
"address": 0,
"dev_model_name": "BL-A001",
"device_id": "{DEVICE_ID}",
"firmware": [
{
"description": "",
"force_update": false,
"url": "http://public-cdn.bambulab.com/upgrade/device/BL-A001/00.00.05.96/product/ams-ota_v00.00.05.96-20230106163615.json.sig",
"version": "00.00.05.96"
}
],
"firmware_current": null
}
],
"firmware": {
"description": "",
"force_update": false,
"url": "https://public-cdn.bambulab.com/upgrade/device/BL-P001/01.04.01.00/product/ota-v01.04.01.00-20230227162230.json.sig",
"version": "01.04.01.00"
}
}
],
"reason": "",
"result": "success",
"sequence_id": "0"
}
}TODO
Stops a print. Sent with QoS of 1 for higher priority.
Request
{
"print": {
"sequence_id": "0",
"command": "stop",
"param": "", // Always empty
}
}Report
See basic structure
Pauses a print. Sent with QoS of 1 for higher priority.
Request
{
"print": {
"sequence_id": "0",
"command": "pause",
"param": "", // Always empty
}
}Report
See basic structure
Resumes a print. Sent with QoS of 1 for higher priority.
Request
{
"print": {
"sequence_id": "0",
"command": "resume",
"param": "", // Always empty
}
}Report
See basic structure
Tells printer to perform a filament change using AMS.
Request
{
"print": {
"sequence_id": "0",
"command": "ams_change_filament",
"target": 0, // ID of filament tray
"curr_temp": 0, // Old print temperature
"tar_temp": 0 // New print temperature
}
}Report
TODO
Changes the AMS settings of the given unit.
Request
{
"print": {
"sequence_id": "0",
"command": "ams_user_setting",
"ams_id": 0, // Index of the AMS
"startup_read_option": true, // Read RFID on startup
"tray_read_option": true // Read RFID on insertion
}
}Report
TODO
Changes the setting of the given filament in the given AMS.
Request
{
"print": {
"sequence_id": "0",
"command": "ams_filament_setting",
"ams_id": 0, // Index of the AMS
"tray_id": 0, // Index of the tray
"tray_info_idx": "", // Probably the setting ID of the filament profile
"tray_color": "00112233", // Formatted as hex RRGGBBAA (alpha is always FF)
"nozzle_temp_min": 0, // Minimum nozzle temp for filament (in C)
"nozzle_temp_max": 0, // Maximum nozzle temp for filament (in C)
"tray_type": "PLA" // Type of filament, such as "PLA" or "ABS"
}
}Report
TODO
Gives basic control commands for the AMS.
Request
{
"print": {
"sequence_id": "0",
"command": "ams_control",
"param": "resume" // "resume", "reset" or "pause"
}
}Report
TODO
Set print speed to one of the 4 presets.
Request
{
"print": {
"sequence_id": "0",
"command": "print_speed",
"param": "2" // Print speed level as a string
// 1 = silent
// 2 = standard
// 3 = sport
// 4 = ludicrous
}
}Report
See basic structure
Print a gcode file. This takes absolute paths.
Request
{
"print": {
"sequence_id": "0",
"command": "gcode_file",
"param": "filename.gcode" // Filename (on the printer's filesystem) to print
}
}Report
See basic structure
Send raw GCode to the printer.
Request
{
"print": {
"sequence_id": "0",
"command": "gcode_line",
"param": "M420", // Gcode to execute, can use \n for multiple lines
"user_id": "1234" // Optional
}
}Report
See basic structure
Starts calibration process.
Note: Some printers might need gcode_file with /usr/etc/print/auto_cali_for_user.gcode instead!
Request
{
"print": {
"sequence_id": "0",
"command": "calibration"
}
}Report
TODO
Unloads the filament.
Note: Some printers might need gcode_file with /usr/etc/print/filament_unload.gcode instead!
Request
{
"print": {
"sequence_id": "0",
"command": "unload_filament"
}
}Report
{
// TODO
}Prints a "project"
Request
{
"print": {
"sequence_id": "0",
"command": "project_file",
"param": "Metadata/plate_X.gcode",
"project_id": "0", // Always 0 for local prints
"profile_id": "0", // Always 0 for local prints
"task_id": "0", // Always 0 for local prints
"subtask_id": "0", // Always 0 for local prints
"subtask_name": "",
"file": "", // Filename to print, not needed when "url" is specified with filepath
"url": "file:///mnt/sdcard", // URL to print. Root path, protocol can vary. E.g., if sd card, "ftp:///myfile.3mf", "ftp:///cache/myotherfile.3mf"
"md5": "",
"timelapse": true,
"bed_type": "auto", // Always "auto" for local prints
"bed_levelling": true,
"flow_cali": true,
"vibration_cali": true,
"layer_inspect": true,
"ams_mapping": "",
"use_ams": false
}
}Report
See basic structure
Controls the LEDs of the printer.
Request
{
"system": {
"sequence_id": "0",
"command": "ledctrl",
"led_node": "chamber_light", // Either "chamber_light" or "work_light"
"led_mode": "on", // "on", "off" or "flashing"
// The below effects are only used for "flashing" mode
// but required to be present always
"led_on_time": 500, // LED on time in ms
"led_off_time": 500, // LED off time in ms
"loop_times": 1, // How many times to loop
"interval_time": 1000 // Looping interval
}
}Report
See basic structure
Gets the LAN access code of the printer
Request
{
"system": {
"sequence_id": "0",
"command": "get_access_code"
}
}Report
{
"system": {
"sequence_id": "0",
"command": "get_access_code",
"access_code": "{ACCESS_CODE}",
"result": "success"
}
}Turns on or off creating a recording of prints.
Request
{
"camera": {
"sequence_id": "0",
"command": "ipcam_record_set",
"control": "enable" // "enable" or "disable"
}
}Report
See basic structure
Turns on or off creating a timelapse of prints.
Request
{
"camera": {
"sequence_id": "0",
"command": "ipcam_timelapse",
"control": "enable" // "enable" or "disable"
}
}Report
See basic structure
Configures the XCam (camera AI features, including Micro LIDAR features).
Request
{
"xcam": {
"sequence_id": "0",
"command": "xcam_control_set",
"module_name": "first_layer_inspector", // "first_layer_inspector" or "spaghetti_detector"
"control": true, // Enable the module
"print_halt": false // Cause the module to halt the print on error
}
}Report
See basic structure
Reports printer status
The X1 series always responds with the full object. See pushing.pushall for said object.
Due to performance limitations the P1P uses the same object, but only actually responds with values that have been changed since the previous report. The full data can be requested using the pushing.pushall request.
Reports log lines of the printer. Can be requested with the pushing.pushall request.
{
"mc_print": {
"command": "push_info",
"param": "[LINK] GcodeLine (8) l=15 from 0600 ok: M106 P2 S255 \n\n",
"sequence_id": "107"
}
}Report after Lidar calibration of the pressure advance (the reported K value)
{
"mc_print": {
"command": "push_info",
"param": "[BMC] M900 KX.XXXX, LX.XXXXX, MX.XXXXX",
"sequence_id": "2004"
}
}mc_print.command = "push_info", mc_print.param = "[AMS][TASK]amsX temp:XX.X;humidity:XX%;humidity_idx:X"
Report for the raw value for AMS humidity % per AMS id
{
"mc_print": {
"command":"push_info",
"param":"[AMS][TASK]ams0 temp:18.4;humidity:30%;humidity_idx:4",
"sequence_id":"83"
}
}