keesverruijt / mayara Goto Github PK

Welcome to Marine Yacht Radar server.

This project will play as intermediary between marine yacht radars such as Navico's HALO series, Garmin, Raymarine, etc, and modern client side tools acting as chartplotter or MFD. Intended use is for applications such as Freeboard SK, OpenCPN, AvNav. Note: no implication that this software will actually be available in any of the mentioned software packages is made!

On the "client" side, it will offer a Signal K API for basic information and a WebSocket server for the actual radar data. Changing the radar settings is possible, a JSON Schema explains what settings can be made.

This is basically a rewrite of the OpenCPN radar plugin that I have worked over ten years or so. The problem with that code is that it is written in C++ with wxWidgets, and very much meant to operate as a plugin to OpenCPN. That makes it hard to graft on an extra layer that allows it to be used in other contexts.

The code shall:

• Be able to run independently, and provide a simple API for clients to use. This shall be 'friendly' to web based software.
• As far as possible, detect all radars automatically without any configuration; in the radar_pi plugin you had to set which brand/type of radar is installed.
• Make it as simple as possible to add more radars. Our experience with radar_pi tells us that there are hardly any folks out there cruising with the right skillset to make this happen.
• Be robust and error-free. Again, C++ allows you to be doing stuff illegally and for many years we had race conditions and other bugs in radar_pi. Writing the new server in Rust will hopefully make this an easy thing to do.

At the moment I intend to support the following radars:

• First level (functionally complete including all settings) support for Navico 3G, 4G and HALO radars.
• Best effort support for Navico BR24 (we no longer have access to one.)
• Second level (operational support, maybe not all features) for Garmin xHD and hopefully something modern.
• Second level (operational support, maybe not all features) for Raymarine E series and Quantum series.

See TODO

We're on Discord, here is an invite: Discord channel