fix: fix the description

Signed-off-by: Nascs Fang <[email protected]>
radxa-docs · Dec 3, 2024 · cf1703a · cf1703a
1 parent 1d24635
commit cf1703a
Show file tree

Hide file tree

Showing 10 changed files with 95 additions and 15 deletions.
diff --git a/docs/common/dev/_pico-sdk-windows.mdx b/docs/common/dev/_pico-sdk-windows.mdx
@@ -1,4 +1,4 @@
-### 安装必要工具
+## 安装必要工具
 
 - [Git for Windows](https://github.com/git-for-windows/git/releases/download/v2.47.1.windows.1/Git-2.47.1-64-bit.exe)
 
@@ -48,7 +48,7 @@
 
 - [Python3 for Windows](https://www.python.org/downloads/windows/)
 
-### 设置环境变量
+## 设置环境变量
 
 - 在搜索栏搜索 "编辑系统环境"
 
@@ -84,7 +84,7 @@
     alt="pico path env"
   />
 
-### 构建编译
+## 构建编译
 
 打开 git bash， 进入到 pico-examples/build 目录下，执行以下命令进行构建编译
 

diff --git a/docs/x/x2l/software-development/c-sdk-windows.md b/docs/x/x2l/software-development/c-sdk-windows.md
@@ -4,6 +4,20 @@ sidebar_position: 31
 
 import PICO_SDK_WINDOWS from "../../../common/dev/\_pico-sdk-windows.mdx";
 
-# 在 Windows 下搭建 RP2040 的 C/C++ 编译环境
+# 在 Windows 下控制 RP2040
 
 <PICO_SDK_WINDOWS />
+
+## 烧录
+
+按下 BOOTSEL 键后， 会弹出一个 USB 设备。将编译后产生的 .uf2 文件拷贝到 RP2040 的 USB 设备中， 待该 USB 设备消失后， 程序开始执行。
+
+## 示例
+
+<GPIO flash_url="./flash" gpio_definition="./gpio" product_name="Radxa X2L"  led_pin="PIN_5" />
+
+<I2C flash_url="./flash" product_name="Radxa X2L"  scl_pin="PIN_5" sda_pin="PIN_3" />
+
+<PWM flash_url="./flash" product_name="Radxa X2L" led_pin="PIN_5" />
+
+<UART flash_url="./flash" tty_num="ttyS0"/>
diff --git a/docs/x/x2l/software-development/c_sdk_examples.md b/docs/x/x2l/software-development/c_sdk_examples.md
@@ -10,7 +10,7 @@ import FAN from "../../../common/dev/\_pico-fan.mdx";
 import RELATION from "./\_relation.mdx"
 import UART from "../../../common/dev/\_pico-uart.mdx";
 
-# 40-PIN 使用指南
+# Linux 下控制 RP2040
 
 ## Intel J4125 与 RP2040 和 40-PIN GPIO 的关系介绍
 

diff --git a/docs/x/x4/software/c-sdk-windows.md b/docs/x/x4/software/c-sdk-windows.md
@@ -4,6 +4,32 @@ sidebar_position: 31
 
 import PICO_SDK_WINDOWS from "../../../common/dev/\_pico-sdk-windows.mdx";
 
-# 在 Windows 下搭建 RP2040 的 C/C++ 编译环境
+# 在 Windows 下控制 RP2040
 
 <PICO_SDK_WINDOWS />
+
+## 烧录
+
+按下 BOOTSEL 键后， 会弹出一个 USB 设备。将编译后产生的 .uf2 文件拷贝到 RP2040 的 USB 设备中， 待该 USB 设备消失后， 程序开始执行。
+
+## 示例
+
+### RP2040 控制 40-PIN
+
+<Tabs queryString="type">
+    <TabItem value="GPIO">
+       <GPIO flash_url="./flash" gpio_definition="./gpio" product_name="Radxa X4"  led_pin="PIN_5" />
+    </TabItem>
+    <TabItem value="I2C">
+        <I2C flash_url="./flash" product_name="Radxa X4"  scl_pin="PIN_5" sda_pin="PIN_3" />
+    </TabItem>
+     <TabItem value="PWM">
+       <PWM flash_url="./flash" product_name="Radxa X4" led_pin="PIN_5" />
+    </TabItem>
+     <TabItem value="PoE FAN">
+       <PoE flash_url="./flash" product_name="Radxa X4" poe_name="瑞莎 25W PoE+ HAT X4 专用款" poe_img="/img/x/x4/25w_poe_plus_for_x4_04.webp" />
+    </TabItem>
+     <TabItem value="UART">
+      <UART flash_url="./flash" tty_num="ttyS4" />
+    </TabItem>
+</Tabs>
diff --git a/docs/x/x4/software/c_sdk_examples.md b/docs/x/x4/software/c_sdk_examples.md
@@ -12,7 +12,7 @@ import RELATION from "./\_relation.mdx"
 import UART from "../../../common/dev/\_pico-uart.mdx";
 import INTEL_UART from "../../../common/dev/\_pico-gpio-controlled-by-intel.mdx";
 
-# 40-PIN 使用指南
+# Linux 下控制 RP2040
 
 ## 概述
 

diff --git a/i18n/en/docusaurus-plugin-content-docs/current/common/dev/_pico-sdk-windows.mdx b/i18n/en/docusaurus-plugin-content-docs/current/common/dev/_pico-sdk-windows.mdx
@@ -1,4 +1,4 @@
-### 安装必要工具
+## 安装必要工具
 
 - [Git for Windows](https://github.com/git-for-windows/git/releases/download/v2.47.1.windows.1/Git-2.47.1-64-bit.exe)
 
@@ -48,7 +48,7 @@
 
 - [Python3 for Windows](https://www.python.org/downloads/windows/)
 
-### Set Environment Variables
+## Set Environment Variables
 
 - Search for ‘Edit the system environment’ in the search bar.
 
@@ -84,7 +84,7 @@
     alt="pico path env"
   />
 
-### Build
+## Build
 
 Open git bash, go to the pico-examples/build directory, and execute the following command to build the system
 

diff --git a/...usaurus-plugin-content-docs/current/x/x2l/software-development/c-sdk-windows.md b/...usaurus-plugin-content-docs/current/x/x2l/software-development/c-sdk-windows.md
@@ -4,6 +4,20 @@ sidebar_position: 31
 
 import PICO_SDK_WINDOWS from "../../../common/dev/\_pico-sdk-windows.mdx";
 
-# Build C/C++ compilation environment for RP2040 on Windows
+# Control RP2040 on Windows
 
 <PICO_SDK_WINDOWS />
+
+## Flash
+
+Press the BOOTSEL key and a USB device will pop up. Copy the compiled .uf2 file to the USB device of RP2040 and wait until the USB device disappears, then the programme will start to execute.
+
+## Examples
+
+<GPIO flash_url="./flash" gpio_definition="./gpio" product_name="Radxa X2L"  led_pin="PIN_5" />
+
+<I2C flash_url="./flash" product_name="Radxa X2L"  scl_pin="PIN_5" sda_pin="PIN_3" />
+
+<PWM flash_url="./flash" product_name="Radxa X2L" led_pin="PIN_5" />
+
+<UART flash_url="./flash" tty_num="ttyS0"/>
diff --git a/...saurus-plugin-content-docs/current/x/x2l/software-development/c_sdk_examples.md b/...saurus-plugin-content-docs/current/x/x2l/software-development/c_sdk_examples.md
@@ -10,13 +10,13 @@ import FAN from "../../../common/dev/\_pico-fan.mdx";
 import RELATION from "./\_relation.mdx"
 import UART from "../../../common/dev/\_pico-uart.mdx";
 
-# 40-PIN Usage
+# Control RP2040 on Linux
 
 ## Introduction to Intel N100 and RP2040 and 40-PIN GPIO Relationships
 
 <RELATION />
 
-## 40-PIN Usage
+## Control RP2040 on Linux
 
 In order to operate the IO resources on RP2040, we need a complete software environment, such as MicroPython or C/C++ SDK, here we mainly introduce a set of C/C++ SDKs, namely pico-sdk and pico-examples. pico-sdk mainly provides some APIs to operate the RP2040, while pico-examples provides a compilation framework for us to add our own programs according to the compilation framework provided by pico-examples. pico-sdk provides some APIs to operate the RP2040, while pico-examples provides a compilation framework for us to add our own programs according to the compilation framework provided by pico-examples.
 

diff --git a/i18n/en/docusaurus-plugin-content-docs/current/x/x4/software/c-sdk-windows.md b/i18n/en/docusaurus-plugin-content-docs/current/x/x4/software/c-sdk-windows.md
@@ -4,6 +4,32 @@ sidebar_position: 31
 
 import PICO_SDK_WINDOWS from "../../../common/dev/\_pico-sdk-windows.mdx";
 
-# Build C/C++ compilation environment for RP2040 on Windows
+# Control RP2040 on Windows
 
 <PICO_SDK_WINDOWS />
+
+## Flash
+
+Press the BOOTSEL key and a USB device will pop up. Copy the compiled .uf2 file to the USB device of RP2040 and wait until the USB device disappears, then the programme will start to execute.
+
+## Examples
+
+### RP2040 Control the 40-PIN
+
+<Tabs queryString="type">
+    <TabItem value="GPIO">
+       <GPIO flash_url="./flash" gpio_definition="./gpio" product_name="Radxa X4"  led_pin="PIN_5" />
+    </TabItem>
+    <TabItem value="I2C">
+        <I2C flash_url="./flash" product_name="Radxa X4"  scl_pin="PIN_5" sda_pin="PIN_3" />
+    </TabItem>
+     <TabItem value="PWM">
+       <PWM flash_url="./flash" product_name="Radxa X4" led_pin="PIN_5" />
+    </TabItem>
+     <TabItem value="PoE FAN">
+       <PoE flash_url="./flash" product_name="Radxa X4" poe_name="Radxa 25W PoE+ HAT X4 Special" poe_img="/img/x/x4/25w_poe_plus_for_x4_04.webp" />
+    </TabItem>
+     <TabItem value="UART">
+      <UART flash_url="./flash" tty_num="ttyS4" />
+    </TabItem>
+</Tabs>
diff --git a/i18n/en/docusaurus-plugin-content-docs/current/x/x4/software/c_sdk_examples.md b/i18n/en/docusaurus-plugin-content-docs/current/x/x4/software/c_sdk_examples.md
@@ -12,7 +12,7 @@ import RELATION from "./\_relation.mdx"
 import UART from "../../../common/dev/\_pico-uart.mdx";
 import INTEL_UART from "../../../common/dev/\_pico-gpio-controlled-by-intel.mdx";
 
-# 40-PIN Usage
+# Control RP2040 on Linux
 
 ## OverView