Advertisement

Quick Links

EB 5660 EN
Translation of original instructions
SAM HOME Gateway
Firmware 2.5.0
Edition February 2023

Advertisement

Table of Contents
loading

Summary of Contents for Samson SAM HOME

  • Page 1 EB 5660 EN Translation of original instructions SAM HOME Gateway Firmware 2.5.0 Edition February 2023...
  • Page 2 Note on these mounting and operating instructions These mounting and operating instructions assist you in mounting and operating the device safely. The instructions are binding for handling SAMSON devices. The images shown in these instructions are for illustration purposes only. The actual product may vary.
  • Page 3: Table Of Contents

    Contents Safety instructions and measures ..............1-1 Notes on possible severe personal injury ............1-3 Notes on possible property damage .............1-3 Markings on the device ................2-1 Nameplate ....................2-1 Firmware versions ..................2-1 Design and principle of operation ...............3-1 Status indication ..................3-1 Functions ....................3-4 Modbus TCP communication ................3-4 Technical data ....................3-7 Dimensions ....................3-8...
  • Page 4 Operation ....................8-1 LED status indication ...................8-1 Malfunctions ....................9-1 Troubleshooting ..................9-1 Emergency action ..................9-2 Servicing....................10-1 Decommissioning ..................11-1 Removal ....................12-1 Repairs ....................13-1 13.1 Returning devices to SAMSON ..............13-1 Disposal ....................14-1 Certificates ....................15-1 Annex......................16-1 16.1 Accessories ....................16-1 16.2 After-sales service ..................16-1 EB 5660 EN...
  • Page 5: Safety Instructions And Measures

    Therefore, operators must ensure that the device is only used in applications where the operating conditions are within the limits defined by the technical data. SAMSON does not assume any liability for damage resulting from the failure to use the de- vice for its intended purpose or for damage caused by external forces or any other external factors.
  • Page 6 Referenced documentation The following documents apply in addition to these mounting and operating instructions: − Mounting and operating instructions for connected components, e.g. heating controllers of the TROVIS 5500 Automation System − Operating instructions for SAMSON's SAM DISTRICT ENERGY web portal u EB 6901 EB 5660 EN...
  • Page 7: Notes On Possible Severe Personal Injury

    DANGER Risk of fatal injury due to electric shock. The SAM HOME Gateway is designed for use in low-voltage installations. Electrical connection of the device involves potential hazards. Î Observe the relevant electrotechnical regulations of the country of use as well as the regulations of the local power suppliers.
  • Page 8 EB 5660 EN...
  • Page 9: Markings On The Device

    The nameplate shown was up to date at the time of publication of this document. The name- plate on the device may differ from the one shown. The nameplate is located on the right side of the SAM HOME Gateway (viewed from the front).
  • Page 10 Firmware revisions 1.38 1.9.0 Boot loader redesigned and revised Note: Î On updating the firmware version 1.38 to the next firmware version 2.x.x, the intermediate firmware version 1.9.0 (boot loader) must also be uploaded. 1.9.0 2.0.0 Function for meter bus files (ZDB) implemented Login to the SAM Gateway Configurator tool over SAM DISTRICT ENERGY Data logger in the gateway saves more status values. 2.0.0 2.0.3 Processing of more Modbus RTU devices connected to a gateway 2.0.3 2.0.6 Constant measurement of the received signal strength as ASU (Arbitrary Strength Unit) also for Internet connection or during connection to the SAM DISTRICT ENERGY web portal...
  • Page 11: Design And Principle Of Operation

    Design and principle of operation 3 Design and principle of oper- 3.1 Status indication ation The SAM HOME Gateway has LEDs to indi- cate the operating and communication state The SAM HOME Gateway allows wired of the gateway. The operating states of the communication (Ethernet) with energy...
  • Page 12 Design and principle of operation Typ 3374/3375 Typ 5x24/5x25 TROVIS 5578 TROVIS 6611-2 2x DI 1x DO 1x AO 1x AI TROVIS 5576 TROVIS 5579 SAM DISTRICT ENERGY TROVIS 5573 TROVIS 5578 Router Switch Fig. 3-1: Application using the SAM HOME Gateway EB 5660 EN...
  • Page 13 One green and one red LED to indicate communication on RS-232 the interface. The red LED indicates data are being sent by Blinking the SAM HOME Gateway and the green LED indicates that data are being received. M-Bus Relay contact (DO) in closed state...
  • Page 14: Functions

    'Markings on the device' section. 3.3 Modbus TCP communication Basic function All the SAM gateways (including SAM HOME and SAM MOBILE) have a new function to forward requests over Modbus TCP in addition to the usual communication based on the request and response method from Modbus TCP to Modbus RTU. The added function makes it possible to directly connect Modbus TCP devices to the gateway and communicate with them.
  • Page 15 Design and principle of operation Modbus TCP (Ethernet, mobile phone network) The arrow indicates the direction of the Modbus request. Modbus RTU (TTL, RS-232, RS-485) The Modbus RTU interfaces can be used either in master or slave mode. As a result, parallel use can be ruled out. Requests are forward over Modbus TCP according to a configured ta- Fig. 3-2: Modbus communication ·...
  • Page 16 Design and principle of operation Configuration of Modbus TCP forwarding using the SAM Gateway Configurator tool The SAM Gateway Configurator tool (firmware version 2.3.1 and higher) in the expert mode is used for configuration. Modbus TCP devices that are accessible can be saved in the 'TCP forwarding' tab. Further information can be found in the 'Start-up' section (SAM Gateway Configurator tool - TCP forwarding). EB 5660 EN...
  • Page 17: Technical Data

    Design and principle of operation 3.4 Technical data Table 3-2: Technical data · Type 5660 SAM HOME Gateway Type 5660 LAN port (Ethernet) IEEE 802.3, 8-pole RJ-45 port Protocol: − Modbus TCP according to MODBUS Messaging on TCP/IP Implementation Guide V1.0b (2006-10-24) − TLS V1.3 Controller interfaces Modbus RTU protocol, 9600 or 19200 Baud and flexible baud rate;...
  • Page 18: Dimensions

    Design and principle of operation 3.5 Dimensions Panel cut-out 138 x 92 Fig. 3-1: Dimensions in mm · SAM HOME Gateway EB 5660 EN...
  • Page 19: Shipment And On-Site Transport

    Î Observe the storage instructions. NOTICE Î Avoid long storage times. Risk of device damage due to foreign parti- Î Contact SAMSON in case of different cles entering it. storage conditions or longer storage Î Do not remove the packaging and pro- times.
  • Page 20 Shipment and on-site transport Storage instructions Î Protect the device against external influ- ences (e.g. impact). Î Protect the device against moisture and dirt. Î Make sure that the ambient air is free of acids or other corrosive media. Î Observe the permissible storage tem- perature from –10 to +60 °C.
  • Page 21: Installation

    Installation 5 Installation The work described in this section is only to be performed by personnel appropriately quali- fied to carry out such tasks. 5.1 Installation conditions Work position The work position for the gateway is the front view onto the operating controls on the gate- way seen from the position of operating personnel.
  • Page 22 Installation Cut-out for panel mounting Holes for wall mounting Fig. 5-1: Mounting the SAM HOME Gateway Panel mounting 1. Undo the screws on the front cover. 2. Separate the gateway from the base. 3. Make panel cut-out with the dimensions 138 x 92 mm (W x H). 4. Push the base through the panel cut-out.
  • Page 23 Installation Rail mounting 1. Fasten the spring-loaded hook at the bottom of the top hat rail. 2. Slightly push the gateway upwards and pull the top hooks over the top hat rail. 3. Undo the screws on the front cover. 4.
  • Page 24: Electrical Connection

    DANGER Risk of fatal injury due to electric shock. The SAM HOME Gateway is designed for use in low-voltage installations. Electrical connec- tion of the device involves potential hazards. Î Observe the relevant electrotechnical regulations of the country of use as well as the reg- ulations of the local power suppliers.
  • Page 25 One single SAMSON TROVIS 5576 or 5579 Controller, or alternatively another device that has an RS-232 interface, can be connected to the RS-232 port of the SAM HOME Gateway. Do not activate the modem operation function of a connected controller. Exception: fault alarm of a separately connected controller with the modem/controller setting (TAP-SMS).
  • Page 26 Note The connection of more than 10 controllers to the RS-485 bus may cause the monthly data allowance limit to be exceeded. Additional costs may be incurred. Your SAMSON point of contact can help you in such cases. Examples: − Converter for TROVIS 5573/5578: iCon485 (8812-2002)
  • Page 27 COM terminal, the measured value can be read remotely using the SAM HOME Gateway. It is used to read a signal of another device or a 0 to 10 V sensor. − Pt1000 If a Pt1000 sensor is connected to AI1 and COM terminals, the SAM HOME Gateway is able to read the temperature at the sensor and make this value available for data remote polling. Digital inputs  1)
  • Page 28 EB 5660 EN...
  • Page 29: Start-Up

    The DHCP client function remains active for around one minute after the device is switched on. If the SAM HOME Gateway does not receive an IP address from a DHCP server during this period, the device starts to function as a DHCP server with the configured IP address (default setting: 192.168.55.2).
  • Page 30 Î Log in to the SAM DISTRICT ENERGY web portal using your personal login data (u EB 6901). Î Register the SAM HOME Gateway using the MAC address of the device (visible on the housing, starting with 00:E0:99:Fx:xx:xx). For reasons of data security, the device must be registered in the web portal within six hours after the device has been started.
  • Page 31: Setup For Use With A Modbus Tcp Control System Or With 55Home Or 55Pro Apps (Server Mode)

    In this case, the SAM HOME Gateway must operate with an IP address that can be accessed by the clients. Activate and set a port forwarding in the router (Modbus TCP port: 502).
  • Page 32 Start-up Î Disconnect the computer from the SAM HOME Gateway. Î Use a network cable to connect the SAM HOME Gateway to the Internet. Î Connect the SAM HOME Gateway to the corre- Status sponding field devices (controller, energy meter) and Power send a request over the Modbus TCP client (building Portal automation system).
  • Page 33: Configuration With Sam Gateway Configurator Tool

    Microsoft .NET Framework 4 is required to in- stall the SAM Gateway Configurator correctly. In addition to configuration, the SAM Gateway Configurator can perform firmware updates and analyze the gateway operations (Debug-Viewer). The SAM HOME Gateway is delivered to work with a default password. We recommend changing the password on start-up. Note The SAM Gateway Configurator tool can be downloaded from our website u www.samsongroup.com >...
  • Page 34 Configuration with SAM Gateway Configurator tool Firmware versions Firmware revisions 1.7.3 1.8.0 Supports new gateway generation (SAM HOME Gateway) Modbus RTU functions extended in expert mode 1.8.0 2.0.3 UDP used for firmware updates Visible fields and tabs adapted for various firmware and gateway versions 2.0.3 2.1.2 Reading (Major.Minor.Patch) in the Configurator tool showing the gateway firmware version 2.1.2 2.1.3 Firmware transmission using UDP improved 2.1.3 2.3.1 Separate readings (columns) for Modbus TCP and web portal connections Separate configuration possible for the Modbus RTU function (slave) and the Modbus TCP forwarding (firmware version 2.4.0 required)
  • Page 35: General

    TROVIS 5578-E Heating Controller. UDP broadcast telegrams are used and prioritized for the search and configuration. This is necessary to allow those devices to respond that are not configured for the network subnet used by the computer. 'DHCP server' is activated by default in the SAM HOME Gateway. The gateway waits approx. 60 s after the voltage supply is connected before it assigns an IP address. If this is not the case, the device assigns an IP address for itself and any connected devices (e.g. laptop). This ensures that the gateway and laptop can communicate.
  • Page 36 Configuration with SAM Gateway Configurator tool Device overview After scanning, all the available devices are shown with the following information: Column Description Model Device model number Name Any name (max. 16 characters) can be assigned to make it easier to find the device Serial number Internal serial number of the device IP address IP address assigned by the DHCP server or at the time when it was scanned...
  • Page 37: Firmware Update

    Configuration with SAM Gateway Configurator tool 7.2 Firmware update To start an update of the SAM HOME/SAM MOBILE Gateway: Î Right-click the device you want to update. Alternatively: Î Click 'Update'. The following conditions must be met for the update to work: 1. New firmware (*.b66 or *.B56 file) 2. An FTP protocol (firmware version 2.0 and higher) or a proprietary communication is used between the software and the device (all other devices). If a firewall is installed (e.g. Windows ), it must let all protocol telegrams through. ®...
  • Page 38 Configuration with SAM Gateway Configurator tool Selecting the files and starting the update Î Click 'Select file'. The required firmware version is uploaded from the computer to the program. Î Click the 'Update' button to confirm. You are prompted to enter the login details. This is the default setting provided the setting in the 'Security' tab has not been changed. The firmware update starts. The current status is indicated in the progress bar (bottom left). The firmware update is completed. The output window logs the actions and errors that occurred during the firmware update. Î Close the firmware update window. EB 5660 EN...
  • Page 39: Debugging

    Configuration with SAM Gateway Configurator tool 7.3 Debugging The debugging details contain information to check the operations of the gateway. They also facilitate troubleshooting in the installed system. It includes any requests and responses over Modbus TCP and Modbus RTU as well as information on the Internet and web portal connec- tion. Î Select the required device. Î Select 'Debug' from the 'Action' menu to open the debug window for the selected device. Alternatively: Î...
  • Page 40 Configuration with SAM Gateway Configurator tool The table shows all the relevant and collected information. If you want to display all data, click the '˂' button on the right of the window to open an additional bar. Click the 'Clear' button to clear all the debug messages from the list. Click the 'Stop' button to stop logging the debug information.
  • Page 41: Saving Configuration Data

    Configuration with SAM Gateway Configurator tool 7.4 Saving configuration data Î Select the device whose configuration data you want to save. Î Select 'Save to file' from the 'Action' menu. Alternatively: Î Right-click on the device and select the menu item. The configuration data from the gateway are loaded. A window to enter the file name and storage location opens. Î Confirm to save. A file (*.ktc) is saved on the computer. Note The configuration data are saved and transmitted in encrypted form. For subsequent decryption, the gateway password (default or custom) must be known as the source of the file.
  • Page 42: Configuration Windows

    Configuration with SAM Gateway Configurator tool 7.6 Configuration windows Depending on the device type and firmware version, the configuration windows are shown with various tabs and parameter settings. Note The firmware is being constantly developed further. To fully use all the functions, we recommend always to operate the device with the latest firmware. The default password to open the expert level, update the firmware and access other functions can be found in the Annex of these mounting and operating instructions.
  • Page 43 Configuration with SAM Gateway Configurator tool Operation with static IP addresses requires entry of IP addresses, subnet masks and gateway. Î Contact your system administrator for these parameters. Static IP address − When the 'Static IP addresses' box is checked, the gateway uses a fixed IP address. If left unchecked, the IP address is assigned by a DHCP server. DHCP server When the 'Use device as DHCP server' box is checked, the gateway acts as a DHCP server and assigns IP addresses within a defined range to connected devices.
  • Page 44: Portal

    Configuration with SAM Gateway Configurator tool 7.6.2 Portal The gateway is ready configured to automatically establish connection to the cloud-based SAM DISTRICT ENERGY and cyclically transmit data after the device has been registered in SAM DISTRICT ENERGY. There are three groups for push intervals. The 'Portal' tab allows the web portal to be activated or deactivated and the available parameters to be entered.
  • Page 45: Modbus

    Configuration with SAM Gateway Configurator tool 7.6.3 Modbus The settings for the Modbus RTU inter- faces (RS-232, RS-485 and TTL) are made in the 'Modbus' tab. Baud rate Transmission rate for the RS-232, RS-485 or TTL interfaces Timeout Time in milliseconds that the gateway waits for the Modbus interfaces to respond (request/response communication) The recommended value is 1000 ms = 1 s.
  • Page 46: Tcp Forwarding

    Configuration with SAM Gateway Configurator tool Time broadcast Gateway time synchronized with connected Modbus RTU devices Note The interval is 24 hours. The devices must support the time broadcast command (45Hex) to use this function. Gateway address Modbus address of the gateway for addressing and communication The address allows access to gateway data (e.g.
  • Page 47 Configuration with SAM Gateway Configurator tool Gateway list The gateway lists contains all the known and connected gateways which are entered manual- ly. A maximum of 60 gateways can be linked to a gateway. Five of them can be entered as domain addresses. IP or domain IP address or domain address of the gateway Port Port number of the gateway for the Modbus TCP connection (Port:...
  • Page 48: M-Bus

    Configuration with SAM Gateway Configurator tool 7.6.5 M-Bus It is possible to connect up to three M-Bus meters to the gateway. Go to the 'M-Bus' tab to configure this setting. The meter configuration and settings can also be performed in the SAM DISTRICT ENERGY web portal. These meters have a unique primary address. The address is written in the product documentation of the connected meter.
  • Page 49: Zbd Files

    The meter values are then written to the corresponding holding reg- ister assigned to heating circuit 1. 7.6.6 ZBD files An individual mapping file (ZBD) can be created and uploaded onto the gateway in cases where manufacturer-specific meter data are required and when meter data are to be read that do not belong to the standard defined meter values. The ZBD file is used for targeted polling of meter values and manufacturer-specific special values (e.g. billing date values or monthly values, meter time etc.) according to the meter bus specifications of EN 1434-3 or adapted. The function is available for SAMSON gateways and certain TROVIS heating and district heating controllers (TROVIS Series 5500). Contact SAMSON for more detailed information. EB 5660 EN 7-17...
  • Page 50: Relay Control

    Configuration with SAM Gateway Configurator tool 7.6.7 Relay control The parameters for the analog input and the associated relay are configured in this tab. The gateway's threshold switch requires information on the switching level, hysteresis and direction of action. In this case, it is configured on site at the device. The function can also be configured and set over the SAM DISTRICT ENERGY web portal. Analog input Input signal at the analog input It can differentiate between a voltage (0 to 10 V) and a temperature...
  • Page 51: Network Time Protocol (Ntp)

    Configuration with SAM Gateway Configurator tool 7.6.8 Network Time Protocol (NTP) The device requires the time at the place of installation for functions requiring ex- act times (e.g. alarms, data logging etc.). The gateway can poll this time cy- clically from special servers over the standardized protocol NTP (Network Time Protocol).
  • Page 52: Security

    Configuration with SAM Gateway Configurator tool 7.6.9 Security Access passwords of the administrator for login and firmware updates can be changed. Functions including those rele- vant for data security, encryption and remote access to activate and configure the device can also be changed. Password for administrator Determines the administrator password for the device ('admin') The user name is 'Admin'. Note The default password is 'Kundendienst'.
  • Page 53: Enabling On-Site Access To The Gateway

    A function to enable the access over a portal PIN can be activated in the 'Security' tab to prevent unwanted remote access in the field to the gateway configuration data. This function can only be used in combination with access to the SAM DISTRICT ENERGY web portal. It must be enabled in the client's account. Contact your contact person at SAMSON AG. EB 5660 EN 7-21...
  • Page 54: Expert

    Note The PIN becomes invalid after three hours. A new PIN must be created and sent. 7.6.11 Expert The SAM HOME Gateway is used to fa- cilitate the integration of Modbus devic- es into the cloud-based SAM DISTRICT ENERGY. Default settings are available for the interfaces.
  • Page 55 A corresponding note appears in the bottom section of the tab when the default setting is changed. Click the 'Default setting' button to reset the parameter settings back to the SAMSON-compatible standard (only for devices with Modbus RTU interface). EB 5660 EN...
  • Page 56 7-24 EB 5660 EN...
  • Page 57: Operation

    Î Take appropriate data security measures to prevent unauthorized access. 8.1 LED status indication The LEDs of the SAM HOME Gateway indicate the operating and communication state of the gateway. Meaning...
  • Page 58 EB 5660 EN...
  • Page 59: Malfunctions

    Malfunctions 9 Malfunctions 9.1 Troubleshooting Î See Table 9-1 and Table 9-2. Table 9-1: Troubleshooting (1) Error Possible reasons Recommended action Î Check the power supply The gateway is not (see the 'Design and Power LED not illuminated. powered with the specified principle of operation' and voltage supply.
  • Page 60: Emergency Action

    (e.g. controller) (SAM Gateway Configurator tool). Note Contact SAMSON's After-sales Service for malfunctions not listed. 9.2 Emergency action Plant operators are responsible for emergency action to be taken in the plant. EB 5660 EN...
  • Page 61 EB 5660 EN...
  • Page 62 EB 5660 EN...
  • Page 63: Servicing

    Servicing 10 Servicing The work described in this section is only to be performed by personnel appropriately quali- fied to carry out such tasks. We recommend inspection and testing according to Table 10-1. Table 10-1: Recommended inspection and testing Inspection and testing Action to be taken in the event of a negative result Check the markings, labels and nameplates on Î...
  • Page 64 10-2 EB 5660 EN...
  • Page 65: Decommissioning

    Decommissioning 11 Decommissioning The work described in this section is only to be performed by personnel appropriately quali- fied to carry out such tasks. DANGER Risk of fatal injury due to electric shock. Î Only allow trained and experienced personnel to perform the work. Î Before disconnecting live wires, switch off the supply voltage and protect it against unin- tentional reconnection.
  • Page 66 11-2 EB 5660 EN...
  • Page 67: Removal

    Removal 12 Removal The work described in this section is only to be performed by personnel appropriately quali- fied to carry out such tasks. DANGER Risk of fatal injury due to electric shock. Î Only allow trained and experienced personnel to perform the work. Î Before disconnecting live wires, switch off the supply voltage and protect it against unin- tentional reconnection.
  • Page 68 12-2 EB 5660 EN...
  • Page 69: Repairs

    Risk of gateway damage due to incorrect service or repair work. Î Do not perform any repair work on your own. Î Contact SAMSON's After-sales Service for service and repair work. 13.1 Returning devices to SAMSON Defective gateways can be returned to SAMSON for repair.
  • Page 70 13-2 EB 5660 EN...
  • Page 71: Disposal

    Disposal 14 Disposal SAMSON is a producer registered at the following European institution u https://www.ewrn.org/ national-registers/national- registers. WEEE reg. no.: DE 62194439/FR 025665 Î Observe local, national and international refuse regulations. Î Do not dispose of components and hazard substances together with your other house- hold waste.
  • Page 72 14-2 EB 5660 EN...
  • Page 73: Certificates

    Certificates 15 Certificates The following certificate is shown on the next page: − EU declaration of conformity The certificate shown was up to date at the time of publishing. The latest certificate can be found on our website at: u www.samsongroup.com > Products & Applications > Product selector > Automation Systems > SAM HOME Gateway > Downloads EB 5660 EN 15-1...
  • Page 74 Management par la qualité totale Development Automation and Integration Technologies SAMSON AKTIENGESELLSCHAFT · Weismüllerstraße 3 · D 60314 Frankfurt am Main Revision 08 Fon: +49 69 4009-0 · Fax: +49 69 4009-1507 · E-Mail: samson@samson.de · Internet: www.samson.de 15-2 EB 5660 EN...
  • Page 75: Annex

    You can reach our after-sales service at aftersalesservice@samsongroup.com. Addresses of SAMSON AG and its subsidiaries The addresses of SAMSON, its subsidiaries, representatives and service facilities worldwide can be found on our website (www.samsongroup.com) or in all product catalogs. EB 5660 EN 16-1...
  • Page 76 Annex Required specifications Please submit the following details: − Type number − Firmware version − Serial number 16-2 EB 5660 EN...
  • Page 77 Annex Default password User Admin Password Kundendienst EB 5660 EN 16-3...
  • Page 78 16-4 EB 5660 EN...
  • Page 82 EB 5660 EN SAMSON AKTIENGESELLSCHAFT Weismüllerstraße 3 · 60314 Frankfurt am Main, Germany Phone: +49 69 4009-0 · Fax: +49 69 4009-1507 samson@samsongroup.com · www.samsongroup.com...

Table of Contents