# openwrt-xiaomi/xmir-patcher architecture

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

- Interactive diagram: https://gitdiagram.com/openwrt-xiaomi/xmir-patcher
- Repository: https://github.com/openwrt-xiaomi/xmir-patcher

## Overview

XMiR-Patcher is a Xiaomi-router firmware patcher. The documented entry is running the application; the source index shows firmware installation as a central operation, supported by device access, device information, firmware-image parsing, and boot activation. The tree also exposes feature unlocking, SSH and language installation, backups, and reboot operations. Those branches are included, but their wiring is not asserted where source evidence was unavailable. The parser internals are represented where the index or excerpts support relationships; unsampled source was not inspected.

Main entry points: [`install_fw.py`](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/install_fw.py) (Firmware install), [`gateway.py`](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/gateway.py) (Router gateway), [`activate_boot.py`](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/activate_boot.py) (Boot activation), [`xmir_base/fdt/__init__.py`](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/fdt/__init__.py) (Device tree parser)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_device["Router access"]
  node_gateway["Router gateway<br/>[gateway.py]"]
  node_device_info["Device information<br/>[read_info.py]"]
  node_connection["Connection methods<br/>[connect.py]"]
  node_telnet["Telnet client<br/>[telnetlib.py]"]
  node_environment["Router environment<br/>[envbuffer.py]"]
end

subgraph group_operations["Router operations"]
  node_firmware["Firmware install<br/>[install_fw.py]"]
  node_activation["Boot activation<br/>[activate_boot.py]"]
  node_unlock["Feature unlock<br/>[unlock_features.py]"]
  node_ssh_install["SSH install<br/>[install_ssh.py]"]
  node_language["Language install<br/>[install_lang.py]"]
  node_backup["Backup creation<br/>[create_backup.py]"]
  node_reboot["Reboot<br/>[reboot.py]"]
  node_model["Router models<br/>[xqmodel.py]"]
end

subgraph group_image["Firmware parsing"]
  node_image_reader["Image reader<br/>[xqimage.py]"]
  node_ubi_io["UBI image I/O<br/>[ubi_io.py]"]
  node_ubi["UBI volumes<br/>[__init__.py]"]
  node_block_sort["UBI block sorting<br/>[sort.py]"]
  node_ubi_defines["UBI structures<br/>[defines.py]"]
  node_ubifs_nodes["UBIFS nodes<br/>[nodes.py]"]
  node_ubifs_defines["UBIFS structures<br/>[defines.py]"]
  node_ubifs_misc["UBIFS utilities<br/>[misc.py]"]
  node_ubifs_display["UBIFS display<br/>[display.py]"]
  node_ubifs_walk["UBIFS traversal<br/>[walk.py]"]
  node_ubifs_output["UBIFS output<br/>[output.py]"]
end

subgraph group_formats["Image formats"]
  node_fdt["Device tree parser<br/>[__init__.py]"]
  node_fdt_header["FDT headers<br/>[header.py]"]
  node_fdt_items["FDT items<br/>[items.py]"]
  node_fdt_misc["FDT utilities<br/>[misc.py]"]
end

node_user(("Operator"))

node_user -->|"runs patcher"| node_firmware
node_firmware -->|"uses access"| node_gateway
node_firmware -->|"reads device"| node_device_info
node_firmware -->|"activates boot"| node_activation
node_firmware -->|"checks model"| node_model
node_firmware -->|"parses tree"| node_fdt
node_firmware -->|"parses UBI"| node_ubi
node_activation -->|"uses access"| node_gateway
node_activation -->|"reads device"| node_device_info
node_activation -->|"uses buffer"| node_environment
node_unlock -->|"uses access"| node_gateway
node_gateway -->|"uses client"| node_telnet
node_image_reader -->|"uses buffer"| node_environment
node_image_reader -->|"checks model"| node_model
node_ubi -->|"sorts blocks"| node_block_sort
node_ubi -->|"uses definitions"| node_ubi_defines
node_ubi_io -->|"sorts blocks"| node_block_sort
node_fdt -->|"uses headers"| node_fdt_header
node_fdt -->|"uses items"| node_fdt_items
node_fdt -->|"uses utilities"| node_fdt_misc
node_ubifs_nodes -->|"uses definitions"| node_ubifs_defines
node_ubifs_nodes -->|"uses utilities"| node_ubifs_misc
node_ubifs_nodes -->|"formats display"| node_ubifs_display
node_ubifs_walk -->|"parses nodes"| node_ubifs_nodes
node_ubifs_walk -->|"uses definitions"| node_ubifs_defines
node_ubifs_output -->|"traverses"| node_ubifs_walk
node_ubifs_output -->|"uses utilities"| node_ubifs_misc
node_connection -.->|"connects through"| node_gateway
node_firmware -.->|"uses image reader"| node_image_reader
node_firmware -.->|"reads image"| node_ubi_io
node_user -.->|"requests operation"| node_unlock
node_user -.->|"requests operation"| node_ssh_install
node_user -.->|"requests operation"| node_language
node_user -.->|"requests operation"| node_backup
node_user -.->|"requests operation"| node_reboot

