signalk-polar-performance-plugin 0.0.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/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,42 @@
1
+ # Polar performance plugin
2
+ Generate performance information based on a polar diagram.
3
+
4
+ ## Data correctness
5
+ It's assumed data is already corrected when it's read by this plugin. This can be sometimes be done by the sensor, sometimes upon entry into SignalK using the (calibration plugin)[https://www.npmjs.com/package/@signalk/calibration].
6
+
7
+ ## Data sources
8
+ The following paths are read
9
+ - navigation.speedThroughWater
10
+ - environment.wind.speedTrue
11
+ - environment.wind.angleTrueWater
12
+
13
+ ## Polar diagram
14
+ For starters, use the plugin config to set one polar diagram.
15
+ Simple interpolation will be used to get the corresponding values from the polar diagram info.
16
+ For polar diagrams you can check (ORC sailboat data)[https://jieter.github.io/orc-data/site/].
17
+
18
+ ## Calculated performance data
19
+ The following data is calculated
20
+ - Upwind / beat angle (performance.beatAngle)
21
+ - Downwind / run / gybe angle (performance.gybeAngle)
22
+ - Upwind / beat VMG (performance.beatAngleVelocityMadeGood)
23
+ - Downwind / run / gybe VMG (performance.gybeAngleVelocityMadeGood)
24
+ - Target TWA (performance.targetAngle)
25
+ - Optimal Wind Angle (diff between TWA and environment.wind.directionTrue)
26
+ - Polar Boat Speed (performance.polarSpeed)
27
+ - Polar Speed Ratio (performance.polarSpeedRatio)
28
+
29
+ ## To-do list
30
+ - Fill up the ends of the polar diagram
31
+ - A switch to use SOG as boat speed
32
+ - Wind angle for maximum speed at this wind speed
33
+ - Improved interpolation
34
+ - Make moment to do calculation smarter/configurable
35
+ - Create polar from live data
36
+ -- Save polar info to file
37
+ -- Save new record speed for angle in polar
38
+ -- Determine if we're on a steady course to avoid fake records
39
+ -- Dampening algoritms
40
+ -- Configure the resolution of the polar diagram
41
+ - Capture heel in polar diagram
42
+ - Visualisation of the polar diagram
package/package.json ADDED
@@ -0,0 +1,24 @@
1
+ {
2
+ "name": "signalk-polar-performance-plugin",
3
+ "version": "0.0.1",
4
+ "description": "A plugin that calculates performance information based on a (CSV) polar diagram.",
5
+ "main": "plugin/index.js",
6
+ "scripts": {
7
+ "test": "echo \"Error: no test specified\" && exit 1"
8
+ },
9
+ "repository": {
10
+ "type": "git",
11
+ "url": "git+https://github.com/htool/signalk-polar-performance-plugin.git"
12
+ },
13
+ "author": "hans@defect.org",
14
+ "license": "ISC",
15
+ "bugs": {
16
+ "url": "https://github.com/htool/signalk-polar-performance-plugin/issues"
17
+ },
18
+ "homepage": "https://github.com/htool/signalk-polar-performance-plugin#readme",
19
+ "keywords": [
20
+ "signalk-node-server-plugin",
21
+ "signalk-category-instruments",
22
+ "signalk-category-chart-plotters"
23
+ ]
24
+ }
@@ -0,0 +1,371 @@
1
+ var sourceAddress
2
+
3
+ module.exports = function (app) {
4
+ var plugin = {}
5
+ var unsubscribes = []
6
+ var timers = []
7
+
8
+ plugin.id = 'signalk-polar-performance-plugin'
9
+ plugin.name = 'Polar performance plugin'
10
+ plugin.description = 'A plugin that calculates performance information based on a (CSV) polar diagram.'
11
+
12
+ plugin.uiSchema = {
13
+ csvTable: { "ui:widget": "textarea" }
14
+ }
15
+
16
+ var schema = {
17
+ // The plugin schema
18
+ properties: {
19
+ beatAngle: {
20
+ type: 'boolean',
21
+ title: 'Enable calculation of beat/upwind and run/gybe/downwind angle'
22
+ },
23
+ beatVMG: {
24
+ type: 'boolean',
25
+ title: 'Enable calculation of beat/upwind and run/gybe/downwind VMG'
26
+ },
27
+ optimalWindAngle: {
28
+ type: 'boolean',
29
+ title: 'Enable calculation of Optimal Wind Angle (difference between TWA and beat/run angle (depends on beat/run angle)'
30
+ },
31
+ csvTable: {
32
+ type: "string",
33
+ title: "Enter csv with polar in http://jieter.github.io/orc-data/site/ style."
34
+ }
35
+ }
36
+ }
37
+
38
+ plugin.schema = function() {
39
+ // updateSchema()
40
+ return schema
41
+ }
42
+
43
+
44
+ plugin.start = function (options, restartPlugin) {
45
+ // Here we put our plugin logic
46
+ app.debug('Plugin started');
47
+ var unsubscribes = [];
48
+ app.debug('Options: %s', JSON.stringify(options))
49
+
50
+ // Load polar table
51
+ var polar = csvToPolarObject(options.csvTable)
52
+ app.debug('polar: %s', JSON.stringify(polar))
53
+
54
+ // Global variables
55
+ var BSP, STW, TWA, TWS, port // Angles in rad, speed in m/s
56
+ var Pi = Math.PI
57
+ var halfPi = Pi / 2
58
+
59
+ // Subscribe to paths
60
+ let localSubscription = {
61
+ context: '*',
62
+ subscribe: [
63
+ {
64
+ path: 'navigation.speedThroughWater',
65
+ policy: 'instant'
66
+ },
67
+ {
68
+ path: 'environment.wind.speedTrue',
69
+ policy: 'instant'
70
+ },
71
+ {
72
+ path: 'environment.wind.angleTrueWater',
73
+ policy: 'instant'
74
+ }
75
+ ]
76
+ }
77
+
78
+ app.subscriptionmanager.subscribe(
79
+ localSubscription,
80
+ unsubscribes,
81
+ subscriptionError => {
82
+ app.error('Error:' + subscriptionError);
83
+ },
84
+ delta => {
85
+ delta.updates.forEach(u => {
86
+ // app.debug(u.values)
87
+ handleDelta(u.values)
88
+ })
89
+ }
90
+ )
91
+
92
+ // Handle delta
93
+ function handleDelta (deltas) {
94
+ deltas.forEach(delta => {
95
+ // app.debug('handleData: %s', JSON.stringify(delta))
96
+ if (delta.path == 'navigation.speedThroughWater') {
97
+ STW = delta.value
98
+ BSP = STW
99
+ // app.debug('speedThroughWater (STW): %d', STW)
100
+ } else if (delta.path == 'environment.wind.speedTrue') {
101
+ TWS = delta.value
102
+ // app.debug('environment.wind.speedTrue (TWS): %d', TWS)
103
+ app.debug('TWS: %d TWA: %d BSP: %d', TWS, TWA, BSP)
104
+ sendUpdates(getPerformanceData(TWS, TWA, BSP))
105
+ } else if (delta.path == 'environment.wind.angleTrueWater') {
106
+ if (delta.value < 0) {
107
+ port = -1
108
+ } else {
109
+ port = 1
110
+ }
111
+ TWA = Math.abs(delta.value)
112
+ // app.debug('environment.wind.angleTrueWater (TWA): %d', TWA)
113
+ }
114
+ })
115
+ }
116
+
117
+ function sendUpdates (perfObj) {
118
+ let values = []
119
+ let metas = []
120
+ if (typeof perfObj.beatAngle != 'undefined') {
121
+ values.push({path: 'performance.beatAngle', value: roundDec(perfObj.beatAngle)})
122
+ values.push({path: 'performance.targetAngle', value: roundDec(perfObj.beatAngle)})
123
+ }
124
+ if (typeof perfObj.beatVMG != 'undefined') {
125
+ values.push({path: 'performance.beatAngleVelocityMadeGood', value: roundDec(perfObj.beatVMG)})
126
+ }
127
+ if (typeof perfObj.runAngle != 'undefined') {
128
+ values.push({path: 'performance.gybeAngle', value: roundDec(perfObj.runAngle)})
129
+ values.push({path: 'performance.targetAngle', value: roundDec(perfObj.runAngle)})
130
+ }
131
+ if (typeof perfObj.runVMG != 'undefined') {
132
+ values.push({path: 'performance.gybeAngleVelocityMadeGood', value: roundDec(perfObj.runVMG)})
133
+ }
134
+ if (typeof perfObj.optimalWindAngle != 'undefined') {
135
+ values.push({path: 'performance.optimalWindAngle', value: roundDec(perfObj.optimalWindAngle)})
136
+ metas.push({path: 'performance.optimalWindAngle', value: {"units": "rad"}})
137
+ }
138
+ if (typeof perfObj.targetSpeed != 'undefined') {
139
+ values.push({path: 'performance.targetSpeed', value: roundDec(perfObj.targetSpeed)})
140
+ }
141
+ if (typeof perfObj.polarSpeed != 'undefined') {
142
+ values.push({path: 'performance.polarSpeed', value: roundDec(perfObj.polarSpeed)})
143
+ values.push({path: 'performance.polarSpeedRatio', value: roundDec(perfObj.polarSpeedRatio)})
144
+ }
145
+
146
+ app.debug('sendUpdates: %s', JSON.stringify(values))
147
+ app.handleMessage(plugin.id, {
148
+ updates: [
149
+ {
150
+ values: values,
151
+ meta: metas
152
+ }
153
+ ]
154
+ })
155
+ }
156
+
157
+ function getPerformanceData (TWS, TWA, BSP) {
158
+ var performance = {}
159
+ // Use windspeed to find nearest speeds
160
+ for (let indexTWS = 0 ; indexTWS < polar.length-1; indexTWS++) {
161
+ let lower = polar[indexTWS].tws
162
+ let upper = polar[indexTWS+1].tws
163
+ if (TWS >= lower && TWS <= upper) {
164
+ //app.debug('TWS between %d and %d', lower, upper)
165
+ // Calculate gap ratio
166
+ let gap = upper - lower
167
+ let twsGapRatio = (1 / gap) * (TWS - lower)
168
+ //app.debug('twsGapRatio: %d', twsGapRatio)
169
+ // Calculate beat/run angle
170
+ if (TWA < halfPi) {
171
+ // app.debug('Upwind')
172
+ if (options.beatAngle == true) {
173
+ // Calculate beat angle
174
+ let beatLower = polar[indexTWS]['Beat angle']
175
+ let beatUpper = polar[indexTWS+1]['Beat angle']
176
+ performance.beatAngle = beatLower + ((beatUpper - beatLower) * twsGapRatio)
177
+ }
178
+ // Calculate optimal wind angle
179
+ if (options.optimalWindAngle == true) {
180
+ performance.optimalWindAngle = performance.beatAngle - TWA * port
181
+ }
182
+ // Calculate beat VMG
183
+ if (options.beatVMG == true) {
184
+ let VMGLower = polar[indexTWS]['Beat VMG']
185
+ let VMGUpper = polar[indexTWS+1]['Beat VMG']
186
+ performance.beatVMG = VMGLower + ((VMGUpper - VMGLower) * twsGapRatio)
187
+ }
188
+ } else {
189
+ // app.debug('Downwind')
190
+ if (options.beatAngle == true) {
191
+ // Calculate run angle
192
+ let runLower = polar[indexTWS]['Run angle']
193
+ let runUpper = polar[indexTWS+1]['Run angle']
194
+ //app.debug('runLower: %s runUpper: %s', runLower, runUpper)
195
+ performance.runAngle = runLower + ((runUpper - runLower) * twsGapRatio)
196
+ }
197
+ if (options.optimalWindAngle == true) {
198
+ // Calculate optimal wind angle
199
+ performance.optimalWindAngle = performance.runAngle - TWA * port
200
+ }
201
+ if (options.beatVMG == true) {
202
+ // Calculate run VMG
203
+ let VMGLower = polar[indexTWS]['Run VMG']
204
+ let VMGUpper = polar[indexTWS+1]['Run VMG']
205
+ //app.debug('VMGLower: %s VMGUpper: %s', VMGLower, VMGUpper)
206
+ performance.runVMG = VMGLower + ((VMGUpper - VMGLower) * twsGapRatio)
207
+ }
208
+ }
209
+ // Calculate polar target boat speed
210
+
211
+ // Define the 4 near data points
212
+ let lowerTWA = polar[indexTWS].twa
213
+ let upperTWA = polar[indexTWS+1].twa
214
+ // app.debug('TWAlower: %s', JSON.stringify(TWAlower))
215
+ for (let indexTWA = 0 ; indexTWA < lowerTWA.length-1; indexTWA++) {
216
+ let lowerTWAlower = lowerTWA[indexTWA]
217
+ let lowerTWAupper = lowerTWA[indexTWA+1]
218
+ let upperTWAlower = upperTWA[indexTWA]
219
+ let upperTWAupper = upperTWA[indexTWA+1]
220
+
221
+ // app.debug('lowerTWAlower: %s lowerTWAupper: %s', lowerTWAlower, lowerTWAupper)
222
+ if (TWA >= lowerTWAlower.twa && TWA <= lowerTWAupper.twa) {
223
+ // app.debug('lowerTWAlower: %d TWA: %d lowerTWAupper: %d', lowerTWAlower.twa, TWA, lowerTWAupper.twa)
224
+ // Calculate gap ratio
225
+ let gap = lowerTWAupper.twa - lowerTWAlower.twa
226
+ let twaGapRatio = (1 / gap) * (TWA - lowerTWAlower.twa)
227
+ // app.debug('twaGapRatio: %d', twaGapRatio)
228
+ // Calculate lower tws boat speed
229
+ let lowerTBS = lowerTWAlower.tbs + ((lowerTWAupper.tbs - lowerTWAlower.tbs) * twaGapRatio)
230
+ // Calculate upper tws boat speed
231
+ let upperTBS = upperTWAlower.tbs + ((upperTWAupper.tbs - upperTWAlower.tbs) * twaGapRatio)
232
+
233
+ // Calculate target boat speed
234
+ performance.polarSpeed = lowerTBS + ((upperTBS - lowerTBS) * twsGapRatio)
235
+ // app.debug('lowerTBS: %d TBS: %d upperTBS: %d', lowerTBS, performance.polarSpeed, upperTBS)
236
+
237
+ // Calculate polar performance
238
+ performance.polarSpeedRatio = (1 / performance.polarSpeed) * BSP
239
+
240
+ }
241
+ }
242
+
243
+ // Calculate polar performance ratio
244
+ } else {
245
+ // app.debug('%d not >= %d && <= %d', TWS, lower, upper)
246
+ }
247
+ }
248
+ return performance
249
+ }
250
+
251
+ function csvToPolarObject (csv) {
252
+ var csvArray = []
253
+ var polar = {}
254
+ var beat = false
255
+
256
+ // Create array of arrays from csv
257
+ csv.split('\n').forEach(row => {
258
+ csvArray.push(row.split(';'))
259
+ })
260
+ // app.debug('csvArray: %s', JSON.stringify(csvArray))
261
+
262
+ // Populate the polar object from CSV rows
263
+ csvArray.forEach(row => {
264
+ if (row[0] == 'twa/tws') {
265
+ // The row with TWS columns
266
+ // Create empty TWS objects in polar object
267
+ polar = []
268
+ for (let index = 1; index < row.length; index++) {
269
+
270
+ let twsObj = {'tws': ktsToMs(row[index])} // CSV kts to internal m/s
271
+ polar.push(twsObj)
272
+ }
273
+ app.debug('polar: %s', JSON.stringify(polar))
274
+ } else if (row[0] == '0') {
275
+ app.debug('beat and run angles are included')
276
+ } else if (row.includes('0')) {
277
+ // Beat / Run angle
278
+ let angle = Number(row[0])
279
+ let angleName
280
+ let VMGName
281
+ if (angle < 90) {
282
+ angleName = 'Beat angle'
283
+ VMGName = 'Beat VMG'
284
+ } else {
285
+ angleName = 'Run angle'
286
+ VMGName = 'Run VMG'
287
+ }
288
+ for (let index = 1; index < row.length; index++) {
289
+ if (row[index] != 0) {
290
+ polar[index-1][angleName] = degToRad(angle)
291
+ polar[index-1][VMGName] = roundDec(Number((row[index]) * Math.abs(Math.cos(angle))))
292
+ app.debug('polar[index-1]: %s', polar[index-1])
293
+ if (typeof polar[index-1]['twa'] == 'undefined') {
294
+ polar[index-1]['twa'] = []
295
+ }
296
+ app.debug('polar[index-1]: %s', polar[index-1])
297
+ app.debug('Adding TargetBoatSpeed')
298
+ let Obj = {"twa": degToRad(angle), "tbs": ktsToMs(Number(row[index]))}
299
+ app.debug('Obj: %s', JSON.stringify(Obj))
300
+ polar[index-1]['twa'] = polar[index-1]['twa'].concat(Obj)
301
+ app.debug('polar[index-1]["twa"]: %s', polar[index-1]['twa'])
302
+ app.debug('polar: %s', JSON.stringify(polar))
303
+ }
304
+ }
305
+ } else {
306
+ // Normal line
307
+ let angle = degToRad(Number(row[0])) // CSV deg to internal rad
308
+ for (let index = 1; index < row.length; index++) {
309
+ if (typeof polar[index-1].twa == 'undefined') {
310
+ polar[index-1].twa = []
311
+ }
312
+ let Obj = {"twa": angle, "tbs": ktsToMs(Number(row[index]))}
313
+ polar[index-1]['twa'] = polar[index-1]['twa'].concat(Obj)
314
+ app.debug('polar: %s', JSON.stringify(polar))
315
+ }
316
+ }
317
+ })
318
+
319
+ // Sort the twa arrays by angle
320
+ polar.forEach(tws => {
321
+ let twaArray = tws.twa
322
+ twaArray = twaArray.sort((a, b) => a.twa - b.twa)
323
+ // app.debug('twaArray sorted: %s', JSON.stringify(twaArray))
324
+ tws.twa = twaArray
325
+ })
326
+
327
+ // app.debug(JSON.stringify(polar))
328
+ return (polar)
329
+ }
330
+
331
+
332
+ }
333
+
334
+
335
+ plugin.stop = function () {
336
+ // Here we put logic we need when the plugin stops
337
+ app.debug('Plugin stopped');
338
+ plugin.stop = function () {
339
+ unsubscribes.forEach(f => f());
340
+ unsubscribes = [];
341
+ timers.forEach(timer => {
342
+ clearInterval(timer)
343
+ })
344
+ };
345
+
346
+ };
347
+
348
+ return plugin;
349
+ };
350
+
351
+
352
+ function radToDeg(radians) {
353
+ return radians * 180 / Math.PI
354
+ }
355
+
356
+ function degToRad(degrees) {
357
+ return degrees * (Math.PI/180.0)
358
+ }
359
+
360
+ function ktsToMs(knots) {
361
+ return knots / 1.94384
362
+ }
363
+
364
+ function MsToKts(ms) {
365
+ return ms * 1.94384
366
+ }
367
+
368
+ function roundDec (value) {
369
+ value = Number(value.toFixed(3))
370
+ return value
371
+ }