@windypro-rourou/dsh-eda 0.1.4 → 0.1.5

package/skill/format/pcb/text.md

@@ -1,62 +1,62 @@
-# Text System
-
-## STRING Text
-
-When `STRING` is on a signal layer, from the DRC perspective it is:
-
-1. Net-less.
-2. A BBox with `position` at 0,0, `rotation angle` 0, and `whether mirrored` 0.
-3. A rectangular area after applying `position`, `rotation angle`, and `whether mirrored` transformations.
-
-```json
-{ "type": "STRING", "id":"UUID", "ticket": 1 }||
-{
-  "partitionId":null,
-  "groupId":0,
-  "locked":1,
-  "zIndex":0.2693,
-  "layerId":1,
-  "positionX":300,
-  "positionY":600,
-  "text":"any text",
-  "fontFamily":"SimSun",
-  "fontSize":50,
-  "strokeWidth":10,
-  "bold":0,
-  "italic":0,
-  "origin":5,
-  "angle":15,
-  "reverse":1,
-  "reverseExpansion":0,
-  "mirror":1,
-  "width":100,
-  "height":200,
-  "path":["complex polygon"],
-}|
-["STRING", "e100", 0, 1, 0.2693, 1, 300, 600, "any text", "SimSun", 50, 10, 0, 0, 5, 15, 1, 0, 1]
-```
-
-1. type text `STRING`.
-2. id primitive ID, unique within the document.
-3. ticket logical clock.
-4. partitionId partition ID it belongs to, null means no partition. Ignored for footprints.
-5. groupId group ID: 0 no group, non-zero is the group flag, same flag means same group.
-6. locked whether locked.
-7. zIndex Z-axis height.
-8. layerId layer.
-9. positionX position X.
-10. positionY position Y.
-11. text content.
-12. fontFamily font name.
-13. fontSize font size.
-14. strokeWidth stroke width.
-15. bold whether bold.
-16. italic whether italic.
-17. origin alignment mode: `0` top-left, `1` top-center, `2` top-right, `3` middle-left, `4` middle-center, `5` middle-right, `6` bottom-left, `7` bottom-center, `8` bottom-right.
-18. angle rotation angle.
-19. reverse whether reverse expansion.
-20. expansion reverse expansion size: size of the reverse expansion area, supports negative numbers.
-21. mirror whether mirrored. Generally, when text appears on the bottom layer, this should also be adjusted to `1`.
-22. width height, `null` if none.
-23. height width, `null` if none.
-24. path complex polygon array, `null` if none.
+# Text System
+
+## STRING Text
+
+When `STRING` is on a signal layer, from the DRC perspective it is:
+
+1. Net-less.
+2. A BBox with `position` at 0,0, `rotation angle` 0, and `whether mirrored` 0.
+3. A rectangular area after applying `position`, `rotation angle`, and `whether mirrored` transformations.
+
+```json
+{ "type": "STRING", "id":"UUID", "ticket": 1 }||
+{
+  "partitionId":null,
+  "groupId":0,
+  "locked":1,
+  "zIndex":0.2693,
+  "layerId":1,
+  "positionX":300,
+  "positionY":600,
+  "text":"any text",
+  "fontFamily":"SimSun",
+  "fontSize":50,
+  "strokeWidth":10,
+  "bold":0,
+  "italic":0,
+  "origin":5,
+  "angle":15,
+  "reverse":1,
+  "reverseExpansion":0,
+  "mirror":1,
+  "width":100,
+  "height":200,
+  "path":["complex polygon"],
+}|
+["STRING", "e100", 0, 1, 0.2693, 1, 300, 600, "any text", "SimSun", 50, 10, 0, 0, 5, 15, 1, 0, 1]
+```
+
+1. type text `STRING`.
+2. id primitive ID, unique within the document.
+3. ticket logical clock.
+4. partitionId partition ID it belongs to, null means no partition. Ignored for footprints.
+5. groupId group ID: 0 no group, non-zero is the group flag, same flag means same group.
+6. locked whether locked.
+7. zIndex Z-axis height.
+8. layerId layer.
+9. positionX position X.
+10. positionY position Y.
+11. text content.
+12. fontFamily font name.
+13. fontSize font size.
+14. strokeWidth stroke width.
+15. bold whether bold.
+16. italic whether italic.
+17. origin alignment mode: `0` top-left, `1` top-center, `2` top-right, `3` middle-left, `4` middle-center, `5` middle-right, `6` bottom-left, `7` bottom-center, `8` bottom-right.
+18. angle rotation angle.
+19. reverse whether reverse expansion.
+20. expansion reverse expansion size: size of the reverse expansion area, supports negative numbers.
+21. mirror whether mirrored. Generally, when text appears on the bottom layer, this should also be adjusted to `1`.
+22. width height, `null` if none.
+23. height width, `null` if none.
+24. path complex polygon array, `null` if none.

