Merge pull request #217 from Jomo-desktop/ndev

读取id及烧录文档更新
Mellow-3D · Jan 21, 2024 · b076c22 · b076c22
2 parents 8a55ace + 4d8d544
commit b076c22
Show file tree

Hide file tree

Showing 20 changed files with 431 additions and 68 deletions.
diff --git a/docs/board/fly_cdy_v3/_sidebar.md b/docs/board/fly_cdy_v3/_sidebar.md
@@ -3,7 +3,7 @@
   * **入门必看**
   * [1. 产品简介](/board/fly_cdy_v3/README.md)
   * [2. 固件编译和烧录](/board/fly_cdy_v3/flash.md)
-  * [3. 读取主板ID](/board/fly_cdy_v3/read_id.md)
+  * [3. 读取主板ID](/board/fly_cdy_v3/usbid.md)
   * [4. CDY主板接线](/board/fly_cdy_v3/wiring.md)
   * [5. printer参考配置](/board/fly_cdy_v3/cfg.md)
   * [6. Pin脚分布](/board/fly_cdy_v3/pins.md)

diff --git a/docs/board/fly_cdy_v3/read_id.md b/docs/board/fly_cdy_v3/read_id.md
diff --git a/docs/board/fly_cdy_v3/usbid.md b/docs/board/fly_cdy_v3/usbid.md
@@ -0,0 +1,52 @@
+# 读取ID
+
+<!-- tabs:start -->
+
+### **USB ID读取方法**
+
+1.[连接到SSH](/board/fly_C8/ssh "点击即可跳转")，然后输入 ``ls /dev/serial/by-id/*`` 回车。如果一切正常，则会出现下面一行蓝色的ID。
+
+<img src="../../images/boards/fly_super8/id.png" alt="id" style="zoom:80%;" />
+
+2.在左侧边栏的配置选项里找到：fluidd为：``{…}`` ；mainsail为：``机器``，点击进去，即可找到``printer.cfg``
+
+![fluidd](../../images/boards/fly_super8/fluidd.png)
+
+3.将蓝色的ID复制，填写到``printer.cfg``里。保存重启后即可连上主板。若Klipper提示 ``ADC out of range``为正常现象，将热床和热敏连接好，配置好喷头、热床的热敏引脚和输出引脚，再保存重启即可。
+
+<img src="../../images/boards/fly_super8/id2.png" alt="id2" style="zoom:80%;" />
+
+### **CAN ID读取方法**
+
+> [!TIP]
+> 已经识别到的CAN ID是不会被查找到的（即已经写入配置文件printer.cfg中的ID，连接成功并正常运行的，是不会被查找到的）
+
+
+
+> [!Tip]
+>
+> 请确保上位机的can0、桥接主板的CAN速率、CAN工具板的速率完全一致
+
+```bash
+[mcu]
+canbus_uuid: b7c79ec3f948     #将读取到的uuid填写到此处
+```
+
+也可以在SSH中输入下面的命令查找uuid
+
+```bash
+~/klippy-env/bin/python ~/klipper/scripts/canbus_query.py can0
+```
+
+![uuid](../../images/boards/fly_sht36_42/uuid.png)
+
+出现``Found canbus_uuid=b7c79ec3f948``则查找到设备ID，其中``b7c79ec3f948``为设备UUID。
+
+> [!TIP]
+> 如果找不到CAN ID，请检查：
+
+* 是否正确供电
+* 您的镜像内核是否支持CAN
+* 固件编译是否正确
+
+<!-- tabs:end -->
diff --git a/docs/board/fly_d5/flash.md b/docs/board/fly_d5/flash.md
@@ -1,7 +1,7 @@
 
 
 > [!TIP]
-> FLY-D5 需在断电状态下按住 **BOOT键** 后，使用Type-C数据线连接上位机，才能烧录固件
+> FLY-D7 需在断电状态下按住 **BOOT键** 后，使用Type-C数据线连接上位机，才能烧录固件
 
 请使用**MobaXterm_Personal**等**SSH工具**连接通过**WIFI**到您的上位机，并且需要确定以下几点
 
@@ -137,8 +137,11 @@
 
 
 
+## 3. 固件烧录
 
-## 3. Klipper上位机烧录
+<!-- tabs:start -->
+
+### **使用Klipper上位机烧录**
 
 1. 安装烧录工具
 
@@ -174,3 +177,28 @@ cd ~/klipper && make flash FLASH_DEVICE=0483:df11
 
 ![7](../../images/boards/fly_super8_pro/dfu.png ":no-zooom")
 
+### **使用电脑烧录**
+
+1. 下载烧录工具：[STM32CubeProgrammer](https://cdn.mellow.klipper.cn/Utils/STM32CubeProgrammer.zip '点击即可下载')
+2. 解压烧录工具到任意目录，进入`STM32CubeProgrammer/bin`目录，双击打开`STM32CubeProgrammer.exe`
+3. 将前面编译好的固件(klipper.bin)复制到电脑任意目录
+4. 使用Type-C数据线将D5主板连接到电脑，请确保连接前已安装短接跳线
+5. STM32CubeProgrammer中选择USB模式，并刷新，连接
+
+![2](../../images/boards/fly_sht36_42/2.png ":no-zooom")
+
+6. 如果没有出现错误弹窗则连接成功
+7. 打开固件文件，在弹窗中选择前面编译完成的固件文件(klipper.bin)。
+
+![3](../../images/boards/fly_sht36_42/3.png ":no-zooom")
+
+8. 确认页面有内容，不是00000。然后点击**Download**
+
+![4](../../images/boards/fly_sht36_42/4.png ":no-zooom")
+
+9. 出现图中就是烧录成功
+
+![5](../../images/boards/fly_sht36_42/5.png ":no-zooom")
+
+<!-- tabs:end -->
+
diff --git a/docs/board/fly_d7/flash.md b/docs/board/fly_d7/flash.md
@@ -137,8 +137,11 @@
 
 
 
+## 3. 固件烧录
 
-## 3. Klipper上位机烧录
+<!-- tabs:start -->
+
+### **使用Klipper上位机烧录**
 
 1. 安装烧录工具
 
@@ -174,3 +177,28 @@ cd ~/klipper && make flash FLASH_DEVICE=0483:df11
 
 ![7](../../images/boards/fly_super8_pro/dfu.png ":no-zooom")
 
+### **使用电脑烧录**
+
+1. 下载烧录工具：[STM32CubeProgrammer](https://cdn.mellow.klipper.cn/Utils/STM32CubeProgrammer.zip '点击即可下载')
+2. 解压烧录工具到任意目录，进入`STM32CubeProgrammer/bin`目录，双击打开`STM32CubeProgrammer.exe`
+3. 将前面编译好的固件(klipper.bin)复制到电脑任意目录
+4. 使用Type-C数据线将D7主板连接到电脑，请确保连接前已安装短接跳线
+5. STM32CubeProgrammer中选择USB模式，并刷新，连接
+
+![2](../../images/boards/fly_sht36_42/2.png ":no-zooom")
+
+6. 如果没有出现错误弹窗则连接成功
+7. 打开固件文件，在弹窗中选择前面编译完成的固件文件(klipper.bin)。
+
+![3](../../images/boards/fly_sht36_42/3.png ":no-zooom")
+
+8. 确认页面有内容，不是00000。然后点击**Download**
+
+![4](../../images/boards/fly_sht36_42/4.png ":no-zooom")
+
+9. 出现图中就是烧录成功
+
+![5](../../images/boards/fly_sht36_42/5.png ":no-zooom")
+
+<!-- tabs:end -->
+
diff --git a/docs/board/fly_d7/wiring.md b/docs/board/fly_d7/wiring.md
@@ -1,3 +1,9 @@
 # 5. FLY-D7接线
 
-**接线图制作中，敬请期待**
+> [!WARNING]
+>
+> 如果不使用UART功能，请务必在下图中插入两个跳线帽，否则主板不能正常使用！！！
+
+<img src="../../images/boards/fly_d7/jumper_uart.png" alt="jumper_uart" style="zoom:80%;" />
+
+**其余接线图正在制作中，敬请期待**
diff --git a/docs/board/fly_dp5/flash.md b/docs/board/fly_dp5/flash.md
@@ -1,7 +1,7 @@
 
 
 > [!TIP]
-> FLY-DP5 需在断电状态下按住 **BOOT键** 后，使用Type-C数据线连接上位机，才能烧录固件
+> FLY-D7 需在断电状态下按住 **BOOT键** 后，使用Type-C数据线连接上位机，才能烧录固件
 
 请使用**MobaXterm_Personal**等**SSH工具**连接通过**WIFI**到您的上位机，并且需要确定以下几点
 
@@ -137,8 +137,11 @@
 
 
 
+## 3. 固件烧录
 
-## 3. Klipper上位机烧录
+<!-- tabs:start -->
+
+### **使用Klipper上位机烧录**
 
 1. 安装烧录工具
 
@@ -174,3 +177,28 @@ cd ~/klipper && make flash FLASH_DEVICE=0483:df11
 
 ![7](../../images/boards/fly_super8_pro/dfu.png ":no-zooom")
 
+### **使用电脑烧录**
+
+1. 下载烧录工具：[STM32CubeProgrammer](https://cdn.mellow.klipper.cn/Utils/STM32CubeProgrammer.zip '点击即可下载')
+2. 解压烧录工具到任意目录，进入`STM32CubeProgrammer/bin`目录，双击打开`STM32CubeProgrammer.exe`
+3. 将前面编译好的固件(klipper.bin)复制到电脑任意目录
+4. 使用Type-C数据线将DP5主板连接到电脑，请确保连接前已安装短接跳线
+5. STM32CubeProgrammer中选择USB模式，并刷新，连接
+
+![2](../../images/boards/fly_sht36_42/2.png ":no-zooom")
+
+6. 如果没有出现错误弹窗则连接成功
+7. 打开固件文件，在弹窗中选择前面编译完成的固件文件(klipper.bin)。
+
+![3](../../images/boards/fly_sht36_42/3.png ":no-zooom")
+
+8. 确认页面有内容，不是00000。然后点击**Download**
+
+![4](../../images/boards/fly_sht36_42/4.png ":no-zooom")
+
+9. 出现图中就是烧录成功
+
+![5](../../images/boards/fly_sht36_42/5.png ":no-zooom")
+
+<!-- tabs:end -->
+
diff --git a/docs/board/fly_e3_v2/_sidebar.md b/docs/board/fly_e3_v2/_sidebar.md
@@ -3,7 +3,7 @@
   * **入门必看**
   * [1. 产品简介](/board/fly_e3_v2/README.md)
   * [2. 固件编译和烧录](/board/fly_e3_v2/firmware.md)
-  * [3. 读取主板ID](/board/fly_e3_v2/readid.md)
+  * [3. 读取主板ID](/board/fly_e3_v2/usbid.md)
   * [4. E3 v2 主板接线](/board/fly_e3_v2/wiring.md)
   * [5. printer参考配置](/board/fly_e3_v2/cfg.md)
   * [6. Pin脚分布](/board/fly_e3_v2/pins.md)

diff --git a/docs/board/fly_e3_v2/readid.md b/docs/board/fly_e3_v2/readid.md
diff --git a/docs/board/fly_e3_v2/usbid.md b/docs/board/fly_e3_v2/usbid.md
@@ -0,0 +1,52 @@
+# 读取ID
+
+<!-- tabs:start -->
+
+### **USB ID读取方法**
+
+1.[连接到SSH](/board/fly_C8/ssh "点击即可跳转")，然后输入 ``ls /dev/serial/by-id/*`` 回车。如果一切正常，则会出现下面一行蓝色的ID。
+
+<img src="../../images/boards/fly_super8/id.png" alt="id" style="zoom:80%;" />
+
+2.在左侧边栏的配置选项里找到：fluidd为：``{…}`` ；mainsail为：``机器``，点击进去，即可找到``printer.cfg``
+
+![fluidd](../../images/boards/fly_super8/fluidd.png)
+
+3.将蓝色的ID复制，填写到``printer.cfg``里。保存重启后即可连上主板。若Klipper提示 ``ADC out of range``为正常现象，将热床和热敏连接好，配置好喷头、热床的热敏引脚和输出引脚，再保存重启即可。
+
+<img src="../../images/boards/fly_super8/id2.png" alt="id2" style="zoom:80%;" />
+
+### **CAN ID读取方法**
+
+> [!TIP]
+> 已经识别到的CAN ID是不会被查找到的（即已经写入配置文件printer.cfg中的ID，连接成功并正常运行的，是不会被查找到的）
+
+
+
+> [!Tip]
+>
+> 请确保上位机的can0、桥接主板的CAN速率、CAN工具板的速率完全一致
+
+```bash
+[mcu]
+canbus_uuid: b7c79ec3f948     #将读取到的uuid填写到此处
+```
+
+也可以在SSH中输入下面的命令查找uuid
+
+```bash
+~/klippy-env/bin/python ~/klipper/scripts/canbus_query.py can0
+```
+
+![uuid](../../images/boards/fly_sht36_42/uuid.png)
+
+出现``Found canbus_uuid=b7c79ec3f948``则查找到设备ID，其中``b7c79ec3f948``为设备UUID。
+
+> [!TIP]
+> 如果找不到CAN ID，请检查：
+
+* 是否正确供电
+* 您的镜像内核是否支持CAN
+* 固件编译是否正确
+
+<!-- tabs:end -->
diff --git a/docs/board/fly_gemini_v2/_sidebar.md b/docs/board/fly_gemini_v2/_sidebar.md
@@ -9,7 +9,7 @@
   * [6. 启动前的系统配置](/board/fly_gemini_v2/flyos_install.md)
   * [7. 连接SSH](/board/fly_gemini_v2/to_ssh.md)
   * [8. 固件编译烧录](/board/fly_gemini_v2/flash.md)
-  * [9. 读取主板ID](/board/fly_gemini_v2/readid.md)
+  * [9. 读取主板ID](/board/fly_gemini_v2/usbid.md)
   * [10. Gemini主板接线](/board/fly_gemini_v2/wiring.md)
   * [11.printer参考配置](/board/fly_gemini_v2/cfg.md)
   * [12. Pin脚分布](/board/fly_gemini_v2/pins.md)

diff --git a/docs/board/fly_gemini_v2/readid.md b/docs/board/fly_gemini_v2/readid.md
diff --git a/docs/board/fly_gemini_v2/usbid.md b/docs/board/fly_gemini_v2/usbid.md
@@ -0,0 +1,52 @@
+# 读取ID
+
+<!-- tabs:start -->
+
+### **USB ID读取方法**
+
+1.[连接到SSH](/board/fly_C8/ssh "点击即可跳转")，然后输入 ``ls /dev/serial/by-id/*`` 回车。如果一切正常，则会出现下面一行蓝色的ID。
+
+<img src="../../images/boards/fly_super8/id.png" alt="id" style="zoom:80%;" />
+
+2.在左侧边栏的配置选项里找到：fluidd为：``{…}`` ；mainsail为：``机器``，点击进去，即可找到``printer.cfg``
+
+![fluidd](../../images/boards/fly_super8/fluidd.png)
+
+3.将蓝色的ID复制，填写到``printer.cfg``里。保存重启后即可连上主板。若Klipper提示 ``ADC out of range``为正常现象，将热床和热敏连接好，配置好喷头、热床的热敏引脚和输出引脚，再保存重启即可。
+
+<img src="../../images/boards/fly_super8/id2.png" alt="id2" style="zoom:80%;" />
+
+### **CAN ID读取方法**
+
+> [!TIP]
+> 已经识别到的CAN ID是不会被查找到的（即已经写入配置文件printer.cfg中的ID，连接成功并正常运行的，是不会被查找到的）
+
+
+
+> [!Tip]
+>
+> 请确保上位机的can0、桥接主板的CAN速率、CAN工具板的速率完全一致
+
+```bash
+[mcu]
+canbus_uuid: b7c79ec3f948     #将读取到的uuid填写到此处
+```
+
+也可以在SSH中输入下面的命令查找uuid
+
+```bash
+~/klippy-env/bin/python ~/klipper/scripts/canbus_query.py can0
+```
+
+![uuid](../../images/boards/fly_sht36_42/uuid.png)
+
+出现``Found canbus_uuid=b7c79ec3f948``则查找到设备ID，其中``b7c79ec3f948``为设备UUID。
+
+> [!TIP]
+> 如果找不到CAN ID，请检查：
+
+* 是否正确供电
+* 您的镜像内核是否支持CAN
+* 固件编译是否正确
+
+<!-- tabs:end -->
diff --git a/docs/board/fly_gemini_v3/_sidebar.md b/docs/board/fly_gemini_v3/_sidebar.md
@@ -9,7 +9,7 @@
     * [6. 启动前的系统配置](/board/fly_gemini_v3/config.md)
     * [7. 连接SSH](/board/fly_gemini_v3/to_ssh.md)
     * [8. 固件编译烧录](/board/fly_gemini_v3/flash.md)
-    * [9. 读取主板ID](/board/fly_gemini_v3/readid.md)
+    * [9. 读取主板ID](/board/fly_gemini_v3/usbid.md)
     * [10. Gemini主板接线](/board/fly_gemini_v3/wiring.md)
     * [11. printer参考配置](/board/fly_gemini_v3/cfg.md)
     * [12. Pin脚分布](/board/fly_gemini_v3/pins.md)