Overview

The OctoMesh SDK is a collection of libraries that provide the necessary tools to

• interact with the API
• Create Data Transfer Objects for the API
• create adapters
• create nodes for ETL pipelines

Currently, the SDK is available for .NET and .NET Core. All libraries are available as NuGet packages.

Overview of Libraries

• Meshmakers.Octo.Sdk.Common - Contains the common interfaces and contracts for defining adapters and nodes.
• Meshmakers.Octo.Sdk.Common.Web - Is based on Meshmakers.Octo.Sdk.Common and contains the common interfaces and contracts for defining adapters and nodes for web applications.
• Meshmakers.Octo.Sdk.ServiceClient - Contains the service client for interacting with the OctoMesh API.
• Meshmakers.Octo.Sdk.SourceGeneration - Contains the source generator for creating DTOs for the OctoMesh API.
• Sdk.SimulationNodes - Contains the simulation nodes for the OctoMesh API.

Overview of Samples

• OctoMeshAdapter: A simple adapter that demonstrates how to create an adapter for OctoMesh. This adapter is a getting started implementation for the OctoMesh SDK and not production ready.
• PlugDemo: A simple adapter that demonstrates how to create an adapter for OctoMesh. This adapter is a reference implementation for the OctoMesh SDK.