package/skill/format/project/blob.md

@@ -1,30 +1,30 @@
-# BLOB True-Color Image
-
-```json
-{ "type": "META", "id": "BLOB-HASH-ID",  "ticket": 1 }||{ "filename": "dadas", "data": "data:image/png;base64,asdfasdfwer" }|
-```
-
-1. filename file name.
-2. data reserved metadata; binary data uses a specification similar to `Data URLs`, but with differences.
-
-    1. General format, fully compatible with `Data URLs`: `data:[<mediatype>][;base64],<data>`
-
-        - e.g. `data:image/png;base64,asdfasdfwer`
-        - e.g. `data:text/html,<html></html>`
-        - In general, this format should be used whenever possible, so it can be loaded directly with Web APIs without algorithm conversion.
-
-    2. Extended format, extending functionality by adding encodings such as gzip/deflate: `data:<mediatype>[pipeline],<data>`
-
-    - e.g. `data:text/html;gzip;base64,asdfasdf`
-        1. First base64-decode `asdfasdf`.
-        2. Then decompress with gzip.
-        3. Finally load as `text/html`.
-    - e.g. `data:text/css;deflate;aes128;base64,aaaaaaa`
-        1. First base64-decode `aaaaaaa`.
-        2. Then decrypt with aes128 (specific encryption/decryption logic to be determined).
-        3. Then decompress with deflate.
-        4. Finally load as `text/css`.
-
-```json
-{ "type": "META", "id": "ID",  "ticket": 1 }||{ "filename": "dadas", "data": "data:application/vnd.ms-excel;base64,xxsasdfawerwerqwer" }|
-```
+# BLOB True-Color Image
+
+```json
+{ "type": "META", "id": "BLOB-HASH-ID",  "ticket": 1 }||{ "filename": "dadas", "data": "data:image/png;base64,asdfasdfwer" }|
+```
+
+1. filename file name.
+2. data reserved metadata; binary data uses a specification similar to `Data URLs`, but with differences.
+
+    1. General format, fully compatible with `Data URLs`: `data:[<mediatype>][;base64],<data>`
+
+        - e.g. `data:image/png;base64,asdfasdfwer`
+        - e.g. `data:text/html,<html></html>`
+        - In general, this format should be used whenever possible, so it can be loaded directly with Web APIs without algorithm conversion.
+
+    2. Extended format, extending functionality by adding encodings such as gzip/deflate: `data:<mediatype>[pipeline],<data>`
+
+    - e.g. `data:text/html;gzip;base64,asdfasdf`
+        1. First base64-decode `asdfasdf`.
+        2. Then decompress with gzip.
+        3. Finally load as `text/html`.
+    - e.g. `data:text/css;deflate;aes128;base64,aaaaaaa`
+        1. First base64-decode `aaaaaaa`.
+        2. Then decrypt with aes128 (specific encryption/decryption logic to be determined).
+        3. Then decompress with deflate.
+        4. Finally load as `text/css`.
+
+```json
+{ "type": "META", "id": "ID",  "ticket": 1 }||{ "filename": "dadas", "data": "data:application/vnd.ms-excel;base64,xxsasdfawerwerqwer" }|
+```

