Skip to content

Commit 988454b

Browse files
webbpinnerwebbpinner
committed
Merge branch 'dev'
2 parents fe4e753 + 0dbc154 commit 988454b

File tree

16 files changed

+1182
-348
lines changed

16 files changed

+1182
-348
lines changed

‎CHANGELOG.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Changelog
22

3-
## 1.0.0 (Unreleased)
3+
## 1.0.0
44

55
Initial release.
6+
7+
## 2.0.0
8+
9+
Added wind direction indicators/labels
10+
11+
## 2.1.0
12+
13+
Added wind velocity labels

‎README.md‎

Lines changed: 40 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@
44
[![License](https://img.shields.io/github/license/OceanDataTools/grafana-compass-panel)](LICENSE)
55

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

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

1314
---
1415

@@ -27,6 +28,8 @@ Optionally the panel can display true and/or apparent wind angle.
2728
- Optional numeric heading readout (e.g. `273°`).
2829
- Optional indicator and numeric heading for true wind direction.
2930
- Optional indicator and numeric heading for apparent wind direction.
31+
- Optional numeric display for true wind speed.
32+
- Optional numeric display for apparent wind speed.
3033

3134
---
3235

@@ -42,56 +45,68 @@ Optionally the panel can display true and/or apparent wind angle.
4245
## Options
4346

4447
### Data Options
48+
4549
- **Heading Field**: Select the numeric field in your series that represents heading in degrees.
50+
- **Truewind Direction Field**: Select the numeric field in your series that represents truewind direction in degrees.
51+
- **Truewind Velocity Field**: Select the numeric field in your series that represents truewind velocity in degrees.
52+
- **Apparent wind Direction Field**: Select the numeric field in your series that represents apparent wind direction in degrees.
53+
- **Apparent wind Velocity Field**: Select the numeric field in your series that represents apparent wind velocity in degrees.
4654

4755
### Display Options
56+
4857
- **Show Labels**: Toggle cardinal direction labels (N/E/S/W).
4958
- **Show Numeric Heading**: Display a numeric degree readout below the compass.
59+
- **Truewind Velocity UOM**: Select the unit of measure for the truewind.
60+
- **Apparent wind Velocity UOM**: Select the unit of measure for the apparent wind.
61+
- **Rotation Mode**: Select to rotate the needle (North up) or rotate the dial (Bow up).
5062

5163
### Needle Options
52-
- **Needle Type**
53-
- `Default` – red-tipped classic compass needle
54-
- `Arrow` – stylized arrow needle
55-
- `Ship` – simplified vessel silhouette (points to heading)
56-
- `SVG` – load a custom vector (provide URL or relative path)
57-
- `PNG` – load a custom image (provide URL or relative path)
58-
59-
- **Needle Color**: Color of the primary needle.
60-
- **Tail Color**: Color of the tail (for default needle).
61-
- **Custom SVG**: Path/URL to your own SVG asset.
62-
- **Custom PNG**: Path/URL to your own PNG asset.
64+
65+
- **Needle Type**
66+
67+
- `Default` – Red-tipped classic compass needle
68+
- `Arrow` – Stylized arrow needle
69+
- `Ship` – Simplified vessel silhouette (points to heading)
70+
- `SVG` – Load a custom vector (provide URL or relative path)
71+
- `PNG` – Load a custom image (provide URL or relative path)
72+
73+
- **Needle Color**: Color of the primary needle.
74+
- **Tail Color**: Color of the tail (for default needle).
75+
- **Custom SVG**: Path/URL to your own SVG asset.
76+
- **Custom PNG**: Path/URL to your own PNG asset.
6377

6478
### Colors
65-
- **Dial Color** – background of compass dial.
66-
- **Bezel Color** – outer rim.
67-
- **Text Color** – labels, ticks, numeric heading.
68-
- **True Wind Color**: Color of the true wind indicator.
69-
- **Apparent Wind Color**: Color of the apparent wind indicator.
7079

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

7286
---
7387

7488
## Screenshots
89+
7590
![Default Needle](https://raw.githubusercontent.com/OceanDataTools/grafana-compass-panel/main/src/screenshots/compass-with-needle.png)
7691

77-
*Arrow needle with labels and numeric heading enabled*
92+
_Arrow needle with labels and numeric heading enabled_
7893

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

81-
*Arrow needle with labels and numeric heading enabled*
96+
_Arrow needle with labels and numeric heading enabled_
8297

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

85-
*Ship silhouette needle for vessel heading visualization*
100+
_Ship silhouette needle for vessel heading visualization_
86101

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

89-
*Standard needle compass with custom styling*
104+
_Standard needle compass with custom styling_
90105

91-
![North Up Orientation](https://raw.githubusercontent.com/OceanDataTools/grafana-compass-panel/main/src/screenshots/winddial-north-up.png)
106+
![North Up Orientation](https://raw.githubusercontent.com/OceanDataTools/grafana-compass-panel/main/src/screenshots/wind-with-spd.png)
92107

93-
*North up orientation for wind dial visualization*
108+
_North up orientation for wind indicator visualization_
94109

95-
![Bow Up Orientation](https://raw.githubusercontent.com/OceanDataTools/grafana-compass-panel/main/src/screenshots/winddial-bow-up.png)
110+
![Bow Up Orientation](https://raw.githubusercontent.com/OceanDataTools/grafana-compass-panel/main/src/screenshots/wind-without-spd.png)
96111

97-
*Bow up orientation for wind dial visualization*
112+
_Bow up orientation for wind indicator visualization_

‎docker-compose.yaml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,15 @@ services:
33
extends:
44
file: .config/docker-compose-base.yaml
55
service: grafana
6+
7+
environment:
8+
# --- Basic admin setup ---
9+
- GF_SECURITY_ADMIN_USER=admin
10+
- GF_SECURITY_ADMIN_PASSWORD=admin
11+
12+
# --- Enable anonymous access (required for public dashboards) ---
13+
- GF_AUTH_ANONYMOUS_ENABLED=true
14+
- GF_AUTH_ANONYMOUS_ORG_ROLE=Viewer
15+
16+
# --- Enable public dashboards feature toggle ---
17+
- GF_FEATURE_TOGGLES_publicDashboards=true

‎package-lock.json‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "compass-panel",
3-
"version": "2.0.0",
3+
"version": "2.1.0",
44
"scripts": {
55
"build": "webpack -c ./.config/webpack/webpack.config.ts --env production",
66
"dev": "webpack -w -c ./.config/webpack/webpack.config.ts --env development",

0 commit comments

Comments
 (0)