Project File Format

A project file (.circzy.json) contains a complete project: board, editing mode, blocks, sketch and circuit. It is created by Download in the top bar or Files › Download › Project, and opened with Import project on the home page.

Example

{
  "format": "circzy-project",
  "version": 1,
  "name": "Traffic Light",
  "board": "uno",
  "mode": "sketch",
  "blocks": null,
  "sketch": "void setup() {\n}\n\nvoid loop() {\n}\n",
  "diagram": {
    "parts": [ … ],
    "wires": [ … ]
  }
}

Fields

Field	Type	Description
`format`	string	Always `"circzy-project"`. Files with `"elka-project"` from earlier versions are accepted too.
`version`	number	Format version. Currently `1`.
`name`	string	The project name.
`board`	string	The board ID (see diagram.json Format).
`mode`	string	`"blocks"` or `"sketch"`.
`blocks`	object or null	The block workspace in Blockly's JSON serialization format, for Blocks projects. `null` for projects created as Sketch; ignored on import when `mode` is `"sketch"`.
`sketch`	string	The Arduino program. For Blocks projects it is regenerated from the blocks when the project opens.
`diagram`	object	The circuit, with the `parts` and `wires` arrays described in diagram.json Format.

Importing rules

The file must be valid JSON with a supported format and a known board.
The diagram is validated with the same rules as the diagram.json tab.
Renamed pins from earlier versions are converted automatically, and wires to pins that no longer exist are dropped.
The imported project gets a new internal ID, so importing the same file twice gives two separate projects.

Ready to try it?

Start simulating free