package/skill/format/project/common.md

@@ -1,42 +1,42 @@
-# Common Data
-
-Each document carries basic information, creation information, and modification information, which are maintained by the project manager.
-
-### Basic Information
-
-```json
-{ "type": "META", "ticket": 1 }||data
-```
-
-1. type "META" basic information.
-2. data specific data, different for each document.
-
-### Creation Information
-
-Same for every document.
-
-```json
-{ "type": "META_CREATE", "ticket": 1 }||
-{
-    "creator": { "uuid":"UUID", "nickname":"nickname", "username":"username", },
-    "createTime": 1725593026474,
-}|
-```
-
-1. type "META_CREATE" creation information.
-2. creator creator.
-3. createTime creation time.
-
-### Modification Information
-
-```json
-{ "type": "META_MODIFY", "ticket": 1 }||
-{
-    "modifier": { "uuid":"UUID", "nickname":"nickname", "username":"username", },
-    "createTime": 1725593026474,
-}|
-```
-
-1. type "META_MODIFY" modification information.
-2. modifier modifier.
-3. updateTime update time.
+# Common Data
+
+Each document carries basic information, creation information, and modification information, which are maintained by the project manager.
+
+### Basic Information
+
+```json
+{ "type": "META", "ticket": 1 }||data
+```
+
+1. type "META" basic information.
+2. data specific data, different for each document.
+
+### Creation Information
+
+Same for every document.
+
+```json
+{ "type": "META_CREATE", "ticket": 1 }||
+{
+    "creator": { "uuid":"UUID", "nickname":"nickname", "username":"username", },
+    "createTime": 1725593026474,
+}|
+```
+
+1. type "META_CREATE" creation information.
+2. creator creator.
+3. createTime creation time.
+
+### Modification Information
+
+```json
+{ "type": "META_MODIFY", "ticket": 1 }||
+{
+    "modifier": { "uuid":"UUID", "nickname":"nickname", "username":"username", },
+    "createTime": 1725593026474,
+}|
+```
+
+1. type "META_MODIFY" modification information.
+2. modifier modifier.
+3. updateTime update time.

package/skill/format/project/group.md

