DLI DC3 Object Model Reference
20210819T152642Z
Meter server object
objectmeter/
Object representing the meter server state and configuration
dot_inline_dotgraph_619.png

This object contains the following items:

valuesMeasured values
busesBus list
power_statusPower status
emergency_off_statusEmergency shutoff status
synchronizeSynchronize meter data
notificationsNotifications

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/meter/"

...

Sample JS request read command:

request.get({url:"meter/"},function(error,response,body) {console.log(body)});

<...>

Browse more samples

Measured values

mapmeter/values/
Values measured by meters
dot_inline_dotgraph_620.png

This map contains Measured value elements.

Sample CLI read command:

uom get "meter/values"

...

Sample uom library write command:

uom.meter.values=<...>

Browse more samples

Measured value

objectmeter/values/S/
Value measured by meter
dot_inline_dotgraph_621.png

The value is subject to the following constraints: not index of the value matches ^(|​.*|.*)$

Removing the object from its parent collection is denied if not custom flag

This object contains the following items:

nameValue name
valueValue, if any
expressionExpression, if any
customCustom flag
in_calibrationCalibration flag
supports_calibrationCalibration support flag
insert_calibration_pointInsert calibration point
commit_calibrationCommit calibration
quantityQuantity
busBus index, if any
internalInternal
log_historyLog history
history_parametersHistory log parameters
history_subsample_countHistory subsample count
history_time_stepHistory time step
get_historyGet value history
clear_historyClear value history
data_absence_alarm_levelData absence alarm level, if any
data_absence_alarm_periodData absence alarm period, if any
lowest_interval_alarm_levelLowest interval alarm level, if any
lowest_interval_alarm_periodLowest interval alarm period, if any
intervalsValue interval properties

Sample JS request write command (note that _measured_value is a variable):

request.put({url:"meter/values/"+_measured_value+"/",body:<...>});

Sample CLI deletion command (note that measured_value is a variable):

uom remove "meter/values/${measured_value}"

Browse more samples

See also Measured value: Value name

See also Measured value: Value, if any

See also Measured value: Expression, if any

See also Measured value: Custom flag

See also Measured value: Calibration flag

See also Measured value: Calibration support flag

See also Measured value: Insert calibration point

See also Measured value: Commit calibration

See also Measured value: Quantity

See also Measured value: Bus index, if any

See also Measured value: Internal

See also Measured value: Log history

See also Measured value: History log parameters

See also Measured value: History subsample count

See also Measured value: History time step

See also Measured value: Get value history

See also Measured value: Clear value history

See also Measured value: Data absence alarm level, if any

See also Measured value: Data absence alarm period, if any

See also Measured value: Lowest interval alarm level, if any

See also Measured value: Lowest interval alarm period, if any

See also Measured value: Value interval properties

Measured value: Value name

stringmeter/values/S/name/
Name of the measured value
dot_inline_dotgraph_622.png

Changing the value is denied if not administrative user

This string does not support direct modification if not custom flag.

This string represents a value in persistent storage.

Sample curl write command (note that :measured_value is a URL template argument):

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"DC voltage\"" "http://192.168.0.100/restapi/meter/values/:measured_value/name/"

Sample JS request read command (note that _measured_value is a variable):

request.get({url:"meter/values/"+_measured_value+"/name/"},function(error,response,body) {console.log(body)});

"Temperature"

Browse more samples

Measured value: Value, if any

sum (variant)meter/values/S/value/
Current value measured by meter, if any
dot_inline_dotgraph_623.png

Changing the value is denied if not administrative user

This sum does not support direct modification if all of the following is true:

This sum can change as if by itself or indirectly because of other actions.

Changes to this sum may have an effect besides setting value.

This sum can assume the following values:

numberValueCurrent value measured by meter
constant falseNo valueIndication that measurement is currently not being carried out

Sample requests read command (note that _measured_value is a variable):

print(requests.get('http://192.168.0.100/restapi/meter/values/'+_measured_value+'/value/',auth=auth,headers=headers).json())

8

Sample JS request read command (note that _measured_value is a variable):

request.get({url:"meter/values/"+_measured_value+"/value/"},function(error,response,body) {console.log(body)});

276

Browse more samples

Measured value: Expression, if any

sum (optional string)meter/values/S/expression/
Expression governing the value, if any
dot_inline_dotgraph_624.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum does not support direct modification if not custom flag.

This sum represents a value in persistent storage.

This sum can change as if by itself or indirectly because of other actions.

This sum can assume the following values:

constant nullVariableThe value can be modified arbitrarily
stringExpressionExpression governing the value

Sample requests write command (note that _measured_value is a variable):

requests.put('http://192.168.0.100/restapi/meter/values/'+_measured_value+'/expression/',auth=auth,headers=headers,json=None)

Sample JS request read command (note that _measured_value is a variable):

request.get({url:"meter/values/"+_measured_value+"/expression/"},function(error,response,body) {console.log(body)});

null

Browse more samples

Measured value: Custom flag

sum (boolean)meter/values/S/custom/
Flag indicating whether the value is custom
dot_inline_dotgraph_625.png

The value is unconditionally set to true on creation and doesn't have to be supplied (if it is, it must match)

Retrieving the value is denied if not administrative user

This sum does not support direct modification.

This sum represents a value in persistent storage.

This sum can assume the following values:

constant trueCustomThe value is custom and can be modified freely
constant falseBuilt-inThe value is built-in and only the hardware can modify it

Sample uom library read command (note that _measured_value is a variable):

