Skip to content

Commit 3974a7b

Browse files
JasonYANG170JasonYANG170
committed
docs: Add English README
1 parent a3959ca commit 3974a7b

2 files changed

Lines changed: 115 additions & 1 deletion

File tree

‎.github/workflows/build.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ jobs:
6363
if [ -z "$NOTES" ]; then
6464
NOTES=$(awk "/^# ${VERSION}/ {flag=1; next} flag" CHANGELOG.md)
6565
fi
66-
NOTES="$NOTES\n\n---\n由GitHub Actions自动构建并发布\nBuilt and released automatically by GitHub Actions\n\n也可前往[嘉立创EDA扩展广场](https://extensions.oshwhub.com/item/oshwhub/${EEXTNAME})下载\nAlso available at [JLCEDA Extension Plaza](https://extensions.oshwhub.com/item/oshwhub/${EEXTNAME})"
66+
NOTES="$NOTES\n\n---\n由GitHub Actions自动构建并发布\nBuilt and released automatically by GitHub Actions\n\n也可前往[嘉立创EDA扩展广场](https://ext.lceda.cn/item/oshwhub/${EEXTNAME})下载\nAlso available at [EasyEDA Extension Plaza](https://ext.easyeda.com/item/oshwhub/${EEXTNAME})"
6767
6868
echo "RELEASE_NOTES<<EOF" >> $GITHUB_ENV
6969
echo -e "$NOTES" >> $GITHUB_ENV

‎README.en.md‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# Batch Component Placement
2+
3+
A batch placement tool for EasyEDA Professional Edition that supports importing component information via CSV files and automatically placing components at specified coordinate locations.
4+
5+
## Supported Features
6+
7+
- **PCB Footprint Placement**: Batch place components on the PCB based on package name
8+
9+
- **Schematic Symbol Placement**: Batch place components on the schematic based on symbol name
10+
11+
## Features
12+
13+
- Supports batch importing component information from CSV files
14+
- Accurately place components at specified locations based on coordinate information
15+
- Intelligent Unit Conversion: Supports automatic conversion between mm, mils, and inches
16+
- Intelligent Header Recognition: Automatically extracts unit information from the CSV header (e.g., Name, X(mm), Y(mm))
17+
- Footprint/symbol name and device name must match exactly for placement
18+
- Provides detailed success/failure statistics and error messages
19+
- Supports selecting different component libraries (system library, personal library, project library, etc.)
20+
21+
## Usage
22+
23+
### 1. Prepare a CSV file
24+
25+
Create a CSV file in the format: `Component Name, X Coordinate, Y Coordinate`
26+
27+
#### PCB Package Placement Example
28+
29+
**Sample File Content (Sample Package Data.csv):**
30+
```csv
31+
name,x,y
32+
RELAY-TH_HVR24-2A04-02,0,0
33+
CONN-TH_250-121,3000,0
34+
RELAY-TH_HVR24-2A04-02,6000,0
35+
SSOP-4_L2.7-W4.4-P1.27-LS7.0-BL,6000,1000
36+
HDR-TH_SSW-101-03-G-S,9000,1000
37+
```
38+
39+
* *Smart unit conversion example (using mm):**
40+
```csv
41+
Name, X(mm), Y(mm)
42+
RELAY-TH_HVR24-2A04-02, 0, 0
43+
CONN-TH_250-121, 76.2, 0
44+
RELAY-TH_HVR24-2A04-02, 152.4, 0
45+
SSOP-4_L2.7-W4.4-P1.27-LS7.0-BL, 152.4, 25.4
46+
HDR-TH_SSW-101-03-G-S, 228.6, 25.4
47+
```
48+
49+
#### Schematic Symbol Placement Example
50+
51+
**Example File Content (Sample Symbol Data .csv):**
52+
```csv
53+
name,x,y
54+
HHW32GS62C-B1,30,10
55+
STM32F103C8T6,60,10
56+
LM358,90,10
57+
```
58+
59+
**Smart Unit Conversion Example (using mm):**
60+
```csv
61+
Name,X(mm),Y(mm)
62+
HHW32GS62C-B1,762,254
63+
STM32F103C8T6,1524,254
64+
LM358,2286,254
65+
```
66+
67+
**Format Description:**
68+
- First Column: Component Name (Package Mode matches Package Name, Symbol Mode matches Symbol Name)
69+
- Second Column: X Coordinate
70+
- Third Column: Y Coordinate
71+
- Supports CSV files with headers (as shown in the example)
72+
- **Smart Unit Conversion**:
73+
- You can specify units in the table header: `Name, X (mm), Y (mm)` or `Name, X (mil), Y (mil)` or `Name, X (inch), Y (inch)`.
74+
- If units are not specified in the table header, the default units are: mil for PCB footprints and inches for schematic symbols.
75+
- The system automatically converts to internal standard units (mil for PCB, inches for schematic).
76+
77+
### 2. Setting Up the Component Library
78+
79+
1. In the editor, click **Place Component** → **Settings**
80+
2. Select the component library type to use:
81+
- **System Library**: Use the system default component library
82+
- **Personal Library**: Use a personally created component library
83+
- **Project Library**: Use the project library for the current project
84+
- **Other Library**: Select another team's library
85+
86+
### 3. Batch Place Components
87+
88+
#### PCB Footprint Placement
89+
1. In the **PCB page**, click **Place Component** → **Batch Place**
90+
2. Select the prepared footprint CSV file
91+
3. The extension will automatically parse the CSV file and begin placing footprints.
92+
93+
[PCB Footprint Placement Demo](images/Footprint Placement.gif)
94+
95+
#### Schematic Symbol Placement
96+
1. On the **Schematic Page**, click **Place Components** → **Batch Place**
97+
2. Select the prepared symbol CSV file.
98+
3. The extension will automatically parse the CSV file and begin placing symbols.
99+
100+
[Schematic Symbol Placement Demo](images/Symbol Placement.gif)
101+
102+
**After completion, a statistical result will be displayed. Detailed error information can be viewed in the Log panel.**
103+
104+
## Troubleshooting
105+
106+
If placement fails, please check the following:
107+
108+
- ✅ Is the component name exactly the same as in the library (case-sensitive)?
109+
- ✅ Are you using the correct editor (PCB/Schematic)?
110+
- ✅ Is the CSV file format correct?
111+
- ✅ Are the coordinate values valid numbers?
112+
- ✅ Is the unit format in the header correct (e.g., X (mm), Y (mil)?
113+
- ✅ Is the correct component library selected?
114+
- ✅ Check the Log panel for detailed error information.

0 commit comments

Comments
 (0)