# ob-f/openbot architecture

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

- Interactive diagram: https://gitdiagram.com/ob-f/openbot
- Repository: https://github.com/ob-f/openbot

## Overview

OpenBot is a smartphone-centered robotics platform: a phone runs robot software and controls a low-cost vehicle, with separate tools for remote operation, visual programming, and driving-policy training. The README establishes these product capabilities; sampled source confirms selected camera, control, signaling, and sensor-logging responsibilities, but not the complete cross-platform runtime wiring.

Main entry points: [`policy/frontend/src/App.tsx`](https://github.com/ob-f/openbot/blob/master/policy/frontend/src/App.tsx) (Policy trainer UI), [`robot/ios/OpenBot/OpenBot/Controllers/FreeRoam/FreeRoamController.swift`](https://github.com/ob-f/openbot/blob/master/robot/ios/OpenBot/OpenBot/Controllers/FreeRoam/FreeRoamController.swift) (Free roam), [`robot/android/app/src/main/java/org/openbot/app/robot/main/MainActivity.java`](https://github.com/ob-f/openbot/blob/master/robot/android/app/src/main/java/org/openbot/app/robot/main/MainActivity.java) (Robot app), [`controller/node-js/client/index.js`](https://github.com/ob-f/openbot/blob/master/controller/node-js/client/index.js) (Controller)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_robot["Robot apps"]
  node_robot_app["Robot app<br/>[MainActivity.java]"]
  node_ios_camera["Camera capture"]
  node_ios_roam["Free roam"]
  node_ios_network["Inference network<br/>[Network.swift]"]
  node_sensor_logging["Sensor logging<br/>[SensorService.java]"]
  node_preferences["Robot preferences"]
end

subgraph group_control["Remote control"]
  node_controller["Controller<br/>[index.js]"]
  node_controller_signaling["Signaling server<br/>[server.js]"]
  node_connection_manager["Connection manager"]
end

subgraph group_coding["Robot programming"]
  node_playground["Blockly playground<br/>[customblocks.js]"]
  node_playground_app["Playground app<br/>[App.js]"]
  node_firebase["Firebase services<br/>[firebase.js]"]
end

subgraph group_policy["Policy training"]
  node_policy_ui["Policy trainer UI<br/>[App.tsx]"]
  node_models_page["Model management<br/>[ModelsPage.tsx]"]
  node_training_page["Training page<br/>[TrainPage.tsx]"]
  node_policy_training["Policy training<br/>[train.py]"]
end

node_builder(("Robot builder"))
node_robot_body["Robot body"]

node_builder -->|"builds"| node_robot_body
node_builder -->|"installs"| node_robot_app
node_builder -->|"drives via"| node_controller
node_builder -->|"programs with"| node_playground_app
node_builder -->|"trains with"| node_policy_ui
node_robot_app -.->|"runs on"| node_robot_body
node_ios_roam -->|"uses"| node_ios_camera
node_ios_roam -->|"references"| node_ios_network
node_sensor_logging -->|"reads settings"| node_preferences
node_controller_signaling -.->|"relays messages"| node_robot_body
node_controller -.->|"connects to"| node_controller_signaling
node_playground_app -->|"uses"| node_firebase
node_policy_ui -->|"routes to"| node_models_page
node_policy_ui -->|"routes to"| node_training_page
node_training_page -.->|"starts training"| node_policy_training

click node_robot_app "https://github.com/ob-f/openbot/blob/master/robot/android/app/src/main/java/org/openbot/app/robot/main/MainActivity.java"
click node_ios_camera "https://github.com/ob-f/openbot/blob/master/robot/ios/OpenBot/OpenBot/Controllers/CameraController.swift"
click node_ios_roam "https://github.com/ob-f/openbot/blob/master/robot/ios/OpenBot/OpenBot/Controllers/FreeRoam/FreeRoamController.swift"
click node_ios_network "https://github.com/ob-f/openbot/blob/master/robot/ios/OpenBot/OpenBot/tflite/Network.swift"
click node_sensor_logging "https://github.com/ob-f/openbot/blob/master/robot/android/app/src/main/java/org/openbot/app/robot/logging/SensorService.java"
click node_preferences "https://github.com/ob-f/openbot/blob/master/robot/android/app/src/main/java/org/openbot/app/robot/env/SharedPreferencesManager.java"
click node_controller "https://github.com/ob-f/openbot/blob/master/controller/node-js/client/index.js"
click node_controller_signaling "https://github.com/ob-f/openbot/blob/master/controller/web-server/server/server.js"
click node_connection_manager "https://github.com/ob-f/openbot/blob/master/controller/node-js/server/connection-manager.js"
click node_playground "https://github.com/ob-f/openbot/blob/master/open-code/src/components/blockly/blocks/customblocks.js"
click node_playground_app "https://github.com/ob-f/openbot/blob/master/open-code/src/App.js"
click node_firebase "https://github.com/ob-f/openbot/blob/master/open-code/src/services/firebase.js"
click node_policy_ui "https://github.com/ob-f/openbot/blob/master/policy/frontend/src/App.tsx"
click node_models_page "https://github.com/ob-f/openbot/blob/master/policy/frontend/src/pages/ModelsPage.tsx"
click node_training_page "https://github.com/ob-f/openbot/blob/master/policy/frontend/src/pages/TrainPage.tsx"
click node_policy_training "https://github.com/ob-f/openbot/blob/master/policy/openbot/train.py"

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_robot_app,node_ios_camera,node_ios_roam,node_ios_network,node_sensor_logging,node_preferences toneBlue
class node_controller,node_controller_signaling,node_connection_manager toneAmber
class node_playground,node_playground_app,node_firebase toneMint
class node_policy_ui,node_models_page,node_training_page,node_policy_training toneRose
class node_builder,node_robot_body toneIndigo
```

## Components

### Robot apps

- [Robot app](https://github.com/ob-f/openbot/blob/master/robot/android/app/src/main/java/org/openbot/app/robot/main/MainActivity.java): `robot/android/app/src/main/java/org/openbot/app/robot/main/MainActivity.java`
- [Camera capture](https://github.com/ob-f/openbot/blob/master/robot/ios/OpenBot/OpenBot/Controllers/CameraController.swift): `robot/ios/OpenBot/OpenBot/Controllers/CameraController.swift`
- [Free roam](https://github.com/ob-f/openbot/blob/master/robot/ios/OpenBot/OpenBot/Controllers/FreeRoam/FreeRoamController.swift): `robot/ios/OpenBot/OpenBot/Controllers/FreeRoam/FreeRoamController.swift`
- [Inference network](https://github.com/ob-f/openbot/blob/master/robot/ios/OpenBot/OpenBot/tflite/Network.swift): `robot/ios/OpenBot/OpenBot/tflite/Network.swift`
- [Sensor logging](https://github.com/ob-f/openbot/blob/master/robot/android/app/src/main/java/org/openbot/app/robot/logging/SensorService.java): `robot/android/app/src/main/java/org/openbot/app/robot/logging/SensorService.java`
- [Robot preferences](https://github.com/ob-f/openbot/blob/master/robot/android/app/src/main/java/org/openbot/app/robot/env/SharedPreferencesManager.java): `robot/android/app/src/main/java/org/openbot/app/robot/env/SharedPreferencesManager.java`

### Remote control

- [Controller](https://github.com/ob-f/openbot/blob/master/controller/node-js/client/index.js): `controller/node-js/client/index.js`
- [Signaling server](https://github.com/ob-f/openbot/blob/master/controller/web-server/server/server.js): `controller/web-server/server/server.js`
- [Connection manager](https://github.com/ob-f/openbot/blob/master/controller/node-js/server/connection-manager.js): `controller/node-js/server/connection-manager.js`

### Robot programming

- [Blockly playground](https://github.com/ob-f/openbot/blob/master/open-code/src/components/blockly/blocks/customblocks.js): `open-code/src/components/blockly/blocks/customblocks.js`
- [Playground app](https://github.com/ob-f/openbot/blob/master/open-code/src/App.js): `open-code/src/App.js`
- [Firebase services](https://github.com/ob-f/openbot/blob/master/open-code/src/services/firebase.js): `open-code/src/services/firebase.js`

### Policy training

- [Policy trainer UI](https://github.com/ob-f/openbot/blob/master/policy/frontend/src/App.tsx): `policy/frontend/src/App.tsx`
- [Model management](https://github.com/ob-f/openbot/blob/master/policy/frontend/src/pages/ModelsPage.tsx): `policy/frontend/src/pages/ModelsPage.tsx`
- [Training page](https://github.com/ob-f/openbot/blob/master/policy/frontend/src/pages/TrainPage.tsx): `policy/frontend/src/pages/TrainPage.tsx`
- [Policy training](https://github.com/ob-f/openbot/blob/master/policy/openbot/train.py): `policy/openbot/train.py`

### Other components

- **Robot builder**
- **Robot body**

## Connections

- Robot builder → Robot body: builds (evidence: `README.md`)
- Robot builder → Robot app: installs (evidence: `README.md`)
- Robot builder → Controller: drives via (evidence: `README.md`)
- Robot builder → Playground app: programs with (evidence: `README.md`)
- Robot builder → Policy trainer UI: trains with (evidence: `README.md`)
- Robot app → Robot body: runs on
- Free roam → Camera capture: uses (evidence: `robot/ios/OpenBot/OpenBot/Controllers/FreeRoam/FreeRoamController.swift`)
- Free roam → Inference network: references (evidence: `robot/ios/OpenBot/OpenBot/Controllers/FreeRoam/FreeRoamController.swift`)
- Sensor logging → Robot preferences: reads settings (evidence: `robot/android/app/src/main/java/org/openbot/app/robot/logging/SensorService.java`)
- Signaling server → Robot body: relays messages
- Controller → Signaling server: connects to
- Playground app → Firebase services: uses (evidence: `open-code/src/App.js`)
- Policy trainer UI → Model management: routes to (evidence: `policy/frontend/src/App.tsx`)
- Policy trainer UI → Training page: routes to (evidence: `policy/frontend/src/App.tsx`)
- Training page → Policy training: starts training
