QMotion QzHub 3 (Cloud) Driver

Overview

This driver offers two-way control of QMotion shades through the QzHub3 interface and its associated cloud service. Up to 50 shades and 50 groups are supported.

Supported features

Raise, Lower, Stop, Go to Level

PLEASE NOTE:

Communication with the device is via a cloud service. There will be a delay between commands being issued from RTI and action being taken. In most causes this will be less than 1 second. This is caused by the time taken for the command to go from the controller via the internet to QMotion’s cloud server and then back to the QzHub and on to the device motors.

This also means that the driver can be used to control any QzHub located anywhere in the world. The QzHub3 does not need to be on the same network as the RTI Processor. This may be useful for commercial environments where the QzHub is not on the same subnet as the RTI Processor.

Any feature not specifically noted as supported should be assumed to be unsupported.

Change Log

v2.03 Minor changes to improve connection stability, more detailed logging

v2.02 No functional changes, minor bug fix to error parsing large responses, more detailed logging

v2.01 No change, version number bump

v2.00 Initial release

Continued dealer support

Intrinsic Dev offer free license keys for showrooms and dealer’s own homes. To obtain your free license keys simply drop us a support ticket. All of our drivers/modules are fully supported by our online ticketing system.

Disclaimer

Intrinsic Dev’s drivers are created to the highest standard, developed with industry leading practices.

By installing this driver, you agree to our full Terms and Conditions, a copy of which can be found at the end of this document.

Driver license

This driver requires a license to function. Pricing and license keys can be obtained by visiting www.intrinsicdev.co.uk . License keys are issued on a per controller basis and are tied to the MAC address of that controller, you will need quote that MAC address when placing your order. Only a single license key is required for multiple instances of the driver on the same controller.

Device setup

Add and setup devices as described in QzHub app.

The system should be fully functional and tested before pairing to RTI.

Apex Configuration process

1. Download the latest version of the driver from www.intrinsicdev.co.uk

2. Place the .rtidriver file in your designated custom driver directory. This can be identified in Apex by clicking Options > Set Directories.

3. Import instances of the driver into your project as required.

4. In the QzHub app go to Settings > Select your hub > Integrate

5. Click Generate New Code

6. Open the Intrinsic(DEV) – QzHub3 Driver Support App and enter the integration code in the top field then click “Pair”

7. An authentication code will be generated. Copy this code and paste it in the Auth Token parameter field in the Driver Properties view

8. In the helper app click “Query”. This will then generate a list of device IDs for individual shades and groups.

9. In the Apex driver config pane. Copy the Device IDs and Group ID’s to the required ID fields.

Additional Notes

1. Only compatible with QzHub3.

2. Note that integration codes expire every 15 minutes, be sure to obtain the auth token promptly.

3. Auth Code not entered in or Device/Group not selected in parameter fields.

4. This is a cloud driver. There will be a small delay between commands being issued from RTI and then actually happening. In most causes this will be less than 1 second. This is caused by the time taken for the command to go from the controller via the internet to QMotion’s cloud server and then back to the QzHub.

5. During testing it was found that position updates can be slow, intermittent and/or inaccurate. In this case, attach a macro to the corresponding “Change Event” – this will fire every time the value changes and can help identify if an updated value is being received. When position is being updated but it’s value is incorrect, this is due to the cloud server sending the driver incorrect information and support should be sought from QMotion.

Supported Functions

Individual Shade Control \
Set PositionSet a shade to a specified position, percent open
OpenSet the shade fully open
CloseSet the shade fully closed
StopStop the shade whilst moving
Set TiltSet the tilt percent

Group Control \
Set PositionSet all shades in a group to a specified position, percent open
OpenSet the group fully open
CloseSet the group fully closed
StopStop the shades whilst moving
Set TiltSet the tilt percent

Query \
GetStatusRequest the status of all outlets and the PDU global info.

Note that by default the GetStatus command is periodically sent according to the Status Query Interval (ms) property. Each time the command is sent the poll timer is reset meaning the polling interval is maintained

Supported Variables

Querying the status will update properties of all shades.

Shade 1-50 \
Variable NameTypeDescription
IDStringMotor ID
NameStringName assigned in the QzHub App
PositionIntegerPercentage of open
StatusStringIdentifies if a motor is online communicating to the hub
Serial NumberStringSerial number of the motor
ManufacturerStringManufacturer of the motor
ModelStringModel of the motor
Battery LevelIntegerPercentage battery level

Supported Events

Since every variable is updated at the same time there’s no need to schedule queries from events and a change event for one variable can be considered to indicate an update to all variables.

Given that all states must be queried events can therefore happen no more frequently than the polling interval. For example, should a user adjust a shade using QMotion’s own app, the change won’t be detected by the RTI system until it next queries the status which (by default) could be up to 10 seconds later.

Shade[1-50] Events \
Status ChangedFired when status (on/off line) of a motor is updated and has changed
Position ChangedFired when the position of a motor is updated
Battery Level ChangedFired when the battery level is updated and has changed
Name ChangedFired when a motor’s name has been updated and has changed