---
title: "Compass panel plugin for Grafana"
description: "A dynamic compass panel for Grafana. Compass panel plugin for Grafana by oceandatatools. Available in Grafana Cloud and self-managed Grafana."
---

> This is the Markdown version of https://grafana.com/grafana/plugins/oceandatatools-compass-panel/

# Compass

- Developer: oceandatatools
- Version: 2.2.0
- [Installation](https://grafana.com/grafana/plugins/oceandatatools-compass-panel/installation.md)
- [Change log](https://grafana.com/grafana/plugins/oceandatatools-compass-panel/changelog.md)

![Compass with needle](https://grafana.com/api/plugins/oceandatatools-compass-panel/versions/2.2.0/images/screenshots/compass-with-needle.png)

![Compass with arrow](https://grafana.com/api/plugins/oceandatatools-compass-panel/versions/2.2.0/images/screenshots/compass-with-arrow.png)

![Compass with ship profile](https://grafana.com/api/plugins/oceandatatools-compass-panel/versions/2.2.0/images/screenshots/compass-with-ship-profile.png)

![Compass with custom styling](https://grafana.com/api/plugins/oceandatatools-compass-panel/versions/2.2.0/images/screenshots/compass-with-custom-styling.png)

# Compass Panel

[![Grafana Marketplace](https://img.shields.io/badge/dynamic/json?logo=grafana\&query=$.version\&url=https://grafana.com/api/plugins/oceandatatools-compass-panel\&label=Marketplace\&prefix=v\&color=F47A20)](https://grafana.com/grafana/plugins/oceandatatools-compass-panel/) [![GitHub Sponsor](https://img.shields.io/github/sponsors/webbpinner?label=Sponsor\&logo=GitHub)](https://github.com/sponsors/webbpinner) [![License](https://img.shields.io/github/license/OceanDataTools/grafana-compass-panel)](https://grafana.com/grafana/plugins/oceandatatools-compass-panel/)

## Overview / Introduction

**Compass** is a Grafana visualization plugin for displaying heading or orientation data on a compass dial.\
It is especially useful for ship navigation, robotics, UAVs, or any time-series data representing direction in degrees (0–360). Optionally the panel can display true and/or apparent wind angle.

![Compass with Wind Indicators Example](https://raw.githubusercontent.com/OceanDataTools/grafana-compass-panel/main/src/screenshots/wind-with-spd.png)

---

## Features

- Smoothly animated compass dial that rotates with heading values.

- Multiple **needle types**:

  - **Default**: classic north/south needle with red tip.
  - **Arrow**: bold arrow-style needle.
  - **Ship**: minimal ship silhouette pointing forward.
  - **Airplane**: swept-wing top-down aircraft silhouette.
  - **Helicopter**: 4-blade helicopter silhouette.
  - **Underwater Drone**: glider-shaped AUV silhouette.
  - **Quadcopter**: four-arm drone frame and rotor silhouette.
  - **ROV**: Remotely Operated Vehicle silhouette.
  - **Custom SVG**: load your own vector as a needle.
  - **Custom PNG**: load your own bitmap as a needle.

- Cardinal direction labels (N/E/S/W).

- Configurable colors for bezel, dial, text, needle, and tail.

- Minor and major tick marks for easy orientation.

- Optional numeric heading readout (e.g. `273°`).

- Optional indicator and numeric heading for true wind direction.

- Optional indicator and numeric heading for apparent wind direction.

- Optional numeric display for true wind speed.

- Optional numeric display for apparent wind speed.

---

## Getting Started

1. Install the plugin by copying it into Grafana’s plugin directory or installing from the Grafana Marketplace.
2. Restart Grafana.
3. Add a new panel and select **Compass** as the visualization.
4. Configure the data source and select the field representing **heading** (0–360 degrees).

---

## Options

### Data Options

- **Heading Field**: Select the numeric field in your series that represents heading in degrees.
- **Truewind Direction Field**: Select the numeric field in your series that represents true wind direction, as an **absolute compass bearing** (0-360°, independent of the ship's heading).
- **Truewind Velocity Field**: Select the numeric field in your series that represents truewind velocity in degrees.
- **Apparent wind Direction Field**: Select the numeric field in your series that represents apparent wind angle, **relative to the ship's bow** (0-360°, as read directly off a wind vane/anemometer). This is _not_ an absolute compass bearing — a rotational wind sensor can only measure angle relative to the bow it's mounted on, so the panel combines it with the Heading Field to compute the wind's true position on the compass. If your data source already outputs an absolute apparent wind direction (e.g. some chartplotters/NMEA multiplexers compute this for you), subtract the heading from it upstream to get a bow-relative angle before wiring it in here.
- **Apparent wind Velocity Field**: Select the numeric field in your series that represents apparent wind velocity in degrees.

### Display Options

- **Show Labels**: Toggle cardinal direction labels (N/E/S/W).
- **Show Numeric Heading**: Display a numeric degree readout below the compass.
- **Truewind Velocity UOM**: Select the unit of measure for the truewind.
- **Apparent wind Velocity UOM**: Select the unit of measure for the apparent wind.
- **Rotation Mode**: Select to rotate the needle (North up) or rotate the dial (Bow up).
- **Animation Duration (ms)**: How long needle/dial/wind-arrow rotations take to animate (default 600ms). Lower this, or set it to 0 to disable animation, for high-frequency live data (e.g. Grafana Live streams updating tens of times per second) where the default speed lags behind incoming updates.

### Needle Options

- **Needle Type**

  - `Default` - classic north/south needle with red tip.
  - `Arrow` - bold arrow-style needle.
  - `Ship` - minimal ship silhouette pointing forward.
  - `Airplane` - swept-wing top-down aircraft silhouette.
  - `Helicopter` - 4-blade helicopter silhouette.
  - `Underwater Drone` - glider-shaped AUV silhouette.
  - `Quadcopter` - four-arm drone frame and rotor silhouette.
  - `ROV` - Remotely Operated Vehicle silhouette.
  - `Custom SVG` – Load a custom vector (provide URL or relative path)
  - `Custom PNG` – Load a custom image (provide URL or relative path)

- **Needle Color**: Color of the primary needle (or the front rotor, for the quadcopter).

- **Tail Color**: Color of the tail (for the default needle).

- **Custom SVG**: Path/URL to your own SVG asset.

- **Custom PNG**: Path/URL to your own PNG asset.

### Colors

- **Dial Color** – Background color of compass dial.
- **Bezel Color** – Color of outer rim.
- **Text Color** – Color of labels, ticks, numeric heading.
- **True Wind Color**: Color of the true wind indicator and labels.
- **Apparent Wind Color**: Color of the apparent wind indicator and labels.

---

## Screenshots

![Default Needle](https://raw.githubusercontent.com/OceanDataTools/grafana-compass-panel/main/src/screenshots/compass-with-needle.png)

_Default needle with labels and numeric heading enabled_

![Arrow Needle](https://raw.githubusercontent.com/OceanDataTools/grafana-compass-panel/main/src/screenshots/compass-with-arrow.png)

_Arrow needle with labels and numeric heading enabled_

![Ship Needle](https://raw.githubusercontent.com/OceanDataTools/grafana-compass-panel/main/src/screenshots/compass-with-ship-profile.png)

_Ship silhouette needle for vessel heading visualization_

![Airplane Needle](https://raw.githubusercontent.com/OceanDataTools/grafana-compass-panel/main/src/screenshots/compass-with-airplane.png)

_Airplane needle for aircraft heading visualization_

![Helicopter Needle](https://raw.githubusercontent.com/OceanDataTools/grafana-compass-panel/main/src/screenshots/compass-with-helicopter.png)

_Helicopter needle for rotorcraft heading visualization_

![Underwater Drone Needle](https://raw.githubusercontent.com/OceanDataTools/grafana-compass-panel/main/src/screenshots/compass-with-underwater-drone.png)

_Underwater drone needle for ROV/AUV heading visualization_

![Quadcopter Needle](https://raw.githubusercontent.com/OceanDataTools/grafana-compass-panel/main/src/screenshots/compass-with-quadcopter.png)

_Quadcopter needle for rotorcraft heading visualization_

![ROV Needle](https://raw.githubusercontent.com/OceanDataTools/grafana-compass-panel/main/src/screenshots/compass-with-rov.png)

_ROV needle for underwater vehicle heading visualization_

![Custom Styling](https://raw.githubusercontent.com/OceanDataTools/grafana-compass-panel/main/src/screenshots/compass-with-custom-styling.png)

_Default needle with custom styling visualization_

![Custom PNG Needle](https://raw.githubusercontent.com/OceanDataTools/grafana-compass-panel/main/src/screenshots/compass-with-custom-png-needle.png)

_Custom PNG needle styling visualization_

![North Up Orientation](https://raw.githubusercontent.com/OceanDataTools/grafana-compass-panel/main/src/screenshots/wind-with-spd.png)

_North up orientation for wind indicator visualization_

![Bow Up Orientation](https://raw.githubusercontent.com/OceanDataTools/grafana-compass-panel/main/src/screenshots/wind-without-spd.png)

_Bow up orientation for wind indicator visualization_
