Ecolink Door / Window Sensor Missing Config Parameters - Unable to reset case open tamper

pdobrien3 commented 4 years ago

Issue Guidelines

Before opening a new issue, please review the following:

The Github Issues is for OZW Bugs only. Please do not use this for general questions or howto type conversations. If you have a question, please post to our mailing list at https://groups.google.com/forum/#!forum/openzwave
Please use the search feature to see if your issues have been raised or addressed first.
Try the OpenZWave Log Analyzer at http://www.openzwave.com/log-analyzer if you are experiencing problems with a device on your network.
Often we will require Log Files to help diagnose the issue. Please stop any application you are using, remove zwcfg*.xml/ozwcache*.xml files, and restart your application. After experiencing your issue, stop your application and attach the OZW_Log.txt file to this issue (please do not filter the log file, we often need the full log file to diagnose issues)
If you want to add a new device to the OZW Database, please consult https://github.com/OpenZWave/open-zwave/wiki/Adding-Devices

According to the manual: Parameter #1 - Configuration Value: 0x00 - (Default) Sensor does NOT send basic sets to node IDs in Association Group 2 when the sensor is resored (ie Door/Window closed). Parameter #1 - Configuration Value: 0xFF - Sensor sends Basic Sets of 0x00 to nodes in Association Group2 when sensor is restored. Parameter #2 - Configuration Value: 0x00 - (Default) Sensor sends Sensor Binary Reports when sensor is faulted and restored for backwards compatibility in addition to Notification Reports. Parameter #2 - Configuration Value: 0xFF - Sensor will send only Notification Reports and NOT Sensor Binary Reports when the sensor is faulted and restored.

As far as I can tell, these Parameters are not included in the device xml nor are they available under config values in ozw admin.

The end result of this (I believe) is that there is no way to turn of a tamper notification when the case is opened besides excluding and re-including the device.

pdobrien3 commented 4 years ago

While this is my first attempt at configuring an xml file, I believe this will correct the issue.

<!-- Configuration Parameters -->
<CommandClass id="112">
  <Value type="list" index="1" genre="config" label="Basic Set Report when sensor is restored" units="" max="1" min="0" size="1" value="0">
    <Help>
    Configures the sensor to send or not send Basic Sets to nodes IDs in Association group 2 when the sensor is in a restored state (i.e. Door/Window Closed).  
    By default the sensor does NOT send Basic Set commands.
    </Help>
    <Item label="Disable" value="0"/>
    <Item label="Enable" value="255"/>
  </Value>
  <Value type="list" index="2" genre="config" label="Sensor Binary / Notification Reports" units="" max="1" min="0" size="1" value="0">
    <Help>
    Configures the sensor to either send Sensor Binary Report and Notification Reports or only Notification Reports when the sensor is faulted and restored.  
    </Help>
    <Item label="Enable Binary Reports" value="0"/>
    <Item label="Disable Binary Reports" value="255"/>
  </Value>
</CommandClass>

pdobrien3 commented 4 years ago

<!--
Ecolink Door Window Sensor (DWZWAVE2.5-ECO)
http://products.z-wavealliance.org/products/1498
--><Product Revision="7" xmlns="https://github.com/OpenZWave/open-zwave">
  <MetaData>
    <MetaDataItem name="OzwInfoPage">http://www.openzwave.com/device-database/014A:0002:0001</MetaDataItem>
    <MetaDataItem name="ProductPic">images/ecolink/doorwindow.png</MetaDataItem>
    <MetaDataItem id="0002" name="ZWProductPage" type="0001">https://products.z-wavealliance.org/products/1498/</MetaDataItem>
    <MetaDataItem id="0002" name="FrequencyName" type="0001">U.S. / Canada / Mexico</MetaDataItem>
    <MetaDataItem name="Name">EU Z-WAVE DOOR WINDOW SENSOR</MetaDataItem>
    <MetaDataItem name="Description">Includes Brown &amp; White covers
