Eye4Software Hydromagic

  Hydrographic Survey Software

Download free demo version

Hydromagic ASCII output plugin

The Hydromagic ASCII output plugin allows you to send ASCII formatted data to a third party application using a serial port, TCP or UDP connection. You can define the data messages by yourself, by including placeholders that will be replaced with the actual position, depth, motion, tide data or more.

Loading the ASCII output plugin

To load this plugin, open the preferences window by selecting "Preferences..." from the "Options" menu. In the window that appears, select the "Devices" tab. Next click the "Add..." button.

the devices tab in the preferences dialog
Click the "Add..." button to load a new plugin.

A list of available plugins will be displayed. From this list, select the "ASCII Output Plugin for Hydromagic" and click "OK" to load and display the plugin's configuration window.

select the Hydromagic ASCII output plugin
Select "ASCII output plugin for Hydromagic" from the list and click "OK".

Configuring the communication settings

This plugin can send data over a serial port or an Ethernet or WiFi connection using TCP or UDP. Please note that when sending data over a serial port to another computer, you will need a so called "null-modem" cable (crossed rxd/txd wire pairs). For TCP and UDP you can use a WiFi access point or an Ethernet switch.

When the data has to be send to another computer using TCP or UDP, make sure you enter the host IP address of the target computer. Use the 'connection type' drop down box to switch between serial port and TCP/IP communication.

Configuring the communication settings
Configure the serial or TCP/IP communication settings.

Configuring the output string

After setting how the data will be send, you need to define the string that will be sent each time the interval timer expires. To do so, click the 'Define Output Format...' button. The example above sends out the current timestamp followed by the x, y and z coordinate.

Configuring the ASCII output format
You can define the generated output string by using placeholders and custom text.

The output string is configured by adding placeholders separated with separators such as a comma, semi column, pipe symbol etc.. To add a placeholder, simply click the "Add Placeholder" button. A selection dialog will be displayed which can be used to pick one.

Select a placeholder for the output string
Select one of the placeholders from the list.

Please note, that you have to add the separator characters by yourself. When you want to separate the fields by tabs, please use the "Add Tab" button. When you completed adding all the required fields, please do not forget to terminate your string by adding a line-feed or carriage return. You can use the "Add Line Feed" or "Add Carriage Return" buttons to do so.

Testing the configuration

To test the configuration as well as the resulting output data, go back to the list of plugins and select the "ASCII Output Plugin for Hydromagic" plugin. Next, click the "Monitor" button to have a look at the outgoing data. When there is no output data, or when there is a red exclamation icon in front of the plugin name, please consult the real-time activity view for more information on the problem.

Use the communications monitor to check the output format
Click "Monitor..." to launch the "Communications Monitor".

In the real-time communications monitor you can see at which interval the data is send as well as the content of the output data:

The outgoing data in the real-time communications monitor
Use the "Communications Monitor" to test the configuration.

Unloading the Hydromagic ASCII output plugin

To unload the generic echo sounder plugin, open the preferences window by selecting "Preferences..." from the "Options" menu. In the window that appears, select the "Devices" tab. Next select the "ASCII Output Plugin for Hydromagic" and click the "Remove..." button.

Unload the ASCII Output plugin
Plugins can be unloaded using the "Remove" button.