ARDI Documentation - mos

Announcement Modules

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Announcement Modules Announcement modules are modules that distribute their output directly to end-users, through mechanisms such as email, SMS messaging or voice. When using these output modules, you should be aware of two reasons why you should ensure that these outputs only happen

Common Output Module Options

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Common Output Module Options While each Output Module has it's own distinct set of options, there are a few that are common to all modules. These are usually used to allow you to filter your data or only output specific kinds of information, giving you control over exactly what is recorded.

Azure Communication Services

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Azure Communication Services The ACS Email output module allows you to write an email in response to an event, which is sent through Azure Communication Services Email. This helps get around some common security issues trying to send SMTP email in the modern era, where password policies and two-factor authentication make it difficult to send messages from automated systems and appliances.

Announce

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Announce This output is used to announce an event through the speakers of the system. If needed, this can be redirected (through your network or through cabling) to a PA or announcement system. ParameterDefaultMeaningformat%MThe content of the message, with

Discord

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Discord This output is used to write a Discord message to an existing Discord WebHook. ParameterDefaultMeaningurlThe Discord WebHook URLmessageA list of JSON parameters to set (using periods for dictionaries) that may include event substitutions Example [ { "method": "discord", "url": "http://", "message": { "author.name": "Notifications", "footer.text": "@ %S", "title": "%M", "description": "This is to let you…

EMail

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

EMail The Email output module allows you to write a simple email message. ParameterDefaultMeaningserverThe IP or DNS name of your SMTP serverport165Theport for your SMTP serverfromThe address to send the message fromtoThe address to send the message to

Event Substitutions

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Event Substitutions Some event output modules allow you to substitute special patterns with details of the event. This is particularly common in SQL-based outputs, such as those to MySQL/MariaDB, or to messaging outputs such as Email. The following table shows the substitutions available

Events

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Events Events can also be recorded by the modular output system. Note that when recording events, you should be aware of possible timezone issues. Most recording modules will have the option of specifying the timezone that you'd like the final output to be in.

Event Data Methods

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Event Data Methods The methods below apply to event data only. The output modules for key-data methods have different options. Module List Basic LogFile Databases MySQL/MariaDB PostgreSQL MS-SQL Server Snowflake Message Brokers MQTT Sockets UDPStream TCPStream Web Discord HTTP JSON Signl4 Teams Announcing Azure Communication Email E-Mail SMS (Twilio) Voice Calling (Twilio) Voice Announcement Whatsapp (Twilio)

HTTP JSON

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

HTTP JSON This output is used to write a JSON message to an HTTP or HTTPS URL. This is commonly used when notifying cloud-based services such as Microsoft PowerAutomate that an event has taken place. ParameterDefaultMeaningurlThe destination URL of the message

MQTT

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

MQTT The MQTT output module allows you to write data to a MQTT message broker. ParameterDefaultMeaninghostThe host name or IP address of the serverport1883The REDIS server portpatheventsThe path to write the address tomessage{“message”: “%M”

Microsoft SQL Server

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Microsoft SQL Server The MS-SQL output module allows you to write data to a Microsoft SQL Server database server. ParameterDefaultMeaninghostlocalhostThe host name or IP address of the serveruserThe name of the database userpasswordThe database password

MySQL/MariaDB

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

MySQL/MariaDB The MySQL output module allows you to write data to a MySQL or MariaDB database server. ParameterDefaultMeaninghostlocalhostThe host name or IP address of the serveruserThe name of the database userpasswordThe database passworddatabase

PostGRESQL

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

PostGRESQL The PostGRES output module allows you to write data to a PostGRESQL database server. ParameterDefaultMeaninghostlocalhostThe host name or IP address of the serveruserThe name of the database userpasswordThe database passworddatabaseThe name of the database

Signl4

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Signl4 This output is used to write a JSON message to an HTTP or HTTPS URL. This is commonly used when notifying cloud-based services such as Microsoft PowerAutomate that an event has taken place. ParameterDefaultMeaningapikeyYour SIGNL4 API Keymessage

Snowflake

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Snowflake The Snowflake output module allows you to write data to the cloud Snowflake database system. ParameterDefaultMeaninguserThe name of the database userpasswordThe database passwordwarehouseThe name of the data warehouseschemaThe name of the data schema

TCPStream

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

TCPStream This output is used to write data to a listening UDP socket, ideal for notifying 3rd party applications of any changes and/or activity. ParameterDefaultMeaninghostThe host name or IP address of the serverportThe listening UDP portmessage{“

Microsoft Teams

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Microsoft Teams This output is used to write a notification/chat message to Microsoft Teams via a Webhook. ParameterDefaultMeaningurlThe Microsoft Teams webhooktimezoneUTCThe timezone to send all dates/times incontent%MThe text content of the message, including

Twilio SMS

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Twilio SMS The Twilio SMS output module allows you to write simple SMS messages through the Twilio API. ParameterDefaultMeaningccode61Your international dialling codesidYour Twilio security IDtokenYour Twilio Auth TokenfromThe Twilio phone number to send messages from

Twilio SMS

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Twilio SMS

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

UDPStream

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

UDPStream This output is used to write data to a listening UDP socket, ideal for notifying 3rd party applications of any changes and/or activity. ParameterDefaultMeaninghostThe host name or IP address of the serverportThe listening UDP portmessage{“

InfluxDB

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

InfluxDB The InfluxDB output module allows you to write data to an InfluxDB database server. ParameterDefaultMeaningurlThe URL of the InfluxDB serverbucketThe name of the bucket/database to useorgThe name of the organisation to accesstokenThe security token to use to write data

Key-Value Data Methods

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Key-Value Data Methods The methods below apply to key-value data only. The output modules for event methods have different options. Module List Basic TextFile LogFile Industrial Protocols OPC-UA Modbus/TCP Databases Prometheus MySQL/MariaDB PostGRESQL MS-SQL InfluxDB Snowflake Key-Value Stores Redis Memcache Message Brokers MQTT

Key-Value Output

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Key-Value Output Key-Value data is what you would normally see in 'live' information. A single name that identifies the point (the key) and a single measurement for that point (the value).

Snowflake

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Snowflake The Snowflake output module allows you to write data to the Snowflake cloud database. If your output parameters include a time parameter, these are recorded with a matching timestamp, creating a historical record of your data. If you omit the

LogFile

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

LogFile The LogFile output module allows you to write data to a simple text-based log file. ParameterDefaultMeaningfilenameThe full path to the file to write Availability Available for key-value and events. Example [ { "method": "logfile", "filename": "c:\tmp\myfile.txt" } ]

Memcache

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Memcache The MEMCACHE output module allows you to write data to a Memcache in-memory key-value store. While Redis is often a more attractive option due to it's subscription mechanism, unfortunately Redis isn't officially compatible with Windows servers.

Modbus/TCP

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Modbus/TCP The Modbus/TCP output module turns your system into an Modbus/TCP server (known as a modbus slave) that can be read from a variety of industrial systems and protocol converters, allowing you to feed values from your analytics back into your industrial historian, SCADA system or even inject it into your PLCs.

MOS

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

MOS This output is used to write data to the Modular Output System ARDI driver, allowing you to directly inject Modular Output System data into ARDI. Note that this output method is almost identicial to the UDPStream output, without the need to specify a delimiter

MQTT

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

MQTT The MQTT output module allows you to write data to a MQTT message broker. The messages are sent for each individual channel, allowing you to subscribe to specific channels or groups of channel. ParameterDefaultMeaninghostThe host name or IP address of the server

MS-SQL

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

MS-SQL The MS-SQL output module allows you to write data to a Microsoft SQL Server database server. If your output parameters include a time parameter, these are recorded with a matching timestamp, creating a historical record of your data. If you omit the

MySQL/MariaDB

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

MySQL/MariaDB The MySQL output module allows you to write data to a MySQL or MariaDB database server. If your output parameters include a time parameter, these are recorded with a matching timestamp, creating a historical record of your data. If you omit the

OPC-UA

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

OPC-UA The OPC-UA output module turns your system into an OPC-UA server that can be read from a variety of industrial systems and protocol converters, allowing you to feed values from your analytics back into your industrial historian, SCADA system or even inject it into your PLCs.

PostGRESQL

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

PostGRESQL The PostGRES output module allows you to write data to a PostGRESQL database server. If your output parameters include a time parameter, these are recorded with a matching timestamp, creating a historical record of your data. If you omit the

Prometheus

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Prometheus The Prometheus output module turns your system into a web server that hosts values in a format that can be read by Prometheus. The URL to read is http://servername/prometheus. This is a service module - meaning that rather than writing

Redis

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Redis The REDIS output module allows you to write data to a Redis key-value store. One key benefit of Redis is that you can subscribe to new incoming data, allowing you to react immediately to changes in value of one or more outputs. ParameterDefault

REST

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

REST The REST output module turns your system into a web server that hosts values in a variety of machine-readable formats, including JSON and XML. The URL to read is http://servername/api. This is a service module - meaning that rather than writing

TCPStream

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

TCPStream This output is used to write data to a listening TCP socket, allowing you to push outputs directly to a custom application. ParameterDefaultMeaninghostThe host name or IP address of the serverportThe listening UDP portdelimiterThe delimiter to separate the name and value of the point.

TextFile

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

TextFile The TextFile output module allows you to write data to a simple text file. Note that this text file will contain only the live values currently being read - it doesn't maintain a log of events or values (see LogFile if you want that). This is often used with older systems reading data through

UDPStream

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Using the Modular Output System

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Using the Modular Output System If you'd like to use the Modular Output System in your own projects, the system is relatively easy to use. Include the Library import ardi.util.outputengine as outie Create and Start an Instance oe = outie.OutputEngine("My Source Name") oe.Start()

Modular Output System

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Modular Output System The Modular Output System is designed to help you get your output information to where you need it. The system is primarily designed around transmitting key-value information (ie. a point with both a name and a value) and event logs to the destination(s) of your choice.

WriteLog Function

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

WriteLog Function The WriteLog function writes a single event to your modular output system outputs. The following parameters are supported... ParameterDefaultMeaningnameThe primary name/text/description of your eventduration0The length of the event, in secondsoffset0The difference (in seconds) between the event and the current time

WriteValue Function

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

WriteValue Function The WriteValue function writes a single key/value pair (a value and a unique name for that value) to your modular output system outputs. The following parameters are supported... ParameterDefaultMeaningnameThe name (key) for the key/value pair. This may contains '/' symbols if the value is hierarchial