altium-to-circuit-json 0.0.87 → 0.0.89
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 +19 -0
- package/dist/index.d.ts +4970 -8
- package/dist/index.js +414 -2
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -32,11 +32,30 @@ const document = parseAltiumSchDoc(schematicBytes)
|
|
|
32
32
|
const circuitJson = convertAltiumSchDocToCircuitJson(document)
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
+
Convert a PCB and its schematic sheets together when they belong to one
|
|
36
|
+
project. The project converter gives every document its own ID scope, then
|
|
37
|
+
reconciles components, pins, named nets, and traces into shared source
|
|
38
|
+
identities:
|
|
39
|
+
|
|
40
|
+
```ts
|
|
41
|
+
const circuitJson = convertAltiumProjectToCircuitJson({
|
|
42
|
+
pcb: { document: pcbDocument },
|
|
43
|
+
schematics: [
|
|
44
|
+
{ document: powerSchematic },
|
|
45
|
+
{ document: controllerSchematic },
|
|
46
|
+
],
|
|
47
|
+
})
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
For custom document assembly, the individual document converters also accept a
|
|
51
|
+
stable `idPrefix` that is applied to every Circuit JSON ID and reference.
|
|
52
|
+
|
|
35
53
|
The public conversion functions are:
|
|
36
54
|
|
|
37
55
|
- `convertAltiumToCircuitJson(source, options)` for automatic parsing and conversion.
|
|
38
56
|
- `convertAltiumDocumentToCircuitJson(document, options)` for an already parsed document.
|
|
39
57
|
- `convertAltiumPcbDocToCircuitJson(document, options)` for PCB documents.
|
|
58
|
+
- `convertAltiumProjectToCircuitJson(input)` for a PCB and its schematic sheets.
|
|
40
59
|
- `convertAltiumSchDocToCircuitJson(document, options)` for schematic documents.
|
|
41
60
|
|
|
42
61
|
For callers that need progress visibility, debugging, or custom orchestration,
|