UDPTERM user manual   Version May 2011

Download "UDPTERM.ZIP". UDPTERM is provided 'as is' -- without any warranty.

UDPTERM is provided in 2 different default configurations. Both versions have the same features, except different default IP and port settings. By user cofiguration, each version can be transformed into the other one.

When you start UDPTERM, first the actually selected IP address of the desired UDP communication partner, the default send(destination) port and the default receive(source) port number of this communication is displayed.

UDTMERM_STD comes preconfigured as follows: the default IP is 192.168.0.240, the default send port as well as the default receive port number is 65535 in correspondence with the default settings of Cinetix Ethernet products delivered before May 2011.

UDTMERM_MCAST comes preconfigured as follows: the default IP is 225.0.0.37, the default send port as well as the default receive port number is 21928 in correspondence with the default settings of Cinetix Ethernet products delivered from May 2011 on. This multicast IP provides easier configuration of the Ethernet/DMX devices without temporary reconfiguration of your network. Furthermore it is in line with the ipMIDI driver MIDI to Ethernet, which makes use of Cinetix products easy together with MIDI sequencers etc.

If you have stored a preset before, the IP and port numbers will be taken from there.

At any time you can make a new selection with <CTRL-D>.
You will be asked then to enter the IP address of the desired UDP communication partner in the standard ASCII style as 4 decimal numbers separated by dots. Next you will be asked to enter the send(destination) port number of the communication as a decimal number in the range 1 to 65535. Finally you will be asked to enter the receive(source) port number of the communication as a decimal number in the range 1 to 65535. If latter one is prompted simply by <enter>, the send port number is copied to the receive port number.
Bear in mind, that the send(destination) port of UDPTERM must be set equal to the receive(source) port of the Ethernet device and vice versa !

The default mode of typing/displayis "ASCII text". Alternatively you can select typing style and/or display style as pure hex data. You can change your mode of typing/display at any time with <CTRL-Q,W,E,R>.

To avoid this work of selection any time you restart UDPTERM, you can save your selections as a preset with <CTRL-P>. Then the file UDPTERM.SET is created (or overwritten, if already existing) in the same directory where UDPTERM is installed.
If you ever will install a new version of UDPTERM, the file UDPTERM.SET should be deleted before.

Exit UDPTERM: press the <ESC> key or type CTRL-X. You will be asked if you really want to exit. Confirm with <ENTER>, cancel with any other button.

screenshot

How to send ASCII text:

If you have selected command input as ASCII text (default=<CTRL-Q> or <CTRL-W>) then your input from the PC keyboard is sent as a permanent stream of UDP packets. Because you type much slower than Ethernet transmits, most of these packets will contain a single character.

How to receive and display UDP packets as ASCII text:

If you have selected message display as ASCII text (<CTRL-Q> or <CTRL-E>) then UDP packets from the addressed "server" are displayed on the PC monitor as a permanent ASCII text stream. "Nonprintable" characters may be displayed as small graphical symbols.

How to send raw bytes through UDP:

If you have selected command input as raw hex bytes (<CTRL-W> or <CTRL-R>) then a single UDP byte is entered as follows and transmitted immediately:

first enter the high nibble as a hex digit 0,1,2,3,4,5,6,7,8,9,A,B,C,D,E,F. Letter input is case insensitive. Next enter the low nibble the same style. Terminate input with a <SPACE>, <COMMA> or <ENTER>. If the high nibble is = 0, then only the low nibble has to be entered and terminated as described before.

Example: send a NOTE ON message on MIDI channel #3 with chamber pitch 'a' and standard velocity (dec64 = hex40): type as text  92<SPACE>45<SPACE>40<SPACE>. Every byte is transmitted immediately after termination.

How to receive and display raw UDP bytes:

If you have selected display as raw hex bytes (<CTRL-E> or <CTRL-R>) then received UDP bytes is are displayed as a permanent ASCII text stream of hex bytes.

Backup of Ethernet/DMX device memory:

UDPTERM is helpful to save the complete nonvolatile memory (user configuration and presets) of Cinetix devices with Ethernet interface by means of the XMODEM CRC transfer protocol. This feature is only available at devices delivered from May 2011 on.

Download the complete nonvolatile memory: type CTRL-G. This automatically triggers the download. Progress is signalled by a series of dots printed on the console screen. The downloaded content is stored in a binary file named XMODEM.BAK in the same directory where UDPTERM is installed. Any existing file with this name is overwritten without warning, so be careful to rename older backup files.

Upload the backup file XMODEM.BAK: type CTRL-U. This automatically triggers the upload. Progress is signalled by a series of dots printed on the console screen. Only files downloaded from the same device type with compatible firmware version can be uploaded. Incompatible backup files are refused.

This backup mechanism uses the ASCII commands {, ( and ) as described in the device manual. Direct use of these commands from a terminal does not work because the XMODEM protocol demands some special handshake which cannot be provided by manual operation.


* State of information September 2012. Right of modifications reserved.
* This description is for information only, without any warranty. No product specifications are assured in juridical sense.
* Trademarks and product names cited in this text are property of their respective owners.