Documentation

Welcome. Adsify is a .NET 10 REST API that wraps Beckhoff’s TwinCAT ADS protocol, so you can get at PLC data, diagnostics and alarms over plain authenticated HTTP.

Who is this for?

  • AI agents performing machine diagnostics via HTTP

  • Remote HMI applications that need PLC data over the network

  • Diagnostic tools that require authenticated, scoped access to PLCs

Key Concepts

  • PLC Targets: configured TwinCAT runtimes identified by aliases (e.g., Line1, TestRig)

  • Feature Slices: independently toggleable API feature groups (Variables, Symbols, DeviceInfo, Lifecycle, Notifications, Files, EtherCatDiagnostics, EtherCatCoe, Mcp, Alarms, TypeMetadata, Rpc)

  • Hybrid Authorization: RBAC roles intersected with OAuth2 scopes determine effective permissions

  • Embedded ADS Router: cross-platform ADS routing without a local TwinCAT installation

Getting Started

Install, configure, and run Adsify

API Reference

All endpoints with examples

Authentication

OIDC, JWT, roles, scopes

Architecture

Vertical slices, ADS router, error handling

Traceability

Features, requirements and endpoints as sphinx-needs