circuit-json 0.0.206 → 0.0.208
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 +116 -0
- package/dist/index.d.mts +521 -238
- package/dist/index.mjs +222 -152
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -48,7 +48,10 @@ https://github.com/user-attachments/assets/2f28b7ba-689e-4d80-85b2-5bdef84b41f8
|
|
|
48
48
|
- [Source Components](#source-components)
|
|
49
49
|
- [SourceComponentBase](#sourcecomponentbase)
|
|
50
50
|
- [SourceFailedToCreateComponentError](#sourcefailedtocreatecomponenterror)
|
|
51
|
+
- [SourceGroup](#sourcegroup)
|
|
51
52
|
- [SourceMissingPropertyError](#sourcemissingpropertyerror)
|
|
53
|
+
- [SourceNet](#sourcenet)
|
|
54
|
+
- [SourcePcbGroundPlane](#sourcepcbgroundplane)
|
|
52
55
|
- [SourcePort](#sourceport)
|
|
53
56
|
- [SourceProjectMetadata](#sourceprojectmetadata)
|
|
54
57
|
- [SourceSimpleBattery](#sourcesimplebattery)
|
|
@@ -77,6 +80,8 @@ https://github.com/user-attachments/assets/2f28b7ba-689e-4d80-85b2-5bdef84b41f8
|
|
|
77
80
|
- [PcbCutout](#pcbcutout)
|
|
78
81
|
- [PcbFabricationNotePath](#pcbfabricationnotepath)
|
|
79
82
|
- [PcbFabricationNoteText](#pcbfabricationnotetext)
|
|
83
|
+
- [PcbGroundPlane](#pcbgroundplane)
|
|
84
|
+
- [PcbGroundPlaneRegion](#pcbgroundplaneregion)
|
|
80
85
|
- [PcbGroup](#pcbgroup)
|
|
81
86
|
- [PcbHole](#pcbhole)
|
|
82
87
|
- [PcbManualEditConflictWarning](#pcbmanualeditconflictwarning)
|
|
@@ -94,6 +99,7 @@ https://github.com/user-attachments/assets/2f28b7ba-689e-4d80-85b2-5bdef84b41f8
|
|
|
94
99
|
- [PcbSilkscreenText](#pcbsilkscreentext)
|
|
95
100
|
- [PcbSolderPaste](#pcbsolderpaste)
|
|
96
101
|
- [PcbText](#pcbtext)
|
|
102
|
+
- [PcbThermalSpoke](#pcbthermalspoke)
|
|
97
103
|
- [PcbTrace](#pcbtrace)
|
|
98
104
|
- [PcbTraceError](#pcbtraceerror)
|
|
99
105
|
- [PcbTraceHint](#pcbtracehint)
|
|
@@ -226,6 +232,21 @@ interface SourceFailedToCreateComponentError {
|
|
|
226
232
|
}
|
|
227
233
|
```
|
|
228
234
|
|
|
235
|
+
### SourceGroup
|
|
236
|
+
|
|
237
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_group.ts)
|
|
238
|
+
|
|
239
|
+
```typescript
|
|
240
|
+
interface SourceGroup {
|
|
241
|
+
type: "source_group"
|
|
242
|
+
source_group_id: string
|
|
243
|
+
subcircuit_id?: string
|
|
244
|
+
parent_subcircuit_id?: string
|
|
245
|
+
is_subcircuit?: boolean
|
|
246
|
+
name?: string
|
|
247
|
+
}
|
|
248
|
+
```
|
|
249
|
+
|
|
229
250
|
### SourceMissingPropertyError
|
|
230
251
|
|
|
231
252
|
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_missing_property_error.ts)
|
|
@@ -244,6 +265,43 @@ interface SourceMissingPropertyError {
|
|
|
244
265
|
}
|
|
245
266
|
```
|
|
246
267
|
|
|
268
|
+
### SourceNet
|
|
269
|
+
|
|
270
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_net.ts)
|
|
271
|
+
|
|
272
|
+
```typescript
|
|
273
|
+
interface SourceNet {
|
|
274
|
+
type: "source_net"
|
|
275
|
+
source_net_id: string
|
|
276
|
+
name: string
|
|
277
|
+
member_source_group_ids: string[]
|
|
278
|
+
is_power?: boolean
|
|
279
|
+
is_ground?: boolean
|
|
280
|
+
is_digital_signal?: boolean
|
|
281
|
+
is_analog_signal?: boolean
|
|
282
|
+
trace_width?: number
|
|
283
|
+
subcircuit_id?: string
|
|
284
|
+
subcircuit_connectivity_map_key?: string
|
|
285
|
+
}
|
|
286
|
+
```
|
|
287
|
+
|
|
288
|
+
### SourcePcbGroundPlane
|
|
289
|
+
|
|
290
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_pcb_ground_plane.ts)
|
|
291
|
+
|
|
292
|
+
Defines a ground plane in the source domain
|
|
293
|
+
|
|
294
|
+
```typescript
|
|
295
|
+
/** Defines a ground plane in the source domain */
|
|
296
|
+
interface SourcePcbGroundPlane {
|
|
297
|
+
type: "source_pcb_ground_plane"
|
|
298
|
+
source_pcb_ground_plane_id: string
|
|
299
|
+
source_group_id: string
|
|
300
|
+
source_net_id: string
|
|
301
|
+
subcircuit_id?: string
|
|
302
|
+
}
|
|
303
|
+
```
|
|
304
|
+
|
|
247
305
|
### SourcePort
|
|
248
306
|
|
|
249
307
|
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/source/source_port.ts)
|
|
@@ -694,6 +752,43 @@ interface PcbFabricationNoteText {
|
|
|
694
752
|
}
|
|
695
753
|
```
|
|
696
754
|
|
|
755
|
+
### PcbGroundPlane
|
|
756
|
+
|
|
757
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_ground_plane.ts)
|
|
758
|
+
|
|
759
|
+
Defines a ground plane on the PCB
|
|
760
|
+
|
|
761
|
+
```typescript
|
|
762
|
+
/** Defines a ground plane on the PCB */
|
|
763
|
+
interface PcbGroundPlane {
|
|
764
|
+
type: "pcb_ground_plane"
|
|
765
|
+
pcb_ground_plane_id: string
|
|
766
|
+
source_pcb_ground_plane_id: string
|
|
767
|
+
source_net_id: string
|
|
768
|
+
pcb_group_id?: string
|
|
769
|
+
subcircuit_id?: string
|
|
770
|
+
}
|
|
771
|
+
```
|
|
772
|
+
|
|
773
|
+
### PcbGroundPlaneRegion
|
|
774
|
+
|
|
775
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_ground_plane_region.ts)
|
|
776
|
+
|
|
777
|
+
Defines a polygon region of a ground plane
|
|
778
|
+
|
|
779
|
+
```typescript
|
|
780
|
+
/** Defines a polygon region of a ground plane */
|
|
781
|
+
interface PcbGroundPlaneRegion {
|
|
782
|
+
type: "pcb_ground_plane_region"
|
|
783
|
+
pcb_ground_plane_region_id: string
|
|
784
|
+
pcb_ground_plane_id: string
|
|
785
|
+
pcb_group_id?: string
|
|
786
|
+
subcircuit_id?: string
|
|
787
|
+
layer: LayerRef
|
|
788
|
+
points: Point[]
|
|
789
|
+
}
|
|
790
|
+
```
|
|
791
|
+
|
|
697
792
|
### PcbGroup
|
|
698
793
|
|
|
699
794
|
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_group.ts)
|
|
@@ -1097,6 +1192,27 @@ interface PcbText {
|
|
|
1097
1192
|
}
|
|
1098
1193
|
```
|
|
1099
1194
|
|
|
1195
|
+
### PcbThermalSpoke
|
|
1196
|
+
|
|
1197
|
+
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_thermal_spoke.ts)
|
|
1198
|
+
|
|
1199
|
+
Pattern for connecting a ground plane to a plated hole
|
|
1200
|
+
|
|
1201
|
+
```typescript
|
|
1202
|
+
/** Pattern for connecting a ground plane to a plated hole */
|
|
1203
|
+
interface PcbThermalSpoke {
|
|
1204
|
+
type: "pcb_thermal_spoke"
|
|
1205
|
+
pcb_thermal_spoke_id: string
|
|
1206
|
+
pcb_ground_plane_id: string
|
|
1207
|
+
shape: string
|
|
1208
|
+
spoke_count: number
|
|
1209
|
+
spoke_thickness: Distance
|
|
1210
|
+
spoke_inner_diameter: Distance
|
|
1211
|
+
spoke_outer_diameter: Distance
|
|
1212
|
+
pcb_plated_hole_id?: string
|
|
1213
|
+
}
|
|
1214
|
+
```
|
|
1215
|
+
|
|
1100
1216
|
### PcbTrace
|
|
1101
1217
|
|
|
1102
1218
|
[Source](https://github.com/tscircuit/circuit-json/blob/main/src/pcb/pcb_trace.ts)
|