click node_firmware "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/install_fw.py"
click node_gateway "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/gateway.py"
click node_device_info "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/read_info.py"
click node_connection "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/connect.py"
click node_telnet "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/telnetlib/telnetlib.py"
click node_activation "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/activate_boot.py"
click node_unlock "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/unlock_features.py"
click node_ssh_install "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/install_ssh.py"
click node_language "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/install_lang.py"
click node_backup "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/create_backup.py"
click node_reboot "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/reboot.py"
click node_model "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xqmodel.py"
click node_image_reader "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xqimage.py"
click node_ubi_io "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/ubireader/ubi_io.py"
click node_ubi "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/ubireader/ubi/__init__.py"
click node_block_sort "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/ubireader/ubi/block/sort.py"
click node_ubi_defines "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/ubireader/ubi/defines.py"
click node_fdt "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/fdt/__init__.py"
click node_fdt_header "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/fdt/header.py"
click node_fdt_items "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/fdt/items.py"
click node_fdt_misc "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/fdt/misc.py"
click node_ubifs_nodes "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/ubireader/ubifs/nodes.py"
click node_ubifs_defines "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/ubireader/ubifs/defines.py"
click node_ubifs_misc "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/ubireader/ubifs/misc.py"
click node_ubifs_display "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/ubireader/ubifs/display.py"
click node_ubifs_walk "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/ubireader/ubifs/walk.py"
click node_ubifs_output "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/ubireader/ubifs/output.py"
click node_environment "https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/envbuffer.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_gateway,node_device_info,node_connection,node_telnet,node_environment toneBlue
class node_firmware,node_activation,node_unlock,node_ssh_install,node_language,node_backup,node_reboot,node_model toneAmber
class node_image_reader,node_ubi_io,node_ubi,node_block_sort,node_ubi_defines,node_ubifs_nodes,node_ubifs_defines,node_ubifs_misc,node_ubifs_display,node_ubifs_walk,node_ubifs_output toneMint
class node_fdt,node_fdt_header,node_fdt_items,node_fdt_misc toneRose
class node_user toneIndigo
```

## Components

### Router access

- [Router gateway](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/gateway.py): `gateway.py`
- [Device information](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/read_info.py): `read_info.py`
- [Connection methods](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/connect.py): `connect.py`
- [Telnet client](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/telnetlib/telnetlib.py): `xmir_base/telnetlib/telnetlib.py`
- [Router environment](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/envbuffer.py): `envbuffer.py`

### Router operations

- [Firmware install](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/install_fw.py): `install_fw.py`
- [Boot activation](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/activate_boot.py): `activate_boot.py`
- [Feature unlock](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/unlock_features.py): `unlock_features.py`
- [SSH install](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/install_ssh.py): `install_ssh.py`
- [Language install](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/install_lang.py): `install_lang.py`
- [Backup creation](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/create_backup.py): `create_backup.py`
- [Reboot](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/reboot.py): `reboot.py`
- [Router models](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xqmodel.py): `xqmodel.py`

### Firmware parsing

- [Image reader](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xqimage.py): `xqimage.py`
- [UBI image I/O](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/ubireader/ubi_io.py): `xmir_base/ubireader/ubi_io.py`
- [UBI volumes](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/ubireader/ubi/__init__.py): `xmir_base/ubireader/ubi/__init__.py`
- [UBI block sorting](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/ubireader/ubi/block/sort.py): `xmir_base/ubireader/ubi/block/sort.py`
- [UBI structures](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/ubireader/ubi/defines.py): `xmir_base/ubireader/ubi/defines.py`
- [UBIFS nodes](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/ubireader/ubifs/nodes.py): `xmir_base/ubireader/ubifs/nodes.py`
- [UBIFS structures](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/ubireader/ubifs/defines.py): `xmir_base/ubireader/ubifs/defines.py`
- [UBIFS utilities](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/ubireader/ubifs/misc.py): `xmir_base/ubireader/ubifs/misc.py`
- [UBIFS display](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/ubireader/ubifs/display.py): `xmir_base/ubireader/ubifs/display.py`
- [UBIFS traversal](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/ubireader/ubifs/walk.py): `xmir_base/ubireader/ubifs/walk.py`
- [UBIFS output](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/ubireader/ubifs/output.py): `xmir_base/ubireader/ubifs/output.py`

### Image formats

- [Device tree parser](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/fdt/__init__.py): `xmir_base/fdt/__init__.py`
- [FDT headers](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/fdt/header.py): `xmir_base/fdt/header.py`
- [FDT items](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/fdt/items.py): `xmir_base/fdt/items.py`
- [FDT utilities](https://github.com/openwrt-xiaomi/xmir-patcher/blob/main/xmir_base/fdt/misc.py): `xmir_base/fdt/misc.py`

### Other components

- **Operator**

## Connections

- Operator → Firmware install: runs patcher (evidence: `README.md`)
- Firmware install → Router gateway: uses access (evidence: `install_fw.py`)
- Firmware install → Device information: reads device (evidence: `install_fw.py`)
- Firmware install → Boot activation: activates boot (evidence: `install_fw.py`)
- Firmware install → Router models: checks model (evidence: `install_fw.py`)
- Firmware install → Device tree parser: parses tree (evidence: `install_fw.py`)
- Firmware install → UBI volumes: parses UBI (evidence: `install_fw.py`)
- Boot activation → Router gateway: uses access (evidence: `activate_boot.py`)
- Boot activation → Device information: reads device (evidence: `activate_boot.py`)
- Boot activation → Router environment: uses buffer (evidence: `activate_boot.py`)
- Feature unlock → Router gateway: uses access (evidence: `unlock_features.py`)
- Router gateway → Telnet client: uses client (evidence: `gateway.py`)
- Image reader → Router environment: uses buffer (evidence: `xqimage.py`)
- Image reader → Router models: checks model (evidence: `xqimage.py`)
- UBI volumes → UBI block sorting: sorts blocks (evidence: `xmir_base/ubireader/ubi/__init__.py`)
- UBI volumes → UBI structures: uses definitions (evidence: `xmir_base/ubireader/ubi/__init__.py`)
- UBI image I/O → UBI block sorting: sorts blocks (evidence: `xmir_base/ubireader/ubi_io.py`)
- Device tree parser → FDT headers: uses headers (evidence: `xmir_base/fdt/__init__.py`)
- Device tree parser → FDT items: uses items (evidence: `xmir_base/fdt/__init__.py`)
- Device tree parser → FDT utilities: uses utilities (evidence: `xmir_base/fdt/__init__.py`)
- UBIFS nodes → UBIFS structures: uses definitions (evidence: `xmir_base/ubireader/ubifs/nodes.py`)
- UBIFS nodes → UBIFS utilities: uses utilities (evidence: `xmir_base/ubireader/ubifs/nodes.py`)
- UBIFS nodes → UBIFS display: formats display (evidence: `xmir_base/ubireader/ubifs/nodes.py`)
- UBIFS traversal → UBIFS nodes: parses nodes (evidence: `xmir_base/ubireader/ubifs/walk.py`)
- UBIFS traversal → UBIFS structures: uses definitions (evidence: `xmir_base/ubireader/ubifs/walk.py`)
- UBIFS output → UBIFS traversal: traverses (evidence: `xmir_base/ubireader/ubifs/output.py`)
- UBIFS output → UBIFS utilities: uses utilities (evidence: `xmir_base/ubireader/ubifs/output.py`)
- Connection methods → Router gateway: connects through
- Firmware install → Image reader: uses image reader
- Firmware install → UBI image I/O: reads image (evidence: `install_fw.py`)
- Operator → Feature unlock: requests operation
- Operator → SSH install: requests operation
- Operator → Language install: requests operation
- Operator → Backup creation: requests operation
- Operator → Reboot: requests operation
