Thousands of Happy Smart Home Customers

But don’t just take our word for it...

We offer great products & great knowledge all backed up with great service - and our customers agree!

We’re very proud of our independent Excellent Trustpilot rating, backed up by the many repeat customers we’ve been supporting for years.

 

Read More

 
 

World-Class, Industry-Leading Technical Support - Forever Free

You’ll always have FREE access to our technical knowledgebase, application guides, YouTube tutorials & Customer Services, as well as all other online resources, help, white papers and articles.

If none of these answer your query you can also raise a ticket and get direct access to our team of smart home specialists for for assistance.

 
 

Access to technical specialists
100’s of in-depth help resources
Video guides via YouTube channel
Blog articles with product reviews & test results

 
 

The Vesternet Promise

As Founder & CEO of Vesternet, I personally guarantee your 100% satisfaction on any purchase.

I’d never want you to be unhappy with something you buy from us, so here’s my promise - you can return any unused products within 365 days. If you have problems with a new purchase, our support team will work with you to resolve. And if you still can’t get it working then you can return it within 14 days for replacement or refund. For full information take a look at our full returns policy.

In addition, here’s my personal email should you ever have any problems or feedback: dave.bell@vesternet.com

We’re not just a shop, we’re with you all the way on building your smart home.

 
 

Using the Aeon Labs Siren in VERA UI5

This guide shows how to use the recently released Aeon Labs Siren in the VERA Z-Wave Controller using UI5 firmware.

The Aeon Labs Siren is one of the new "Generation 5" / "Gen5" / "Z-Wave+" / "Z-Wave Plus" devices.

These devices are unfortunately presenting some issues when used with current Z-Wave Controllers and it will likely be some time before the Z-Wave Controller manufacturers issue updated firmware that includes support for the new devices out-of-the-box.

In the meantime, this application note will detail some workarounds to allow you to use the Aeon Labs Siren in VERA using UI5 firmware.

NOTE: These steps may not work in other versions of VERA firmware! We recommend using UI5 series firmware on VERA where possible!

Prerequisites


Your VERA will need to be running the latest BETA UI5 firmware release (1.5.672) to allow the Aeon Labs Siren to be Included correctly.

This is due to the fact that the device uses "V2" of the "Version" Z-Wave Command Class:

Aeon Labs Siren In VERA UI5Aeon Labs Siren fails to install correctly in VERA UI5

Aeon Labs Siren In VERA UI5Aeon Labs Siren fails to install correctly in VERA UI5


Fortunately, MiCasaVerde released version 1.5.672 firmware for VERA at the end of 2013 to allow support for the Fibaro Smoke Sensor and Fibaro Motion Sensor devices.

Follow our related KB article for either the Motion Sensor or Smoke Sensor in order to update your VERA firmware to the required version!

Including the Aeon Labs Siren


With the 1.5.672 version firmware loaded, when you Include the Aeon Labs Siren it will install as an "_Appliance Module".

Aeon Labs Siren In VERA UI5Aeon Labs Siren in VERA UI5


Looks good, but I can't control it from VERA!


Indeed, unfortunately out-of-the-box VERA can't control the device - not very useful!

By reverse-engineering the Z-Wave protocol used to communicate with the device, we have discovered that the device supports "Security Encapsulation" Z-Wave Command Classes and VERA configures itself to talk to the device using encryption.


Aeon Labs Siren Security EncapsulationAeon Labs Siren Security Encapsulation


This is fine, but VERA attempts to control the device using the "Basic" Z-Wave Command Class and does not appear to encapsulate these Z-Wave Commands in the Security Encapsulation Z-Wave Command Classes first, whereas all other communication IS encapsulated.

This appears to cause the device to ignore the Basic Z-Wave Commands being sent to it that would usually tell it to turn on or off!

It's not clear who is at fault for this problem, whether VERA should encapsulate ALL Z-Wave Command Classes if it's configured itself to talk to the device using encryption, or whether the device should still accept an un-encrypted command using the Basic Z-Wave Command Class even if it's been configured to use encryption.

