# mushketer888/grblcontroller architecture

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

- Interactive diagram: https://gitdiagram.com/mushketer888/grblcontroller
- Repository: https://github.com/mushketer888/grblcontroller

## Overview

Grbl Controller is an Android CNC control app. The main workflow is selecting a connection, attaching to a GRBL machine, using the control panels or sending a G-code file, and monitoring machine responses and job progress. Its major capabilities include Bluetooth, USB and TCP serial services, jogging, probing, console commands, file streaming, real-time overrides and status reporting. The README supports the product-level workflow; source excerpts and the index confirm selected service, parsing, event and UI relationships. Several panel-to-command and connection-activity wiring details were not shown, so those links are omitted or marked unverified.

Main entry points: [`app/src/main/java/com/iljal/grblcontoller/listeners/SerialCommunicationHandler.java`](https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/listeners/SerialCommunicationHandler.java) (Serial handlers), [`app/src/main/java/com/iljal/grblcontoller/GrblActivity.java`](https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/GrblActivity.java) (Main activity), [`app/src/main/java/com/iljal/grblcontoller/service/FileStreamerIntentService.java`](https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/service/FileStreamerIntentService.java) (File streamer), [`app/src/main/java/com/iljal/grblcontoller/service/GrblBluetoothSerialService.java`](https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/service/GrblBluetoothSerialService.java) (Bluetooth service)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_connect["Connections"]
  node_serial["Serial services"]
  node_bluetooth["Bluetooth service"]
  node_usb["USB service"]
  node_tcp["TCP service"]
end

subgraph group_control["Machine controls"]
  node_panels["Control panels"]
  node_jog["Jogging"]
end

subgraph group_stream["G-code streaming"]
  node_streamer["File streamer"]
  node_gcode["G-code commands<br/>[GcodeCommand.java]"]
end

subgraph group_protocol["GRBL protocol and state"]
  node_handlers["Serial handlers"]
  node_bt_handler["Bluetooth handler"]
  node_status["Machine status"]
  node_utils["GRBL utilities<br/>[GrblUtils.java]"]
  node_events["Event messages"]
end

subgraph group_app["App interface and support"]
  node_activity["Main activity<br/>[GrblActivity.java]"]
  node_preferences[("Preferences")]
  node_notifications["Notifications"]
  node_iconify["Icon rendering<br/>[Iconify.java]"]
end

node_operator(("Operator"))
node_machine(("GRBL machine"))
node_file["G-code file"]

node_operator -->|"controls"| node_activity
node_activity -.->|"presents"| node_panels
node_operator -->|"connects via"| node_bluetooth
node_operator -->|"connects via"| node_usb
node_operator -.->|"connects via"| node_tcp
node_bluetooth -->|"dispatches to"| node_bt_handler
node_usb -.->|"dispatches to"| node_handlers
node_tcp -.->|"dispatches to"| node_handlers
node_machine -->|"exchanges serial data"| node_serial
node_serial -.->|"routes messages"| node_handlers
node_handlers -->|"parses with"| node_utils
node_handlers -->|"updates"| node_status
node_handlers -->|"posts"| node_events
node_operator -->|"jogs machine"| node_jog
node_jog -.->|"sends jog commands"| node_machine
node_operator -->|"starts file send"| node_streamer
node_file -->|"provides G-code"| node_streamer
node_streamer -->|"creates commands"| node_gcode
node_streamer -->|"posts progress"| node_events
node_activity -->|"reads settings"| node_preferences
node_activity -->|"uses"| node_notifications
node_streamer -->|"notifies job state"| node_notifications
node_activity -->|"renders icons"| node_iconify
node_bluetooth -.->|"sends commands"| node_machine

