bimdown-cli 0.3.0 → 0.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -3
- package/dist/chunk-4SKM4RHY.js +142 -0
- package/dist/chunk-4SKM4RHY.js.map +1 -0
- package/dist/chunk-4YHVOWS4.js +255 -0
- package/dist/chunk-4YHVOWS4.js.map +1 -0
- package/dist/chunk-AYAXRYGP.js +2129 -0
- package/dist/chunk-AYAXRYGP.js.map +1 -0
- package/dist/chunk-EC5MR5ZH.js +648 -0
- package/dist/chunk-EC5MR5ZH.js.map +1 -0
- package/dist/chunk-HS3PO2LB.js +487 -0
- package/dist/chunk-HS3PO2LB.js.map +1 -0
- package/dist/chunk-IQJA3EFO.js +179 -0
- package/dist/chunk-IQJA3EFO.js.map +1 -0
- package/dist/chunk-JY6KWRDB.js +80 -0
- package/dist/chunk-JY6KWRDB.js.map +1 -0
- package/dist/chunk-KWSGJUMZ.js +2501 -0
- package/dist/chunk-KWSGJUMZ.js.map +1 -0
- package/dist/chunk-LWYIPR64.js +35 -0
- package/dist/chunk-LWYIPR64.js.map +1 -0
- package/dist/chunk-OBY3UYCO.js +44 -0
- package/dist/chunk-OBY3UYCO.js.map +1 -0
- package/dist/chunk-XC6WHJRL.js +29 -0
- package/dist/chunk-XC6WHJRL.js.map +1 -0
- package/dist/chunk-XQU52JKB.js +187 -0
- package/dist/chunk-XQU52JKB.js.map +1 -0
- package/dist/clash-load-D3LNQR6G.js +941 -0
- package/dist/clash-load-D3LNQR6G.js.map +1 -0
- package/dist/cli.js +431 -0
- package/dist/cli.js.map +1 -0
- package/dist/dehydrate-ZHAGOI7Q.js +90 -0
- package/dist/dehydrate-ZHAGOI7Q.js.map +1 -0
- package/dist/diff-T2KOK2WR.js +89 -0
- package/dist/diff-T2KOK2WR.js.map +1 -0
- package/dist/engine-2TPWJVEQ.js +12 -0
- package/dist/engine-2TPWJVEQ.js.map +1 -0
- package/dist/hydrate-V24H7IF3.js +673 -0
- package/dist/hydrate-V24H7IF3.js.map +1 -0
- package/dist/import-ifc-RCZSXDA6.js +5324 -0
- package/dist/import-ifc-RCZSXDA6.js.map +1 -0
- package/dist/info-QC7YXWNX.js +92 -0
- package/dist/info-QC7YXWNX.js.map +1 -0
- package/dist/init-VWDML3UC.js +112 -0
- package/dist/init-VWDML3UC.js.map +1 -0
- package/dist/lib.d.ts +492 -0
- package/dist/lib.js +6528 -0
- package/dist/lib.js.map +1 -0
- package/dist/mep-W4HJI363.js +25 -0
- package/dist/mep-W4HJI363.js.map +1 -0
- package/dist/merge-ESOPDSA5.js +413 -0
- package/dist/merge-ESOPDSA5.js.map +1 -0
- package/dist/publish-3TAXQCUV.js +80 -0
- package/dist/publish-3TAXQCUV.js.map +1 -0
- package/dist/render-UEWYHPN6.js +1807 -0
- package/dist/render-UEWYHPN6.js.map +1 -0
- package/dist/resolve-topology-AQ2RO3W3.js +338 -0
- package/dist/resolve-topology-AQ2RO3W3.js.map +1 -0
- package/dist/spec/csv-schema/annotation/dimension.yaml +77 -0
- package/dist/spec/csv-schema/annotation/tag.yaml +44 -0
- package/dist/spec/csv-schema/annotation/text_note.yaml +52 -0
- package/dist/spec/csv-schema/architecture/ceiling.yaml +8 -1
- package/dist/spec/csv-schema/architecture/column.yaml +5 -1
- package/dist/spec/csv-schema/architecture/curtain_wall.yaml +45 -5
- package/dist/spec/csv-schema/architecture/door.yaml +5 -0
- package/dist/spec/csv-schema/architecture/furniture.yaml +28 -0
- package/dist/spec/csv-schema/architecture/opening.yaml +27 -6
- package/dist/spec/csv-schema/architecture/railing.yaml +35 -0
- package/dist/spec/csv-schema/architecture/roof.yaml +34 -1
- package/dist/spec/csv-schema/architecture/slab.yaml +19 -0
- package/dist/spec/csv-schema/architecture/space.yaml +11 -1
- package/dist/spec/csv-schema/architecture/stair.yaml +49 -0
- package/dist/spec/csv-schema/architecture/stair_landing.yaml +36 -0
- package/dist/spec/csv-schema/architecture/stair_run.yaml +31 -0
- package/dist/spec/csv-schema/architecture/wall.yaml +14 -1
- package/dist/spec/csv-schema/architecture/window.yaml +19 -0
- package/dist/spec/csv-schema/base/element.yaml +20 -11
- package/dist/spec/csv-schema/base/furniture_params.yaml +60 -0
- package/dist/spec/csv-schema/base/hosted_element.yaml +10 -2
- package/dist/spec/csv-schema/base/mep_connectable.yaml +23 -0
- package/dist/spec/csv-schema/base/mep_design.yaml +24 -0
- package/dist/spec/csv-schema/base/mep_insulated.yaml +9 -0
- package/dist/spec/csv-schema/base/mep_system_tag.yaml +12 -0
- package/dist/spec/csv-schema/base/point_element.yaml +1 -0
- package/dist/spec/csv-schema/base/section_profile.yaml +5 -0
- package/dist/spec/csv-schema/base/spatial_line_element.yaml +4 -2
- package/dist/spec/csv-schema/base/structural_section_profile.yaml +50 -0
- package/dist/spec/csv-schema/base/vertical_span.yaml +9 -3
- package/dist/spec/csv-schema/base/wall_bounded.yaml +21 -0
- package/dist/spec/csv-schema/grid.yaml +5 -0
- package/dist/spec/csv-schema/mep/cable_tray.yaml +10 -3
- package/dist/spec/csv-schema/mep/circuit.yaml +70 -0
- package/dist/spec/csv-schema/mep/conduit.yaml +2 -2
- package/dist/spec/csv-schema/mep/connector.yaml +112 -0
- package/dist/spec/csv-schema/mep/duct.yaml +10 -3
- package/dist/spec/csv-schema/mep/equipment.yaml +18 -1
- package/dist/spec/csv-schema/mep/mep_node.yaml +91 -2
- package/dist/spec/csv-schema/mep/mep_system.yaml +21 -0
- package/dist/spec/csv-schema/mep/pipe.yaml +27 -3
- package/dist/spec/csv-schema/mep/terminal.yaml +22 -1
- package/dist/spec/csv-schema/model_group.yaml +40 -0
- package/dist/spec/csv-schema/sheet/sheet.yaml +50 -0
- package/dist/spec/csv-schema/sheet/sheet_viewport.yaml +86 -0
- package/dist/spec/csv-schema/structure/beam.yaml +29 -1
- package/dist/spec/csv-schema/structure/beam_system.yaml +29 -0
- package/dist/spec/csv-schema/structure/brace.yaml +24 -1
- package/dist/spec/csv-schema/structure/foundation.yaml +40 -7
- package/dist/spec/csv-schema/structure/structure_column.yaml +19 -1
- package/dist/spec/csv-schema/structure/structure_slab.yaml +32 -0
- package/dist/spec/csv-schema/structure/structure_wall.yaml +22 -0
- package/dist/spec/csv-schema/types/beam_type.yaml +11 -0
- package/dist/spec/csv-schema/types/ceiling_type.yaml +6 -0
- package/dist/spec/csv-schema/types/column_type.yaml +12 -0
- package/dist/spec/csv-schema/types/curtain_wall_type.yaml +32 -0
- package/dist/spec/csv-schema/types/door_type.yaml +27 -0
- package/dist/spec/csv-schema/types/element_type.yaml +21 -0
- package/dist/spec/csv-schema/types/fenestration.yaml +16 -0
- package/dist/spec/csv-schema/types/foundation_type.yaml +36 -0
- package/dist/spec/csv-schema/types/furniture_type.yaml +11 -0
- package/dist/spec/csv-schema/types/layered_type.yaml +13 -0
- package/dist/spec/csv-schema/types/railing_type.yaml +40 -0
- package/dist/spec/csv-schema/types/roof_type.yaml +7 -0
- package/dist/spec/csv-schema/types/slab_type.yaml +9 -0
- package/dist/spec/csv-schema/types/type_layer.yaml +47 -0
- package/dist/spec/csv-schema/types/wall_type.yaml +6 -0
- package/dist/spec/csv-schema/types/window_type.yaml +31 -0
- package/dist/spec/csv-schema/underlay.yaml +73 -0
- package/dist/spec/csv-schema/view.yaml +36 -0
- package/dist/spec/duckdb-strategy.md +4 -3
- package/dist/spec/geojson-schema/readme.md +380 -0
- package/dist/spec/mep-port-conventions.md +190 -0
- package/dist/spec/migration-guide.md +1 -1
- package/dist/spec/project_metadata.schema.yaml +52 -4
- package/dist/spec/readme.md +356 -97
- package/dist/spec/starter-types/global/beam_type.csv +5 -0
- package/dist/spec/starter-types/global/ceiling_type.csv +3 -0
- package/dist/spec/starter-types/global/column_type.csv +5 -0
- package/dist/spec/starter-types/global/curtain_wall_type.csv +2 -0
- package/dist/spec/starter-types/global/door_type.csv +6 -0
- package/dist/spec/starter-types/global/foundation_type.csv +7 -0
- package/dist/spec/starter-types/global/furniture_type.csv +11 -0
- package/dist/spec/starter-types/global/railing_type.csv +5 -0
- package/dist/spec/starter-types/global/roof_type.csv +3 -0
- package/dist/spec/starter-types/global/slab_type.csv +4 -0
- package/dist/spec/starter-types/global/type_layer.csv +40 -0
- package/dist/spec/starter-types/global/wall_type.csv +8 -0
- package/dist/spec/starter-types/global/window_type.csv +6 -0
- package/dist/spec/svg-schema/readme.md +47 -1
- package/package.json +17 -5
- package/dist/index.js +0 -3366
- package/dist/index.js.map +0 -1
- package/dist/spec/csv-schema/base/mep_connected_segment.yaml +0 -17
- package/dist/spec/csv-schema/base/mep_system.yaml +0 -7
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
# MEP Port Conventions
|
|
2
|
+
|
|
3
|
+
This document defines how MEP ports are named, what their `system_role` /
|
|
4
|
+
`flow_dir` / `domain` should be for common equipment, and how passive
|
|
5
|
+
fittings' implicit ports are derived from geometry.
|
|
6
|
+
|
|
7
|
+
**It is a guide for humans and LLMs, not a machine-readable library.** The
|
|
8
|
+
editor, CLI, and Revit add-in do **not** parse this file. Anything written
|
|
9
|
+
in `connector.csv` overrides whatever this document recommends.
|
|
10
|
+
|
|
11
|
+
## 1. Port identity
|
|
12
|
+
|
|
13
|
+
A port is identified by `host_id:name`. The pair `(host_id, name)` is
|
|
14
|
+
unique within a project.
|
|
15
|
+
|
|
16
|
+
- `host_id` — id of an `equipment`, `terminal`, or `mep_node` row
|
|
17
|
+
- `name` — string in `connector.name`, conventionally lowercase semantic
|
|
18
|
+
(e.g. `supply`, `inlet`, `in`); falls back to `c0`, `c1`, … when no
|
|
19
|
+
semantic name applies
|
|
20
|
+
|
|
21
|
+
MEP curves (`pipe` / `duct` / `conduit` / `cable_tray`) reference ports via
|
|
22
|
+
`from` and `to` columns. Examples:
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
pi-001.from = "eq-AHU-01:supply"
|
|
26
|
+
pi-001.to = "eq-VAV-01:inlet"
|
|
27
|
+
|
|
28
|
+
pi-002.from = "eq-VAV-01:outlet"
|
|
29
|
+
pi-002.to = "mn-007" # passive elbow, bare host_id
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## 2. Recommended port names by element kind
|
|
33
|
+
|
|
34
|
+
Names below are conventions, not enforced. Two principles:
|
|
35
|
+
|
|
36
|
+
- **Prefer semantic over directional**: write `supply` / `return` instead
|
|
37
|
+
of `c0` / `c1` when the role is obvious.
|
|
38
|
+
- **Lowercase, snake_case**: `supply_air`, `condensate_drain`.
|
|
39
|
+
|
|
40
|
+
### 2.1 HVAC equipment
|
|
41
|
+
|
|
42
|
+
| Equipment | Typical ports | Notes |
|
|
43
|
+
|---|---|---|
|
|
44
|
+
| AHU (Air Handling Unit) | `chws`, `chwr` (or `supply`/`return` for hydronic), `sa`, `ra`, `oa`, `condensate` | 4-pipe AHUs add `hws`/`hwr` for hot water |
|
|
45
|
+
| FCU (Fan Coil Unit) | `supply`, `return`, `sa`, `ra`, `condensate` | Smaller cousin of AHU |
|
|
46
|
+
| VAV / VAV Box | `inlet`, `outlet`, optional `reheat_supply`/`reheat_return` for reheat coils | Air-side mostly |
|
|
47
|
+
| Chiller | `chws`, `chwr`, `cws`, `cwr` | Evaporator + condenser sides |
|
|
48
|
+
| Cooling tower | `cws`, `cwr`, `makeup`, `overflow` | |
|
|
49
|
+
| Boiler | `hws`, `hwr`, `gas_in`, `flue` | |
|
|
50
|
+
| Pump | `inlet`, `outlet` | Single in, single out |
|
|
51
|
+
| Fan | `inlet`, `outlet` | Air-side pump |
|
|
52
|
+
|
|
53
|
+
### 2.2 Plumbing equipment & fixtures
|
|
54
|
+
|
|
55
|
+
| Element | Typical ports |
|
|
56
|
+
|---|---|
|
|
57
|
+
| Water heater | `cold_in`, `hot_out`, `gas_in` (or `power_in` electric) |
|
|
58
|
+
| Tank | `inlet`, `outlet`, `drain`, `overflow`, `vent` |
|
|
59
|
+
| Water closet | `cold_in`, `drain`, optional `vent` |
|
|
60
|
+
| Lavatory | `cold_in`, `hot_in`, `drain`, `vent` |
|
|
61
|
+
| Floor drain | `drain`, optional `vent` |
|
|
62
|
+
|
|
63
|
+
### 2.3 Electrical equipment
|
|
64
|
+
|
|
65
|
+
| Equipment | Typical ports |
|
|
66
|
+
|---|---|
|
|
67
|
+
| Transformer | `primary_in`, `secondary_out` |
|
|
68
|
+
| Panelboard | `main_in`, `branch_1`, `branch_2`, … |
|
|
69
|
+
| Generator | `power_out`, `fuel_in` |
|
|
70
|
+
| Light fixture | `power_in` |
|
|
71
|
+
| Receptacle | `power_in` |
|
|
72
|
+
| Data outlet | `data_in` |
|
|
73
|
+
|
|
74
|
+
### 2.4 Terminals (air-side)
|
|
75
|
+
|
|
76
|
+
| Terminal | Typical port |
|
|
77
|
+
|---|---|
|
|
78
|
+
| Supply air diffuser | `inlet` (air enters from duct, exits to space) |
|
|
79
|
+
| Return air grille | `outlet` (air enters from space, exits to duct) |
|
|
80
|
+
| Exhaust air grille | `outlet` |
|
|
81
|
+
| Sprinkler head | `inlet` |
|
|
82
|
+
|
|
83
|
+
### 2.5 Active mep_node (accessories with explicit `kind`)
|
|
84
|
+
|
|
85
|
+
| Kind | Typical ports |
|
|
86
|
+
|---|---|
|
|
87
|
+
| `valve`, `gate_valve`, `ball_valve`, `butterfly_valve`, `globe_valve`, `balancing_valve`, `damper`, `fire_damper` | `in`, `out` (offset ±L/2 along the run in the node frame, `rotation` = run direction) |
|
|
88
|
+
| `pump`, `fan` | `inlet`, `outlet` |
|
|
89
|
+
| `strainer`, `flow_meter`, `sensor`, `check_valve` | `in`, `out` |
|
|
90
|
+
| Multi-port mixing valve | `in1`, `in2`, `out` (or `cold_in`, `hot_in`, `mixed_out`) |
|
|
91
|
+
|
|
92
|
+
### 2.6 Passive mep_node (no `connector` rows)
|
|
93
|
+
|
|
94
|
+
Passive fittings (auto-elbow / tee / cross / coupling / cap / transition)
|
|
95
|
+
do **not** have `connector` rows. Pipes reference them by bare `host_id`:
|
|
96
|
+
|
|
97
|
+
```
|
|
98
|
+
pi-005.from = "mn-007"
|
|
99
|
+
pi-006.to = "mn-007"
|
|
100
|
+
pi-007.from = "mn-007" # tee with 3 incident pipes
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
The fitting kind is derived at runtime from the count and geometry of the
|
|
104
|
+
incident pipes (see §4).
|
|
105
|
+
|
|
106
|
+
## 3. Recommended `system_role` vocabulary
|
|
107
|
+
|
|
108
|
+
`system_role` is a semantic role that is **not stored on the connector**
|
|
109
|
+
(connector only has `system_type`), but is used in starter templates and
|
|
110
|
+
LLM prompts to map "I want a CHW supply port" to a project-specific
|
|
111
|
+
`system_type` tag like `CHWS`.
|
|
112
|
+
|
|
113
|
+
| Role | Meaning | Typical `system_type` tags |
|
|
114
|
+
|---|---|---|
|
|
115
|
+
| `chw_supply` | Chilled water supply | `CHWS` |
|
|
116
|
+
| `chw_return` | Chilled water return | `CHWR`, `CHR` |
|
|
117
|
+
| `cw_supply` | Condenser water supply | `CWS` |
|
|
118
|
+
| `cw_return` | Condenser water return | `CWR` |
|
|
119
|
+
| `hw_supply` | Hot water supply | `HWS` |
|
|
120
|
+
| `hw_return` | Hot water return | `HWR` |
|
|
121
|
+
| `dhw_supply` | Domestic hot water supply | `DHWS` |
|
|
122
|
+
| `dhw_recirc` | Domestic hot water recirculation | `DHWR` |
|
|
123
|
+
| `dcw` | Domestic cold water | `DCW`, `CW` |
|
|
124
|
+
| `sa` | Supply air | `SA` |
|
|
125
|
+
| `ra` | Return air | `RA` |
|
|
126
|
+
| `ea` | Exhaust air | `EA` |
|
|
127
|
+
| `oa` | Outdoor air | `OA` |
|
|
128
|
+
| `drain` | Sanitary drain / waste | `SAN`, `W` |
|
|
129
|
+
| `vent` | Sanitary vent | `V` |
|
|
130
|
+
| `condensate` | Equipment condensate drain | `CD` |
|
|
131
|
+
| `gas` | Natural gas / fuel | `G` |
|
|
132
|
+
| `fp_supply` | Fire protection supply | `FP` |
|
|
133
|
+
| `power` | Generic electrical power | `PWR` |
|
|
134
|
+
| `data` | Generic data / low-voltage | `DATA` |
|
|
135
|
+
|
|
136
|
+
## 4. Passive fitting derivation rules
|
|
137
|
+
|
|
138
|
+
For a passive `mep_node` (`kind=""`, no `connector` rows), the runtime
|
|
139
|
+
classifies it from the incident pipes:
|
|
140
|
+
|
|
141
|
+
| Incident pipes | Geometry | Classification |
|
|
142
|
+
|---|---|---|
|
|
143
|
+
| 1 | — | `cap` |
|
|
144
|
+
| 2 | collinear, equal size | `coupling` |
|
|
145
|
+
| 2 | collinear, unequal size | `reducer` |
|
|
146
|
+
| 2 | collinear, equal size + different shape | `transition` |
|
|
147
|
+
| 2 | non-collinear | `elbow` (any angle other than 0° / 180°) |
|
|
148
|
+
| 3 | branch square to the main | `tee` |
|
|
149
|
+
| 3 | branch at an angle to the main (45° drainage branch) | `wye` |
|
|
150
|
+
| 4 | two pairs of collinear | `cross` |
|
|
151
|
+
| ≥ 5 | — | `manifold` or `custom` (warn) |
|
|
152
|
+
|
|
153
|
+
A 3-way junction where the branch is small (≤ half the main width) or
|
|
154
|
+
round on a rectangular main is drawn as a **tap** (branch cut into the
|
|
155
|
+
main, no tee body). `mep_node.fitting` overrides the derived kind where
|
|
156
|
+
geometry can't tell: `tap` / `tee`, `cap` (intentional closed end — a node
|
|
157
|
+
with one curve is kept), `open` (deliberate open end: outfall, vent through
|
|
158
|
+
the roof, future connection).
|
|
159
|
+
|
|
160
|
+
A plumbing vent (`V` / `VENT`) may share a fitting with the one drainage
|
|
161
|
+
system it ventilates (`SAN`, `W`, …); any other mix of systems at a fitting
|
|
162
|
+
is a `system_mismatch`. The check also reports `duplicate_segment` (two
|
|
163
|
+
runs on top of each other), `size_mismatch` (a run ending on a device port
|
|
164
|
+
of another size: put a short port-size stub before the port, which derives
|
|
165
|
+
a transition / reducer) and `flow_balance` (equipment `flow` more than 10 %
|
|
166
|
+
off the sum of the air terminals its supply port reaches).
|
|
167
|
+
|
|
168
|
+
Geometric tolerances:
|
|
169
|
+
|
|
170
|
+
- Collinearity: angle between pipe directions ≤ 0.5°
|
|
171
|
+
- Equal size: difference ≤ 1 mm in `size_x` (round) or in both `size_x`
|
|
172
|
+
and `size_y` (rect)
|
|
173
|
+
|
|
174
|
+
If a passive `mep_node` is degenerate (two incident pipes overlap with
|
|
175
|
+
indistinguishable directions, e.g. duplicate runs), CLI `validate` should
|
|
176
|
+
emit a warning — port identity becomes ambiguous.
|
|
177
|
+
|
|
178
|
+
## 5. Revit round-trip mapping
|
|
179
|
+
|
|
180
|
+
| BimDown | Revit |
|
|
181
|
+
|---|---|
|
|
182
|
+
| `connector.name` | Prefer `Connector.Description`; else derive `supply`/`return`/`inlet`/`outlet` from `Domain` + `Direction` + system semantics; else `c{ConnectorManager.index}` |
|
|
183
|
+
| `connector.flow_dir` | `Connector.Direction` (`In` → `in`, `Out` → `out`, `Bidirectional` → `bidirectional`) |
|
|
184
|
+
| `connector.domain` | `Connector.Domain` (`DomainHvac` → `hvac`, `DomainPiping` → `piping`, `DomainElectrical` → `electrical`, `DomainCableTrayConduit` → `cable_tray_conduit`) |
|
|
185
|
+
| `equipment.family` + `type` | `FamilySymbol.Family.Name` + `FamilySymbol.Name` |
|
|
186
|
+
| `terminal.family` + `type` | same |
|
|
187
|
+
| `mep_node.family` + `type` | same |
|
|
188
|
+
| pipe `from` / `to` | Resolve the connected `Connector.Owner.UniqueId`, look up its named port; on import, write back `OwnerUniqueId:name` |
|
|
189
|
+
| Passive `mep_node` (no connector rows) | `OST_PipeFitting`/`OST_DuctFitting` with `PartType ∈ {Elbow, Tee, Cross, Union, Cap, Transition}` — connectors exist in Revit but are not re-exported (geometry-derived) |
|
|
190
|
+
| Active `mep_node` (explicit `kind`) | `OST_PipeAccessory`/`OST_DuctAccessory` — connectors are exported as `connector.csv` rows |
|
|
@@ -124,7 +124,7 @@ MEP networks are a **bipartite graph**: curves connect to nodes, nodes connect t
|
|
|
124
124
|
- `mep_curve` (duct/pipe/cable_tray/conduit) endpoints come from **connector positions** (not centerline). This ensures endpoints coincide with fitting/accessory positions.
|
|
125
125
|
- `mep_node` represents fittings and accessories. Minimal data: just position and system_type.
|
|
126
126
|
- `equipment` and `terminal` also serve as network endpoints.
|
|
127
|
-
- `
|
|
127
|
+
- `from` / `to` on curves reference the connected port via `host_id:port_name` (or bare `host_id` for passive fittings). See [`mep-port-conventions.md`](mep-port-conventions.md).
|
|
128
128
|
|
|
129
129
|
AI authoring: draw curves → call CLI `validate`/`resolve-topology` → auto-generates nodes and fills connectivity.
|
|
130
130
|
|
|
@@ -5,17 +5,65 @@ fields:
|
|
|
5
5
|
- name: format_version
|
|
6
6
|
type: string
|
|
7
7
|
required: true
|
|
8
|
-
description:
|
|
8
|
+
description: |
|
|
9
|
+
BimDown format version, which also selects the geometry encoding:
|
|
10
|
+
"1" = CSV + SVG (2D geometry), "2" = CSV + GeoJSON (2D/3D geometry).
|
|
11
|
+
Both encodings are fully supported; 2 is the default for new projects.
|
|
12
|
+
Tools may also detect the encoding from the geometry files present
|
|
13
|
+
(*.svg vs *.geojson).
|
|
9
14
|
|
|
10
15
|
- name: project_name
|
|
11
16
|
type: string
|
|
12
17
|
description: Human-readable project name
|
|
13
18
|
|
|
14
|
-
- name:
|
|
19
|
+
- name: project_number
|
|
20
|
+
type: string
|
|
21
|
+
description: Project number shown in sheet title blocks
|
|
22
|
+
|
|
23
|
+
- name: client
|
|
24
|
+
type: string
|
|
25
|
+
description: Client name shown in sheet title blocks
|
|
26
|
+
|
|
27
|
+
- name: address
|
|
15
28
|
type: string
|
|
16
|
-
description:
|
|
17
|
-
|
|
29
|
+
description: Site address shown in sheet title blocks
|
|
30
|
+
|
|
31
|
+
- name: units
|
|
32
|
+
type: enum
|
|
33
|
+
values: [m, ft, in, mm]
|
|
34
|
+
description: |
|
|
35
|
+
Unit system for all coordinates and dimensions in this project's CSV/GeoJSON
|
|
36
|
+
files (store-as-displayed model — no internal canonical unit, every numeric
|
|
37
|
+
value is in this unit). Defaults to "m" when missing to preserve existing
|
|
38
|
+
projects. Abbreviations: m = meter, ft = foot, in = inch, mm = millimeter.
|
|
39
|
+
default: m
|
|
18
40
|
|
|
19
41
|
- name: source
|
|
20
42
|
type: string
|
|
21
43
|
description: Export source (e.g. "Revit 2026", "BimDown CLI")
|
|
44
|
+
|
|
45
|
+
- name: spatial_z
|
|
46
|
+
type: enum
|
|
47
|
+
values: [absolute]
|
|
48
|
+
description: |
|
|
49
|
+
Marker that the Z in spatial elements' coordinates (beam, duct,
|
|
50
|
+
equipment, … — GeoJSON spec §4.2) is absolute, as the spec requires.
|
|
51
|
+
Written by tools that guarantee it (CLI `init`, bim.jouledown.com, the BimDown
|
|
52
|
+
editor, the legacy migration script). Older hosted projects (bim-claw.com, formerly BimClaw) without it
|
|
53
|
+
may hold level-relative Z written by earlier editor versions; see
|
|
54
|
+
bimdown-editor/scripts/migrate-spatial-z.mjs.
|
|
55
|
+
|
|
56
|
+
- name: discipline
|
|
57
|
+
type: enum
|
|
58
|
+
values: [architecture, structure, mep]
|
|
59
|
+
description: |
|
|
60
|
+
Discipline the editor opens the project in, e.g. "mep" for an imported
|
|
61
|
+
MEP model (written by `import-ifc` for MEP / structural models).
|
|
62
|
+
Default architecture.
|
|
63
|
+
- name: numbering
|
|
64
|
+
type: object
|
|
65
|
+
description: |
|
|
66
|
+
Auto-numbering (marks) per table: table name → prefix, e.g.
|
|
67
|
+
{"structure_column": "KZ", "beam": "KL", "foundation": "J", "equipment": "AHU-"}.
|
|
68
|
+
Tools that number elements write `number` = prefix + 1, 2, 3 … (doors and
|
|
69
|
+
rooms: level number + sequence). Missing tables use the tool defaults.
|