It's also possible that the device doesn't support the Basic Z-Wave Command Class, but that would be very strange and it does seem that the device responds to the command as VERA updates the UI thinking that the device state has changed successfully. The device just doesn't act on the command!

Whoever is at fault, fortunately this problem can be resolved and the device can be used successfully - there's an EASY way and a HARD way.

The EASY Way


The easy way simply involves using LUA to control the device - the LUA would tell VERA to send an on or off command to the device using a different Z-Wave Command Class - the "Binary Switch" Z-Wave Command Class.

This Z-Wave Command Class is correctly encapsulated in the Security Encapsulation Z-Wave Command Classes by VERA prior to sending and controls the device properly.

Make a note of the "ID" that VERA has given to the device - this is the Z-Wave ID, shown on the "Settings" tab of the device in the VERA UI.

ON Command

The LUA required to turn the device on is as follows:

luup.call_action('urn:micasaverde-com:serviceId:ZWaveNetwork1','SendData',{Node='47',Data='37 1 255'},1)

  • 47 = Z-Wave Device ID
  • 37 = Binary Switch Command Class
  • 1 = SET
  • 255 = ON

This would be entered on the LUUP tab of either a Trigger or a Scene:


Aeon Labs Siren Binary Switch Z-Wave Command ClassAeon Labs Siren Binary Switch Z-Wave Command Class


OFF Command

The LUA required to turn the device off is as follows:

luup.call_action('urn:micasaverde-com:serviceId:ZWaveNetwork1','SendData',{Node='47',Data='37 1 0'},1)

  • 47 = Z-Wave Device ID
  • 37 = Binary Switch Command Class
  • 1 = SET
  • 0 = OFF

This would be entered on the LUUP tab of either a Trigger or a Scene:


Aeon Labs Siren Binary Switch Z-Wave Command ClassAeon Labs Siren Binary Switch Z-Wave Command Class


The above LUA commands should now control the Aeon Labs Siren correctly!

This won't correct the problem of the device being uncontrollable from the UI directly, but you could create a Scene that is Triggered from the device turning on or off - remember that the device does respond to the Basic Z-Wave Command sent to it and therefore VERA updates the UI thinking that the device state has changed.

This fact can be used to Trigger a Scene that would use the LUA above to control the device - you would need to be very careful however not to create a loop where the Scene is Triggered by the device state changing, which sends the LUA, which Triggers the Scene again, which sends the LUA, etc, etc

It might therefore be more prudent to use a Virtual Device to Trigger the Scene and not use the real device icon at all.

The HARD Way


The hard way involves modifying a file on your VERA that will tell VERA to use a different Z-Wave Command Class to communicate with the device - the "Binary Switch" Z-Wave Command Class.

This Z-Wave Command Class is correctly encapsulated in the Security Encapsulation Z-Wave Command Classes by VERA prior to sending and controls the device properly.

NOTE: If you aren't comfortable doing this, we would recommend that you use the easy way above!

Accessing VERA in this way and making changes to core files can have adverse effects on your VERA!

We are purposefully only giving brief details here - do not ask us for detailed instructions on how to carry out this task.

If you do not understand what the below instructions mean, we would suggest that you should not attempt them!

You have been warned!


  • Access VERA using an SCP Client.
  • Download the file "zwave_products_user.xml" from "/etc/cmh".
  • Using an appropriate text editor that preserves the correct line endings, BOM and XML formatting, merge the below data.
  • NOTE: Choose a value for the "id" that fits with any existing entries (you should also check "/etc/cmh/zwave_products_sys.xml" to ensure there aren't any clashes).

<root>
	<deviceList>
		<device id="4002" manufacturer_id="86" basic="" generic="" specific="" child="" prodid="50" 
		prodtype="4" device_file="D_Siren1.xml" zwave_class="" default_name="_Aeon Siren" 
		manufacturer_name="Aeon Labs" model="ZW080" basic_class="0x25">		
		</device>
	</deviceList>
</root>

  • Upload and overwrite the original file on VERA.
  • Click "RELOAD" in the VERA UI.
  • Examine the "LuaUPnP.log" log file in "/var/log/cmh" to ensure that the customisation is correctly loaded for the device.

The Aeon Labs Siren should now be fully functional and with the added bonus that it should now be using a more appropriate device Icon in the VERA UI too!


Aeon Labs Siren in VERA UI5Aeon Labs Siren in VERA UI5

Great, It Works, but the device is supposed to support different sounds!


Indeed it does - these are configured by setting Parameter 37 appropriately.

Parameter 37 is a "2-byte" value and needs to be set as decimal in VERA.

The value is comprised of the "bits" in each "byte" that are set as "on" or "off".

Bit math is then used to determine the total decimal value (since it needs to be applied as a 2-byte value).

If the above sounds complicated, it can be :-)

