# jmeyer1292/opw_kinematics architecture

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

- Interactive diagram: https://gitdiagram.com/jmeyer1292/opw_kinematics
- Repository: https://github.com/jmeyer1292/opw_kinematics

## Overview

OPW Kinematics is a header-only analytical inverse- and forward-kinematics library for six-axis industrial robots with parallel bases and spherical wrists. A caller supplies a target pose and robot parameters to the inverse-kinematics API, which returns up to eight joint solutions; the caller can check or harmonize those solutions and use forward kinematics to obtain a tool pose. Robot-specific parameter examples are provided. The implementation excerpts show the solver calculations, but not every public function body, so the graph focuses on documented API behavior and evidenced header relationships.

Main entry points: [`include/opw_kinematics/opw_kinematics.h`](https://github.com/jmeyer1292/opw_kinematics/blob/master/include/opw_kinematics/opw_kinematics.h) (Kinematics API), [`include/opw_kinematics/opw_parameters_examples.h`](https://github.com/jmeyer1292/opw_kinematics/blob/master/include/opw_kinematics/opw_parameters_examples.h) (Robot examples), [`include/opw_kinematics/opw_parameters.h`](https://github.com/jmeyer1292/opw_kinematics/blob/master/include/opw_kinematics/opw_parameters.h) (Robot parameters), [`include/opw_kinematics/opw_io.h`](https://github.com/jmeyer1292/opw_kinematics/blob/master/include/opw_kinematics/opw_io.h) (Parameter formatting)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_config["Robot configuration"]
  node_examples["Robot examples"]
  node_parameters["Robot parameters<br/>[opw_parameters.h]"]
  node_io["Parameter formatting<br/>[opw_io.h]"]
end

subgraph group_kinematics["Kinematics"]
  node_api["Kinematics API<br/>[opw_kinematics.h]"]
  node_solver["Analytical solver"]
end

subgraph group_solution["Solution utilities"]
  node_utilities["Solution utilities<br/>[opw_utilities.h]"]
end

node_caller(("Library caller"))

node_caller -->|"selects parameters"| node_examples
node_examples -->|"returns parameters"| node_parameters
node_caller -->|"requests kinematics"| node_api
node_api -->|"uses parameter type"| node_parameters
node_api -->|"includes implementation"| node_solver
node_caller -->|"checks solutions"| node_utilities
node_caller -->|"requests forward pose"| node_api
node_caller -.->|"formats parameters"| node_io

click node_examples "https://github.com/jmeyer1292/opw_kinematics/blob/master/include/opw_kinematics/opw_parameters_examples.h"
click node_parameters "https://github.com/jmeyer1292/opw_kinematics/blob/master/include/opw_kinematics/opw_parameters.h"
click node_api "https://github.com/jmeyer1292/opw_kinematics/blob/master/include/opw_kinematics/opw_kinematics.h"
click node_solver "https://github.com/jmeyer1292/opw_kinematics/blob/master/include/opw_kinematics/opw_kinematics_impl.h"
click node_utilities "https://github.com/jmeyer1292/opw_kinematics/blob/master/include/opw_kinematics/opw_utilities.h"
click node_io "https://github.com/jmeyer1292/opw_kinematics/blob/master/include/opw_kinematics/opw_io.h"

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_examples,node_parameters,node_io toneBlue
class node_api,node_solver toneAmber
class node_utilities toneMint
class node_caller toneIndigo
```

## Components

### Robot configuration

- [Robot examples](https://github.com/jmeyer1292/opw_kinematics/blob/master/include/opw_kinematics/opw_parameters_examples.h): `include/opw_kinematics/opw_parameters_examples.h`
- [Robot parameters](https://github.com/jmeyer1292/opw_kinematics/blob/master/include/opw_kinematics/opw_parameters.h): `include/opw_kinematics/opw_parameters.h`
- [Parameter formatting](https://github.com/jmeyer1292/opw_kinematics/blob/master/include/opw_kinematics/opw_io.h): `include/opw_kinematics/opw_io.h`

### Kinematics

- [Kinematics API](https://github.com/jmeyer1292/opw_kinematics/blob/master/include/opw_kinematics/opw_kinematics.h): `include/opw_kinematics/opw_kinematics.h`
- [Analytical solver](https://github.com/jmeyer1292/opw_kinematics/blob/master/include/opw_kinematics/opw_kinematics_impl.h): `include/opw_kinematics/opw_kinematics_impl.h`

### Solution utilities

- [Solution utilities](https://github.com/jmeyer1292/opw_kinematics/blob/master/include/opw_kinematics/opw_utilities.h): `include/opw_kinematics/opw_utilities.h`

### Other components

- **Library caller**

## Connections

- Library caller → Robot examples: selects parameters (evidence: `Readme.md`)
- Robot examples → Robot parameters: returns parameters (evidence: `include/opw_kinematics/opw_parameters_examples.h`)
- Library caller → Kinematics API: requests kinematics (evidence: `Readme.md`)
- Kinematics API → Robot parameters: uses parameter type (evidence: `include/opw_kinematics/opw_kinematics.h`)
- Kinematics API → Analytical solver: includes implementation (evidence: `include/opw_kinematics/opw_kinematics.h`)
- Library caller → Solution utilities: checks solutions (evidence: `Readme.md`)
- Library caller → Kinematics API: requests forward pose (evidence: `Readme.md`)
- Library caller → Parameter formatting: formats parameters
