From 3058fde6c5388e43f02446a730c3c06284e4a200 Mon Sep 17 00:00:00 2001 From: Teppo Kurki Date: Fri, 26 Sep 2025 14:39:35 +0300 Subject: [PATCH] Remove outdated getting started docs A quick sweep of this document to remove outdated content and add links to documents that are in better shape. --- src/pages/installation.md | 106 ++------------------------------------ src/pages/overview.md | 3 +- 2 files changed, 6 insertions(+), 103 deletions(-) diff --git a/src/pages/installation.md b/src/pages/installation.md index fb74d9e2..415467a7 100644 --- a/src/pages/installation.md +++ b/src/pages/installation.md @@ -7,63 +7,6 @@ description: 'Follow these instructions to get started with Signal K. Please don help if you run in to trouble.' --- -## [Getting Started with Signal K](#) - -In this section we will look at different ways you can install and use Signal K on your boat. There are already a -number of hardware platforms and devices being used, and more are bound to follow, but we will concentrate on three -recommended starter packs that we will refer to as; Basic, Advanced and Expert. - -## ["Basic" Starter Pack](#) - -For boat owners that want to use Signal K with the minimum of effort, then the Basic Starter Pack gives you a simple -way to install Signal K on your boat and start using the free apps and services that are available. The pack consists -of a “Smart” Gateway that converts your existing NMEA data in to Signal K and installation just consists of wiring the -gateway to your NMEA0183 and/or NMEA2000 networks and plugging the gateway in to a wireless router. - -
- -
Basic Starter Pack
-
- -The most popular “smart gateway” is Digital Yacht’s -iKommunicate Gateway which has three NMEA 0183 and one NMEA 2000 -interfaces. It comes with some built-in Signal K web apps to get you started or you can copy other apps on to its 8GB -SD card. - -As your experience and confidence in Signal K grows, you can simply add a Signal K server to iKommunicate to make one -of the advanced or expert packs (see below). - -## ["Advanced" Starter Pack](#) - -For more technical minded boat owners that want to use the logging and cloud features of Signal K or who want to get -involved in the “cutting edge” Signal K developments, then one of the two Advanced packs below would be the best -starting point. For a larger, more powerful Signal K system, but where stability and reliability are key, then adding a -Signal K server to an iKommunicate is the way to go. - -
- -
Advanced Starter Pack 1
-
- -If you enjoy getting your hands dirty and want to experiment with the “cutting edge” features then a Signal K server -with raw NMEA data coming from USB adaptors and gateways would be the best solution, as shown in the diagram below. - -
- -
Advanced Starter Pack 2
-
- -## ["Expert" Starter Pack](#) - -For developers and seriously technical installations, then a larger network with multiple Signal K servers, Signal K -sensors, etc. is possible and will become more common in the future as more people discover Signal K and the new -functionality and benefits it can bring. - -
- -
Expert Starter Pack
-
- ## [Installing your Signal K server](#) A Signal K server, is basically a webserver with the ability to read marine data and create web pages and web apps that @@ -125,50 +68,9 @@ You should see NMEA 0183 sentences scrolling off the screen. To exit picocom pre ### NMEA 2000 Instruments -For NMEA 2000, there are less options. A quick search on Google will return a number of NMEA2000 to USB gateways, but -the interface device is just one half of the solution. The other equally important part is the software that can read -the data from the gateway and then convert it in to a format that the Signal K server understands. This software called -CANboat is a suite of tools that can read and write -NMEA 2000 data and convert it in to Signal K. - -Currently, CANboat supports the following NMEA 2000 to USB Gateways: - -- - iKonvert USB from Digital Yacht (NMEA Certified) - -- - NGT-1-USB from Actisense (NMEA Certified) - -- - YDNU-02 by Yacht Devices - - -and any CAN Interface that supports "SocketCAN" such as the -CANable board. - -Alternatively if you want to have a wireless NMEA 2000 gateway, CANboat supports these products: - -- - NavLink 2 from Digital Yacht (NMEA Certified) - -- - SeaSmart by Chetco (NMEA Certified) - -- - GoFree Wifi-1 by Simrad - -- - YDGW-02 by Yacht Devices - - -Or wired Ethernet version: - -- - YDEN-02 by Yacht Devices - - -CANBoat has recently been ported to JavaScript and is now part of the Signal K Node Server build, so no additional -installation of CANBoat is required. +See [How Do I Integrate with NMEA2000](https://github.com/SignalK/signalk-server/wiki/FAQ:-Frequently-Asked-Questions#how-do-i-integrate-with-nmea2000-can-bus) in the Signal K server FAQ. + + ### Proprietary Interfaces @@ -185,3 +87,5 @@ Even though Raymarine no longer make a SeaTalk 1 interface, there are a number o convert to NMEA 0183, which both of the Signal K servers can read, or convert to a raw $STALK format that allows more control and access to the SeaTalk data. One such interface that handles both types of SeaTalk conversions is the ST-NMEA interface from Digital Yacht. + +Signal K server also includes [Seatalk 1 support (a bit of DIY hardware required)](https://demo.signalk.org/documentation/Configuration/Seatalk_Connections.html). diff --git a/src/pages/overview.md b/src/pages/overview.md index 6f96ac56..a7ec9cda 100644 --- a/src/pages/overview.md +++ b/src/pages/overview.md @@ -129,8 +129,7 @@ NMEA networks onboard as well as databases, other Signal K data streams, and pot resources. The server can also hold static items like charts, routes and notes. It can also hold and act as a web-server for browser-based Apps. -The Signal K server is available as a ready-to-fit commercial product (such as the -[Digital Yacht iKommunicate](http://ikommunicate.com)), or you can download the software for free and run it yourself. +The Signal K server software is available as a free download. The software runs on a range of single board computers; Raspberry Pi, Beagle Board, etc. as well as any normal PC running Linux, Windows and MacOS, see the [Install page](./installation) for details.