a2nr
/
amr-ros-k4
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
amr-ros-k4/DOCUMENTATION.md

36 lines
1.6 KiB
Markdown
Raw Normal View History

Add README files for blockly_app and blockly_executor; fix typo in digitalOut block
2026-03-09 23:35:48 +07:00
# Blockly ROS2 Robot Controller — Documentation
initial with big achivement
2026-03-07 11:13:06 +07:00
Add README files for blockly_app and blockly_executor; fix typo in digitalOut block
2026-03-09 23:35:48 +07:00
Visual programming interface for controlling a ROS2 Jazzy Kiwi Wheel AMR.
See [readme.md](readme.md) for project overview and status.
initial with big achivement
2026-03-07 11:13:06 +07:00
---
Add README files for blockly_app and blockly_executor; fix typo in digitalOut block
2026-03-09 23:35:48 +07:00
## Documentation Index
initial with big achivement
2026-03-07 11:13:06 +07:00
Add README files for blockly_app and blockly_executor; fix typo in digitalOut block
2026-03-09 23:35:48 +07:00
| Topic | File |
initial with big achivement
2026-03-07 11:13:06 +07:00
|---|---|
Add README files for blockly_app and blockly_executor; fix typo in digitalOut block
2026-03-09 23:35:48 +07:00
| System architecture & Blockly–ROS2 integration flow | [docs/architecture.md](docs/architecture.md) |
| Installation, directory structure & running | [docs/installation.md](docs/installation.md) |
| Troubleshooting & known issues | [docs/troubleshooting.md](docs/troubleshooting.md) |
| Guide: adding a new ROS2 package | [docs/ros2-package-guide.md](docs/ros2-package-guide.md) |
| `blockly_app` — file reference | [src/blockly_app/README.md](src/blockly_app/README.md) |
| `blockly_app` — creating custom blocks (full guide + reference) | [src/blockly_app/BLOCKS.md](src/blockly_app/BLOCKS.md) |
| `blockly_executor` — file reference, handlers & testing guide | [src/blockly_executor/README.md](src/blockly_executor/README.md) |
| `blockly_interfaces` — ROS2 action interface | [src/blockly_interfaces/README.md](src/blockly_interfaces/README.md) |
initial with big achivement
2026-03-07 11:13:06 +07:00
---
Add README files for blockly_app and blockly_executor; fix typo in digitalOut block
2026-03-09 23:35:48 +07:00
## Quick Start
initial with big achivement
2026-03-07 11:13:06 +07:00
```bash
Add README files for blockly_app and blockly_executor; fix typo in digitalOut block
2026-03-09 23:35:48 +07:00
pixi install # first time only
pixi run build-interfaces # must build interfaces first
pixi run build # build all packages
pixi run setup-ui # download Blockly JS vendor files (first time, needs internet)
Add digital output block and GPIO handling - Introduced a new Blockly block for setting digital output pins (`digitalOut`). - Implemented the corresponding handler in Python to manage digital output actions. - Updated dummy, GPIO, and real hardware interfaces to support digital output functionality. - Modified the workspace configuration to include the new digital output block in the Blockly environment. - Added potential enhancements to the README for future improvements.
2026-03-09 23:08:46 +07:00
Add README files for blockly_app and blockly_executor; fix typo in digitalOut block
2026-03-09 23:35:48 +07:00
pixi run executor # Terminal 1 — start Action Server
pixi run app # Terminal 2 — start desktop GUI
Add digital output block and GPIO handling - Introduced a new Blockly block for setting digital output pins (`digitalOut`). - Implemented the corresponding handler in Python to manage digital output actions. - Updated dummy, GPIO, and real hardware interfaces to support digital output functionality. - Modified the workspace configuration to include the new digital output block in the Blockly environment. - Added potential enhancements to the README for future improvements.
2026-03-09 23:08:46 +07:00
```
Add README files for blockly_app and blockly_executor; fix typo in digitalOut block
2026-03-09 23:35:48 +07:00
See [docs/installation.md](docs/installation.md) for full setup and prerequisites.