Proxus Documentation

Welcome to the comprehensive guide for Proxus. Learn how to deploy edge gateways, configure the unified namespace, and extend the platform with custom C# logic.

bolt Quick Start

rocket_launch

Getting Started

Deploy your first Proxus instance and connect a device in minutes.

schema

Platform Architecture

Understand the Central-Edge architecture and key components.

rocket_launch

Getting Started

timer

5-Minute Quick Start

Deploy Proxus using Docker and connect your first simulated device.

dock_to_right

On-Premise Deployment with Docker

The official guide to installing and running the Proxus IIoT platform using Docker and Docker Compose.

memory

System Requirements

Hardware, software, and network prerequisites for Proxus Central Server and Edge Gateways.

account_tree

Architecture Overview

Understanding the Central Core, Edge Gateways, and the secure data pipeline.

schema

Core Concepts

schema

Unified Namespace (UNS)

How to model your industrial data using the ISA-95 standard for a Single Source of Truth.

high_quality

Data Quality & Metrics

Understanding the health, freshness, and quality of your industrial data streams in Proxus.

memory

Stateless Edge Architecture

Why Proxus Gateways are designed to be stateless, secure, and maintenance-free.

hub

Hub & Spoke Topology

Understand the centralized architecture of Proxus

hub

Embedded MQTT Broker

Configure and use the built-in MQTT broker on Proxus Edge Gateways for local device telemetry.

cable

Connecting Data

hub

Overview

Comprehensive list of all industrial protocols supported by Proxus.

Devices & Assets Overview

Understanding the relationship between Gateways, Profiles, and Devices in Proxus.

Managing Edge Gateways

How to deploy, authenticate, and monitor your Edge Gateways.

memory

Connect Siemens S7

Reference guide for Siemens S7 communication (S7-300, 400, 1200, 1500).

settings_ethernet

Connect Modbus TCP

Complete reference for the Modbus TCP driver: connection parameters, addressing syntax, and function codes.

Using Device Profiles

Create reusable templates for your industrial assets to standardize data ingestion.

security

Connect OPC UA

Complete reference for the OPC UA Client driver: connection parameters, security configuration, and node addressing.

Configuring a Device

A step-by-step guide to defining and activating your industrial assets in Proxus.

Monitoring Device Details

A comprehensive guide to the real-time monitoring dashboard for individual devices.

settings_input_component

Connect Allen-Bradley

Reference guide for Allen-Bradley PLC communication (ControlLogix, CompactLogix, SLC 500, MicroLogix).

Routing Data to Targets

How to configure where your device data is sent (Internal DB, Cloud, or Message Brokers).

developer_board

Connect Mitsubishi MELSEC

Reference guide for Mitsubishi MELSEC communication (Q, L, R, FX Series).

Tag Browser

Visually browse OPC UA, SNMP, and MTConnect address spaces to discover and import tags without manual entry.

radio_button_checked

Connect Omron

Reference guide for Omron PLC communication (FINS, CIP, HostLink).

router

Connect Beckhoff ADS

Reference guide for Beckhoff TwinCAT communication via ADS (Automation Device Specification).

precision_manufacturing

Connect MTConnect

Reference guide for MTConnect communication in CNC and machine-tool data collection.

router

Connect SNMP

Complete reference for the SNMP driver: connection parameters, SNMPv3 security, OID addressing, and tag browsing.

precision_manufacturing

Connect FANUC Robots

Reference guide for FANUC Robot Controller communication.

settings_applications

Connect FANUC CNC

Reference guide for FANUC CNC (Series 0i, 30i, etc.) communication via FOCAS.

smart_toy

Connect KUKA Robots

Reference guide for KUKA Robot communication via Ethernet.

robot_2

Connect Yaskawa Robots

Reference guide for Yaskawa Motoman Robot communication (YRC1000).

memory

Connect Keyence

Reference guide for Keyence KV and KV Nano series PLC communication.

developer_board

Connect Panasonic

Reference guide for Panasonic FP series PLC communication.

settings_input_hdmi

Connect Delta

Reference guide for Delta DVP, AH, and AS series PLC communication.

settings_ethernet

