burr 0.27.0

Design-rule checks for CAD-as-code workflows.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

# Design Data Reference

`burr-design-data.json` is the language-agnostic contract Burr checks.

It can be emitted by `burr-build123d`, CadQuery, OpenSCAD, JavaScript CAD, Rust
CAD, Fusion scripts, or any tool that can write JSON.

## Minimal Shape

```json
{
  "schema_version": "burr.design-data.v1",
  "artifact_id": "actuator-mount",
  "artifact_version": "0.1.0",
  "artifact_type": "actuator_mount",
  "units": "mm",
  "source": {
    "path": "design.py",
    "sha256": "..."
  },
  "artifacts": [
    {
      "kind": "step",
      "path": "actuator.step",
      "sha256": "..."
    }
  ],
  "parts": [
    {
      "id": "housing",
      "bbox_mm": {
        "min": [-42, -16, 0],
        "max": [42, 16, 26]
      }
    }
  ],
  "features": [
    {
      "id": "m3_lower_left",
      "part": "housing",
      "kind": "clearance_hole",
      "intent": "mechanical_interface",
      "fastener": "M3",
      "diameter_mm": 3.4,
      "center_mm": [39.5, -8, 8],
      "axis": [1, 0, 0],
      "role": "loaded_mount"
    }
  ]
}
```

## Top-Level Fields

| Field | Purpose |
| --- | --- |
| `schema_version` | Must be `burr.design-data.v1` for this Burr release. |
| `artifact_id` | Stable id for the generated CAD artifact. |
| `artifact_version` | Optional design version. |
| `artifact_type` | Selects rulepack compatibility, such as `actuator_mount`. |
| `units` | Must be `mm`. |
| `source` | Source file path and hash used for freshness checks. |
| `artifacts` | Generated outputs, usually STEP, with hashes. |
| `parts` | Declared part envelopes or named bodies. |
| `features` | Declared design intent Burr can check. |
| `rulepack` | Optional rulepack path selected by the design data. |
| `measurements` | Optional named measurements for custom rulepacks. |

## Feature Intent

Burr does not infer that every cylinder or hole in a STEP file is mechanically
important. A STEP file may contain vents, lightening holes, cable routes,
cosmetic cuts, construction reliefs, bosses, fillets, and unrelated round faces.

Use `intent` to separate mechanical interfaces from incidental geometry:

```txt
mechanical_interface  -> judged by mechanical rulepacks
weight_reduction      -> declared if useful, but not judged by mount rules
fluid_or_air_path     -> separate rules, not screw-mount rules
manufacturing_feature -> process-specific rules only
cosmetic              -> normally unjudged
```

## Standoff Boss Links

For `kind: "standoff_boss"`, `supports_feature_id` links the raised boss to the
declared `clearance_hole` or `heat_set_insert_pocket` it supports.

The linked feature should expose `center_mm`, `axis`, and a comparable diameter
such as `support_diameter_mm`, `diameter_mm`, or `pocket_diameter_mm`. Burr uses
those fields to check that the boss is centered on the supported feature instead
of merely existing somewhere nearby.

For `kind: "counterbore"`, `part` should reference a part with `bbox_mm`,
`center_mm` and `axis` locate the through-hole, and `counterbore_diameter_mm`
describes the larger screw-head recess. Edge-material rules use that larger
diameter so a counterbore can fail even when the smaller bore would leave enough
material.

For `kind: "heat_set_insert_pocket"`, `part` should reference a part with
`bbox_mm`, `pocket_center_mm` locates the blind pocket cylinder, and
`bottom_center_mm` locates the pocket bottom. Back-wall rules measure from that
bottom point to the host part bbox face in the pocket-bottom direction.

For `kind: "bearing_seat"`, `part` should reference a part with `bbox_mm`,
`center_mm` and `axis` locate the seat, and `seat_diameter_mm` describes the
bearing support envelope. Edge-material rules use that diameter so a bearing
seat can fail when the seat is too close to a free edge even if the STEP seat
geometry exists.