# lord-microstrain/mip_sdk architecture

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

- Interactive diagram: https://gitdiagram.com/lord-microstrain/mip_sdk
- Repository: https://github.com/lord-microstrain/mip_sdk

## Overview

##### Project type and purpose
- This is a cross‐platform SDK library (“MIP SDK”) for interacting with MicroStrain MIP devices.
- It provides both a minimal C API (suitable for bare‐metal) and a more convenient C++ API.
- It also bundles example applications, documentation, tests, and build infrastructure.

##### File structure
- Top-level directories:
- .devcontainer        — Docker/dev‐container build definitions
- cmake                — Custom CMake macros/modules
- docs                 — SDK documentation in Markdown + CSS
- examples             — Sample applications using the SDK
- scripts              — release automation
- src                  — Source code, split into C (src/c) and C++ (src/cpp)
- test                 — Unit and performance tests for C and C++ APIs
- Key sub-components in src:
- microstrain/common     — basic utilities (logging, time, platform)
- connections            — adapters for serial, TCP, recording
- mip                    — packet creation/parsing, command queue, descriptors, serialization
- extras/metadata        — optional higher‐level utilities, metadata support (C++ only)

##### README for additional insights
- The README describes:
- Two API layers: C and a thin C++ wrapper
- Two transport layers: serial port and TCP client
- Build configuration driven by CMake options (enable/disable logging, C++ API, extras, serial, TCP, tests, examples, docs)
- Example use cases (getting device info, streaming IMU data, device‐specific demos)

1. User Application (examples, 3rd-party apps)
2. SDK API Layer
- C API (mip::C namespace)
- C++ API (mip::… classes)
3. Core SDK Modules
- Common utilities (logging, timestamping, error codes)
- Command Queue & Dispatch
- Packet Builder & Parser
- Serialization / Deserialization
- Descriptor Definitions (commands_xxx, data_xxx)
- Optional Metadata Module (C++20)
4. Transport Layer
- Serial Connection adapter
- TCP Connection adapter
- Recording Connection (for offline file parsing)
5. External Systems
- Physical MIP Device (via USB/Serial or TCP server)
- File system (for recorded playback, examples)
- User App → [calls] → C++ API → [forwards] → C API (if used) → Core Modules → Transport
- Core Modules → Descriptor Definitions → Serialization → Transport
- Transport → [receives raw bytes] → Parser → Core Modules → returns structured data back up to API → User App
c. Architectural patterns / principles:
- Layered architecture (API → core logic → transport)
- Adapter pattern for connection types (serial, TCP, recording)
- Facade pattern: C++ API facade over C API and core modules
- Metadata as optional plug-in to reduce codegen and drive compile‐time reflection
d. Relevant technologies / frameworks:
- CMake (build orchestration, FindMip.cmake)
- Docker/.devcontainer (development environments)
- Doxygen (optional doc generation)
- Native C11 and C++14/20

