To run this app type this in a terminal:
This is the main OpenPlotter app. You need it to install the rest of the apps. If you are using any of the OpenPlotter images for Raspberry Pi, the sources for the repositories where the OpenPlotter apps live will be installed and working, but if you are installing OpenPlotter from scratch you will see something like this:
To install the sources, click
Add sources and then click
Get Candidates. You will see the result of each process in the output tab. After adding the sources you are ready to install the rest of the apps:
This button will be disabled until you install the Documentation app. After installation, the button will be enabled and clicking on it will open an offline copy of this documentation in a browser.
This button should always be checked.
Allows self-diagnosis at startup of all OpenPlotter apps and some important settings. It will also trigger some programs and tools configured to run at startup.
By clicking this button, you can run the self-diagnosis at any time. Each OpenPlotter app installed will add new processes to diagnose its operation. If something does not work as expected, a red message will show the problem and the solution:
This process runs automatically at startup and it is also the time when some important internal OpenPlotter processes are started. OpenPlotter is highly configurable and some parameters can produce unexpected effects such as data loops, unstable or even unusable systems. By clicking
Rescue you can prevent these processes from starting in order to modify the settings and recover the system.
OpenPlotter apps versions consist of 3 digits separated by periods (a.b.c), a code name and a development state:
|a:||This is the OpenPlotter version the app belongs. This value will change only when a new Debian version is released.|
|b:||This value will change when major updates like new features have been added.|
|c:||This value will change when minor updates like fixed bugs or translations have been added.|
|codeName:||Name to identify the OpenPlotter version (a).|
|state:||Alpha: new features need to be added; Beta: all features have been added, but need to be tested; Stable: all functions should work properly.|
The sources of the OpenPlotter apps repositories should be added once at the beginning and then only if you see the missing source message in any of the OpenPlotter apps.
Occasionally, you should check if there are new versions of OpenPlotter apps in the remote repositories to enjoy new features and correct errors. If there is a new version of an installed app, it will be shown in green:
Run this option when you want to know the status of your apps. This option only compares versions locally and checks for pending tasks. To compare versions in the remote repositories click
To install a new version of any app select the item in the list and click this button. If the updated app was running while the installation, you will have to close and open it again to see changes.
It is highly recommended to install and update the OpenPlotter apps from OpenPlotter Settings because often the installation process involves extra changes to the system that will be carried out automatically. If you install the apps manually from a terminal or they are updated automatically due to a general system update, they will be marked in pink to indicate that there are pending actions:
These extra actions will be executed the first time you open the app:
To uninstall any app select the item in the list and click this button. It is also important to uninstall OpenPlotter apps from OpenPlotter Settings to undo the changes in the system.
If you have trouble locating and opening the OpenPlotter apps installed on your system, you can open them from here.
Select any app and click this button to see all changes across versions.
You can select any of the available languages and all OpenPlotter apps will be translated the next time you open them. You can help us with translations by clicking
If you enable this option, all OpenPlotter applications will be maximized the next time you open them.
Here you can enable/disable the Rescue mode to help recover unstable systems due to some misconfigurations. For example if you set an action to reboot the system using the OpenPlotter Notifications app in response to some value of Signal K, it can cause a reboot loop. Using the Rescue mode disables all actions temporarily and you will be able to remove that killer setting.
Usually OpenPlotter will not have an internet connection while sailing and cannot set the system time automatically. To solve this, the Signal K server collects the time of the GNSS signal and sets the system time. Enabling the NTP server allows other devices connected to the same network as OpenPlotter to update their system time as well. You need to configure the NTP client of your device to connect to the OpenPlotter NTP server.
OpenPlotter includes a virtual keyboard for touch systems or systems that do not have a physical keyboard. You can customize your virtual keyboard by creating a layout that suits your requirements and your language.
Visit this link. to know how to create and share a keyboard layout.
Sometimes you may need some devices or programs to be ready before they work normally. Adding seconds to this field and enabling this button will add a delay to the OpenPlotter startup process to allow time for these lazy devices or programs.
You can play a sound to notify you when the OpenPlotter startup process is complete. Select a sound by clicking and enable the
Play button. This is especially useful for headless systems.
Some apps will report which GPIO they are using and you can check it here. Checking a GPIO will return useful information about its usage.
You can use any GPIO on the Raspberry to set a shutdown botton. Click
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 to save settings and changes will be applied after the next reboot.
You can use any GPIO on the Raspberry to notify an external circuit that it can safely cut power. Click
GPIO to choose a GPIO, usually GPIO 26 at pin 37. Select a GPIO
Transition to trigger the power off, high->low or low->high. Click
Apply to save settings and changes will be applied after the next reboot.
Here are some tools for debugging and troubleshooting your system. When an application malfunctions, it can generate excess messages and eventually create huge log files that consume all free storage space. By setting a maximum log file size, you can detect and resolve potential problems.
When this button is enabled, OpenPlotter applications will generate error messages that will be saved to the log file or printed on the screen when the application is run from a terminal. Use this feature only to check for errors, do not forget to disable it later because it might slow down performance or lead to oversized log files.
This button will print the full contents of the system log file in the output tab.
Here you can filter the contents of the system log file by some keywords.
Here you can filter the contents of the system log file by any term.
If after debugging the system the log file is too large here you can delete it to start from scratch on the next reboot.