Somfy Tahoma North America Gateway Driver

Description

This driver is for control of Somfy Tahoma compatible devices via the Tahoma North America Gateway. This driver communicates exclusively with the gateway device to signal actions on the endpoint smart devices.

The Somfy Tahoma North America application can be downloaded from the Apple App Store and Google Play. This app will be required for setup and configuration of the Gateway and endpoint devices. The app will also be needed to synchronize this driver and the Tahoma Gateway. This process will be described later in the document.

https://apps.apple.com/us/app/tahoma-north-america/id1437975616

https://play.google.com/store/apps/details?id=com.somfy.beecon

This module was developed against a Tahoma Gateway running firmware version 1.3.0 (312) with a small set of zigbee smart devices.

A demo Integration Designer project has been created to demonstrate general usage of this driver.

Note: This document is not a replacement for understanding the equipment your controlling and the documentation that is distributed with the equipment. Please read and understand all documentation before attempting to use this driver.

Revision History

v1.0.0 : Initial Release

v1.2.0 : APEX Compatibility Improvements

Connection Settings

All communication between the Gateway and the driver will occur over a secure TCP connection via port 44100. The IP address of the Gateway can be entered in the driver settings and the port number can be changed if needed, however as of the time of this writing port 44100 is the standard port and should not need to be changed.

Authorization Sequence

In order for the driver to communicate properly with the Gateway, the driver must complete an authorization handshake with the gateway. In order for this to happen, the Gateway must be put into "Pairing Mode" via the "Third Party Integration" section of the app or via the hard button on the gateway. The app should provide a button labeled "Enable / Refresh Integrations" or something similar to put the Gateway into pairing mode. Pairing mode will last for 10 minutes.

During startup or when the "Refresh Token" function is triggered, the driver will attempt to pair with the Gateway. This should be done within the 10 minute window. Once the handshake is successful, the driver will maintain the acquired token so subsequent code loads and reboots will not require this handshake to take place. Therefore, it is recommended to put the Gateway into pairing mode right before the first load of the system/driver.

Initialization Sequence

Once driver communications have been started and a successful handshake has been completed, the driver will automatically start polling the Gateway for the current state of all registered endpoints. Once the driver has successfully acquired the state of all endpoints, it will be considered initialized. No commands should be sent for endpoint control until this process is complete.

Driver Configuration

Debug Settings

Only visible if "Show Driver Debug Options" has been set in TraceViewer.

Enable Debug Messages

Enables the driver debugging messages.

Debug Level

Determines which debug messages to show.

Identifier

Prefix for debug messages to distinguish debug messages from this driver.

Network Settings

IP Address

IP Address of the Tahoma Gateway. Can be found in the TaHoma North America app via the "Third Party Integration" section.

IP Port

The IP Port for Tahoma Gateway communications. Standard is 44100.

Configuration

Poll Rate

The number of seconds between polling events. Polling only happens for feedback from devices that don't support push notifications. Note: Changes in feedback from the Gateway can be slow to update regardless of polling. Somfy recommends a polling rate of 30 seconds with a minimum of 10 seconds.

Auto Start Communications

If enabled, the driver will automatically attempt to connect to the gateway and initialize the state of all endpoints as soon as it is ready after processor startup and will maintain this connection. If disabled, the connection process will need to be started manually via driver connection functions.

Device Configuration

Motor Device Count

Determines the number of Motor-type endpoint devices the driver will control. A single instance of the driver supports up to 32 of these devices.

Switch Device Count

Determines the number of Switch-type endpoint devices the driver will control. A single instance of the driver supports up to 32 of these devices.

Lighting Device Count

Determines the number of Lighting-type endpoint devices the driver will control. A single instance of the driver supports up to 32 of these devices.

Motor Device Settings

Motor Name [1-32]

Defines a friendly name for the endpoint device or group. This is only for reference in Integration Designer.

Motor TargetID [1-32]

Defines the TargetID of the endpoint device or group. This ID can be found in the "Third Party Integration" section of the app. Example: zigbee.12026/1

Switch Device Settings

Switch Name [1-32]

Defines a friendly name for the endpoint device or group. This is only for reference in Integration Designer.

Switch TargetID [1-32]

Defines the TargetID of the endpoint device or group. This ID can be found in the "Third Party Integration" section of the app. Example: zigbee.13982/1#1

Lighting Device Settings

Light Name [1-32]

Defines a friendly name for the endpoint device or group. This is only for reference in Integration Designer.

Light TargetID [1-32]

Defines the TargetID of the endpoint device or group. This ID can be found in the "Third Party Integration" section of the app. Example: zigbee.25946/1

Further Assistance

If you need more information or assistance please contact us.

Contact Information

Somfy Systems, Inc.

121 Herrod Boulevard

Dayton

NJ 08810

1-800-64-SOMFY

https://www.somfysystems.com/en-us/discover-somfy/contact-us/service-support