Skip to content

Commit af9cbfe

Browse files
committed
updated the other README.md file
1 parent 64d33f3 commit af9cbfe

File tree

1 file changed

+22
-13
lines changed

1 file changed

+22
-13
lines changed

README.md

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
It is especially useful for ship navigation, robotics, UAVs, or any time-series data representing direction in degrees (0–360).
1010
Optionally the panel can display true and/or apparent wind angle.
1111

12-
![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)
1313

1414
---
1515

@@ -28,6 +28,8 @@ Optionally the panel can display true and/or apparent wind angle.
2828
- Optional numeric heading readout (e.g. `273°`).
2929
- Optional indicator and numeric heading for true wind direction.
3030
- 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.
3133

3234
---
3335

@@ -45,21 +47,28 @@ Optionally the panel can display true and/or apparent wind angle.
4547
### Data Options
4648

4749
- **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.
4854

4955
### Display Options
5056

5157
- **Show Labels**: Toggle cardinal direction labels (N/E/S/W).
5258
- **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).
5362

5463
### Needle Options
5564

5665
- **Needle Type**
5766

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)
62-
- `PNG`load a custom image (provide URL or relative path)
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)
6372

6473
- **Needle Color**: Color of the primary needle.
6574
- **Tail Color**: Color of the tail (for default needle).
@@ -68,11 +77,11 @@ Optionally the panel can display true and/or apparent wind angle.
6877

6978
### Colors
7079

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.
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.
7685

7786
---
7887

@@ -94,10 +103,10 @@ _Ship silhouette needle for vessel heading visualization_
94103

95104
_Standard needle compass with custom styling_
96105

97-
![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)
98107

99108
_North up orientation for wind dial visualization_
100109

101-
![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)
102111

103112
_Bow up orientation for wind dial visualization_

0 commit comments

Comments
 (0)