(Optional) Add a Local EnOcean Interface

Owned by Nina Cardillo
Last updated: 12-Jul-2024
6 min read
Local EnOcean interface is supported with SmartServer 4.0 and higher.

For SmartServer 4.1 and prior, see (Optional) Add an EnOcean Interface (Release 4.1 and Prior).

Support for EnOcean devices is available in following interface modes:

  • Remote EnOcean (beta) – EnOcean devices are supported in remote mode with SmartServer 4.3 Update 1 and higher. For remote mode, the EnOcean driver supports EnOcean IoT Connector (IoTC) as an EnOcean network interface. Remote mode uses a remote connection to IoTC, and supports a local EnOcean radio with a web security service (WSS) tunnel to IoTC. Remote mode works with or without a local EnOcean radio. 

    For remote EnOcean interface, see (Optional) Add a Remote EnOcean Interface (Beta) for SmartServer IoT or (Optional) Add a Remote EnOcean Interface (Beta) for SmartServer Pi.

  • Local EnOcean – EnOcean devices are supported in local mode with SmartServer 4.0 and higher. For local mode, the EnOcean driver supports the EnOcean USB 300 (868MHz for Europe), USB 500U (902MHz for North America), and USB 500J (928 MHz for Japan) network interfaces. Local mode uses the local EnOcean radio and does not require any remote interfaces.


This section describes how you can use the SmartServer to integrate and manage EnOcean devices in local mode and consists of the following:

Setting up Local EnOcean Interface

To set up and use local EnOcean interface with the SmartServer, follow these steps:

  1. Add an EnOcean network interface as described on this page.

  2. Enable EnOcean on your SmartServer as described on this page. With SmartServer 4.2 and higher, the EnOcean driver is enabled by default for SmartServer IoT and disabled for SmartServer Pi.
     
  3. Download and modify, or create an EnOcean device interface (XIF) and device type definition as described on this page.

  4. Define datapoint properties for any datapoints to be monitored or logged as described in Setting Datapoint Properties.

  5. Define or discover, and provision devices as described in Site Provisioning.  See the following sections on this page for step-by-step examples:
  6. Optionally, provide a BACnet interface for your EnOcean device; see Setting up the BACnet Server.  This enables you to use a BACnet workstation with your EnOcean device.

Adding an EnOcean Network Interface

To add support for communicating with EnOcean devices, attach an EnOcean USB network interface to your SmartServer. See USB 300, 300U, 400J, and 500U EnOcean Network Interfaces. 

With SmartServer 4.3 and higher, EnOcean IoT Connector (IoTC) is supported as an EnOcean network interface, where EnOcean devices can be accessed through EnOcean Protobuf WSS tunnel via access points, gateways, and SmartServers. See(Optional) Add a Remote EnOcean Interface (Beta) for SmartServer IoT.

Enabling the EnOcean Driver

With SmartServer 4.2 and higher, the EnOcean driver is enabled by default for SmartServer IoT and disabled by default for SmartServer Pi. 

To verify that the EnOcean driver is enabled, or to enable it if it is disabled, follow these steps:

  1. Open the SmartServer Configuration page as described in Accessing the SmartServer IoT Configuration Page. The Network tab appears as the default SmartServer IoT Configuration page. Once the network settings are configured for the SmartServer system, then the System tab will appear as the default.



    SmartServer IoT Network tab


    SmartServer IoT System tab


    For SmartServer Pi, open the SmartServer Configuration page as described in Accessing the SmartServer Pi Configuration Page. The Configuration page view that appears depends on your cache data. As needed, click the SmartServer IoT tab. The System tab (top) will appear as the default as shown below.


    SmartServer Pi System tab

  2. Click the EnOcean tab. The EnOcean driver is enabled by default for SmartServer IoT and disabled by default for SmartServer Pi.


    SmartServer IoT default enabled status


    SmartServer Pi default disabled status

  3. Set the EnOcean driver Enabled option as needed.

  4. Set the Mode to Local. For local mode, the EnOcean driver supports the EnOcean USB 300 (868MHz for Europe), USB 500U (902MHz for North America), and USB 500J (928 MHz for Japan) network interfaces. Local mode uses the local EnOcean radio and does not require any remote interfaces. For remote mode, see (Optional) Add a Remote EnOcean Interface (Beta) for SmartServer IoT.


    SmartServer IoT EnOcean tab – local mode


    SmartServer Pi EnOcean tab – local mode

  5. Click Update to save the configuration.

Downloading and Creating EnOcean Device Interface (XIF) and Device Type Definitions

You can download and optionally modify EnOcean device interface (XIF) and device type definitions. You can also manually create custom EnOcean XIF and device type definitions.  To download and modify EnOcean device interface (XIF) and device type definitions, follow these steps:

  1. To download EnOcean XIF definitions, download the EnOcean device type package (.dtp) files from the SmartServer GitHub Repository  You can optionally modify the EnOcean XIF files to hide selected datapoints.

  2. To create a custom EnOcean XIF definition (.eno), see (Optional) Creating a Local EnOcean Device Interface (XIF) Definition.

  3. To create a custom EnOcean device type definition (.dtd), see Defining Device Types.

  4. Import the EnOcean device interface (XIF) and device type definitions using the Import / Export button () on the SmartServer app bar.



    When the EnOcean XIF and device type definitions are loaded, the device type definitions will appear in the Device Types widget.



  5. Define datapoint properties for any datapoints to be monitored or logged as described in Setting Datapoint Properties.

Using Discovery to Add an EnOcean Double Rocker Device

To add an EnOcean double rocker device using discovery, follow these steps:

  1. Plug the EnOcean USB network interface into an available SmartServer USB drive.


  2. Open the SmartServer IoT CMS or open the SmartServer Pi CMS.

  3. Open the Devices widget.



  4. Click the Discover () button.



    A confirmation dialog box appears indicating that discovery may take up to 40 minutes to complete.



  5. Click OK to start device discovery.

  6. Press the EnOcean double rocker switch to activate it.

    The discovered device appears in the Devices widget.

  7. Once discovery is finished, click the device's Action button () and select the Provision action. 


    If discovery continues to run, reboot the SmartServer IoT or SmartServer Pi.



    The provisioned devices appear in the Devices widget.

Manually Adding an EnOcean Multisensor (STM) Device

To add an EnOcean multisensor (STM) manually, follow these steps:

  1. Plug the EnOcean USB network interface into an available SmartServer USB drive.


  2. Open the SmartServer IoT CMS or open the SmartServer Pi CMS.

  3. Open the Devices widget.



  4. Click the Create () button.



    The Create Edge Devices view appears.



  5. Enter the following information for the device:

    • Name – enter a name for the device
    • UID – enter the ID that is printed on the back of the device (e.g., 04208BA6)



    • Integration method – select Manual assignment 
    • Driver – select enocean
    • Device Type – select STM550-V1-1




  6. Click Save.

    The manually added device appears in the Devices widget.



  7. Click the device's Action button () and select the Provision action.



    The provisioned devices appear in the Devices widget.