(Optional) Add a Remote EnOcean Interface for SmartServer IoT

Remote EnOcean interface is supported with SmartServer 4.3 and higher.

EnOcean devices are supported in remote mode with SmartServer 4.3 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.

You can use the SmartServer to integrate and manage EnOcean devices in remote mode. This section describes how to get started using remote EnOcean interface and consists of the following:

For local EnOcean interface, see (Optional) Add a Local EnOcean Interface.

Setting up Remote EnOcean Interface

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

  1. Optionally add an EnOcean network interface as described on this page. 

  2. Enable remote mode on your SmartServer as described on this page. For SmartServer IoT 4.3, do not use the EnOcean Configuration page to enable remote mode; for this release, remote mode is configured manually as described on this page. If a local EnOcean radio is used, then you will also configure Local Antenna Tunnel settings using the SmartServer EnOcean Configuration page as described on this page.
     
  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 devices as described in Site Provisioning. See the following section on this page for a step-by-step example:
  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

With SmartServer 4.3 and higher, EnOcean IoTC is supported as an EnOcean network interface, where EnOcean devices can be accessed through EnOcean WSS tunnel via access points, gateways, and SmartServers.

You can also optionally attach an EnOcean USB network interface to your SmartServer to add support for communicating with your EnOcean devices. See USB 300, 300U, 400J, and 500U EnOcean Network InterfacesIf a local EnOcean radio is used, then you will also configure Local Antenna Tunnel settings using the SmartServer EnOcean Configuration page as described in the next section.

Enabling Remote Mode

Perform the following steps to enable remote EnOcean interface.

  1. Open a terminal connection to SmartServer IoT.

  2. Edit the remote mode configuration file by entering the following command, followed by the apollo password:

    SmartServer IoT
    sudo nano /var/apollo/conf.d/iotcid/iotcid.conf
  3. Configure and save the remote interface mqtt and iotc (API) settings, including the remote server address and login credentials as shown in the example below.


    SmartServer IoT example

  4. If you were previously configured for EnOcean interface local mode, then enter the following commands to stop and disable local EnOcean interface:

    sudo smartserverctl stop enocean
    sudo smartserverctl disable enocean
  5. Enter the following commands to start and enable remote EnOcean interface:

    sudo smartserverctl start iotcid
    sudo smartserverctl enable iotcid
  6. Enter the following command to verify that the enocean process (local mode) is inactive and iotcid process (remote mode) is active:

    sudo smartserverctl status


    Example results to include:
    enocean                            inactive
    iotcid                             active since Thu 2024-03-14 09:26:14 EDT; 39s ago
  7. Open the SmartServer Configuration page as described in Accessing the SmartServer IoT Configuration PageThe 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

  8. Click the EnOcean tab. 



  9. If needed, click the Enabled option and/or select Remote mode. The settings that you defined in the iotcid.conf file will appear for the SmartServer IoT remote server.

  10. If you are using a local EnOcean radio, then verify that the EnOcean USB network interface is plugged into an available SmartServer USB drive and configure the Local Antenna Tunnel settings as follows:
    1. Set the Enabled option to enabled status.
    2. Set Auth URL to the EnOcean IoTC cloud URL.
    3. Use the Host DEV pulldown menu to set the SmartServer USB where the EnOcean radio is connected. To determine which port is being used, enter the following command from a terminal connection to the SmartServer:

      sudo ls -l /dev/serial/by-id/ | grep usb-EnOcean_GmbH

      A response similar to the one shown below is returned, where the port is ttyUSB0:

      lrwxrwxrwx 1 root root 13 Mar 17 14:48 usb-EnOcean_GmbH_USB_500U_DA_EO6TD13G-if00-port0 -> ../../ttyUSB0
    4. Set Username to the EnOcean IoTC username credentials.
    5. Set Password to the EnOcean IoTC password credentials.
    6. Set Client ID to a user-defined client identifier (e.g., userStarterKit).
    7. Set Identifier to your SmartServer MAC ID without the colons (e.g., 00d0710d29b5). You can find your SmartServer MAC ID on the SmartServer System Configuration page. See Viewing System Information.


      SmartServer IoT example

  11. Click Update to save the remote mode 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 (.iotc), see (Optional) Creating a Remote EnOcean Device Interface (XIF) Definition.

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

  4. If you were previously configured for EnOcean interface local mode, then open the SmartServer IoT CMS and remove local EnOcean interface device types from the Device Types widget. SeDefining Device Types.

  5. 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.



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

Adding Remote EnOcean Devices

Once you have enabled remote mode and imported EnOcean device types, you can manually add EnOcean devices and/or discover EnOcean devices. To add EnOcean devices using remote mode, perform the following steps.

  1. Open the SmartServer IoT CMS.

  2. Open the Devices widget.



  3. If you were previously configured for EnOcean interface local mode, then remove the EnOcean devices from the Devices widget. See Discovering, Defining, or Importing Devices.

  4. If you are manually adding EnOcean devices, then define the Create Edge Devices fields as shown in the example below. See Discovering, Defining, or Importing Devices

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


    • Integration method – select Manual assignment 
    • Driver – select iotc
    • Device Type – select the device type (e.g., STM550-V1-1)

      The devices are added and provisioned.

  5. If you are adding EnOcean devices using IoTC, then click the Discover button () on the Devices widget.



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



  6. Click OK to start device discovery.

    The discovered remote EnOcean devices appear in the Devices widget.



    The discovered remote EnOcean devices are automatically provisioned.



    If you discover remote EnOcean devices, removing them using the SmartServer CMS Devices widget removes the devices from the remote server

  7. If discovery continues to run, reboot the SmartServer IoT