SoftGateway Manual
Page Contents
Introduction¶
This manual describes Proemion SoftGateway version 3.x and its settings.
Proemion SoftGateway enables bidirectional CAN communication between local and remote CAN networks.
It routes messages in RealTime via the CAN interface of one CAN device to the CAN interface of another CAN device.
This way, a local application can connect to a remote machine by using two CAN devices: a (remote) CANlink mobile on the machine and a (local) gateway device connected to the application.
Note
Proemion SoftGateway can also be used as a driver for a "Diagnostics & Service Tool". See Service and Support to get in touch about this integration.
Use Cases¶
Proemion SoftGateway remotely bridges a CANlink mobile with a supported gateway device connected to the local application, e.g. a service tool, without requiring any changes to the service tool itself.
This setup can be used for proof-of-concept tests, configuring machine parameters, or sending files, all of which would otherwise require being on-site.
A service technician can observe the CAN messages received by a CANlink mobile with SoftGateway as follows: the messages received by the CANlink mobile are sent to a supported gateway device, e.g. a PCAN-USB, over the internet and transmitted through the CAN interface of the gateway device:

Other use cases include:
- Connecting two local CAN networks via SoftGateway, using the same type of gateway device, e.g. PCAN-USB, on each side. See Add and Configure Gateway Devices for setup instructions.
- Transferring files between a service tool and a CANlink mobile. See Transfer Optimization for how to configure the transfer behavior.
Comparing SoftGateway Versions 2.x and 3.x¶
- Version 3.x ships with predefined filter sets, so SoftGateway is ready to use with an initial operation set.
- Tool updates can now be checked manually via ? > Check for updates....
- Issues can be reported via ? > Report an issue..., which opens the Proemion Support Form, where support can be contacted directly.
Note
Both Remote Service Tool and SoftGateway work with RealTime connections to Proemion devices, but they serve different purposes: Remote Service Tool focuses on CAN bus data visualization for service and analysis, while SoftGateway enables bidirectional communication and file transfers between CAN networks.
Login¶
Logging in to the Proemion DataPlatform is supported via SSO:

Note
SSO login is a preliminary feature.
Proemion customers with a full white-label solution must configure their dedicated API address before logging in.
Go to Options > Preferences and set the dedicated REST API URL:

Logging in opens DataPortal in a browser, where the user signs in.
To change the login credentials, clear the browser cache first.
Once SoftGateway is configured and running, the Login/Logout action has no further effect on the tool itself: logging in is only required to retrieve the machine list and select the target of the remote connection.
SoftGateway shows an error if the target machine is not connected to DataPortal, or if a remote reset connection is applied.
Setup & Configuration
Setup¶
By default, Proemion SoftGateway and the client application, e.g. a "Diagnostics & Service Tool", run on the same computer.
If the cable gateways or applications used cause conflicts, run them on separate computers instead:

Note
A CAN bus termination (two 120 Ω resistors) is required. See Connecting the Device to the PC in the CANlink® mobile 3600 device manual for wiring details.
Use separate CAN bus monitoring software, such as PCAN-View (version 5.3.0 or later), to compare the messages received by the service tool and the CANlink mobile:

Resources¶
Download Proemion SoftGateway and its release notes from the Download Center, under 03_Proemion Tools Software > 01_Software > 06_PROEMION SoftGateway.
We recommend the PCAN-USB by PEAK as the CAN-to-USB gateway device.
Prerequisites¶
Proemion SoftGateway has the following prerequisites:

- Requires MS Windows 10 or 11.
- No special hardware is required.
- To retrieve the machine list from the Proemion server, SoftGateway uses an outgoing TCP connection on port 443 (HTTPS).
- For a RealTime connection to a CANlink mobile, SoftGateway uses WebSockets on port 443 (same as HTTPS).
- Ensure the firewall does not block these connections, otherwise the RealTime connection cannot be established.
- Ensure the CANlink mobile device is in RealTime mode, see RealTime Operation.
- Check connectivity on the computer using connectivity-check.exe (Windows, 64-bit), available via Connectivity Check.
- A Proemion DataPlatform account (preferably a REST client) with RealTime permission must be set up for the CANlink mobile device.
- SoftGateway is based on the REST API, so DataPortal users with the Realtime:Admin Permission Set are allowed to use the tool.
Add and Configure Gateway Devices¶
Add the CAN devices via the Play buttons in Connection Control to establish a connection between them.
Configure their communication settings via Gateway Settings.
Add Gateway Device 1¶
-
Add the gateway device, e.g. PCAN-USB, see Resources for where to get it.

Figure 1: Gateway Device 1 configuration Enter the password
GSMONLIN. -
Adjust the settings where necessary, e.g. the Baud rate (set the CAN bit rate according to the system).
-
Click OK to apply the settings.
The final Gateway Device 1 setup looks as follows:

