Skip to content

AquaticInformatics/flowtracker2-field-data-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

77 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

flowtracker2-field-data-plugin

Build status

An AQTS field data plugin supporting FlowTracker2 measurement files, for AQTS 2017.4-or-newer systems.

Want to install this plugin?

Plugin Compatibility Matrix

It is recommended that you use the most recent version of the plugin which matches your AQTS server version.

AQTS Version Latest compatible plugin Version
AQTS 2020.2+ v20.2.4 - BUGFIX: Use a velocity unit for the meter calibration equation
v20.2.3 - Adds configurable ISO Uncertainty Scalar
AQTS 2019.2 - 2020.1 v19.2.13 - Adds Party and Primary Meter to channel measurement
v19.2.12 - Adds incrementing vertical numbers
2017.4 - 2019.1 v17.4.44

Configuring the plugin

Starting with version 20.2.0, there are some configurable plugin settings which can be set in the Settings tab of the System Config Page.

Group Key Value Description
FieldDataPluginConfig-FlowTracker2 IsoUncertaintyScalar 1.0 This value will be used to scale the FlowTracker2 ISO uncertainty measurement, which defaults to a single standard devation (68% confidence interval).

A value of 1.96 will scale the uncertainty into a two-standard-deviation value (95% confidence interval).

Defaults to 1.0 if the value is missing or is not a valid number.

Requirements for building the plugin from source

  • Requires Visual Studio 2017 (Community Edition is fine)
  • .NET 4.7 runtime

Building the plugin

  • Load the src\FlowTracker2.sln file in Visual Studio and build the Release configuration.
  • The src\FlowTracker2Plugin\deploy\Release\FlowTracker2Plugin.plugin file can then be installed on your AQTS app server.

Testing the plugin within Visual Studio

Use the included PluginTester.exe tool from the Aquarius.FieldDataFramework package to test your plugin logic on the sample files.

  1. Open the FlowTracker2Plugin project's Properties page
  2. Select the Debug tab
  3. Select Start external program: as the start action and browse to "src\packages\Aquarius.FieldDataFramework.17.4.3\tools\PluginTester.exe
  4. Enter the Command line arguments: to launch your plugin
/Plugin=FlowTracker2Plugin.dll /Json=AppendedResults.json /Data=..\..\..\..\data\DemoData.ft

The /Plugin= argument can be the filename of your plugin assembly, without any folder. The default working directory for a start action is the bin folder containing your plugin.

  1. Set a breakpoint in the plugin's ParseFile() methods.
  2. Select your plugin project in Solution Explorer and select "Debug | Start new instance"
  3. Now you're debugging your plugin!

See the PluginTester documentation for more details.

Installation of the plugin

Use the SystemConfig page to install/enable this plugin on your AQTS app server.