Blueprints
The parameters, formulas and presentation of a sensor are based off of a blueprint. This means that when a project has multiple sensors which you want to process and present the same way, the setup is not repeated for each one.
Creating
On creation of a blueprint a name, icon, manufacturer and type need to be set. Name, manufacturer and type are used for filtering in the search and categorizing the sensor. The icon is used for display on the map.
New manufacturers and types can be edited or added as required.
After creation, you will then be able to add the other following components that make up a blueprint.
Formulas
Formulas are used for the transformation of raw data using calibrations to a calculated output.
Inputs
Inputs are often timeseries data that is coming from a datalogger or another sensor that you wish to perform a calculation on.
These are determined by the mapping set on each sensor.
Calibration Factors
Calibration factors are individual factors applied to each sensor. These can be a set of values from a sensor calibration sheet, a fixed offset or multiplier, for conversion from one unit type to another etc. These are then added as calibrations, which can be dated to be used for set periods, on each sensor belonging to the blueprint. See the quick guide data offsets for how to remove steps in data.
Outputs
Outputs are the calculated result of your inputs and calibration factors. This can be as simple as the input or a complex formula using the Javascript Math library
These can also have an engineering unit associated with them that is shown when presenting the readings in charts, readings tables, map labels etc.
Aggregations
Outputs can either be their own formula or an aggregation of another output. Aggregations are a way to apply special functions to intervals of data such as an average over a 24 hour period.
Function
There are a number of functions to choose from: average, min, max, median, total, range, rate of change.
Interval
The interval can be in minutes, hours, or days. Each interval's starting time is 00:00. The interval's starting time can be offset.
Offset
The offset can only be in minutes or hours. For example, if a 12 hour average from 7 am to 7 pm is desired, the interval should be 12 hours and the offset should be 7 hours.
Interval datetime
The interval datetime determines whether the datetime should be at the start or the end of the interval. For example, if we have an aggregation with a 24 hour interval, the datetime range for one of our intervals could start at 2024-06-23 00:00 and end at 2024-06-24 00:00. Since a reading is created for each interval, if the interval datetime is set to start then reading datetime for that interval will be 2024-06-23 00:00, and conversely if the interval datetime is set to end then the reading datetime for that interval will be 2024-06-24 00:00.
Fields
Fields of various types can be added to a blueprint to record additional context around a sensor installation. Types can be text, text blocks, numbers or users.
Each sensor of that type can then have the information added under the sensor fields.
These can be used in dashboard presentation and reporting, but also to ensure the correct information is captured during installation and context added to the sensor on the platform for reference.
Field Types
Different fields types allow for ease of capturing information and adding it to the sensor. These may be decided by the manufacturers recommendations or from the project requirements.
Text
Short text (>80 characters) e.g. site area, weather etc.
Text Blocks
A longer form paragraph of text to capture details e.g. location description, installation notes etc.
Numbers
Numeric details that are not used as a calibration but still need to be recorded e.g. ambient temperature, depth etc.
Users
A user of the platform that can be added to the field e.g. installer, maintainer etc.
Datetime
Date and time associated with an event e.g. installation date, logger installed etc.
Charts
Multiple charts can be set up to best present the data. These can have multiple axis containing one or more of the sensor outputs.
If you want to see multiple sensors on the same chart see custom charts
| Label | Description |
|---|---|
| 1 | Charts for the blueprint. |
| 2 | Axes for the selected chart. |
| 3 | Position of the axis on the chart. |
| 4 | Max and min values of the selected axis, leave blank for autoscaling. |
| 5 | Sensor Output to display on the axis. |
| 6 | Colour of the line on the chart in hex. |
XY Charts
XY charts allow for profiles to be presented where the datetime of the readings are shown as labels
| Label | Description |
|---|---|
| 1 | XY charts for the blueprint, select the tab to configure as required. |
| 2 | Max and min values for each axis, leave blank for autoscaling. |
| 3 | Either value or parameter can be selected, a parameter is a blueprint output selected from a list, a value is a set number. |
| 4 | Drop down if parameter is selected or number field for a value. |
Dashboard
Tiles
On adding a tile you will have selection of various tile types.
Chart
Pick from the available sensors charts.
ChartXY
Select from the any of sensors setup XY charts.
Location
The location of the sensor shown on the map view.
Field
A single value field tile.
Layout
Resize
Using the arrows in the bottom right corner of added tiles the size can be altered
Move
By clicking and holding on the dashboard tiles can be repositioned, this will move other tiles out of the way.
