signalk-racer 0.9.0 → 0.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.MD +18 -19
- package/package.json +1 -1
package/README.MD
CHANGED
|
@@ -10,17 +10,17 @@ GitHub repository: [https://github.com/gregw/signalk-racer](https://github.com/g
|
|
|
10
10
|
|
|
11
11
|
This plugin calculates and publishes the following Signal K paths:
|
|
12
12
|
|
|
13
|
-
| Path | Description | Units |
|
|
14
|
-
|
|
15
|
-
| `navigation.racing
|
|
16
|
-
| `navigation.racing
|
|
17
|
-
| `navigation.racing
|
|
18
|
-
| `navigation.racing
|
|
19
|
-
| `navigation.racing
|
|
20
|
-
| `navigation.racing
|
|
21
|
-
| `navigation.racing
|
|
22
|
-
| `navigation.racing
|
|
23
|
-
| `navigation.racing
|
|
13
|
+
| Path | Description | Units | Schema |
|
|
14
|
+
|---------------------------------------------|--------------------------------------------------------|---------|--------|
|
|
15
|
+
| `navigation.racing.`<br/>`distanceStartline` | Signed minimum distance from the bow to the start line | `m` | Y |
|
|
16
|
+
| `navigation.racing.`<br/>`startLineLength` | Total length of the start line | `m` | |
|
|
17
|
+
| `navigation.racing.`<br/>`stbLineBias` | Bias of the start line toward the starboard end | `m` | |
|
|
18
|
+
| `navigation.racing.`<br/>`startLinePort.latitude` | Latitude of the port (pin) end of the start line | `deg` | Y |
|
|
19
|
+
| `navigation.racing.`<br/>`startLinePort.longitude` | Longitude of the port end | `deg` | Y |
|
|
20
|
+
| `navigation.racing.`<br/>`startLineStb.latitude` | Latitude of the starboard (boat) end of the start line | `deg` | Y |
|
|
21
|
+
| `navigation.racing.`<br/>`startLineStb.longitude` | Longitude of the starboard end | `deg` | Y |
|
|
22
|
+
| `navigation.racing.`<br/>`nextLegHeading` | True heading for the next leg of the course | `deg` | |
|
|
23
|
+
| `navigation.racing.`<br/>`nextLegTWA` | True Wind Angle for the next leg of the course | `deg` | |
|
|
24
24
|
|
|
25
25
|
These values can be displayed in KIP, Freeboard-SK, or other Signal K clients.
|
|
26
26
|
|
|
@@ -44,16 +44,15 @@ You can configure the plugin via the Signal K web interface or by editing `setti
|
|
|
44
44
|
|
|
45
45
|
## 🧠 Algorithm Descriptions
|
|
46
46
|
|
|
47
|
-
###
|
|
47
|
+
### Waypoint selection (`navigation.racing.startLinePort` and `navigation.racing.startLineStb`)
|
|
48
48
|
|
|
49
|
-
The `startLineStb` and `startLinePort` configurations are used to search resources for matching waypoints.
|
|
50
|
-
These waypoints can be modified in real time (e.g. moving or setting in Freeboard SK) and the algorithm with update to the new line.
|
|
49
|
+
The `startLineStb` and `startLinePort` configurations are used to search resources for matching waypoints. These waypoints can be modified in real time (e.g. moving or setting in Freeboard SK) and the algorithm with update to the new line.
|
|
51
50
|
|
|
52
|
-
###
|
|
51
|
+
### Bow position
|
|
53
52
|
|
|
54
53
|
If `navigation.headingTrue` is not available, then `navigation.courseOverGroundTrue` is used when determining the position of the bow relative to the GPS position.
|
|
55
54
|
|
|
56
|
-
###
|
|
55
|
+
### Distance to Start Line (`navigation.racing.distanceStartline`)
|
|
57
56
|
|
|
58
57
|
- Computes the **signed minimum distance** from the **bow** of the boat to the configured start line.
|
|
59
58
|
- Uses `sensors.gps.fromBow` and `sensors.gps.fromCenter` offsets to calculate the actual bow position.
|
|
@@ -63,20 +62,20 @@ If `navigation.headingTrue` is not available, then `navigation.courseOverGroundT
|
|
|
63
62
|
- **Negative** when the bow is **over the line (OCS)**
|
|
64
63
|
- **Positive** when the bow is **behind the line**
|
|
65
64
|
|
|
66
|
-
###
|
|
65
|
+
### Start Line Bias (`navigation.racing.stbLineBias`)
|
|
67
66
|
|
|
68
67
|
- Measures how far ahead (downwind) the **pin** end is relative to the **boat** end.
|
|
69
68
|
- The `environment.wind.directionTrue` is used as well as the calculated line length and bearing.
|
|
70
69
|
- A **positive value** means the **pin end is more downwind**, implying the **starboard (boat) end is favored** for upwind starts.
|
|
71
70
|
|
|
72
|
-
###
|
|
71
|
+
### Line Coordinates & Length
|
|
73
72
|
|
|
74
73
|
- The plugin reads Signal K `waypoints` resources for the names you configure.
|
|
75
74
|
- If both endpoints are found, it calculates:
|
|
76
75
|
- Line length (using `geolib.getPreciseDistance`)
|
|
77
76
|
- Line bearing (rhumb line from starboard to port)
|
|
78
77
|
|
|
79
|
-
|
|
78
|
+
### Next Leg
|
|
80
79
|
- If a course is active then the true bearing for the next leg is calculated as `navigation.racing.nextLegHeading`
|
|
81
80
|
- If the `environment.wind.directionTrue` is available, then the True Wind Angle for the next leg is also calculated as `navigation.racing.nextLegHeading`
|
|
82
81
|
- If the next mark of the active route is beyond the first mark, then the start line calculations are suspended.
|