Skip to content

Calculated Fields · Changes

Page history
More edits to the ARIS calculated field documentation authored by alaskamapscience's avatar alaskamapscience
Hide whitespace changes
Inline Side-by-side
SysAdmin/Calculated-Fields.md
View page @ 5ba6a62d
...@@ -89,10 +89,16 @@ The energy_parameter specifies which value will be read from the ARIS database: ...@@ -89,10 +89,16 @@ The energy_parameter specifies which value will be read from the ARIS database:
A value of 'EnergyQuantity' will be used by default if you don't include this parameter. A value of 'EnergyQuantity' will be used by default if you don't include this parameter.
####`energy_multiplier` Optional Parameter ####`energy_multiplier` Optional Parameter
The energy_multiplier is a multiplier that is used to scale the value that is read from the ARIS database if hte energy_parameter is 'EnergyQuantity'. If you don't include the parameter, a value of 1.0 will be used by default. The value that is stored is calculated as: The energy_multiplier is a multiplier that is used to scale the value that is read from the ARIS database when the energy_parameter is 'EnergyQuantity'. If you don't include the parameter, a value of 1.0 will be used by default. The value that is stored is calculated as:
[stored value] = [value from ARIS] / [hours in the read period] * energy_multiplier [stored value] = [value from ARIS] / [total hours in the read period] * energy_multiplier
####`expected_period_months` Optional Parameter ####`expected_period_months` Optional Parameter
In rare cases where the normal read period for the energy usage is other than one month, you can enter a different number of months using this parameter. This value is used for estimating the previous read date when the date wasn't set for the previous entry in ARIS, and for detecting missing data when the previous read date is more than 1.75 * [expected period months] earlier than the current read date. In rare cases where the normal read period for the energy usage is other than one month, you can enter a different number of months using this parameter. This value is used for estimating the previous read date when the date wasn't set for the previous entry in ARIS, and for detecting missing data when the previous read date is more than 1.75 * [expected period months] earlier than the current read date.
####Additional Required Settings
To use the BMON ARIS functionality you need to enter the URL, Username and Password in your installation's settings.py file. The required settings parameters are:
BMSAPP_ARIS_URL = 'https://arisapi.ahfc.us'
BMSAPP_ARIS_USERNAME = 'EnterUsernameHere'
BMSAPP_ARIS_PASSWORD = 'EnterPasswordHere'
## Converting On/Off Events into Runtime Fraction ## Converting On/Off Events into Runtime Fraction
Some sensors record the precise time of On and Off events. An example of such a sensor is a Monnit Dry Contact sensor. This sensor posts a reading every time its two contacts are closed or are opened, and the sensor is often used to record when a device turns on and turns off. As well as seeing the exact times that a device turned on and turned off, it is often useful to record the *percentage of time* that the device was on during evenly spaced intervals. Some sensors record the precise time of On and Off events. An example of such a sensor is a Monnit Dry Contact sensor. This sensor posts a reading every time its two contacts are closed or are opened, and the sensor is often used to record when a device turns on and turns off. As well as seeing the exact times that a device turned on and turned off, it is often useful to record the *percentage of time* that the device was on during evenly spaced intervals.
......