ARDI Documentation

Creating an ARDI Historical Driver

optrix@undisclosed.example.com (optrix) — Mon, 21 Sep 2026 02:18:37 +0000

Creating an ARDI Historical Driver This tutorial will re-create the ARDI Historical Text driver as an example of how to create your own ARDI driver in Python. Many of the steps are very similar to those from our Creating an ARDI Live Driver tutorial - however the functions that we create are a little different.

Error Notifications - created

optrix@undisclosed.example.com (optrix) — Mon, 21 Sep 2026 02:02:48 +0000

Error Notifications Both the Historical and Event drivers have the statusmessage variable that can be used to indicate any issues when making a request. Simply set the variable to a value that describes the problem (ie. 'Access Denied') to give feedback to the user when a particular action could not be performed.

Python Driver Developer SDK

optrix@undisclosed.example.com (optrix) — Mon, 21 Sep 2026 01:59:45 +0000

Python Driver Developer SDK ARDI includes a library of files to assist in the rapid creation of ARDI drivers. Most drivers built by Optrix are deliberately left open and documented so they can be used as basis for 3rd parties to create their own drivers. They can also be copied and enhanced if your application needs very specific alterations.

ARDI Driver Guidelines

optrix@undisclosed.example.com (optrix) — Mon, 21 Sep 2026 01:41:51 +0000

ARDI Driver Guidelines ARDI historical drivers have a set of guidelines that every history driver is supposed to follow if at all possible. No Point Should Have Overlapping Timestamps History drivers should not produce two values for the exact same timestamp. If there is a transition in a discrete state (ie. a boolean value changing from 'false' to 'true'), these two points should be offset by a small amount of time (ie. 0.1 seconds).

Live Data Replication

optrix@undisclosed.example.com (optrix) — Wed, 16 Sep 2026 22:30:31 +0000

Live Data Replication ARDIs Live Data Replication functions let you push live data to other platforms as it arrives. It's useful for recording data to historians, or pushing data to distribution and messaging systems such as MQTT. Importantly, it applies ARDIs naming and structure to the incoming data, ensuring that the information is recorded consistently and is easy for users to find.

Creating Your Own Replicator

optrix@undisclosed.example.com (optrix) — Wed, 16 Sep 2026 22:30:04 +0000

Creating Your Own Replicator Replicator files can be found in your Python library directory, under /ardi/consolidator. Replicator modules are named 'dist_xxx', where 'xxx' is the type name used in the configuration file. Note that originally the replication engine was called the

Webhook

optrix@undisclosed.example.com (optrix) — Wed, 16 Sep 2026 22:26:17 +0000

Webhook This type of replicator sends incoming data to an HTTP server. Note that as live data can be very fast, we suggest the webhook server must be able to handle a high rate of incoming calls. Type Name The type name to use in your configuration is webhook

TimescaleDB

optrix@undisclosed.example.com (optrix) — Wed, 16 Sep 2026 22:26:02 +0000

TimescaleDB This type of replicator sends incoming data to a TimescaleDB server to be recorded. TimescaleDB is a modified version of PostGRESQL designed to handle long term, high-speed time-series data without experiencing the major performance issues that arise when storing this sort of data in a traditional database engine.

Redis

optrix@undisclosed.example.com (optrix) — Wed, 16 Sep 2026 22:25:49 +0000

Redis This type of replicator sends incoming data to a REDIS server, where it is held in an in-memory data store that can be subscribed to. Type Name The type name to use in your configuration is redis. Configuration The following configuration options are accepted

MQTT Per-Asset Topics

optrix@undisclosed.example.com (optrix) — Wed, 16 Sep 2026 22:25:02 +0000

MQTT Per-Asset Topics This type of replicator sends incoming data to your MQTT server, with one topic per ARDI asset that has live data. This will consolidate all updates about an asset into a single message, reducing the total size of the MQTT namespace and reducing the number of total messages sent.

MQTT Event Notifications

optrix@undisclosed.example.com (optrix) — Wed, 16 Sep 2026 22:24:50 +0000

MQTT Event Notifications This type of replicator sends incoming data to your MQTT server, with one topic per property. However, rather than being a live stream of updates, these topics are only sent updates when a significant change happens. For discrete values (on/off signals, statuses, text values etc.), messages will be sent with any change. This reflects machines turning on/off, doors closing etc.

MQTT Per-Point Topics

optrix@undisclosed.example.com (optrix) — Wed, 16 Sep 2026 22:24:37 +0000

MQTT Per-Point Topics This type of replicator sends incoming data to your MQTT server, with one topic per point of live data. This means that there will be a large number of individual topics in your MQTT hierarchy. Each message simply contains the raw value of that point of information.

Memcache

optrix@undisclosed.example.com (optrix) — Wed, 16 Sep 2026 22:24:24 +0000

Memcache This type of replicator sends incoming data to a Memcache server, where it is held in an in-memory data store. Type Name The type name to use in your configuration is memcache. Configuration The following configuration options are accepted... Name

InfluxDB

optrix@undisclosed.example.com (optrix) — Wed, 16 Sep 2026 22:23:57 +0000

InfluxDB This type of replicator sends incoming data to an InfluxDB server to be recorded. Type Name The type name to use in your configuration is influx. Configuration The following configuration options are accepted... NameNotesPurposehostnameRequiredThe full path to your

Pre-Built Replicators

optrix@undisclosed.example.com (optrix) — Wed, 16 Sep 2026 22:23:43 +0000

Pre-Built Replicators Below are the list of replicator modules that are included with ARDI 2026 and above. InfluxDB Memcache MQTT Per-Point Topics MQTT Event Notifications MQTT Per-Asset Topics Redis TimescaleDB Webhook

linedetails.png - created

optrix@undisclosed.example.com (optrix) — Tue, 15 Sep 2026 23:54:16 +0000

linediagram.png

optrix@undisclosed.example.com (optrix) — Tue, 15 Sep 2026 05:08:38 +0000

chorddiagram.png

optrix@undisclosed.example.com (optrix) — Tue, 15 Sep 2026 05:07:03 +0000

articulation.png - created

optrix@undisclosed.example.com (optrix) — Thu, 03 Sep 2026 00:02:17 +0000

apprisepage.png - created

optrix@undisclosed.example.com (optrix) — Thu, 20 Aug 2026 04:20:03 +0000