<div class="section" id="value-documentation">

<h1>Value documentation</h1>

<p>The value.</p>

<div class="toctree-wrapper compound">

<ul class="simple">

<span class="target" id="module-openzwave.value"></span><span class="target" id="module-openzwave.value"></span><dl class="docutils">

<dt>This file is part of <strong>python-openzwave</strong> project <a class="reference external" href="https://github.com/OpenZWave/python-openzwave">https://github.com/OpenZWave/python-openzwave</a>.</dt>

<dd><table class="first last docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">platform:</th><td class="field-body">Unix, Windows, MacOS X</td>

<tr class="field-even field"><th class="field-name">sinopsis:</th><td class="field-body">openzwave API</td>

<p>License : GPL(v3)</p>

<p><strong>python-openzwave</strong> is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.</p>

<p><strong>python-openzwave</strong> is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with python-openzwave. If not, see <a class="reference external" href="http://www.gnu.org/licenses">http://www.gnu.org/licenses</a>.</p>

<dl class="class">

<dt id="openzwave.value.ZWaveValue">

<em class="property">class </em><tt class="descclassname">openzwave.value.</tt><tt class="descname">ZWaveValue</tt><big>(</big><em>value_id</em>, <em>network=None</em>, <em>parent=None</em><big>)</big></dt>

<dd><p>Represents a single value.</p>

<dl class="method">

<dt id="openzwave.value.ZWaveValue.check_data">

<tt class="descname">check_data</tt><big>(</big><em>data</em><big>)</big></dt>

<dd><p>Check that data is correct for this value.

Return the data in a correct type. None is data is incorrect.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<em>lambda</em>) &#8211; The data value to check</td>

<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A variable of the good type if the data is correct. None otherwise.</td>

<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">variable</td>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.command_class">

<tt class="descname">command_class</tt></dt>

<dd><p>The command class of the value.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The command class of this value</td>

<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int</td>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.data">

<tt class="descname">data</tt></dt>

<dd><p>Get the current data of the value.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The data of the value</td>

<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">depending of the type of the value</td>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.data_as_string">

<tt class="descname">data_as_string</tt></dt>

<dd><p>Get the value data as String.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.data_items">

<tt class="descname">data_items</tt></dt>

<dd><p>When type of value is list, data_items contains a list of valid values</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The valid values or a help string</td>

<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">string or set</td>

<dl class="method">

<dt id="openzwave.value.ZWaveValue.disable_poll">

<tt class="descname">disable_poll</tt><big>(</big><big>)</big></dt>

<dd><p>Disable poll off this value.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if polling was disabled.</td>

<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>

<dl class="method">

<dt id="openzwave.value.ZWaveValue.enable_poll">

<tt class="descname">enable_poll</tt><big>(</big><em>intensity=1</em><big>)</big></dt>

<dd><p>Enable the polling of a device&#8217;s state.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>intensity</strong> (<em>int</em>) &#8211; The intensity of the poll</td>

<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if polling was enabled.</td>

<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.genre">

<tt class="descname">genre</tt></dt>

<dd><p>Get the genre of the value. The genre classifies a value to enable

low-level system or configuration parameters to be filtered out

by the application</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">genre of the value (Basic, User, Config, System)</td>

<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.help">

<tt class="descname">help</tt></dt>

<dd><p>Gets a help string describing the value&#8217;s purpose and usage.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.id_on_network">

<tt class="descname">id_on_network</tt></dt>

<dd><p>Get an unique id for this value.</p>

<p>The scenes use this to retrieve values</p>

<div class="highlight-xml"><div class="highlight"><pre><span class="nt">&lt;Scene</span> <span class="na">id=</span><span class="s">&quot;1&quot;</span> <span class="na">label=</span><span class="s">&quot;scene1&quot;</span><span class="nt">&gt;</span>

<span class="nt">&lt;Value</span> <span class="na">homeId=</span><span class="s">&quot;0x014d0ef5&quot;</span> <span class="na">nodeId=</span><span class="s">&quot;2&quot;</span> <span class="na">genre=</span><span class="s">&quot;user&quot;</span> <span class="na">commandClassId=</span><span class="s">&quot;38&quot;</span> <span class="na">instance=</span><span class="s">&quot;1&quot;</span> <span class="na">index=</span><span class="s">&quot;0&quot;</span> <span class="na">type=</span><span class="s">&quot;byte&quot;</span><span class="nt">&gt;</span>54<span class="nt">&lt;/Value&gt;</span>

