feat: Added new schemas

2026-08-31 21:18:49 +00:00
parent 51dba8e896
commit d4b9f62de0
19 changed files with 295 additions and 3 deletions
@@ -2,7 +2,7 @@
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://git.octoturge.com/Continuum/continuum-schemas/raw/branch/main/schemas/bambulab/common/envelope.schema.json",
  "title": "CommandEnvelope",
-  "description": "Fields every Bambu MQTT command/response shares, across both protocol generations - unversioned, at the bambulab/ root, not duplicated under v1/ or v2/. This is the 'base class' - other schemas extend it via allOf + $ref. JSON Schema doesn't have inheritance either, strictly speaking (no 'extends' keyword) - allOf is composition: it says the instance must satisfy THIS schema AND whatever else is listed alongside it. It's the closest thing to real inheritance ergonomics of anything used across this project's schema stack (proto, Rust), because $ref + allOf lets you name and reuse a shape without re-declaring its fields, which proto/Rust composition can't quite do (there you still write `common: PrinterReportCommon` by hand on every struct).",
+  "description": "Fields every Bambu MQTT command/response shares, across both protocol generations - unversioned, at the bambulab/ root, not duplicated under v1/ or v2/. This is the 'base class' - other schemas extend it via allOf + $ref. JSON Schema doesn't have inheritance either, strictly speaking (no 'extends' keyword) - allOf is composition: it says the instance must satisfy THIS schema AND whatever else is listed alongside it. It's the closest thing to real inheritance ergonomics of anything used across this project's schema stack (proto, Rust), because $ref + allOf lets you name and reuse a shape without re-declaring its fields, which proto/Rust composition can't quite do (there you still write `common: PrinterReportCommon` by hand on every struct). Additionally, any field not defined by the schema will be returned by the printer int the original form - useful when making telemetrics.",
  "type": "object",
  "properties": {
    "sequence_id": {
@@ -21,6 +21,10 @@
    "reason": {
      "type": "string",
      "description": "Optional reason or error message"
+    },
+    "is_from_mqtt": {
+      "type": "boolean",
+      "description": "Used by BambuMQTT v2"
    }
  },
  "required": ["sequence_id", "command"]
@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.octoturge.com/Continuum/continuum-schemas/raw/branch/main/schemas/bambulab/v1/report/print/gcode_file.schema.json",
+  "title": "GcodeFileRequest",
+  "allOf": [
+    { "$ref": "../../../common/envelope.schema.json" },
+    {
+      "type": "object",
+      "properties": {
+        "command": { "const": "gcode_file" },
+        "param": { "description": "Full path to GCODE file in printer's FS", "type": "string" }
+      },
+      "required": ["param"]
+    }
+  ]
+}
@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.octoturge.com/Continuum/continuum-schemas/raw/branch/main/schemas/bambulab/v1/report/print/gcode_line.schema.json",
+  "title": "GcodeLineReport",
+  "allOf": [
+    { "$ref": "../../../common/envelope.schema.json" },
+    {
+      "type": "object",
+      "properties": {
+        "command": { "const": "gcode_line" },
+        "param": { "description": "use \n for multiple lines", "type": "string" }
+      },
+      "required": ["param"]
+    }
+  ]
+}
@@ -51,7 +51,7 @@
        "print_error": { "type": "integer" },
        "lifecycle": { "type": "string", "enum": ["product"] },
        "wifi_signal": { "type": "string", "pattern": "^-([0-9]{1,2}|100)dBm$" },
-        "gcode_state": { "type": "string", "enum": [ "idle", "IDLE", "finish", "FINISH" ] },
+        "gcode_state": { "type": "string", "enum": [ "idle", "IDLE", "finish", "FINISH", "running", "RUNNING" ] },
        "gcode_file_prepare_percent": { "type": "string" },
        "queue_number": { "type": "integer" },
        "queue_total": { "type": "integer" },
