Adapter Development
This document provides a comprehensive guide to developing adapters for OctoMesh, covering both Edge and Mesh adapters.
All documents that are targeted at developers
View all tagsThis document provides a comprehensive guide to developing adapters for OctoMesh, covering both Edge and Mesh adapters.
This document covers how to integrate with OctoMesh APIs, including authentication, GraphQL operations, and the service client SDK.
Blueprints are versioned, declarative bundles of Construction Kit (CK) models and runtime seed data that bootstrap a tenant — and continue to manage it across its lifetime. A blueprint can be installed, re-applied, updated, rolled back, uninstalled, and may depend on other blueprints. Versioned migration scripts transform tenant data when a blueprint's own version moves forward.
This document explains the fundamental data modeling concepts in OctoMesh, including Construction Kits, Runtime Entities, and Stream Data.
Welcome to OctoMesh, the premier platform for building robust and scalable services, client applications, and communication adapters. OctoMesh is designed to empower developers with a suite of APIs that streamline the development process, enabling the creation of high-performance, reliable, and interconnected systems. Our comprehensive API library, tailored for .NET, provides the tools and resources necessary to harness the full potential of OctoMesh.
This Developer Guide is the starting point for developers and system architects who are looking to integrate and build on the OctoMesh platform. OctoMesh is an advanced, scalable platform designed for the modern needs of the Industrial Internet of Things (IIoT), multi-tenant environments, and complex distributed systems.
OctoMesh helps you to bring structure into your data in your organization. It is a powerful tool that can help you to manage your data in a more efficient way.
When a Construction Kit (CK) model evolves to a new version, existing runtime entities in tenant databases may need to be updated to match the new schema. CK model migrations automate this process by defining versioned transformation scripts that update entity data (rename types, change attributes, etc.) during model import.
This document provides a comprehensive overview of the OctoMesh platform architecture, designed to help developers understand the system components, data flows, and integration patterns.
A Stream Data Archive is the unit of configuration and storage for time-series data in OctoMesh. Each archive is a versioned, typed, per-tenant CrateDB table that captures a curated set of attribute paths from a Construction Kit type. Archives have a strict lifecycle (Created → Activated → Disabled / Failed), an immutable schema once activated, and a three-tier activation gate (instance → tenant → archive) that determines whether the data plane is open.