http://docs.optrix.com.au/ Wed, 27 May 2026 01:24:39 +0000 FeedCreator 1.8 http://docs.optrix.com.au/_media/wiki:dokuwiki.svg http://docs.optrix.com.au/ http://docs.optrix.com.au/pyapi:aqlquery_execute_df AQLQuery::Execute_DF This function is part of the AQLQuery class. Execute_DF is used to run an AQL query on the ARDI server and convert the historical information returned into a Pandas dataframe. Python does a considerable amount of processing on the data to give you a anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:aqlquery_execute AQLQuery::Execute This function is part of the AQLQuery class. Execute is used to run an AQL query on the ARDI server. It returns None if there is a problem or exception, and returns a parsed JSON object on success. If the data contains measurement history, we suggest using anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:aqlquery_historytodataframe AQLQuery::HistoryToDataframe This function is part of the AQLQuery class. HistoryToDataframe is used to transform the JSON results of an ARDI AQL history request into a Pandas dataframe for use in analysis, reporting or analytics. Its used in Execute_DF - you'll find detailed documentation about the parameters there. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:aqlquery Class: AQLQuery The AQLQuery class manages a single AQL request. It contains functions to convert historical queries into Pandas data-frames for easy processing and analytics. Member Functions NameDescriptionParametersinitConstructorServerExecuteExecutes the query on the server and returns the resulting JSON anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:ardi.py import requests import xmltodict import pandas as pd import numpy as np import json import traceback import time from dateutil import tz try: from urllib.parse import urlencode except ImportError: from urllib import urlencode class Context: def __init__(self): self.consolidator = 5336 self.submission = 2991 self.name = "Actual" self.server = "" class Server: def __init__(self, srv, site='default', port=80): self.server = srv … anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:channel_asfloat Channel:AsFloat This function is part of the Channel class. AsFloat is used to retrieve the value of the channel as a floating-point number. ARDI data generally travels as strings, but through JSON conversion might be converted to and from numeric values. As such, we always suggest casting your channels to the desired type to ensure no exceptions occurr. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:channel_astext Channel:AsText This function is part of the Channel class. AsText is used to retrieve the value of the channel as a string. ARDI data generally travels as strings, but through JSON conversion might be converted to and from numeric values. As such, we always suggest casting your channels to the desired type to ensure no exceptions occurr. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:channel Class: Channel The Channel class represents a single point of data from a live source. Channels are created through Session objects. You should not create your own Channel instances. Member Functions NameDescriptionParametersAsTextReturns the value of this channel as a string anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:class_reference Python API Class Reference Key Classes Server Session Channel AQLQuery Secondary Classes Context Subscription anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:complete_dataframe Complete Dataframe A Complete Dataframe is one where there is a valid value for every time in a time-indexed dataframe. In most cases, the data you'll request in a complex query won't have synchronised sample times. Some sensors update several times a second, others every few seconds, some once an hour. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:connecting_to_an_ardi_server Connecting to an ARDI Server The first step in using the API is connecting. This verifies that the server you want to talk to is available, and discovers critical information such as how to subscribe to live data. To connect, you create a Class: Server object, initialised with the address of the ARDI server and the site name you wish to connect to. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:context Class: Context The Context class is used to store the information about an ARDI data context. Member Variables NameDescriptionnameThe name of the contextconsolidatorThe port to use to contact the consolidator (used for live data)submissionThe port to use to submit new data anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:examples Python API Examples Connecting to an ARDI Server Reading Live Data Making an AQL Query Reading Historical Data anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:making_queries Reading Historical Data / Using AQL ARDI uses its own query language named AQL to ask for information. It returns JSON information that you should be able to use in a variety of applications. When you're asking for historical information (using the AQL anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:querying_ardi_data Making an AQL Query ARDI uses its own query language named AQL to ask for information. It returns JSON information that you should be able to use in a variety of applications. When you're asking for historical information (using the AQL GETHISTORY anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:reading_historical_data Reading Historical Data ARDI uses its own query language named AQL to ask for information. The GETHISTORY function in AQL gets the history for one or more points of data. But these individual data points will often have different time-stamps, update rates and be a bit scattered. Trying to figure out exactly what the state of the system was at any given time can be challenging. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:reading_live_data Reading Live Data ARDI uses a subscription model for live data. Instead of re-reading a list of points continuously, you subscribe to the specific set of data points you are interested in. Then ARDI will send you responses when these values have changed. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:server_addchannel Session:AddChannel This function is part of the Session class. AddChannel is used to add a single live data channel to the session. The session won't start receiving new updates until the next call to Start. Parameters NameDescriptionAssetThe name of the ARDI Asset to read from anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:server_addchannels Session:AddChannels This function is part of the Session class. AddChannels is used to add one or more new Channels of live data to your Session. These channels are loaded from an AQL statement, allowing you to dynamically link to assets based on their relationships, types, properties etc. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:server_connect Server::Connect This function is part of the Server class. Connect is used to establish and verify a connection with an ARDI server, using the information passed in the constructor (the server host name and site name). Return Value This function returns anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:server_endpoint Server::Endpoint This function is part of the Server class. Endpoint is used to get the full URL to the ARDI server, including the signature needed when using a password-protected ARDI server. Return Value A string containing the full URL to use. Note that if you have not called anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:server_getconfiguration Server::GetConfiguration This function is part of the Server class. GetConfiguration is used to return a list of the properties and relationships within an ARDI server. Return Value This function returns None if an error occurred. Otherwise, it returns an array containing two sub-arrays. The first is a list of relationships, the second a list of properties. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:server Class: Server The Server class manages the connection and information about an ARDI server. Member Functions NameDescriptionParametersinitConstructorServer, Site(default), Port(80)ConnectConnects to the ARDI serverNoneGetConfigurationGets property and relationship information from the ARDI server anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:session_callback Session:Callback This function is part of the Session class. Callback is used to set the callback function you want to call when changes are made to your data. While each of your Channels are automatically updated with new data as it comes in, callbacks provide a mechanism of knowing anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:session_start Session:Start This function is part of the Session class. Start is used to begin listening for data changes from ARDI. You will initially get an inrush of data points, as when you first connect you'll be sent the current values for every point you've requested. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:session_stop Session:Stop This function is part of the Session class. Stop is used to stop listening to data changes from ARDI. This function will free up the thread that was blocked by a call to Start. Note that there may potentially be a time-gap between the Stop request and the subscription actually stopping. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:session Class: Session The Session class manages a feed of live data from the ARDI server. It allows you to get regular updates when values change on one or more Channels. Member Functions NameDescriptionParametersinitConstructorServerAddChannelAdds a single channel to the Session anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/pyapi:start ARDI Python API Almost any computer language can communicate with ARDIs APIs, as they are all based on web-requests. We do however provide a Python package to make working with ARDI data even easier. You can download the latest version here. If you're exploring the anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000