@@ -1,62 +1,62 @@
-# Component Grouping
-
-## Document Header
-
-```json
-{ "type": "DOCHEAD" }||{ "docType": "COMPONENT_GROUP", "uuid": "UUID", "client": "clientID" }|
-```
-
-1. type: `DOCHEAD`, document header identifier.
-2. docType: `COMPONENT_GROUP` component grouping.
-3. uuid: unique identifier, random id.
-4. client: terminal identifier for eventual consistency.
-
-### META Basic Information
-
-```json
-{ "type": "META", "ticket": 1 }||
-{
-	/** Name */
-	"title": string,
-	/** Parent component group uuid of the child component group */
-	"parent": string,
-	/** Component groups belonging directly to a variant do not participate in the component group tree */
-	"belong": string,
-	/** Sort order in the component group tree */
-	"zIndex": number,
-	/** Schematic */
-	"schematicId": string,
-}|
-```
-
-### GROUP_INDEX Sorting of Component Groups in Variants
-
-```json
-{ "type": "GROUP_INDEX", "ticket": 1, "id": "variantId" }||
-{
-	"zIndex": 1,
-}|
-```
-
-1. type: `GROUP_INDEX`
-2. ticket: logical clock.
-3. id: variant uuid.
-4. zIndex: sort order within the variant.
-
-### GROUP_DATA Attribute Data
-
-```json
-{ "type": "GROUP_DATA", "id": "e176@uuid",  "ticket": 1 }||data
-```
-
-1. type `GROUP_DATA` attribute data.
-2. id combined id, separated by `@`:
-    1. The first is the primitive ID.
-    2. The second is the instance page ID.
-3. data attribute override, data signature is `{ [key: string]: string }| `
-
-```json
-{ "type": "GROUP_DATA", "id": "e176@uuid1",  "ticket": 1 }||{ "Designator": "U15", "ASDF": "1234" }|
-{ "type": "GROUP_DATA", "id": "e177@uuid1",  "ticket": 2 }||{ "NUMBER": 2 }|
-{ "type": "GROUP_DATA", "id": "e176@uuid2",  "ticket": 3 }||{ "Author": "abc" }|
-```
+# Component Grouping
+
+## Document Header
+
+```json
+{ "type": "DOCHEAD" }||{ "docType": "COMPONENT_GROUP", "uuid": "UUID", "client": "clientID" }|
+```
+
+1. type: `DOCHEAD`, document header identifier.
+2. docType: `COMPONENT_GROUP` component grouping.
+3. uuid: unique identifier, random id.
+4. client: terminal identifier for eventual consistency.
+
+### META Basic Information
+
+```json
+{ "type": "META", "ticket": 1 }||
+{
+	/** Name */
+	"title": string,
+	/** Parent component group uuid of the child component group */
+	"parent": string,
+	/** Component groups belonging directly to a variant do not participate in the component group tree */
+	"belong": string,
+	/** Sort order in the component group tree */
+	"zIndex": number,
+	/** Schematic */
+	"schematicId": string,
+}|
+```
+
+### GROUP_INDEX Sorting of Component Groups in Variants
+
+```json
+{ "type": "GROUP_INDEX", "ticket": 1, "id": "variantId" }||
+{
+	"zIndex": 1,
+}|
+```
+
+1. type: `GROUP_INDEX`
+2. ticket: logical clock.
+3. id: variant uuid.
+4. zIndex: sort order within the variant.
+
+### GROUP_DATA Attribute Data
+
+```json
+{ "type": "GROUP_DATA", "id": "e176@uuid",  "ticket": 1 }||data
+```
+
+1. type `GROUP_DATA` attribute data.
+2. id combined id, separated by `@`:
+    1. The first is the primitive ID.
+    2. The second is the instance page ID.
+3. data attribute override, data signature is `{ [key: string]: string }| `
+
+```json
+{ "type": "GROUP_DATA", "id": "e176@uuid1",  "ticket": 1 }||{ "Designator": "U15", "ASDF": "1234" }|
+{ "type": "GROUP_DATA", "id": "e177@uuid1",  "ticket": 2 }||{ "NUMBER": 2 }|
+{ "type": "GROUP_DATA", "id": "e176@uuid2",  "ticket": 3 }||{ "Author": "abc" }|
+```

package/skill/format/project/index.md

@@ -1,12 +1,12 @@
-# Project Log Format
-
-This document only describes data that belongs to the project but not to the canvas. For specific canvas data, please refer to the separate documents.
-
-## Contents
-
-- [Common Data](/en/format/project/common.md) - Includes basic information, creation information, modification information, etc.
-- [Basic Information](/en/format/project/meta.md) - Includes metadata for project config, board, schematic, PCB, panel, symbol, footprint, device, etc.
-- [BLOB True-Color Image](/en/format/project/blob.md) - True-color image data format.
-- [Instance Attribute Override](/en/format/project/instance.md) - Instance attribute override format.
-- [Variant](/en/format/project/variant.md) - Variant data format.
-- [Component Grouping](/en/format/project/group.md) - Component grouping data format.
+# Project Log Format
+
+This document only describes data that belongs to the project but not to the canvas. For specific canvas data, please refer to the separate documents.
+
+## Contents
+
+- [Common Data](/en/format/project/common.md) - Includes basic information, creation information, modification information, etc.
+- [Basic Information](/en/format/project/meta.md) - Includes metadata for project config, board, schematic, PCB, panel, symbol, footprint, device, etc.
+- [BLOB True-Color Image](/en/format/project/blob.md) - True-color image data format.
+- [Instance Attribute Override](/en/format/project/instance.md) - Instance attribute override format.
+- [Variant](/en/format/project/variant.md) - Variant data format.
+- [Component Grouping](/en/format/project/group.md) - Component grouping data format.

