Praxis Software Structure Model

Module Boundaries: firmware

Explains firmware's package/module boundaries, number of files, number of symbols, and cross-module dependencies.

Package Diagrams candidate / high 0.1.0 · 34aad0bffa2f / main

How to read pictures

Technical complexity analysis

Relationship with business complexity

Governance suggestions

UML/Technical Diagram

flowchart LR
  package_node["firmware"]
  dependency_1["boards"]
  package_node --> dependency_1
  dependency_2["apps/esp32_lvgl"]
  package_node --> dependency_2
  dependency_3["apps/linux_uconsole_gtk"]
  package_node --> dependency_3

Coverage

Drill down on semantic elements in the diagram

  1. firmware package

    firmware is the central engineering boundary of the current Package Diagram, used to observe its own scale, dependency direction, and drill-down technical complexity.

    Technical roles
    Technical organization boundary: It aggregates files, symbols and cross-module relationships under firmware into a discussable engineering unit.
    Why it appears
    The local repository evidence observes enough files, symbols, or cross-module relationships under the firmware that it deserves to be promoted to a package-level entry in the software structure model.
    Relationship meaning
    The arrows pointing from firmware to other nodes in the figure indicate that the current boundary relies on external packages/modules; it is dependent on or called 68 times by other modules and depends on or called external modules 23 times, which is used to determine whether it is more like a stable reuse boundary or an orchestration/bridging boundary.
    Drill-down intention
    Drilling down into this node can continue to view the key components, structural collaboration slices, running links, deployment nodes and complexity hotspots within the firmware to understand how this engineering boundary carries functional changes.
    Business correlation
    This node is not the business story itself, but the Use Case falling to firmware in the organization/process model can refer to this as the technology bearing boundary. The current association is still CANDIDATE.
    Change impact
    Modifying the public entry, dependency direction or directory boundary of firmware may affect the verification path of component diagrams, sequence fragments, deployment configurations and related business stories that reference it.
    Confidence
    high

    Evidence

    • package scope: firmware
    • Module path: firmware
    • Number of files: 33
    • Number of symbols: 376
    • Depends on or called by other modules: 68
    • Depends on or calls external modules: 23
    • firmware/c6_companion/CMakeLists.txt
    • firmware/c6_companion/components/tm_ble/CMakeLists.txt

    Risk

    • If you only regard this node as a directory name, you will miss its responsibility as a stable project boundary.
    • If signs of dependence on external modules continue to increase, it may be a sign that the boundary is taking on too much orchestration or bridging responsibility.

    Problem

    • The current warehouse evidence has not yet explicitly traced the package to a Use Case; therefore, the business association remains a candidate.
  2. boards package

    Boards is the external technical boundary dependency currently observed by the firmware; it indicates that the current module is not implemented in isolation, but requires the help of another set of engineering capabilities to complete its responsibilities.

    Technical roles
    Cross-module technology dependency boundary: The current package requires another package/module to provide capabilities, contracts, configuration or operation support.
    Why it appears
    The local repository evidence observes a cross-module factual relationship between firmware and boards, so the dependency is put into the Package Diagram instead of just hidden in the code import/call.
    Relationship meaning
    firmware -> boards represents local repository evidence of observed cross-module relationships; it explains technical dependency direction but does not directly prove business processes.
    Drill-down intention
    Drill down into boards to view its own Package Diagram, and then continue to enter its components, structures, sequences or hotspots to determine whether the current dependency falls on the entry, runtime, tool registration, model adaptation or infrastructure boundary.
    Business correlation
    If firmware carries user-visible capabilities, the dependency on boards may be the operating mechanism, extension point, or governance constraint of the capability. This business association needs to be confirmed by the Use Case evidence of the organization/process model.
    Change impact
    Modifying the public interface, path or operation mode of boards may cause chain changes in the firmware call chain, packaging entry, agent workflow or UI behavior.
    Confidence
    high

    Evidence

    • dependency edge: firmware -> boards
    • boards/cardputerzero/board_facts.h
    • boards/cardputerzero/BOARD.md
    • boards/gat562_mesh_evb_pro.json
    • boards/gat562_mesh_evb_pro/board_facts.h
    • boards/gat562_mesh_evb_pro/BOARD.md
    • boards/gat562_mesh_evb_pro/include/boards/gat562_mesh_evb_pro/board_profile.h
    • boards/gat562_mesh_evb_pro/include/boards/gat562_mesh_evb_pro/gat562_board.h

    Risk

    • Cross-module dependencies can only prove technical relationships, but cannot directly prove business relationships.
    • If this dependency exists only for implementation convenience, future changes may cause boundary drift or implicit public toolboxes.

    Problem

    • Current evidence does not demonstrate that firmware dependency boards are directly related to a Use Case, runtime command, or configuration decision.
    • The current dependency direction is a candidate according to the warehouse fact record, and no architectural decision document has been found to prove that it is a stable boundary.
  3. apps/esp32_lvgl package

    apps/esp32_lvgl is the external technology boundary dependency currently observed by firmware; it indicates that the current module is not implemented in isolation, but requires the help of another set of engineering capabilities to complete its responsibilities.

    Technical roles
    Cross-module technology dependency boundary: The current package requires another package/module to provide capabilities, contracts, configuration or operation support.
    Why it appears
    Local repository evidence observed a cross-module factual relationship between firmware and apps/esp32_lvgl, so the dependency was put into the Package Diagram instead of just hidden in the code import/call.
    Relationship meaning
    firmware -> apps/esp32_lvgl indicates that local repository evidence observes cross-module relationships; it explains the technical dependency direction but does not directly prove the business process.
    Drill-down intention
    Drilling down into apps/esp32_lvgl, you can view its own Package Diagram, and then continue to enter its components, structures, sequences or hotspots to determine whether the current dependency falls on the entry, runtime, tool registration, model adaptation or infrastructure boundary.
    Business correlation
    If firmware hosts a user-visible capability, the dependency on apps/esp32_lvgl may be the operating mechanism, extension point, or governance constraint of that capability. This business association needs to be confirmed by the Use Case evidence of the organization/process model.
    Change impact
    Modifying the public interface, path or running mode of apps/esp32_lvgl may cause chain changes in the firmware's call chain, packaging entry, agent workflow or UI behavior.
    Confidence
    high

    Evidence

    • dependency edge: firmware -> apps/esp32_lvgl
    • apps/esp32_lvgl/APP_SHELL_MANIFEST.md
    • apps/esp32_lvgl/CMakeLists.txt
    • apps/esp32_lvgl/library.json
    • apps/esp32_lvgl/README.md
    • apps/esp32_lvgl/src/esp32_lvgl_app_shell.cpp
    • apps/esp32_lvgl/src/esp32_lvgl_app_shell.h
    • apps/esp32_lvgl/src/esp32_lvgl_arduino_app_registry.cpp

    Risk

    • Cross-module dependencies can only prove technical relationships, but cannot directly prove business relationships.
    • If this dependency exists only for implementation convenience, future changes may cause boundary drift or implicit public toolboxes.

    Problem

    • Current evidence does not demonstrate that the firmware dependency on apps/esp32_lvgl is directly related to a Use Case, runtime command, or configuration decision.
    • The current dependency direction is a candidate according to the warehouse fact record, and no architectural decision document has been found to prove that it is a stable boundary.
  4. apps/linux_uconsole_gtk package

    apps/linux_uconsole_gtk is the external technology boundary dependency currently observed by firmware; it indicates that the current module is not implemented in isolation, but requires the help of another set of engineering capabilities to complete its responsibilities.

    Technical roles
    Cross-module technology dependency boundary: The current package requires another package/module to provide capabilities, contracts, configuration or operation support.
    Why it appears
    Local repository evidence observed a cross-module factual relationship between firmware and apps/linux_uconsole_gtk, so the dependency was put into the Package Diagram instead of just hidden in the code import/call.
    Relationship meaning
    firmware -> apps/linux_uconsole_gtk represents local repository evidence of observed cross-module relationships; it explains the technical dependency direction but does not directly prove the business process.
    Drill-down intention
    Drilling down into apps/linux_uconsole_gtk, you can view its own Package Diagram, and then continue to enter its components, structures, sequences or hotspots to determine whether the current dependency falls on the entry, runtime, tool registration, model adaptation or infrastructure boundary.
    Business correlation
    firmware If hosting a user-visible capability, the dependency on apps/linux_uconsole_gtk may be the operating mechanism, extension point, or governance constraint of that capability. This business association needs to be confirmed by the Use Case evidence of the organization/process model.
    Change impact
    Modifying the public interface, path or running mode of apps/linux_uconsole_gtk may cause chain changes in the firmware call chain, packaging entry, agent workflow or UI behavior.
    Confidence
    high

    Evidence

    • dependency edge: firmware -> apps/linux_uconsole_gtk
    • apps/linux_uconsole_gtk/APP_SHELL_MANIFEST.md
    • apps/linux_uconsole_gtk/CMakeLists.txt
    • apps/linux_uconsole_gtk/packaging/trailmate-uconsole.desktop
    • apps/linux_uconsole_gtk/packaging/trailmate-uconsole.png
    • apps/linux_uconsole_gtk/README.md
    • apps/linux_uconsole_gtk/src/linux_uconsole_gtk_app_shell.cpp
    • apps/linux_uconsole_gtk/src/linux_uconsole_gtk_app_shell.h

    Risk

    • Cross-module dependencies can only prove technical relationships, but cannot directly prove business relationships.
    • If this dependency exists only for implementation convenience, future changes may cause boundary drift or implicit public toolboxes.

    Problem

    • Current evidence does not prove that the firmware dependency on apps/linux_uconsole_gtk is directly related to a Use Case, runtime command, or configuration decision.
    • The current dependency direction is a candidate according to the warehouse fact record, and no architectural decision document has been found to prove that it is a stable boundary.

Drill-down UML

Service object: main component · contains

Open the service object: main to confirm which specific object within the firmware is responsible for entry, orchestration, adaptation, contract or sharing responsibilities. Focus on checking the code anchor firmware/c6_companion/tests/test_tm_services_functional.cpp, and whether its referenced/calling relationship and external dependency/calling relationship mean that changes will spread.

function is located in firmware/c6_companion/tests/test_tm_services_functional.cpp#L97, coordinates multiple external objects or capabilities, and is used to explain technical collaboration and change impact areas.
Interface component: tm_services_record_error component · contains

Open the interface component: tm_services_record_error to confirm which specific object within the firmware is responsible for entry, orchestration, adaptation, contract or sharing responsibilities. Focus on checking the code anchor firmware/c6_companion/components/tm_services/tm_services.c, and whether its referenced/calling relationship and external dependency/calling relationship mean that changes will propagate.

function is located in firmware/c6_companion/components/tm_services/tm_services.c#L471. It is reused or relied on by multiple objects and is used to explain technical collaboration and change impact.

Evidence

Problem