1. Manuals
  2. Brands
  3. HMS Networks Manuals
  4. Network Hardware
  5. Ixxat CAN-Gateway Configurator V6
  6. User manual

HMS Networks Ixxat CAN-Gateway Configurator V6 User Manual

For can@net nt and canbridge nt
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
ENGLISH
CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT
USER MANUAL
4.02.0332.20001
Version 1.7
Publication date 2022-06-15

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the Ixxat CAN-Gateway Configurator V6 and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for HMS Networks Ixxat CAN-Gateway Configurator V6

Summary of Contents for HMS Networks Ixxat CAN-Gateway Configurator V6

  • Page 1 ENGLISH CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT USER MANUAL 4.02.0332.20001 Version 1.7 Publication date 2022-06-15...
  • Page 2 The information in this document shall therefore not be construed as a commitment on the part of HMS Networks and is subject to change without notice. HMS Networks makes no commitment to update or keep current the information in this document.

  • Page 3: Table Of Contents

    CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Table of Contents 1. User Guide ..........................1 1.1. Related Documents ......................1 1.2. Document History ......................1 1.3. Trademark Information ...................... 1 1.4. Conventions ........................1 2. Product Description ......................... 3 2.1.
  • Page 4 This page is intentionally left blank.

  • Page 5: User Guide

    User Guide CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT 1. User Guide Please read the manual carefully. Make sure you fully understand the manual before using the product. 1.1. Related Documents Document Author User Manual CAN@net NT 100/200/420 User Manual CANbridge NT 200/420 Software Design Guide CAN@net NT 100/200/420 Generic Protocol for Gateway Mode User Manual CAN@net NT/CANbridge NT Lua ADK...
  • Page 6 CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Conventions Code User Interaction Elements User interaction elements (buttons etc.) are indicated with bold text. Cross-References and Links Cross-reference within this document: Document Conventions External link (URL): www.ixxat.com Safety Symbols DANGER Instructions that must be followed to avoid an imminently hazardous situation which, if not avoided, will result in death or serious injury.

  • Page 7: Product Description

    Product Description CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT 2. Product Description NOTE To use all features the latest version of the CAN-Gateway Configurator as well as the latest firmware of the CAN NT device must be installed. For information about firmware versions below V6 contact Ixxat support.

  • Page 8: Operational Modes Can@Net Nt

    CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Operational Modes CAN@net NT 2.2. Operational Modes CAN@net NT 2.2.1. ASCII Gateway Mode In the Gateway mode, the CAN@net NT is directly hooked to the local intranet or internet (firewall needed). This allows a TCP/UDP host within the reach of this intranet or internet to connect to the CAN@net NT and gain control of the CAN system.
  • Page 9 Operational Modes CAN@net NT CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT CAN@net NT CAN@net NT (Master) (Slave) Figure 2. CAN-Ethernet-CAN Bridge with 2 devices (NT 200) CAN@net NT CAN@net NT (Master) (Slave) CAN@net NT CAN@net NT (Slave) (Slave) 1+2: 3+4: CAN or CAN-FD...

  • Page 10: Vci Interface Mode

    CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Add-Ons for Customer Specific Expansions 2.2.4. VCI Interface Mode IMPORTANT The VCI interface mode is only possible via Ethernet. With the VCI driver the CAN@net NT can be used as a PC interface with Windows. All VCI-based Ixxat tools as well as customer-specific applications based on the VCI driver can be used.

  • Page 11: Installation

    Start the Ixxat CanGWconfig Setup. • Installation wizard starts automatically. Follow the instructions in installation program. • By default the package is stored in C:\Program Files\HMS\Ixxat CAN-Gateway Configurator V6. • The examples for (LUAand configuration) are stored in C:\Users\Public\Documents\HMS\Ixxat CAN- Gateway Configurator\Examples.
  • Page 12 CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Checking and Updating the Firmware NOTICE The firmware is constantly improved and expanded! Check if a newer firmware version is available within the product support pages on www.ixxat.com/support-bridges-gateways. If the current firmware of the device in use is V4 or older: •...

  • Page 13: Connecting The Device In Use

    Connecting the Device in Use CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT 4. Connecting the Device in Use IMPORTANT Connection disturbance possible if extension cable or longer cable is used! HMS recommends connecting the interface directly with the included cable or via an active USB hub to the computer according to the USB specification.
  • Page 14 CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Connecting the Device in Use In combo box Target Device (7) select the device in use. If a CAN@net NT is connected via a router, enter the IP address in combo box Target Device (7) 10.

  • Page 15: Configuring The Device

    Configuring the Device CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT 5. Configuring the Device NOTE In the configuration tree open Info to add information about the configuration in fields Author, Configuration Name and Additional Info. NOTE It is possible to create and save a configuration without a connected device. Saved configurations can be downloaded to connected CAN NT devices with Windows and Linux by using the Command Line Tool (see Downloading the Configuration with Linux, p.

  • Page 16: Can@Net Nt Bridge Mode (Local Can, Can-Eth-Can)

    CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Basic Configuration Steps Click button Save or Save as to save the configuration. To exchange messages in the Gateway mode, use ASCII commands (for more information see Software Design Guide CAN@net NT 100/200/420 Generic Protocol for Gateway Mode).

  • Page 17: General Settings

    General Settings CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT To activate the new rules, execute the following command: udevadm control --reload-rules To load a saved configuration file onto the CAN NT device, use the command line tool cangwfile. If the tool is started without any command line parameters, a list of available commands and options is shown.
  • Page 18 CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT General Settings LUA ADK The Ixxat Lua ADK is a firmware extension that is layered over the standard firmware and based on the standard Lua 5.3.5 distribution. By using the Lua ADK for handling and processing of communication data the functionality of the standard application can be expanded.
  • Page 19 General Settings CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT • discard new messages (default) • discard old messages In the CAN-Ethernet-CAN Bridge mode the Expert mode of the Master can be configured individually for the connection to each connected Slave. CAN Tunnel With two CANbridge NT 420 it is possible to transmit messages between two Classic CAN networks via a CAN FD network (CAN tunnel).

  • Page 20: Can Ports

    CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT CAN Ports 10. Configure the CAN tunnel of the second device. 11. In drop-down list Tunnel Port select the receiving port for CAN FD messages. 12. In drop-down list Classic Port select the receiving port for the Classic CAN messages. •...
  • Page 21 CAN Ports CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT With CAN@net NT configure the Master and each Slave that is active (black) in the configuration tree. Select CAN Ports in the configuration tree (1). • Form to set baud rate of each port of the selected device appears on the right side. If only certain CAN ports of a device are used, deactivate the check boxes of the CAN ports (2) not to be used.
  • Page 22 CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT CAN Ports Formula for the calculation of the baud rate: CAN 1 and CAN 2 (Classic CAN) • baud rate [kBaud] = 36000 / ((TSEG1 + TSEG2 +1) * Prescaler) CAN 3 and CAN 4 (Classic CAN/CAN FD) •...
  • Page 23 CAN Ports CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Setting Recommendations for CAN FD NOTE HMS Industrial Networks recommends using the same bit timing settings in all connected nodes. Observe the following recommendations: • Set arbitration and data phase prescaler as low as possible. •...

  • Page 24: Communication Error Severity

    CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Communication Error Severity 5.4. Communication Error Severity NOTE With the CAN@net NT in the CAN-Ethernet-CAN Bridge mode each device can be configured differently. But to build a Bridge configuration all devices must be configured in one configuration file.

  • Page 25: Syslog Configuration

    Syslog Configuration CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT 5.5. Syslog Configuration NOTE With the CAN@net NT in the CAN-Ethernet-CAN Bridge mode each device can be configured differently. But to build a Bridge configuration all devices must be configured in one configuration file.

  • Page 26: Mqtt Configuration

    CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT MQTT Configuration Enabling the Syslog Configuration To enable Syslog, in the configuration tree select General and select enabled in the field Use of Syslog. • Syslog Configuration is enabled in the configuration tree. In the configuration tree select Syslog Configuration.
  • Page 27 MQTT Configuration CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Figure 11. MQTT configuration MQTT messages are only possible with the CAN@net NT via Ethernet. Figure 12. MQTT Publisher and Subscriber 4.02.0332.20001 Version 1.7 Page 23 of 56...
  • Page 28 CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT MQTT Configuration The CAN@net NT supports MQTT v3.1.1 and can act as publisher and as subscriber. With the MQTT/CAN Bridging module CAN messages of a defined format can be published and received via MQTT. Additionally as publisher the CAN@net NT can publish messages via MQTT that can be individually defined in Action Rules.
  • Page 29 MQTT Configuration CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Configuring MQTT/CAN Briding With the MQTT/CAN Bridging module CAN messages in JSON format can be published and received via MQTT. Enable the MQTT configuration (see Enabling the MQTT Configuration, p. 24).

  • Page 30: Action Rules

    CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Action Rules System Variables for Topic and Payload For topic and payload it is possible to use system variables that are replaced with actual values when a message is sent. For example, the following keywords are possible: •...
  • Page 31 Action Rules CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT To load an existing csv file with actions rules, click button Import in Action Rules. • Window Select a File is opened. NOTE If a csv file is imported, already entered action rules are deleted. To save configured Action Rules as template, click button Export.
  • Page 32 CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Action Rules It is possible to configure either a delay time or a blocking time. The blocking time defines the minimum time between two executed actions. The blocking time starts after the execution of an action.
  • Page 33 Action Rules CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Possible Events Event name Description Further settings CAN message If this event is set, the defined action is triggered if the CAN Port: port to receive the message received specified CAN message is received on the specified CAN CAN message format: standard or port.
  • Page 34 CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Action Rules Event name Description Further settings Comm. error state In Communication Error Severity it is possible to – changed to warning configure that the device changes to status warning in defined events (see Communication Error Severity, p.
  • Page 35 Action Rules CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Possible Actions Action name Description Further settings Start CAN – CAN Port Stop CAN – CAN Port Send CAN The status message contains the status of the CAN CAN Port: port to transmit the message to status controllers as well as other status information of CAN message format: standard or extended...
  • Page 36 CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Action Rules Table 1. Data Bytes of CAN Status Message Byte number Description Possible states Error State of CAN 1 See table CAN Error State in Bytes 1-4 of the CAN Status Message (page 32) Error State of CAN 2 Error State of CAN 3 Error State of CAN 4...

  • Page 37: Mapping Table

    Mapping Table CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT 5.8. Mapping Table The CAN-Gateway Configurator allows free routing configurations. Individual messages or message groups can be mapped from and to each CAN port. The route through the device always starts at the receiving CAN controller (message source) and ends at the transmitting CAN controller (message destination).
  • Page 38 CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Mapping Table Configuration Select Mapping Table in the configuration tree. • Form to specify the mapping table appears on the right side. NOTE If new mapping tables are loaded, already available mapping table entries are deleted. To load an existing mapping table, click button Import.
  • Page 39 Mapping Table CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Possible Entries Column Possible entries Rx Device CANbridge NT: select local. CAN@net NT: Master, Slave 1, additionally with NT 420: Slave 2, Slave 3 Rx Channel CAN1, CAN2, additionally with NT 420: CAN3, CAN4 Defines the receive channel.
  • Page 40 CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Mapping Table • binary positions with value 1 are relevant for the filter • binary positions with value 0 are not relevant for the filter Binary representation of value: • Defines the values for the positions that are marked as relevant (1) in mask. •...
  • Page 41 Mapping Table CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Examples Example 3. Mapping Table Bridge The following mapping table is an example of a CANbridge NT Bridge, that allows all messages (standard and extended) to pass: • from CAN 1 to CAN 2 and vice versa •...

  • Page 42: J1939 Mapping Table

    CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT J1939 Mapping Table 5.9. J1939 Mapping Table IMPORTANT To be able to transmit CAN FD messages, CAN port 3 and CAN port 4 must be configured as CAN FD port (see CAN Ports, p.

  • Page 43: Can Fd/Can Demultiplexing

    CAN FD/CAN Demultiplexing CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Possible Entries Column Possible entries Rx Device CANbridge NT: select local. CAN@net NT: Master, Slave 1, additionally with NT 420: Slave 2, Slave 3 Rx Channel CAN1, CAN2, additionally with NT 420: CAN3, CAN4 Defines the receive channel.

  • Page 44: Can/Can Fd Multiplexing

    CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT CAN/CAN FD Multiplexing Figure 19. Example demultiplexing table For handling of the table see configuration in Mapping Table, p. Entry Limitations The size of the mapping table is limited. Maximal 128 CAN FD messages are possible. Possible Entries Column Possible entries...
  • Page 45 CAN/CAN FD Multiplexing CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Figure 20. Example multiplexing table For handling of the table see configuration in Mapping Table, p. Entry Limitations The size of the mapping table is limited. Maximal 128 CAN FD messages are possible. 4.02.0332.20001 Version 1.7 Page 41 of 56...
  • Page 46 CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT CAN/CAN FD Multiplexing Possible Entries Column Possible entries Activated, Deactivated An activated checkbox defines the start of a new CAN FD message, that is to be transmitted. Rx channel CAN1, CAN2, CAN3 (Classic CAN) and CAN4 (Classic CAN) Defines the receive channel of the Classic CAN message.

  • Page 47: Cyclic Transmission

    Cyclic Transmission CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT 5.12. Cyclic Transmission IMPORTANT To be able to transmit CAN FD messages, CAN port 3 and CAN port 4 must be configured as CAN FD port (see CAN Ports, p. 16) .
  • Page 48 CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Cyclic Transmission Possible Entries Column Possible entries Rx channel CAN1, CAN2, additionally with NT 420: CAN3, CAN4 Defines the receive channel. Rx format Standard, Extended Defines the format in which messages are received, standard (11 bit identifiers) or extended (29 bit identifier).

  • Page 49: Dashboard

    Dashboard CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT 6. Dashboard With the dashboard that is integrated in the CAN-Gateway Configurator it is possible to keep track of transmitted messages in the software, and, for example, to monitor in the receive counters and transmit counters of the various modules.
  • Page 50 CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Dashboard Figure 23. Slave Figure 24. Local Bridge Segments of the surface: Page 46 of 56 4.02.0332.20001 Version 1.7...
  • Page 51 Dashboard CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT CAN1 - CAN4 Information about the CAN interfaces Mapping Information about the Mapping Table and the J1939 Mapping Table Mux/Demux Information about the CAN-FD/CAN demultiplexer/multiplexer Cyclic Information on cyclic data transmission (Cyclic Transmission) Action Rules Information about the Action Rules Load Filter...

  • Page 52: Command Line Program

    CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Command Line Program 7. Command Line Program The integrated command line program CanGWfile works via USB and with the CAN@net NT also via TCP. The command line tool is available for Windows and for Linux (cangwfile). Output when Started Without Parameters #### Ixxat CAN-Gateway File Utility V6.05 #### Syntax:...
  • Page 53 Output when Started Without Parameters CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT • CXML: device configuration created and saved by the CAN-Gateway Configurator (*.cxml) • CONF: device configuration exported by the CAN-Gateway Configurator as conf file • ERR: error/log file •...

  • Page 54: Reset

    CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Reset 8. Reset Figure 25. Menu Reset to factory settings Reset Target With Reset target (1) it is possible to restart the device without reset the configuration • Open menu Target and select Reset target. •...
  • Page 55 Reset to Factory Settings CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Click button Yes to confirm the reset. • Configuration is reset to factory settings. • Connection to the CAN-Gateway Configurator is lost. 4.02.0332.20001 Version 1.7 Page 51 of 56...

  • Page 56: Security Settings

    CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Security Settings 9. Security Settings The CAN-Gateway Configurator has four security levels. The default device password is IXXAT. NOTE HMS Industrial Networks recommends to change the default password. Action Security level 1 Security level 2 Security level 3 Security level...
  • Page 57 Security Settings CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Figure 26. Security Settings IMPORTANT If the device is connected via Ethernet and the security level is set to 3 or 4, the access via Ethernet is locked. For changes the device then has to be connected via USB. 4.02.0332.20001 Version 1.7 Page 53 of 56...

  • Page 58: Lua License

    CAN-Gateway Configurator V6 for CAN@net NT and CANbridge NT Lua License 10. Lua License Copyright © 1994–2019 Lua.org, PUC-Rio. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the...
  • Page 59 This page is intentionally left blank.
  • Page 60 This page is intentionally left blank.

Table of Contents