@windypro-rourou/dsh-eda 0.1.4 → 0.1.6

package/skill/format/schematic/component.md

@@ -1,91 +1,91 @@
-# COMPONENT
-
--   `COMPONENT` references a Symbol. Since a Symbol supports multiple Parts, it carries a `sub-library ID` to indicate which one; for a single-Part device, the default value `""` is used.
--   A `COMPONENT` can bind many `ATTR`s; specific attribute behavior is defined by the tool.
-
-### Symbol Types
-
-| Symbol Type ID | Symbol Type     | Description                                                                                                                                                                                                                   |
-| :-------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| 2               | Part Symbol     | Common device.                                                                                                                                                                                                               |
-| 17              | Block Symbol    | Hierarchical symbol.                                                                                                                                                                                                         |
-| 18              | NetFlag Symbol  | Global net symbol.                                                                                                                                                                                                         |
-| 19              | NetPort Symbol  | Hierarchical net export symbol.                                                                                                                                                                                              |
-| 20              | Sheet Symbol    | Provides a reuse mechanism for schematic sheets.                                                                                                                                                                             |
-| 21              | NoneElec Symbol | Non-electrical symbol. NoneElec is a class of non-electrical primitives without `PIN`.<br>Can also be used as a reuse mechanism for special icons, copyright statements, etc.<br>NoneElec stands for None Electrical. |
-| 22              | Short Symbol    | Short Symbol is a special Symbol that must have two `PIN`s.<br>All nets connected to the `PIN`s of the same `Short Symbol` are electrically shorted.<br>For example, if net A is connected to PIN1 and net B to PIN2, A and B are the same net. |
-
-### Component Primitive
-
-```json
-{ "type": "COMPONENT", "id": "UUID", "ticket": 1 }||
-{
-    "partId": "e176",
-    "groupId": 0,
-    "positionX": 300,
-    "positionY": 200,
-    "rotation": 15,
-    "isMirror": false,
-    "data": {},
-}|
-```
-
-1. type COMPONENT identifier: COMPONENT.
-2. id ID, unique within the file.
-3. ticket logical clock.
-4. partId sub-library ID.
-5. groupId group ID, cannot be 0, empty by default when none.
-6. zIndex Z-axis height: all non-attribute child elements are distributed within Z0 ~ Z9, e.g. Z of 23.554 means child elements are auto-distributed within 23.5540 ~ 23.5549.
-7. positionX position X.
-8. positionY position Y.
-9. rotation rotation angle, around `position`.
-10. isMirror whether mirrored.
-11. data pure data attributes: additional information for internal editor logic.
-
-The Symbol referenced by a Component is transformed in the following order:
-
-1. Rotate counter-clockwise around the origin (0,0) by the `rotation angle`.
-2. If `isMirror` is `1`, mirror horizontally around the Y-axis at the origin (0,0).
-3. Translate by `position`.
-
-Or equivalently (but more cumbersome to implement):
-
-1. Translate by `position`.
-2. Rotate counter-clockwise around `position` by the `rotation angle`.
-3. If `isMirror` is `1`, mirror horizontally around the Y-axis at `position`.
-
-```json
-{ "type": "ATTR", "id": "e187", "ticket": 1 }||
-{ "partId": "", "groupId": 0, "locked": true, "zIndex": 0.1, "parentId": "e176", "key":"Device", "value":"device-uuid-1", "keyVisible":true, "valueVisible":true, "positionX":300, "positionY":200, "rotation":0, "color":null, "fillColor":null, "fontFamily":null, "fontSize":null, "strikeout":null, "underline":null, "italic":null, "fontWeight":null, "vAlign":0, "hAlign":2,}|
-```
-
-Device uuid, consistent with the file name corresponding to the device in project.json.
-
-```json
-{ "type": "ATTR", "id": "e188", "ticket": 1 }||
-{ "partId": "", "groupId": 0, "locked": true, "zIndex": 0.1, "parentId": "e176", "key":"Symbol", "value":"symbol-uuid-1", "keyVisible":true, "valueVisible":true, "positionX":300, "positionY":200, "rotation":0, "color":null, "fillColor":null, "fontFamily":null, "fontSize":null, "strikeout":null, "underline":null, "italic":null, "fontWeight":null, "vAlign":0, "hAlign":2,}|
-```
-
-An `ATTR` inside `COMPONENT` with the same name as one in the template will override it. Overriding Symbol affects the binding between the device and the symbol.
-
-```json
-{ "type": "ATTR", "id": "e188", "ticket": 1 }||
-{ "partId": "", "groupId": 0, "locked": true, "zIndex": 0.1, "parentId": "e176", "key":"Footprint", "value":"footprint-uuid-1", "keyVisible":true, "valueVisible":true, "positionX":300, "positionY":200, "rotation":0, "color":null, "fillColor":null, "fontFamily":null, "fontSize":null, "strikeout":null, "underline":null, "italic":null, "fontWeight":null, "vAlign":0, "hAlign":2,}|
-```
-
-An `ATTR` inside `COMPONENT` with the same name as one in the template will override it. Overriding Footprint affects the binding between the device and the footprint.
-
-```json
-{ "type": "ATTR", "id": "e188", "ticket": 1 }||
-{ "partId": "", "groupId": 0, "locked": true, "zIndex": 0.1, "parentId": "e176", "key":"Designator", "value":"U1", "keyVisible":true, "valueVisible":true, "positionX":300, "positionY":200, "rotation":0, "color":null, "fillColor":null, "fontFamily":null, "fontSize":null, "strikeout":null, "underline":null, "italic":null, "fontWeight":null, "vAlign":0, "hAlign":2,}|
-```
-
-An `ATTR` inside `COMPONENT` with the same name as one in the template will override it.
-
-```json
-{ "type": "ATTR", "id": "e180", "ticket": 1 }||
-{ "partId": "", "groupId": 0, "locked": true, "zIndex": 0.1, "parentId": "e176e5", "key":"NUMBER", "value":"1", "keyVisible":true, "valueVisible":true, "positionX":108, "positionY":804.5, "rotation":0, "color":null, "fillColor":null, "fontFamily":null, "fontSize":null, "strikeout":null, "underline":null, "italic":null, "fontWeight":null, "vAlign":0, "hAlign":2,}|
-```
-
-The key to `PIN` attribute override lies in the `parentId` of `ATTR`.
-The ID has two parts, e.g. `e176e5`, where `e176` is the `COMPONENT` ID and `e5` is the `PIN` ID in the template.
+# COMPONENT
+
+-   `COMPONENT` references a Symbol. Since a Symbol supports multiple Parts, it carries a `sub-library ID` to indicate which one; for a single-Part device, the default value `""` is used.
+-   A `COMPONENT` can bind many `ATTR`s; specific attribute behavior is defined by the tool.
+
+### Symbol Types
+
+| Symbol Type ID | Symbol Type     | Description                                                                                                                                                                                                                   |
+| :-------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| 2               | Part Symbol     | Common device.                                                                                                                                                                                                               |
+| 17              | Block Symbol    | Hierarchical symbol.                                                                                                                                                                                                         |
+| 18              | NetFlag Symbol  | Global net symbol.                                                                                                                                                                                                         |
+| 19              | NetPort Symbol  | Hierarchical net export symbol.                                                                                                                                                                                              |
+| 20              | Sheet Symbol    | Provides a reuse mechanism for schematic sheets.                                                                                                                                                                             |
+| 21              | NoneElec Symbol | Non-electrical symbol. NoneElec is a class of non-electrical primitives without `PIN`.<br>Can also be used as a reuse mechanism for special icons, copyright statements, etc.<br>NoneElec stands for None Electrical. |
+| 22              | Short Symbol    | Short Symbol is a special Symbol that must have two `PIN`s.<br>All nets connected to the `PIN`s of the same `Short Symbol` are electrically shorted.<br>For example, if net A is connected to PIN1 and net B to PIN2, A and B are the same net. |
+
+### Component Primitive
+
+```json
+{ "type": "COMPONENT", "id": "UUID", "ticket": 1 }||
+{
+    "partId": "e176",
+    "groupId": 0,
+    "positionX": 300,
+    "positionY": 200,
+    "rotation": 15,
+    "isMirror": false,
+    "data": {},
+}|
+```
+
+1. type COMPONENT identifier: COMPONENT.
+2. id ID, unique within the file.
+3. ticket logical clock.
+4. partId sub-library ID.
+5. groupId group ID, cannot be 0, empty by default when none.
+6. zIndex Z-axis height: all non-attribute child elements are distributed within Z0 ~ Z9, e.g. Z of 23.554 means child elements are auto-distributed within 23.5540 ~ 23.5549.
+7. positionX position X.
+8. positionY position Y.
+9. rotation rotation angle, around `position`.
+10. isMirror whether mirrored.
+11. data pure data attributes: additional information for internal editor logic.
+
+The Symbol referenced by a Component is transformed in the following order:
+
+1. Rotate counter-clockwise around the origin (0,0) by the `rotation angle`.
+2. If `isMirror` is `1`, mirror horizontally around the Y-axis at the origin (0,0).
+3. Translate by `position`.
+
+Or equivalently (but more cumbersome to implement):
+
+1. Translate by `position`.
+2. Rotate counter-clockwise around `position` by the `rotation angle`.
+3. If `isMirror` is `1`, mirror horizontally around the Y-axis at `position`.
+
+```json
+{ "type": "ATTR", "id": "e187", "ticket": 1 }||
+{ "partId": "", "groupId": 0, "locked": true, "zIndex": 0.1, "parentId": "e176", "key":"Device", "value":"device-uuid-1", "keyVisible":true, "valueVisible":true, "positionX":300, "positionY":200, "rotation":0, "color":null, "fillColor":null, "fontFamily":null, "fontSize":null, "strikeout":null, "underline":null, "italic":null, "fontWeight":null, "vAlign":0, "hAlign":2,}|
+```
+
+Device uuid, consistent with the file name corresponding to the device in project.json.
+
+```json
+{ "type": "ATTR", "id": "e188", "ticket": 1 }||
+{ "partId": "", "groupId": 0, "locked": true, "zIndex": 0.1, "parentId": "e176", "key":"Symbol", "value":"symbol-uuid-1", "keyVisible":true, "valueVisible":true, "positionX":300, "positionY":200, "rotation":0, "color":null, "fillColor":null, "fontFamily":null, "fontSize":null, "strikeout":null, "underline":null, "italic":null, "fontWeight":null, "vAlign":0, "hAlign":2,}|
+```
+
+An `ATTR` inside `COMPONENT` with the same name as one in the template will override it. Overriding Symbol affects the binding between the device and the symbol.
+
+```json
+{ "type": "ATTR", "id": "e188", "ticket": 1 }||
+{ "partId": "", "groupId": 0, "locked": true, "zIndex": 0.1, "parentId": "e176", "key":"Footprint", "value":"footprint-uuid-1", "keyVisible":true, "valueVisible":true, "positionX":300, "positionY":200, "rotation":0, "color":null, "fillColor":null, "fontFamily":null, "fontSize":null, "strikeout":null, "underline":null, "italic":null, "fontWeight":null, "vAlign":0, "hAlign":2,}|
+```
+
+An `ATTR` inside `COMPONENT` with the same name as one in the template will override it. Overriding Footprint affects the binding between the device and the footprint.
+
+```json
+{ "type": "ATTR", "id": "e188", "ticket": 1 }||
+{ "partId": "", "groupId": 0, "locked": true, "zIndex": 0.1, "parentId": "e176", "key":"Designator", "value":"U1", "keyVisible":true, "valueVisible":true, "positionX":300, "positionY":200, "rotation":0, "color":null, "fillColor":null, "fontFamily":null, "fontSize":null, "strikeout":null, "underline":null, "italic":null, "fontWeight":null, "vAlign":0, "hAlign":2,}|
+```
+
+An `ATTR` inside `COMPONENT` with the same name as one in the template will override it.
+
+```json
+{ "type": "ATTR", "id": "e180", "ticket": 1 }||
+{ "partId": "", "groupId": 0, "locked": true, "zIndex": 0.1, "parentId": "e176e5", "key":"NUMBER", "value":"1", "keyVisible":true, "valueVisible":true, "positionX":108, "positionY":804.5, "rotation":0, "color":null, "fillColor":null, "fontFamily":null, "fontSize":null, "strikeout":null, "underline":null, "italic":null, "fontWeight":null, "vAlign":0, "hAlign":2,}|
+```
+
+The key to `PIN` attribute override lies in the `parentId` of `ATTR`.
+The ID has two parts, e.g. `e176e5`, where `e176` is the `COMPONENT` ID and `e5` is the `PIN` ID in the template.