Connect Fatek

Reference guide for Fatek FBs and B1 series PLC communication.

bolt

Connect LS Electric (LSIS)

Reference guide for LS Electric XGT (XGK, XGB) series PLC communication.

power

Connect Fuji Electric

Reference guide for Fuji MICREX-SX and MICREX-F series PLC communication.

factory

Connect Yokogawa

Reference guide for Yokogawa FA-M3 series PLC communication.

account_tree

Automation Logic

notifications_active

Actions Overview

Configure alerts, notifications, and automated responses.

Rules Engine Overview

Powerful real-time processing using criteria expressions and anomaly detection.

notifications_active

Managing Alerts

Handling rule violations, acknowledgments, and resolution workflows.

build

Creating Rules Visually

How to build real-time automation logic using the visual rule builder without writing code.

code

Rule Expression Syntax

Complete reference for writing automation rules using the Criteria Language.

insights

Statistical Anomaly Detection

Detect hidden patterns and deviations using statistical algorithms without setting hard thresholds.

terminal

Edge Scripting

terminal

Writing User Functions

Extend platform logic by writing custom C# scripts that run directly on the Edge Gateway.

rocket_launch

Deploy & Debug Functions

Managing the lifecycle of your scripts: Build, Deploy, and Monitor logs.

monitoring

Visualization

database

Data Query Studio

Rapidly explore historical data, troubleshoot issues, and create permanent dashboards from ad-hoc queries.

dashboard

Creating Dashboards

Design drag-and-drop real-time dashboards using the integrated designer.

dynamic_feed

Integrations

notifications Notifications

mail

Email Notifications

Send alert emails via SMTP when rules trigger.

sms

SMS Notifications

Send SMS alerts via Twilio when rules trigger.

notifications

Push Notifications

Send push notifications via Firebase Cloud Messaging (FCM).

chat

WhatsApp Notifications

Send WhatsApp messages via Twilio when rules trigger.

tag

Slack Notifications

Send alerts to Slack channels via Incoming Webhooks.

chat_bubble

Discord Notifications

Send alerts to Discord channels via Webhooks.

send

Telegram Notifications

Send alerts to Telegram chats via Bot API.

chat

LINE Notifications

Send alerts via LINE Messaging API.

groups

Microsoft Teams Notifications

Send alerts to Teams channels via Incoming Webhooks.

forum

Facebook Messenger Notifications

Send alerts via Facebook Messenger Graph API.

output Outbound Connectors

analytics

Export to Splunk

Enterprise data platform integration with HEC forwarding, SSL support, and acknowledgment.

http

Export to HTTP API

Flexible HTTP export with authentication, JSON payload, and configurable endpoints.

table_chart

Export to ClickHouse

High-performance export to ClickHouse using Async Inserts, LZ4 compression, and local buffering.

database

PostgreSQL

Send telemetry data to PostgreSQL databases.

publish

Export to MQTT

High-performance MQTT export with QoS support, TLS encryption, and in-memory reactive buffering.

cloud_queue

Export to AWS IoT Core

Secure MQTT export to AWS IoT Core with X.509 certificate authentication.

analytics

Azure Data Lake Storage Gen2

High-performance telemetry export to Azure Data Lake Storage Gen2 with Parquet, JSON, and CSV support.

database

MySQL

Send telemetry data to MySQL databases.

rss_feed

Export to Apache Kafka

High-throughput Kafka export with partitioning, replication, and resilient delivery.

cloud_queue

Export to Sparkplug B

Industrial IoT messaging using Eclipse Sparkplug B specification with device lifecycle management.

cloud_queue

Export to Azure IoT Hub

Secure device telemetry export to Azure IoT Hub using MQTT over TLS.

database

Microsoft SQL Server

Send telemetry data to SQL Server databases.

rss_feed

Export to RabbitMQ

Reliable message queuing with AMQP protocol, exchanges, and routing keys.

database

Oracle Database

Send telemetry data to Oracle databases.

database

SQLite

Send telemetry data to local SQLite databases.

database

Firebird

Send telemetry data to Firebird databases.

database

IBM DB2

Send telemetry data to IBM DB2 databases.

dns

