Deploy reworking, Windows edition.
[VOID.git] / VOID_DataLogger.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
// VOID
//
// VOID_DataLogger.cs
//
// Copyright © 2014, toadicus
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation and/or other
//    materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors may be used
//    to endorse or promote products derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
using KSP;
using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
using ToadicusTools;
using UnityEngine;
 
namespace VOID
{
        public class VOID_DataLogger : VOID_WindowModule, IVOID_BehaviorModule
        {
                /*
                 * Fields
                 * */
                protected bool stopwatch1_running;
 
                protected bool _loggingActive;
                protected bool first_write;
 
                protected double stopwatch1;
 
                protected string csv_log_interval_str;
 
                protected float csv_log_interval;
 
                protected double csvCollectTimer;
 
                protected System.Text.UTF8Encoding utf8Encoding;
                protected FileStream _outputFile;
 
                protected uint outstandingWrites;
 
                protected List<string> csvList = new List<string>();
 
                /*
                 * Properties
                 * */
                // TODO: Add configurable or incremental file names.
                protected bool loggingActive
                {
                        get
                        {
                                return this._loggingActive;
                        }
                        set
                        {
                                if (value != this._loggingActive)
                                {
                                        if (value)
                                        {
 
                                        }
                                        else
                                        {
                                                if (this._outputFile != null)
                                                {
                                                        Tools.DebugLogger logger = Tools.DebugLogger.New(this);
 
                                                        logger.Append("CSV logging disabled, ");
 
                                                        logger.Append("disposing file.");
                                                        logger.Print();
                                                        this.outputFile.Dispose();
                                                        this._outputFile = null;
                                                }
                                        }
 
                                        this._loggingActive = value;
                                }
                        }
                }
                protected string fileName
                {
                        get
                        {
                                return KSP.IO.IOUtils.GetFilePathFor(
                                        typeof(VOID_Core),
                                        string.Format(
                                                "{0}_{1}",
                                                this.vessel.vesselName,
                                                "data.csv"
                                        ),
                                        null
                                );
                        }
                }
 
                protected FileStream outputFile
                {
                        get
                        {
                                if (this._outputFile == null)
                                {
                                        Tools.DebugLogger logger = Tools.DebugLogger.New(this);
                                        logger.AppendFormat("Initializing output file '{0}' with mode ", this.fileName);
 
                                        if (File.Exists(this.fileName))
                                        {
                                                logger.Append("append");
                                                this._outputFile = new FileStream(this.fileName, FileMode.Append, FileAccess.Write, FileShare.Write, 512, true);
                                        }
                                        else
                                        {
                                                logger.Append("create");
                                                this._outputFile = new FileStream(this.fileName, FileMode.Create, FileAccess.Write, FileShare.Write, 512, true);
 
                                                byte[] bom = utf8Encoding.GetPreamble();
 
                                                logger.Append(" and writing preamble");
                                                outputFile.Write(bom, 0, bom.Length);
                                        }
 
                                        logger.Append('.');
                                        logger.Print();
                                }
 
                                return this._outputFile;
                        }
                }
 
                /*
                 * Methods
                 * */
                public VOID_DataLogger()
                {
                        this._Name = "CSV Data Logger";
 
                        this.stopwatch1_running = false;
 
                        this.loggingActive = false;
                        this.first_write = true;
 
                        this.stopwatch1 = 0;
                        this.csv_log_interval_str = "0.5";
 
                        this.csvCollectTimer = 0;
                        this.outstandingWrites = 0;
 
                        this.WindowPos.x = Screen.width - 520;
                        this.WindowPos.y = 85;
                }
 
