HomeIQ H4P-WC Search For Hub Instructions

: May 15, 2024
: HomeIQ

HomeIQ H4P-WC Search For Hub

Specifications:

Product Name: Yardi HomeIQ Hub
Connectivity: Ethernet, Wi-Fi
Z-Wave Compatibility: Yes
Web GUI: Optional, accessible at https://:4443

Product Usage Instructions

Logging In:

Connecting through Ethernet: Connect the hub to the network to receive an IP address for login.

Connecting through Wi-Fi AP: Connect to the Wi-Fi AP with provided credentials and access the hub through SSH at IP address 192.168.200.1.

Logging in with SSH: Use a terminal client like PuTTY or Terminal with the assigned IP address and login credentials.

Using Console Application:

After logging in, execute the `zwave-console’ command to launch the console application and connect to the Z/IP Gateway.
Use the `help’ command to list available commands and follow the format provided.
Numeric input can be in decimal or hexadecimal by prefixing with 0x.
Abort network functions using CTRL-C and exit the console with quit’,exit’, or keyboard shortcuts.

Z-WaveTM Network Management:

b. Failed Nodes: Use the Network-RemoveFailedNode command to remove unreachable nodes by entering the node ID.
c. Copy Network Information: Use the Network-Inclusion command to add another controller into the network.
d. Capability Rediscovery: Update network status and device information with the Node-Update command.

Node Suggestions:

Enter suggested nodes or any node on the network when executing commands for individual nodes.

Multi-Channel Commands:

Format for Node ID is nodeId:endpointId. Default endpoint is used if :X suffix is not provided.

Device Control Commands:

Control devices using specified commands.

Notification Reports:

View recent notifications using Notification-ViewRecent command and choose to see all or from a single device.

Optional Web GUI:

The Z-Wave Engineering UI provides a web page to manage the network and devices. Enable with UI-Start command and disable with UI-Stop command.

Frequently Asked Questions

Q: How do I enable the optional Web GUI?

A: To enable the Web GUI, use the UI-Start command within the console application. Access the page at https://:4443 with provided credentials.

Logging in

Connecting through Ethernet: The hub will receive an IP address through DHCP that you can use to connect to the hub.
Connecting through Wi-Fi AP: You can connect to the Wi-Fi AP of the hub using the credentials provided. Once connected you can access the hub through SSH at the IP address 192.168.200.1
Logging in with SSH: Using a terminal client (e.g., PuTTY on Windows, Terminal on Mac) you can connect to the hub using the assigned IP address (from above) and the provided login user and password.

Using console application

Once logged in, execute the ‘zwave-console’ command on the terminal. This will launch the console application and automatically connect to the local Z/IP Gateway.
Once connected you can use the ‘help’ command to list available commands. The format is generally - (e.g., UserCode-Get, Battery-Get, DoorLock-ConfigurationGet).
All commands will prompt for their required input parameters. Some commands will provide default values for parameters and they will be shown in braces (e.g. [10]). Pressing enter at the prompt will accept the default value.
Numeric input is in decimal by default but can be specified as hexadecimal by prefixing with 0x (e.g., 0x16, 0x0023).
Network functions (add, remove, node/network updates) can be aborted/interrupted using the CTRL-C keyboard shortcut.
Exiting the console can be done via the ‘quit’, or ‘exit’ commands, as well as CTRL-C, or CTRL-D keyboard shortcuts.

Z-Wave™ Network Management

All commands stated below are assumed to be executed in the console application.

a. Add/Remove
- i. Adding Non-S2 devices
- Execute the “Network-Inclusion” command
- Enter “N” on the “Pre-enter DSK?” prompt
- Start add node procedure for the device to be added
- Upon successful completion a message indicating which node ID was allocated to the included node is printed
- ii. Adding S2 devices
- Execute the “Network-Inclusion” command
- Enter “N” on the “Pre-enter DSK?” prompt
- Start add node procedure for the device to be added
- If prompted, enter PIN (5 digits) to be included
  5. Upon successful completion a message indicating which node ID was allocated to the included node is printed
- Removing/Excluding devices
  1. Execute the “Network-Exclusion” command
  2. Start exclusion mode procedure for the device to be removed
  3. Upon successful completion a message indicating which node ID was removed is printed
b. Failed nodes
i. Failed nodes allows you to remove nodes from the network that are now unreachable. E.g.) previously added nodes that have been factory reset, or nodes with dead batteries, etc. The “Network-RemoveFailedNode” command can be used and requires entering the node ID of the failed node.
c. Copy network information to another controller
i. Use “Network-Inclusion” command to add another controller into the network. Follow steps 3.(a) above.
d. Performing capability rediscovery of a node
i. The “Node-Update” command will update the network status and device information of the provided node ID. If the node update does not fully rediscover the node’s capabilities it will have to be excluded and reincluded into the network.

Node suggestions

When executing a command for an individual node there will often be a “suggested nodes” prompt that is suggesting nodes that are compatible with that command. You can enter one of the suggested nodes but can also enter any node that is on the network.

Multi-Channel commands

When prompted for a Node ID you can enter in the format “nodeId:endpointId”. E.g.) “8:1” which will be node ID 8 and endpoint 1. Not providing the “:X” suffix will use the default endpoint of 0.

Device control commands

Devices can be controlled with the following commands:

