Skip to content

README.md

Latest commit

 

History

History
160 lines (121 loc) · 7.07 KB

README.md

File metadata and controls

160 lines (121 loc) · 7.07 KB
Raw

Logo

ioBroker.nmea

This adapter allows connecting ioBroker to NMEA-2000 yacht bus.

This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers. For more details and for information how to disable the error reporting, see Sentry-Plugin Documentation! Sentry reporting is used starting with js-controller 3.0.

To use this adapter, you need a hardware that can read NMEA-2000 bus and convert it to the serial port:

PiCAN-M could work with Raspberry 4 and 5.

Widgets

YouTube explanation

How to use it on Raspberry PI with PiCAN-M

The PiCAN M is a compact add-on board designed for the Raspberry Pi 3/4. It enables the connection of both NMEA2000 and NMEA0183 networks to a Raspberry Pi. The board can be powered through an external 12V source. Additionally, it offers the option to power the Raspberry Pi directly via the NMEA2000 bus when used with the PiCAN-M board.

The PiCAN-M lacks appropriate protection against reverse polarity for the 12V supply voltage. When operated externally at 12V, it is necessary to include a 1A fuse in the power supply line.

Because of the high requirements of Raspberry Pi to power supply, we suggest powering the Raspberry PI from the external power source (at least 3A). Power over NMEA2000 and over USB could function in parallel without a problem.

Installation

See chapter 3 in PiCAN-M User Guide for more details, but here is a short summary:

Edit file /boot/config.txt (with sudo nano /boot/config.txt) and add the following lines to the end of the file:

enable_uart=1
dtparam=i2c_arm=on
dtparam=spi=on
dtoverlay=mcp2515-can0,oscillator=16000000,interrupt=25

Disable outputs on the UART console:

  • start in CLI sudo raspi-config
  • go to 3 Interface Options
  • go ot I5 Serial Port
  • Disable shell accessible over serial and serial port hardware enabled
  • Exit from raspi-config and reboot

Install can-utils

sudo apt-get install can-utils

Actisense NGT-1

Actisense NGT-1 is visible on Windows or Linux without any additional drivers. It is visible as a serial port 'COMn' (Windows) or ttyN(on linux).

YDEN, YDWG

Enable server N2 with TCP protocol and bidirectional mode.

YDWG

UDP could work too, but the gateway sends the data into the network continuously, so the bus could be overloaded.

Todo

Data simulation

You can feed the data from external sensors to the NMEA2000 bus. Actually, you can only simulate environmental data, like temperature, humidity, pressure.

With the flag Combined environment you can define the PGN number which will be used for temperature, humidity and pressure:

  • If you unselect the flag Combined environment, so for the temperature will be used PGN 130314, for humidity PGN 130313 and for pressure PGN 130314.
  • If you select the flag Combined environment, so all three values will be sent in PGN 130311 together with other possible environmental values.

Time zone

There is a possibility to set the time zone from GPS coordinates. For this the according option must be enabled in the adapter settings and allowed for iobroker user the command execution: sudo visudo

iobroker ALL=(ALL) timedatectl set-timezone

Autopilot

Actually, only one autopilot is supported: Raymarine

The development of Simrad/navico/B&G is not completed yet.

Wind datum display

For Raymarine units that publish the "Pilot Wind Datum" (PGN 65345), the adapter stores the raw angle in radians under seatalkPilotWindDatum.windDatum (this is the canonical value the autopilot reads back when you change the wind angle, so it must stay in radians).

In addition, a read-only convenience state seatalkPilotWindDatum.windDatumDisplay is created. It shows the angle exactly the way the Raymarine pilot head does:

  • 0…180° → starboard, 180…360° → port,
  • each as a ≤180° value plus a language-dependent side letter (e.g. a datum of 230° is shown as 130°P in English and 130°B in German). 0° (dead ahead) and 180° (dead astern) carry no side letter.

Use windDatumDisplay for visualization and windDatum for calculations/automation.

Changelog

WORK IN PROGRESS

  • (@GermanBluefox) Migrated widgets to React 19

2.0.0 (2026-08-04)

  • (bluefox) Migrated to devices V3

1.0.3 (2026-07-08)

  • (bluefox) Better decoding of motor PGNs

1.0.2 (2026-06-30)

  • (copilot) Adapter requires node.js >= 22 now
  • (bluefox) Added seatalkPilotWindDatum.windDatumDisplay state with the Raymarine-style port/starboard wind-angle display
  • (bluefox) The autopilot device-manager widget now shows the wind datum the Raymarine way (e.g. 130°P) with a language-dependent port/starboard letter
  • (bluefox) Added the custom icon set

1.0.1 (2026-06-26)

  • (bluefox) Implemented Raymarine autopilot support
  • (bluefox) Corrected values simulation for yacht devices gateways
  • (bluefox) Added support of Fusion player

0.4.2 (2026-01-05)

  • (bluefox) Updated packages

Older changelogs can be found there

License

The MIT License (MIT)

Copyright (c) 2024-2026 bluefox dogafox@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.