Skip to content

Commit 4963070

Browse files
authored
Remove outdated getting started docs (#130)
A quick sweep of this document to remove outdated content and add links to documents that are in better shape.
1 parent 7738e52 commit 4963070

File tree

2 files changed

+6
-103
lines changed

2 files changed

+6
-103
lines changed

src/pages/installation.md

Lines changed: 5 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -7,63 +7,6 @@ description: 'Follow these instructions to get started with Signal K. Please don
77
help if you run in to trouble.'
88
---
99

10-
## [Getting Started with Signal K](#) <a class="anchor" id="started"></a>
11-
12-
In this section we will look at different ways you can install and use Signal K on your boat. There are already a
13-
number of hardware platforms and devices being used, and more are bound to follow, but we will concentrate on three
14-
recommended starter packs that we will refer to as; Basic, Advanced and Expert.
15-
16-
## ["Basic" Starter Pack](#) <a class="anchor" id="basic"></a>
17-
18-
For boat owners that want to use Signal K with the minimum of effort, then the Basic Starter Pack gives you a simple
19-
way to install Signal K on your boat and start using the free apps and services that are available. The pack consists
20-
of a “Smart” Gateway that converts your existing NMEA data in to Signal K and installation just consists of wiring the
21-
gateway to your NMEA0183 and/or NMEA2000 networks and plugging the gateway in to a wireless router.
22-
23-
<figure>
24-
<img src="../assets/images/diagrams/SK_Smart_Gateway.png" width="400">
25-
<figcaption>Basic Starter Pack</figcaption>
26-
</figure>
27-
28-
The most popular “smart gateway” is Digital Yacht’s
29-
<a href="http://ikommunicate.com" target="_blank">iKommunicate Gateway</a> which has three NMEA 0183 and one NMEA 2000
30-
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
31-
SD card.
32-
33-
As your experience and confidence in Signal K grows, you can simply add a Signal K server to iKommunicate to make one
34-
of the advanced or expert packs (see below).
35-
36-
## ["Advanced" Starter Pack](#) <a class="anchor" id="advanced"></a>
37-
38-
For more technical minded boat owners that want to use the logging and cloud features of Signal K or who want to get
39-
involved in the “cutting edge” Signal K developments, then one of the two Advanced packs below would be the best
40-
starting point. For a larger, more powerful Signal K system, but where stability and reliability are key, then adding a
41-
Signal K server to an iKommunicate is the way to go.
42-
43-
<figure>
44-
<img src="../assets/images/diagrams/SK_Server+Gateway.png" width="400">
45-
<figcaption>Advanced Starter Pack 1</figcaption>
46-
</figure>
47-
48-
If you enjoy getting your hands dirty and want to experiment with the “cutting edge” features then a Signal K server
49-
with raw NMEA data coming from USB adaptors and gateways would be the best solution, as shown in the diagram below.
50-
51-
<figure>
52-
<img src="../assets/images/diagrams/Signal_K_Server_Diagram.png" width="400">
53-
<figcaption>Advanced Starter Pack 2</figcaption>
54-
</figure>
55-
56-
## ["Expert" Starter Pack](#) <a class="anchor" id="expert"></a>
57-
58-
For developers and seriously technical installations, then a larger network with multiple Signal K servers, Signal K
59-
sensors, etc. is possible and will become more common in the future as more people discover Signal K and the new
60-
functionality and benefits it can bring.
61-
62-
<figure>
63-
<img src="../assets/images/diagrams/SK_Multiple_Servers+Gateway.png" width="400">
64-
<figcaption>Expert Starter Pack</figcaption>
65-
</figure>
66-
6710
## [Installing your Signal K server](#) <a class="anchor" id="server"></a>
6811

6912
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
12568

12669
### NMEA 2000 Instruments
12770

128-
For NMEA 2000, there are less options. A quick search on Google will return a number of NMEA2000 to USB gateways, but
129-
the interface device is just one half of the solution. The other equally important part is the software that can read
130-
the data from the gateway and then convert it in to a format that the Signal K server understands. This software called
131-
<a href="https://github.com/canboat/canboatjs" target="_blank">CANboat</a> is a suite of tools that can read and write
132-
NMEA 2000 data and convert it in to Signal K.
133-
134-
Currently, CANboat supports the following NMEA 2000 to USB Gateways:
135-
136-
- <a href="https://digitalyacht.co.uk/product/ikonvert-nmea-2000-to-usb/" target="_blank">
137-
iKonvert USB from Digital Yacht (NMEA Certified)
138-
</a>
139-
- <a href="http://www.actisense.com/product/nmea-2000-to-pc-interface-ngt-1/" target="_blank">
140-
NGT-1-USB from Actisense (NMEA Certified)
141-
</a>
142-
- <a href="https://www.yachtd.com/purchase/" target="_blank">
143-
YDNU-02 by Yacht Devices
144-
</a>
145-
146-
and any CAN Interface that supports "SocketCAN" such as the
147-
<a href="http://canable.io/" target="_blank">CANable board</a>.
148-
149-
Alternatively if you want to have a wireless NMEA 2000 gateway, CANboat supports these products:
150-
151-
- <a href="https://digitalyacht.co.uk/product/navlink2/" target="_blank">
152-
NavLink 2 from Digital Yacht (NMEA Certified)
153-
</a>
154-
- <a href="https://digitalmarinegauges.com/seasmart-network-gateways/" target="_blank">
155-
SeaSmart by Chetco (NMEA Certified)
156-
</a>
157-
- <a href="https://www.simrad-yachting.com/simrad/type/accessories/cables-connectors/gofree-wifi1-wireless-module/" target="_blank">
158-
GoFree Wifi-1 by Simrad
159-
</a>
160-
- <a href="https://www.yachtd.com/purchase/" target="_blank">
161-
YDGW-02 by Yacht Devices
162-
</a>
163-
164-
Or wired Ethernet version:
165-
166-
- <a href="https://www.yachtd.com/purchase/" target="_blank">
167-
YDEN-02 by Yacht Devices
168-
</a>
169-
170-
CANBoat has recently been ported to JavaScript and is now part of the Signal K Node Server build, so no additional
171-
installation of CANBoat is required.
71+
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.
72+
73+
17274

17375
### Proprietary Interfaces
17476

@@ -185,3 +87,5 @@ Even though Raymarine no longer make a SeaTalk 1 interface, there are a number o
18587
convert to NMEA 0183, which both of the Signal K servers can read, or convert to a raw $STALK format that allows more
18688
control and access to the SeaTalk data. One such interface that handles both types of SeaTalk conversions is the
18789
<a href="http://digitalyacht.co.uk/product/st-nmea-usb/" target="_blank">ST-NMEA interface</a> from Digital Yacht.
90+
91+
Signal K server also includes [Seatalk 1 support (a bit of DIY hardware required)](https://demo.signalk.org/documentation/Configuration/Seatalk_Connections.html).

src/pages/overview.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,7 @@ NMEA networks onboard as well as databases, other Signal K data streams, and pot
129129
resources. The server can also hold static items like charts, routes and notes. It can also hold and act as a
130130
web-server for browser-based Apps.
131131

132-
The Signal K server is available as a ready-to-fit commercial product (such as the
133-
[Digital Yacht iKommunicate](http://ikommunicate.com)), or you can download the software for free and run it yourself.
132+
The Signal K server software is available as a free download.
134133
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
135134
[Install page](./installation) for details.
136135

0 commit comments

Comments
 (0)