version 4.0.1 beta

Author: sailoog

debian/changelog

@@ -1,4 +1,4 @@
-openplotter-doc (4.0.0-beta) bookworm; urgency=medium
+openplotter-doc (4.0.1-beta) bookworm; urgency=medium
 
   * x
 

docs/OpenPlotter-v4-docs.zip

@@ -0,0 +1,3 @@
+# AvNav
+
+Coming soon.

docs/avnav/avnav_app.md

@@ -0,0 +1,3 @@
+# CAN Bus
+
+Coming soon.

docs/can/can_app.md

@@ -0,0 +1,3 @@
+# Dashboards
+
+Coming soon.

docs/dashboards/dashboards_app.md

@@ -0,0 +1,33 @@
+# Features
+
+
+* **Chart Plotter**. Chart a course and track your position using OpenCPN, a concise and robust chart plotter navigation software designed to be used at the helm station of your boat while underway. You can also run AvNav as server to have a chart plotter in any device remotely connected to it using a web browser.|
+
+* **Weather**. Download and display GRIB files using XyGrib.
+
+* **NMEA 0183**. Connect your NMEA 0183 devices to receive and send data.
+
+* **NMEA 2000**. Connect your NMEA 2000 network to receive and send data.
+
+* **Seatalk<sup>1</sup>**. Connect your old Seatalk<sup>1</sup> network to receive data.
+
+* **Signal K**. The free and open source universal marine data exchange format.
+
+* **Access point**. Share data with laptops, tablets, phones…
+
+* **Headless**. You can connect OpenPlotter to any HDMI monitor and/or access to OpenPlotter desktop from the cockpit through your mobile devices.
+
+* **Dashboards**. Customize your instrument panels to visualize data or create charts to see its evolution.
+
+* **AIS**. Build open source AIS receivers/transmitters.
+
+* **Compass**. Get magnetic heading, heel and trim using cheap Inertial Measurement Units (IMU).
+
+* **Autopilot**. Full pypilot integration.
+
+* **Sensors**. Easily connect all kinds of sensors (temperature, pressure, humidity, voltage, current, luminance, tank level, RPM, doors…)
+
+* **Notifications**. Set thresholds for any parameter to trigger visual and sound notifications or trigger multiple custom actions.
+
+* **IoB**. Internet of Boats. Monitor what happens on your boat when you are not there or activate devices remotely.
+

docs/description/features.md

