https://docs.optrix.com.au/ Wed, 27 May 2026 01:23:37 +0000 FeedCreator 1.8 https://docs.optrix.com.au/_media/wiki:dokuwiki.svg https://docs.optrix.com.au/ https://docs.optrix.com.au/analytics:ardi_analytics ARDI Analytics ---------- DEPRECATION WARNING: ARDI Analytics is no longer being actively developed. More powerful analytics are now possible using Visual Analytics, the Agency platform, Capture and the Trigger Python module. ---------- The ARDI analytic package allows you to deploy simple analytics based on live data. anonymous@undisclosed.example.com (Anonymous) Thu, 23 Apr 2026 05:49:24 +0000 https://docs.optrix.com.au/analytics:buffering Buffering The reason ARDIs version of graphs are known as funnels is that they can buffer data. This allows them to store more than just the most recent values - they can keep multiple (even hours) of data that may be needed to allow filters to make logical decisions or calculate elements across time. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analytics:data Analytic Data Internally, your analytic data takes the form of a table. Your data is made up of one or more rows of data, each row containing at least one column, similar to a database or spreadsheet. IndexColumn 1Column 2Column 3Date/TimeValue 1Value 2 anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analytics:filter_change Change (Analytic Filter) Description The Change filter is used to prevent output unless there has been a change to the incoming data. This prevents redundant calls to your sinks. The amount of change allowed can be set with the threshold parameter. This allows you to filter out small amounts of drift or error in the value. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analytics:filter_difference Difference (Analytic Filter) Description The Difference filter is used to calculate the difference between the minimum and maximum value in each row of your data. Parameters NameDefaultMeaningColumnDifferenceThe resulting column name Example <filter type="Difference"> <column>DiffTemperature</column> </filter> anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analytics:filter_discreteframe DiscreteFrame (Analytic Filter) Description The DiscreteFrame filter is used to convert discrete data into specific time-frames when the value was at a given value. WARNING: DiscreteFrame requires that you use Dynamic Buffering in your funnel to work, as it needs you to retain history anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analytics:filter_list_-_alphabetical Filter List - Alphabetical Change Difference DiscreteFrame Max Mean Min RenumberColumns Throttle TravelWriter TravelWriterProfile anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analytics:filter_list_-_by_type Filter List - By Type Aggregation Max Mean Min Columns RenumberColumns Heatmap TravelWriter TravelWriterProfile Timing Change DiscreteFrame Throttle anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analytics:filter_list Filters Alphabetical List By Type anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analytics:filter_max Max (Analytic Filter) Description The Max filter is used to calculate the maximum value from the data set. When used on multiple rows, it returns the per-row maximum (ie. it will return the same number of columns and only one row). When used on a anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analytics:filter_mean Mean (Analytic Filter) Description The Mean filter is used to calculate a mean (average) from the data set. When used on multiple rows, it returns the per-row means (ie. it will return the same number of columns and only one row). When used on a anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analytics:filter_min Min (Analytic Filter) Description The Min filter is used to calculate the minimum value from the data set. When used on multiple rows, it returns the per-row minimum (ie. it will return the same number of columns and only one row). When used on a anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analytics:filter_renumbercolumns RenumberColumns (Analytic Filter) Description The RenumberColumns filter is used to change the names of the columns in your data. The resulting columns will have a sequential numeric element, starting from your chosen number (defaulting to 1). Parameters anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analytics:filter_throttle Throttle (Analytic Filter) Description The Throttle filter is used to slow down the output of a particular analytic. In some cases the changes to your incoming data may be rapid - so rapid that storing them will either cause excessive network, server or storage use. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analytics:filter_travelwriter TravelWriter (Analytic Filter) Description The TravelWriter filter is used to write values when items are in a certain point in your process or physical location. It's primarily used to create heatmaps when one axis of your heatmap is an element that moves or changes state over time. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analytics:filter_travelwriterprofile TravelWriterProfile (Analytic Filter) Description The TravelWriterProfile filter very similar to TravelWriter - it's used to write values when items are in a certain point in your process or physical location. The primary difference is that this version of the filter uses multiple columns as an input. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analytics:filter Filters A filter modifies the data in a funnel after it has originated from a source. Some filters may only make subtle changes to your data. Some may make drastic transformations, completely changing the nature of the information. Some may in fact stop your funnel from operating. This is often found in filters that delay or alter the timing of your output, such as anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analytics:funnel Funnels A funnel is used to generate analytic output. It is comprised of three different elements - one source, one or more filters, and one or more sinks. Data originates in the source, is transformed by the filters, and eventually recorded in the sinks. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analytics:how_it_works How Analytics Works To create an analytic, you create a funnel. In other analytic packages, these are also known as graphs. However, ARDIs funnels are very slightly different in how they operate. A funnel is made up of three distinct elements... * A Source, anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analytics:simple_example_funnels Simple Example Funnels Difference Calc Let's imagine we have a simple analytic - we'd like to record a differential temperature (the difference between two temperatures) from ARDI to a MySQL database. In this case, we can identify the source (ARDI anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analytics:sink Sinks A sink is where the data in your funnel ends up after it has passed from the source and through all of your filters. A source transfers data from the Analytic funnel to a destination. This might be a source of live data - such as MQTT or REDIS, or a database such as InfluxDB or anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analytics:source Sources A source is where new data is created. It is read from the origin and pours into your funnel. Once in the funnel, it may be buffered, before moving through one or more filters. After the filters have finished their work and passed the transformed data through, it passes into the anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000