Skip to content

Commit 64d33f3

Browse files
committed
initial attempt to implement issue #4
1 parent fe4e753 commit 64d33f3

File tree

16 files changed

+1168
-343
lines changed

16 files changed

+1168
-343
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: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
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.
@@ -42,56 +43,61 @@ Optionally the panel can display true and/or apparent wind angle.
4243
## Options
4344

4445
### Data Options
46+
4547
- **Heading Field**: Select the numeric field in your series that represents heading in degrees.
4648

4749
### Display Options
50+
4851
- **Show Labels**: Toggle cardinal direction labels (N/E/S/W).
4952
- **Show Numeric Heading**: Display a numeric degree readout below the compass.
5053

5154
### 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)
55+
56+
- **Needle Type**
57+
58+
- `Default` – red-tipped classic compass needle
59+
- `Arrow` – stylized arrow needle
60+
- `Ship` – simplified vessel silhouette (points to heading)
61+
- `SVG` – load a custom vector (provide URL or relative path)
5762
- `PNG` – load a custom image (provide URL or relative path)
5863

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+
- **Needle Color**: Color of the primary needle.
65+
- **Tail Color**: Color of the tail (for default needle).
66+
- **Custom SVG**: Path/URL to your own SVG asset.
67+
- **Custom PNG**: Path/URL to your own PNG asset.
6368

6469
### 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.
7070

71+
- **Dial Color** – background of compass dial.
72+
- **Bezel Color** – outer rim.
73+
- **Text Color** – labels, ticks, numeric heading.
74+
- **True Wind Color**: Color of the true wind indicator.
75+
- **Apparent Wind Color**: Color of the apparent wind indicator.
7176

7277
---
7378

7479
## Screenshots
80+
7581
![Default Needle](https://raw.githubusercontent.com/OceanDataTools/grafana-compass-panel/main/src/screenshots/compass-with-needle.png)
7682

77-
*Arrow needle with labels and numeric heading enabled*
83+
_Arrow needle with labels and numeric heading enabled_
7884

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

81-
*Arrow needle with labels and numeric heading enabled*
87+
_Arrow needle with labels and numeric heading enabled_
8288

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

85-
*Ship silhouette needle for vessel heading visualization*
91+
_Ship silhouette needle for vessel heading visualization_
8692

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

89-
*Standard needle compass with custom styling*
95+
_Standard needle compass with custom styling_
9096

9197
![North Up Orientation](https://raw.githubusercontent.com/OceanDataTools/grafana-compass-panel/main/src/screenshots/winddial-north-up.png)
9298

93-
*North up orientation for wind dial visualization*
99+
_North up orientation for wind dial visualization_
94100

95101
![Bow Up Orientation](https://raw.githubusercontent.com/OceanDataTools/grafana-compass-panel/main/src/screenshots/winddial-bow-up.png)
96102

97-
*Bow up orientation for wind dial visualization*
103+
_Bow up orientation for wind dial 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)