TCP proxy forwarding ASCII messages to an NMEA concentrator
Install Python3.5 from https://www.python.org/ftp/python/3.5.1/python-3.5.1-amd64.exe.
(make sure you get the 64 bits installer on a 64bits install).
Ensure you have "Add to System path" checked in the installer.
Download the zipped Python code at https://github.com/ksamuel/nmea_converter_proxy/archive/master.zip.
Unzip nmea_converter_proxy.zip. Hold Ctrl and right click on the directory icon to open a new terminal windows inside the directory.
Type:
python -m pip install . # add --upgrade in case you already have an install
python -m nmea_converter_proxy initFollow the instructions.
Open a new terminal windows and type:
python -m nmea_converter_proxy run "c:\path\to\your\config\file.ini"Config file format:
[optiplex]
ip = IPV4 address we will use to connect to the optiplex
port = port we will use to connect to the optiplex
[aanderaa]
ip = IPV4 address we will use to connect to the aanderaa
port = port we will use to connect to the aanderaa
magnetic_declination = magnetic declination at the sensor location
# Line starting with # is a comment. It does nothing but helps to document
# your configuration.
[concentrator]
ip = IPV4 address where the concentrator is going to listen for clients
port = port the where the concentrator is going to listen for clients
# You can have as many "sensor:" sections as you want. All messages
# retrieved from these will be forwarded as is by the concentrator.
[sensor:an abitrary sensor name]
ip = IPV4 address we will use to connect to this sensor
port = port we will use to connect to this sensor
[sensor:another sensor]
ip = IPV4 address we will use to connect to this sensor
port = port we will use to connect to this sensorExample:
[optiplex]
ip = 45.32.00.17
port = 8502
[aanderaa]
ip = 45.32.00.17
port = 8501
magnetic_declination = -0.5
[concentrator]
ip = 89.32.00.1
port = 1245
[sensor:bay1]
ip = 45.32.00.17
port = 8502
# Sensor disabled for maintenance.
#[sensor:bay2]
#ip = 45.32.00.17
#port = 8500Water flow sentence:
$VWVDR,<true degrees>,T,<magnetic degrees>,M,<speed in knots>,N*<checksum>\r\nE.G:
$VWVDR,318.0,T,318.5,M,34.0,N*A\r\nTemperature sentence:
$VWMTW,<celsius degrees>,C*<checksum>\r\nE.G:
$VWMTW,17.1,C*15\r\nWater depth variation sentence:
$VWDPT,<meter>,<empty field>,*<checksum>\r\nE.G:
$VWDPT,5.4,,*42\r\n
$VWDPT,-1.0,,*6F\r\nPressure sentence:
b"!PPRE,<pascals>,P*<checksum>\r\n"E.G:
!PPRE,102400.0,P*5E\r\nNote that, because I couldn't find a suitable message to send pressure, I had to use NEMA hability to define a proprietary format with "!".
Find out more about log by doing:
python -m nmea_converter_proxy logYou can get help on the command line tool by typing:
python -m nmea_converter_proxy --helpOr:
python -m nmea_converter_proxy [command] --helpIf you can't run the command "python", make sure you have the directory containing Python added to your system path.
If you have several versions of Python installed at the same time, you can run a one in particular by doing:
C:\direct\path\to\python.exe nmea_converter_proxy [command]Activate more verbosity by activating the debug mode:
python -m nmea_converter_proxy --debug [command]Install in editable mode:
python -m pip install -e .[dev]Run a fake concentrator:
python -m nmea_converter_proxy fakeconcentratorStyle Guide:
- Python: PEP8 (https://www.python.org/dev/peps/pep-0008/)
- JS: Google (http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml)
Deactivate dev mode:
python setup.py develop --uninstallRunning all tests:
python setup.py testInstall and run tox to check coverage and unit test at once:
python -m pip install tox
python -m toxIn a terminal:
python -m pip uninstall nmea_converter_proxy