                public override void ModuleWindow(int _)
                {
                        GUIStyle txt_white = new GUIStyle(GUI.skin.label);
                        txt_white.normal.textColor = txt_white.focused.textColor = Color.white;
                        txt_white.alignment = TextAnchor.UpperRight;
                        GUIStyle txt_green = new GUIStyle(GUI.skin.label);
                        txt_green.normal.textColor = txt_green.focused.textColor = Color.green;
                        txt_green.alignment = TextAnchor.UpperRight;
                        GUIStyle txt_yellow = new GUIStyle(GUI.skin.label);
                        txt_yellow.normal.textColor = txt_yellow.focused.textColor = Color.yellow;
                        txt_yellow.alignment = TextAnchor.UpperRight;
 
                        GUILayout.BeginVertical();
 
                        GUILayout.Label("System time: " + DateTime.Now.ToString("HH:mm:ss"));
                        GUILayout.Label(VOID_Tools.ConvertInterval(stopwatch1));
 
                        GUILayout.BeginHorizontal(GUILayout.ExpandWidth(true));
                        if (GUILayout.Button("Start"))
                        {
                                if (stopwatch1_running == false) stopwatch1_running = true;
                        }
                        if (GUILayout.Button("Stop"))
                        {
                                if (stopwatch1_running == true) stopwatch1_running = false;
                        }
                        if (GUILayout.Button("Reset"))
                        {
                                if (stopwatch1_running == true) stopwatch1_running = false;
                                stopwatch1 = 0;
                        }
                        GUILayout.EndHorizontal();
 
                        GUIStyle label_style = txt_white;
                        string log_label = "Inactive";
                        if (loggingActive && vessel.situation.ToString() == "PRELAUNCH")
                        {
                                log_label = "Awaiting launch";
                                label_style = txt_yellow;
                        }
                        if (loggingActive && vessel.situation.ToString() != "PRELAUNCH")
                        {
                                log_label = "Active";
                                label_style = txt_green;
                        }
                        GUILayout.BeginHorizontal(GUILayout.ExpandWidth(true));
                        this.loggingActive = GUILayout.Toggle(loggingActive, "Data logging: ", GUILayout.ExpandWidth(false));
 
                        GUILayout.Label(log_label, label_style, GUILayout.ExpandWidth(true));
                        GUILayout.EndHorizontal();
 
                        GUILayout.BeginHorizontal(GUILayout.ExpandWidth(true));
                        GUILayout.Label("Interval: ", GUILayout.ExpandWidth(false));
                        csv_log_interval_str = GUILayout.TextField(csv_log_interval_str, GUILayout.ExpandWidth(true));
                        GUILayout.Label("s", GUILayout.ExpandWidth(false));
                        GUILayout.EndHorizontal();
 
                        float new_log_interval;
                        if (float.TryParse(csv_log_interval_str, out new_log_interval))
                        {
                                csv_log_interval = new_log_interval;
                        }
 
                        GUILayout.EndVertical();
                        GUI.DragWindow();
                }
 
                public void Update()
                {
                        // CSV Logging
                        // from ISA MapSat
                        if (loggingActive)
                        {
                                //data logging is on
                                //increment timers
                                csvCollectTimer += Time.deltaTime;
 
                                if (csvCollectTimer >= csv_log_interval && vessel.situation != Vessel.Situations.PRELAUNCH)
                                {
                                        //data logging is on, vessel is not prelaunch, and interval has passed
                                        //write a line to the list
                                        line_to_csvList();  //write to the csv
                                }
 
                                if (csvList.Count > 0)
                                {
                                        // csvList is not empty and interval between writings to file has elapsed
                                        //write it
 
                                        // Tools.PostDebugMessage("")
 
                                        this.AsyncWriteData();
                                }
                        }
                        else
                        {
                                //data logging is off
                                //reset any timers and clear anything from csvList
                                csvCollectTimer = 0f;
                                if (csvList.Count > 0) csvList.Clear();
                        }
 
                        if (stopwatch1_running)
                        {
                                stopwatch1 += Time.deltaTime;
                        }
                }
 
                public void FixedUpdate() {}
 
                public void OnDestroy()
                {
                        Tools.DebugLogger logger = Tools.DebugLogger.New(this);
 
                        logger.Append("Destroying...");
 
                        if (this.csvList.Count > 0)
                        {
                                logger.Append(" Writing final data...");
                                this.AsyncWriteData();
                        }
 
                        while (this.outstandingWrites > 0)
                        {
                                System.Threading.Thread.Sleep(10);
                        }
 
                        if (this._outputFile != null)
                        {
                                logger.Append(" Closing File...");
                                this.outputFile.Close();
                        }
 
                        logger.Append(" Done.");
                        logger.Print();
                }
 
                ~VOID_DataLogger()
                {
                        this.OnDestroy();
                }
 
                protected void AsyncWriteCallback(IAsyncResult result)
                {
                        Tools.PostDebugMessage(this, "Got async callback, IsCompleted = {0}", result.IsCompleted);
 
                        this.outputFile.EndWrite(result);
                        this.outstandingWrites--;
                }
 
