OpenPlotter

https://openplotter.readthedocs.io/latest/
Admin
OpenPlotter is a free and open-source software suite for sailing yachts and small boats that...
Tokens:10,864
Snippets:194
Trust Score:9.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install gnome-screenshot

Source: https://openplotter.readthedocs.io/latest/description/how_to_collaborate.html

Command to install the gnome-screenshot utility for capturing images for documentation.

```bash
    sudo apt install gnome-screenshot
```

--------------------------------

### Install OpenPlotter Settings package

Source: https://openplotter.readthedocs.io/latest/getting_started/installing.html

Install the OpenPlotter Settings application using the downloaded .deb file.

```bash
sudo dpkg -i openplotter-settings_x.x.x-stable_all.deb
```

--------------------------------

### Launch Signal K Installer via Terminal

Source: https://openplotter.readthedocs.io/latest/signalk/signalk_app.html

Use this command in a terminal to open the Signal K Installer application.

```bash
openplotter-signalk-installer
```

--------------------------------

### Launch OpenCPN Installer via Terminal

Source: https://openplotter.readthedocs.io/latest/opencpn/opencpn_app.html

Command to open the OpenCPN Installer application from the command line.

```bash
openplotter-opencpn-installer
```

--------------------------------

### Install OpenPlotter dependencies on Debian/Ubuntu

Source: https://openplotter.readthedocs.io/latest/getting_started/installing.html

Install required system packages before setting up OpenPlotter on a desktop or laptop.

```bash
sudo apt update
sudo apt install python3-wxgtk4.0 python3-ujson python3-pyudev vlc matchbox-keyboard
```

--------------------------------

### Launch OpenPlotter Settings

Source: https://openplotter.readthedocs.io/latest/getting_started/installing.html

Start the OpenPlotter Settings application from the terminal.

```bash
openplotter-settings
```

--------------------------------

### Launch Pypilot via Terminal

Source: https://openplotter.readthedocs.io/latest/pypilot/imu.html

Use this command in a terminal to start the Pypilot application.

```bash
openplotter-pypilot
```

--------------------------------

### Enable OpenPlotter rescue mode

Source: https://openplotter.readthedocs.io/latest/getting_started/first_steps.html

Add this line to the /boot/firmware/config.txt file to prevent core processes from starting during boot.

```text
OPrescue=1
```

--------------------------------

### Launch IoB via Terminal

Source: https://openplotter.readthedocs.io/latest/iob/iob_app.html

Command to start the IoB application from the terminal.

```bash
openplotter-iob
```

--------------------------------

### Launch CAN Bus Application

Source: https://openplotter.readthedocs.io/latest/can/can_app.html

Command to start the OpenPlotter CAN Bus application from the terminal.

```bash
openplotter-can
```

--------------------------------

### getData JSON Response

Source: https://openplotter.readthedocs.io/latest/iob/mqtt.html

Example JSON response received when requesting data via the getData command.

```json
{
    "value":293.45,
    "$source": "OpenPlotter.I2C.BME680/688",
    "timestamp": "2025-01-31T18:55:24.124Z"
}
```

--------------------------------

### Filtered getData Response

Source: https://openplotter.readthedocs.io/latest/iob/mqtt.html

Example JSON response when requesting specific sensor data.

```json
{
  "pressure": {
    "meta": {
      "units": "Pa",
      "description": "Pressure in zone"
    },
    "value": 101967,
    "$source": "OpenPlotter.I2C.BME680/688",
    "timestamp": "2025-02-13T21:39:27.622Z"
  },
  "temperature": {
    "meta": {
      "units": "K",
      "description": "Temperature"
    },
    "value": 295.04999999999995,
    "$source": "OpenPlotter.I2C.BME680/688",
    "timestamp": "2025-02-13T21:39:27.622Z"
  }
}
```

--------------------------------

### PUBLISH mqtt/command/getCommand

Source: https://openplotter.readthedocs.io/latest/iob/mqtt.html

Requests information about available commands in the system.

