object	upnp/
Object representing the UPnP server configuration

Retrieving the value is denied if not administrative user

This object contains the following items:

enabled	UPnP enabled
outlets	Outlet UPnP configuration settings
profiles	UPnP device profiles
notifications	Notifications

Sample JS request write command:

request.put({url:"upnp/",body:<...>});

Sample JS request read command:

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

⇒

<...>

Browse more samples

UPnP enabled

sum (boolean)	upnp/enabled/
UPnP enable status

Retrieving the value is denied if not administrative user

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

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

request.put({url:"upnp/enabled/",body:true});

Sample uom library write command:

uom.upnp.enabled=false

Browse more samples

Outlet UPnP configuration settings

array	upnp/outlets/
Properties related to exposing outlets via UPnP

The value is subject to the following constraints: length of the value is equal to length of outlets

Retrieving the value is denied if not administrative user

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

This array represents a value in persistent storage.

This array contains Outlet UPnP configuration elements.

Sample requests read command:

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

⇒

Sample curl outlet UPnP configuration creation command:

curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"exposed\":false,\"alternate_name\":null,\"id\":\"1944d90d7\",\"profile\":\"belkin_wemo_socket\"}" "http://192.168.0.100/restapi/upnp/outlets/"

Browse more samples

Outlet UPnP configuration settings: Outlet UPnP configuration

object	upnp/outlets/N/
Properties related to exposing the outlet via UPnP

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

This object contains the following items:

id	Identifier
profile	Profile
exposed	Exposed
alternate_name	Alternate name, if any

Sample uom library deletion command (note that _outlet_upnp_configuration_index is a variable):

uom.remove(uom.upnp.outlets,_outlet_upnp_configuration_index)

