# minnnnno/inf2004_smartrobo architecture

> Architecture diagram of the GitHub repository minnnnno/inf2004_smartrobo, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/minnnnno/inf2004_smartrobo
- Repository: https://github.com/minnnnno/inf2004_smartrobo

## Overview

INF2004 SmartRobo is embedded robot firmware integrating motion control with line/barcode navigation, terrain monitoring, obstacle avoidance, and Buddy 1 WiFi/MQTT command handling. The principal workflow routes requests through the Vehicle Controller into Buddy 2 motion control; independent safety controls can stop or invalidate commands. Startup composes and starts the application tasks, while supervision and telemetry support runtime monitoring. Relationships below follow explicit README statements and SOURCE INDEX references; unsampled implementation details are not inferred.

Main entry points: [`app_program/subsystem3/line_following.c`](https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem3/line_following.c) (Line following), [`app_program/subsystem1/comms.c`](https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem1/comms.c) (WiFi and MQTT queues), [`app_program/controller/vehicle_controller.c`](https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/controller/vehicle_controller.c) (Vehicle Controller), [`app_program/app_main.c`](https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/app_main.c) (Application startup)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_application["Application control"]
  node_startup["Application startup<br/>[app_main.c]"]
  node_task_table["Task startup<br/>[app_tasks.c]"]
  node_app_interfaces["Application interfaces<br/>[app.h]"]
  node_controller["Vehicle Controller"]
  node_robot_bus["Request and status bus<br/>[robot.h]"]
end

subgraph group_motion["Motion control"]
  node_motion_runtime["Motion runtime<br/>[motion_runtime.c]"]
  node_motion_engine["Motion control<br/>[motion.c]"]
  node_motion_api["Motion interfaces<br/>[motion.h]"]
  node_motion_hal["Motor and encoder HAL<br/>[motion_hal.h]"]
  node_encoder_api["Encoder capture<br/>[encoder_capture.h]"]
  node_board_config["Board configuration<br/>[board_config.h]"]
  node_hal_template["Template HAL interface<br/>[template_hal.h]"]
end

subgraph group_autonomy["Navigation and sensing"]
  node_line_follow["Line following<br/>[line_following.c]"]
  node_line_rejoin["Line rejoin interface<br/>[line_rejoin.h]"]
  node_route["Route actions<br/>[route.h]"]
  node_barcode["Barcode navigation<br/>[barcode.c]"]
  node_terrain["Terrain and IMU<br/>[terrain_task.c]"]
  node_obstacle["Obstacle avoidance<br/>[detour.c]"]
  node_steering["Steering interface<br/>[steering.h]"]
  node_subsystem_interfaces["Subsystem interfaces<br/>[subsystems.h]"]
end

subgraph group_integration["Communications and supervision"]
  node_comms["WiFi and MQTT queues<br/>[comms.c]"]
  node_comms_api["Communications interface<br/>[comms.h]"]
  node_telemetry["Telemetry frame<br/>[telemetry_frame.h]"]
  node_system_runtime["System supervision<br/>[system_runtime.c]"]
end

node_operator(("Operator"))

node_operator -.->|"sends commands"| node_comms
node_comms -->|"queues start/stop"| node_controller
node_startup -->|"starts tasks"| node_task_table
node_startup -->|"composes"| node_controller
node_controller -->|"submits requests"| node_motion_runtime
node_motion_runtime -.->|"runs motion"| node_motion_engine
node_motion_engine -->|"uses interface"| node_motion_api
node_motion_hal -->|"uses interface"| node_motion_api
node_line_follow -->|"runs route actions"| node_route
node_line_follow -->|"uses interface"| node_line_rejoin
node_line_follow -->|"uses steering"| node_steering
node_line_follow -->|"uses HAL"| node_hal_template
node_terrain -->|"requests stops"| node_controller
node_obstacle -->|"uses rejoin"| node_line_rejoin
node_comms -->|"uses frames"| node_telemetry
node_comms -->|"references routes"| node_route
node_startup -->|"runs supervision"| node_system_runtime
node_motion_runtime -->|"shares request bus"| node_robot_bus

