Configuration

The Configuration Application is a command driven application that is used to upload created configurations to the DD500E. The application and a default configuration file can be downloaded from the Advenica Artifactory file share site, see Downloads for details.

Make sure the following files are downloaded before proceeding:

dd500e_config.exe
dd500e_config_template.toml

Preparations

Perform the following steps to prepare for using the Configuration Application:

Configuration Application preparation

Step 1Step 2Step 3

Copy the downloaded files to a directory on a Configuration laptop running Windows 11.
Edit the .toml configuration file, see Editing configuration.
Run Configuration Application, see Using Configuration Application.

Editing configuration

A complete DD500E configuration includes network settings for both the Upstream and Downstream side of the device. Multiple configurations can be created, using unique names when saved. Only one configuration file can be uploaded to the DD500E and the file must have the .toml file extension to be accepted when uploaded to the device.

note

DD500E is delivered without a loaded configuration.
DD500E does not support dynamic configuration, such as DHCP.

To edit a configuration, perform the following steps:

Edit configuration

Step 1Step 2Step 3Step 4

Open the default dd500e_config_template.toml configuration file in a text editor, such as Windows Notepad.
Change the parameters, adjusting them for the Upstream and Downstream networks the DD500E will be connected to. Parameters with default values are listed in the table in Default settings.
Save the updated configuration file, making sure to use the .toml extension.
Proceed with using the Configuration Application, see Using Configuration Application.

Default settings

In the DD500E default dd500e_config_template.toml configuration file, the following parameters are available:

Parameter	Default value	Comment
Upstream
upstream_ip	10.0.0.42	IPv4 address for the Upstream network interface.
upstream_network_mask	255.255.255.0	IPv4 network mask for the Upstream network interface.
upstream_port	6000	UDP port the Upstream network interface will listen on.
Downstream
downstream_ip	10.0.0.54	IPv4 address for the Downstream network interface. This address will be used as source address for packets sent to the intended destination.
downstream_network_mask	255.255.255.0	IPv4 network mask for the Downstream network interface.
downstream_default_gateway_ip	0.0.0.0	IPv4 address for the default gateway on the Downstream network. If set to 0.0.0.0, no default gateway will be set and the destination_ip is assumed to be in the same subnet as downstream_ip.
destination_ip	10.0.0.2	Destination IPv4 address to forward data to.
destination_port	6000	Destination UDP port to forward data to.
Common
max_payload_size	1472	Maximum size, in bytes, of payload within a UDP datagram. A lower value makes the device able to handle more datagrams per second. Minimum value is 32. Maximum value is the smallest of: - connected network Ethernet MTU minus 28 (to accommodate IP and UDP headers) - 1472 Note! IP fragmentation or Path MTU Discovery (PMTUD) is not supported.

Using Configuration Application

The Configuration Application is command driven and will perform various tasks based on entered commands.

Available commands are:

list-ports - lists available serial ports. The command requires that the USB-serial cables are connected correctly (see Connecting cables for configuration) and that the DD500E is powered on (see Power).
configure - sends a configuration file to the specified serial ports.
info - shows device specific information from a specified serial port (see Info).
diagnostics - shows diagnostic information from a specified serial port (see Diagnostics).
error-logs - shows the 10 latest error logs from a specified serial port (see Error logs).
read - reads real-time information from a specified serial port. Note that network traffic sent over the DD500E cannot be accessed in any way.
firmware-upgrade - sends new firmware to the specified serial ports. Both the Upstream and Downstream section of the DD500E must be upgraded at the same time (see Firmware upgrade).
factory-reset - erases all user provided settings (see Factory reset).
help - provides information about all commands or a specified command.

To start the Configuration Application, perform the following steps:

Start Configuration Application

Step 1Step 2Step 3

Open the Windows command prompt.
Go to the directory the dd500e_config.exe file was copied to, see Preparations.
Enter dd500e_config followed by the command corresponding with the task to perform.

Checking COM ports

Due to the way that Windows handles connected USB-serial ports, it is necessary to determine which COM ports that has been assigned when the Configuration ports on the DD500E have been connected to the Configuration laptop.

To determine COM port assignment, perform the following steps:

Determine COM port assignments

Step 1Step 2Step 3Step 4Step 5Step 6Step 7

Power on the DD500E (see Power) and make sure the Power and status indicator is constantly lit blue.
Connect the device to the Configuration laptop, using the two included USB serial cables (see Connecting cables for configuration).
Start two separate Command prompt windows on the Configuration laptop and change directory to where the dd500e_config.exe file is located.
Run the command dd500_config list-ports in one of the Command prompt windows. Available COM ports will be listed.
Test the COM port connections.
- Run the command dd500_config read COMX in the first Command prompt window, replacing COMX with the first COM port listed in step 4.
- Run the command dd500_config read COMY in the second Command prompt window, replacing COMY with the second COM port listed in step 4.
Reset the device using the Multi-function button, leaving the Command prompt windows as they are. When the device is restarted, a complete log of the boot process will be displayed in each of the Command prompt windows, as seen below. Differences between Upstream and Downstream can be noted.
The DD500E is now ready to receive a customized configuration. Proceed with Uploading configuration.

Uploading configuration

note

The following instruction assumes that a customized configuration has been created. See Editing configuration for further information.

To upload a configuration, perform the following steps:

Upload configuration

Step 1Step 2Step 3Step 4Step 5Step 6

Press the Multi-function button on the front panel of the DD500E to enter Configuration mode. Release the button after ~2 seconds.
Confirm that Configuration mode has been entered. The information can be seen in both Command prompt windows. It is also indicated by the Power and status indicator being lit solid green.
To free the COM ports for configuration upload, press Ctrl+C in both Command prompt windows to exit the running dd500e_config commands. Do not close the windows.
Run the command dd500e_config configure [config_file_name.toml] COMX COMY in either of the Command prompt windows, where:
- [config_file_name.toml] is replaced with the configuration file name used when created, see Editing configuration.
- COMX COMY are replaced with the COM ports found in Checking COM ports.
- COMX COMY* must be entered with a space.
When the configuration has been uploaded successfully, the device will automatically restart. Information, similar to the figure below, is displayed in the Command prompt window where the upload was started. Verify that network settings are as expected. To further verify the configuration upload, see Verifying configuration.
note
The configuration is uploaded to both sides of the device. No upload feedback is, however, displayed in the second Command prompt window.
Configuration upload has completed when Configuration successfully applied is displayed. The device is ready for operation.

Verifying configuration

To verify the configuration after upload, perform the following steps:

Verify configuration

Step 1Step 2

Step 1
Use the info command to retrieve configuration information from the DD500E. See Info for detailed instructions.
Step 2
Verify that the parameters in the displayed Configuration summary have the expected values.

Preparations​

Editing configuration​

Default settings​

Using Configuration Application​

Checking COM ports​

Uploading configuration​

Verifying configuration​