Sleek design virtually disappears
Easy-to-open case requires no special tools
Case tamper protection
Ideal for double-hung window
Up to 3 year battery life on 1 CR123A lithium battery
Uses rare earth magnet for up to 5/8th inch gap detection
Includes white and brown cases</MetaDataItem>
    <MetaDataItem id="0002" name="Identifier" type="0001">DWZWAVE2.5-ECO</MetaDataItem>
    <ChangeLog>
      <Entry author="Justin Hammond - Justin@dynam.ac" date="03 May 2019" revision="4">Initial Metadata Import from Z-Wave Alliance Database - https://products.z-wavealliance.org/products/790/xml</Entry>
      <Entry author="Justin Hammond - Justin@dynam.ac" date="08 May 2019" revision="5">Updated Metadata Import from Z-Wave Alliance Database - https://products.z-wavealliance.org/products/1498/xml</Entry>
      <Entry author="Justin Hammond - Justin@dynam.ac" date="02 Jun 2019" revision="6">Updated Metadata Import from Z-Wave Alliance Database - https://products.z-wavealliance.org/products/2927/xml</Entry>
      <Entry author="Paul OBrien - pdobrien3@gmail.com" date="13 Aug 2020" revision="7">Updated Configuration Parameters</Entry>
    </ChangeLog>
    <MetaDataItem name="ProductManual">https://Products.Z-WaveAlliance.org/ProductManual/File?folder=&amp;filename=Manuals/2927/EU Z-wave Door Window Sensor H114101 ZWAVE_Ver03.pdf</MetaDataItem>
    <MetaDataItem name="WakeupDescription">The sensor will wake up every so often and when the case is closed to send a Wake-Up Notification to allow the life line master node controller that the sensor is now available for any queued messages that the controller may have for the sensor. The time between Wake-Up Notifications can be configured with the Wake-Up Notification command class to be between 1 hour and 1 week with interval steps of 200 seconds. </MetaDataItem>
    <MetaDataItem name="InclusionDescription">The sensor must be added to a Z-Wave network prior to use. To include the sensor in a network both the sensor and the network controller must be in inclusion mode at the same time. Refer to the instructions provided by the manufacturer of your specific controller for details on initiating the controller’s inclusion mode. 

STEP ONE         Start by placing the controller into inclusion mode.

STEP TWO        Activate inclusion mode for the sensor by removing the plastic pull-tab from the back of the sensor.  When the
    inclusion process is complete, the LED on the sensor will be solid blue, then go out.

STEP THREE    Test the sensor.  Place the magnet next to the sensor to represent a closed position (see Installation section 
          to see where to position the magnet).  If the LED flashes ONE TIME, it is successfully communicating on your 
          Zwave network.  If the LED on the sensor flashes slow and steady for 5 seconds, you need to repeat the 
          inclusion process.
</MetaDataItem>
    <MetaDataItem name="ExclusionDescription">Exclusion mode on the senor is initiated following the same exact procedure as inclusion.</MetaDataItem>
    <MetaDataItem name="ResetDescription">To restore this sensor to factory default settings, follow the instructions in this manual to exclude this sensor from the Z-Wave network. Upon completion of removal from the network the sensor will restore itself to factory default settings automatically.  Use this procedure only in the event that the network primary controller is missing or otherwise inoperable.</MetaDataItem>
    <MetaDataItem id="0002" name="ZWProductPage" type="0004">https://products.z-wavealliance.org/products/2927/</MetaDataItem>
    <MetaDataItem id="0002" name="FrequencyName" type="0004">CEPT (Europe)</MetaDataItem>
    <MetaDataItem id="0002" name="Identifier" type="0004">H114101</MetaDataItem>
  </MetaData>
  <!-- Basic set as report-->
  <CommandClass id="32">
    <Compatibility>
      <SetAsReport>true</SetAsReport>
    </Compatibility>
  </CommandClass>
  <!-- Configuration Parameters -->
  <CommandClass id="112">
    <Value type="list" index="1" genre="config" label="Basic Set Report when sensor is restored" units="" max="1" min="0" size="1" value="0">
      <Help>
      Configures the sensor to send or not send Basic Sets to nodes IDs in Association group 2 when the sensor is in a restored state (i.e. Door/Window Closed).  
      By default the sensor does NOT send Basic Set commands.
      </Help>
      <Item label="Disable" value="0"/>
      <Item label="Enable" value="255"/>
    </Value>
    <Value type="list" index="2" genre="config" label="Sensor Binary / Notification Reports" units="" max="1" min="0" size="1" value="0">
      <Help>
      Configures the sensor to either send Sensor Binary Report and Notification Reports or only Notification Reports when the sensor is faulted and restored.  
      </Help>
      <Item label="Enable Binary Reports" value="0"/>
      <Item label="Disable Binary Reports" value="255"/>
    </Value>
  </CommandClass>
  <!-- Refresh Battery Level on wakeup-->
  <CommandClass id="128">
    <Compatibility>
      <RefreshOnWakeup>true</RefreshOnWakeup>
    </Compatibility>
  </CommandClass>
  <!-- Association Groups -->
  <CommandClass id="133">
    <Associations num_groups="2">
      <Group index="1" label="Lifeline" max_associations="5"/>
      <Group index="2" label="Basic Report" max_associations="5"/>
    </Associations>
  </CommandClass>
</Product>

OpenZWave / open-zwave

Ecolink Door / Window Sensor Missing Config Parameters - Unable to reset case open tamper #2355

Issue Guidelines