@@ -6,36 +6,52 @@ sidebar_position: 4
66
77## 概述
88
9- QuakeWatch-Pro 是一款專為地震儀 ( ES 系列) 設計的配套軟體,可透過 USB Type-C 串列埠 ( UART) 連接地震儀,並顯示地震波形資料 。
9+ QuakeWatch-Pro 是一款專為地震儀( ES 系列) 設計的配套軟體,可透過 USB Type-C 串列埠( UART) 連接地震儀,並即時顯示地震波形資料 。
1010
11- ## 環境
11+ ## 環境需求
1212
13- - [ ** Python 版本要求:** ` 3.10 ` ≤ Python ≤ ` 3.12 ` ] ( https://www.python.org/downloads/ )
14- - [ ** 推薦版本:** Python ` 3.10 ` 、` 3.11 ` 或 ` 3.12 ` ] ( https://www.python.org/downloads/ )
13+ :::tip Python 版本
14+
15+ - ** 版本要求:** ` 3.10 ` ≤ Python ≤ ` 3.12 `
16+ - ** 推薦版本:** Python ` 3.10 ` 、` 3.11 ` 或 ` 3.12 `
17+ - [ 前往 Python 官網下載] ( https://www.python.org/downloads/ )
18+
19+ :::
1520
1621## 下載
1722
18- - [ GitHub ] ( https://github.com/ExpTechTW/QuakeWatch-Pro )
23+ import GithubRepoCard from " @site/src/components/GithubRepoCard " ;
1924
20- ## 準備
25+ <GithubRepoCard
26+ owner = " ExpTechTW"
27+ repo = " QuakeWatch-Pro"
28+ displayName = " QuakeWatch-Pro"
29+ description = " 專為地震儀設計的配套軟體,可透過 USB 連接並顯示地震波形資料"
30+ />
2131
22- 1 . 切換到 QuakeWatch-Pro 的目錄
32+ ## 安裝步驟
33+
34+ ### 第 1 步:切換到專案目錄
35+
36+ 切換到 QuakeWatch-Pro 的目錄:
2337
2438``` bash
2539cd ./Documents/GitHub/QuakeWatch-Pro
2640```
2741
28- :::tip
42+ :::tip 路徑設定
2943
30- 路徑根據自己的實際情況修改 。
44+ 路徑請根據自己的實際情況修改 。
3145
3246:::
3347
34- 2 . (建議)建立虛擬環境
48+ ### 第 2 步:建立虛擬環境 (建議)
3549
3650:::tip 建議使用虛擬環境
3751
38- ** macOS:**
52+ 使用虛擬環境可以避免套件衝突,建議在開始前先建立。
53+
54+ ** macOS / Linux:**
3955
4056``` bash
4157python3 -m venv venv
@@ -51,21 +67,25 @@ python -m venv venv
5167
5268:::
5369
54- ## 安裝依賴
70+ ### 第 3 步:安裝依賴套件
71+
72+ 在虛擬環境中安裝所需的依賴套件:
5573
5674``` bash
5775pip install -r requirements.txt
5876```
5977
60- ## 執行
78+ ## 使用方式
79+
80+ ### 第 1 步:啟動資料收集程式
6181
62- 1 . 先執行 ` data_collector.py ` 收集資料
82+ 先執行 ` data_collector.py ` 來收集地震儀的資料:
6383
6484``` bash
6585python data_collector.py
6686```
6787
68- ** 輸出範例: **
88+ #### 選擇串列埠
6989
7090執行後會顯示可用的串列埠列表:
7191
@@ -82,7 +102,9 @@ QuakeWatch - ES-Net Serial Data Collector
82102請選擇 [0-1] 或 q 退出:
83103```
84104
85- 選擇要收集的串列埠,輸入編號後按下 ` Enter ` 鍵。
105+ 選擇要使用的串列埠,輸入編號後按下 ` Enter ` 鍵。
106+
107+ #### 確認連接成功
86108
87109成功連接後會看到以下輸出:
88110
@@ -98,14 +120,15 @@ QuakeWatch - ES-Net Serial Data Collector
98120
99121這代表資料收集正在正常進行中。
100122
123+ ### 第 2 步:啟動波形圖顯示程式
101124
102- 2 . 執行 ` main.py ` 顯示波形圖
125+ 在另一個終端視窗中執行 ` main.py ` 來顯示波形圖:
103126
104127``` bash
105128python main.py
106129```
107130
108- ** 輸出範例: **
131+ #### 確認程式運行
109132
110133成功啟動後會看到以下輸出:
111134
@@ -125,8 +148,13 @@ QuakeWatch - ES-Net Data Visualization
125148
126149:::warning 重要提醒
127150
128- - 請先執行 ` data_collector.py ` 收集資料,再執行 ` main.py ` 顯示波形圖
129- - ** 不要** 先直接執行 ` main.py `
130- - ** 不要** 關閉 ` data_collector.py ` 只執行 ` main.py ` ,否則會導致資料收集不完全
151+ ** 執行順序很重要!**
131152
132- :::
153+ 1 . ✅ ** 先執行** ` data_collector.py ` 收集資料
154+ 2 . ✅ ** 再執行** ` main.py ` 顯示波形圖
155+ 3 . ❌ ** 不要** 先直接執行 ` main.py `
156+ 4 . ❌ ** 不要** 關閉 ` data_collector.py ` 只執行 ` main.py ` ,否則會導致資料收集不完全
157+
158+ 兩個程式需要** 同時運行** 才能正常運作。
159+
160+ :::
0 commit comments