print(uom.dump(uom.meter.values[_measured_value].custom))

{}

Sample JS request read command (note that _measured_value is a variable):

request.get({url:"meter/values/"+_measured_value+"/custom/"},function(error,response,body) {console.log(body)});

[]

Browse more samples

Measured value: Calibration flag

sum (boolean)meter/values/S/in_calibration/
Flag indicating whether the value is being calibrated
dot_inline_dotgraph_626.png

The value is subject to the following constraints: any of the following is true:

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum does not support direct modification if not calibration support flag.

This sum can change as if by itself or indirectly because of other actions if calibration support flag.

This sum can assume the following values:

constant trueCalibrationThe value is being calibrated (it can be updated to match external reference)
constant falseMeasurementThe value is being measured

Sample JS request read command (note that _measured_value is a variable):

request.get({url:"meter/values/"+_measured_value+"/in_calibration/"},function(error,response,body) {console.log(body)});

false

Sample JS request write command (note that _measured_value is a variable):

request.put({url:"meter/values/"+_measured_value+"/in_calibration/",body:true});

Browse more samples

Measured value: Calibration support flag

sum (boolean)meter/values/S/supports_calibration/
Flag indicating whether calibrating the value is supported
dot_inline_dotgraph_627.png

Retrieving the value is denied if not administrative user

This sum does not support direct modification.

This sum represents a value in persistent storage.

This sum can assume the following values:

constant trueSupportedThe value can be calibrated
constant falseNot supportedThere is no support for calibrating the value, or it does not make sense to

Sample JS request read command (note that _measured_value is a variable):

request.get({url:"meter/values/"+_measured_value+"/supports_calibration/"},function(error,response,body) {console.log(body)});

true

Sample requests read command (note that _measured_value is a variable):

print(requests.get('http://192.168.0.100/restapi/meter/values/'+_measured_value+'/supports_calibration/',auth=auth,headers=headers).json())

True

Browse more samples

Measured value: Insert calibration point

callmeter/values/S/insert_calibration_point/
Specify custom calibration point, possibly overriding measurements
dot_inline_dotgraph_628.png

Performing the function call is denied if any of the following is true:

The call accepts the following arguments:

  1. Kind: Standard, Identity or Current
  2. Value: number
  3. Weight: number
  4. Derivative: number
  5. Derivative weight: number

The call returns the following results:

  1. Empty result: null

Sample uom library invocation (note that _measured_value is a variable):

uom.meter.values[_measured_value].insert_calibration_point("standard",0,7.8,3.6,1.1)

(no output)

Sample JS request invocation (note that _measured_value is a variable):

request.post({url:"meter/values/"+_measured_value+"/insert_calibration_point/",body:["identity",8,8.5,-2.7,3.6]});

(no output)

Browse more samples

Kind

sum (enumerated string)meter/values/S/insert_calibration_point/arguments: 1/
Kind of calibration point

This sum does not correspond to an actual resource.

This sum can assume the following values:

constant "standard"StandardThe point supplies the calibrated value
constant "identity"IdentityAssume the calibration function is the identity in point
constant "current"CurrentAssume the calibration function keeps current value in point

Value

numbermeter/values/S/insert_calibration_point/arguments: 2/
Calibrated value
dot_inline_dotgraph_629.png

The value represents quantity.

This number does not correspond to an actual resource.

Weight

numbermeter/values/S/insert_calibration_point/arguments: 3/
Weight of the calibration point

The value represents ratio, which is dimensionless.

To convert to percents, multiply by 100.

To convert from percents, divide by 100.

The value is subject to the following constraints: the value is greater or equal to 0

This number does not correspond to an actual resource.

Derivative

numbermeter/values/S/insert_calibration_point/arguments: 4/
Derivative value in the calibration point

The value represents ratio, which is dimensionless.

To convert to percents, multiply by 100.

To convert from percents, divide by 100.

This number does not correspond to an actual resource.

Derivative weight

numbermeter/values/S/insert_calibration_point/arguments: 5/
Weight of derivative value in the calibration point

The value represents ratio, which is dimensionless.

To convert to percents, multiply by 100.

To convert from percents, divide by 100.

The value is subject to the following constraints: the value is greater or equal to 0

This number does not correspond to an actual resource.

Empty result

constant nullmeter/values/S/insert_calibration_point/results: 1/
No additional information available

This constant does not correspond to an actual resource.

Measured value: Commit calibration

callmeter/values/S/commit_calibration/
Save calibration data to persistent storage
dot_inline_dotgraph_630.png

Performing the function call is denied if any of the following is true:

The call has no arguments (supply empty tuple).

The call returns the following results:

  1. Empty result: null

Sample curl invocation (note that :measured_value is a URL template argument):

curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[]" "http://192.168.0.100/restapi/meter/values/:measured_value/commit_calibration/"

null

Sample JS request invocation (note that _measured_value is a variable):

request.post({url:"meter/values/"+_measured_value+"/commit_calibration/",body:[]});

(no output)

Browse more samples

Empty result

constant nullmeter/values/S/commit_calibration/results: 1/
No additional information available

This constant does not correspond to an actual resource.

Measured value: Quantity

stringmeter/values/S/quantity/
Quantity of the value
dot_inline_dotgraph_631.png

The value is subject to the following constraints: known quantities[the value]

Changing the value is denied if not administrative user

This string does not support direct modification if not custom flag.

This string represents a value in persistent storage.

Sample CLI read command (note that measured_value is a variable):

uom get "meter/values/${measured_value}/quantity"

"current"