Anti-Theft Unlock
o AntiTheftUnlock-Set can be used to unlock a node
Basic
Basic-Set can be used to set the node state
Binary Switches
SwitchBinary-Get retrieves the current switch state
SwitchBinary-Set will set the switches state
Configuration
- Configuration-Set will set a configuration parameter
- Configuration-Reset will reset all configuration parameters to defaults
Door Locks
- DoorLock-OperationGet retrieves the current operating state
- DoorLock-OperationSet will set the lock’s operation state
- DoorLock-ConfigurationGet retrieves the current lock configurations
- DoorLock-ConfigurationSet will set the lock’s configurations
- In “Timed” operation the “Lock operation timeout” prompt for minutes and seconds are added together for the total timeout value.
Meters
- Meter-Get retrieves the current meter value with a chosen type and unit
- Meter-Reset resets the accumulated value for the meter
Multilevel Switches
- MultilevelSwitch-Get retrieves the current switch state
- MultilevelSwitch-Set sets the switch state
- Multilevel-StartChange will start a dimming change
- Dimming direction, step size, and starting level will be prompted for
- Prompts for the dimming of the secondary switch will appear if supported
- Multilevel-StopChange stops any in progress dimming changes
Thermostats
- ThermostatFanMode-Get retrieves the current fan mode
- ThermostatFanMode-Set sets the thermostat fan mode
- ThermostatFanState-Get retrieves the current state of the fan
- ThermostatMode-Get retrieves the current thermostat mode
- ThermostatMode-Set sets the thermostat operating mode
- ThermostatOperatingState-Get retrieves the current thermostat operating state
- ThermostatSetpoint-Get retrieves the current setpoint
- ThermostatSetpoint-Set sets the setpoint given the type and units
User Code
- o UserCode-Set can be used to set or erase a user code
- o UserCode-SetKeypadMode sets the keypad mode
- o UserCode-SetMasterCode sets the master code

Notification reports

The “Notification-ViewRecent” command can be used to view the last received notifications. You can choose whether to see all notifications or ones from a single device.

Optional Web GUI

The hub also contains the Z-Wave Engineering UI that provides a local web page to manage the network and devices. It is off by default but can be enabled within the console using the “UI-Start” command and disabled again with the “UI-Stop” command. The page can be reached at https://:4443 and using the credentials provided. A manual for the web UI is provided in the “Z-Ware Web User Guide” file.

Devices from multiple manufacturers

This product can be operated in any Z-Wave network with other Z-Wave certified devices from other manufacturers. All mains operated nodes within the network will act as repeaters regardless of vendor to increase reliability of the network.

Factory Default Reset

Using the console application, you can execute the “Network-Reset” command to factory reset the Z-Wave controller. If this controller is the primary controller for your network, resetting it will result in the nodes in your network being orphaned and it will be necessary after the reset to exclude and re-include all of the nodes in the network. If this controller is being used as a secondary controller in the network, use this procedure to reset this controller only in the event that the network primary controller is missing or otherwise inoperable.

Identify

The “Indicator-Identify” command can be used to identify the controller or any node that supports the Identify command. The controller does the following to identify itself:

Blinks internal green LED (an LED on the internal board, not the green power LED on the top of the case)
Blinks green LED on the ethernet jack if an ethernet cable is connected

The “Indicator-Set” command can be used to send specific indicating parameters to a node.

Association

The “Lifeline Group” association is supported. The Device Reset Locally Report will be sent to nodes in the group. The maximum number of nodes in this group is one.

Security 2 Command Classes.

Command Class	Version	Required Security Level
Association	3	Either S2 Access Control or S0
Association Group Info	3	Either S2 Access Control or S0
Device Reset Locally	1	Either S2 Access Control or S0
Firmware Update MD	5	Either S2 Access Control or S0
Indicator	3	Either S2 Access Control or S0
Manufacturer Specific	2	Either S2 Access Control or S0
Multi-Channel Association	4	Either S2 Access Control or S0
Network Management Basic	2	Either S2 Access Control or S0
Network Management Inclusion	4	Either S2 Access Control or S0
Network Management Installation Maintenance	4	Either S2 Access Control or S0
Network Management Proxy	4	Either S2 Access Control or S0
Node Provisioning	1	Either S2 Access Control or S0
Powerlevel	1	Either S2 Access Control or S0
Version	3	Either S2 Access Control or S0

ZIP Gateway

|

1

| Either S2 Access Control or S0 (Supported on

LAN-side only)

ZIP Naming

|

1

| Either S2 Access Control or S0 (Supported on

LAN-side only)

ZIP Portal

|

1

| Either S2 Access Control or S0 (Supported on

LAN-side only)

Application Status| 1| none
CRC16 Encapsulation| 1| none
Inclusion Controller| 1| none
Multi-Cmd| 1| none
Security| 1| none
Security 2| 1| none
Supervision| 1| none
Time| 1| none
Transport Service| 2| none
ZIP| 4| none (Supported on LAN-side only)
ZIP ND| 1| none (Supported on LAN-side only)
Z-Wave Plus™ Info| 2| none

Update Device Firmware

A device’s firmware can be update using the “Firmware-Update” command. This requires that the firmware update file has already been transferred onto the hub. It will then prompt for its location and begin the update. If the option to not activate the firmware immediately has been chosen the
“Firmware-Activate” command can be used when ready.

SmartStart

SmartStart enabled products can be added into a Z-Wave network by scanning the Z-Wave QR Code present on the product with a controller providing SmartStart inclusion. No further action is required and the SmartStart product will be added automatically within 10 minutes of being switched on in the network vicinity.

Print Provisioning List SmartStart-Get can be used to see an individual entry SmartStart-GetAll can be used to see all SmartStart entries
Add to Provisioning List
The SmartStart-Add command will prompt for the DSK of the device to be added
Remove from Provisioning List
SmartStart-Delete can be used to remove an entry

Z-Wave Device Specific Key

The Device Specific Key (DSK) for the controller is available through the console application using the “DSK-Get” command. The full DSK (ex: 26812-06634-16142-05208-24315-35221-63933-59053) will be printed.