package/skill/format/schematic/index.md

@@ -1,14 +1,14 @@
-# SCH Schematic Type Document
-
-This chapter details the format specification of the EasyEDA schematic file. Schematic files mainly consist of the following parts:
-
-- [Common Format](/en/format/schematic/common.md): document header and canvas configuration.
-- [Structural Elements](/en/format/schematic/structure.md): PART sub-library and GROUP combination.
-- [Attributes](/en/format/schematic/attr.md): primitive attribute definitions.
-- [Wires](/en/format/schematic/wire.md): wires, buses, and bus entries.
-- [Text](/en/format/schematic/text.md): text elements.
-- [Shapes](/en/format/schematic/shape.md): rectangles, polygons, circles, arcs, Bezier curves, ellipses.
-- [Pins](/en/format/schematic/pin.md): pin definitions.
-- [Components](/en/format/schematic/component.md): schematic component instances.
-- [Objects](/en/format/schematic/obj.md): binary objects (images, etc.).
-- [Tables](/en/format/schematic/table.md): tables and cells.
+# SCH Schematic Type Document
+
+This chapter details the format specification of the EasyEDA schematic file. Schematic files mainly consist of the following parts:
+
+- [Common Format](/en/format/schematic/common.md): document header and canvas configuration.
+- [Structural Elements](/en/format/schematic/structure.md): PART sub-library and GROUP combination.
+- [Attributes](/en/format/schematic/attr.md): primitive attribute definitions.
+- [Wires](/en/format/schematic/wire.md): wires, buses, and bus entries.
+- [Text](/en/format/schematic/text.md): text elements.
+- [Shapes](/en/format/schematic/shape.md): rectangles, polygons, circles, arcs, Bezier curves, ellipses.
+- [Pins](/en/format/schematic/pin.md): pin definitions.
+- [Components](/en/format/schematic/component.md): schematic component instances.
+- [Objects](/en/format/schematic/obj.md): binary objects (images, etc.).
+- [Tables](/en/format/schematic/table.md): tables and cells.