Figure 2: Gateway Device 1
Add Gateway Device 2¶
-
Add the CANlink mobile by logging in to DataPlatform.

Figure 3: Gateway Device 2 configuration -
Click Find machines to select the target device or machine.

Figure 4: Find machines -
Adjust the settings where necessary, e.g. Source CAN (choose the CAN interface, e.g. CAN1 or CAN2).
Note
During an active connection, the available CAN interface can be switched. Transfer Optimization is turned on automatically in this case.
Successful Connection¶
When the connection is successful, SoftGateway indicates the connected devices with a green status in Connection health:

If a gateway device has a problem, the CAN bus state in Connection health turns red, indicating an error:

Stop the connection via Connection Control, or by closing SoftGateway.
The configuration is saved and proposed again at the start of the next session.
Transfer Optimization¶
Transfer or upload files via CAN, or via protocols such as CANopen, from a service tool to the CANlink mobile on the machine.
These files are, for example, configuration or firmware files.
By default, the Transfer optimization slider is set to Off when no connection is active.
Warning
After starting Connection Control, the Transfer optimization slider is automatically set to On. If the CAN protocol does not use the CANopen segmented data transfer, set the Transfer optimization slider back to Off.

Transfer optimization applies only to the CANopen segmented data transfer, and requires a CANlink mobile with firmware version 2.0.0 or later.
CAN Filters¶
Set up CAN filters to limit the CAN communication for transmitted and received 11-bit or 29-bit messages.
Leave the filter set to Fully Open to apply no filtering, see Predefined Filter Profiles.
Filters can also be imported.
Note
During an active connection, CAN filters can be switched.
Open the Filter set configuration window via Options > Filter set configuration:

Alternatively, select the Filters button:

Create a New Filter Set¶
-
Open the Filter set configuration window via the Filters button.
The Filter set configuration window opens:

Figure 3: Filter set configuration window -
Click the Plus icon to add a new filter set.
-
Rename the filter set by clicking the Pencil icon, or remove it by clicking the X icon.
Filters can also be imported in this window.
-
Enter the filter set directly in the empty area on the right, as shown in the following image.
The ID, Mask, and Suspension time/Timeout in msec can be edited in the same area.Note
If an
.idsexport from a previous SoftGateway version is available, its content can be copied and pasted here.
Figure 4: New filter -
Click OK to store the filter set.
The filter set can also be exported as a JSON file.
The new filter set becomes immediately available for selection in the Gateway settings:

Predefined Filter Profiles¶
By default, two predefined profiles are available in the Filter set configuration window: Fully closed and Fully open.
Selecting a profile fills the area on the right (empty by default) with its content, in the following format:
-
Fully open:
[11Bit] 0x000, 0x000 [29Bit] 0x00000000, 0x00000000 -
Fully closed: empty/blank
Neither predefined profile can be overwritten, removed, or edited.
The filter definition format works as follows:
[11Bit],[29Bit]: CAN message filters applied to a CAN message ID with a length of 11 bit or 29 bit.0x0/0x00000000: the fixed CAN message ID, in hex or decimal format.0x000/0x00000000(optional): the CAN message filter mask, in hex or decimal format.0/0: the down-sample cycle time. If this value is0, it can be omitted from the filter definition.
Optimization Configuration¶
Optimization Configuration is a feature that manages communication handshakes, reducing the delay between a request and its corresponding answer.

Select Options > Optimization configuration to open the configuration window:

- Configure a request message. When this message is received, on either side of SoftGateway, it starts storing response messages and sends back a stored answer if one already exists.
- Configure a response message, the answer to the request message. SoftGateway saves the latest data content and returns it when requested.
Example¶
A request is sent under optimization:
- ID:
0x123 - DLC:
8 - Data:
11 22 33 44 55 66 77 88
Expected reply:
- ID:
0x321
When SoftGateway sees the request for the first time, it starts the optimization.
An ECU on the remote side replies with 0x321.
The first reply might take some time to arrive.
The second time the same request is sent, SoftGateway immediately answers with the stored response, significantly reducing the waiting time.
Service and Support¶
The latest versions of the drivers, software, firmware, and documentation are available at Document Library.
Do you need help or want to report a bug?
Visit Proemion for more information, or raise a ticket via Support.
Firmware Updates and Support¶
To ensure the best performance and security of your devices, we strongly recommend always installing the latest firmware provided by Proemion.
Please note:
We do not provide technical support for issues caused by outdated firmware.
Errors resulting from outdated firmware are considered non-qualified errors and are not covered by warranty or support.
Regular firmware updates are essential to maintaining the functionality of your devices.
If you need assistance with the update process, please contact our Service and Support.
For more information on the Firmware Update, check the device manual of your device at the Document Library.
