Skip to content

Commit c94a549

Browse files
committed
add signal k installer
1 parent 66be9bc commit c94a549

13 files changed

+83
-5
lines changed

docs/network/network_app.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Network
22

3-
We have kept this chapter for historical reasons. The *OpenPlotter Network* application present in earlier versions of OpenPlotter has been removed since *Raspberry Pi OS* added the *Network Manager* program and now almost all *OpenPlotter Network* functions can be done there. Some other functions have been moved to the *OpenPlotter Settings* app.
3+
We have kept this chapter for historical reasons. The *OpenPlotter Network* application present in earlier versions of OpenPlotter has been removed since *Raspberry Pi OS* added the *Network Manager* program and now almost all *OpenPlotter Network* functions can be done there. Some other functions have been moved to the ![Settings](../settings/img/openplotter-settings.png) *Settings* app.
44

5-
Now, to turn the Raspberry Pi internal WiFi device into an access point and a client simultaneously, you need to go to the `Raspberry Settings` tab of the *OpenPlotter Settings* app and click on ![Hotspot+Client](../settings/img/ap.png) `Hotspot+Client`.
5+
Now, to turn the Raspberry Pi internal WiFi device into an access point and a client simultaneously, you need to go to the `Raspberry Settings` tab of the ![Settings](../settings/img/openplotter-settings.png) *Settings* app and click on ![Hotspot+Client](../settings/img/ap.png) `Hotspot+Client`.
66

77
![Hotspot+Client](img/network1.png)
88

99
To find out what IPs, addresses and ports the OpenPlotter apps use, click on ![Network](../settings/img/ports.png) `Network`.
1010

1111
![network](img/network2.png)
1212

13-
The rest of the operations such as connecting as clients to access points, creating more access points, connecting to VPN... are now carried out with the *Network Manager* program and are accessed by clicking on the icon ![WiFi](img/wifi.png)
13+
The rest of the operations such as connecting as clients to access points, creating dedicated access points, connecting to VPN... are now carried out with the *Network Manager* program and are accessed by clicking on the icon ![WiFi](img/wifi.png)
1414

1515
![network](../getting_started/img/network.png)

docs/settings/raspberry.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,20 @@ If you have the ![Notifications](../notifications/img/notifications.png) *Notifi
2222

2323
![Backlight Action](img/backlightAction.png)
2424

25+
## ![](img/wayland.png) Wayland
26+
27+
The latest version of *Raspberry OS* contains the Wayland graphical server by default, but some programs and system tools still do not work correctly in this graphical environment. OpenPlotter still uses the old X11 graphic environment by default to ensure that all programs work correctly until Wayland is mature enough.
28+
29+
You can switch between graphical environments by clicking the ![Wayland](img/wayland.png) `Wayland` button.
30+
31+
32+
## ![](img/ap.png) Hotspot+Client
33+
34+
To turn the Raspberry Pi internal WiFi device into an access point and a client simultaneously, just click on ![Hotspot+Client](img/ap.png) `Hotspot+Client`.
35+
36+
!!! note
37+
Go to the [Network](../network/network_app.md) chapter to learn how to connect OpenPlotter to the Internet and how network management has changed since the last version.
38+
2539
## ![](img/shutdown.png) Shutdown
2640

2741
You can use any GPIO on the Raspberry to set a shutdown botton. Click ![GPIO](img/chip.png) ``GPIO`` to choose a GPIO, usually GPIO 21 at pin 40. Select a GPIO ``Transition`` to trigger the shutdown, *high->low* or *low->high*. Select an internal pull resistor, *pull-up* and *pull-down*, or *off* if you use an external pull resistor. Click ![Apply](img/apply.png) ``Apply`` to save settings and changes will be applied after the next reboot.

docs/settings/settings_app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Settings
22

3-
To run this app, click ![Settings](img/openplotter-settings.png) `Settings` in `Main -> OpenPlotter` or type this in a terminal:
3+
To run this app, click ![Settings](img/openplotter-settings.png) `Settings` under `Main -> OpenPlotter` or type this in a terminal:
44

