# wandelbotsgmbh/wandelbots-nova architecture

> Architecture diagram of the GitHub repository wandelbotsgmbh/wandelbots-nova, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-31). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/wandelbotsgmbh/wandelbots-nova
- Repository: https://github.com/wandelbotsgmbh/wandelbots-nova

## Overview

##### Main Components
- External NOVA Service: Represent the NOVA instance (robot operating system) that serves as the external API. Indicate that users must provide API credentials and connect to a running NOVA instance.
- API Client & Communication Layer: Include the auto-generated API client accessible via the “nova/api.py” module. This component handles REST/HTTP communication with the NOVA server.
- SDK Core Modules:
– Authentication: Identify the “nova/auth” module that is responsible for setting up authentication (whether via username/password or token-based), which should be clearly associated with the API Client.
– Types and Data Structures: Add a component for “nova/types” which defines data models (e.g., Pose, state, collision_scene) for the SDK.
- Extensions and Visualization: Represent the “nova_rerun_bridge” module as a separate component that integrates with visualization tools (rerun). This module wraps or extends core functionality with features like logging trajectories and rendering robot motion.
- Supporting Components:
– Developer Tools: Optionally note the CI/CD pipeline (using the .github workflows), tests, and scripts directory as ancillary components for building, testing, and deployment.

##### Relationships and Interactions
- That the “core” modules interact with both the “actions” and “types” components. For instance, the motion planning workflow flows from high-level actions (e.g., motion planning in “nova/actions”) that heavily rely on data defined in “nova/types.”
- Additionally, the authentication module works alongside the API client to ensure secure connectivity.

##### Architectural Patterns and Design Principles
- A clear separation of concerns: the SDK decouples different facets like authentication (nova/auth), actions (nova/actions), and core operations (nova/core).
- Modularity through distinct sub-packages. For example, extensions such as OPC UA integration (under “nova/extentions/opcua”) show that the architecture is designed for easy extension and customization.
- Use of asynchronous programming patterns (as evident in the examples using “async with” and “asyncio”), emphasizing non-blocking I/O for robust performance when interacting with the NOVA API.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Subgraph: External Services
    subgraph "External Services"
        A["External NOVA Service"]:::external
    end

    %% Subgraph: API Communication
    subgraph "API Communication"
        B["API Client"]:::communication
        C["Authentication"]:::communication
    end

    %% Subgraph: SDK Core Modules
    subgraph "SDK Core Modules"
        D["Core Motion Planning (nova/core)"]:::core
        E["Motion Actions (nova/actions)"]:::core
        F["Data Models (nova/types)"]:::core
    end

    %% Subgraph: Extensions & Visualization
    subgraph "Extensions & Visualization"
        G["Rerun Visualization Bridge (nova_rerun_bridge)"]:::extension
    end

    %% Subgraph: Usage Examples
    subgraph "Usage Examples"
        H["SDK Examples (examples)"]:::examples
        I["Visualization Examples (nova_rerun_bridge/examples)"]:::examples
    end

    %% Subgraph: Developer Tools & CI/CD
    subgraph "Developer Tools & CI/CD"
        K["CI/CD Pipelines (.github/workflows)"]:::devtools
        L["Tests (tests)"]:::devtools
        M["Scripts (scripts)"]:::devtools
    end

    %% Relationships and Data Flow
    %% Core Modules communicate with API Communication
    D -->|"uses"| B
    %% Authentication works with API Client
    C -->|"integrates"| B
    %% API Client sends requests to External NOVA Service
    B -->|"requests"| A
    %% Core Modules depend on Actions and Types
    D -->|"orchestrates"| E
    D -->|"manages"| F
    %% Motion Actions rely on Data Models
    E -->|"utilizes"| F
    %% Core sends trajectories to Visualization Bridge
    D -->|"sends_trajectory"| G
    %% Examples drive usage of Core Modules and Visualization
    H -->|"triggers_core_usage"| D
    I -->|"triggers_visualization"| G

    %% Styling Classes
    classDef external fill:#ffcccc,stroke:#d9534f,stroke-width:2px;
    classDef communication fill:#d0f0c0,stroke:#5cb85c,stroke-width:2px;
    classDef core fill:#cce5ff,stroke:#5bc0de,stroke-width:2px;
    classDef extension fill:#ffe6cc,stroke:#f0ad4e,stroke-width:2px;
    classDef examples fill:#fff2cc,stroke:#f7c08a,stroke-width:2px;
    classDef devtools fill:#e2e2e2,stroke:#999999,stroke-width:2px;

    %% Click Events
    click B "https://github.com/wandelbotsgmbh/wandelbots-nova/blob/main/nova/api.py"
    click C "https://github.com/wandelbotsgmbh/wandelbots-nova/tree/main/nova/auth"
    click D "https://github.com/wandelbotsgmbh/wandelbots-nova/tree/main/nova/core"
    click E "https://github.com/wandelbotsgmbh/wandelbots-nova/tree/main/nova/actions"
    click F "https://github.com/wandelbotsgmbh/wandelbots-nova/tree/main/nova/types"
    click G "https://github.com/wandelbotsgmbh/wandelbots-nova/tree/main/nova_rerun_bridge"
    click H "https://github.com/wandelbotsgmbh/wandelbots-nova/tree/main/examples"
    click I "https://github.com/wandelbotsgmbh/wandelbots-nova/tree/main/nova_rerun_bridge/examples"
    click K "https://github.com/wandelbotsgmbh/wandelbots-nova/tree/main/.github/workflows"
    click L "https://github.com/wandelbotsgmbh/wandelbots-nova/tree/main/tests"
    click M "https://github.com/wandelbotsgmbh/wandelbots-nova/tree/main/scripts"
```
