Relay object

object	relay/
Object representing relay state and configuration

This object contains the following items:

name	Name
online	Online status
model	Model
version	Relay version number
outlets	Outlets
set_outlet_transient_states	Configure multiple transient states simultaneously
sequence_delay	Outlet ON sequence delay
min_sequence_delay	Minimal ON sequence delay
cycle_delay	Default outlet cycle delay
relatch	Brown-out re-latch delay
recovery_mode	Recovery mode
measurement_interval	Measurement interval
buses	Buses
ports	Ports
known_port_types	Port types
pins	Pins
nets	Nets
net_max_bits	Net max width
net_fractional_bits	Fractional bit count
net_poll_interval	Net poll interval
gpio_scan_interval	GPIO scan interval, if any
scan_catch_up_limit	GPIO scan interval catch-up limit
resources	Resources
fuses_enabled	Enable measurement-driven outlet control
min_relay_voltage	Minimum relay voltage, if any
fuse_relatch	Measurement-driven relatch timeout, if any
keypad_enabled	Keypad state
all_caps	LCD all-caps filter
beep_sequence	Beep sequence
backlight_sequence	Backlight sequence
lcd_columns	LCD column count
lcd_rows	LCD row count
user_lines	User LCD lines
user_message_force_timeout	User message force display timeout, if any
user_message_timeout	User message display timeout, if any
notifications	Notifications

Sample JS request read command:

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

⇒

<...>

Sample requests write command:

requests.put('http://192.168.0.100/restapi/relay/',auth=auth,headers=headers,json=<...>)

Browse more samples

Name

string	relay/name/
User-visible relay name

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

Sample curl read command:

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

⇒

"My controller"

Sample JS request read command:

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

⇒

"My controller"

Browse more samples

Online status

sum (variant)	relay/online/
Relay module online status

Retrieving the value is denied if not administrative user

This sum does not support direct modification if agent identifier is not equal to relay.

This sum can assume the following values:

constant true	Online	The relay module is online and fully operational, outlets can be switched on unless emergency shutoff is activated
constant "degraded"	Degraded	The relay module is online but outlets cannot be switched on due to low-power conditions
constant false	Offline	The relay module is offline, outlets cannot be switched on

Sample JS request read command:

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

⇒

true

Sample curl read command:

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

⇒

true

Browse more samples

Model

string	relay/model/
Relay model name

Retrieving the value is denied if not administrative user

This string does not support direct modification.

This string represents a value in persistent storage.

Sample requests read command:

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

⇒

'V222'

Sample CLI read command:

uom get "relay/model"

⇒

"V222"

Browse more samples

Relay version number

string	relay/version/
Relay core firmware version number

Retrieving the value is denied if not administrative user

This string does not support direct modification if agent identifier is not equal to relay.

Sample requests read command:

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

⇒

'1.8.1.0'

Sample uom library read command:

print(uom.dump(uom.relay.version))

⇒

"1.8.1.0"

Browse more samples

Outlets

array	relay/outlets/
Outlets controlled by the relay

This array does not support direct modification.

This array represents a value in persistent storage.

This array contains Outlet elements.

Creating elements in this collection is not supported.

Sample requests read command:

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

⇒

<...>

Sample curl read command:

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

⇒

...

Browse more samples

Outlet

object	relay/outlets/N/
Object representing outlet state and configuration

This object contains the following items:

name	Name
state	Configured state
transient_state	Transient state
physical_state	Physical state
locked	Lock state
critical	Critical
cycle_delay	Cycle delay override, if any
cycle	Cycle

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

uom get "relay/outlets/${outlet_index}"

⇒

{"state":true,"critical":false,"cycle_delay":null,"locked":true,"transient_state":false,"physical_state":false,"name":"outlet #6"}

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

requests.put('http://192.168.0.100/restapi/relay/outlets/'+str(_outlet_index)+'/',auth=auth,headers=headers,json={'state': False, 'critical': True, 'cycle_delay': None, 'locked': False, 'transient_state': True, 'physical_state': False, 'name': 'POE Injector'})

Browse more samples

See also Outlet: Name

See also Outlet: Configured state

See also Outlet: Transient state

See also Outlet: Physical state

See also Outlet: Lock state

See also Outlet: Critical

See also Outlet: Cycle delay override, if any

See also Outlet: Cycle

Outlet: Name

string	relay/outlets/N/name/
User-visible outlet name

Retrieving the value is denied if any of the following is true:

• outlet access permissions is equal to false
• all of the following is true:
  • outlet access permissions is not equal to true
  • not outlet access permissions[index of outlet]

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

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

print(requests.get('http://192.168.0.100/restapi/relay/outlets/'+str(_outlet_index)+'/name/',auth=auth,headers=headers).json())

⇒

'POE Injector'

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

uom set "relay/outlets/${outlet_index}/name" "\"Local alarm lights\""

Browse more samples

Outlet: Configured state

sum (boolean)	relay/outlets/N/state/
Saved configured state of the outlet. Cannot be changed if the outlet is locked

Retrieving the value is denied if any of the following is true:

• outlet access permissions is equal to false
• all of the following is true:
  • outlet access permissions is not equal to true
  • not outlet access permissions[index of outlet]

Changing the value is denied if any of the following is true:

• any of the following is true:
  • outlet access permissions is equal to false
  • all of the following is true:
    • outlet access permissions is not equal to true
    • not outlet access permissions[index of outlet]
• lock state

This sum represents a value in persistent storage.

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

This sum can assume the following values:

constant true	On	The outlet is powered
constant false	Off	The outlet is not powered

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

uom.relay.outlets[_outlet_index].state=false

Sample curl read command (note that :outlet_index is a URL template argument):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/relay/outlets/:outlet_index/state/"

⇒

false

Browse more samples

Outlet: Transient state

sum (boolean)	relay/outlets/N/transient_state/
Current expected state of the outlet. Cannot be changed if the outlet is locked

Retrieving the value is denied if any of the following is true:

• outlet access permissions is equal to false
• all of the following is true:
  • outlet access permissions is not equal to true
  • not outlet access permissions[index of outlet]

Changing the value is denied if any of the following is true:

• any of the following is true:
  • outlet access permissions is equal to false
  • all of the following is true:
    • outlet access permissions is not equal to true
    • not outlet access permissions[index of outlet]
• lock state

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

This sum can assume the following values:

constant true	On	The outlet is powered
constant false	Off	The outlet is not powered

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

request.put({url:"relay/outlets/"+_outlet_index.toString()+"/transient_state/",body:true});

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

uom set "relay/outlets/${outlet_index}/transient_state" "true"

Browse more samples

Outlet: Physical state

sum (boolean)	relay/outlets/N/physical_state/
Current actual state of the outlet

Retrieving the value is denied if any of the following is true:

• outlet access permissions is equal to false
• all of the following is true:
  • outlet access permissions is not equal to true
  • not outlet access permissions[index of outlet]

Changing the value is denied if agent identifier is not equal to relay

This sum does not support direct modification if agent identifier is not equal to relay.

This sum can assume the following values:

constant true	On	The outlet is powered
constant false	Off	The outlet is not powered

Sample curl read command (note that :outlet_index is a URL template argument):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/relay/outlets/:outlet_index/physical_state/"

⇒

true

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

print(uom.dump(uom.relay.outlets[_outlet_index].physical_state))

⇒

true

Browse more samples

Outlet: Lock state

sum (boolean)	relay/outlets/N/locked/
Indicates whether the outlet state is locked from keypad

Retrieving the value is denied if any of the following is true:

• outlet access permissions is equal to false
• all of the following is true:
  • outlet access permissions is not equal to true
  • not outlet access permissions[index of outlet]

Changing the value is denied if agent identifier is not equal to relay

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Locked	The outlet state cannot be changed
constant false	Unlocked	The outlet state can be changed

Sample curl read command (note that :outlet_index is a URL template argument):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/relay/outlets/:outlet_index/locked/"

⇒

true

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

print(uom.dump(uom.relay.outlets[_outlet_index].locked))

⇒

false

Browse more samples

Outlet: Critical

sum (boolean)	relay/outlets/N/critical/
Flag indicating whether the outlet is critical, and turning it off should ask for confirmation

Retrieving the value is denied if any of the following is true:

• outlet access permissions is equal to false
• all of the following is true:
  • outlet access permissions is not equal to true
  • not outlet access permissions[index of outlet]

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 true	Critical	Confirmation requested to change the outlet state
constant false	Noncritical	No confirmation is needed to change the outlet state

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

print(requests.get('http://192.168.0.100/restapi/relay/outlets/'+str(_outlet_index)+'/critical/',auth=auth,headers=headers).json())

⇒

True

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

uom.relay.outlets[_outlet_index].critical=true

Browse more samples

Outlet: Cycle delay override, if any

sum (optional number)	relay/outlets/N/cycle_delay/
Outlet cycle delay override, if any

Retrieving the value is denied if any of the following is true:

• outlet access permissions is equal to false
• all of the following is true:
  • outlet access permissions is not equal to true
  • not outlet access permissions[index of outlet]

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 null	Use default cycle delay	Use unit default cycle delay
number	Cycle delay override	Outlet cycle delay override	the value is greater than 0