Sample JS request read command (note that _measured_value is a variable):

request.get({url:"meter/values/"+_measured_value+"/quantity/"},function(error,response,body) {console.log(body)});

"voltage"

Browse more samples

Measured value: Bus index, if any

sum (optional number)meter/values/S/bus/
Index of bus being measured, if any
dot_inline_dotgraph_632.png

Changing the value is denied if not administrative user

This sum does not support direct modification if not custom flag.

This sum represents a value in persistent storage.

This sum can assume the following values:

constant nullUnspecifiedThe value is not related to a bus
numberBus indexIndex of bus being measuredbuses[the value]

Sample uom library write command (note that _measured_value is a variable):

uom.meter.values[_measured_value].bus=null

Sample uom library read command (note that _measured_value is a variable):

print(uom.dump(uom.meter.values[_measured_value].bus))

null

Browse more samples

Measured value: Internal

sum (boolean)meter/values/S/internal/
Flag indicating whether this value is internal
dot_inline_dotgraph_633.png

Changing the value is denied if not administrative user

This sum does not support direct modification if not custom flag.

This sum represents a value in persistent storage.

This sum can assume the following values:

constant trueInternalThe value is internal and should not matter to users
constant falseVisibleThe value should be visible to users

Sample curl write command (note that :measured_value is a URL template argument):

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "true" "http://192.168.0.100/restapi/meter/values/:measured_value/internal/"

Sample CLI write command (note that measured_value is a variable):

uom set "meter/values/${measured_value}/internal" "true"

Browse more samples

Measured value: Log history

sum (boolean)meter/values/S/log_history/
Flag indicating whether the value should be logged to the history
dot_inline_dotgraph_634.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample uom library write command (note that _measured_value is a variable):

uom.meter.values[_measured_value].log_history=true

Sample requests write command (note that _measured_value is a variable):

requests.put('http://192.168.0.100/restapi/meter/values/'+_measured_value+'/log_history/',auth=auth,headers=headers,json=False)

Browse more samples

Measured value: History log parameters

arraymeter/values/S/history_parameters/
Configuration of history logs sampling intervals and timespans
dot_inline_dotgraph_635.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This array is composite, i.e. is modified as a whole.

This array represents a value in persistent storage.

This array can change as if by itself or indirectly because of other actions.

This array contains History log elements.

Sample uom library read command (note that _measured_value is a variable):

print(uom.dump(uom.meter.values[_measured_value].history_parameters))

{{300,86400},{3600,1209600},{86400,31536000}}

Sample curl write command (note that :measured_value is a URL template argument):

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[[300,86400],[3600,1209600],[86400,31536000]]" "http://192.168.0.100/restapi/meter/values/:measured_value/history_parameters/"

Browse more samples

History log

tuplemeter/values/S/history_parameters/N/
History log settings

This tuple is a part of a composite value which is modified as a whole.

This tuple contains the following items:

1Interval
2Span

Sample requests read command (note that _measured_value and _history_log_index are variables):

print(requests.get('http://192.168.0.100/restapi/meter/values/'+_measured_value+'/history_parameters/'+str(_history_log_index)+'/',auth=auth,headers=headers).json())

[300, 86400]

Sample uom library write command (note that _measured_value and _history_log_index are variables):

uom.meter.values[_measured_value].history_parameters[_history_log_index]={300,86400}

Browse more samples

Interval

numbermeter/values/S/history_parameters/N/1/
Time interval between two consecutive history samples (changes will trigger history rebuilding and may cause adjustments to time span)
dot_inline_dotgraph_636.png

The value represents time, the standard unit of which is the second (s).

The value is subject to the following constraints: all of the following is true:

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number is a part of a composite value which is modified as a whole.

This number represents a value in persistent storage.

This number can change as if by itself or indirectly because of other actions.

