Skip to content

development.md

Latest commit

 

History

History
131 lines (96 loc) · 3.1 KB

development.md

File metadata and controls

131 lines (96 loc) · 3.1 KB
Raw

Development Guide

Read CONTRIBUTING.md before changing robot controls, topics, persistence, networking, or safety behavior.

Frontend development server

cd ~/openamrobot-ui/web
npm ci
npm run dev

Open http://localhost:3000.

The development server can render without ROS. Live robot data and controls require rosbridge on port 9090. When the page runs on port 3000, the fallback robot address comes from ROSBRIDGE_SERVER_IP in web/src/shared/constants/index.js.

The development server bypasses Flask. Flask REST features therefore still require the backend on port 5050.

Production frontend workflow

The production path has three stages:

web/src
  → npm production build in web/build
  → synchronized ROS static/app directory
  → installed openamr_ui_package share directory

Run:

cd ~/openamrobot-ui
bash scripts/build_frontend.sh
bash scripts/sync_frontend_to_ros.sh

cd ros2
source /opt/ros/jazzy/setup.bash
colcon build --symlink-install --packages-select openamr_ui_package
source install/setup.bash
ros2 launch openamr_ui_bringup ui.launch.py

Hard-refresh the browser with Ctrl+Shift+R after rebuilding.

Frontend checks

cd ~/openamrobot-ui/web
CI=true npm test -- --watchAll=false
npm run build

npm run lint applies Prettier and ESLint fixes. Run it only when you are ready to review and keep those edits.

ROS development

Build all packages:

cd ~/openamrobot-ui/ros2
source /opt/ros/jazzy/setup.bash
colcon build --symlink-install
source install/setup.bash

Build selected packages:

colcon build --symlink-install \
  --packages-select openamr_ui_msgs openamr_ui_package openamr_ui_bringup

Run ROS tests:

colcon test --packages-select openamr_ui_package openamr_ui_msgs
colcon test-result --verbose

After changing messages:

colcon build --symlink-install \
  --packages-select openamr_ui_msgs openamr_ui_package
source install/setup.bash

Where to make changes

Change Start here
Add a page or panel UI panel guide
Connect a topic or external device External-device guide
Add a Blockly block Blockly extension guide
Understand page composition Lesson 06
Understand shared components Lesson 07
Change a topic name or message type Lesson 10
Change backend nodes Lesson 05

Generated directories

Do not edit or commit:

web/node_modules/
web/build/
ros2/build/
ros2/install/
ros2/log/

Edit sources under web/src/ and ros2/src/.

Verification order

For a behavior that can move hardware:

  1. Verify static checks and unit tests.
  2. Test in Demo Mode when the feature supports it.
  3. Test in simulation.
  4. Test on hardware at low speed with a clear area and tested physical emergency stop.

Record the commands, scenario, and observed result in the pull request.