OriginBot Usage Guide
Let’s embark on the journey of intelligent robot development together!
Info
Before proceeding, you should have some basic knowledge of robot development. Test yourself with the following questions:
- What is Linux? What is Ubuntu? How do you open a command-line terminal? What do the commands
cd,ls, andsudomean? - What is SSH? What are the commonly used SSH tools in Windows and Ubuntu? How do you use them?
- What is ROS/ROS2? What are its core concepts? How do you install and use it? How do you compile a workspace and set environment variables?
If you can answer these questions, feel free to continue with the guide. Otherwise, it is recommended to spend 3–5 days researching these topics using search tools or reference materials and GYH Chat. This preparation will help you better understand the subsequent robot development process.
1. Choose the Right Kit
For a detailed list of materials included in the OriginBot kit, refer to: OriginBot Kit List.
2. Assemble OriginBot
Follow the Kit Assembly Guide or the instructions included in the kit to complete the assembly of your OriginBot.
Hint
Assembling the robot is expected to take 30 to 60 minutes. This process not only helps you understand the robot's components but also makes your OriginBot unique.
3. Burn the Image and Firmware
Once the kit is assembled, the "body" of the OriginBot is ready. The next step is to inject its "soul."
- Follow the "System Installation and Backup" instructions to Burn the OriginBot SD Card Image.
- Follow the Controller Firmware Installation Guide to flash the controller firmware.
Attention
The OriginBot does not come with a pre-burned SD card image. Please follow the instructions above to complete the process; otherwise, subsequent functions may not work properly.
4. Configure the Computer Environment
To monitor and control the robot remotely, configure your computer as follows:
- Refer to Ubuntu System Installation to install the system environment on your computer. Ubuntu 22.04 is recommended.
- Refer to ROS2 System Installation to install ROS2 on the Ubuntu system. ROS2 Humble is recommended.
- Refer to Downloading/Compiling PC Function Packages to compile OriginBot-related function packages. These packages are primarily used for visualization and simulation on the host computer.
5. Run the Quick Start Example
Now you’re ready to bring your OriginBot to life.
Follow the Quick Start Guide to perform the first operation and control the robot's movement.
6. Explore Robot Functions
OriginBot includes various sample programs to help developers understand intelligent robot development. Detailed instructions can be found in the following sections:
Basic Usage
This section explains how to use OriginBot's basic functions:
| Function | Description | Difficulty |
|---|---|---|
| Build a Development Environment | Set up a remote debugging environment using VS Code | Beginner |
| Code Development Methodology | Modify and compile function packages | Beginner |
| Robot Startup and Parameter Configuration | Start the OriginBot chassis and sensors | Beginner |
| Robot Remote Control and Visualization | Control the robot's movement using a keyboard or joystick | Beginner |
| Camera Driver and Visualization | Visualize camera image data | Beginner |
| Lidar Driver and Visualization | Visualize lidar data | Beginner |
| IMU Driver and Visualization | Visualize IMU data | Beginner |
| Dynamic Monitoring of Robot Parameters | Monitor robot voltage, peripherals, temperature, and PID parameters | Beginner |
| Robot Odometry Calibration | Calibrate the robot's linear and angular velocities | Intermediate |
| Robot Charging Method | Instructions for charging the robot | Beginner |
| Communication Protocol Description | Details of the communication protocol between the controller and RDK X5 | Intermediate |
| Upper Computer Control Instructions | Communication between the upper computer and RDK X5 | Advanced |
| RTOS Configuration | Configure the controller with FreeRTOS | Advanced |
| EKF Multi-Sensor Fusion | Perform EKF multi-sensor positioning | Beginner |
Application Features
This section introduces OriginBot's application functions:
| Function | Description | Difficulty |
|---|---|---|
| Basic Functional Programming | Examples of basic robot function programming (e.g., obtaining robot status, controlling peripherals) | Intermediate |
| SLAM Map Construction | Build maps using Cartographer | Beginner |
| Autonomous Navigation | Use Navigation2 and AMCL for autonomous positioning and navigation | Beginner |
| Human Body Tracking | Dynamically recognize and follow human movements | Beginner |
| Gesture Control | Dynamically recognize gestures and perform corresponding actions | Beginner |
| Visual Line Follower (OpenCV) | Implement visual line following using OpenCV | Intermediate |
| Visual Line Follower (AI Deep Learning) | Implement visual line following using deep learning | Advanced |
| Gazebo Virtual Simulation | Run a 3D physical simulation environment for OriginBot on a PC | Intermediate |
| SLAM Mapping (Gazebo) | Perform mapping in a 3D physical simulation environment | Intermediate |
| Autonomous Navigation (Gazebo) | Perform autonomous navigation in a 3D physical simulation environment | Intermediate |
| Parking Spot Detection (AI Deep Learning) | Dynamically recognize parking spots and drive into them | Beginner |
| Trajectory Tracking | Follow a designated trajectory | Beginner |
| Kick the Ball and Shoot at Goal | Dynamically recognize a football and score a goal | Advanced |
| Voice Control | Dynamically recognize voice commands and respond accordingly | Advanced |
Application Function Demo
Explore More Possibilities
OriginBot is an open-source project built by the community. You can customize and redevelop it to make your OriginBot truly unique. Developers are encouraged to refer to, learn from, provide feedback, and contribute to the project.
If you create new features or improvements based on the OriginBot open-source project, please share them here!
We wish you an exciting journey in robot development! ☻
