Merge branch 'feature/update_the_README_in_esp_joystick' into 'master'
esp_joystick: update the README files in examples/esp_joystick See merge request ae_group/esp-box!97
This commit is contained in:
Xu Xin
+1
-1
@@ -8,4 +8,4 @@ include($ENV{IDF_PATH}/tools/cmake/project.cmake)
|
||||
add_compile_options("-Wno-format"
|
||||
"-Wno-deprecated-declarations"
|
||||
"-Wno-unused-variable")
|
||||
project(joystick_controler)
|
||||
project(joystick_controller)
|
||||
+1
-1
@@ -1,5 +1,5 @@
|
||||
|
||||
# JoyStick-Controler Example
|
||||
# JoyStick-Controller Example
|
||||
|
||||
[[中文]](README_cn.md)
|
||||
|
||||
+4
-4
@@ -1,5 +1,5 @@
|
||||
|
||||
# JoyStick-Controler Example
|
||||
# JoyStick-Controller Example
|
||||
|
||||
[[English]](README.md)
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
|
||||
## 项目概述
|
||||
|
||||
ESP-JoyStick 硬件系统由 ESP32-S3-BOX-3 开发板、 JoyStick 手柄和 ESP32-S3-USB-Bridge 接收机三部分组成。ESP32-S3-BOX-3 作为主控制器，通过 PCIe 接口与 JoyStick 手柄进行连接。系统在“游戏模式”和“遥控模式”下运行。在游戏模式下，它支持 USB-HID 和 BLE-HID 协议，用于控制计算机游戏，以及 NES 模拟器模式。在 RC 遥控模式下，它利用 ESP-NOW 无线通信协议与 [ESP32-S3-USB-Bridge](https://docs.espressif.com/projects/espressif-esp-dev-kits/zh_CN/latest/esp32s3/esp32-s3-usb-bridge/user_guide.html)（购买链接：[淘宝](https://item.taobao.com/item.htm?ft=t&id=753321694177)或[速卖通](https://www.aliexpress.us/item/3256806114330511.html?gatewayAdapt=glo2usa4itemAdapt)）或其他 Expressif 开发板（这里的 ESP32-S3-USB-Bridge 或其他 Expressif 开发板作为航模接收机）进行配对，实现 [RC 遥控车](examples/esp_joystick/joystick_rc_receiver)和 [ESP-Drone](https://docs.espressif.com/projects/espressif-esp-drone/en/latest/gettingstarted.html) 四轴飞行器的无线控制。
|
||||
ESP-JoyStick 硬件系统由 ESP32-S3-BOX-3 开发板、 JoyStick 手柄和 ESP32-S3-USB-Bridge 接收机三部分组成。ESP32-S3-BOX-3 作为主控制器，通过 PCIe 接口与 JoyStick 手柄进行连接。系统在“游戏模式”和“遥控模式”下运行。在游戏模式下，它支持 USB-HID 和 BLE-HID 协议，用于控制计算机游戏，以及 NES 模拟器模式。在 RC 遥控模式下，它利用 ESP-NOW 无线通信协议与 [ESP32-S3-USB-Bridge](https://docs.espressif.com/projects/espressif-esp-dev-kits/zh_CN/latest/esp32s3/esp32-s3-usb-bridge/user_guide.html)（购买链接：[淘宝](https://item.taobao.com/item.htm?ft=t&id=753321694177)或[速卖通](https://www.aliexpress.us/item/3256806114330511.html?gatewayAdapt=glo2usa4itemAdapt)）或其他 Espressif 开发板（这里的 ESP32-S3-USB-Bridge 或其他 Espressif 开发板作为航模接收机）进行配对，实现 [RC 遥控车](examples/esp_joystick/joystick_rc_receiver)和 [ESP-Drone](https://docs.espressif.com/projects/espressif-esp-drone/en/latest/gettingstarted.html) 四轴飞行器的无线控制。
|
||||
|
||||
<div align="center">
|
||||
<img src="https://dl.espressif.com/ae/esp-box/ESP32-S3-BOX-3-JoyStick-overall.png/ESP32-S3-BOX-3-JoyStick-overall.png" width="60%">
|
||||
@@ -42,12 +42,12 @@ ESP-JoyStick 硬件系统由 ESP32-S3-BOX-3 开发板、 JoyStick 手柄和 ESP3
|
||||
|
||||
<div align="center">
|
||||
<img src="https://dl.espressif.com/ae/esp-box/control_esp_drone.gif/control_esp_drone.gif" width="60%">
|
||||
<p>ESP-JoyStick 遥控ESP-Droneo小飞机</p>
|
||||
<p>ESP-JoyStick 遥控 ESP-Drone 小飞机</p>
|
||||
</div>
|
||||
|
||||
<div align="center">
|
||||
<img src="https://dl.espressif.com/ae/esp-box/control_rc_car.gif/control_rc_car.gif" width="60%">
|
||||
<p>ESP-JoyStick 控制RC遥控车</p>
|
||||
<p>ESP-JoyStick 控制 RC 遥控车</p>
|
||||
</div>
|
||||
|
||||
## 硬件参考
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
#Add sources from ui directory
|
||||
file(GLOB_RECURSE SRC_UI ${CMAKE_SOURCE_DIR} "ui/*.c" "app/*.c")
|
||||
|
||||
idf_component_register(SRCS "joystick_controler_main.c" "app_ui_event.c" ${SRC_UI}
|
||||
idf_component_register(SRCS "joystick_controller_main.c" "app_ui_event.c" ${SRC_UI}
|
||||
INCLUDE_DIRS "." "ui" "app")
|
||||
|
||||
target_compile_options(${COMPONENT_LIB} PRIVATE -Wno-unused-const-variable)
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
[[中文]](README_cn.md)
|
||||
|
||||
This example represents the model aircraft receiver functionality module for the [ESP-JoyStick](examples/esp_joystick/joystick_controler) project. Using this sample program, you can control an RC remote control car with the following effects:
|
||||
This example represents the model aircraft receiver functionality module for the [ESP-JoyStick](examples/esp_joystick/joystick_controller) project. Using this sample program, you can control an RC remote control car with the following effects:
|
||||
|
||||
* Upon successful pairing and connection with ESP-JoyStick through ESP-NOW, the RGB indicator light turns green for 1 second and then turns off. When not paired, the RGB indicator light remains solid red.
|
||||
* Pushing the left joystick up/down makes the car move forward/backward.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
[[English]](README.md)
|
||||
|
||||
该示例为 [ESP-JoyStick](examples/esp_joystick/joystick_controler) 项目的航模接收机功能模块，使用该示例程序可实现对 RC 遥控车的控制，控制效果如下：
|
||||
该示例为 [ESP-JoyStick](examples/esp_joystick/joystick_controller) 项目的航模接收机功能模块，使用该示例程序可实现对 RC 遥控车的控制，控制效果如下：
|
||||
|
||||
* 通过 ESP-NOW 与 ESP-JoyStick 配对连接成功后，RGB 指示灯亮绿灯；未配对连接时，RGB指示灯红灯常亮。
|
||||
* 左侧摇杆向上/向下推，小车前进/后退。
|
||||
@@ -13,7 +13,7 @@
|
||||
|
||||
<div align="center">
|
||||
<img src="https://dl.espressif.com/ae/esp-box/control_rc_car.gif/control_rc_car.gif" width="60%">
|
||||
<p>ESP-JoyStick 控制RC遥控车</p>
|
||||
<p>ESP-JoyStick 控制 RC 遥控车</p>
|
||||
</div>
|
||||
|
||||
## 硬件说明
|
||||
|
||||
@@ -56,7 +56,7 @@ ignore: # You can also select ignoring files here
|
||||
- examples/usb_camera_lcd_display/components/esp_jpeg/
|
||||
- examples/watering_demo/main/gui/font/
|
||||
- examples/watering_demo/main/gui/image/
|
||||
- examples/esp_joystick/joystick_controler/main/ui/fonts
|
||||
- examples/esp_joystick/joystick_controler/main/ui/images
|
||||
- examples/esp_joystick/joystick_controler/main/ui
|
||||
- examples/esp_joystick/joystick_controler/pictures
|
||||
- examples/esp_joystick/joystick_controller/main/ui/fonts
|
||||
- examples/esp_joystick/joystick_controller/main/ui/images
|
||||
- examples/esp_joystick/joystick_controller/main/ui
|
||||
- examples/esp_joystick/joystick_controller/pictures
|
||||
|
||||
Reference in New Issue
Block a user