clean up readme
parent
cfc390e1d6
commit
6b912191d6
54
readme.md
54
readme.md
|
|
@ -336,56 +336,4 @@ Fields: `X (cm)`, `Y (cm)`, `Heading (rad)`, `Vel X (cm/s)`, `Vel Y (cm/s)`, `An
|
||||||
- [x] `pixi run build-as5600` berhasil — as5600_node compile dengan nav_msgs dependency
|
- [x] `pixi run build-as5600` berhasil — as5600_node compile dengan nav_msgs dependency
|
||||||
- [x] Handler `odometry_read` berfungsi di dummy mode (test passes)
|
- [x] Handler `odometry_read` berfungsi di dummy mode (test passes)
|
||||||
- [ ] End-to-end: Blockly → executor (real) → cache `odometry_encoder/odom` → return JSON
|
- [ ] End-to-end: Blockly → executor (real) → cache `odometry_encoder/odom` → return JSON
|
||||||
- [x] Integration test `test_block_odometry.py` passes di dummy mode
|
- [x] Integration test `test_block_odometry.py` passes di dummy mode
|
||||||
|
|
||||||
|
|
||||||
## 6 Enhancement: Split BLOCKS.md Documentation : [x]
|
|
||||||
BLOCKS.md (1225 baris) dipecah menjadi 4 file terpisah + index di `src/blockly_app/docs/` agar lebih mudah dinavigasi.
|
|
||||||
|
|
||||||
### Definition Of Done
|
|
||||||
- [x] `docs/BLOCKS.md` — index / table of contents (~40 baris)
|
|
||||||
- [x] `docs/01-quickstart.md` — walkthrough end-to-end menambah block baru
|
|
||||||
- [x] `docs/02-block-api-ref.md` — API reference `BlockRegistry.register()`, `definition.init`
|
|
||||||
- [x] `docs/03-templates.md` — 6 template copy-paste (A–F)
|
|
||||||
- [x] `docs/04-examples.md` — contoh real (`digitalOut`, `digitalIn`, `delay`) + tabel kategori
|
|
||||||
- [x] Semua referensi ke BLOCKS.md di-update (README.md, DOCUMENTATION.md, blockly_interfaces/README.md, readme.md)
|
|
||||||
- [x] Original `BLOCKS.md` dihapus
|
|
||||||
|
|
||||||
## 8 Enhancement: Launch Files — Desktop Bringup : [ ]
|
|
||||||
ROS2 launch files untuk menjalankan executor + blockly_app dengan satu command. Package `amr_bringup` (ament_python, launch-only).
|
|
||||||
|
|
||||||
### Implementasi
|
|
||||||
|
|
||||||
#### A. Package Structure
|
|
||||||
```
|
|
||||||
src/amr_bringup/
|
|
||||||
├── package.xml
|
|
||||||
├── setup.py / setup.cfg
|
|
||||||
├── resource/amr_bringup
|
|
||||||
├── amr_bringup/__init__.py
|
|
||||||
├── launch/
|
|
||||||
│ ├── blockly.launch.py # executor (dummy) + blockly_app
|
|
||||||
│ └── blockly_hw.launch.py # executor (real) + blockly_app
|
|
||||||
└── config/ # reserved untuk Pi nodes YAML nanti
|
|
||||||
```
|
|
||||||
|
|
||||||
#### B. Pixi Tasks
|
|
||||||
```bash
|
|
||||||
pixi run launch-blockly # executor dummy + app (development)
|
|
||||||
pixi run launch-blockly-hw # executor real + app (Pi nodes harus sudah jalan)
|
|
||||||
```
|
|
||||||
|
|
||||||
#### C. Catatan
|
|
||||||
- `blockly_app` diluncurkan via `ExecuteProcess` (bukan `Node()`) karena pywebview memerlukan main thread ownership
|
|
||||||
- Pi nodes (gpio, pca9685, as5600) akan dibahas terpisah — kemungkinan menggunakan C++ composition (`rclcpp_components`) untuk optimasi resource di Raspberry Pi
|
|
||||||
- Ctrl+C menghentikan semua node sekaligus
|
|
||||||
|
|
||||||
### Definition Of Done
|
|
||||||
- [x] `src/amr_bringup/` package scaffolding (package.xml, setup.py, setup.cfg, resource)
|
|
||||||
- [x] `launch/blockly.launch.py` — executor dummy + app
|
|
||||||
- [x] `launch/blockly_hw.launch.py` — executor real + app
|
|
||||||
- [x] Pixi tasks: `build-bringup`, `launch-blockly`, `launch-blockly-hw`
|
|
||||||
- [x] `pixi run launch-blockly` berhasil menjalankan executor + app
|
|
||||||
- [x] `pixi run launch-blockly-hw` berhasil menjalankan executor (real) + app
|
|
||||||
- [x] Ctrl+C menghentikan semua proses
|
|
||||||
|
|
||||||
Loading…
Reference in New Issue