@@ -0,0 +1,67 @@
+# How does it work?
+
+![data flow](img/dataflow.png)
+
+The center of OpenPlotter is the **Signal K Server**. All the data collected by the boat's sensors in any of the supported formats are converted to Signal K format and stored. Once the server has the data in Signal K format, these can be sent by different ways to any program that supports this open source universal data exchange format or they can be converted again to any of the supported formats.
+
+!!! note
+	The main function of the different apps that make up OpenPlotter is to facilitate the connection of the sensors with the Signal K server and in some cases to directly generate data in Signal K format from the raw sensor data. There is also another group of apps dedicated to processing and displaying the data from the Signal K server. You will learn how to use these apps in successive chapters.
+
+Depending on the initial format of the data, it can follow different routes or be available in different ways:
+
+## Signal K
+
+We encourage companies and developers to use the Signal K format for new sensors and devices. OpenPlotter can obtain Signal K data from sensors using USB, GPIO, UDP, TCP and Websockets connections.
+
+There are two Signal K data models, *delta* and *full*. The delta format is used to exchange data between devices and/or servers and the full format is used to store data on servers. Read the [Signal K documentation](https://signalk.org/specification/1.7.0/doc/data_model.html) for details on both models.
+
+When the Signal K server receives delta messages from sensors, it forwards them immediately through a Websocket and a TCP connection at:
+
+```
+ws://openplotter.local:3000/signalk/v1/stream
+tcp://openplotter.local:8375
+```
+
+It also stores data using the full model. This data can be queried using the HTTP REST API at:
+
+```
+http://openplotter.local:3000/signalk/v1/api/
+```
+
+You can manage the Signal K server through a web application at:
+
+```
+http://openplotter.local:3000
+```
+
+
+![SKadmin](img/SKadmin.png)
+
+!!! note
+	You can learn more about Signal K here: [https://signalk.org/specification](https://signalk.org/specification)
+
+## NMEA 0183
+
+You can get NMEA 0183 data from USB, GPIO, TCP and UDP connections. The Signal K server will automatically convert the data to Signal K format and store it. NMEA 0183 data will also optionally be forwarded to:
+
+```
+tcp://openplotter.local:10110
+```
+
+!!! warning "Caution"
+	If the same application gets NMEA 0183 data over the TCP port 10110 and also from any of the Signal K data outputs (HTTP, TCP, or WS) at the same time, it will probably get the same duplicate data in different formats.
+
+If you have data in Signal K format that has not been converted from NMEA 0183, you can convert it to NMEA 0183 and send it through the TCP port 10110 using the **signalk-to-nmea0183** plugin.
+
+!!! note
+	To better understand the management of NMEA 0183 data in the Signal K server, please refer to the chapter [NMEA 0183 multiplexing](../signalk/multiplexing.md).
+
+## NMEA 2000
+
+You can get NMEA 2000 data from USB, GPIO, TCP and UDP connections. The Signal K server will automatically convert the data to Signal K format and store it.
+
+If you have data in Signal K format that has not been converted from NMEA 2000, you can convert it to NMEA 2000 and send it through the same CAN bus adapter using the **signalk-to-nmea2000** plugin.
+
+## Seatalk<sup>1</sup>
+
+You can get data in the old Seatalk<sup>1</sup> format from a GPIO. The Signal K server will automatically convert the data to Signal K format and store it. There is currently no way to convert Signal K data to Seatalk<sup>1</sup> or send data in Seatalk<sup>1</sup> format from a Signal K server.

docs/description/how_does_it_work.md

@@ -0,0 +1,42 @@
+# How to collaborate
+
+
+> *Everything takes ***time***, ***money*** and ***monkeys***. You need a lot from any two groups and a little from the third. An increase in any one reduces the requirement for the other two. Change occurs when one of those three change*
+
+
+**Time**
+
+Download and install OpenPlotter and test and test and test... Report bugs and request new features in [OpenMarine forums](http://forum.openmarine.net/). Spread the word among your friends in ports and forums.
+
+**Money**
+
+This project is financed by [selling related products ](https://shop.openmarine.net/) or by [voluntary contributions](https://www.paypal.com/donate?hosted_button_id=3J8V5AT6M74L4).
+
+**Monkeys**
+
+> *Men wanted for hazardous journey. Low wages, bitter cold, long hours of complete darkness. Safe return doubtful. Honour and recognition in event of success*
+>
+>-- Ernest Shackleton
+
+If you have python skills, push your commits to the [github repository](https://github.com/openplotter). If you have electronics skills, share your work on [OpenMarine forums](http://forum.openmarine.net/).
+
+## Translations
+
+If you want to help translate the software into your language, create an account on the Crowdin platform and edit [the project](https://crowdin.com/project/openplotter).
+
+
+## Documentation
+
+If you want to help us maintain this documentation, let us know what your intentions are in [the forum](http://forum.openmarine.net/forumdisplay.php?fid=16) to coordinate. The best way to do this is to fork [this GitHub repository ](https://github.com/openplotter/docs) and push your commits. If you are not familiar with GitHub, do not worry, send us your contributions to [the forum](http://forum.openmarine.net/forumdisplay.php?fid=16).
+
+**Guidelines**
+
+-  We need schematic and concise documentation just for reference. We do not want manuals, tutorials or detailed *How-to's*. That makes people free to generate their detailed manuals, tutorials or videos for newbies in their language. Remember, this is a reference book, not a tutorial. Be brief and concise.
+
+- A picture is worth a thousand words. Use this tool to make screenshots:
+
+```
+	sudo apt install gnome-screenshot
+```
+
+- English is not our main language and there will be many errors, please help us with this too.

docs/description/how_to_collaborate.md

@@ -26,9 +26,9 @@ Icons used in OpenPlotter apps and documentation are from [flaticon.com](https:/
 
 ## About us
 
-You will see everywhere the nickname Sailoog. That is me, a guy from Barcelona, Catalonia, who started OpenPlotter as an exercise to learn English and Python in 2014. After a few years, OpenPlotter has become a very popular project and has helped me make many friends and a few enemies, so as long as this is still this fun, this project will last a long time ;)
+You will see everywhere the nickname Sailoog. That is me, a guy from Barcelona, Catalonia, who started OpenPlotter as an exercise to learn Python in 2014. After a few years, OpenPlotter has become a very popular project and has helped me make many friends and a few enemies, so as long as this is still this fun, this project will last a long time ;)
 
-My motivations are scientific and political, but OpenPlotter is free and that means that your motivations to use or collaborate with this project can be whatever you want, even the opposite of mine. OpenPlotter is not my main activity, I currently work as employee at o-charts that is part of the OpenCPN development team.
+My motivations are scientific and political, but OpenPlotter is free and that means that your motivations to use or collaborate with this project can be whatever you want, even the opposite of mine. OpenPlotter is not my main activity.
 
 You will also see that I always use the plural when I speak about OpenPlotter. Although it seems that I am always that boring guy behind everything, many people collaborate on this project that always needs more hands and brains. I cannot mention all the people who have gone through this project because I would forget many of them, but I would like to make a special mention of e-sailing who contributed a lot of code.
 

docs/description/img/SKadmin.png

@@ -0,0 +1,108 @@
+# Downloading
+
+!!! note "Raspberry Pi or desktop/laptop computer?"
+
+	OpenPlotter is optimized to be used on [Raspberry Pi](https://www.raspberrypi.com) computers, but you can also install OpenPlotter on any desktop or laptop computer running Linux Debian or any derivative like Ubuntu, Mint ... Some OpenPlotter apps that are used to manage some sensors connected via GPIO will not be available when installed on desktop and laptop computers. See a list [here](downloading.md#desktop-and-laptop).
+
+## Raspberry Pi images
+
+This is the easiest and fastest way to get started with OpenPlotter. We publish different editions according to the most demanded uses that contain all the required apps installed and preconfigured. We try to provide solutions for everyone from beginners to experts. We even have a fully customizable option that will save you a lot of time. Just plug and sail!
+
+Our OpenPlotter editions are based on Raspberry Pi OS. You do not need any prior knowledge of Linux to install and use them. Follow the [installing](installing.md) chapter to learn how.
+
+### OpenPlotter Starting
+
+All required apps to fulfill most OpenPlotter marine features.
+
+- **Download**: [OpenPlotter Starting](https://cloud.openmarine.net/s/TwxS4AJrtTJ485T)
+- **Hostname**: openplotter
+- **User**: pi
+- **Password**: raspberry
+- **Language**: en_GB.UTF-8
+- **Keymap**: gb
+- **Layout**: English (UK)
+- **TimeZone**: Europe/London
+- **Wi-Fi client**: SSID: none, Password: none, Country: none
+- **Wi-Fi AP**: SSID: none, Password: none, IP: none
+- **SSH**: Disabled
+- **Remote desktop**: Disabled
+- **Touchscreen**: Disabled
+- **Backlight**: Disabled
+- **Installed apps**: Settings - Docs - Signal K installer - OpenCPN installer - Serial - CAN bus - Dashboards - Notifications - Xygrib
+
+### OpenPlotter Headless
+
+Same as *OpenPlotter Starting* but ready to be used remotely without monitor. The Raspberry Pi's internal Wi-Fi device is configured in dual mode, this means that there is a preconfigured access point but it can also connect as a client.
+
+- **Download**: [OpenPlotter Headless](https://cloud.openmarine.net/s/cMJrfH45aPeamFc)
+- **Hostname**: openplotter
+- **User**: pi
+- **Password**: raspberry
+- **Language**: en_GB.UTF-8
+- **Keymap**: gb
+- **Layout**: English (UK)
+- **TimeZone**: Europe/London
+- **Wi-Fi client**: SSID: none, Password: none, Country: none
+- **Wi-Fi AP**: SSID: openplotter, Password: 12345678, IP: 10.42.0.1
+- **SSH**: Enabled
+- **Remote desktop**: Enabled
+- **Touchscreen**: Disabled
+- **Backlight**: Disabled
+- **Installed apps**: Settings - Docs - Signal K installer - OpenCPN installer - Serial - CAN bus - Dashboards - Notifications - Xygrib
+
+### OpenPlotter Touchscreen
+
+Same as *OpenPlotter Starting* but ready to be used on DSI touchscreens as the official monitor for Raspberry Pi and its clones.
+
+- **Download**: [OpenPlotter Touchscreen](https://cloud.openmarine.net/s/3gjyKsrpKRb6ZHe)
+- **Hostname**: openplotter
+- **User**: pi
+- **Password**: raspberry
+- **Language**: en_GB.UTF-8
+- **Keymap**: gb
+- **Layout**: English (UK)
+- **TimeZone**: Europe/London
+- **Wi-Fi client**: SSID: none, Password: none, Country: none
+- **Wi-Fi AP**: SSID: none, Password: none, IP: none
+- **SSH**: Disabled
+- **Remote desktop**: Disabled
+- **Touchscreen**: Enabled
+- **Backlight**: Enabled
+- **Installed apps**: Settings - Docs - Signal K installer - OpenCPN installer - Serial - CAN bus - Dashboards - Notifications - Xygrib
+
+### OpenPlotter À la Carte
+
+Fill in a form with all the available customization options and in a few minutes you will receive an image built by a robot from scratch and to your liking that will save you a lot of time. Another advantage over the other editions is that all packages that make up the OS, including Openplotter apps, will be updated to the latest versions.
+
+- **Download**: Coming soon.
+- **Hostname**: Customizable
+- **User**: Customizable
+- **Password**: Customizable
+- **Language**: Customizable
+- **Keymap**: Customizable
+- **Layout**: Customizable
+- **TimeZone**: Customizable
+- **Wi-Fi client**: SSID: Customizable, Password: Customizable, Country: Customizable
+- **Wi-Fi AP**: SSID: Customizable, Password: Customizable, IP: Customizable
+- **SSH**: Customizable
+- **Remote desktop**: Customizable
+- **Touchscreen**: Customizable
+- **Backlight**: Customizable
+- **Installed apps**: Customizable
+
+## Desktop and laptop
+
+!!! important
+	Each new version of OpenPlotter should only be installed on the indicated system. **OpenPlotter v4 will work only on Debian 12 Bookworm, Ubuntu 22.04 Jammy or any of their derivatives**. If you try to force an installation of OpenPlotter v4 over OpenPlotter v3 (based on Debian 11 Bullseye), your system will become unstable.
+
+You can also install OpenPlotter in any desktop or laptop computer running your favourite Debian derivative distribution. Hovewer, if your computer is not a Raspberry Pi, you will not be able to install some OpenPlotter apps:
+
+- **Common**: Settings - Docs - Signal K installer - OpenCPN installer - Serial - CAN bus - Dashboards - Notifications - IoB - MAIANA AIS Transponder - Xygrib - AvNav installer - SDR VHF
+
+- **Only Raspberry Pi**: Pypilot - I2C Sensors - GPIO
+
+You just need basic knowledge of Linux to install OpenPlotter for desktop and laptop. Download this *OpenPlotter Settings* package: [![Latest version of 'openplotter-settings' @ Cloudsmith](https://api-prd.cloudsmith.io/v1/badges/version/openplotter/openplotter/deb/openplotter-settings/latest/a=all;xc=main;d=debian%252Fbookworm;t=binary/?render=true&show_latest=true)](https://cloudsmith.io/~openplotter/repos/openplotter/packages/detail/deb/openplotter-settings/latest/a=all;xc=main;d=debian%252Fbookworm;t=binary/) and follow the [Desktop and laptop](installing.md#desktop-and-laptop) chapter to install OpenPlotter from scratch.
+
+## OpenPlotter Expert
+
+Pi-gen is the tool used to create the official *Raspberry Pi OS* images. We use a fork of pi-gen to create OpenPlotter images. Use the *openplotter64* branch of our repository to create your own OpenPlotter flavor. You need good knowledge of Linux to create your own OpenPlotter distributions. Follow instructions in [README file](https://github.com/openplotter/pi-gen/tree/openplotter64).