Adding Wave device to Home Assistant - Z-Wave JS UI

Modified on Fri, 08 Sep 2023 at 10:41 AM

Below you may find the guide-s on how to add (include) the Shelly Wave devices in the Home Assistant with Z-Wave JS UI in carious modes.


TABLE OF CONTENTS


Prior to proceeding, it is essential to verify the status of the following keys within the Z-WaveJS application:
  • S2 Unauthenticated
  • S2 Authenticated
  • S2 Access Control
  • S0 Legacy
These key settings can be located within the Z-WaveJS application under the Settings / Z-Wave. Ensure that these settings are filled, if not simply utilise the "Refresh" button to have them filled.



SmartStart from UI


  • If you choose the SmartStart option in the Control Panel of the Z-Wave JS UI.


  • A new window will open with a list of SmartStart devices. Click the Menu icon at the bottom right to select your preferred device addition method.


  • In the menu you will have multiple options, you can manually add the device details by selecting the "Add" option. Alternatively, you can choose to scan the QR code, import or export a JSON file, or reload the list of devices.


  • If you choose the "Scan" option, you can either scan the QR code or input the code from another QR scanner if a camera is not assigned in HA. Alternatively, you can import a picture of the QR code if you have one.


  • After you scan or input the code, a new entry will be added to the Provisioning Entries list.


  • After successfully adding a device, you can repeat the process to add more devices or return to the previous menu. For automatic inclusion upon connection to power, you must use Z-Wave USB or Shield from the series 700 or higher.


Once the device is added to the Gateway, it will switch on and off 2 times the output-s (if it have any) to notify you that was successfully added to the gateway.

Adding - Inclusion


  • Open the HA Menu by selecting the Menu icon located in the top left corner.


  • Within the HA Menu, choose the option "Open Z-Wave JS".


  • Once the user interface (UI) loads, select the Menu icon located in the bottom right corner.


  • Choose "Manage Nodes" represented by a green infinite symbol icon.


  • Next, click on "Inclusion". (HA step 1)


  • In this step, you will be prompted to input the name and location of the device you wish to add. (HA step 2) 


  • By default, the Secure S2 inclusion is selected. If you want to proceed with this option, simply click "Next", and the device will be included under Secure S2 mode. (HA step 3)
    If you prefer alternative inclusion methods, you can choose from the following options:


  • The inclusion process will begin automatically after you start adding the device, if you select the Default (S2), S0 encryption, or No encryption inclusion. (HA step 3) 
    • For SmartStart inclusion, choose the "Scan QR code" option, and a new window will pop up.

Secure S2

  • If you selected Secure S2 inclusion, confirm your choice to proceed to the next step. (HA step 4) 

 

  • Enter the PIN number found on the device's label or as an extra label in the device's box. (HA step 5) 
    • Click "Next" to start the inclusion process.


  • After a few moments, the device will be successfully added to the gateway. (HA step 6) 


  • Once the device is added, you can begin adding another device. Please note that some settings are still transmitted between the device and the gateway, which can be observed in the newly created widget. The spinning circle and the red alert mark on the top right of the widget indicate the ongoing transmission.


  • After successful inclusion with S2 secure encryption, the widget will display a green check-mark in the middle and the top right corner. Additionally, a green lock icon will appear, confirming the device's inclusion with S2 secure encryption. 


The device will switch on and off 2 times the output-s (if it have any) to notify you that was successfully added to the gateway.

SmartStart


  • Choosing SmartStart inclusion in the 3rd step, it will give you few options:


  • A new window will appear, giving you the option to either scan the QR code


  • Or input the code from another QR scanner, in case you haven't assigned the camera in HA. Alternatively, you can import a picture of the QR code if you have one.


  • Once you hit the "Confirm" button, HA will begin integrating the device.


  • After successful inclusion with S2 secure encryption, the widget will display a green check-mark in the middle and the top right corner. Additionally, a green lock icon will appear, confirming the device's inclusion with S2 secure encryption. 


The device will switch on and off 2 times the output-s (if it have any) to notify you that was successfully added to the gateway.

No encryption


  • If you choose the "No encryption" option in the 3rd step, click "Next" to initiate the inclusion process.



  • Once the device is added, you can begin adding another device. Please note that some settings are still transmitted between the device and the gateway, which can be observed in the newly created widget. The spinning circle and the red alert mark on the top right of the widget indicate the ongoing transmission. (HA step 4) 


  • The device is fully added to the gateway, which is indicated with the green check-mark in the middle and the upper-right position of the widget a red crossed lock icon let you know that is added without encryption.


The device will switch on and off 2 times the output-s (if it have any) to notify you that was successfully added to the gateway.

S0 encryption


  • If you select the "S0 encryption" option in the 3rd step, click "Next" to initiate the inclusion process.  



  • Once the device is added, you can begin adding another device. Please note that some settings are still transmitted between the device and the gateway, which can be observed in the newly created widget. The spinning circle and the red alert mark on the top right of the widget indicate the ongoing transmission. (HA step 4) 


  • Once the device is fully added to the gateway, will be indicated with the green check-mark in the middle and the upper-right position of the widget. A yellow lock icon let you know that is added with S0 encryption


The device will switch on and off 2 times the output-s (if it have any) to notify you that was successfully added to the gateway.