##### Essential detail checklist
- Major components and sub‐modules (common, connections, mip definitions, extras, metadata).
- Both C and C++ API layers and how they relate.
- Transport adapters and the external device/file playback.
- Build/configuration influences (CMake options, devcontainer).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User Applications
    subgraph "User Applications"
        Examples["examples/"]:::external
    end

    %% API Layer
    subgraph "API Layer"
        CppAPI["C++ API\nsrc/cpp/microstrain/microstrain_all.hpp\nmip_interface.hpp/.cpp"]:::api
        C_API["C API\nsrc/c/microstrain/microstrain_all.h\nmip_interface.h/.c"]:::api
    end

    %% Core SDK Modules
    subgraph "Core SDK Modules"
        Common_C["Common Utilities (C)\nsrc/c/microstrain/common/"]:::core
        Common_CPP["Common Utilities (C++)\nsrc/cpp/microstrain/common/"]:::core
        Serialization_C["Serialization Core (C)\nsrc/c/microstrain/common/serialization.c/.h\nsrc/c/mip/mip_serialization.c/.h"]:::core
        Serialization_CPP["Serialization Core (C++)\nsrc/cpp/microstrain/common/serialization.hpp\nserializer.hpp"]:::core
        Definitions_C["Descriptor Definitions (C)\nsrc/c/mip/definitions/"]:::core
        Definitions_CPP["Descriptor Definitions (C++)\nsrc/cpp/mip/definitions/"]:::core
        Cmd_C["Command Queue & Dispatch (C)\nsrc/c/mip/mip_cmdqueue.c/.h\nmip_dispatch.c/.h"]:::core
        Cmd_CPP["Command Queue & Dispatch (C++)\nsrc/cpp/mip/mip_cmdqueue.hpp\nmip_dispatch.hpp"]:::core
        Packet_C["Packet Builder & Parser (C)\nsrc/c/mip/mip_packet.c/.h\nmip_parser.c/.h"]:::core
        Packet_CPP["Packet Builder & Parser (C++)\nsrc/cpp/mip/mip_packet.hpp\nmip_parser.hpp"]:::core
        Metadata["Optional Metadata Module (C++)\nsrc/cpp/mip/metadata/"]:::core
    end

    %% Transport Layer
    subgraph "Transport Layer"
        Serial_C["Serial Adapter (C)\nsrc/c/microstrain/connections/serial/serial_port.c/.h"]:::transport
        Serial_CPP["Serial Adapter (C++)\nsrc/cpp/microstrain/connections/serial/serial_connection.cpp/.h"]:::transport
        TCP_C["TCP Adapter (C)\nsrc/c/microstrain/connections/tcp/tcp_socket.c/.h"]:::transport
        TCP_CPP["TCP Adapter (C++)\nsrc/cpp/microstrain/connections/tcp/tcp_connection.cpp/.h"]:::transport
        Recording["Recording Adapter (C++)\nsrc/cpp/microstrain/connections/recording/recording_connection.cpp/.h"]:::transport
    end

    %% External Systems
    subgraph "External Systems"
        Device["Physical MIP Device"]:::external
        FileSys["File System (recording)"]:::external
    end

    %% Build & Docs
    CMake["Build Infrastructure\ncmake/, CMakeLists.txt"]:::external
    Docs["Documentation\ndocs/"]:::external
    Scripts["Release Scripts\nscripts/release.sh"]:::external

    %% Data Flow
    Examples -->|"uses"| CppAPI
    CppAPI -->|"facade over"| C_API
    C_API -->|"calls"| Common_C
    C_API --> Common_CPP
    C_API --> Definitions_C
    C_API --> Serialization_C
    C_API --> Cmd_C
    C_API --> Packet_C
    CppAPI --> Common_CPP
    CppAPI --> Definitions_CPP
    CppAPI --> Serialization_CPP
    CppAPI --> Cmd_CPP
    CppAPI --> Packet_CPP
    CppAPI --> Metadata

    Common_C -->|"utility"| Serialization_C
    Definitions_C --> Serialization_C
    Serialization_C --> Serial_C
    Serialization_C --> TCP_C
    Serialization_C --> Recording

    Common_CPP --> Serialization_CPP
    Definitions_CPP --> Serialization_CPP
    Serialization_CPP --> Serial_CPP
    Serialization_CPP --> TCP_CPP
    Serialization_CPP --> Recording

    Serial_C -->|"raw bytes"| Device
    TCP_C --> Device
    Recording --> FileSys

    %% Configuration Dependencies
    CMake -.-> CppAPI
    CMake -.-> C_API
    CMake -.-> Common_C
    CMake -.-> Common_CPP
    CMake -.-> Serial_C
    CMake -.-> TCP_C
    CMake -.-> Metadata
    CMake -.-> Examples
    Docs -.-> Examples
    Docs -.-> CppAPI

    %% Click Events
    click Examples "https://github.com/lord-microstrain/mip_sdk/tree/master/examples/"
    click C_API "https://github.com/lord-microstrain/mip_sdk/blob/master/src/c/microstrain/microstrain_all.h"
    click C_API "https://github.com/lord-microstrain/mip_sdk/blob/master/src/c/mip/mip_interface.h"
    click C_API "https://github.com/lord-microstrain/mip_sdk/blob/master/src/c/mip/mip_interface.c"
    click CppAPI "https://github.com/lord-microstrain/mip_sdk/blob/master/src/cpp/microstrain/microstrain_all.hpp"
    click CppAPI "https://github.com/lord-microstrain/mip_sdk/blob/master/src/cpp/mip/mip_interface.hpp"
    click CppAPI "https://github.com/lord-microstrain/mip_sdk/blob/master/src/cpp/mip/mip_interface.cpp"
    click Common_C "https://github.com/lord-microstrain/mip_sdk/tree/master/src/c/microstrain/common/"
    click Common_CPP "https://github.com/lord-microstrain/mip_sdk/tree/master/src/cpp/microstrain/common/"
    click Serialization_C "https://github.com/lord-microstrain/mip_sdk/blob/master/src/c/microstrain/common/serialization.c"
    click Serialization_C "https://github.com/lord-microstrain/mip_sdk/blob/master/src/c/mip/mip_serialization.c"
    click Serialization_CPP "https://github.com/lord-microstrain/mip_sdk/blob/master/src/cpp/microstrain/common/serialization.hpp"
    click Serialization_CPP "https://github.com/lord-microstrain/mip_sdk/blob/master/src/cpp/microstrain/common/serialization/serializer.hpp"
    click Definitions_C "https://github.com/lord-microstrain/mip_sdk/tree/master/src/c/mip/definitions/"
    click Definitions_CPP "https://github.com/lord-microstrain/mip_sdk/tree/master/src/cpp/mip/definitions/"
    click Cmd_C "https://github.com/lord-microstrain/mip_sdk/blob/master/src/c/mip/mip_cmdqueue.c"
    click Cmd_CPP "https://github.com/lord-microstrain/mip_sdk/blob/master/src/cpp/mip/mip_cmdqueue.hpp"
    click Packet_C "https://github.com/lord-microstrain/mip_sdk/blob/master/src/c/mip/mip_packet.c"
    click Packet_CPP "https://github.com/lord-microstrain/mip_sdk/blob/master/src/cpp/mip/mip_packet.hpp"
    click Metadata "https://github.com/lord-microstrain/mip_sdk/tree/master/src/cpp/mip/metadata/"
    click Serial_C "https://github.com/lord-microstrain/mip_sdk/blob/master/src/c/microstrain/connections/serial/serial_port.c"
    click Serial_CPP "https://github.com/lord-microstrain/mip_sdk/blob/master/src/cpp/microstrain/connections/serial/serial_connection.cpp"
    click TCP_C "https://github.com/lord-microstrain/mip_sdk/blob/master/src/c/microstrain/connections/tcp/tcp_socket.c"
    click TCP_CPP "https://github.com/lord-microstrain/mip_sdk/blob/master/src/cpp/microstrain/connections/tcp/tcp_connection.cpp"
    click Recording "https://github.com/lord-microstrain/mip_sdk/blob/master/src/cpp/microstrain/connections/recording/recording_connection.cpp"
    click CMake "https://github.com/lord-microstrain/mip_sdk/tree/master/cmake/"
    click Docs "https://github.com/lord-microstrain/mip_sdk/tree/master/docs/"
    click Scripts "https://github.com/lord-microstrain/mip_sdk/blob/master/scripts/release.sh"

    %% Styles
    classDef api fill:#ADD8E6,stroke:#000
    classDef core fill:#98FB98,stroke:#000
    classDef transport fill:#FFA500,stroke:#000
    classDef external fill:#D3D3D3,stroke:#000
```