Export to InfluxDB

Time-series database export with line protocol, precision, and organization support.

dns

Export to Redis

High-performance key-value store with multiple data structures and pub/sub support.

dns

Export to TDengine

High-performance export to TDengine using WebSocket, auto-creation of Super Tables, and efficient batching.

category Other

notifications

Notifications Overview

Real-time alerts and messaging integrations

hub

Outbound Connectors Overview

Export telemetry to databases, messaging systems, cloud platforms, and HTTP endpoints.

hub

UNS Explorer

explore

Overview & Navigation

Navigate and monitor your real-time Unified Namespace hierarchy.

hub

Designing Topic Structures

Best practices for architecting your Unified Namespace topics using ISA-95.

admin_panel_settings

Administration

security

Security & Access Control

Comprehensive guide to User Management, Roles, and the advanced Permission System.

history_edu

System Audit Trail

Track 'Who did What and When' across the entire platform for compliance.

key

Authentication Providers

Configure Local Database, Active Directory, and Azure AD authentication for Proxus.

palette

White Labeling

Customize the platform's branding, including logos, colors, and login screens.

settings

Configuration File Reference

Complete reference for 'Proxus-config.toml' keys and their Docker Environment Variable overrides.

terminal

System Logs

Monitor technical system events, errors, and debug information for troubleshooting.

lock

UNS Topic Permissions

Control access to UNS Explorer nodes using path-based role permissions.

settings

Config Editor

Edit Proxus configuration from the UI safely, understand apply/restart behavior, and roll back quickly.

auto_delete

Data Retention

Configuring how long telemetry and logs are stored in Proxus.

lock

TLS Certificates

Configure HTTPS certificates for the Management Console and core services.

integration_instructions

Developer API

api

REST API Reference

Access and manage Proxus IIoT platform resources using the REST API.

analytics

Example: Basic Processing

Complete class demonstrating subscription, caching, and LINQ analytics.

library_books

FunctionBase SDK Reference

In-depth guide to the C# SDK internals: Lifecycle state machine, Circuit Breaker patterns, and Data Flow pipeline.

smart_toy

AI Agent Integration (MCP Server)

Connect AI assistants like OpenAI Codex, Claude, Cursor, and custom agents to Proxus IIoT Platform via Model Context Protocol.

hub

Example: MQTT Bridge

How to act as an MQTT Client to bridge data to external brokers (AWS/HiveMQ).

schedule

Example: Scheduled Tasks

Execute logic at precise time intervals using the Wall-Clock aligned scheduler.

data_object

Example: Hex Parsing

Parsing packed binary/hexadecimal payloads from legacy PLCs.

folder

General

settings

Platform Administration Overview

Configure system security, data retention, and platform branding.

api

Developer API & SDK Overview

Build custom integrations and extend the platform using the REST API and .NET SDK.

cable

Connecting Your Data Overview

The core architecture for industrial data acquisition in Proxus.

hub

Integrations Overview

Bridge your industrial data to cloud, databases, and messaging systems.

terminal

Edge Scripting Overview

Extend platform behavior with custom C# code and managed user functions.

psychology

Core Concepts Overview

Understand the foundational principles of the Proxus IIoT platform.

build

Troubleshooting Overview

Common issues and solutions for Proxus platform.

bar_chart

Visualization Overview

Visualize your industrial data with real-time dashboards and advanced analytical tools.

info

Introduction to Proxus

The Industrial IoT platform that transforms operational data into a Unified Namespace.

smart_toy

Overview

Process real-time event streams and automate industrial workflows at the edge.

dataset

User Interface Overview

Master the standard capabilities of the Proxus Management Console: grids, filtering, and reporting.

folder

Troubleshooting

router

Gateway Issues

Troubleshoot Edge Gateway connection and communication problems.

swap_vert

Data Flow Problems

Diagnose and fix issues with data not appearing or being delayed.

toggle_on

Rules & Automation

Fix issues with rules not triggering or actions failing.

dashboard

Dashboard Issues

Resolve widget display, binding, and performance problems.

settings_ethernet

Protocol & Address Issues

Solve common problems with protocol addresses, data types, and byte ordering.