How wandelbotsgmbh/wandelbots-nova works
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.