winga-chart-plotter-signalk 0.1.1 → 0.1.2
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 +11 -17
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,18 +5,14 @@ A fast and reliable sea chart plotting application for [Signal K](https://signal
|
|
|
5
5
|
|
|
6
6
|
|
|
7
7
|
## Why another chart plotter for SignalK
|
|
8
|
-
Winga Chart Plotter is an experiment
|
|
8
|
+
Winga Chart Plotter is an experiment playing with WebGL technologies with the intention of building a snappy and solid chart plotter. I owe much inspiration to [Freeboard-sk](https://github.com/SignalK/freeboard-sk).
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
Winga Chart Plotter tries to be projection-agnostic. Currently, there are two projection modes: mercator and globe. Routes are great-circle by default.
|
|
13
|
-
|
|
14
|
-
Being a tool for marine navigation, Winga Chart Plotter will prioritize correctness and stability over features.
|
|
15
|
-
|
|
16
|
-
Eventually, I'd like Winga Chart Plotter not only to be a SignalK webapp, but also a mobile app with native speed.
|
|
10
|
+
Unfortunately, my sailing tablet gets laggy as soon as Freeboard has more than 30 AIS target, chart layers, waypoints or routes to show. Thus, Winga Chart Plotter is written with speed in mind, uses WASM for heavy computation and WebGL for rendering. It is projection-agnostic. Currently, there are two projection modes: mercator and globe and as soon as support for more projections lands in MapLibre, those will be integrated here as well. I'd like Winga Chart Plotter not only to be a SignalK webapp, but also a mobile app with native speed.
|
|
17
11
|
|
|
18
12
|
## Getting started
|
|
13
|
+
Install via SignalK's app store.
|
|
19
14
|
|
|
15
|
+
## Building
|
|
20
16
|
### Prerequisites
|
|
21
17
|
- [Rust](https://rustup.rs/) + `wasm32-unknown-unknown` target
|
|
22
18
|
- [wasm-pack](https://rustwasm.github.io/wasm-pack/)
|
|
@@ -55,11 +51,7 @@ cd app && npm run build:wasm && npm run build
|
|
|
55
51
|
|
|
56
52
|
`app/dist/` is a self-contained static site — serve it with any HTTP server.
|
|
57
53
|
|
|
58
|
-
**Option A —
|
|
59
|
-
|
|
60
|
-
Signal K's built-in HTTP server can host static webapps. Install via SignalK app store.
|
|
61
|
-
|
|
62
|
-
**Option B — standalone static server**
|
|
54
|
+
**Option A — standalone static server**
|
|
63
55
|
|
|
64
56
|
Any `serve`-compatible tool works:
|
|
65
57
|
```sh
|
|
@@ -67,7 +59,7 @@ npx serve app/dist
|
|
|
67
59
|
# or nginx, caddy, etc.
|
|
68
60
|
```
|
|
69
61
|
|
|
70
|
-
**Option
|
|
62
|
+
**Option B — install as PWA**
|
|
71
63
|
|
|
72
64
|
With the dev server or any of the above servers running, open the app in Chrome/Edge/Firefox and use "Add to Home Screen" / "Install app".
|
|
73
65
|
|
|
@@ -78,7 +70,8 @@ cargo test
|
|
|
78
70
|
```
|
|
79
71
|
|
|
80
72
|
## Design
|
|
81
|
-
Do one task, do it good. This means that some features might be left to other layers. E.g. notification and alarm management as well as instrument might be left to KIP.
|
|
73
|
+
Do one task, do it good. This means that some features might be left to other layers. E.g. notification and alarm management as well as instrument might be left to KIP. Being a tool for marine navigation, Winga Chart Plotter will prioritize correctness and stability over features.
|
|
74
|
+
|
|
82
75
|
|
|
83
76
|
See [`KNOWLEDGE_BASE.md`](./KNOWLEDGE_BASE.md) for full architecture decisions, user stories, and open questions.
|
|
84
77
|
|
|
@@ -90,14 +83,15 @@ See [`KNOWLEDGE_BASE.md`](./KNOWLEDGE_BASE.md) for full architecture decisions,
|
|
|
90
83
|
- Great-circle lines for measurements, tracks and routes
|
|
91
84
|
- Highly customizable appearance
|
|
92
85
|
- 3D mode
|
|
93
|
-
- Process SignalK deltas as they arrive
|
|
86
|
+
- Process SignalK deltas as they arrive
|
|
94
87
|
- Multiple, permanent and sticky rulers
|
|
95
|
-
- AIS dead reckoning (honoring rate-of-turn and at
|
|
88
|
+
- AIS dead reckoning (honoring rate-of-turn and at 30fps, whoever this needs)
|
|
96
89
|
|
|
97
90
|
## Missing features compared to Freeboard
|
|
98
91
|
- S57 support (planned)
|
|
99
92
|
- Alarm management
|
|
100
93
|
- Anchor (planned)
|
|
94
|
+
- Many many more
|
|
101
95
|
|
|
102
96
|
## Roadmap
|
|
103
97
|
|