Sample curl read command (note that :measured_value and :history_log_index are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/meter/values/:measured_value/history_parameters/:history_log_index/0/"

86400

Sample requests write command (note that _measured_value and _history_log_index are variables):

requests.put('http://192.168.0.100/restapi/meter/values/'+_measured_value+'/history_parameters/'+str(_history_log_index)+'/0/',auth=auth,headers=headers,json=86400)

Browse more samples

Span

numbermeter/values/S/history_parameters/N/2/
Time span covered by history fragment (changes will trigger history rebuilding)
dot_inline_dotgraph_637.png

The value represents time, the standard unit of which is the second (s).

The value is subject to the following constraints: all of the following is true:

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number is a part of a composite value which is modified as a whole.

This number represents a value in persistent storage.

This number can change as if by itself or indirectly because of other actions.

Sample uom library write command (note that _measured_value and _history_log_index are variables):

uom.meter.values[_measured_value].history_parameters[_history_log_index][2]=1209600

Sample CLI write command (note that measured_value and history_log_index are variables):

uom set "meter/values/${measured_value}/history_parameters/${history_log_index}/1" "86400"

Browse more samples

Measured value: History subsample count

numbermeter/values/S/history_subsample_count/
Number of measurements per history sample
dot_inline_dotgraph_638.png

The value represents count, the standard unit of which is the time (times).

The value is subject to the following constraints: all of the following is true:

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

Sample requests write command (note that _measured_value is a variable):

requests.put('http://192.168.0.100/restapi/meter/values/'+_measured_value+'/history_subsample_count/',auth=auth,headers=headers,json=1)

Sample curl write command (note that :measured_value is a URL template argument):

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "25" "http://192.168.0.100/restapi/meter/values/:measured_value/history_subsample_count/"

Browse more samples

Measured value: History time step

numbermeter/values/S/history_time_step/
Minimal amount of time between saved history samples (changes will trigger history rebuilding and may cause adjustments to history_parameters)
dot_inline_dotgraph_639.png

The value represents time, the standard unit of which is the second (s).

The value is subject to the following constraints: the value is greater than 0

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

Sample requests read command (note that _measured_value is a variable):

print(requests.get('http://192.168.0.100/restapi/meter/values/'+_measured_value+'/history_time_step/',auth=auth,headers=headers).json())

24

Sample requests write command (note that _measured_value is a variable):

requests.put('http://192.168.0.100/restapi/meter/values/'+_measured_value+'/history_time_step/',auth=auth,headers=headers,json=14)

Browse more samples

Value history record: Value history

arraymeter/values/S/get_history/results: 1/3/
Historical data points

This array does not correspond to an actual resource.

This array contains Data point, if any elements.

Data point, if any

sum (variant)meter/values/S/get_history/results: 1/3/N/
Historical data point, if any
dot_inline_dotgraph_640.png

This sum does not correspond to an actual resource.

This sum can assume the following values:

numberData pointHistorical data point, whose corresponding time is determined by array position
constant falseMissing dataIndication that data for the time determined by array position could not be found

Measured value: Get value history

callmeter/values/S/get_history/
Get history of values over a specific time range
dot_inline_dotgraph_641.png

Performing the function call is denied if not administrative user

The call accepts the following arguments:

  1. Data start time: number
  2. Data end time: number
  3. Data time step: number

The call returns the following results:

  1. Value history record: (number,number,array of "Data point or Missing data")

Sample curl invocation (note that :measured_value is a URL template argument):

curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[1566096258,1566098058,900]" "http://192.168.0.100/restapi/meter/values/:measured_value/get_history/"

[1566095400,900,[false,108]]

Sample CLI invocation (note that measured_value is a variable):

uom invoke "meter/values/${measured_value}/get_history" "1583566690" "1583566750" "60"

[1583566680,60,[105]]

Browse more samples

Data start time

numbermeter/values/S/get_history/arguments: 1/
Requested timestamp of the first data point to retrieve

The value represents time, the standard unit of which is the second (s).

This number does not correspond to an actual resource.

Data end time

numbermeter/values/S/get_history/arguments: 2/
Requested timestamp of the last data point to retrieve

The value represents time, the standard unit of which is the second (s).

This number does not correspond to an actual resource.

Data time step

numbermeter/values/S/get_history/arguments: 3/
Requested time step between succeeding data points

The value represents time, the standard unit of which is the second (s).

The value is subject to the following constraints: the value is greater or equal to 0

This number does not correspond to an actual resource.

Value history record

tuplemeter/values/S/get_history/results: 1/
Historical measured values
dot_inline_dotgraph_642.png

This tuple does not correspond to an actual resource.

This tuple contains the following items:

1Data start time
2Data time step
3Value history

Data start time

numbermeter/values/S/get_history/results: 1/1/
Timestamp of the first retrieved historical data point (may differ from requested start timestamp)

The value represents time, the standard unit of which is the second (s).

This number does not correspond to an actual resource.

Data time step

numbermeter/values/S/get_history/results: 1/2/
Time step between succeeding retrieved historical data points (may differ from requested time step)

The value represents time, the standard unit of which is the second (s).

The value is subject to the following constraints: the value is greater or equal to 0

This number does not correspond to an actual resource.

See also Value history record: Value history

Measured value: Clear value history

callmeter/values/S/clear_history/
Clear the complete history of values, and reset value to zero
dot_inline_dotgraph_643.png

Performing the function call is denied if not administrative user

The call has no arguments (supply empty tuple).

The call returns the following results:

  1. Empty result: null

Sample JS request invocation (note that _measured_value is a variable):

request.post({url:"meter/values/"+_measured_value+"/clear_history/",body:[]});

(no output)

Sample curl invocation (note that :measured_value is a URL template argument):

curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[]" "http://192.168.0.100/restapi/meter/values/:measured_value/clear_history/"

null

Browse more samples

Empty result

constant nullmeter/values/S/clear_history/results: 1/
No additional information available

This constant does not correspond to an actual resource.

Measured value: Data absence alarm level, if any

sum (optional number)meter/values/S/data_absence_alarm_level/
Alarm level for absence of data, if any
dot_inline_dotgraph_644.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant nullNoneNo alarm is generated on absence of data
numberData absence alarm levelAlarm level for absence of data

Sample CLI read command (note that measured_value is a variable):

uom get "meter/values/${measured_value}/data_absence_alarm_level"

null

Sample curl write command (note that :measured_value is a URL template argument):

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "null" "http://192.168.0.100/restapi/meter/values/:measured_value/data_absence_alarm_level/"

Browse more samples

Measured value: Data absence alarm period, if any

sum (optional number)meter/values/S/data_absence_alarm_period/
The time interval after which data absence alarm events should be repeated, if any
dot_inline_dotgraph_645.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant nullNoneThe data absence alarm event is generated only once on data loss and is not repeated
numberData absence alarm periodThe time interval after which data absence alarm events should be repeatedthe value is greater than 0

Sample curl write command (note that :measured_value is a URL template argument):

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "null" "http://192.168.0.100/restapi/meter/values/:measured_value/data_absence_alarm_period/"

Sample requests write command (note that _measured_value is a variable):

requests.put('http://192.168.0.100/restapi/meter/values/'+_measured_value+'/data_absence_alarm_period/',auth=auth,headers=headers,json=None)

Browse more samples

Measured value: Lowest interval alarm level, if any

sum (optional number)meter/values/S/lowest_interval_alarm_level/
Alarm level for the lowest value interval, if any
dot_inline_dotgraph_646.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant nullNoneNo alarm is generated for the lowest value interval
numberLowest interval alarm levelAlarm level for the lowest value interval

Sample CLI write command (note that measured_value is a variable):

uom set "meter/values/${measured_value}/lowest_interval_alarm_level" "6"

Sample requests read command (note that _measured_value is a variable):

print(requests.get('http://192.168.0.100/restapi/meter/values/'+_measured_value+'/lowest_interval_alarm_level/',auth=auth,headers=headers).json())

1

Browse more samples

Measured value: Lowest interval alarm period, if any

sum (optional number)meter/values/S/lowest_interval_alarm_period/
The time interval after which lowest interval alarm events should be repeated, if any
dot_inline_dotgraph_647.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant nullNoneThe alarm event is generated only once at lowest interval entry and is not repeated while the value is in the interval
numberLowest interval alarm periodThe time interval after which lowest interval alarm events should be repeatedthe value is greater than 0

Sample requests write command (note that _measured_value is a variable):

requests.put('http://192.168.0.100/restapi/meter/values/'+_measured_value+'/lowest_interval_alarm_period/',auth=auth,headers=headers,json=None)

Sample CLI write command (note that measured_value is a variable):

uom set "meter/values/${measured_value}/lowest_interval_alarm_period" "6"

Browse more samples

Measured value: Value interval properties

arraymeter/values/S/intervals/
Properties defining intervals of the value and their alarm levels
dot_inline_dotgraph_648.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This array is composite, i.e. is modified as a whole.

This array contains Interval configuration elements.

Sample CLI interval configuration creation command (note that measured_value is a variable):

uom insert "meter/values/${measured_value}/intervals/0" "{\"lower_bound_bottom\":690,\"alarm_level\":null,\"lower_bound_top\":701,\"alarm_period\":null}"

Sample uom library read command (note that _measured_value is a variable):

print(uom.dump(uom.meter.values[_measured_value].intervals))

Browse more samples

Interval configuration

objectmeter/values/S/intervals/N/
Configuration of a value interval

This object is a part of a composite value which is modified as a whole.

This object contains the following items:

lower_bound_bottomLower bound bottom
lower_bound_topLower bound top
alarm_levelAlarm level, if any
alarm_periodAlarm period, if any

Sample uom library read command (note that _measured_value and _interval_configuration_index are variables):

print(uom.dump(uom.meter.values[_measured_value].intervals[_interval_configuration_index]))

{alarm_level=null,alarm_period=6,lower_bound_bottom=33.25,lower_bound_top=33.75}

Sample JS request deletion command (note that _measured_value and _interval_configuration_index are variables):

request.delete({url:"meter/values/"+_measured_value+"/intervals/"+_interval_configuration_index.toString()+"/"});

Browse more samples

Lower bound bottom

numbermeter/values/S/intervals/N/lower_bound_bottom/
The bottom of the lower bound of this interval; value must be lower to be considered outside this interval
dot_inline_dotgraph_649.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number is a part of a composite value which is modified as a whole.

This number represents a value in persistent storage.

Sample CLI write command (note that measured_value and interval_configuration_index are variables):

uom set "meter/values/${measured_value}/intervals/${interval_configuration_index}/lower_bound_bottom" "7.8378378378378"

Sample curl write command (note that :measured_value and :interval_configuration_index are URL template arguments):

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "18.348348348348" "http://192.168.0.100/restapi/meter/values/:measured_value/intervals/:interval_configuration_index/lower_bound_bottom/"

Browse more samples

Lower bound top

numbermeter/values/S/intervals/N/lower_bound_top/
The top of the lower bound of this interval; value must be higher to be considered inside this interval
dot_inline_dotgraph_650.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number is a part of a composite value which is modified as a whole.

This number represents a value in persistent storage.

Sample requests read command (note that _measured_value and _interval_configuration_index are variables):

print(requests.get('http://192.168.0.100/restapi/meter/values/'+_measured_value+'/intervals/'+str(_interval_configuration_index)+'/lower_bound_top/',auth=auth,headers=headers).json())

600

Sample JS request read command (note that _measured_value and _interval_configuration_index are variables):

request.get({url:"meter/values/"+_measured_value+"/intervals/"+_interval_configuration_index.toString()+"/lower_bound_top/"},function(error,response,body) {console.log(body)});

40

Browse more samples

Alarm level, if any

sum (optional number)meter/values/S/intervals/N/alarm_level/
The level of importance assigned to this interval, if any
dot_inline_dotgraph_651.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum is a part of a composite value which is modified as a whole.

This sum represents a value in persistent storage.

This sum can assume the following values:

constant nullNoneNo alarm is generated for this value interval
numberAlarm levelThe level of importance assigned to this interval

Sample uom library read command (note that _measured_value and _interval_configuration_index are variables):

print(uom.dump(uom.meter.values[_measured_value].intervals[_interval_configuration_index].alarm_level))

1

Sample uom library write command (note that _measured_value and _interval_configuration_index are variables):

uom.meter.values[_measured_value].intervals[_interval_configuration_index].alarm_level=2

Browse more samples

Alarm period, if any

sum (optional number)meter/values/S/intervals/N/alarm_period/
The time interval after which alarm events should be repeated, if any
dot_inline_dotgraph_652.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum is a part of a composite value which is modified as a whole.

This sum represents a value in persistent storage.

This sum can assume the following values:

constant nullNoneThe alarm event is generated only once at interval entry and is not repeated while the value is in the interval
numberAlarm periodThe time interval after which alarm events should be repeatedthe value is greater than 0

Sample uom library write command (note that _measured_value and _interval_configuration_index are variables):

uom.meter.values[_measured_value].intervals[_interval_configuration_index].alarm_period=2

Sample uom library read command (note that _measured_value and _interval_configuration_index are variables):

print(uom.dump(uom.meter.values[_measured_value].intervals[_interval_configuration_index].alarm_period))

null

Browse more samples

Bus list

arraymeter/buses/
Attributes for buses
dot_inline_dotgraph_653.png

This array does not support direct modification.

This array contains Bus attributes elements.

Creating elements in this collection is not supported.

Sample requests read command:

print(requests.get('http://192.168.0.100/restapi/meter/buses/',auth=auth,headers=headers).json())

[{'power_status': True, 'name': 'Bus A', 'power_factor_percent': 100}, {'power_status': False, 'name': 'Bus B', 'power_factor_percent': 100}]

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/meter/buses/"

[{"power_status":true,"name":"Bus A","power_factor_percent":100},{"power_status":false,"name":"Bus B","power_factor_percent":100}]

Browse more samples

See also Bus list: Bus attributes

Bus list: Bus attributes

objectmeter/buses/N/
Attributes for a bus
dot_inline_dotgraph_654.png

The value is subject to the following constraints: buses[index of the value]

This object contains the following items:

nameName
power_statusPower status
power_factor_percentPower factor

Sample JS request write command (note that _bus_attributes_index is a variable):

request.put({url:"meter/buses/"+_bus_attributes_index.toString()+"/",body:{"power_status":false,"name":"Bus B","power_factor_percent":100}});

Sample CLI read command (note that bus_attributes_index is a variable):

uom get "meter/buses/${bus_attributes_index}"

{"power_status":false,"name":"Bus B","power_factor_percent":100}

Browse more samples

Name

stringmeter/buses/N/name/
User-visible name of this bus
dot_inline_dotgraph_655.png

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

Sample JS request read command (note that _bus_attributes_index is a variable):

request.get({url:"meter/buses/"+_bus_attributes_index.toString()+"/name/"},function(error,response,body) {console.log(body)});

"Bus B"

Sample curl write command (note that :bus_attributes_index is a URL template argument):

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"Bus A\"" "http://192.168.0.100/restapi/meter/buses/:bus_attributes_index/name/"

Browse more samples

Power status

sum (boolean)meter/buses/N/power_status/
Status of bus power
dot_inline_dotgraph_656.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum does not support direct modification.

This sum can change as if by itself or indirectly because of other actions.

This sum can assume the following values:

constant trueOnBus is powered
constant falseOffBus is not powered

Sample JS request read command (note that _bus_attributes_index is a variable):

request.get({url:"meter/buses/"+_bus_attributes_index.toString()+"/power_status/"},function(error,response,body) {console.log(body)});

true

Sample uom library read command (note that _bus_attributes_index is a variable):

print(uom.dump(uom.meter.buses[_bus_attributes_index].power_status))

false

Browse more samples

Power factor

numbermeter/buses/N/power_factor_percent/
Power factor for this bus
dot_inline_dotgraph_657.png

The value is subject to the following constraints: all of the following is true:

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

Sample JS request write command (note that _bus_attributes_index is a variable):

request.put({url:"meter/buses/"+_bus_attributes_index.toString()+"/power_factor_percent/",body:100});

Sample CLI read command (note that bus_attributes_index is a variable):

uom get "meter/buses/${bus_attributes_index}/power_factor_percent"

100

Browse more samples

Power status

sum (boolean)meter/power_status/
Status of unit power
dot_inline_dotgraph_658.png

Retrieving the value is denied if not administrative user

This sum does not support direct modification.

This sum can change as if by itself or indirectly because of other actions.

This sum can assume the following values:

constant trueMainsUnit is powered from at least one bus, outlets can be driven
constant falseBatteryUnit is powered from the battery only, outlets cannot be driven, unit shutdown expected

Sample requests read command:

print(requests.get('http://192.168.0.100/restapi/meter/power_status/',auth=auth,headers=headers).json())

True

Sample JS request read command:

request.get({url:"meter/power_status/"},function(error,response,body) {console.log(body)});

true

Browse more samples

Emergency shutoff status

sum (optional boolean)meter/emergency_off_status/
Status of emergency shutoff
dot_inline_dotgraph_659.png

Retrieving the value is denied if not administrative user

This sum does not support direct modification.

This sum can change as if by itself or indirectly because of other actions.

This sum can assume the following values:

constant trueActiveEmergency shutoff active, all outlets off
constant falseInactiveEmergency shutoff inactive, normal outlet operation
constant nullUnknownEmergency shutoff is in an unknown state, probably due to power failure, all outlets likely off

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/meter/emergency_off_status/"

false

Sample requests read command:

print(requests.get('http://192.168.0.100/restapi/meter/emergency_off_status/',auth=auth,headers=headers).json())

False

Browse more samples

Synchronize meter data

callmeter/synchronize/
Saves meter data to persistent storage expressly (synchronization takes place periodically even without this call)
dot_inline_dotgraph_660.png

Performing the function call is denied if not administrative user

The call has no arguments (supply empty tuple).

The call returns the following results:

  1. Empty result: null

Sample JS request invocation:

request.post({url:"meter/synchronize/",body:[]});

(no output)

Sample CLI invocation:

uom invoke "meter/synchronize"

(no output)

Browse more samples

Empty result

constant nullmeter/synchronize/results: 1/
No additional information available

This constant does not correspond to an actual resource.

Notifications

objectmeter/notifications/
Meter status notifications
dot_inline_dotgraph_661.png

Retrieving the value is denied if not administrative user

This object does not support direct modification.

This object contains the following items:

parameter_kindsParameter kinds
eventsEvents

Sample uom library read command:

print(uom.dump(uom.meter.notifications))

<...>

Sample requests read command:

print(requests.get('http://192.168.0.100/restapi/meter/notifications/',auth=auth,headers=headers).json())

<...>

Browse more samples

See also Notifications: Parameter kinds

Events

mapmeter/notifications/events/
Event templates
dot_inline_dotgraph_662.png

Retrieving the value is denied if not administrative user

This map is composite, i.e. is modified as a whole.

This map does not support direct modification.

This map contains Event elements.

Creating elements in this collection is not supported.

Sample CLI read command:

uom get "meter/notifications/events"

...

Sample JS request read command:

request.get({url:"meter/notifications/events/"},function(error,response,body) {console.log(body)});

<...>

Browse more samples

See also Events: Event

Notifications: Parameter kinds

objectmeter/notifications/parameter_kinds/
Kinds of event parameters

This object does not correspond to an actual resource.

This object contains the following items:

bus_indexBus index
bus_nameBus name
bus_poweredBus power status
poweredPower status
emergency_offEmergency shutoff status
value_idValue identifier
value_nameValue name
value_alarm_levelValue alarm level
value_alarm_repeatedValue alarm repeat count, if any
value_alarm_durationValue alarm duration

Bus index

numbermeter/notifications/parameter_kinds/bus_index/
Index of the bus

Bus name

stringmeter/notifications/parameter_kinds/bus_name/
Name of the bus

Bus power status

sum (boolean)meter/notifications/parameter_kinds/bus_powered/
Status of bus power

This sum can assume the following values:

constant truePoweredThe bus is powered
constant falseNot poweredThe bus is not powered

Power status

sum (boolean)meter/notifications/parameter_kinds/powered/
Status of unit power

This sum can assume the following values:

constant trueMainsThe unit is running on mains
constant falseBatteryThe unit is running on battery

Emergency shutoff status

sum (boolean)meter/notifications/parameter_kinds/emergency_off/
Status of emergency shutoff

This sum can assume the following values:

constant trueActiveAll outlets off
constant falseInactiveNormal outlet operation

Value identifier

stringmeter/notifications/parameter_kinds/value_id/
Identifier of the value

Value name

stringmeter/notifications/parameter_kinds/value_name/
Name of the value

Value alarm level

numbermeter/notifications/parameter_kinds/value_alarm_level/
Alarm level associated with the value

Value alarm repeat count, if any

sum (optional number)meter/notifications/parameter_kinds/value_alarm_repeated/
Number of consecutive times this alarm has been sent, if any

This sum can assume the following values:

constant nullInitial alarmThe value has just entered the interval
numberValue alarm repeat countNumber of consecutive times this alarm has been sent

all of the following is true:

Value alarm duration

numbermeter/notifications/parameter_kinds/value_alarm_duration/
Amount of time the value has been at this alarm level

The value represents time, the standard unit of which is the second (s).

The value is subject to the following constraints: the value is greater or equal to 0

Event parameters: Event parameter

objectmeter/notifications/events/S/parameters/N/
Properties of a parameter associated with the event

This object is a part of a composite value which is modified as a whole.

This object contains the following items:

idIdentifier
has_fixed_valueFixed value flag
fixed_valueFixed value

Sample JS request read command (note that _event and _event_parameter_index are variables):

request.get({url:"meter/notifications/events/"+_event+"/parameters/"+_event_parameter_index.toString()+"/"},function(error,response,body) {console.log(body)});

{"fixed_value":false,"has_fixed_value":true,"id":"emergency_off"}

Sample curl read command (note that :event and :event_parameter_index are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/meter/notifications/events/:event/parameters/:event_parameter_index/"

{"fixed_value":null,"has_fixed_value":false,"id":"value_id"}

Browse more samples

Identifier

stringmeter/notifications/events/S/parameters/N/id/
Parameter identifier
dot_inline_dotgraph_663.png

The value is subject to the following constraints: parameter kinds[the value]

Retrieving the value is denied if not administrative user

This string is a part of a composite value which is modified as a whole.

This string does not support direct modification.

Sample requests read command (note that _event and _event_parameter_index are variables):

print(requests.get('http://192.168.0.100/restapi/meter/notifications/events/'+_event+'/parameters/'+str(_event_parameter_index)+'/id/',auth=auth,headers=headers).json())

'value_alarm_duration'

Sample curl read command (note that :event and :event_parameter_index are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/meter/notifications/events/:event/parameters/:event_parameter_index/id/"

"value_alarm_duration"

Browse more samples

Fixed value flag

sum (boolean)meter/notifications/events/S/parameters/N/has_fixed_value/
Flag indicating that the parameter's value for this event is fixed
dot_inline_dotgraph_664.png

Retrieving the value is denied if not administrative user

This sum is a part of a composite value which is modified as a whole.

This sum does not support direct modification.

This sum can assume the following values:

constant trueFixedThe value is fixed
constant falseVariableThe value is variable

Sample JS request read command (note that _event and _event_parameter_index are variables):

request.get({url:"meter/notifications/events/"+_event+"/parameters/"+_event_parameter_index.toString()+"/has_fixed_value/"},function(error,response,body) {console.log(body)});

false

Sample curl read command (note that :event and :event_parameter_index are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/meter/notifications/events/:event/parameters/:event_parameter_index/has_fixed_value/"

false

Browse more samples

Fixed value

sum (variant)meter/notifications/events/S/parameters/N/fixed_value/
Fixed parameter value for this particular event
dot_inline_dotgraph_665.png

Retrieving the value is denied if not administrative user

This sum is a part of a composite value which is modified as a whole.

This sum does not support direct modification.

This sum can assume the following values:

constant nullNullNull
constant trueTrueTrue
constant falseFalseFalse
stringStringThis string
numberNumberThis number

Sample JS request read command (note that _event and _event_parameter_index are variables):

request.get({url:"meter/notifications/events/"+_event+"/parameters/"+_event_parameter_index.toString()+"/fixed_value/"},function(error,response,body) {console.log(body)});

null

Sample uom library read command (note that _event and _event_parameter_index are variables):

print(uom.dump(uom.meter.notifications.events[_event].parameters[_event_parameter_index].fixed_value))

false

Browse more samples

Events: Event

objectmeter/notifications/events/S/
Event template
dot_inline_dotgraph_666.png

This object is a part of a composite value which is modified as a whole.

This object contains the following items:

message_templateMessage template
severitySeverity
parametersEvent parameters

Sample requests write command (note that _event is a variable):

requests.put('http://192.168.0.100/restapi/meter/notifications/events/'+_event+'/',auth=auth,headers=headers,json={'severity': 5, 'message_template': ['emergency shutoff activated, all outlets off'], 'parameters': [{'fixed_value': True, 'has_fixed_value': True, 'id': 'emergency_off'}]})

Sample uom library read command (note that _event is a variable):

print(uom.dump(uom.meter.notifications.events[_event]))

{message_template={"running on battery"},parameters={{fixed_value=false,has_fixed_value=true,id="powered"}},severity=5}

Browse more samples

Message template

arraymeter/notifications/events/S/message_template/
Template for human-readable message generation
dot_inline_dotgraph_667.png

Retrieving the value is denied if not administrative user

This array is a part of a composite value which is modified as a whole.

This array does not support direct modification.

This array contains Message template element elements.

Creating elements in this collection is not supported.

Sample JS request read command (note that _event is a variable):

request.get({url:"meter/notifications/events/"+_event+"/message_template/"},function(error,response,body) {console.log(body)});

[0," is at alarm level ",1," for ",2," seconds"]

Sample requests read command (note that _event is a variable):

print(requests.get('http://192.168.0.100/restapi/meter/notifications/events/'+_event+'/message_template/',auth=auth,headers=headers).json())

['bus ', 0, ' (', 1, ') is not powered']

Browse more samples

Message template element

sum (variant)meter/notifications/events/S/message_template/N/
Element of human-readable message template
dot_inline_dotgraph_668.png

Retrieving the value is denied if not administrative user

This sum is a part of a composite value which is modified as a whole.

This sum does not support direct modification.

This sum can assume the following values:

stringStringFixed string
numberParameterIndex of message parameter to insertevent parameters[the value]

Sample curl read command (note that :event and :message_template_element_index are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/meter/notifications/events/:event/message_template/:message_template_element_index/"

"emergency shutoff status unknown due to power loss"

Sample requests read command (note that _event and _message_template_element_index are variables):

print(requests.get('http://192.168.0.100/restapi/meter/notifications/events/'+_event+'/message_template/'+str(_message_template_element_index)+'/',auth=auth,headers=headers).json())

') is not powered'

Browse more samples

Severity

sum (enumerated number)meter/notifications/events/S/severity/
Severity rating assigned to the event
dot_inline_dotgraph_669.png

Retrieving the value is denied if not administrative user

This sum is a part of a composite value which is modified as a whole.

This sum does not support direct modification.

This sum can assume the following values:

constant 1EmergencyTreat the event as an emergency
constant 2AlertTreat the event as an alert
constant 3CriticalTreat the event as critical
constant 4ErrorTreat the event as an error
constant 5WarningTreat the event as a warning
constant 6NoticeTreat the event as a notice
constant 7InformationalTreat the event as informational
constant 8DebugTreat the event as debugging-related

Sample CLI read command (note that event is a variable):

uom get "meter/notifications/events/${event}/severity"

7

Sample requests read command (note that _event is a variable):

print(requests.get('http://192.168.0.100/restapi/meter/notifications/events/'+_event+'/severity/',auth=auth,headers=headers).json())

5

Browse more samples

Event parameters

arraymeter/notifications/events/S/parameters/
Additional data associated with the event
dot_inline_dotgraph_670.png

Retrieving the value is denied if not administrative user

This array is a part of a composite value which is modified as a whole.

This array does not support direct modification.

This array contains Event parameter elements.

Creating elements in this collection is not supported.

Sample uom library read command (note that _event is a variable):

print(uom.dump(uom.meter.notifications.events[_event].parameters))

{{fixed_value=true,has_fixed_value=true,id="emergency_off"}}

Sample requests read command (note that _event is a variable):

print(requests.get('http://192.168.0.100/restapi/meter/notifications/events/'+_event+'/parameters/',auth=auth,headers=headers).json())

Browse more samples

See also Event parameters: Event parameter