ARDI Documentation - jsapi https://docs.optrix.com.au/ Wed, 27 May 2026 01:23:25 +0000 FeedCreator 1.8 https://docs.optrix.com.au/_media/wiki:dokuwiki.svg ARDI Documentation https://docs.optrix.com.au/ A Simple Live-Data Web Page https://docs.optrix.com.au/jsapi:a_simple_example A Simple Live-Data Web Page Below you'll find the code for a simple web-page that displays the current speed of the Paint Line on our demo server. <html> <head> <title>Testing</title> <script src="https://demo.optrix.com.au/plugins/optrix/hmitt.js"></script> </head> <body> <div id="display"> Unknown </div> <script> //Create a connection var connection = new HMITTPanel(); //Subscribe to points connection.Sub("Paint Line.Speed - Actual",function (v) { docu… anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 Connect https://docs.optrix.com.au/jsapi:connect Connect The Connect function is part of the HMITTPanel class used to connect to live ARDI data. Once you've subscribed to one or more points with the Sub function, you use Connect to connect to the ARDI server. Parameters NameType/DefaultUseServerStringThe URL anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 GetValue https://docs.optrix.com.au/jsapi:getvalue GetValue The GetValue function is part of the HMITTPanel class used to connect to live ARDI data. It gets the most recent value for a named data point. Note that this point is not animated. If no value has been received for that point yet, the function will return 'null' unless a default value is specified. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 HMITTPanel Class Reference https://docs.optrix.com.au/jsapi:hmittpanel HMITTPanel Class Reference Major Functions Sub - Subscribes to a single ARDI data point UseSSL - Sets up to connect via SSL Connect - Connects to the ARDI server Other Functions GetValue - Returns the value of a named point InteractiveControls - Creates interactive time-travel controls (requires JQuery) anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 InteractiveControls https://docs.optrix.com.au/jsapi:interactivecontrols InteractiveControls The InteractiveControls function is part of the HMITTPanel class used to connect to live ARDI data. It provides a simple, HTML UI that allows users to 'time travel' - to playback data from other times. Parameters None Notes This function should not be called within SVG files or other non- anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 Working With Multiple Data Points https://docs.optrix.com.au/jsapi:introducing_getvalue Working With Multiple Data Points If you want to work with multiple data points at a time, we provide the GetValue function. This function takes the name of the point you're subscribed to, and an optional default value to return if no value is available (if no default is specified, the function returns 'null' when there are no results). anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 OnlyWhenFocused https://docs.optrix.com.au/jsapi:onlywhenfocused OnlyWhenFocused The OnlyWhenFocused function is part of the HMITTPanel class used to connect to live ARDI data. It sets up event handlers so that the feed of live data stops when a HTML page or SVG file is in the background (ie. not the active tab in your web browser). anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 Colours and Names https://docs.optrix.com.au/jsapi:right_names_and_colours Colours and Names Your live data will usually be numeric. Digital sensors and statuses will be sent as 0s and 1s. It's important to be able to make these values human-readable, and to use the colour-codes that users expect to see. The Infographics anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 Sub https://docs.optrix.com.au/jsapi:sub Sub The Sub function is part of the HMITTPanel class used to connect to live ARDI data. It adds a single point of data to the subscription, and provides a function that is called whenever the value of that point changes. Parameters NameType/DefaultUsePointString anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 UseSSL https://docs.optrix.com.au/jsapi:usessl UseSSL The UseSSL function is part of the HMITTPanel class used to connect to live ARDI data. It tells the library to connect using indirect SSL subscriptions rather than direct, insecure HTTP sessions. Parameters None Example //Create 'connection' and subscriptions... connection.UseSSL(); connection.Connect("myardiserver/s/default"); anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 ARDI Javascript Live Data API https://docs.optrix.com.au/jsapi:welcome ARDI Javascript Live Data API The ARDI Javascript Live Data API is an update to the earlier Javascript API, with a number of quality-of-life improvements and new functionality. Fundamentally, the API allows you to connect your web page or SVG image to a stream of live data from an ARDI server. anonymous@undisclosed.example.com (Anonymous) Mon, 27 Apr 2026 23:07:22 +0000