Somfy Connect UAI+
Use this plugin to connect to a Somfy Connect Universal Automation Interface Plus (UAI+) for controlling shades.
Note: See the Connect Universal Automation Interface Plus product page on the Somfy website for product information and documentation.
Known Issues
During telnet login negotiation, the Connect UAI+ software accepts the correct password plus any succeeding characters. For example, if the correct password is 'test', then 'test123' is also accepted.
Prerequisites
Telnet Configuration
Before connecting to the UAI+, configure the Telnet settings.
-
Navigate to the UAI+'s IP address in a web browser to open its web interface.
-
From the top-right, select Settings in the drop-down menu.
-
Navigate to the Telnet section and set the username and password for the UAI+.
Group Assignment
Before you can control a shade motor via Groups, you need to assign it to the desired Groups.
-
Navigate to the UAI+'s IP address in a web browser to open its web interface.
-
From the top-right, select Settings in the drop-down menu.
-
Navigate to the SDN tab and click on the Groups tab.
-
Add Groups and assign your shade motors to them.
Tip: See the Programming Guide for the Somfy Connect UAI Plus for more information on system setup.
Configuration Overview
To begin using the plugin, drag it into the schematic. Then, press F5 to save your design to the Core and run it.
Connecting to the Device
In the Connection Setup tab:
- Type the IP Address of the UAI+ to control.
- Specify the Control System Username and Password of the UAI+ (see Prerequisites), and then press Enter.
The plugin will automatically attempt a connection. If you see "OK" status, you are successfully connected to the device. If you see a "Fault" error, check that you have entered the correct Username and Password.
Controlling the Device with Groups
Click a Groups tab to adjust the position of the shades assigned to the specified Group:
-
Click Open to raise the shades completely to the open position.
-
Click and hold Up to raise the shades. On release of the button, the shades will stop moving.
-
Click Stop to stop the movement of the shades.
-
Click and hold Down to lower the shades. On release of the button, the shades will stop moving.
-
Click Close to lower the shades completely to the closed position.
-
Click and drag the Set Position fader to set the shades to a specific position.
Note: The plugin cannot poll the position of Groups, so position changes must be observed directly.
Controlling the Device with Motors
Click a Motorss tab to adjust the position of a specific motor:
-
Click Open to raise the shades completely to the open position.
-
Click and hold Up to raise the shades. On release of the button, the shades will stop moving.
-
Click Stop to stop the movement of the shades.
-
Click and hold Down to lower the shades. On release of the button, the shades will stop moving.
-
Click Close to lower the shades completely to the closed position.
-
Click and drag the Set Position fader to set the shades to a specific position.
Properties
Is Managed
Select 'Yes' to add the plugin to your Inventory list, which makes the plugin's Status available for monitoring in Core Manager and Enterprise Manager. When enabled, you can then specify a Name and Location for the plugin, as with any other Inventory item.
For more information, refer to the Plugins topic in the Q-SYS Help.
Show Debug
Select 'Yes' to show the Debug Output window. For details, see the Debug Output topic in the Q-SYS Help.
Groups
Set the number of Groups in your system and the plugin will draw the appropriate pages. The plugin supports up to 40 Groups per instance and Group IDs are automatically populated.
To verify your Group IDs, navigate to the UAI+ web interface, select the SDN tab, and then hover over the SDN tab to download a CSV report. The Group IDs for your system will be under 'Groups' and are in the format of '0101xx', with the final two characters being hexadecimal values of the Group number.
Motors
Set the number of Motors in your system and the plugin will draw the appropriate pages. The plugin supports up to 40 Motors per instance. Motor IDs are automatically populated and the Motor ID control is read-only.
To verify your Motor IDs, navigate to the UAI+ web interface, select the SDN tab, and then hover over the SDN tab to download a CSV report. The Motor IDs for your system will be under 'Motors' and will also display the Groups to which the motor is currently assigned.
Upon initial connection, the plugin will poll the UAI+ unit for the Motor IDs. If there is a mismatch in the number of motors specified and the number received from the UAI+ unit, the plugin status will throw a FAULT and polling will be stopped.
Suppress Motor Fault
When set to 'Yes', this will suppress the FAULT status if there is a motor count mismatch. Additionally, the Motor ID controls will now be editable and you can specify the Motor IDs yourself. This allows for leveraging multiple plugins in a design if the system exceeds the 40 motor count.
Note: If a specified Motor ID returns an error from the UAI+ unit, the plugin will throw a FAULT and specify the index of the malformed Motor ID. If this occurs, the plugin will not stop polling or close the TCP socket.
Controls
Connection Setup
IP Address
Type the IP address of the UAI+ device on your network.
Password
Type in the Telnet Username and Password credentials, as configured in the web interface. See the Programming Guide for the Somfy Connect UIA Plus.
Connection Status
Shows the current connection status of the device. Normally, this shows "Initializing" for a few moments after running your design, followed by "OK". If you see a "Fault" status, check that you have entered the correct Username and Password for the Telnet protocol.
Poll Interval
Sets the polling frequency of the plugin. This gives users flexibility with respect to Motor Position feedback and system configuration.
Note: If you have many motors in your system, the UAI+ unit can be overwhelmed with control data if polling is excessively frequent. If your system has 40 or more motors, we recommend that you set the Poll Interval to 60 seconds to avoid overwhelming the UAI+ unit. If the UAI+ returns a 'false' for any motor position polling, the plugin will throw a FAULT. If this occurs, check your Poll Interval and UAI+ configuration.
Controls
Group ID
Displays the ID associated with each group. These controls are read-only and automatically populate based on the Group's index (see Prerequisites).
Open
Sets the Group or motor to the position specified by the upper limit.
Up
Raises the position of the Group or motor while pressed.
Stop
Stops the movement of the Group or motor.
Down
Lowers the position of the Group or motor while pressed.
Closed
Sets the Group or motor to the position specified by the lower limit.
Set Position
Sets the Group or motor to a specific position.
Note: This control only sets the position. It does not indicate the current position of the Group.
Get Position
Shows current position of the respective Motor.
Note: This control only applies to individual Motors, not to Groups.
Control Pins
| Pin Name | Value | String | Position | Pins Available |
|---|---|---|---|---|
|
Connection |
||||
|
IP Address |
(text) |
Input / Output |
||
|
Username |
(text) |
Input / Output |
||
|
Password |
(text) |
Input / Output |
||
|
Status |
(text) |
Output |
||
|
Details |
||||
|
Group ID |
(text) |
Output |
||
|
Motor ID |
(text) |
Output |
||
|
Controls |
||||
|
Open |
(trigger) |
Input / Output |
||
|
Up |
(momentary) |
Input / Output |
||
|
Stop |
(trigger) |
Input / Output |
||
|
Down |
(momentary) |
Input / Output |
||
|
Closed |
(trigger) |
Input / Output |
||
|
Set Position |
(fader) |
Input / Output |
||
|
Get Position (Motors only) |
(fader) |
Output |
||
|
Disable1 |
0 1 |
disabled enabled |
0 1 |
Input / Output |