                private void AsyncWriteData()
                {
                        if (this.utf8Encoding == null)
                        {
                                this.utf8Encoding = new System.Text.UTF8Encoding(true, true);
                        }
 
                        List<byte> bytes = new List<byte>();
 
                        foreach (string line in this.csvList)
                        {
                                byte[] lineBytes = utf8Encoding.GetBytes(line);
                                bytes.AddRange(lineBytes);
                        }
 
                        WriteState state = new WriteState();
 
                        state.bytes = bytes.ToArray();
                        state.stream = this.outputFile;
 
                        this.outstandingWrites++;
                        var writeCallback = new AsyncCallback(this.AsyncWriteCallback);
 
                        this.outputFile.BeginWrite(state.bytes, 0, state.bytes.Length, writeCallback, state);
 
                        this.csvList.Clear();
                }
 
                private void line_to_csvList()
                {
                        //called if logging is on and interval has passed
                        //writes one line to the csvList
 
                        StringBuilder line = new StringBuilder();
 
                        if (first_write)
                        {
                                first_write = false;
                                line.Append(
                                        "\"Mission Elapsed Time (s)\t\"," +
                                        "\"Altitude ASL (m)\"," +
                                        "\"Altitude above terrain (m)\"," +
                                        "\"Surface Latitude (°)\"," +
                                        "\"Surface Longitude (°)\"," +
                                        "\"Orbital Velocity (m/s)\"," +
                                        "\"Surface Velocity (m/s)\"," +
                                        "\"Vertical Speed (m/s)\"," +
                                        "\"Horizontal Speed (m/s)\"," +
                                        "\"Gee Force (gees)\"," +
                                        "\"Temperature (°C)\"," +
                                        "\"Gravity (m/s²)\"," +
                                        "\"Atmosphere Density (g/m³)\"," +
                                        "\"Downrange Distance  (m)\"," +
                                        "\n"
                                );
                        }
 
                        //Mission time
                        line.Append(vessel.missionTime.ToString("F3"));
                        line.Append(',');
 
                        //Altitude ASL
                        line.Append(vessel.orbit.altitude.ToString("F3"));
                        line.Append(',');
 
                        //Altitude (true)
                        double alt_true = vessel.orbit.altitude - vessel.terrainAltitude;
                        if (vessel.terrainAltitude < 0) alt_true = vessel.orbit.altitude;
                        line.Append(alt_true.ToString("F3"));
                        line.Append(',');
 
                        // Surface Latitude
                        line.Append('"');
                        line.Append(VOID_Data.surfLatitude.Value);
                        line.Append('"');
                        line.Append(',');
 
                        // Surface Longitude
                        line.Append('"');
                        line.Append(VOID_Data.surfLongitude.Value);
                        line.Append('"');
                        line.Append(',');
 
                        //Orbital velocity
                        line.Append(vessel.orbit.vel.magnitude.ToString("F3"));
                        line.Append(',');
 
                        //surface velocity
                        line.Append(vessel.srf_velocity.magnitude.ToString("F3"));
                        line.Append(',');
 
                        //vertical speed
                        line.Append(vessel.verticalSpeed.ToString("F3"));
                        line.Append(',');
 
                        //horizontal speed
                        line.Append(vessel.horizontalSrfSpeed.ToString("F3"));
                        line.Append(',');
 
                        //gee force
                        line.Append(vessel.geeForce.ToString("F3"));
                        line.Append(',');
 
                        //temperature
                        line.Append(vessel.flightIntegrator.getExternalTemperature().ToString("F2"));
                        line.Append(',');
 
                        //gravity
                        double r_vessel = vessel.mainBody.Radius + vessel.mainBody.GetAltitude(vessel.findWorldCenterOfMass());
                        double g_vessel = (VOID_Core.Constant_G * vessel.mainBody.Mass) / (r_vessel * r_vessel);
                        line.Append(g_vessel.ToString("F3"));
                        line.Append(',');
 
                        //atm density
                        line.Append((vessel.atmDensity * 1000).ToString("F3"));
                        line.Append(',');
 
                        // Downrange Distance
                        line.Append((VOID_Data.downrangeDistance.Value.ToString("G3")));
 
                        line.Append('\n');
 
                        csvList.Add(line.ToString());
 
                        csvCollectTimer = 0f;
                }
 
                private class WriteState
                {
                        public byte[] bytes;
                        public FileStream stream;
                }
        }
}