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.
Configuration surface for the MCP (Model Context Protocol) Services. Most settings are static for hosted clusters (set via Helm values at deploy time); this page documents what each one does so you can override sensibly during local development or when reviewing a Helm change.
This document explains the fundamental data modeling concepts in OctoMesh, including Construction Kits, Runtime Entities, and Stream Data.
The formula engine evaluates small numeric expressions wherever the platform accepts a
Several OctoMesh features let you enter a formula — a small numeric expression that
This page is the architectural foundation for stream data: the mental model and vocabulary you need before reading either the full Stream Data Archives reference or the Rollups & recompute deep-dive. It explains how the pieces fit together — the two-store split, the three archive types, how rows are stored, how an archive moves through its lifecycle, and what happens on the write and read paths — and then hands off to the reference and deep-dive pages for the exhaustive detail.
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.
Running the MCP (Model Context Protocol) Services from source against a local OctoMesh stack on your own machine.
This section is for developers working on the MCP (Model Context Protocol) Services itself — building from source, running it against a local OctoMesh stack, and understanding the configuration surface. For end-user documentation (registering the hosted endpoints with Claude Code, available tools, troubleshooting), see MCP Services in the Tech Guide.
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 page is the engineer-facing companion to Stream Data Archives. It explains how a RollupArchive keeps its derived aggregations correct as the underlying data changes — the detection criterion, the dirty-windows ledger, the dependency graph, the periodic orchestrator, and the optimistic atomic swap that keeps readers on a consistent snapshot throughout.
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.
Stream data is always stored in UTC. Many questions, however, are asked in civil (wall-clock) time for a specific place: "what were the values **yesterday**? this week? last month?" — meaning the local day / week / month boundaries of a chosen time zone, not a UTC day that is shifted against the local one.