55
```console
66
openplotter-settings

docs/signalk/img/apply.png

588 Bytes
Loading

docs/signalk/img/cancel.png

817 Bytes
Loading

docs/signalk/img/settings2.png

887 Bytes
Loading

docs/signalk/img/ship.png

1.18 KB
Loading

docs/signalk/img/signalk1.png

37.6 KB
Loading

docs/signalk/img/signalk2.png

50 KB
Loading

docs/signalk/img/signalk3.png

49.2 KB
Loading

docs/signalk/img/signalk4.png

212 KB
Loading

docs/signalk/img/skinstaller.png

907 Bytes
Loading

docs/signalk/signalk_app.md

Lines changed: 65 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,67 @@
11
# Signal K Installer
22

3-
Coming soon.
3+
Install this app from the ![Settings](../settings/img/openplotter-settings.png) *Settings* app and open it by clicking ![Signal K Installer](img/skinstaller.png) `Signal K Installer` under `Main -> OpenPlotter` or typing this in a terminal:
4+
5+
```console
6+
openplotter-signalk-installer
7+
```
8+
9+
![signalk1](img/signalk1.png)
10+
11+
![Help](../settings/img/help.png) ``Help`` opens an offline copy of this documentation in a browser and ![Settings](../settings/img/openplotter-settings.png) ``Settings`` opens the main app.
12+
13+
## ![](img/skinstaller.png) Reinstall Signal K
14+
15+
After installing the ![Signal K Installer](img/skinstaller.png) *Signal K Installer* app, the Signal K server should be also installed and you do not have to do anything else to start using it. We add this option in case you need to reinstall the server from scratch if it ever becomes unstable.
16+
17+
!!! caution
18+
Reinstalling the signal K server will remove the current plugins, login credentials and settings.
19+
20+
## ![](img/settings2.png) Settings
21+
22+
![Signal K Installer](img/skinstaller.png) *Signal K Installer* app installs the server using port 3000 by default. To access the web administration panel of the Signal K server, you can use this URL from the browser included in OpenPlotter:
23+
24+
```console
25+
http://localhost:3000
26+
```
27+
28+
Or this one from a browser running on any computer connected to the same network:
29+
30+
```console
31+
http://openplotter.local:3000
32+
```
33+
34+
If you set the port 80 instead the default port 3000, the URLs would be:
35+
36+
```console
37+
http://localhost
38+
http://openplotter.local
39+
```
40+
41+
You can change the port or enable SSL at any time without losing your current settings. Use ![Apply](img/apply.png) ``Apply`` to save changes or ![Cancel](img/cancel.png) ``Cancel`` to reload current settings.
42+
43+
Click ![Vessel Data](img/ship.png) ``Vessel Data`` to set some important data of your boat like name, MMSI, call sign, draft ... You need to login to access this section of the web administration panel.
44+
45+
## Logging in
46+
47+
When you first enter the Signal K web administration panel, it will ask you for a *name* and *password* to create an administrator account:
48+
49+
![signalk2](img/signalk2.png)
50+
51+
Once you do that you will be offered the login page:
52+
53+
![signalk3](img/signalk3.png)
54+
55+
You can add/delete users and change passwords under `Signal K administrator -> Security -> Users`.
56+
57+
## More info
58+
59+
To know how data is managed in OpenPlotter you should read the chapter [How does it work?](../description/how_does_it_work.md) in the *Description* section.
60+
61+
On the official [Signal K site](https://signalk.org/) you will find a lot of valuable information.
62+
63+
In recent versions of the Signal K server, documentation has been introduced in `Signal K administrator -> documentation`
64+
65+
There are more than [270 plugins](https://www.npmjs.com/search?q=signalk-node-server-plugin) and more than [60 apps](https://www.npmjs.com/search?q=signalk-webapp) to extend the Signal K server features. Go to `Signal K administrator -> Appstore`. to install them:
66+
67+
![signalk4](img/signalk4.png)

0 commit comments

Comments
 (0)