This article includes a description of the parameters that can be inserted into the platform, as well as the methodology that should be followed depending on the type of variable that wants to be inserted. Moreover, the algorithm that the software follows in order to calculate all the data frequencies, will be summarised. Finally, some additional information will be provided in order to solve possible problems that might arise.
The information will be divided into the following sections:
- Parameter definition
- Available parameters in the platform
- Inserting parameters into the platform - Available frequencies
- Calculations carried out after the insertion
- Management of the inserted parameters in the platform
- Visualisation of the parameters
- Golden Rules about parameters
1. Parameter definition
A parameter is what allows the platform to understand which type of consumption or variable a device is monitoring. It is really important to correctly define a parameter, as alerts, visualisation of the values and other functionalities will depend on it.
It is important to understand that one device can have a lot of parameters but each of them must be unique. This means that you may have 15 parameters in one device but all of them must be distinct. Then, if a gateway sends data from 2 gas sensors, in our platform this could not be represented by one device only, as it would cause the parameter gas to be repeated. Thus, each sensor should represent a different device, and both devices would then have the parameter gas.
2. Available parameters in the platform
Multiple parameters are accepted in the platform. The list of all the available parameters can be found in the following spreadsheet:
As it can be noticed, these parameters include both discrete and continuous variables. All of them are here represented by a code of 3 digits. However, when inserting data, depending on the type of variable that is being inserted, some more digits may be necessary.
Please go to section 3 to learn more about the insertion of parameters into the platform and the available frequencies for each of them.
3. Inserting parameters into the platform - Available frequencies
In order to understand how a parameter can be inserted into the platform, there needs to be a differentiation between the discrete and continuous variables.
Discrete variables are usually inserted using the 3-digits number shown in the excel file of the previous section. Only in some specific cases, data could be introduced as explained in subsection 3.2.
Continuous variables can be inserted in two different ways:
- Basic. The basic methodology implies data inserted cumulatively, i.e. every measure will be added to the previous one. This results in constantly increasing values and creates a link between the measures. This methodology is frequency-neutral, as it does not directly relate to a certain insertion frequency.
- Discrete. The discrete methodology implies that every measure will directly be uploaded into the platform, despite any prior measures. Every measure inserted into the platform will be independent of the others. This methodology directly relates to a specific insertion frequency.
3.1 Inserting with the basic methodology
While inserting through the basic methodology, it is not necessary to indicate to the software which is the frequency in which data is being uploaded, as the platform itself will identify it.
If we want to insert data through the basic methodology, the representation of each parameter will be the 3 digits that are represented in the excel file of section 2.
When inserting data using this methodology, the software will carry out several calculations so as to determine the specific consumption for different frequencies. Please go to section 4 in order to learn more about these calculations.
3.2 Inserting with the discrete methodology
While inserting through the discrete methodology, it is necessary to specify to the software which is the frequency in which the data is being uploaded. Moreover, an "operation" needs to be defined so as to understand the type of variable that is being monitored.
The code for discrete values' insertion is SSSFO, in which:
- SSS corresponds to the 3-digits representing the parameter, found in the excel file of section 2.
- F represents the frequency in which data is being inserted:
- O represents the operation that will determine how the data has been discretised:
Operation values from 1 to 4 are usually used for continuous variables, such as electricity or water consumption. In these cases, the operation would mean if we are inserting a discrete value of the consumed electricity, the average, the maximum or the minimum; Operation values 2 to 5 are usually used for discrete variables such as temperature or power. Note that operation 5 would represent an instantaneous value, different from sending average values of the variables during a certain period of time.
4. Calculations carried out after the insertion
- 5 minutes.
- 10 minutes.
4.1 Calculations for discrete data insertion
4.2 Calculations for basic data insertion
5. Management of the inserted parameters in the platform
Once the data has been introduced into the platform, in order to see and manage the parameters that are being introduced by your devices, you should go to Settings > Gateways (select a gateway and click to edit) > Devices > Parameters:
Once you click on Parameters, you will see the following window:
In this menu, you will be able to select and de-select all the parameters that have been received by your device.
In case you observe you are receiving a parameter that is not useful to analyse, you have two options:
- De-select this parameter, and it will no longer cost a datapoint to you.
- Derive the parameter into a more useful one, e.g. from pulses to gas volume or energy.
6. Visualisation of the parameters
Once all the parameters have been introduced into the platform and have been accepted by the user, it is time to visualise them in our analysis screens. Please find below a table with the parameters that can be visualised in every screen:
*Energy consumption refers to:
- Electricity consumption
- Gas (kWh, volume and normalised volume)
- Diesel (kWh and volume)
- Produced electricity
- Thermal energy (heating and cooling)
- Compressed air volume
- Liquified natural gas
**Please note that Power is included in the category "Others", together with Voltage or Current.
7. Golden Rules about parameters
- The main rule is that data inserted will prevail over data calculated.
- The second golden rule is that "discrete" data inserted will prevail over "basic" (or cumulative) data inserted.
- The third rule is that in order to apply cost to a certain consumption, the data needs at least a 30min minimum resolution. Cost is not stored (nor charged) as a datapoint, but calculated over a consumption.
- If discrete data is inserted outside its expected timestamp, it will be discarded. For example, if the platform expects data every 15 minutes but receives data at 13:59h instead of 14:00h, the reading will not be stored.
- Discrete data with daily frequency is expected at 00h.