@@ -0,0 +1,20 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.octoturge.com/Continuum/continuum-schemas/raw/branch/main/schemas/bambulab/v1/report/print/print_speed.schema.json",
+  "title": "PrintSpeedReport",
+  "allOf": [
+    { "$ref": "../../../common/envelope.schema.json" },
+    {
+      "type": "object",
+      "properties": {
+        "command": { "const": "print_speed" },
+        "param": {
+          "description": "1 - silent (50%), 2 - standard (100%), 3 - sport (124%), 4 - ludicrous (166%)",
+          "type": "string",
+          "enum": ["1", "2", "3", "4"]
+        }
+      },
+      "required": ["param"]
+    }
+  ]
+}
@@ -0,0 +1,22 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.octoturge.com/Continuum/continuum-schemas/raw/branch/main/schemas/bambulab/v1/request/print/calibration.schema.json",
+  "title": "CalibrationRequest",
+  "description": "Printer responds with `push_status` instead of `calibration` with following fields set: `{ \"mc_print_stage\": 2, \"gcode_state\": \"RUNNING\", \"gcode_file_prepare_percent\": 100, \"subtask_name\": \"auto_cali_for_user_param.gcode\", \"gcode_file\": \"auto_cali_for_user_param.gcode\", \"print_type\": \"system\" }`",
+  "allOf": [
+    { "$ref": "../../../common/envelope.schema.json" },
+    {
+      "type": "object",
+      "properties": {
+        "command": { "const": "calibration" },
+        "option": {
+          "description": "Following bitmask is required for the `option` field: `if (lidarCalibration) bitmask |= 1; if (bedLevelling) bitmask |= 1 << 1; if (vibrationCompensation) bitmask |= 1 << 2; if (motorCancellation) bitmask |= 1 << 3;`",
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 15
+        }
+      },
+      "required": ["option"]
+    }
+  ]
+}
@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.octoturge.com/Continuum/continuum-schemas/raw/branch/main/schemas/bambulab/v1/request/print/gcode_file.schema.json",
+  "title": "GcodeFileRequest",
+  "allOf": [
+    { "$ref": "../../../common/envelope.schema.json" },
+    {
+      "type": "object",
+      "properties": {
+        "command": { "const": "gcode_file" },
+        "param": { "description": "Full path to GCODE file in printer's FS", "type": "string" }
+      },
+      "required": ["param"]
+    }
+  ]
+}
@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.octoturge.com/Continuum/continuum-schemas/raw/branch/main/schemas/bambulab/v1/request/print/gcode_line.schema.json",
+  "title": "GcodeLineRequest",
+  "allOf": [
+    { "$ref": "../../../common/envelope.schema.json" },
+    {
+      "type": "object",
+      "properties": {
+        "command": { "const": "gcode_line" },
+        "param": { "description": "use \n for multiple lines", "type": "string" }
+      },
+      "required": ["param"]
+    }
+  ]
+}
@@ -0,0 +1,20 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.octoturge.com/Continuum/continuum-schemas/raw/branch/main/schemas/bambulab/v1/request/print/print_speed.schema.json",
+  "title": "PrintSpeedRequest",
+  "allOf": [
+    { "$ref": "../../../common/envelope.schema.json" },
+    {
+      "type": "object",
+      "properties": {
+        "command": { "const": "print_speed" },
+        "param": {
+          "description": "1 - silent (50%), 2 - standard (100%), 3 - sport (124%), 4 - ludicrous (166%)",
+          "type": "string",
+          "enum": ["1", "2", "3", "4"]
+        }
+      },
+      "required": ["param"]
+    }
+  ]
+}
@@ -0,0 +1,15 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.octoturge.com/Continuum/continuum-schemas/raw/branch/main/schemas/bambulab/v1/request/print/gcode_line.schema.json",
+  "title": "GcodeLineRequest",
+  "allOf": [
+    { "$ref": "../../../common/envelope.schema.json" },
+    {
+      "type": "object",
+      "properties": {
+        "command": { "const": "unload_filament" }
+      },
+      "required": ["param"]
+    }
+  ]
+}
@@ -0,0 +1,22 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.octoturge.com/Continuum/continuum-schemas/raw/branch/main/schemas/bambulab/v2/report/print/calibration.schema.json",
+  "title": "CalibrationReport",
+  "description": "In contrast to Bambu MQTT v1, printer responds with `calibration` command, however it will still send `push_status` with following fields set: `{\"subtask_name\":\"auto_cali_for_user_param.gcode\",\"file\":\"/usr/etc/print/O1C2/auto_cali_for_user_param.gcode\",\"gcode_file\":\"/usr/etc/print/O1C2/auto_cali_for_user_param.gcode\",\"gcode_file_prepare_percent\":\"100\",\"gcode_state\":\"FAILED\",\"mc_print_stage\":\"1\"}`",
+  "allOf": [
+    { "$ref": "../../../common/envelope.schema.json" },
+    {
+      "type": "object",
+      "properties": {
+        "command": { "const": "calibration" },
+        "option": {
+          "description": "Following bitmask is required for the `option` field: `if (lidarCalibration) bitmask |= 1; if (bedLevelling) bitmask |= 1 << 1; if (vibrationCompensation) bitmask |= 1 << 2; if (motorCancellation) bitmask |= 1 << 3;`",
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 15
+        }
+      },
+      "required": ["option"]
+    }
+  ]
+}
@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.octoturge.com/Continuum/continuum-schemas/raw/branch/main/schemas/bambulab/v2/report/print/gcode_file.schema.json",
+  "title": "GcodeFileRequest",
+  "allOf": [
+    { "$ref": "../../../common/envelope.schema.json" },
+    {
+      "type": "object",
+      "properties": {
+        "command": { "const": "gcode_file" },
+        "param": { "description": "Full path to GCODE file in printer's FS", "type": "string" }
+      },
+      "required": ["param"]
+    }
+  ]
+}
@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.octoturge.com/Continuum/continuum-schemas/raw/branch/main/schemas/bambulab/v2/report/print/gcode_line.schema.json",
+  "title": "GcodeLineReport",
+  "allOf": [
+    { "$ref": "../../../common/envelope.schema.json" },
+    {
+      "type": "object",
+      "properties": {
+        "command": { "const": "gcode_line" },
+        "param": { "description": "use \n for multiple lines", "type": "string" }
+      },
+      "required": ["param"]
+    }
+  ]
+}
@@ -60,7 +60,7 @@
        "fail_reason": { "type": "string" },
        "file": { "type": "string" },
        "gcode_file": { "type": "string" },
