Differences

This shows you the differences between two versions of the page.

--- wiki:value [2017/05/06 04:47]
admin created
+++ wiki:value [2020/07/23 04:13] (current)
admin
@@ Line 5: / Line 5: @@
 Usage:
-''VALUE(variable, options)'' - see below for description.
+''VALUE(variable, options, [max])'' - see below for description.
 ===== Generic Variables (per device type) =====
-''VALUE('INC1_AE')'' - get the value of the current device's variable named INC1_AE.  Make sure to put variable names in single quotes if they contain spaces.
+''VALUE('INC1_AE')''
+Get the latest value of the current device's variable named INC1_AE.  Make sure to put variable names in single quotes if they contain spaces.
+===== Device - Specific Variables =====
-Device - Specific Variables
-For variables with spaces in the name, use single quotes.
-VALUE('My Variable')
 For device specific variables use a . to separate the device name:
-VALUE('My Device.My Value')
-You can also use VALUE('user_field1') to access the user defined field.
+''VALUE('My Device.My Value')''
-The following functions take two parameters.  The first parameter is the variable reference, as described above.
-The second parameter, [period] is a number between 0 and 7 with the following meaning:
+Get the value of the variable 'My Value' in the device 'My Device'
- - latest value
- - since midnight
+===== Special Variables =====
-- this week
-- this month
+You can also use VALUE('user_field1') to access the user defined field.  These values are entered when you edit a device and can contain device specific static information.
-- this year
+The list of special device-specific variables available are as follows:
-- selected period
+|**Variable** | **Description** |
-- last entry in period (only for VALUE function)
+|device_key | MAC ADDRESS |
+|remote_ip | IP Address of wattmon |
+|last_access | last update timestamp |
+|tz_offset | GMT Offset in seconds |
+|geo_lat | Latitude of device |
+|geo_lon | Longitude of device |
+|user_field1 | User Defined field 1 |
+===== Option Parameters =====
+The second parameter, [options] is a number and can be any of the following
+|0 | latest value (Default) |
+|5 | Period (in graph) - gets the value at the end of the selected segment in a graph |
+|7 | latest value for selected period |
+The third optional parameter [max] allows you to specify a maximum value for the data point, and if the value is greater than this the result will be 0.  This is to help in cases where incorrect data may come in from sensors are other devices.
+===== Example =====
+Get the latest value of two watt hour counters and scaled them to kWh
+''(VALUE('delta0_wh',7)+VALUE('delta1_wh',7)) / 1000''

Wattmon EMS

User Tools

Site Tools

Differences

Page Tools