Simonc: Created page with "= Configuration Service = == Overview == The Configuration service provides access to all user-configurable values on a product. It is intended as a developer aid only - configu..."

2015-12-15T13:18:03Z

Created page with "= Configuration Service = == Overview == The Configuration service provides access to all user-configurable values on a product. It is intended as a developer aid only - configu..."

New page

= Configuration Service =
== Overview ==
The Configuration service provides access to all user-configurable values on a product. It is intended as a developer aid only - configuration UIs should use the web app framework instead.

If a device's [[Av:Developer:Eriskay:DeviceService | Device]] service to reports the attribute <tt>openhome.org.configuration</tt> in its <tt>version</tt> section, that device is guaranteed to bear the Configuration service. If the Configuration service is available, all its properties and actions must be fully implemented.

== Actions ==
=== GetKeys ===
<tt>
Arguments: (out string keys)
</tt> 
Read a JSON list of all configuration items for the product.

=== SetValue ===
<tt>
Arguments: (in string key, in string value)
</tt> 
Update the value of a configuration item.

Returns a <tt>800</tt> fault code if the specified key does not match a configuration item.
 Returns a <tt>801</tt> fault code if the configuration item has integer type but the specified value is not a number.
 Returns a <tt>802</tt> fault code if the configuration item has integer type but the specified value is outside the permitted range.
 Returns a <tt>803</tt> fault code if the configuration item has a list of allowed values and the specified value is not in this allowed list.
 Returns a <tt>804</tt> fault code if the specified value is longer than the maximum storage available for the configuration item.

=== GetValue ===
<tt>
Arguments: (in string key, out string value)
</tt> 
Read the value of a configuration item.
 The return value is always text; the caller is responsible for converting this to an integer if necessary.

Returns a <tt>800</tt> fault code if the specified key does not match a configuration item.

== UPnP Service Description ==
For devices supporting the UPnP protocol, the service description is

<tt>name: "Configuration"
 domain: "openhome.org.eriskay"
 version: "1"</tt>

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<scpd xmlns="urn:schemas-upnp-org:service-1-0">
<specVersion>
<major>1</major>
<minor>0</minor>
</specVersion>
<actionList>
<action>
<name>GetKeys</name>
<argumentList>
<argument>
<name>KeyList</name>
<direction>out</direction>
<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>SetValue</name>
<argumentList>
<argument>
<name>Key</name>
<direction>in</direction>
<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
</argument>
<argument>
<name>Value</name>
<direction>in</direction>
<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
</argument>
</argumentList>
</action>
<action>
<name>GetValue</name>
<argumentList>
<argument>
<name>Key</name>
<direction>in</direction>
<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
</argument>
<argument>
<name>Value</name>
<direction>out</direction>
<relatedStateVariable>A_ARG_TYPE_String</relatedStateVariable>
</argument>
</argumentList>
</action>
</actionList>
<serviceStateTable>
<stateVariable sendEvents="no">
<name>A_ARG_TYPE_String</name>
<dataType>string</dataType>
</stateVariable>
</serviceStateTable>
</scpd>
</syntaxhighlight>

Av:Developer:Eriskay:ConfigurationService - Revision history

Simonc: Created page with "= Configuration Service = == Overview == The Configuration service provides access to all user-configurable values on a product. It is intended as a developer aid only - configu..."