diagram.json Format

diagram.json describes the circuit of a project: the parts on the canvas and the wires between them. You can read and edit it in the diagram.json tab of the editor; valid changes are applied to the canvas immediately, and invalid ones show an error without changing anything.

Example

{
  "version": 1,
  "editor": "circzy",
  "board": "uno",
  "parts": [
    { "id": "uno", "type": "arduino-uno", "x": 0, "y": 0, "rotate": 0, "flip": false, "color": "", "value": "", "level": 0 },
    { "id": "led1", "type": "led", "x": 260, "y": -120, "rotate": 0, "flip": false, "color": "red", "value": "", "level": 0 },
    { "id": "r1", "type": "resistor", "x": 240, "y": -40, "rotate": 90, "flip": false, "color": "", "value": "220", "level": 0 }
  ],
  "wires": [
    { "id": "w1", "from": { "partId": "uno", "pin": "13" }, "to": { "partId": "r1", "pin": "1" }, "color": "#1f9d48", "points": [] },
    { "id": "w2", "from": { "partId": "r1", "pin": "2" }, "to": { "partId": "led1", "pin": "A" }, "color": "#1f9d48", "points": [] },
    { "id": "w3", "from": { "partId": "led1", "pin": "C" }, "to": { "partId": "uno", "pin": "GND.1" }, "color": "#1c1c1c", "points": [{ "x": 300, "y": 40 }] }
  ]
}

Top-level fields

Parts

The diagram must contain the project's board, and no board of another type. Missing optional fields get their default values.

Wires

Pin names

Pins are named after the labels printed on the parts: 13, A0, GND.1 on an Arduino Uno; D21, 3V3 on an ESP32 DevKit; VCC, GND, SDA, SCL on an I²C module; A and C for LED anode and cathode; 1 and 2 for resistor legs. When several pins share a name, a suffix such as .1 and .2 makes them unique; pins with the same base name are connected to each other.

Breadboard holes are named <column><half>.<row>, for example 12t.a or 5b.j, and rail holes tp.3, tn.3, bp.3 and bn.3.

Validation errors