click node_startup "https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/app_main.c"
click node_task_table "https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/system/app_tasks.c"
click node_app_interfaces "https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/app.h"
click node_controller "https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/controller/vehicle_controller.c"
click node_robot_bus "https://github.com/minnnnno/inf2004_smartrobo/blob/main/include/robot.h"
click node_motion_runtime "https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem2/motion_runtime.c"
click node_motion_engine "https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem2/motion.c"
click node_motion_api "https://github.com/minnnnno/inf2004_smartrobo/blob/main/include/motion.h"
click node_motion_hal "https://github.com/minnnnno/inf2004_smartrobo/blob/main/include/motion_hal.h"
click node_encoder_api "https://github.com/minnnnno/inf2004_smartrobo/blob/main/include/encoder_capture.h"
click node_board_config "https://github.com/minnnnno/inf2004_smartrobo/blob/main/include/board_config.h"
click node_line_follow "https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem3/line_following.c"
click node_line_rejoin "https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem3/line_rejoin.h"
click node_route "https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem3/route.h"
click node_barcode "https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem3/barcode.c"
click node_terrain "https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem4/terrain_task.c"
click node_obstacle "https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem5/detour.c"
click node_comms "https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem1/comms.c"
click node_comms_api "https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem1/comms.h"
click node_telemetry "https://github.com/minnnnno/inf2004_smartrobo/blob/main/include/telemetry_frame.h"
click node_system_runtime "https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/system/system_runtime.c"
click node_hal_template "https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem2/template_hal.h"
click node_steering "https://github.com/minnnnno/inf2004_smartrobo/blob/main/include/steering.h"
click node_subsystem_interfaces "https://github.com/minnnnno/inf2004_smartrobo/blob/main/include/subsystems.h"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_startup,node_task_table,node_app_interfaces,node_controller,node_robot_bus toneBlue
class node_motion_runtime,node_motion_engine,node_motion_api,node_motion_hal,node_encoder_api,node_board_config,node_hal_template toneAmber
class node_line_follow,node_line_rejoin,node_route,node_barcode,node_terrain,node_obstacle,node_steering,node_subsystem_interfaces toneMint
class node_comms,node_comms_api,node_telemetry,node_system_runtime toneRose
class node_operator toneIndigo
```

## Components

### Application control

- [Application startup](https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/app_main.c): `app_program/app_main.c`
- [Task startup](https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/system/app_tasks.c): `app_program/system/app_tasks.c`
- [Application interfaces](https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/app.h): `app_program/app.h`
- [Vehicle Controller](https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/controller/vehicle_controller.c): `app_program/controller/vehicle_controller.c`
- [Request and status bus](https://github.com/minnnnno/inf2004_smartrobo/blob/main/include/robot.h): `include/robot.h`

### Motion control

- [Motion runtime](https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem2/motion_runtime.c): `app_program/subsystem2/motion_runtime.c`
- [Motion control](https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem2/motion.c): `app_program/subsystem2/motion.c`
- [Motion interfaces](https://github.com/minnnnno/inf2004_smartrobo/blob/main/include/motion.h): `include/motion.h`
- [Motor and encoder HAL](https://github.com/minnnnno/inf2004_smartrobo/blob/main/include/motion_hal.h): `include/motion_hal.h`
- [Encoder capture](https://github.com/minnnnno/inf2004_smartrobo/blob/main/include/encoder_capture.h): `include/encoder_capture.h`
- [Board configuration](https://github.com/minnnnno/inf2004_smartrobo/blob/main/include/board_config.h): `include/board_config.h`
- [Template HAL interface](https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem2/template_hal.h): `app_program/subsystem2/template_hal.h`

### Navigation and sensing

- [Line following](https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem3/line_following.c): `app_program/subsystem3/line_following.c`
- [Line rejoin interface](https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem3/line_rejoin.h): `app_program/subsystem3/line_rejoin.h`
- [Route actions](https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem3/route.h): `app_program/subsystem3/route.h`
- [Barcode navigation](https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem3/barcode.c): `app_program/subsystem3/barcode.c`
- [Terrain and IMU](https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem4/terrain_task.c): `app_program/subsystem4/terrain_task.c`
- [Obstacle avoidance](https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem5/detour.c): `app_program/subsystem5/detour.c`
- [Steering interface](https://github.com/minnnnno/inf2004_smartrobo/blob/main/include/steering.h): `include/steering.h`
- [Subsystem interfaces](https://github.com/minnnnno/inf2004_smartrobo/blob/main/include/subsystems.h): `include/subsystems.h`

### Communications and supervision

- [WiFi and MQTT queues](https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem1/comms.c): `app_program/subsystem1/comms.c`
- [Communications interface](https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/subsystem1/comms.h): `app_program/subsystem1/comms.h`
- [Telemetry frame](https://github.com/minnnnno/inf2004_smartrobo/blob/main/include/telemetry_frame.h): `include/telemetry_frame.h`
- [System supervision](https://github.com/minnnnno/inf2004_smartrobo/blob/main/app_program/system/system_runtime.c): `app_program/system/system_runtime.c`

### Other components

- **Operator**

## Connections

- Operator → WiFi and MQTT queues: sends commands
- WiFi and MQTT queues → Vehicle Controller: queues start/stop
- Application startup → Task startup: starts tasks
- Application startup → Vehicle Controller: composes
- Vehicle Controller → Motion runtime: submits requests
- Motion runtime → Motion control: runs motion
- Motion control → Motion interfaces: uses interface (evidence: `app_program/subsystem2/motion.c`)
- Motor and encoder HAL → Motion interfaces: uses interface (evidence: `include/motion_hal.h`)
- Line following → Route actions: runs route actions (evidence: `app_program/subsystem3/line_following.c`)
- Line following → Line rejoin interface: uses interface (evidence: `app_program/subsystem3/line_following.c`)
- Line following → Steering interface: uses steering (evidence: `app_program/subsystem3/line_following.c`)
- Line following → Template HAL interface: uses HAL (evidence: `app_program/subsystem3/line_following.c`)
- Terrain and IMU → Vehicle Controller: requests stops
- Obstacle avoidance → Line rejoin interface: uses rejoin (evidence: `app_program/subsystem5/detour.c`)
- WiFi and MQTT queues → Telemetry frame: uses frames
- WiFi and MQTT queues → Route actions: references routes (evidence: `app_program/subsystem1/comms.c`)
- Application startup → System supervision: runs supervision
- Motion runtime → Request and status bus: shares request bus