Sample curl write command (note that :outlet_upnp_configuration_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 "{\"exposed\":false,\"alternate_name\":null,\"id\":\"1944d90d3\",\"profile\":\"belkin_wemo_socket\"}" "http://192.168.0.100/restapi/upnp/outlets/:outlet_upnp_configuration_index/"

Browse more samples

Identifier

string	upnp/outlets/N/id/
Outlet device identifier seed

Retrieving the value is denied if not administrative user

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

This string represents a value in persistent storage.

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

uom get "upnp/outlets/${outlet_upnp_configuration_index}/id"

⇒

"1944d90d5"

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

uom set "upnp/outlets/${outlet_upnp_configuration_index}/id" "\"1944d90d5\""

Browse more samples

Profile

string	upnp/outlets/N/profile/
Outlet device profile

The value is subject to the following constraints: UPnP device profiles[the value]

Retrieving the value is denied if not administrative user

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

This string represents a value in persistent storage.

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

request.put({url:"upnp/outlets/"+_outlet_upnp_configuration_index.toString()+"/profile/",body:"belkin_wemo_socket"});

Sample curl write command (note that :outlet_upnp_configuration_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 "\"belkin_wemo_socket\"" "http://192.168.0.100/restapi/upnp/outlets/:outlet_upnp_configuration_index/profile/"

Browse more samples

Exposed

sum (boolean)	upnp/outlets/N/exposed/
Outlet is exposed via UPnP

Retrieving the value is denied if not administrative user

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

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 JS request write command (note that _outlet_upnp_configuration_index is a variable):

request.put({url:"upnp/outlets/"+_outlet_upnp_configuration_index.toString()+"/exposed/",body:false});

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

print(uom.dump(uom.upnp.outlets[_outlet_upnp_configuration_index].exposed))

⇒

true

Browse more samples

Alternate name, if any

sum (optional string)	upnp/outlets/N/alternate_name/
Alternate name for the same outlet to be used instead of the configured name, if any

Retrieving the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Configured outlet name	Use the outlet's configured name
string	Alternate name	Alternate name for the same outlet to be used instead of the configured name	the value is not equal to ""

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

request.put({url:"upnp/outlets/"+_outlet_upnp_configuration_index.toString()+"/alternate_name/",body:null});

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

uom set "upnp/outlets/${outlet_upnp_configuration_index}/alternate_name" "null"

Browse more samples

UPnP device profiles

map	upnp/profiles/
Map of UPnP device exposure settings

Retrieving the value is denied if not administrative user

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

This map represents a value in persistent storage.

This map contains UPnP device profile elements.

Sample requests read command:

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

⇒

<...>

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 "..." "http://192.168.0.100/restapi/upnp/profiles/"

Browse more samples

UPnP device profile

object	upnp/profiles/S/
UPnP device exposure settings

This object contains the following items:

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

request.get({url:"upnp/profiles/"+_upnp_device_profile+"/"},function(error,response,body) {console.log(body)});

⇒

<...>

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

uom get "upnp/profiles/${upnp_device_profile}"

⇒

...

Browse more samples

UPnP device profile: Namespace identifier

string	upnp/profiles/S/nid/
URN namespace identifier

Retrieving the value is denied if not administrative user

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

This string represents a value in persistent storage.

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

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/upnp/profiles/:upnp_device_profile/nid/"

⇒

"Belkin"

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

print(uom.dump(uom.upnp.profiles[_upnp_device_profile].nid))

⇒

"Belkin"

Browse more samples

UPnP device profile: Device namespace

string	upnp/profiles/S/device_xmlns/
Device description XML namespace

Retrieving the value is denied if not administrative user

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

This string represents a value in persistent storage.

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

uom.upnp.profiles[_upnp_device_profile].device_xmlns="urn:Belkin:device-1-0"

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

request.get({url:"upnp/profiles/"+_upnp_device_profile+"/device_xmlns/"},function(error,response,body) {console.log(body)});

⇒

"urn:Belkin:device-1-0"

Browse more samples

UPnP device profile: Manufacturer

string	upnp/profiles/S/manufacturer/
Manufacturer name

Retrieving the value is denied if not administrative user

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

This string represents a value in persistent storage.

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

uom get "upnp/profiles/${upnp_device_profile}/manufacturer"

⇒

"Belkin International Inc."

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

requests.put('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile+'/manufacturer/',auth=auth,headers=headers,json='Belkin International Inc.')

Browse more samples

UPnP device profile: Model

string	upnp/profiles/S/model/
Model name

Retrieving the value is denied if not administrative user

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

This string represents a value in persistent storage.

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

uom set "upnp/profiles/${upnp_device_profile}/model" "\"DLI emulated Belkin socket\""

Sample curl write command (note that :upnp_device_profile 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 "\"DLI emulated Belkin socket\"" "http://192.168.0.100/restapi/upnp/profiles/:upnp_device_profile/model/"

Browse more samples

UPnP device profile: Model number

string	upnp/profiles/S/model_number/
Model number string

Retrieving the value is denied if not administrative user

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

This string represents a value in persistent storage.

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

uom get "upnp/profiles/${upnp_device_profile}/model_number"

⇒

""

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

print(requests.get('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile+'/model_number/',auth=auth,headers=headers).json())

⇒

''

Browse more samples

UPnP device profile: UUID prefix

string	upnp/profiles/S/uuid_prefix/
Outlet device identifier prefix

Retrieving the value is denied if not administrative user

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

This string represents a value in persistent storage.

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

print(uom.dump(uom.upnp.profiles[_upnp_device_profile].uuid_prefix))

⇒

"Socket-1_0"

Sample curl write command (note that :upnp_device_profile 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 "\"Socket-1_0\"" "http://192.168.0.100/restapi/upnp/profiles/:upnp_device_profile/uuid_prefix/"

Browse more samples

UPnP device profile: Device type

string	upnp/profiles/S/device_type/
Device type identifier

Retrieving the value is denied if not administrative user

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

This string represents a value in persistent storage.

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

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/upnp/profiles/:upnp_device_profile/device_type/"

⇒

"controllee"

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

requests.put('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile+'/device_type/',auth=auth,headers=headers,json='controllee')

Browse more samples

UPnP device profile: Device version

string	upnp/profiles/S/device_version/
Device version string

Retrieving the value is denied if not administrative user

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

This string represents a value in persistent storage.

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

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/upnp/profiles/:upnp_device_profile/device_version/"

⇒

"1"

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

uom.upnp.profiles[_upnp_device_profile].device_version="1"

Browse more samples

UPnP device profile: Service namespace

string	upnp/profiles/S/service_xmlns/
Service description XML namespace

Retrieving the value is denied if not administrative user

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

This string represents a value in persistent storage.

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

requests.put('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile+'/service_xmlns/',auth=auth,headers=headers,json='urn:Belkin:service-1-0')

Sample curl write command (note that :upnp_device_profile 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 "\"urn:Belkin:service-1-0\"" "http://192.168.0.100/restapi/upnp/profiles/:upnp_device_profile/service_xmlns/"

Browse more samples

UPnP device profile: Service ID

string	upnp/profiles/S/service_id/
Service identifier

Retrieving the value is denied if not administrative user

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

This string represents a value in persistent storage.

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

requests.put('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile+'/service_id/',auth=auth,headers=headers,json='basicevent1')

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

uom get "upnp/profiles/${upnp_device_profile}/service_id"

⇒

"basicevent1"

Browse more samples

UPnP device profile: Service type

string	upnp/profiles/S/service_type/
Service type identifier

Retrieving the value is denied if not administrative user

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

This string represents a value in persistent storage.

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

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/upnp/profiles/:upnp_device_profile/service_type/"

⇒

"basicevent"

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

request.put({url:"upnp/profiles/"+_upnp_device_profile+"/service_type/",body:"basicevent"});

Browse more samples

UPnP device profile: Service version

string	upnp/profiles/S/service_version/
Service version string

Retrieving the value is denied if not administrative user

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

This string represents a value in persistent storage.

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

print(requests.get('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile+'/service_version/',auth=auth,headers=headers).json())

⇒

'1'

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

uom set "upnp/profiles/${upnp_device_profile}/service_version" "\"1\""

Browse more samples

UPnP device profile: Service control URL

string	upnp/profiles/S/service_control_url/
URL to send service control requests to

Retrieving the value is denied if not administrative user

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

This string represents a value in persistent storage.

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

uom.upnp.profiles[_upnp_device_profile].service_control_url="/upnp/control/basicevent1"

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

uom get "upnp/profiles/${upnp_device_profile}/service_control_url"

⇒

"/upnp/control/basicevent1"

Browse more samples

UPnP device profile: Service event subscription URL

string	upnp/profiles/S/service_event_sub_url/
URL to send service subscription management requests to

Retrieving the value is denied if not administrative user

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

This string represents a value in persistent storage.

Sample curl write command (note that :upnp_device_profile 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 "\"/upnp/event/basicevent1\"" "http://192.168.0.100/restapi/upnp/profiles/:upnp_device_profile/service_event_sub_url/"

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

request.get({url:"upnp/profiles/"+_upnp_device_profile+"/service_event_sub_url/"},function(error,response,body) {console.log(body)});

⇒

"/upnp/event/basicevent1"

Browse more samples

UPnP device profile: Service SCPD URL

string	upnp/profiles/S/service_scpd_url/
Service control protocol document URL

Retrieving the value is denied if not administrative user

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

This string represents a value in persistent storage.

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

print(uom.dump(uom.upnp.profiles[_upnp_device_profile].service_scpd_url))

⇒

"/eventservice.xml"

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

print(requests.get('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile+'/service_scpd_url/',auth=auth,headers=headers).json())

⇒

'/eventservice.xml'

Browse more samples

UPnP device profile: Variable types

map	upnp/profiles/S/types/
Map of supported variable types

Retrieving the value is denied if not administrative user

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

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

This map represents a value in persistent storage.

This map contains Variable type elements.

Sample requests variable type creation command (note that _upnp_device_profile is a variable):

requests.put('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile+'/types/Boolean/',auth=auth,headers=headers,json={'decode': 'function(str) return str=="1" end', 'encode': 'function(value) return value and "1" or "0" end'})

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

uom get "upnp/profiles/${upnp_device_profile}/types"

⇒

{"Boolean":{"decode":"function(str) return str==\"1\" end","encode":"function(value) return value and \"1\" or \"0\" end"},"string":{"decode":"function(str) return str end","encode":"function(value) return value end"}}

Browse more samples

Variable type

object	upnp/profiles/S/types/S/
Variable type properties

The value is subject to the following constraints: index of the value matches ^[a-zA-Z_][a-zA-Z_0-9]*$

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

This object contains the following items:

decode	Decoding function
encode	Encoding function

Sample requests read command (note that _upnp_device_profile and _variable_type are variables):

print(requests.get('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile+'/types/'+_variable_type+'/',auth=auth,headers=headers).json())

⇒

{'decode': 'function(str) return str=="1" end', 'encode': 'function(value) return value and "1" or "0" end'}

Sample CLI write command (note that upnp_device_profile and variable_type are variables):

uom set "upnp/profiles/${upnp_device_profile}/types/${variable_type}" "{\"decode\":\"function(str) return str==\\\"1\\\" end\",\"encode\":\"function(value) return value and \\\"1\\\" or \\\"0\\\" end\"}"

Browse more samples

Decoding function

string	upnp/profiles/S/types/S/decode/
Code of Lua function to decode and validate the value's string representation

Retrieving the value is denied if not administrative user

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

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

This string represents a value in persistent storage.

Sample JS request write command (note that _upnp_device_profile and _variable_type are variables):

request.put({url:"upnp/profiles/"+_upnp_device_profile+"/types/"+_variable_type+"/decode/",body:"function(str) return str end"});

Sample CLI write command (note that upnp_device_profile and variable_type are variables):

uom set "upnp/profiles/${upnp_device_profile}/types/${variable_type}/decode" "\"function(str) return str==\\\"1\\\" end\""

Browse more samples

Encoding function

string	upnp/profiles/S/types/S/encode/
Code of Lua function to check and encode the value to string representation

Retrieving the value is denied if not administrative user

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

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

This string represents a value in persistent storage.

Sample curl write command (note that :upnp_device_profile and :variable_type 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 "\"function(value) return value and \\\"1\\\" or \\\"0\\\" end\"" "http://192.168.0.100/restapi/upnp/profiles/:upnp_device_profile/types/:variable_type/encode/"

Sample JS request write command (note that _upnp_device_profile and _variable_type are variables):

request.put({url:"upnp/profiles/"+_upnp_device_profile+"/types/"+_variable_type+"/encode/",body:"function(value) return value and \"1\" or \"0\" end"});

Browse more samples

UPnP device profile: State variables

map	upnp/profiles/S/state_variables/
Map of state variable bindings

Retrieving the value is denied if not administrative user

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

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

This map represents a value in persistent storage.

This map contains State variable binding elements.

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

print(uom.dump(uom.upnp.profiles[_upnp_device_profile].state_variables))

⇒

{BinaryState={default_value="0",events_enabled=true,name="state",type="Boolean"},FriendlyName={default_value="",events_enabled=true,name="name",type="string"}}

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

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/upnp/profiles/:upnp_device_profile/state_variables/"

⇒

{"FriendlyName":{"default_value":"","events_enabled":true,"name":"name","type":"string"},"BinaryState":{"default_value":"0","events_enabled":true,"name":"state","type":"Boolean"}}

Browse more samples

State variable binding

object	upnp/profiles/S/state_variables/S/
Properties of a state variable binding

The value is subject to the following constraints: index of the value matches ^[a-zA-Z_][a-zA-Z_0-9]*$

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

This object contains the following items:

name	Outlet property name
type	Variable type
default_value	Default variable name
events_enabled	Events

Sample uom library write command (note that _upnp_device_profile and _state_variable_binding are variables):

uom.upnp.profiles[_upnp_device_profile].state_variables[_state_variable_binding]={default_value="0",events_enabled=true,name="state",type="Boolean"}

Sample uom library deletion command (note that _upnp_device_profile and _state_variable_binding are variables):

local composite=uom.copy(uom.upnp.profiles[_upnp_device_profile].state_variables)
uom.remove(composite,_state_variable_binding)
uom.upnp.profiles[_upnp_device_profile].state_variables=composite

Browse more samples

Outlet property name

string	upnp/profiles/S/state_variables/S/name/
The outlet property to which the variable is bound

Retrieving the value is denied if not administrative user

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

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

This string represents a value in persistent storage.

Sample curl read command (note that :upnp_device_profile and :state_variable_binding are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/upnp/profiles/:upnp_device_profile/state_variables/:state_variable_binding/name/"

⇒

"state"

Sample CLI read command (note that upnp_device_profile and state_variable_binding are variables):

uom get "upnp/profiles/${upnp_device_profile}/state_variables/${state_variable_binding}/name"

⇒

"state"

Browse more samples

Variable type

string	upnp/profiles/S/state_variables/S/type/
The type of the variable

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

Retrieving the value is denied if not administrative user

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

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

This string represents a value in persistent storage.

Sample uom library read command (note that _upnp_device_profile and _state_variable_binding are variables):

print(uom.dump(uom.upnp.profiles[_upnp_device_profile].state_variables[_state_variable_binding].type))

⇒

"Boolean"

Sample curl write command (note that :upnp_device_profile and :state_variable_binding 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 "\"string\"" "http://192.168.0.100/restapi/upnp/profiles/:upnp_device_profile/state_variables/:state_variable_binding/type/"

Browse more samples

Default variable name

string	upnp/profiles/S/state_variables/S/default_value/
The string-encoded default value of the state variable

Retrieving the value is denied if not administrative user

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

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

This string represents a value in persistent storage.

Sample JS request read command (note that _upnp_device_profile and _state_variable_binding are variables):

request.get({url:"upnp/profiles/"+_upnp_device_profile+"/state_variables/"+_state_variable_binding+"/default_value/"},function(error,response,body) {console.log(body)});

⇒

""

Sample uom library write command (note that _upnp_device_profile and _state_variable_binding are variables):

uom.upnp.profiles[_upnp_device_profile].state_variables[_state_variable_binding].default_value=""

Browse more samples

Events

sum (boolean)	upnp/profiles/S/state_variables/S/events_enabled/
Send events on property change

Retrieving the value is denied if not administrative user

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

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

This sum represents a value in persistent storage.

This sum can assume the following values:

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

Sample uom library read command (note that _upnp_device_profile and _state_variable_binding are variables):

print(uom.dump(uom.upnp.profiles[_upnp_device_profile].state_variables[_state_variable_binding].events_enabled))

⇒

true

Sample curl read command (note that :upnp_device_profile and :state_variable_binding are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/upnp/profiles/:upnp_device_profile/state_variables/:state_variable_binding/events_enabled/"

⇒

true

Browse more samples

Arguments: Argument

object	upnp/profiles/S/actions/S/arguments/N/
Action input or output argument properties

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

This object contains the following items:

name	Argument name
type	Argument type
is_output	Output/return value flag
state_id	Related state variable identifier, if any

Sample JS request write command (note that _upnp_device_profile, _action and _argument_index are variables):

request.put({url:"upnp/profiles/"+_upnp_device_profile+"/actions/"+_action+"/arguments/"+_argument_index.toString()+"/",body:{"is_output":false,"state_id":"BinaryState","name":"BinaryState","type":"Boolean"}});

Sample requests deletion command (note that _upnp_device_profile, _action and _argument_index are variables):

requests.delete('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile+'/actions/'+_action+'/arguments/'+str(_argument_index)+'/',auth=auth,headers=headers)

Browse more samples

Argument name

string	upnp/profiles/S/actions/S/arguments/N/name/
The name of the argument as seen by clients

The value is subject to the following constraints: the value matches ^[a-zA-Z_][a-zA-Z_0-9]*$

Retrieving the value is denied if not administrative user

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

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

This string represents a value in persistent storage.

Sample requests read command (note that _upnp_device_profile, _action and _argument_index are variables):

print(requests.get('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile+'/actions/'+_action+'/arguments/'+str(_argument_index)+'/name/',auth=auth,headers=headers).json())

⇒

'BinaryState'

Sample CLI write command (note that upnp_device_profile, action and argument_index are variables):

uom set "upnp/profiles/${upnp_device_profile}/actions/${action}/arguments/${argument_index}/name" "\"FriendlyName\""

Browse more samples

Argument type

string	upnp/profiles/S/actions/S/arguments/N/type/
The type of the argument

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

Retrieving the value is denied if not administrative user

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

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

This string represents a value in persistent storage.

Sample CLI read command (note that upnp_device_profile, action and argument_index are variables):

uom get "upnp/profiles/${upnp_device_profile}/actions/${action}/arguments/${argument_index}/type"

⇒

"string"

Sample JS request write command (note that _upnp_device_profile, _action and _argument_index are variables):

request.put({url:"upnp/profiles/"+_upnp_device_profile+"/actions/"+_action+"/arguments/"+_argument_index.toString()+"/type/",body:"string"});

Browse more samples

Output/return value flag

sum (boolean)	upnp/profiles/S/actions/S/arguments/N/is_output/
Flag indicating that the argument is output/return instead of input

Retrieving the value is denied if not administrative user

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

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Output/return	The argument is output, and also the return value if it's the first output argument
constant false	Input	The argument is input

Sample requests write command (note that _upnp_device_profile, _action and _argument_index are variables):

requests.put('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile+'/actions/'+_action+'/arguments/'+str(_argument_index)+'/is_output/',auth=auth,headers=headers,json=True)

Sample requests read command (note that _upnp_device_profile, _action and _argument_index are variables):

print(requests.get('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile+'/actions/'+_action+'/arguments/'+str(_argument_index)+'/is_output/',auth=auth,headers=headers).json())

⇒

True

Browse more samples

Related state variable identifier, if any

sum (optional string)	upnp/profiles/S/actions/S/arguments/N/state_id/
The identifier of the state variable to which the argument is related, if any

Retrieving the value is denied if not administrative user

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

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	No related state variable	The argument isn't related to a state variable
string	Related state variable identifier	The identifier of the state variable to which the argument is related	state variables[the value]

Sample curl write command (note that :upnp_device_profile, :action and :argument_index are URL template arguments):

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"FriendlyName\"" "http://192.168.0.100/restapi/upnp/profiles/:upnp_device_profile/actions/:action/arguments/:argument_index/state_id/"

Sample CLI write command (note that upnp_device_profile, action and argument_index are variables):

uom set "upnp/profiles/${upnp_device_profile}/actions/${action}/arguments/${argument_index}/state_id" "\"FriendlyName\""

Browse more samples

UPnP device profile: Action map

map	upnp/profiles/S/actions/
Map of actions that can be performed on the outlet

Retrieving the value is denied if not administrative user

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

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

This map represents a value in persistent storage.

This map contains Action elements.

Sample CLI action creation command (note that upnp_device_profile is a variable):

uom insert "upnp/profiles/${upnp_device_profile}/actions/GetBinaryState" "{\"code\":\"function(outlet) return outlet.state end\",\"arguments\":[{\"is_output\":true,\"state_id\":\"BinaryState\",\"name\":\"BinaryState\",\"type\":\"Boolean\"}]}"

Sample JS request action creation command (note that _upnp_device_profile is a variable):

request.put({url:"upnp/profiles/"+_upnp_device_profile+"/actions/SetBinaryState/",body:{"code":"function(outlet,value) outlet.state=value end","arguments":[{"is_output":false,"state_id":"BinaryState","name":"BinaryState","type":"Boolean"}]}});

Browse more samples

Action

object	upnp/profiles/S/actions/S/
Action properties

The value is subject to the following constraints: index of the value matches ^[a-zA-Z_][a-zA-Z_0-9]*$

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

This object contains the following items:

arguments	Arguments
code	Code

Sample requests deletion command (note that _upnp_device_profile and _action are variables):

requests.delete('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile+'/actions/'+_action+'/',auth=auth,headers=headers)

Sample requests read command (note that _upnp_device_profile and _action are variables):

print(requests.get('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile+'/actions/'+_action+'/',auth=auth,headers=headers).json())

⇒

{'code': 'function(outlet) return outlet.name end', 'arguments': [{'is_output': True, 'state_id': 'FriendlyName', 'name': 'FriendlyName', 'type': 'string'}]}

Browse more samples

Arguments

array	upnp/profiles/S/actions/S/arguments/
Action input and output arguments

Retrieving the value is denied if not administrative user

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

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

This array represents a value in persistent storage.

This array contains Argument elements.

Sample uom library argument creation command (note that _upnp_device_profile and _action are variables):

local composite=uom.copy(uom.upnp.profiles[_upnp_device_profile].actions)
uom.insert(composite[_action].arguments,1,{is_output=false,name="BinaryState",state_id="BinaryState",type="Boolean"})
uom.upnp.profiles[_upnp_device_profile].actions=composite

Sample uom library read command (note that _upnp_device_profile and _action are variables):

print(uom.dump(uom.upnp.profiles[_upnp_device_profile].actions[_action].arguments))

⇒

{{is_output=true,name="BinaryState",state_id="BinaryState",type="Boolean"}}

Browse more samples

Code

string	upnp/profiles/S/actions/S/code/
Code of Lua function to perform the action

Retrieving the value is denied if not administrative user

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

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

This string represents a value in persistent storage.

Sample JS request read command (note that _upnp_device_profile and _action are variables):

request.get({url:"upnp/profiles/"+_upnp_device_profile+"/actions/"+_action+"/code/"},function(error,response,body) {console.log(body)});

⇒

"function(outlet) return outlet.state end"

Sample requests read command (note that _upnp_device_profile and _action are variables):

print(requests.get('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile+'/actions/'+_action+'/code/',auth=auth,headers=headers).json())

⇒

'function(outlet) return outlet.state end'

Browse more samples

UPnP device profile: SOAP XML namespace prefix override, if any

sum (optional string)	upnp/profiles/S/soap_xmlns_prefix_override/
SOAP XML namespace prefix to use on encoding instead of the default one (for compatibility), if any

Retrieving the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	None	Use the default SOAP XML namespace prefix ('soap11')
string	SOAP XML namespace prefix override	SOAP XML namespace prefix to use on encoding instead of the default one (for compatibility)	the value matches ^([A-Za-z_][A-Za-z0-9_-]?\|[A-WYZa-wyz_][A-Za-z0-9_-]{2,}\|[xX][A-LN-Za-ln-z0-9_-][A-Za-z0-9_-]{1,}\|[xX][mM][A-KM-Za-km-z0-9_-][A-Za-z0-9_-]*)$

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

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "null" "http://192.168.0.100/restapi/upnp/profiles/:upnp_device_profile/soap_xmlns_prefix_override/"

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

uom get "upnp/profiles/${upnp_device_profile}/soap_xmlns_prefix_override"

⇒

null

Browse more samples

UPnP device profile: Service XML namespace prefix override, if any

sum (optional string)	upnp/profiles/S/service_xmlns_prefix_override/
Service XML namespace prefix to use on encoding instead of the default one (for compatibility), if any

Retrieving the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	None	Use the default service XML namespace prefix ('svc')
string	Service XML namespace prefix override	Service XML namespace prefix to use on encoding instead of the default one (for compatibility)	the value matches ^([A-Za-z_][A-Za-z0-9_-]?\|[A-WYZa-wyz_][A-Za-z0-9_-]{2,}\|[xX][A-LN-Za-ln-z0-9_-][A-Za-z0-9_-]{1,}\|[xX][mM][A-KM-Za-km-z0-9_-][A-Za-z0-9_-]*)$

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

requests.put('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile+'/service_xmlns_prefix_override/',auth=auth,headers=headers,json=None)

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

uom.upnp.profiles[_upnp_device_profile].service_xmlns_prefix_override="XkC2DPr"

Browse more samples

UPnP device profile: Event XML namespace prefix override, if any

sum (optional string)	upnp/profiles/S/event_xmlns_prefix_override/
Event XML namespace prefix to use on encoding instead of the default one (for compatibility), if any

Retrieving the value is denied if not administrative user

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

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	None	Use the default event XML namespace prefix ('event')
string	Event XML namespace prefix override	Event XML namespace prefix to use on encoding instead of the default one (for compatibility)	the value matches ^([A-Za-z_][A-Za-z0-9_-]?\|[A-WYZa-wyz_][A-Za-z0-9_-]{2,}\|[xX][A-LN-Za-ln-z0-9_-][A-Za-z0-9_-]{1,}\|[xX][mM][A-KM-Za-km-z0-9_-][A-Za-z0-9_-]*)$

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

uom.upnp.profiles[_upnp_device_profile].event_xmlns_prefix_override=null

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

print(requests.get('http://192.168.0.100/restapi/upnp/profiles/'+_upnp_device_profile+'/event_xmlns_prefix_override/',auth=auth,headers=headers).json())

⇒

'rK_t'

Browse more samples

Notifications

object	upnp/notifications/
UPnP-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 uom library read command:

print(uom.dump(uom.upnp.notifications))

⇒

{events={["dli.upnp.sample_event"]={message_template={"sample event"},parameters={{fixed_value=null,has_fixed_value=false,id="sample_parameter"}}}},parameter_kinds={}}

Sample curl read command:

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

⇒

{"events":{"dli.upnp.sample_event":{"parameters":[{"id":"sample_parameter","has_fixed_value":false,"fixed_value":null}],"message_template":["sample event"]}},"parameter_kinds":[]}

Browse more samples

Parameter kinds

object	upnp/notifications/parameter_kinds/
Kinds of event parameters

This object does not correspond to an actual resource.

This object is empty.

Events

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

uom get "upnp/notifications/events"

⇒

{"dli.upnp.sample_event":{"parameters":[{"id":"sample_parameter","has_fixed_value":false,"fixed_value":null}],"message_template":["sample event"]}}

Sample curl read command:

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

⇒

{"dli.upnp.sample_event":{"parameters":[{"id":"sample_parameter","has_fixed_value":false,"fixed_value":null}],"message_template":["sample event"]}}

Browse more samples

Event parameters: Event parameter

object	upnp/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 CLI write command (note that event and event_parameter_index are variables):

uom set "upnp/notifications/events/${event}/parameters/${event_parameter_index}" "{\"id\":\"sample_parameter\",\"has_fixed_value\":false,\"fixed_value\":null}"

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

request.put({url:"upnp/notifications/events/"+_event+"/parameters/"+_event_parameter_index.toString()+"/",body:{"id":"sample_parameter","has_fixed_value":false,"fixed_value":null}});

Browse more samples

Identifier

string	upnp/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 uom library read command (note that _event and _event_parameter_index are variables):

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

⇒

"sample_parameter"

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

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

⇒

"sample_parameter"

Browse more samples

Fixed value flag

sum (boolean)	upnp/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 uom library read command (note that _event and _event_parameter_index are variables):

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

⇒

false

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

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

⇒

false

Browse more samples

Fixed value

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

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

⇒

null

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

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

⇒

None

Browse more samples

Events: Event

object	upnp/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 CLI read command (note that event is a variable):

uom get "upnp/notifications/events/${event}"

⇒

{"parameters":[{"id":"sample_parameter","has_fixed_value":false,"fixed_value":null}],"message_template":["sample event"]}

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

requests.put('http://192.168.0.100/restapi/upnp/notifications/events/'+_event+'/',auth=auth,headers=headers,json={'parameters': [{'id': 'sample_parameter', 'has_fixed_value': False, 'fixed_value': None}], 'message_template': ['sample event']})

Browse more samples

Message template

array	upnp/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 CLI read command (note that event is a variable):

uom get "upnp/notifications/events/${event}/message_template"

⇒

["sample event"]

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

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

⇒

["sample event"]

Browse more samples

Message template element

sum (variant)	upnp/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 requests read command (note that _event and _message_template_element_index are variables):

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

⇒

'sample event'

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

⇒

"sample event"

Browse more samples

Severity

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

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

⇒

{}

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

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/upnp/notifications/events/:event/severity/"

⇒

[]

Browse more samples

Event parameters

array	upnp/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/upnp/notifications/events/'+_event+'/parameters/',auth=auth,headers=headers).json())

⇒

[{'id': 'sample_parameter', 'has_fixed_value': False, 'fixed_value': None}]

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

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

⇒

{{fixed_value=null,has_fixed_value=false,id="sample_parameter"}}

Browse more samples

nid	Namespace identifier
device_xmlns	Device namespace
manufacturer	Manufacturer
model	Model
model_number	Model number
uuid_prefix	UUID prefix
device_type	Device type
device_version	Device version
service_xmlns	Service namespace
service_id	Service ID
service_type	Service type
service_version	Service version
service_control_url	Service control URL
service_event_sub_url	Service event subscription URL
service_scpd_url	Service SCPD URL
types	Variable types
state_variables	State variables
actions	Action map
soap_xmlns_prefix_override	SOAP XML namespace prefix override, if any
service_xmlns_prefix_override	Service XML namespace prefix override, if any
event_xmlns_prefix_override	Event XML namespace prefix override, if any