Getting Started
On this page

System Requirements

RayNmeaSimulator runs on a desktop computer or an appropriately equipped Raspberry Pi. You can learn the workspace, edit instrument values, use local simulation and read this Help without marine hardware. A real NMEA connection is needed only when receiving from or transmitting to external equipment.

Choose a computer and matching application

PlatformWhat it means for the user
Windows 11 on a 64-bit PCUse the matching Windows application and its supplied runtime files
Ubuntu 26.04 on a 64-bit PCUse a matching Linux application and a working desktop session
Raspberry Pi 5, Debian 13, ARM64Use the matching ARM64 package, suitable power/storage and a working desktop

Choose the package for your operating system and processor. PC and ARM64 Raspberry Pi packages are not interchangeable. The Debian 12-compatible ARM64 package is supplied separately from the native ARM64 package. Follow its installation instructions and keep the supplied runtime files together. A macOS application package is not currently supplied.

A keyboard, pointing device and readable desktop display are recommended. Help images can be enlarged on small or high-DPI displays. Keep writable per-user storage for Layouts, Templates, themes and logs. No fixed minimum RAM, CPU speed or disk allowance has been established: the number of widgets, traffic rate and recording settings affect resource use. Start with a small workspace and bounded recording.

Choose hardware for the intended connection

ConnectionRequired equipment
CANable SLCANSupported SLCAN adapter/firmware, USB cable and proper CAN wiring. Use firmware compatible with the SLCAN protocol.
Waveshare USB-CAN-AThe supported USB-CAN-A serial adapter and correct cable wiring. Use the USB-CAN-A protocol and serial settings described in its connection topic.
Native SocketCANA supported Linux CAN controller/HAT and an already configured healthy CAN interface. Configure the controller and CAN interface in Linux before connecting.
Network NMEA2000A reachable compatible RayNetworkBridge host with a configured CAN interface, trusted network connection and the required authorization. The bridge and client must use compatible configuration.
Actisense NGT-1A supported Actisense connection for RX. Release TX is disabled; Debug ordinary TX is experimental, and active chartplotter route service is excluded.
NMEA0183A serial interface with the electrical levels, wiring and baud rate required by the connected equipment; a generic USB port name alone does not establish compatibility.

Use a properly powered NMEA2000 backbone with appropriate termination and connections. NMEA2000 operates at 250000 bit/s on CAN; a serial adapter's USB/serial baud setting is a different layer. Follow the adapter's wiring documentation. A USB cable, a serial cable and a CAN backbone cable are not substitutes for one another.

Check operating-system device access before connecting. Linux serial ports may require the appropriate device/group permission and a renewed login after access changes. Close competing applications if a port is busy. The simulator does not install drivers, repair USB permissions, configure a CAN HAT or bring a Linux CAN interface up for you.

Optional equipment and services

  • A compatible game controller and the existing mappings are needed only for Game Pad movement.
  • Weather retrieval needs a network connection, a selected provider and provider credentials where required. Manual weather values and other local simulation do not require a provider.
  • Signal K publication needs a reachable compatible server and its access approval; it is not a substitute for raw CAN hardware.
  • External marine instruments or a chartplotter are needed to evaluate actual receiver behavior. Check the receiving application or instrument to confirm that it receives the intended data.

Check the intended connection

Choose an interface that supports the operation you need. Instrument RX/TX and chartplotter route retrieval use different controls. For chartplotter retrieval, follow Selecting Chartplotter Routes and check that the target provides the required service.

Viewer does not authorize instrument Sending. Normal CAN controllers may still acknowledge frames or signal bus errors while receiving. Use explicit Enable Sending only for the intended test; bounded route requests require their own authorization.

Introduction · Installation and First Launch · Viewer vs Generate · Quick Start · Loading the Default Layout · Connection Troubleshooting · Enable, Dispatch and Sending · Route Overview · Engineering Units

Help Home · Back to top

Image