-        "gcode_state": { "type": "string", "enum": [ "idle", "IDLE", "finish", "FINISH" ] },
+        "gcode_state": { "type": "string", "enum": [ "idle", "IDLE", "finish", "FINISH", "running", "RUNNING" ] },
        "gcode_file_prepare_percent": { "type": "string" },
        "force_upgrade": { "type": "boolean" },

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.octoturge.com/Continuum/continuum-schemas/raw/branch/main/schemas/bambulab/v2/report/print/print_speed.schema.json",
+  "title": "PrintSpeedReport",
+  "allOf": [
+    { "$ref": "../../../common/envelope.schema.json" },
+    {
+      "type": "object",
+      "properties": {
+        "command": { "const": "print_speed" },
+        "param": {
+          "description": "1 - silent (50%), 2 - standard (100%), 3 - sport (124%), 4 - ludicrous (166%)",
+          "type": "string",
+          "enum": ["1", "2", "3", "4"]
+        }
+      },
+      "required": ["param"]
+    }
+  ]
+}
@@ -0,0 +1,21 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.octoturge.com/Continuum/continuum-schemas/raw/branch/main/schemas/bambulab/v2/request/print/calibration.schema.json",
+  "title": "CalibrationRequest",
+  "allOf": [
+    { "$ref": "../../../common/envelope.schema.json" },
+    {
+      "type": "object",
+      "properties": {
+        "command": { "const": "calibration" },
+        "option": {
+          "description": "Following bitmask is required for the `option` field: `if (lidarCalibration) bitmask |= 1; if (bedLevelling) bitmask |= 1 << 1; if (vibrationCompensation) bitmask |= 1 << 2; if (motorCancellation) bitmask |= 1 << 3;`",
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 15
+        }
+      },
+      "required": ["option"]
+    }
+  ]
+}
@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.octoturge.com/Continuum/continuum-schemas/raw/branch/main/schemas/bambulab/v2/request/print/gcode_file.schema.json",
+  "title": "GcodeFileRequest",
+  "allOf": [
+    { "$ref": "../../../common/envelope.schema.json" },
+    {
+      "type": "object",
+      "properties": {
+        "command": { "const": "gcode_file" },
+        "param": { "description": "Full path to GCODE file in printer's FS", "type": "string" }
+      },
+      "required": ["param"]
+    }
+  ]
+}
@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.octoturge.com/Continuum/continuum-schemas/raw/branch/main/schemas/bambulab/v2/request/print/gcode_line.schema.json",
+  "title": "GcodeLineRequest",
+  "allOf": [
+    { "$ref": "../../../common/envelope.schema.json" },
+    {
+      "type": "object",
+      "properties": {
+        "command": { "const": "gcode_line" },
+        "param": { "description": "use \n for multiple lines", "type": "string" }
+      },
+      "required": ["param"]
+    }
+  ]
+}
@@ -0,0 +1,20 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://git.octoturge.com/Continuum/continuum-schemas/raw/branch/main/schemas/bambulab/v2/request/print/print_speed.schema.json",
+  "title": "PrintSpeedRequest",
+  "allOf": [
+    { "$ref": "../../../common/envelope.schema.json" },
+    {
+      "type": "object",
+      "properties": {
+        "command": { "const": "print_speed" },
+        "param": {
+          "description": "1 - silent (50%), 2 - standard (100%), 3 - sport (124%), 4 - ludicrous (166%)",
+          "type": "string",
+          "enum": ["1", "2", "3", "4"]
+        }
+      },
+      "required": ["param"]
+    }
+  ]
+}