Fortunately we can take some short-cuts and just highlight the decimal values to be used:

Siren Volume

  • Value 1 = Volume 1 - 1
  • Value 2 = Volume 2 - 2
  • Value 3 = Volume 3 - 3

Siren Sound

  • Value 1 = Sound 1 - 256
  • Value 2 = Sound 2 - 512
  • Value 3 = Sound 3 - 768
  • Value 4 = Sound 4 - 1024
  • Value 5 = Sound 5 - 1280

To set a particular combination, simply add the decimal values at the right hand side together!

So, for "Volume 1" and "Sound 4" as an example, you add 1 and 1024 to give 1025 and configure Parameter 37:


Aeon Labs SirenAeon Labs Siren

Once you've saved the changes in VERA, the Aeon Labs Siren will be configured to use the new sound immediately.

NOTE: Configuring the Aeon Labs Siren to change sound or volume will also immediately cause it to activate!

Fantastic, but I want to use the different sounds in Scenes!


Absolutely, in fact this is supposed to be one of the main appeals of the device!

We're not sure why Aeon Labs chose to implement this functionality using the "Configuration" Z-Wave Command Class as it means that most Z-Wave Controllers won't be able to use the functionality of triggering different sounds for different events.

In VERA, we can exploit the fact that configuring the Aeon Labs Siren to change sound or volume will also immediately cause it to activate it by using some simple LUA scripting.

Make a note of the "ID" that VERA has given to the device - this is the Z-Wave ID, shown on the "Settings" tab of the device in the VERA UI.

The LUA required to send the configuration data to the device on is as follows:

luup.call_action('urn:micasaverde-com:serviceId:ZWaveNetwork1','SendData',{Node='47',Data='112 4 37 2 3 1'},1)

  • 47 = Z-Wave Device ID
  • 112 = Configuration Command Class
  • 4 = SET
  • 37 = Parameter
  • 2 = Size
  • 3 = "Value" from the short-cuts detailed above for the "Sound" required
  • 1 = "Value" from the short-cuts detailed above for the "Volume" required

  • This would be entered on the LUUP tab of either a Trigger or a Scene:


    Aeon Labs Siren Configuration Z-Wave Command ClassAeon Labs Siren Configuration Z-Wave Command Class


    As mentioned above, sending the configuration in this manner will immediately cause the Aeon Labs Siren to activate - you will then need to turn it off as appropriate - either using the LUA commands described in the "EASY Way" section of this guide or by activating the "Off" button on the device if you've gone the "HARD Way" route.

    NOTE:

    If you have configured Parameter 37 in the device settings as well and you use the LUA above to trigger the siren, you are effectively changing the configuration stored in the device, meaning it may no longer match what is stored in VERA.

    This could mean that the next time VERA re-configures the device (for example during a nightly heal), the configuration will be updated in the device to match what is in VERA.

    This will immediately cause the siren to activate!

    Conclusion


    Using either of the above methods should allow you to use the Aeon Labs Siren in VERA UI5.


    We hope that you've found this application note useful!

    Related Information



     

    Copyright Vesternet 2014

    Updated: 19/12/14

    You viewed

    Please wait...

    Item(s) Added Continue shopping or View cart & checkout
    Continue shopping or View cart & checkout