```APIDOC
## PUBLISH mqtt/command/getCommand

### Description
Retrieves a list of defined commands or the description of a specific command.

### Topic
mqtt/command/getCommand

### Payload
- **payload** (string) - Required - The command name to query, or 'all' to list all available commands.

### Response
- **Topic**: mqtt/data/command
- **Format**: JSON array of strings (if 'all') or a string description of the requested command.
```

--------------------------------

### PUBLISH mqtt/command/getData

Source: https://openplotter.readthedocs.io/latest/iob/mqtt.html

Requests boat data from the system. You can request all data or specific Signal K keys.

```APIDOC
## PUBLISH mqtt/command/getData

### Description
Requests boat data. Publishing 'all' returns all current data. Publishing a specific Signal K key (e.g., 'environment/inside/temperature') returns data for that specific key.

### Topic
mqtt/command/getData

### Payload
- **payload** (string) - Required - The Signal K key to retrieve, or 'all' for all data.

### Response
- **Topic**: mqtt/data (or specific sub-topic based on key)
- **Format**: JSON object containing value, $source, and timestamp.
```

--------------------------------

### getCommand Response

Source: https://openplotter.readthedocs.io/latest/iob/mqtt.html

List of available commands returned by the getCommand command.

```json
["getData","getCommand"]
```

--------------------------------

### MQTT Broker Connection Details

Source: https://openplotter.readthedocs.io/latest/iob/mqtt.html

Standard connection parameters for accessing the OpenMarine MQTT broker.

```APIDOC
## MQTT Broker Connection

### Address
mqtt.openmarine.net

### Port
1883

### SSL
No

### Authentication
Username and password required.

### Privacy
Only clients using the same user credentials can subscribe and publish to that user's topics.
```

--------------------------------

### Signal K Web Administration Interface

Source: https://openplotter.readthedocs.io/latest/description/how_does_it_work.html

URL for accessing the web-based management application for the Signal K server.

```text
http://openplotter.local:3000
```

--------------------------------

### Allowed MQTT Topics

Source: https://openplotter.readthedocs.io/latest/iob/mqtt.html

Specifications for allowed topic patterns, QoS levels, and message retention policies.

```APIDOC
## Allowed Topics

### mqtt/command/+
- **Usage**: Publish and subscribe
- **QoS**: 0
- **Retained messages**: No

### mqtt/data/#
- **Usage**: Publish and subscribe
- **QoS**: 0, 1, 2
- **Retained messages**: Yes
```

--------------------------------

### Launch Serial app via terminal

Source: https://openplotter.readthedocs.io/latest/serial/serial_app.html

Command to open the OpenPlotter Serial application from a terminal interface.

```bash
openplotter-serial
```

--------------------------------

### Configure sudoers for OpenPlotter

Source: https://openplotter.readthedocs.io/latest/getting_started/installing.html

Modify the sudoers file to allow passwordless execution of administrative tasks.

```bash
sudo visudo
```

```text
myuser ALL=(ALL) NOPASSWD: ALL
```

--------------------------------

### Access Signal K Web Administration Panel on Port 80

Source: https://openplotter.readthedocs.io/latest/signalk/signalk_app.html

URLs to access the Signal K web interface when configured to use port 80.

```text
    http://localhost
    http://openplotter.local
```

--------------------------------

### Signal K REST API Endpoint

Source: https://openplotter.readthedocs.io/latest/description/how_does_it_work.html

Endpoint for querying stored data using the full Signal K model.

```text
http://openplotter.local:3000/signalk/v1/api/
```

--------------------------------

### Signal K Data Stream Endpoints

Source: https://openplotter.readthedocs.io/latest/description/how_does_it_work.html

Endpoints for receiving real-time delta messages from the Signal K server.

```text
ws://openplotter.local:3000/signalk/v1/stream
tcp://openplotter.local:8375
```

--------------------------------

### NMEA 0183 Forwarding Endpoint

Source: https://openplotter.readthedocs.io/latest/description/how_does_it_work.html

TCP port used for forwarding NMEA 0183 data.

```text
tcp://openplotter.local:10110
```

--------------------------------

### JSONPath Expression

Source: https://openplotter.readthedocs.io/latest/iob/mqtt.html

JSONPath expression used to extract the temperature value from the returned JSON data.

```text
$.temperature.value
```
Tokens:
Raw