package/skill/format/project/instance.md

@@ -1,32 +1,32 @@
-# Instance Attribute Override
-
-## Document Header
-
-```json
-{ "type": "DOCHEAD" }||{ "docType": "INSTANCE", "uuid": "SCH-UNIQUE-ID_$5|e100_$1|e55_$6|e15_$8", "client": "clientID" }|
-```
-
-1. type: `DOCHEAD`, document header identifier.
-2. docType: `INSTANCE` instance attribute override.
-3. uuid: hierarchical ID, unique within the project, IDs separated by `_`.
-    1. The first is the top-level schematic ID.
-    2. The last goes only to the sheet ID.
-    3. All in between use the numbering combination syntax to locate `Block Symbol`, e.g. `$1|e2`, where `$1` is the sheet ID and `e2` is the `Block Symbol` ID.
-4. client: terminal identifier for eventual consistency.
-
-## Attribute Override
-
-```json
-{ "type": "INSTANCE_ATTR", "id": "e176",  "ticket": 1 }||data
-```
-
-1. type `INSTANCE_ATTR` instance attribute override.
-2. id primitive ID.
-3. data attribute override, data signature is `{ [parentId: string]: { [key: string]: string }| }|`
-
-```json
-{ "type": "DOCHEAD" }||{ "docType": "INSTANCE", "uuid": "SCH-UNIQUE-ID_$5|e100_$1|e55_$6|e15_$8", "client": "clientID" }|
-{ "type": "INSTANCE_ATTR", "id": "e176",  "ticket": 1 }||{ "Designator": "U15", "ASDF": "1234" }|
-{ "type": "INSTANCE_ATTR", "id": "e176e5",  "ticket": 1 }||{ "NUMBER": 2 }|
-{ "type": "INSTANCE_ATTR", "id": "e178",  "ticket": 1 }||{ "Author": "abc" }|
-```
+# Instance Attribute Override
+
+## Document Header
+
+```json
+{ "type": "DOCHEAD" }||{ "docType": "INSTANCE", "uuid": "SCH-UNIQUE-ID_$5|e100_$1|e55_$6|e15_$8", "client": "clientID" }|
+```
+
+1. type: `DOCHEAD`, document header identifier.
+2. docType: `INSTANCE` instance attribute override.
+3. uuid: hierarchical ID, unique within the project, IDs separated by `_`.
+    1. The first is the top-level schematic ID.
+    2. The last goes only to the sheet ID.
+    3. All in between use the numbering combination syntax to locate `Block Symbol`, e.g. `$1|e2`, where `$1` is the sheet ID and `e2` is the `Block Symbol` ID.
+4. client: terminal identifier for eventual consistency.
+
+## Attribute Override
+
+```json
+{ "type": "INSTANCE_ATTR", "id": "e176",  "ticket": 1 }||data
+```
+
+1. type `INSTANCE_ATTR` instance attribute override.
+2. id primitive ID.
+3. data attribute override, data signature is `{ [parentId: string]: { [key: string]: string }| }|`
+
+```json
+{ "type": "DOCHEAD" }||{ "docType": "INSTANCE", "uuid": "SCH-UNIQUE-ID_$5|e100_$1|e55_$6|e15_$8", "client": "clientID" }|
+{ "type": "INSTANCE_ATTR", "id": "e176",  "ticket": 1 }||{ "Designator": "U15", "ASDF": "1234" }|
+{ "type": "INSTANCE_ATTR", "id": "e176e5",  "ticket": 1 }||{ "NUMBER": 2 }|
+{ "type": "INSTANCE_ATTR", "id": "e178",  "ticket": 1 }||{ "Author": "abc" }|
+```