package/skill/format/schematic/obj.md

@@ -1,41 +1,41 @@
-# OBJ Binary Embedded Object
-
-Embedded images and files on the page, which can be downloaded as attachments or displayed directly (decided by EDA, not required by the format).
-
-```json
-{ "type": "OBJ", "id": "UUID", "ticket": 1 }||
-{
-    "partId": "",
-    "groupId": 0,
-    "locked": false,
-    "zIndex": 9.0876,
-    "fileName": "a.txt",
-    "startX": 200,
-    "startY": 300,
-    "width": 10,
-    "height": 20,
-    "rotation": 0,
-	"isMirror": false,
-	"content": "data:text/plain;base64,MTIzNA==",
-}|
-```
-
-1. type binary embedded object identifier: OBJ.
-2. id ID, unique within the file.
-3. ticket logical clock.
-4. partId sub-library ID, exclusive to symbol pages; ignored on schematics.
-5. groupId group ID, cannot be 0, empty by default when none.
-6. locked whether locked.
-7. zIndex Z-axis height.
-8. fileName file name.
-9. startX top-left X.
-10. startY top-left Y.
-11. width width.
-12. height height.
-13. rotation rotation angle, around `top-left`.
-14. isMirror whether mirrored.
-15. content binary data, two modes.
-    1. General format, compatible with `Data URLs`: `data:[<mediatype>][;base64],<data>`
-        - e.g. `data:image/png;base64,asdfasdfwer`
-        - e.g. `data:text/html,<html></html>`
-    2. BLOB reference mode, `blob:hashid`.
+# OBJ Binary Embedded Object
+
+Embedded images and files on the page, which can be downloaded as attachments or displayed directly (decided by EDA, not required by the format).
+
+```json
+{ "type": "OBJ", "id": "UUID", "ticket": 1 }||
+{
+    "partId": "",
+    "groupId": 0,
+    "locked": false,
+    "zIndex": 9.0876,
+    "fileName": "a.txt",
+    "startX": 200,
+    "startY": 300,
+    "width": 10,
+    "height": 20,
+    "rotation": 0,
+	"isMirror": false,
+	"content": "data:text/plain;base64,MTIzNA==",
+}|
+```
+
+1. type binary embedded object identifier: OBJ.
+2. id ID, unique within the file.
+3. ticket logical clock.
+4. partId sub-library ID, exclusive to symbol pages; ignored on schematics.
+5. groupId group ID, cannot be 0, empty by default when none.
+6. locked whether locked.
+7. zIndex Z-axis height.
+8. fileName file name.
+9. startX top-left X.
+10. startY top-left Y.
+11. width width.
+12. height height.
+13. rotation rotation angle, around `top-left`.
+14. isMirror whether mirrored.
+15. content binary data, two modes.
+    1. General format, compatible with `Data URLs`: `data:[<mediatype>][;base64],<data>`
+        - e.g. `data:image/png;base64,asdfasdfwer`
+        - e.g. `data:text/html,<html></html>`
+    2. BLOB reference mode, `blob:hashid`.

