https://docs.optrix.com.au/ Wed, 27 May 2026 01:31:15 +0000 FeedCreator 1.8 https://docs.optrix.com.au/_media/wiki:dokuwiki.svg https://docs.optrix.com.au/ https://docs.optrix.com.au/mplreport:add_a_query Querying Data in a Report To query data, the mplreport class has the FetchHistory function. The function takes a single parameter - the AQL function you want to run. Note that this function should not include the call to GETHISTORY. The API will take care of adding that for you. You simply need to include a query that returns a list of ARDI points. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:aichannel AIChannel The AIChannel function of the mplreport class writes an array of data to a file for AI analysis. This is used by the reporting engine to help evaluate what a 'normal' report looks like, so that unusual or unexpected events in reports can be highlighted to users. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:aqlhistresponse AQLHistResponse The AQLHistResponse class is part of the ARDI Python API. It includes both the Pandas dataframe containing your historical information, and the metadata dictionary about the columns in the dataframe. This allows you to not only get the data values, but also have access to the attributes of the properties, such as units, min and max values, colour mapping and - for discrete values - how to map those numeric values into human-readable strings. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:capturing_data Capturing Data with KPICapture Capturing data with the KPICapture library is designed to be very simple. First, import the library... import kpicapture as kpi Next, create an instance of the KPICapture class. The constructor takes one parameter - the name of the anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:clear Clear The Clear function of the mplreport class is used to delete all of the PDF pages created so far. Usually, this function is used when your output is not a PDF file and is instead something else, such as an Excel spreadsheet, Powerpoint presentation or video. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:clearfailures ClearFailures The ClearFailures function of the mplreport class erases the list of errors seen when retrieving data from ARDI, resetting the response you get from the FetchFailure function. This is normally used in situations where reports can continue to be generated even if one or more sources of data are unavailable. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:create_a_report_page Create a Page We now need to start our actual report. The CreatePage function is used to create a new page. It takes the same arguments as the MatPlotLib subplots function and returns the same values - a figure and a list of axes. If we wanted to create a simple report with only a single set of axes, we could use anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:createpage CreatePage The CreatePage function of the mplreport class is used to create a new page in a PDF report, and takes the same parameters as the MatPlotLib subplots function. Parameters See the documentation for subplots in the MatPlotLib documentation. Return This function returns a tuple containing two objects - the first is a MatPlotLib anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:data_set Data Sets In the KPICapture library, you can record data into a 'data set'. While data sets can be very specific - such as focusing on a particular area of a facility or part of a machine - they're usually used to record different time resolutions of data. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:dateformat DateFormat The DateFormat function of the mplreport class returns a DateTime format string suitable for the chosen report range. For example, a report of less than 24 hours will usually use the HH:MM date format, while longer reports will use %H %d/%m. Parameters anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:errors errors The errors member of the mplreport class contains an array of all of the errors encountered while retrieving data from ARDI. This includes requests for time-series data and events. Items in the array are human-readable text that show the specific problems encountered. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:failed Failed The Failed function of the mplreport class creates an output page showing that the report has failed to generate. If using the ardireport decorator, an exception handler is placed around your function. If an un-handled exception happens during report generation, this function is called to allow your report to fail gracefully. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:failedaxis FailedAxis The FailedAxis function of the mplreport class marks a particular set of MatPlotLib axes with a visual indicator showing it couldn't be created due to a problem. Unlike the Failed function - which indicates that the report as a whole has failed, this function allows you to indicate that a anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:failonerror FailOnError The FailOnError function of the mplreport class will gracefully fail the report with a “This Report Is Unavailable” message and some explanatory text if one or more errors have been returned as part of a data request, such as FetchHistory or anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:fetchfailure FetchFailure The FetchFailure function of the mplreport class returns True if one or more errors have been returned as part of a data request, such as FetchHistory or GetEvents. Parameters None Return True if there are one or more errors, otherwise False anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:fetchhistory FetchHistory The FetchHistory function of the mplreport class returns an AQLHistResponse object with the results of a historical AQL query. Parameters ParameterTypeDefaultMeaningquerystrThe AQL query to run, without the GETHISTORY command.startDateTimeNoneThe start of the query time, in UTC. If anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:getanaloguecolourmap GetAnalogueColourMap The GetAnalogueColourMap function of the mplreport class returns a colour map that allows you to convert the analogue value of a property to a matching colour using the AQLHistResponse object returned from the FetchHistory command. This is usually used to create heatmaps or other colour-coded displays of analogue values. If colouring anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:getcolourmap GetColourMap The GetColourMap function of the AQLHistResponse class returns a dictionary used to convert numerical values into colours. This function is generally suitable for discrete values. Additional logic will be needed to interpolate between colours on continuous values. You might want to consider anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:getcolumncolour GetColumnColour The GetColumnColour function of the AQLHistResponse class returns a suitable colour for a particular value and property. For performance reasons, it is better to use the GetColourMap function or the GetAnalogueColourMap functions if available and suitable. Parameters ParameterType anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:getcolumndata GetColumnData The GetColumnData function of the AQLHistResponse class returns the metadata for a named column. This is usually used to find information such as the units of measurement, minimum and maximum values, colour schemes etc. for a property. Parameters Parameter anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:getcolumntext GetColumnText The GetColumnText function of the AQLHistResponse class returns the human-readable text version of a discrete value. This is used on properties that have distinct meanings for values. For example where '0' means 'Off' and '1' means 'On'. If performing this action multiple times, it is often more efficient to use anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:getdiscretecolourmap GetDiscreteColourMap The GetDiscreteColourMap function of the mplreport class returns a lookup array of the possible values of a discrete property and the associated MatPlotLib RGB colours for those values, based on an AQLHistResponse object. This is usually used to create heatmaps, status-lines, broken bar-charts or other colour-coded displays of discrete values. If colouring anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:getdiscretelegend GetDiscreteLegend The GetDiscreteLegend function of the mplreport class returns the patches and names required to create a custom legend displaying the colours for discrete property. This function is usually used along-side GetDiscreteColourMap to visually show discrete values over time. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:getevents GetEvents The GetEvents function of the mplreport class returns a list of Events from the ARDI server for the chosen time-frame. Parameters ParameterTypeDefaultMeaningsourcestrNoneA source name to get events from. If None, uses all sources.startDateTimeNone anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:getvaluemap GetValueMap The GetValueMap function of the AQLHistResponse class returns a dictionary used to convert numerical values into text. This function is generally suitable for discrete values, where each numeric value will have a string representation - such as '0' meaning 'Off' and '1' meaning 'On'. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:grid Grid The Grid function of the mplreport class is simply a more subtle version of the grid you would normally get by calling axes.Grid() in MatPlotLib. Parameters ParameterTypeDefaultMeaningaxesAxesThe axes to create a subtle grid on Return None Example report.Grid(ax) anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:heatmaptimeaxis HeatMapTimeAxis The HeatMapTimeAxis function of the mplreport class is similar to the TimeAxis function, but is used when you don't have a DateTime index to work with. Given a number of samples, it creates axis ticks that look like dates/times. Note that it assumes that your data is anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:kpicapture KPICapture The KPICapture classes are used to store and retrieve very low-resolution, time-stamped data, such as per-day or per-shift KPIs. Although they are very simple, they are a useful tool if you'd like to create weekly, monthly or yearly reporting based on figures you're capturing in your daily reports. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:localtime LocalTime The LocalTime function of the mplreport class converts a naive DateTime object from UTC time to local time. The UTCTime function performs the opposite. Parameters ParameterTypeDefaultMeaningtmDateTimeThe UTC time to be converted Return A naive DateTime object, converted to the local timezone. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:mplreport mplreport The mplreport class is used to easily create reports. Many of the settings of your report are pre-loaded into the object by the reporting engine. Member Functions AIChannel - Writes an array of information out for AI processing, used by the report engine to detect if reports are showing 'normal' or 'unexpected' values. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:quick_function_guide Reporting Quick Function Guide Below you will find some quick guides to common reporting tasks. Show the Correct Colour/Text for a Discrete Value anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:report_folder Your Report Folder By default, your reports are in the reports folder of your ARDI site. These can normally be found in the /web/sites/ folder of your ARDI installation, under the folder for the individual ARDI application. For example, on Windows you could find it at anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:retrieving_data Retrieving Data from KPICapture Reading data (that you've previously written with the KPICapture class) is designed to be relatively easy. First, import the library... import kpicapture as kpi Next, create an instance of the KPIAccess class. The constructor takes one parameter - the name of the anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:save Save The Save function of the mplreport class saves your finished report. Note that your report output might vary - in many cases it will be saved as a PDF file, but certain options may also save your file as a PNG or SVG. Parameters None Return None anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:setup-reportengine Setting Up A Report When being used as part of the ARDI Reporting Engine, you can use a decorator to set up your report. To begin, you would... * Open the folder where your reports are kept, * Create a unique directory name for your report, * Create a file named report.py in that folder, anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:simple_example A Simple Report import ardi.util.mplreport @mplreport.ardireport("Sample Report") def CreateReport(report,args): #Set up the report page fig,ax = report.CreatePage(1) report.Title() #Fetch the report data thedata = report.FetchHistory("'Temperature' PROPERTYEX ALLPOINTS") #Check for incomplete data if report.FetchFailure(): report.Failed("\n".join(report.errors)) frame = thedata.data #Draw the lines for colname in frame.columns: ax.plot(… anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:simplifyticks SimplifyTicks The SimplifyTicks function of the mplreport class takes an array of strings and removes any text that is common among all of the array elements at both the start and the end of the array. Parameters ParameterTypeDefaultMeaningarrlistThe array of strings to process anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:timeaxis TimeAxis The TimeAxis function of the mplreport class creates a suitable time axis on a MatPlotLib subplot, given the current report range. Parameters ParameterTypeDefaultMeaningaxisAxisThe MatPlotLib axis object to modify. Return None Example report.TimeAxis(ax.xaxis) anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:title Title The Title function of the mplreport class adds a simple title-block to the top of your report page. Using the optional keyword parameters, you can adjust the content of the title. Parameters ParameterTypeDefaultMeaningstarttimeDateTimeNoneThe displayed start date. If anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:using_historical_data Using Data in our Report Our code currently looks like this... import ardi.util.mplreport @mplreport.ardireport("Sample Report") def CreateReport(report,args): fig,ax = report.CreatePage(1) report.Title() thedata = report.FetchHistory("'Temperature' PROPERTYEX ALLPOINTS") if report.FetchFailure(): report.Failed("\n".join(report.errors)) report.Save() anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:utctime UTCTime The UTCTime function of the mplreport class converts a naive DateTime object from local time to UTC time. The LocalTime function performs the opposite. Parameters ParameterTypeDefaultMeaningtmDateTimeThe local time to be converted Return A naive DateTime object, converted to the UTC timezone. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/mplreport:welcome ARDI MatPlotLib Reporting Library The reporting library is designed to very quickly create ARDI-powered reports in Python using MatPlotLib. It's designed to work with the ARDI reporting engine, but can also be used in other places where you'd like to create reports in Python using ARDI information. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000