<span class="nt">&lt;/Scene&gt;</span>

<p>The format is :</p>

<div>home_id.node_id.command_class.instance.index</div></blockquote>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.index">

<tt class="descname">index</tt></dt>

<dd><p>Get the value index. The index is used to identify one of multiple

values created and managed by a command class. In the case of configurable

parameters (handled by the configuration command class), the index is the

same as the parameter ID.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">index of the value</td>

<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int</td>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.instance">

<tt class="descname">instance</tt></dt>

<dd><p>Get the command class instance of this value. It is possible for there to be

multiple instances of a command class, although currently it appears that

only the SensorMultilevel command class ever does this.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">instance of the value</td>

<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int</td>

<dl class="method">

<dt id="openzwave.value.ZWaveValue.is_change_verified">

<tt class="descname">is_change_verified</tt><big>(</big><big>)</big></dt>

<dd><p>determine if value changes upon a refresh should be verified.

If so, the library will immediately refresh the value a second time whenever a change is observed.

This helps to filter out spurious data reported occasionally by some devices.</p>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.is_polled">

<tt class="descname">is_polled</tt></dt>

<dd><p>Verify that the value is polled.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.is_read_only">

<tt class="descname">is_read_only</tt></dt>

<dd><p>Test whether the value is read-only.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the value cannot be changed by the user.</td>

<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.is_set">

<tt class="descname">is_set</tt></dt>

<dd><p>Test whether the value has been set.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the value has actually been set by a status message

from the device, rather than simply being the default.</td>

<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.is_write_only">

<tt class="descname">is_write_only</tt></dt>

<dd><p>Test whether the value is write-only.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the value can only be written to and not read.</td>

<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.label">

<tt class="descname">label</tt></dt>

<dd><p>Get the label of the value.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.max">

<tt class="descname">max</tt></dt>

<dd><p>Gets the maximum that this value may contain.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">int</td>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.min">

<tt class="descname">min</tt></dt>

<dd><p>Gets the minimum that this value may contain.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">int</td>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.node">

<tt class="descname">node</tt></dt>

<dd><p>The value_id of the value.</p>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.parent_id">

<tt class="descname">parent_id</tt></dt>

<dd><p>Get the parent_id of the value.</p>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.poll_intensity">

<tt class="descname">poll_intensity</tt></dt>

<dd><p>The poll intensity of the value.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">0=none, 1=every time through the list, 2-every other time, etc</td>

<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int</td>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.precision">

<tt class="descname">precision</tt></dt>

<dd><p>Gets a float value&#8217;s precision.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a float value&#8217;s precision</td>

<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int</td>

<dl class="method">

<dt id="openzwave.value.ZWaveValue.refresh">

<tt class="descname">refresh</tt><big>(</big><big>)</big></dt>

<dd><p>Refresh the value.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the command was transmitted to controller</td>

<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>

<dl class="method">

<dt id="openzwave.value.ZWaveValue.set_change_verified">

<tt class="descname">set_change_verified</tt><big>(</big><em>verify</em><big>)</big></dt>

<dd><p>Sets a flag indicating whether value changes noted upon a refresh should be verified.</p>

<p>If so, the library will immediately refresh the value a second time whenever a change is observed.

This helps to filter out spurious data reported occasionally by some devices.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>verify</strong> (<em>bool</em>) &#8211; if true, verify changes; if false, don&#8217;t verify changes.</td>

<dl class="method">

<dt id="openzwave.value.ZWaveValue.to_dict">

<tt class="descname">to_dict</tt><big>(</big><em>extras=['all']</em><big>)</big></dt>

<dd><p>Return a dict representation of the node.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>extras</strong> (<em>[]</em>) &#8211; The extra inforamtions to add</td>

<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A dict</td>

<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">dict()</td>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.type">

<tt class="descname">type</tt></dt>

<dd><p>Get the type of the value. The type describes the data held by the value

and enables the user to select the correct value accessor method in the

Manager class.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">type of the value</td>

<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.units">

<tt class="descname">units</tt></dt>

<dd><p>Gets the units that the value is measured in.</p>

<table class="docutils field-list" frame="void" rules="none">

<col class="field-name" />

<col class="field-body" />

<tbody valign="top">

<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>

<dl class="attribute">

<dt id="openzwave.value.ZWaveValue.value_id">

<tt class="descname">value_id</tt></dt>

<dd><p>Get the value_id of the value.</p>