Sample curl write command (note that :outlet_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 "6" "http://192.168.0.100/restapi/relay/outlets/:outlet_index/cycle_delay/"

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

uom get "relay/outlets/${outlet_index}/cycle_delay"

⇒

6

Browse more samples

Outlet: Cycle

call	relay/outlets/N/cycle/
Turns the outlet off, then on again after the cycle delay passes. Has no effect when the outlet is already off. Signals an error if the outlet is locked. Does not turn the outlet back on if it becomes locked

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

• any of the following is true:
  • outlet access permissions is equal to false
  • all of the following is true:
    • outlet access permissions is not equal to true
    • not outlet access permissions[index of outlet]
• lock state

The call has no arguments (supply empty tuple).

The call returns the following results:

1. Action performed: Started or No action taken

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

request.post({url:"relay/outlets/"+_outlet_index.toString()+"/cycle/",body:[]});

⇒

true

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

uom invoke "relay/outlets/${outlet_index}/cycle"

⇒

true

Browse more samples

Action performed

sum (boolean)	relay/outlets/N/cycle/results: 1/
Flag indicating whether the call affected the outlet state

This sum does not correspond to an actual resource.

This sum can assume the following values:

constant true	Started	The outlet was on and the cycle has started
constant false	No action taken	The outlet was off or already in a cycle, so the call had no effect

Configure multiple transient states simultaneously

call	relay/set_outlet_transient_states/
Change transient states of multiple outlets as simultaneously as possible, failing if one of them is not accessible

Performing the function call is denied if outlet access permissions is equal to false

The call accepts the following arguments:

1. Pin transient state configurations: array of "(number,On or Off)"

The call returns the following results:

1. Empty result: null

Sample requests invocation:

print(requests.post('http://192.168.0.100/restapi/relay/set_outlet_transient_states/',auth=auth,headers=headers,json=[[[0, True], [5, False], [6, False], [7, False]]]).json())

⇒

None

Sample CLI invocation:

uom invoke "relay/set_outlet_transient_states" "[]"

⇒

null

Browse more samples

Pin transient state configurations

array	relay/set_outlet_transient_states/arguments: 1/
Desired pin transient state configurations

The value is subject to the following constraints: 0 elements of all values of the value are distinct

This array does not correspond to an actual resource.

This array contains Pin transient state configuration elements.

See also Pin transient state configurations: Pin transient state configuration

Empty result

constant null	relay/set_outlet_transient_states/results: 1/
No additional information available

This constant does not correspond to an actual resource.

Pin transient state configurations: Pin transient state configuration

tuple	relay/set_outlet_transient_states/arguments: 1/N/
Desired pin transient state configuration

This tuple does not correspond to an actual resource.

This tuple contains the following items:

1	Outlet index
2	Transient state

Outlet index

number	relay/set_outlet_transient_states/arguments: 1/N/1/
Index of the outlet to be configured

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

• any of the following is true:
  • outlet access permissions is equal to true
  • outlet access permissions[the value]
• outlets[the value]
• not outlets[the value].locked

This number does not correspond to an actual resource.

Transient state

sum (boolean)	relay/set_outlet_transient_states/arguments: 1/N/2/
Desired actual state of the outlet

This sum does not correspond to an actual resource.

This sum can assume the following values:

constant true	On	The outlet is powered
constant false	Off	The outlet is not powered

Outlet ON sequence delay

number	relay/sequence_delay/
Time after switching an outlet on during which switching outlets on is delayed to prevent simultaneous inrush currents on power-on

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 minimal ON sequence delay

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

Sample CLI read command:

uom get "relay/sequence_delay"

⇒

10

Sample CLI write command:

uom set "relay/sequence_delay" "1"

Browse more samples

Minimal ON sequence delay

number	relay/min_sequence_delay/
The minimal time after switching an outlet on during which switching outlets on is delayed

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 support direct modification.

This number represents a value in persistent storage.

Sample uom library read command:

print(uom.dump(uom.relay.min_sequence_delay))

⇒

1

Sample JS request read command:

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

⇒

1

Browse more samples

Default outlet cycle delay

number	relay/cycle_delay/
Time between switching an outlet off and turning it back on during cycling, which allows the controlled device to really power down

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

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

Sample uom library write command:

uom.relay.cycle_delay=4

Sample CLI read command:

uom get "relay/cycle_delay"

⇒

5

Browse more samples

Brown-out re-latch delay

number	relay/relatch/
Time to wait before relatching relays on brown-out

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 CLI write command:

uom set "relay/relatch" "2"

Sample curl write command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "10" "http://192.168.0.100/restapi/relay/relatch/"

Browse more samples

Recovery mode

sum (enumerated number)	relay/recovery_mode/
Outlet power-off recovery state policy

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 0	All outlets off	All outlets remain powered off at power-up
constant 1	All outlets on	All outlets are switched on in sequence during power-up
constant 2	Pre-powerloss state	Outlets are returned to configured pre-powerloss state during power-up

Sample requests read command:

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

⇒

1

Sample JS request write command:

request.put({url:"relay/recovery_mode/",body:1});

Browse more samples

Measurement interval

number	relay/measurement_interval/
Time between meter value fetches

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 CLI read command:

uom get "relay/measurement_interval"

⇒

9

Sample requests write command:

requests.put('http://192.168.0.100/restapi/relay/measurement_interval/',auth=auth,headers=headers,json=8)

Browse more samples

Buses

array	relay/buses/
Buses powering the relay

This array does not support direct modification.

This array represents a value in persistent storage.

This array contains Bus elements.

Creating elements in this collection is not supported.

Sample uom library read command:

print(uom.dump(uom.relay.buses))

⇒

Sample CLI read command:

uom get "relay/buses"

⇒

Browse more samples

Bus

object	relay/buses/N/
Object representing bus state and configuration

This object contains the following items:

outlet_indices	Outlet list
voltage_affects_outlets	Voltage-affected outlets
min_voltage	Minimum voltage, if any
max_voltage	Maximum voltage, if any
current_affects_outlets	Current-affected outlets
max_current	Maximum current, if any

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

uom set "relay/buses/${bus_index}" "{\"outlet_indices\":[0,1,2,3],\"voltage_affects_outlets\":[1,2,3],\"max_current\":5,\"current_affects_outlets\":[0],\"max_voltage\":null,\"min_voltage\":60}"

Sample curl read command (note that :bus_index is a URL template argument):

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

⇒

{"outlet_indices":[0,1,2,3],"voltage_affects_outlets":[1,2,3],"max_current":5,"current_affects_outlets":[0],"max_voltage":null,"min_voltage":60}

Browse more samples

See also Bus: Outlet list

See also Bus: Voltage-affected outlets

See also Bus: Minimum voltage, if any

See also Bus: Maximum voltage, if any

See also Bus: Current-affected outlets

See also Bus: Maximum current, if any

Bus: Outlet list

array	relay/buses/N/outlet_indices/
List of outlets connected to the bus

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

This array does not support direct modification.

This array represents a value in persistent storage.

This array represents an unordered set (order of its elements doesn't matter, and each value should not be supplied more than once).

This array contains Outlet index elements.

Creating elements in this collection is not supported.

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

uom get "relay/buses/${bus_index}/outlet_indices"

⇒

[0,1,2,3]

Sample curl read command (note that :bus_index is a URL template argument):

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

⇒

[4,5,6,7]

Browse more samples

Outlet index

number	relay/buses/N/outlet_indices/N/
Index of outlet connected to the bus

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

• outlets[the value]
• outlet list are distinct

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

This number does not support direct modification.

This number represents a value in persistent storage.

Sample uom library read command (note that _bus_index and _outlet_index_index are variables):

print(uom.dump(uom.relay.buses[_bus_index].outlet_indices[_outlet_index_index]))

⇒

6

Sample CLI read command (note that bus_index and outlet_index_index are variables):

uom get "relay/buses/${bus_index}/outlet_indices/${outlet_index_index}"

⇒

4

Browse more samples

Bus: Voltage-affected outlets

array	relay/buses/N/voltage_affects_outlets/
List of outlets affected by over/undervoltage

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 represents an unordered set (order of its elements doesn't matter, and each value should not be supplied more than once).

This array contains Outlet list index elements.

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

uom.relay.buses[_bus_index].voltage_affects_outlets={0,1,2,3}

Sample uom library outlet list index creation command (note that _bus_index is a variable):

local composite=uom.copy(uom.relay.buses[_bus_index].voltage_affects_outlets)
uom.insert(composite,1,0)
uom.relay.buses[_bus_index].voltage_affects_outlets=composite

Browse more samples

Outlet list index

number	relay/buses/N/voltage_affects_outlets/N/
Index of outlet in the bus outlet list

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

• outlet list[the value]
• voltage-affected outlets are distinct

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.

Sample JS request read command (note that _bus_index and _outlet_list_index_index are variables):

request.get({url:"relay/buses/"+_bus_index.toString()+"/voltage_affects_outlets/"+_outlet_list_index_index.toString()+"/"},function(error,response,body) {console.log(body)});

⇒

3

Sample JS request deletion command (note that _bus_index and _outlet_list_index_index are variables):

request.delete({url:"relay/buses/"+_bus_index.toString()+"/voltage_affects_outlets/"+_outlet_list_index_index.toString()+"/"});

Browse more samples

Bus: Minimum voltage, if any

sum (optional number)	relay/buses/N/min_voltage/
The minimum voltage, below which the affected bus outlets are switched off, if any

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 null	No minimum voltage	Undervoltage doesn't affect any outlets
number	Minimum voltage	The minimum voltage, below which the affected bus outlets are switched off	the value is greater or equal to 0

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

request.put({url:"relay/buses/"+_bus_index.toString()+"/min_voltage/",body:60});

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

uom set "relay/buses/${bus_index}/min_voltage" "60"

Browse more samples

Bus: Maximum voltage, if any

sum (optional number)	relay/buses/N/max_voltage/
The maximum voltage, above which the affected bus outlets are switched off, if any

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 null	No maximum voltage	Overvoltage doesn't affect any outlets
number	Maximum voltage	The maximum voltage, above which the affected bus outlets are switched off	the value is greater or equal to 0

Sample curl read command (note that :bus_index is a URL template argument):

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

⇒

null

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

uom get "relay/buses/${bus_index}/max_voltage"

⇒

null

Browse more samples

Bus: Current-affected outlets

array	relay/buses/N/current_affects_outlets/
List of outlets affected by overcurrent

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 represents an unordered set (order of its elements doesn't matter, and each value should not be supplied more than once).

This array contains Outlet list index elements.

Sample curl write command (note that :bus_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 "[0]" "http://192.168.0.100/restapi/relay/buses/:bus_index/current_affects_outlets/"

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

request.get({url:"relay/buses/"+_bus_index.toString()+"/current_affects_outlets/"},function(error,response,body) {console.log(body)});

⇒

[0]

Browse more samples

Outlet list index

number	relay/buses/N/current_affects_outlets/N/
Index of outlet in the bus outlet list

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

• outlet list[the value]
• current-affected outlets are distinct

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.

Sample uom library read command (note that _bus_index and _outlet_list_index_index are variables):

print(uom.dump(uom.relay.buses[_bus_index].current_affects_outlets[_outlet_list_index_index]))

⇒

1

Sample curl read command (note that :bus_index and :outlet_list_index_index are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/relay/buses/:bus_index/current_affects_outlets/:outlet_list_index_index/"

⇒

0

Browse more samples

Bus: Maximum current, if any

sum (optional number)	relay/buses/N/max_current/
The maximum current, above which the affected bus outlets are switched off, if any

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 null	No maximum current	Overcurrent doesn't affect any outlets
number	Maximum current	The maximum current, above which the affected bus outlets are switched off	the value is greater or equal to 0

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

request.get({url:"relay/buses/"+_bus_index.toString()+"/max_current/"},function(error,response,body) {console.log(body)});

⇒

5

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

print(uom.dump(uom.relay.buses[_bus_index].max_current))

⇒

14

Browse more samples

Ports

map	relay/ports/
I/O ports attached to the relay

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This map does not support direct modification if agent identifier is not equal to relay.

This map contains I/O port elements.

Creating elements in this collection is not supported.

Sample requests read command:

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

⇒

{'uart_2js7': {'latest_received': {}, 'type': 'uart', 'name': 'uart_2js7', 'accept': {'d': True}, 'configuration': {'baudrate': '6224', 'char_size': '7'}}}

Sample curl read command:

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

⇒

Browse more samples

I/O port

object	relay/ports/S/
Object representing an I/O port and its channels

This object contains the following items:

name	Name
type	Type
configuration	Configuration
accept	Data reception mask
send	Send data
latest_received	Latest received data
get_receive_history	Get receive history
clear_receive_history	Clear received data history

Sample curl read command (note that :i_o_port is a URL template argument):

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

⇒

{"latest_received":{"d":"8E6B"},"type":"uart","name":"uart_cm92","accept":[],"configuration":[]}

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

uom set "relay/ports/${i_o_port}" "{\"latest_received\":{\"d\":\"9B1990\"},\"type\":\"uart\",\"name\":\"uart_lr6h2\",\"accept\":[],\"configuration\":{\"stop_bits\":\"1.5\",\"parity\":\"M\"}}"

Browse more samples

See also I/O port: Name

See also I/O port: Type

See also I/O port: Configuration

See also I/O port: Data reception mask

See also I/O port: Send data

See also I/O port: Latest received data

See also I/O port: Get receive history

See also I/O port: Clear received data history

I/O port: Name

string	relay/ports/S/name/
User-visible port name

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

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

print(uom.dump(uom.relay.ports[_i_o_port].name))

⇒

"uart_yp"

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

uom get "relay/ports/${i_o_port}/name"

⇒

"uart_4hbwy2f3pydv"

Browse more samples

I/O port: Type

string	relay/ports/S/type/
Port type

The value is subject to the following constraints: port types[the value]

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string does not support direct modification if agent identifier is not equal to relay.

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

uom get "relay/ports/${i_o_port}/type"

⇒

"uart"

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

print(uom.dump(uom.relay.ports[_i_o_port].type))

⇒

"uart"

Browse more samples

I/O port: Configuration

map	relay/ports/S/configuration/
Port configuration

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This map represents a value in persistent storage.

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

This map contains Configuration value elements.

Sample JS request configuration value creation command (note that _i_o_port is a variable):

request.put({url:"relay/ports/"+_i_o_port+"/configuration/char_size/",body:"7"});

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

print(uom.dump(uom.relay.ports[_i_o_port].configuration))

⇒

{baudrate="61739114926",stop_bits="1.5"}

Browse more samples

Configuration value

string	relay/ports/S/configuration/S/
Value of a configuration item

The value is subject to the following constraints: the value matches port types[type].data_items[index of the value].regexp

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

Sample uom library deletion command (note that _i_o_port and _configuration_value are variables):

uom.remove(uom.relay.ports[_i_o_port].configuration,_configuration_value)

Sample CLI deletion command (note that i_o_port and configuration_value are variables):

uom remove "relay/ports/${i_o_port}/configuration/${configuration_value}"

Browse more samples

I/O port: Data reception mask

map	relay/ports/S/accept/
Mask of channels to receive data from

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This map represents a value in persistent storage.

This map contains Enable elements.

Sample curl write command (note that :i_o_port 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 "[]" "http://192.168.0.100/restapi/relay/ports/:i_o_port/accept/"

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

uom get "relay/ports/${i_o_port}/accept"

⇒

[]

Browse more samples

Enable

constant true	relay/ports/S/accept/S/
Enable reception from this channel

The value is subject to the following constraints: port types[type].channels[index of the value]

Sample requests write command (note that _i_o_port and _enable are variables):

requests.put('http://192.168.0.100/restapi/relay/ports/'+_i_o_port+'/accept/'+_enable+'/',auth=auth,headers=headers,json={})

Sample JS request read command (note that _i_o_port and _enable are variables):

request.get({url:"relay/ports/"+_i_o_port+"/accept/"+_enable+"/"},function(error,response,body) {console.log(body)});

⇒

[]

Browse more samples

I/O port: Send data

call	relay/ports/S/send/
Write data to port's channels

Performing the function call is denied if not administrative user

The call accepts the following arguments:

1. Data: map of "string"

The call returns the following results:

1. Empty result: null

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

uom invoke "relay/ports/${i_o_port}/send"

⇒

null

Sample curl invocation (note that :i_o_port 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 "{\"d\":\"\"}" "http://192.168.0.100/restapi/relay/ports/:i_o_port/send/"

⇒

null

Browse more samples

Data

map	relay/ports/S/send/arguments: 1/
Data to write, indexed by channel

This map does not correspond to an actual resource.

This map contains Data string elements.

Data string

string	relay/ports/S/send/arguments: 1/S/
Channel send data

The value is subject to the following constraints: port types[type].channels[index of the value]

This string does not correspond to an actual resource.

Empty result

constant null	relay/ports/S/send/results: 1/
No additional information available

This constant does not correspond to an actual resource.

I/O port: Latest received data

map	relay/ports/S/latest_received/
Latest data received, indexed by channel

Retrieving the value is denied if not administrative user

Changing 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 if agent identifier is not equal to relay.

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

This map contains Data string elements.

Creating elements in this collection is not supported.

Sample curl read command (note that :i_o_port is a URL template argument):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/relay/ports/:i_o_port/latest_received/"

⇒

{"d":""}

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

uom get "relay/ports/${i_o_port}/latest_received"

⇒

[]

Browse more samples

Data string

string	relay/ports/S/latest_received/S/
Channel received data

The value is subject to the following constraints: port types[type].channels[index of the value]

Retrieving the value is denied if not administrative user

Changing 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 if agent identifier is not equal to relay.

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

Sample CLI read command (note that i_o_port and data_string are variables):

uom get "relay/ports/${i_o_port}/latest_received/${data_string}"

⇒

[]

Sample uom library read command (note that _i_o_port and _data_string are variables):

print(uom.dump(uom.relay.ports[_i_o_port].latest_received[_data_string]))

⇒

""

Browse more samples

Received data element: Reception time

number	relay/ports/S/get_receive_history/results: 1/N/1/
Timestamp of the received data

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

This number does not correspond to an actual resource.

Received data element: Received data

map	relay/ports/S/get_receive_history/results: 1/N/2/
Historical data received, indexed by channel

This map does not correspond to an actual resource.

This map contains Data string elements.

Data string

string	relay/ports/S/get_receive_history/results: 1/N/2/S/
Channel received data

The value is subject to the following constraints: port types[type].channels[index of the value]

This string does not correspond to an actual resource.

This string does not support direct modification if agent identifier is not equal to relay.

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

I/O port: Get receive history

call	relay/ports/S/get_receive_history/
Get history of data received over a specific time range

Performing the function call is denied if not administrative user

The call accepts the following arguments:

1. Data start time, if any: Beginning of time or Data start time
2. Data end time, if any: Now or Data end time

The call returns the following results:

1. Data history: array of "(number,map of "string")"

Sample curl invocation (note that :i_o_port 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 "[1234484856,null]" "http://192.168.0.100/restapi/relay/ports/:i_o_port/get_receive_history/"

⇒

[[1234515175,{"d":""}]]

Sample requests invocation (note that _i_o_port is a variable):

print(requests.post('http://192.168.0.100/restapi/relay/ports/'+_i_o_port+'/get_receive_history/',auth=auth,headers=headers,json=[1234554112, None]).json())

⇒

Browse more samples

Data start time, if any

sum (optional number)	relay/ports/S/get_receive_history/arguments: 1/
Requested timestamp of the first data element to retrieve, if any

This sum does not correspond to an actual resource.

This sum can assume the following values:

constant null	Beginning of time	Return data starting from the oldest available
number	Data start time	Requested timestamp of the first data element to retrieve

Data end time, if any

sum (optional number)	relay/ports/S/get_receive_history/arguments: 2/
Requested timestamp of the last data element to retrieve, if any

This sum does not correspond to an actual resource.

This sum can assume the following values:

constant null	Now	Return data up to the most recent available
number	Data end time	Requested timestamp of the last data element to retrieve

Data history

array	relay/ports/S/get_receive_history/results: 1/
Historical received data elements

This array does not correspond to an actual resource.

This array contains Received data element elements.

Received data element

tuple	relay/ports/S/get_receive_history/results: 1/N/
Historical data element received

This tuple does not correspond to an actual resource.

This tuple contains the following items:

1	Reception time
2	Received data

See also Received data element: Reception time

See also Received data element: Received data

I/O port: Clear received data history

call	relay/ports/S/clear_receive_history/
Clear the complete history of received data

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 curl invocation (note that :i_o_port 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/relay/ports/:i_o_port/clear_receive_history/"

⇒

null

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

print(uom.dump(uom.relay.ports[_i_o_port].clear_receive_history()))

⇒

null

Browse more samples

Empty result

constant null	relay/ports/S/clear_receive_history/results: 1/
No additional information available

This constant does not correspond to an actual resource.

Port types

map	relay/known_port_types/
Known I/O port types

Retrieving the value is denied if not administrative user

Changing 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 if agent identifier is not equal to relay.

This map contains I/O port type elements.

Creating elements in this collection is not supported.

Sample JS request read command:

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

⇒

Sample requests read command:

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

⇒

Browse more samples

I/O port type

object	relay/known_port_types/S/
Object representing a supported type of I/O ports

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

This object contains the following items:

data_items	Configuration structure
channels	Channel map

Sample curl write command (note that :i_o_port_type 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 "{\"data_items\":{\"baudrate\":{\"name\":\"Baud rate\",\"regexp\":\"^[1-9][0-9]*$\"},\"char_size\":{\"name\":\"Character size in bits\",\"regexp\":\"^(5|6|7|8)$\"},\"stop_bits\":{\"name\":\"Number of stop bits\",\"regexp\":\"^(1|2|1\\\\.5)$\"},\"parity\":{\"name\":\"Parity setting: N for none, E for even, O for odd, M for mark, S for space\",\"regexp\":\"^(N|E|O|M|S)$\"}},\"channels\":{\"d\":\"Data\"}}" "http://192.168.0.100/restapi/relay/known_port_types/:i_o_port_type/"

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

uom get "relay/known_port_types/${i_o_port_type}"

⇒

Browse more samples

See also I/O port type: Configuration structure

See also I/O port type: Channel map

I/O port type: Configuration structure

map	relay/known_port_types/S/data_items/
Port configuration structure

Retrieving the value is denied if not administrative user

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

This map does not support direct modification.

This map contains Configuration item properties elements.

Creating elements in this collection is not supported.

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

print(uom.dump(uom.relay.known_port_types[_i_o_port_type].data_items))

⇒

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

request.get({url:"relay/known_port_types/"+_i_o_port_type+"/data_items/"},function(error,response,body) {console.log(body)});

⇒

Browse more samples

Configuration item properties

object	relay/known_port_types/S/data_items/S/
Properties of a configuration item

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

This object contains the following items:

name	Name
regexp	Regular expression

Sample curl read command (note that :i_o_port_type and :configuration_item_properties are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/relay/known_port_types/:i_o_port_type/data_items/:configuration_item_properties/"

⇒

{"name":"Parity setting: N for none, E for even, O for odd, M for mark, S for space","regexp":"^(N|E|O|M|S)$"}

Sample curl write command (note that :i_o_port_type and :configuration_item_properties 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 "{\"name\":\"Parity setting: N for none, E for even, O for odd, M for mark, S for space\",\"regexp\":\"^(N|E|O|M|S)$\"}" "http://192.168.0.100/restapi/relay/known_port_types/:i_o_port_type/data_items/:configuration_item_properties/"

Browse more samples

Name

string	relay/known_port_types/S/data_items/S/name/
Name of the data item

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 curl read command (note that :i_o_port_type and :configuration_item_properties are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/relay/known_port_types/:i_o_port_type/data_items/:configuration_item_properties/name/"

⇒

"Number of stop bits"

Sample JS request read command (note that _i_o_port_type and _configuration_item_properties are variables):

request.get({url:"relay/known_port_types/"+_i_o_port_type+"/data_items/"+_configuration_item_properties+"/name/"},function(error,response,body) {console.log(body)});

⇒

"Parity setting: N for none, E for even, O for odd, M for mark, S for space"

Browse more samples

Regular expression

string	relay/known_port_types/S/data_items/S/regexp/
Regular expression which the data item must match

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 CLI read command (note that i_o_port_type and configuration_item_properties are variables):

uom get "relay/known_port_types/${i_o_port_type}/data_items/${configuration_item_properties}/regexp"

⇒

"^(N|E|O|M|S)$"

Sample JS request read command (note that _i_o_port_type and _configuration_item_properties are variables):

request.get({url:"relay/known_port_types/"+_i_o_port_type+"/data_items/"+_configuration_item_properties+"/regexp/"},function(error,response,body) {console.log(body)});

⇒

"^(1|2|1\\.5)$"

Browse more samples

I/O port type: Channel map

map	relay/known_port_types/S/channels/
Map of channels supported by the port

Retrieving the value is denied if not administrative user

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

This map does not support direct modification.

This map contains Channel name elements.

Creating elements in this collection is not supported.

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

request.get({url:"relay/known_port_types/"+_i_o_port_type+"/channels/"},function(error,response,body) {console.log(body)});

⇒

{"d":"Data"}

Sample curl read command (note that :i_o_port_type is a URL template argument):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/relay/known_port_types/:i_o_port_type/channels/"

⇒

{"d":"Data"}

Browse more samples

Channel name

string	relay/known_port_types/S/channels/S/
Description of the channel

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 _i_o_port_type and _channel_name are variables):

print(requests.get('http://192.168.0.100/restapi/relay/known_port_types/'+_i_o_port_type+'/channels/'+_channel_name+'/',auth=auth,headers=headers).json())

⇒

'Data'

Sample uom library read command (note that _i_o_port_type and _channel_name are variables):

print(uom.dump(uom.relay.known_port_types[_i_o_port_type].channels[_channel_name]))

⇒

"Data"

Browse more samples

Pins

map	relay/pins/
GPIO pins attached to the relay

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This map does not support direct modification if agent identifier is not equal to relay.

This map contains GPIO pin elements.

Creating elements in this collection is not supported.

Sample uom library read command:

print(uom.dump(uom.relay.pins))

⇒

Sample curl read command:

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

⇒

Browse more samples

GPIO pin

object	relay/pins/S/
Object representing state and configuration of a GPIO pin

This object contains the following items:

name	Name
input_bits	Input bits
mode_bits	Mode bits
level_bits	Level bits
mode_driver	Mode driver
level_driver	Level driver
drive_logic_mapping	Pin drive mapping
format	Format
latest_input_value	Latest input value, if any
configure_input_tracking	Configure tracking
configure_mode_driver	Configure mode driver
configure_level_driver	Configure level driver

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

requests.put('http://192.168.0.100/restapi/relay/pins/'+_gpio_pin+'/',auth=auth,headers=headers,json={'level_bits': 0, 'latest_input_value': None, 'level_driver': 'yprigu1', 'drive_logic_mapping': ['0', '1', '0', '1'], 'name': 'aio52', 'mode_bits': 19, 'format': 'int', 'input_bits': 25, 'mode_driver': True})

Sample curl write command (note that :gpio_pin 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 "{\"level_bits\":0,\"latest_input_value\":null,\"level_driver\":false,\"drive_logic_mapping\":[\"Z\",\"Z\",\"0\",\"0\"],\"name\":\"aout56\",\"mode_bits\":13,\"format\":\"bits\",\"input_bits\":19,\"mode_driver\":true}" "http://192.168.0.100/restapi/relay/pins/:gpio_pin/"

Browse more samples

See also GPIO pin: Name

See also GPIO pin: Input bits

See also GPIO pin: Mode bits

See also GPIO pin: Level bits

See also GPIO pin: Mode driver

See also GPIO pin: Level driver

See also GPIO pin: Pin drive mapping

See also GPIO pin: Format

See also GPIO pin: Latest input value, if any

See also GPIO pin: Configure tracking

See also GPIO pin: Configure mode driver

See also GPIO pin: Configure level driver

GPIO pin: Name

string	relay/pins/S/name/
User-visible pin name

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

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

print(uom.dump(uom.relay.pins[_gpio_pin].name))

⇒

"din34"

Sample curl write command (note that :gpio_pin 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 "\"ain6\"" "http://192.168.0.100/restapi/relay/pins/:gpio_pin/name/"

Browse more samples

GPIO pin: Input bits

number	relay/pins/S/input_bits/
Number of bits in pin input value

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:

• the value is an integer
• the value is greater or equal to 0
• the value is less or equal to 64

Retrieving the value is denied if not administrative user

This number does not support direct modification if agent identifier is not equal to relay.

This number represents a value in persistent storage.

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

print(uom.dump(uom.relay.pins[_gpio_pin].input_bits))

⇒

0

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

uom get "relay/pins/${gpio_pin}/input_bits"

⇒

0

Browse more samples

GPIO pin: Mode bits

number	relay/pins/S/mode_bits/
Number of bits in pin mode value

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:

• the value is an integer
• the value is greater or equal to 0
• the value is less or equal to 64

Retrieving the value is denied if not administrative user

This number does not support direct modification if agent identifier is not equal to relay.

This number represents a value in persistent storage.

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

print(requests.get('http://192.168.0.100/restapi/relay/pins/'+_gpio_pin+'/mode_bits/',auth=auth,headers=headers).json())

⇒

0

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

uom get "relay/pins/${gpio_pin}/mode_bits"

⇒

0

Browse more samples

GPIO pin: Level bits

number	relay/pins/S/level_bits/
Number of bits in pin level value

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:

• the value is an integer
• the value is greater or equal to 0
• the value is less or equal to 64

Retrieving the value is denied if not administrative user

This number does not support direct modification if agent identifier is not equal to relay.

This number represents a value in persistent storage.

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

request.get({url:"relay/pins/"+_gpio_pin+"/level_bits/"},function(error,response,body) {console.log(body)});

⇒

7

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

uom get "relay/pins/${gpio_pin}/level_bits"

⇒

16

Browse more samples

GPIO pin: Mode driver

sum (variant)	relay/pins/S/mode_driver/
Configured signal driving the pin's mode (input or output)

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 all of the following is true:

• agent identifier is not equal to relay
• mode bits is equal to 0

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 true	Active	The pin is as active (output) as possible
constant false	Tristated	The pin is as inactive (input, hi-Z state) as possible
string	Net name	Name of the net providing the driving value	all of the following is true: not the value matches ^(|​.*|.*)$ nets[the value]
string	Invalid net placeholder	A placeholder for a net that has been deleted or renamed (and always has the logical value false)	the value matches ^​net_deleted:.*$

Sample curl read command (note that :gpio_pin is a URL template argument):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/relay/pins/:gpio_pin/mode_driver/"

⇒

"ep1"

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

request.get({url:"relay/pins/"+_gpio_pin+"/mode_driver/"},function(error,response,body) {console.log(body)});

⇒

false

Browse more samples

GPIO pin: Level driver

sum (variant)	relay/pins/S/level_driver/
Configured signal driving the pin's output level

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 all of the following is true:

• agent identifier is not equal to relay
• level bits is equal to 0

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 true	High	The pin is driven as high as possible given the current mode
constant false	Low	The pin is driven as low as possible given the current mode
string	Net name	Name of the net providing the driving value	all of the following is true: not the value matches ^(|​.*|.*)$ nets[the value]
string	Invalid net placeholder	A placeholder for a net that has been deleted or renamed (and always has the logical value false)	the value matches ^​net_deleted:.*$

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

print(uom.dump(uom.relay.pins[_gpio_pin].level_driver))

⇒

"csft41"

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

request.get({url:"relay/pins/"+_gpio_pin+"/level_driver/"},function(error,response,body) {console.log(body)});

⇒

false

Browse more samples

GPIO pin: Pin drive mapping

tuple	relay/pins/S/drive_logic_mapping/
Mapping of pin mode and level combinations to resulting pin IEEE1164 logic levels

Retrieving the value is denied if not administrative user

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

This tuple does not support direct modification if agent identifier is not equal to relay.

This tuple represents a value in persistent storage.

This tuple contains the following items:

1	Low mode, low level
2	Low mode, high level
3	High mode, low level
4	High mode, high level

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

uom get "relay/pins/${gpio_pin}/drive_logic_mapping"

⇒

["0","1","0","1"]

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

print(uom.dump(uom.relay.pins[_gpio_pin].drive_logic_mapping))

⇒

{"Z","H","0","1"}

Browse more samples

Low mode, low level

sum (enumerated string)	relay/pins/S/drive_logic_mapping/1/
IEEE1164 logic level when pin is in the minimum mode, minimum level configuration

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 if agent identifier is not equal to relay.

This sum represents a value in persistent storage.

This sum can assume the following values:

constant "0"	Forcing 0	Strong low signal as good as ground
constant "1"	Forcing 1	Strong high signal as good as power supply voltage
constant "L"	Weak 0	Low signal which is logically 0 but weak (e.g. from a pull-down resistor)
constant "H"	Weak 1	High signal which is logically 1 but weak (e.g. from a pull-up resistor)
constant "Z"	High impedance	Pin pulled neither up nor down, signal defined by external circuitry

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

print(uom.dump(uom.relay.pins[_gpio_pin].drive_logic_mapping[1]))

⇒

"Z"

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

uom get "relay/pins/${gpio_pin}/drive_logic_mapping/0"

⇒

"0"

Browse more samples

Low mode, high level

sum (enumerated string)	relay/pins/S/drive_logic_mapping/2/
IEEE1164 logic level when pin is in the minimum mode, maximum level configuration

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 if agent identifier is not equal to relay.

This sum represents a value in persistent storage.

This sum can assume the following values:

constant "0"	Forcing 0	Strong low signal as good as ground
constant "1"	Forcing 1	Strong high signal as good as power supply voltage
constant "L"	Weak 0	Low signal which is logically 0 but weak (e.g. from a pull-down resistor)
constant "H"	Weak 1	High signal which is logically 1 but weak (e.g. from a pull-up resistor)
constant "Z"	High impedance	Pin pulled neither up nor down, signal defined by external circuitry

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

request.get({url:"relay/pins/"+_gpio_pin+"/drive_logic_mapping/1/"},function(error,response,body) {console.log(body)});

⇒

"H"

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

print(requests.get('http://192.168.0.100/restapi/relay/pins/'+_gpio_pin+'/drive_logic_mapping/1/',auth=auth,headers=headers).json())

⇒

'1'

Browse more samples

High mode, low level

sum (enumerated string)	relay/pins/S/drive_logic_mapping/3/
IEEE1164 logic level when pin is in the maximum mode, minimum level configuration

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 if agent identifier is not equal to relay.

This sum represents a value in persistent storage.

This sum can assume the following values:

constant "0"	Forcing 0	Strong low signal as good as ground
constant "1"	Forcing 1	Strong high signal as good as power supply voltage
constant "L"	Weak 0	Low signal which is logically 0 but weak (e.g. from a pull-down resistor)
constant "H"	Weak 1	High signal which is logically 1 but weak (e.g. from a pull-up resistor)
constant "Z"	High impedance	Pin pulled neither up nor down, signal defined by external circuitry

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

request.get({url:"relay/pins/"+_gpio_pin+"/drive_logic_mapping/2/"},function(error,response,body) {console.log(body)});

⇒

"0"

Sample curl read command (note that :gpio_pin is a URL template argument):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/relay/pins/:gpio_pin/drive_logic_mapping/2/"

⇒

"Z"

Browse more samples

High mode, high level

sum (enumerated string)	relay/pins/S/drive_logic_mapping/4/
IEEE1164 logic level when pin is in the maximum mode, maximum level configuration

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 if agent identifier is not equal to relay.

This sum represents a value in persistent storage.

This sum can assume the following values:

constant "0"	Forcing 0	Strong low signal as good as ground
constant "1"	Forcing 1	Strong high signal as good as power supply voltage
constant "L"	Weak 0	Low signal which is logically 0 but weak (e.g. from a pull-down resistor)
constant "H"	Weak 1	High signal which is logically 1 but weak (e.g. from a pull-up resistor)
constant "Z"	High impedance	Pin pulled neither up nor down, signal defined by external circuitry

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

request.get({url:"relay/pins/"+_gpio_pin+"/drive_logic_mapping/3/"},function(error,response,body) {console.log(body)});

⇒

"Z"

Sample curl read command (note that :gpio_pin is a URL template argument):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/relay/pins/:gpio_pin/drive_logic_mapping/3/"

⇒

"0"

Browse more samples

GPIO pin: Format

sum (optional enumerated string)	relay/pins/S/format/
Pin data format

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 agent identifier is not equal to relay.

This sum represents a value in persistent storage.

This sum can assume the following values:

constant "int"	Signed integer	The pin represents a two's complement signed integer
constant "uint"	Unsigned integer	The pin represents an unsigned integer
constant "fixed"	Signed fixed-point number	The pin represents an analog signal in fixed-point format
constant "bits"	Bit string	The pin represents a collection of independent bits
constant null	Unknown	The pin's format is unknown

Sample curl read command (note that :gpio_pin is a URL template argument):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/relay/pins/:gpio_pin/format/"

⇒

"int"

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

print(requests.get('http://192.168.0.100/restapi/relay/pins/'+_gpio_pin+'/format/',auth=auth,headers=headers).json())

⇒

'uint'

Browse more samples

GPIO pin: Latest input value, if any

sum (optional number)	relay/pins/S/latest_input_value/
Latest pin input value as reported by a net, if any

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

Using the sum as a field for indexing into the grandparent collection is denied

This sum does not support direct modification if agent identifier is not equal to relay.

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

This sum can assume the following values:

constant null	No latest input value	Input value not monitored so no latest value available
number	Latest input value	Latest pin input value as reported by a net

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

uom get "relay/pins/${gpio_pin}/latest_input_value"

⇒

null

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

print(uom.dump(uom.relay.pins[_gpio_pin].latest_input_value))

⇒

null

Browse more samples

Net changes: Removed nets

array	relay/pins/S/configure_input_tracking/results: 1/1/
List of nets removed to fulfill the configuration result

This array does not correspond to an actual resource.

This array contains Removed net elements.

Removed net

string	relay/pins/S/configure_input_tracking/results: 1/1/N/
Identifier of the removed net

This string does not correspond to an actual resource.

Net changes: Added nets

array	relay/pins/S/configure_input_tracking/results: 1/2/
List of nets added to fulfill the configuration result

This array does not correspond to an actual resource.

This array contains Added net elements.

Added net

string	relay/pins/S/configure_input_tracking/results: 1/2/N/
Identifier of the added net

This string does not correspond to an actual resource.

GPIO pin: Configure tracking

call	relay/pins/S/configure_input_tracking/
Set method of reporting the pin's value

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

• not administrative user
• input bits is equal to 0

The call accepts the following arguments:

1. Pin tracking configuration mode: None, Pull or Push

The call returns the following results:

1. Net changes: (array of "string",array of "string")

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

request.post({url:"relay/pins/"+_gpio_pin+"/configure_input_tracking/",body:["pull"]});

⇒

[[],["sp40"]]

Sample curl invocation (note that :gpio_pin 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 "[null]" "http://192.168.0.100/restapi/relay/pins/:gpio_pin/configure_input_tracking/"

⇒

[["hrke49"],[]]

Browse more samples

Pin tracking configuration mode

sum (optional enumerated string)	relay/pins/S/configure_input_tracking/arguments: 1/
Desired pin tracking configuration mode

This sum does not correspond to an actual resource.

This sum can assume the following values:

constant null	None	Latest pin value is not updated
constant "pull"	Pull	Latest pin value is updated periodically
constant "push"	Push	Latest pin value is reported when changed

Net changes

tuple	relay/pins/S/configure_input_tracking/results: 1/
Changes in net structure performed by the call

This tuple does not correspond to an actual resource.

This tuple contains the following items:

1	Removed nets
2	Added nets

See also Net changes: Removed nets

See also Net changes: Added nets

Net changes: Removed nets

array	relay/pins/S/configure_mode_driver/results: 1/1/
List of nets removed to fulfill the configuration result

This array does not correspond to an actual resource.

This array contains Removed net elements.

Removed net

string	relay/pins/S/configure_mode_driver/results: 1/1/N/
Identifier of the removed net

This string does not correspond to an actual resource.

Net changes: Added nets

array	relay/pins/S/configure_mode_driver/results: 1/2/
List of nets added to fulfill the configuration result

This array does not correspond to an actual resource.

This array contains Added net elements.

Added net

string	relay/pins/S/configure_mode_driver/results: 1/2/N/
Identifier of the added net

This string does not correspond to an actual resource.

GPIO pin: Configure mode driver

call	relay/pins/S/configure_mode_driver/
Set pin's mode (input or output) driver

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

• not administrative user
• mode bits is equal to 0

The call accepts the following arguments:

1. Desired mode driver: High, Low or Net code

The call returns the following results:

1. Net changes: (array of "string",array of "string")

Sample requests invocation (note that _gpio_pin is a variable):

print(requests.post('http://192.168.0.100/restapi/relay/pins/'+_gpio_pin+'/configure_mode_driver/',auth=auth,headers=headers,json=[True]).json())

⇒

[{}, {}]

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

request.post({url:"relay/pins/"+_gpio_pin+"/configure_mode_driver/",body:[false]});

⇒

[["l4"],[]]

Browse more samples

Desired mode driver

sum (variant)	relay/pins/S/configure_mode_driver/arguments: 1/
Desired signal driving the pin's mode (input or output)

This sum does not correspond to an actual resource.

This sum can assume the following values:

constant true	High	The pin is driven as high as possible given the current mode
constant false	Low	The pin is driven as low as possible given the current mode
string	Net code	Code of the net providing the driving value

Net changes

tuple	relay/pins/S/configure_mode_driver/results: 1/
Changes in net structure performed by the call

This tuple does not correspond to an actual resource.

This tuple contains the following items:

1	Removed nets
2	Added nets

See also Net changes: Removed nets

See also Net changes: Added nets

Net changes: Removed nets

array	relay/pins/S/configure_level_driver/results: 1/1/
List of nets removed to fulfill the configuration result

This array does not correspond to an actual resource.

This array contains Removed net elements.

Removed net

string	relay/pins/S/configure_level_driver/results: 1/1/N/
Identifier of the removed net

This string does not correspond to an actual resource.

Net changes: Added nets

array	relay/pins/S/configure_level_driver/results: 1/2/
List of nets added to fulfill the configuration result

This array does not correspond to an actual resource.

This array contains Added net elements.

Added net

string	relay/pins/S/configure_level_driver/results: 1/2/N/
Identifier of the added net

This string does not correspond to an actual resource.

GPIO pin: Configure level driver

call	relay/pins/S/configure_level_driver/
Set pin's output level driver

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

• not administrative user
• level bits is equal to 0

The call accepts the following arguments:

1. Desired level driver: High, Low or Net code

The call returns the following results:

1. Net changes: (array of "string",array of "string")

Sample curl invocation (note that :gpio_pin 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 "[false]" "http://192.168.0.100/restapi/relay/pins/:gpio_pin/configure_level_driver/"

⇒

[["bwlctgrlc1"],[]]

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

print(uom.dump(uom.relay.pins[_gpio_pin].configure_level_driver("apin[\"ain6\"]")))

⇒

{{},{"yqf53"}}

Browse more samples

Desired level driver

sum (variant)	relay/pins/S/configure_level_driver/arguments: 1/
Desired signal driving the pin's output level

This sum does not correspond to an actual resource.

This sum can assume the following values:

constant true	High	The pin is driven as high as possible given the current mode
constant false	Low	The pin is driven as low as possible given the current mode
string	Net code	Code of the net providing the driving value

Net changes

tuple	relay/pins/S/configure_level_driver/results: 1/
Changes in net structure performed by the call

This tuple does not correspond to an actual resource.

This tuple contains the following items:

1	Removed nets
2	Added nets

See also Net changes: Removed nets

See also Net changes: Added nets

Nets

map	relay/nets/
Nets controlling the GPIO pins

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This map represents a value in persistent storage.

This map contains GPIO net elements.

Sample requests write command:

requests.put('http://192.168.0.100/restapi/relay/nets/',auth=auth,headers=headers,json=<...>)

Sample CLI GPIO net creation command:

uom insert "relay/nets/fjnjynnnrrwpgl0" "{\"name\":\"fjnjynnnrrwpgl0\",\"scale\":1,\"tracking\":\"push\",\"expression\":\"pin[\\\"dout3\\\"]\"}"

Browse more samples

See also Nets: GPIO net

Nets: GPIO net

object	relay/nets/S/
Object representing a state of a GPIO net signal

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

This object contains the following items:

name	Name
expression	Expression
tracking	Tracking
latest_value	Latest value
scale	Value scale factor

Sample JS request deletion command (note that _gpio_net is a variable):

request.delete({url:"relay/nets/"+_gpio_net+"/"});

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

print(uom.dump(uom.relay.nets[_gpio_net]))

⇒

{expression="iff((apin[\"aout5\"] | apin[\"aio80\"]),pin[\"din83\"],band(pin[\"dout3\"],anet[\"nzf61\"]))",latest_value=3,name="rplbsw60",scale=4,tracking="push"}

Browse more samples

Name

string	relay/nets/S/name/
User-visible net name

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

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

request.get({url:"relay/nets/"+_gpio_net+"/name/"},function(error,response,body) {console.log(body)});

⇒

"n3"

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

print(requests.get('http://192.168.0.100/restapi/relay/nets/'+_gpio_net+'/name/',auth=auth,headers=headers).json())

⇒

'oegfj22'

Browse more samples

Expression

string	relay/nets/S/expression/
Expression governing the net's value

The value contains Lua source (has native MIME type text/x-lua).

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

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

print(uom.dump(uom.relay.nets[_gpio_net].expression))

⇒

"apin[\"aout1\"]"

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

requests.put('http://192.168.0.100/restapi/relay/nets/'+_gpio_net+'/expression/',auth=auth,headers=headers,json='iff(apin["aout2"],iff(lor(land(apin["aio12"],iff(anet["bhxetk0"],net["jxpm80"],apin["ain52"])),apin["dio6"]),pin["dio9"],net["v9"]),net["mhrwgno4"])')

Browse more samples

Tracking

sum (optional enumerated string)	relay/nets/S/tracking/
Method of reporting the net's value

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 null	None	Net value is not updated
constant "pull"	Pull	Net value is updated periodically
constant "push"	Push	Net value is reported when changed

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

requests.put('http://192.168.0.100/restapi/relay/nets/'+_gpio_net+'/tracking/',auth=auth,headers=headers,json='push')

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

request.put({url:"relay/nets/"+_gpio_net+"/tracking/",body:"pull"});

Browse more samples

Latest value

number	relay/nets/S/latest_value/
Latest net value

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

Using the number as a field for indexing into the grandparent collection is denied

This number does not support direct modification if agent identifier is not equal to relay.

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

request.get({url:"relay/nets/"+_gpio_net+"/latest_value/"},function(error,response,body) {console.log(body)});

⇒

5

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

print(requests.get('http://192.168.0.100/restapi/relay/nets/'+_gpio_net+'/latest_value/',auth=auth,headers=headers).json())

⇒

2

Browse more samples

Value scale factor

number	relay/nets/S/scale/
The factor by which the latest value must be divided to obtain the corresponding numeric value

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

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

Using the number as a field for indexing into the grandparent collection is denied

This number does not support direct modification if agent identifier is not equal to relay.

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

uom get "relay/nets/${gpio_net}/scale"

⇒

65536

Sample curl read command (note that :gpio_net is a URL template argument):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/relay/nets/:gpio_net/scale/"

⇒

65536

Browse more samples

Net max width

number	relay/net_max_bits/
Max net width in bits

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

• the value is an integer
• the value is greater or equal to 0

Retrieving the value is denied if not administrative user

This number does not support direct modification.

Sample uom library read command:

print(uom.dump(uom.relay.net_max_bits))

⇒

30

Sample requests read command:

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

⇒

29

Browse more samples

Fractional bit count

number	relay/net_fractional_bits/
Number of fractional bits in fixed-point net values

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

• the value is an integer
• the value is greater or equal to 0

Retrieving the value is denied if not administrative user

This number does not support direct modification.

Sample JS request read command:

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

⇒

5

Sample requests read command:

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

⇒

9

Browse more samples

Net poll interval

number	relay/net_poll_interval/
Time between net value fetches (for nets configured for periodic polling)

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 curl read command:

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

⇒

6

Sample requests read command:

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

⇒

2

Browse more samples

GPIO scan interval, if any

sum (number)	relay/gpio_scan_interval/
Target time between GPIO scans, if any

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 0	Asynchronous GPIO scanning	GPIO scans occur not at a particular interval, but rather as often as possible
number	GPIO scan interval	Target time between GPIO scans	the value is greater than 0

Sample uom library read command:

print(uom.dump(uom.relay.gpio_scan_interval))

⇒

0.05

Sample uom library write command:

uom.relay.gpio_scan_interval=0.0125

Browse more samples

GPIO scan interval catch-up limit

number	relay/scan_catch_up_limit/
The maximum number of end-to-end-consecutive scans to catch up with the desired interval (has no effect if GPIO scanning is asynchronous)

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:

• the value is an integer
• the value is greater or equal to 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 curl read command:

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

⇒

1

Sample CLI read command:

uom get "relay/scan_catch_up_limit"

⇒

8

Browse more samples

Resources

map	relay/resources/
Resource status information

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This map does not support direct modification if agent identifier is not equal to relay.

This map contains Resource elements.

Creating elements in this collection is not supported.

Sample requests read command:

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

⇒

{'i58s': {'used': 3, 'total': 8, 'name': 'i58 count'}}

Sample CLI read command:

uom get "relay/resources"

⇒

{"bpboi3s":{"used":3,"total":5,"name":"bpboi3 count"}}

Browse more samples

See also Resources: Resource

Resources: Resource

object	relay/resources/S/
Resource use status

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This object does not support direct modification if agent identifier is not equal to relay.

This object contains the following items:

name	Name
used	Used
total	Total amount

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

request.get({url:"relay/resources/"+_resource+"/"},function(error,response,body) {console.log(body)});

⇒

{"used":0,"total":7,"name":"kmkxp6 count"}

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

print(requests.get('http://192.168.0.100/restapi/relay/resources/'+_resource+'/',auth=auth,headers=headers).json())

⇒

{'used': 0, 'total': 2, 'name': 'u6 count'}

Browse more samples

Name

string	relay/resources/S/name/
Name of the resource

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

print(requests.get('http://192.168.0.100/restapi/relay/resources/'+_resource+'/name/',auth=auth,headers=headers).json())

⇒

'f25 count'

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

print(uom.dump(uom.relay.resources[_resource].name))

⇒

"w7 count"

Browse more samples

Used

number	relay/resources/S/used/
Amount of the resource currently in use

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

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

requests.put('http://192.168.0.100/restapi/relay/resources/'+_resource+'/used/',auth=auth,headers=headers,json=0)

Sample curl read command (note that :resource is a URL template argument):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/relay/resources/:resource/used/"

⇒

1

Browse more samples

Total amount

number	relay/resources/S/total/
Total amount of the resource

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

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

print(uom.dump(uom.relay.resources[_resource].total))

⇒

5

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

request.get({url:"relay/resources/"+_resource+"/total/"},function(error,response,body) {console.log(body)});

⇒

12

Browse more samples

Enable measurement-driven outlet control

sum (boolean)	relay/fuses_enabled/
Allow use of measurement results to conditionally switch off outlets, enabling safety shutdown and correct power loss operation

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 is expected to be visible to advanced users only.

This sum can assume the following values:

constant true	Enabled	The feature is enabled
constant false	Disabled	The feature is disabled

Sample curl write command:

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/relay/fuses_enabled/"

Sample uom library read command:

print(uom.dump(uom.relay.fuses_enabled))

⇒

true

Browse more samples

Minimum relay voltage, if any

sum (optional number)	relay/min_relay_voltage/
Minimum relay voltage below which it cannot drive outlets and they must be considered off, if any

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 is expected to be visible to advanced users only.

This sum can assume the following values:

constant null	Disable relay undervoltage handling	Ignore relay undervoltage. This is unsafe!
number	Minimum relay voltage	Minimum relay voltage below which it cannot drive outlets and they must be considered off	the value is greater than 0

Sample JS request read command:

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

⇒

8

Sample requests read command:

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

⇒

8

Browse more samples

Measurement-driven relatch timeout, if any

sum (optional number)	relay/fuse_relatch/
Time to hold outlets off after switching them off due to measurement limits being hit, if any

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 null	Latch OFF	Switch outlets off until the user takes action
number	Measurement-driven relatch timeout	Time to hold outlets off after switching them off due to measurement limits being hit	the value is greater than 0

Sample curl write command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "2" "http://192.168.0.100/restapi/relay/fuse_relatch/"

Sample JS request read command:

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

⇒

7

Browse more samples

Keypad state

sum (boolean)	relay/keypad_enabled/
Flag indicating whether keypad is enabled or disabled

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 true	Enabled	The feature is enabled
constant false	Disabled	The feature is disabled

Sample requests read command:

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

⇒

True

Sample requests write command:

requests.put('http://192.168.0.100/restapi/relay/keypad_enabled/',auth=auth,headers=headers,json=False)

Browse more samples

LCD all-caps filter

sum (boolean)	relay/all_caps/
Flag enabling all-caps display of text

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 true	All CAPS	All LCD strings are displayed in capital letters
constant false	Standard mode	LCD strings are displayed as configured without capitalization

Sample CLI write command:

uom set "relay/all_caps" "true"

Sample requests read command:

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

⇒

True

Browse more samples

Beep sequence

string	relay/beep_sequence/
Signal sequence for beeper activation

The value is subject to the following constraints: the value matches ^[01. _-]*$

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

Sample requests write command:

requests.put('http://192.168.0.100/restapi/relay/beep_sequence/',auth=auth,headers=headers,json='0')

Sample JS request write command:

request.put({url:"relay/beep_sequence/",body:"0"});

Browse more samples

Backlight sequence

string	relay/backlight_sequence/
Signal sequence for backlight blinking

The value is subject to the following constraints: the value matches ^[01. _-]*$

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

Sample JS request write command:

request.put({url:"relay/backlight_sequence/",body:"0"});

Sample requests read command:

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

⇒

'0'

Browse more samples

LCD column count

number	relay/lcd_columns/
Number of LCD columns

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:

• the value is an integer
• the value is greater or equal to 0

This number does not support direct modification.

This number represents a value in persistent storage.

Sample curl read command:

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

⇒

16

Sample requests read command:

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

⇒

16

Browse more samples

LCD row count

number	relay/lcd_rows/
Number of LCD rows

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:

• the value is an integer
• the value is greater or equal to 0

This number does not support direct modification.

This number represents a value in persistent storage.

Sample JS request read command:

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

⇒

2

Sample CLI read command:

uom get "relay/lcd_rows"

⇒

2

Browse more samples

User LCD lines

array	relay/user_lines/
Array of strings to override LCD lines with, from top to bottom

The value is subject to the following constraints: length of the value is equal to LCD row count

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This array contains User LCD line, if any elements.

Sample JS request read command:

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

⇒

[null,null]

Sample uom library read command:

print(uom.dump(uom.relay.user_lines))

⇒

{null,null}

Browse more samples

User LCD line, if any

sum (optional string)	relay/user_lines/N/
The line to override the corresponding line of the LCD output with, if any

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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

This sum can assume the following values:

constant null	No user LCD line	Do not override the corresponding line of the ordinary LCD output
string	User LCD line	The line to override the corresponding line of the LCD output with

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

uom remove "relay/user_lines/${user_lcd_line__if_any_index}"

Sample curl read command (note that :user_lcd_line__if_any_index is a URL template argument):

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

⇒

null

Browse more samples

User message force display timeout, if any

sum (optional number)	relay/user_message_force_timeout/
Time during which the user script LCD message always overrides ordinary LCD output, if any

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 null	Always force user message	The user message always overrides ordinary LCD output
number	User message force display timeout	Time during which the user script LCD message always overrides ordinary LCD output	the value is greater or equal to 0

Sample requests read command:

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

⇒

3

Sample requests write command:

requests.put('http://192.168.0.100/restapi/relay/user_message_force_timeout/',auth=auth,headers=headers,json=2)

Browse more samples

User message display timeout, if any

sum (optional number)	relay/user_message_timeout/
Time after which the user script LCD message is replaced by ordinary LCD output even if nothing else happens, if any

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 null	Show user message indefinitely	The user message stays on LCD until ordinary LCD output changes
number	User message display timeout	Time after which the user script LCD message is replaced by ordinary LCD output even if nothing else happens	the value is greater or equal to 0

Sample curl write command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "3" "http://192.168.0.100/restapi/relay/user_message_timeout/"

Sample CLI read command:

uom get "relay/user_message_timeout"

⇒

null

Browse more samples

Notifications

object	relay/notifications/
Relay-state-related notifications

Retrieving the value is denied if not administrative user

This object does not support direct modification.

This object contains the following items:

parameter_kinds	Parameter kinds
events	Events

Sample curl read command:

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

⇒

...

Sample requests read command:

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

⇒

<...>

Browse more samples

See also Notifications: Parameter kinds

Events

map	relay/notifications/events/
Event templates

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 JS request read command:

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

⇒

<...>

Sample CLI read command:

uom get "relay/notifications/events"

⇒

...

Browse more samples

See also Events: Event

Notifications: Parameter kinds

object	relay/notifications/parameter_kinds/
Kinds of event parameters

This object does not correspond to an actual resource.

This object contains the following items:

outlet	Outlet
state	Configured state
transient_state	Transient state
physical_state	Physical state
locked	Lock state

Outlet

number	relay/notifications/parameter_kinds/outlet/
Outlet index

The value is subject to the following constraints: outlets[the value]

Configured state

sum (boolean)	relay/notifications/parameter_kinds/state/
Saved configured state of the outlet

This sum can assume the following values:

constant true	On	The outlet is powered
constant false	Off	The outlet is not powered

Transient state

sum (boolean)	relay/notifications/parameter_kinds/transient_state/
Current expected state of the outlet

This sum can assume the following values:

constant true	On	The outlet is powered
constant false	Off	The outlet is not powered

Physical state

sum (boolean)	relay/notifications/parameter_kinds/physical_state/
Current actual state of the outlet

This sum can assume the following values:

constant true	On	The outlet is powered
constant false	Off	The outlet is not powered

Lock state

sum (boolean)	relay/notifications/parameter_kinds/locked/
Indicates whether the outlet state is locked from keypad

This sum can assume the following values:

constant true	Locked	The outlet state cannot be changed
constant false	Unlocked	The outlet state can be changed

Event parameters: Event parameter

object	relay/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:

id	Identifier
has_fixed_value	Fixed value flag
fixed_value	Fixed value

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

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

⇒

{fixed_value=false,has_fixed_value=true,id="state"}

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

requests.put('http://192.168.0.100/restapi/relay/notifications/events/'+_event+'/parameters/'+str(_event_parameter_index)+'/',auth=auth,headers=headers,json={'fixed_value': None, 'has_fixed_value': False, 'id': 'outlet'})

Browse more samples

Identifier

string	relay/notifications/events/S/parameters/N/id/
Parameter identifier

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 JS request read command (note that _event and _event_parameter_index are variables):

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

⇒

"state"

Sample CLI read command (note that event and event_parameter_index are variables):

uom get "relay/notifications/events/${event}/parameters/${event_parameter_index}/id"

⇒

"outlet"

Browse more samples

Fixed value flag

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

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 true	Fixed	The value is fixed
constant false	Variable	The value is variable

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

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

⇒

True

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

print(uom.dump(uom.relay.notifications.events[_event].parameters[_event_parameter_index].has_fixed_value))

⇒

true

Browse more samples

Fixed value

sum (variant)	relay/notifications/events/S/parameters/N/fixed_value/
Fixed parameter value for this particular event

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 null	Null	Null
constant true	True	True
constant false	False	False
string	String	This string
number	Number	This number

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/relay/notifications/events/:event/parameters/:event_parameter_index/fixed_value/"

⇒

null

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

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

⇒

false

Browse more samples

Events: Event

object	relay/notifications/events/S/
Event template

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

This object contains the following items:

message_template	Message template
severity	Severity
parameters	Event parameters

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

uom.relay.notifications.events[_event]={message_template={"outlet ",0," configured to be ON at power-up"},parameters={{fixed_value=null,has_fixed_value=false,id="outlet"},{fixed_value=true,has_fixed_value=true,id="state"}},severity=6}

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

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

⇒

{'severity': 6, 'message_template': ['outlet ', 0, ' configured to be OFF'], 'parameters': [{'fixed_value': None, 'has_fixed_value': False, 'id': 'outlet'}, {'fixed_value': False, 'has_fixed_value': True, 'id': 'state'}]}

Browse more samples

Message template

array	relay/notifications/events/S/message_template/
Template for human-readable message generation

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:"relay/notifications/events/"+_event+"/message_template/"},function(error,response,body) {console.log(body)});

⇒

["outlet ",0," expected to be OFF"]

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

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

⇒

['outlet ', 0, ' is OFF']

Browse more samples

Message template element

sum (variant)	relay/notifications/events/S/message_template/N/
Element of human-readable message template

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:

string	String	Fixed string
number	Parameter	Index of message parameter to insert	event parameters[the value]

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

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

⇒

"outlet "

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/relay/notifications/events/:event/message_template/:message_template_element_index/"

⇒

0

Browse more samples

Severity

sum (enumerated number)	relay/notifications/events/S/severity/
Severity rating assigned to the event

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 1	Emergency	Treat the event as an emergency
constant 2	Alert	Treat the event as an alert
constant 3	Critical	Treat the event as critical
constant 4	Error	Treat the event as an error
constant 5	Warning	Treat the event as a warning
constant 6	Notice	Treat the event as a notice
constant 7	Informational	Treat the event as informational
constant 8	Debug	Treat the event as debugging-related

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

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

⇒

6

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

print(uom.dump(uom.relay.notifications.events[_event].severity))

⇒

6

Browse more samples

Event parameters

array	relay/notifications/events/S/parameters/
Additional data associated with the event

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 requests read command (note that _event is a variable):

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

⇒

[{'fixed_value': None, 'has_fixed_value': False, 'id': 'outlet'}, {'fixed_value': True, 'has_fixed_value': True, 'id': 'state'}]

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

uom get "relay/notifications/events/${event}/parameters"

⇒

[{"fixed_value":null,"has_fixed_value":false,"id":"outlet"},{"fixed_value":true,"has_fixed_value":true,"id":"state"}]

Browse more samples

See also Event parameters: Event parameter