click node_activity "https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/GrblActivity.java"
click node_panels "https://github.com/mushketer888/grblcontroller/tree/master/app/src/main/java/com/iljal/grblcontoller/ui"
click node_jog "https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/ui/JoggingTabFragment.java"
click node_serial "https://github.com/mushketer888/grblcontroller/tree/master/app/src/main/java/com/iljal/grblcontoller/service"
click node_bluetooth "https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/service/GrblBluetoothSerialService.java"
click node_usb "https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/service/GrblUsbSerialService.java"
click node_tcp "https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/service/GrblTcpSerialService.java"
click node_handlers "https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/listeners/SerialCommunicationHandler.java"
click node_bt_handler "https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/listeners/SerialBluetoothCommunicationHandler.java"
click node_status "https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/listeners/MachineStatusListener.java"
click node_utils "https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/util/GrblUtils.java"
click node_events "https://github.com/mushketer888/grblcontroller/tree/master/app/src/main/java/com/iljal/grblcontoller/events"
click node_streamer "https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/service/FileStreamerIntentService.java"
click node_gcode "https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/model/GcodeCommand.java"
click node_preferences "https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/helpers/EnhancedSharedPreferences.java"
click node_notifications "https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/helpers/NotificationHelper.java"
click node_iconify "https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/joanzapata/iconify/Iconify.java"

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_serial,node_bluetooth,node_usb,node_tcp toneBlue
class node_panels,node_jog toneAmber
class node_streamer,node_gcode toneMint
class node_handlers,node_bt_handler,node_status,node_utils,node_events toneRose
class node_activity,node_preferences,node_notifications,node_iconify,node_operator,node_machine,node_file toneIndigo
```

## Components

### Connections

- [Serial services](https://github.com/mushketer888/grblcontroller/tree/master/app/src/main/java/com/iljal/grblcontoller/service): `app/src/main/java/com/iljal/grblcontoller/service`
- [Bluetooth service](https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/service/GrblBluetoothSerialService.java): `app/src/main/java/com/iljal/grblcontoller/service/GrblBluetoothSerialService.java`
- [USB service](https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/service/GrblUsbSerialService.java): `app/src/main/java/com/iljal/grblcontoller/service/GrblUsbSerialService.java`
- [TCP service](https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/service/GrblTcpSerialService.java): `app/src/main/java/com/iljal/grblcontoller/service/GrblTcpSerialService.java`

### Machine controls

- [Control panels](https://github.com/mushketer888/grblcontroller/tree/master/app/src/main/java/com/iljal/grblcontoller/ui): `app/src/main/java/com/iljal/grblcontoller/ui`
- [Jogging](https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/ui/JoggingTabFragment.java): `app/src/main/java/com/iljal/grblcontoller/ui/JoggingTabFragment.java`

### G-code streaming

- [File streamer](https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/service/FileStreamerIntentService.java): `app/src/main/java/com/iljal/grblcontoller/service/FileStreamerIntentService.java`
- [G-code commands](https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/model/GcodeCommand.java): `app/src/main/java/com/iljal/grblcontoller/model/GcodeCommand.java`

### GRBL protocol and state

- [Serial handlers](https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/listeners/SerialCommunicationHandler.java): `app/src/main/java/com/iljal/grblcontoller/listeners/SerialCommunicationHandler.java`
- [Bluetooth handler](https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/listeners/SerialBluetoothCommunicationHandler.java): `app/src/main/java/com/iljal/grblcontoller/listeners/SerialBluetoothCommunicationHandler.java`
- [Machine status](https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/listeners/MachineStatusListener.java): `app/src/main/java/com/iljal/grblcontoller/listeners/MachineStatusListener.java`
- [GRBL utilities](https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/util/GrblUtils.java): `app/src/main/java/com/iljal/grblcontoller/util/GrblUtils.java`
- [Event messages](https://github.com/mushketer888/grblcontroller/tree/master/app/src/main/java/com/iljal/grblcontoller/events): `app/src/main/java/com/iljal/grblcontoller/events`

### App interface and support

- [Main activity](https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/GrblActivity.java): `app/src/main/java/com/iljal/grblcontoller/GrblActivity.java`
- [Preferences](https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/helpers/EnhancedSharedPreferences.java): `app/src/main/java/com/iljal/grblcontoller/helpers/EnhancedSharedPreferences.java`
- [Notifications](https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/iljal/grblcontoller/helpers/NotificationHelper.java): `app/src/main/java/com/iljal/grblcontoller/helpers/NotificationHelper.java`
- [Icon rendering](https://github.com/mushketer888/grblcontroller/blob/master/app/src/main/java/com/joanzapata/iconify/Iconify.java): `app/src/main/java/com/joanzapata/iconify/Iconify.java`

### Other components

- **Operator**
- **GRBL machine**
- **G-code file**

## Connections

- Operator → Main activity: controls
- Main activity → Control panels: presents (evidence: `app/src/main/java/com/iljal/grblcontoller/GrblActivity.java`)
- Operator → Bluetooth service: connects via
- Operator → USB service: connects via
- Operator → TCP service: connects via
- Bluetooth service → Bluetooth handler: dispatches to (evidence: `app/src/main/java/com/iljal/grblcontoller/service/GrblBluetoothSerialService.java`)
- USB service → Serial handlers: dispatches to
- TCP service → Serial handlers: dispatches to
- GRBL machine → Serial services: exchanges serial data
- Serial services → Serial handlers: routes messages
- Serial handlers → GRBL utilities: parses with (evidence: `app/src/main/java/com/iljal/grblcontoller/listeners/SerialCommunicationHandler.java`)
- Serial handlers → Machine status: updates (evidence: `app/src/main/java/com/iljal/grblcontoller/listeners/SerialCommunicationHandler.java`)
- Serial handlers → Event messages: posts (evidence: `app/src/main/java/com/iljal/grblcontoller/listeners/SerialCommunicationHandler.java`)
- Operator → Jogging: jogs machine
- Jogging → GRBL machine: sends jog commands
- Operator → File streamer: starts file send
- G-code file → File streamer: provides G-code
- File streamer → G-code commands: creates commands (evidence: `app/src/main/java/com/iljal/grblcontoller/service/FileStreamerIntentService.java`)
- File streamer → Event messages: posts progress (evidence: `app/src/main/java/com/iljal/grblcontoller/service/FileStreamerIntentService.java`)
- Main activity → Preferences: reads settings (evidence: `app/src/main/java/com/iljal/grblcontoller/GrblActivity.java`)
- Main activity → Notifications: uses (evidence: `app/src/main/java/com/iljal/grblcontoller/GrblActivity.java`)
- File streamer → Notifications: notifies job state (evidence: `app/src/main/java/com/iljal/grblcontoller/service/FileStreamerIntentService.java`)
- Main activity → Icon rendering: renders icons (evidence: `app/src/main/java/com/iljal/grblcontoller/GrblActivity.java`)
- Bluetooth service → GRBL machine: sends commands