package/skill/format/schematic/pin.md

@@ -1,59 +1,59 @@
-# PIN Number
-
-![image](/storage/images/cn/format/schematic/pin/pin.png)
-
-As shown in the figure:
--   The `position X/Y` of all PINs is the endpoint farthest from the black rectangle.
--   PIN 1 is 0-degree rotation direction, pin style 0.
--   PIN 2 is 90-degree rotation direction, pin style 1.
--   PIN 3 is 180-degree rotation direction, pin style 2.
--   PIN 4 is 270-degree rotation direction, pin style 3.
-
-```json
-{ "type": "PIN", "id": "UUID", "ticket": 1 }||
-{
-    "partId": "",
-    "groupId": 0,
-    "locked": false,
-    "zIndex": 2.8772,
-    "display": true,
-    "electric": 0,
-    "positionX": 350,
-    "positionY": 170,
-    "length": 20,
-    "rotation": 0,
-    "color": "#880000",
-    "pinShape": 3,
-}|
-```
-
-1. type primitive name: PIN.
-2. id ID, unique within the file.
-3. ticket logical clock.
-4. partId sub-library ID, exclusive to symbol pages; ignored on schematics.
-5. groupId group ID, cannot be 0, empty by default when none.
-6. locked whether locked.
-7. zIndex Z-axis height.
-8. display whether to display.
-9. electric electrical characteristic: 0 UNKNOWN, 1 INPUT, 2 OUTPUT, 3 BI.
-10. positionX position X.
-11. positionY position Y.
-12. length pin length.
-13. rotation rotation angle: 0, 90, 180, 270.
-14. color pin color.
-15. pinShape pin style: 1 Clock, 2 DOT; supports bitwise OR, e.g. 3 = 1 | 2.
-    Example: `0` no addition, `1` Clock, `2` DOT, `3` Clock & DOT.
-
-```json
-{ "type": "ATTR", "id": "e184", "ticket": 1 }||
-{ "partId": "", "groupId": 0, "locked": true, "zIndex": 0.1, "parentId": "e102", "key":"NAME", "value":"VCC", "keyVisible":true, "valueVisible":true, "positionX":108, "positionY":804.5, "rotation":0, "color":null, "fillColor":null, "fontFamily":null, "fontSize":null, "strikeout":null, "underline":null, "italic":null, "fontWeight":null, "vAlign":0, "hAlign":2,}|
-```
-
-PIN must have the NAME attribute.
-
-```json
-{ "type": "ATTR", "id": "e185", "ticket": 1 }||
-{ "partId": "", "groupId": 0, "locked": true, "zIndex": 0.1, "parentId": "e102", "key":"NUMBER", "value":"1", "keyVisible":true, "valueVisible":true, "positionX":108, "positionY":804.5, "rotation":0, "color":null, "fillColor":null, "fontFamily":null, "fontSize":null, "strikeout":null, "underline":null, "italic":null, "fontWeight":null, "vAlign":0, "hAlign":2,}|
-```
-
-PIN must have the NUMBER attribute.
+# PIN Number
+
+![image](/storage/images/cn/format/schematic/pin/pin.png)
+
+As shown in the figure:
+-   The `position X/Y` of all PINs is the endpoint farthest from the black rectangle.
+-   PIN 1 is 0-degree rotation direction, pin style 0.
+-   PIN 2 is 90-degree rotation direction, pin style 1.
+-   PIN 3 is 180-degree rotation direction, pin style 2.
+-   PIN 4 is 270-degree rotation direction, pin style 3.
+
+```json
+{ "type": "PIN", "id": "UUID", "ticket": 1 }||
+{
+    "partId": "",
+    "groupId": 0,
+    "locked": false,
+    "zIndex": 2.8772,
+    "display": true,
+    "electric": 0,
+    "positionX": 350,
+    "positionY": 170,
+    "length": 20,
+    "rotation": 0,
+    "color": "#880000",
+    "pinShape": 3,
+}|
+```
+
+1. type primitive name: PIN.
+2. id ID, unique within the file.
+3. ticket logical clock.
+4. partId sub-library ID, exclusive to symbol pages; ignored on schematics.
+5. groupId group ID, cannot be 0, empty by default when none.
+6. locked whether locked.
+7. zIndex Z-axis height.
+8. display whether to display.
+9. electric electrical characteristic: 0 UNKNOWN, 1 INPUT, 2 OUTPUT, 3 BI.
+10. positionX position X.
+11. positionY position Y.
+12. length pin length.
+13. rotation rotation angle: 0, 90, 180, 270.
+14. color pin color.
+15. pinShape pin style: 1 Clock, 2 DOT; supports bitwise OR, e.g. 3 = 1 | 2.
+    Example: `0` no addition, `1` Clock, `2` DOT, `3` Clock & DOT.
+
+```json
+{ "type": "ATTR", "id": "e184", "ticket": 1 }||
+{ "partId": "", "groupId": 0, "locked": true, "zIndex": 0.1, "parentId": "e102", "key":"NAME", "value":"VCC", "keyVisible":true, "valueVisible":true, "positionX":108, "positionY":804.5, "rotation":0, "color":null, "fillColor":null, "fontFamily":null, "fontSize":null, "strikeout":null, "underline":null, "italic":null, "fontWeight":null, "vAlign":0, "hAlign":2,}|
+```
+
+PIN must have the NAME attribute.
+
+```json
+{ "type": "ATTR", "id": "e185", "ticket": 1 }||
+{ "partId": "", "groupId": 0, "locked": true, "zIndex": 0.1, "parentId": "e102", "key":"NUMBER", "value":"1", "keyVisible":true, "valueVisible":true, "positionX":108, "positionY":804.5, "rotation":0, "color":null, "fillColor":null, "fontFamily":null, "fontSize":null, "strikeout":null, "underline":null, "italic":null, "fontWeight":null, "vAlign":0, "hAlign":2,}|
+```
+
+PIN must have the NUMBER attribute.