phd2 0.2.2

Client library for interfacing with phd2.
Documentation
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
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
use std::time::Duration;

use base64::Engine;
use itertools::Itertools;
use serde::{de::Visitor, Deserialize, Serialize, Serializer};

#[derive(Deserialize, Debug)]
pub struct Version {
    // #[serde(flatten)]
    // pub common: Common,
    #[serde(alias = "PHDVersion")]
    pub phd_version: String,
    #[serde(alias = "PHDSubver")]
    pub phd_subver: String,
    #[serde(alias = "OverlapSupport")]
    pub overlap_support: bool,
    #[serde(alias = "MsgVersion")]
    pub msg_version: u32,
}

#[derive(Deserialize, Debug)]
pub struct LockPositionSet {
    #[serde(alias = "X")]
    pub x: f64,
    #[serde(alias = "Y")]
    pub y: f64,
}

#[derive(Deserialize, Debug)]
pub struct Calibrating {
    #[serde(alias = "Mount")]
    pub mount: String,
    pub dir: String,
    pub dx: f64,
    pub dy: f64,
    pub pos: [f64; 2],
    pub step: f64,
    #[serde(alias = "State")]
    pub state: String,
}

#[derive(Deserialize, Debug)]
pub struct CalibrationComplete {
    #[serde(alias = "Mount")]
    pub mount: String,
}

#[derive(Deserialize, Debug)]
pub struct StarSelected {
    #[serde(alias = "X")]
    pub x: f64,
    #[serde(alias = "Y")]
    pub y: f64,
}

#[derive(Deserialize, Debug)]
pub struct StartGuiding {}

#[derive(Deserialize, Debug)]
pub struct Paused {}

#[derive(Deserialize, Debug)]
pub struct StartCalibration {
    #[serde(alias = "Mount")]
    pub mount: String,
}

#[derive(Deserialize, Debug, PartialEq)]
pub enum State {
    Stopped,
    Selected,
    Calibrating,
    Guiding,
    LostLock,
    Paused,
    Looping,
}
#[derive(Debug)]
pub struct InvalidState(pub String);

impl TryFrom<&str> for State {
    type Error = InvalidState;

    fn try_from(value: &str) -> Result<Self, Self::Error> {
        match value {
            "Stoppped" => Ok(State::Stopped),
            "Selected" => Ok(State::Selected),
            "Calibrating" => Ok(State::Calibrating),
            "Guiding" => Ok(State::Guiding),
            "LostLock" => Ok(State::LostLock),
            "Paused" => Ok(State::Paused),
            "Looping" => Ok(State::Looping),
            other => Err(InvalidState(String::from(other))),
        }
    }
}
#[derive(Deserialize, Debug)]
pub struct AppState {
    #[serde(alias = "State")]
    pub state: State,
}

#[derive(Deserialize, Debug)]
pub struct CalibrationFailed {
    #[serde(alias = "Reason")]
    pub reason: String,
}

#[derive(Deserialize, Debug)]
pub struct CalibrationDataFlipped {
    #[serde(alias = "Mount")]
    pub mount: String,
}

#[derive(Deserialize, Debug)]
pub struct LockPositionShiftLimitReached {}

#[derive(Deserialize, Debug)]
pub struct LoopingExposures {
    #[serde(alias = "Frame")]
    pub frame: u32,
}

#[derive(Deserialize, Debug)]
pub struct LoopingExposuresStopped {}

#[derive(Deserialize, Debug)]
pub struct SettleBegin {}

#[derive(Deserialize, Debug)]
pub struct Settling {
    #[serde(alias = "Distance")]
    pub distance: f64,
    #[serde(alias = "Time")]
    pub time: f64,
    #[serde(alias = "SettleTime")]
    pub settle_time: f64,
    #[serde(alias = "StarLocked")]
    pub star_locked: bool,
}

#[derive(Deserialize, Debug)]
pub struct SettleDone {
    #[serde(alias = "Status")]
    pub status: u32,
    #[serde(alias = "Error")]
    pub error: Option<String>,
    #[serde(alias = "TotalFrames")]
    pub total_frames: u32,
    #[serde(alias = "DroppedFrames")]
    pub dropped_frames: u32,
}

#[derive(Deserialize, Debug)]
pub struct StarLost {
    #[serde(alias = "Frame")]
    pub frame: u32,
    #[serde(alias = "Time")]
    pub time: f64,
    #[serde(alias = "StarMass")]
    pub star_mass: f64,
    #[serde(alias = "SNR")]
    pub snr: f64,
    #[serde(alias = "AvgDist")]
    pub avg_dist: f64,
    #[serde(alias = "ErrorCode")]
    pub error_code: i32,
    #[serde(alias = "Status")]
    pub status: String,
}

#[derive(Deserialize, Debug)]
pub struct GuidingStopped {}

#[derive(Deserialize, Debug)]
pub struct Resumed {}

#[derive(Deserialize, Debug)]
pub enum NorthSouth {
    North,
    South,
}
#[derive(Deserialize, Debug)]
pub enum EastWest {
    East,
    West,
}

#[derive(Deserialize, Debug)]
pub struct GuideStep {
    #[serde(alias = "Frame")]
    pub frame: u32,
    #[serde(alias = "Time")]
    pub time: f64,
    #[serde(alias = "Mount")]
    pub mount: String,
    pub dx: f64,
    pub dy: f64,
    #[serde(alias = "RADistanceRaw")]
    pub ra_distance_raw: f64,
    #[serde(alias = "DECDistanceRaw")]
    pub de_distance_raw: f64,
    #[serde(alias = "RADistanceGuide")]
    pub ra_distance_guide: f64,
    #[serde(alias = "DECDistanceGuide")]
    pub de_distance_guide: f64,
    #[serde(alias = "RADuration")]
    pub ra_duration: Option<f64>,
    #[serde(alias = "RADirection")]
    pub ra_direction: Option<EastWest>,
    #[serde(alias = "DECDuration")]
    pub dec_duration: Option<f64>,
    #[serde(alias = "DECDirection")]
    pub dec_direction: Option<NorthSouth>,
    #[serde(alias = "StarMass")]
    pub star_mass: f64,
    #[serde(alias = "SNR")]
    pub snr: f64,
    #[serde(alias = "HFD")]
    pub hfd: f64,
    #[serde(alias = "AvgDist")]
    pub avg_dist: f64,
    #[serde(alias = "RALimited")]
    pub ra_limited: Option<bool>,
    #[serde(alias = "DecLimited")]
    pub dec_limited: Option<bool>,
    #[serde(alias = "ErrorCode")]
    pub error_code: Option<i32>,
}

#[derive(Deserialize, Debug)]
pub struct GuidingDithered {
    pub dx: f64,
    pub dy: f64,
}

#[derive(Deserialize, Debug)]
pub struct LockPositionLost {}

#[derive(Deserialize, Debug)]
pub struct Alert {
    #[serde(alias = "Msg")]
    pub msg: String,
    #[serde(alias = "Type")]
    pub msg_type: String,
}

#[derive(Deserialize, Debug)]
pub struct GuideParamChange {
    #[serde(alias = "Name")]
    pub name: String,
    #[serde(alias = "Value")]
    pub value: serde_json::Value,
}

#[derive(Deserialize, Debug)]
pub struct ConfigurationChange {}

#[derive(Deserialize, Debug)]
#[serde(tag = "Event")]
pub enum Event {
    Version(Version),
    LockPositionSet(LockPositionSet),
    Calibrating(Calibrating),
    CalibrationComplete(CalibrationComplete),
    StarSelected(StarSelected),
    StartGuiding(StartGuiding),
    Paused(Paused),
    StartCalibration(StartCalibration),
    AppState(AppState),
    CalibrationFailed(CalibrationFailed),
    CalibrationDataFlipped(CalibrationDataFlipped),
    LockPositionShiftLimitReached(LockPositionShiftLimitReached),
    LoopingExposures(LoopingExposures),
    LoopingExposuresStopped(LoopingExposuresStopped),
    SettleBegin(SettleBegin),
    Settling(Settling),
    SettleDone(SettleDone),
    StarLost(StarLost),
    GuidingStopped(GuidingStopped),
    Resumed(Resumed),
    GuideStep(GuideStep),
    GuidingDithered(GuidingDithered),
    LockPositionLost(LockPositionLost),
    Alert(Alert),
    GuideParamChange(GuideParamChange),
    ConfigurationChange(ConfigurationChange),
}

#[derive(Deserialize, Debug)]
pub struct ServerEvent {
    #[serde(alias = "Timestamp")]
    pub timestamp: f64,
    #[serde(alias = "Host")]
    pub host: String,
    #[serde(alias = "Inst")]
    pub inst: u32,

    #[serde(flatten)]
    pub event: Event,
}

#[derive(Deserialize, Debug)]
pub struct JsonRpcResponse {
    pub jsonrpc: String,
    pub id: u64,

    pub result: Option<serde_json::Value>,
    pub error: Option<serde_json::Value>,
}
#[derive(Deserialize, Debug)]
#[serde(untagged)]
pub enum ServerMessage {
    ServerEvent(ServerEvent),
    JsonRpcResponse(JsonRpcResponse),
}

#[derive(Serialize, Debug)]
pub struct JsonRpcRequest {
    pub id: u64,
    pub method: String,

    pub params: serde_json::Value,
}

#[derive(Debug, Clone, Copy, PartialEq)]
pub struct DurationSeconds(Duration);

impl From<Duration> for DurationSeconds {
    fn from(value: Duration) -> Self {
        DurationSeconds(value)
    }
}
impl Serialize for DurationSeconds {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        serializer.serialize_f64(self.0.as_secs_f64())
    }
}

#[derive(Debug, PartialEq)]
pub struct DurationMillis(pub Duration);

impl From<DurationMillis> for Duration {
    fn from(value: DurationMillis) -> Self {
        value.0
    }
}

impl From<u64> for DurationMillis {
    fn from(value: u64) -> Self {
        DurationMillis(Duration::from_millis(value))
    }
}

impl Serialize for DurationMillis {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_u128(self.0.as_millis())
    }
}
struct DurationMillisVisitor;

impl<'de> Visitor<'de> for DurationMillisVisitor {
    type Value = u64;

    fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
        formatter.write_str("a float number of milliseconds")
    }

    fn visit_u64<E>(self, v: u64) -> Result<Self::Value, E>
    where
        E: serde::de::Error,
    {
        Ok(v)
    }
}
impl<'de> Deserialize<'de> for DurationMillis {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        let millis = deserializer.deserialize_u64(DurationMillisVisitor)?;
        Ok(DurationMillis(Duration::from_millis(millis)))
    }
}

#[derive(Serialize, Debug, PartialEq)]
pub enum ClearCalibrationParam {
    #[serde(rename = "mount")]
    Mount,
    #[serde(rename = "ao")]
    Ao,
    #[serde(rename = "both")]
    Both,
}

#[derive(Serialize, Debug, PartialEq, Clone, Copy)]
pub struct Settle {
    pub pixels: f64,
    pub time: DurationSeconds,
    pub timeout: DurationSeconds,
}

impl Settle {
    pub fn new(pixels: f64, time: Duration, timeout: Duration) -> Settle {
        Settle {
            pixels,
            time: time.into(),
            timeout: timeout.into(),
        }
    }
}

#[derive(Serialize, Debug, PartialEq)]
pub enum Axis {
    #[serde(rename = "ra")]
    Ra,
    #[serde(rename = "dec")]
    Dec,
    #[serde(rename = "x")]
    X,
    #[serde(rename = "y")]
    Y,
}

#[derive(Serialize, Debug, PartialEq)]
pub enum WhichDevice {
    Mount,
    #[serde(rename = "AO")]
    Ao,
}
#[derive(Deserialize, Debug, PartialEq)]
pub struct Calibration {
    pub calibrated: bool,
    #[serde(flatten)]
    pub data: Option<CalibrationData>,
}

#[derive(Deserialize, Debug, PartialEq)]
pub struct CalibrationData {
    #[serde(alias = "xAngle")]
    pub x_angle: f64,
    #[serde(alias = "xRate")]
    pub x_rate: f64,
    #[serde(alias = "xParity")]
    pub x_parity: Parity,
    #[serde(alias = "yAngle")]
    pub y_angle: f64,
    #[serde(alias = "yRate")]
    pub y_rate: f64,
    #[serde(alias = "yParity")]
    pub y_parity: Parity,
}

#[derive(Deserialize, Debug, PartialEq)]
pub enum Parity {
    #[serde(rename = "+")]
    Pos,
    #[serde(rename = "-")]
    Neg,
    #[serde(rename = "?")]
    Unknown,
}

#[derive(Deserialize, Debug)]
pub struct CoolerStatus {
    #[serde(alias = "coolerOn")]
    pub cooler_on: bool,
    pub temperature: f64,
    pub setpoint: Option<f64>,
    pub power: Option<f64>,
}

#[derive(Deserialize, Debug, PartialEq)]
pub struct Equipment {
    pub connected: bool,
    pub name: String,
}

#[derive(Serialize, Deserialize, Debug, PartialEq)]
pub enum DecGuideMode {
    Off,
    Auto,
    North,
    South,
}

#[derive(Deserialize, Debug)]
pub struct LockShiftParams {
    pub axes: String,
    pub enabled: bool,
    pub units: String,
    pub rate: [f64; 2],
}
#[derive(Deserialize, Debug, PartialEq)]
pub struct Profile {
    pub id: isize,
    pub name: String,
}

#[derive(Debug)]
pub struct Base64Image(pub Vec<u16>);

struct Base64ImageVisitor;
impl<'de> Visitor<'de> for Base64ImageVisitor {
    type Value = Vec<u16>;

    fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
        formatter.write_str("a base64 encoded string")
    }

    fn visit_string<E>(self, v: String) -> Result<Self::Value, E>
    where
        E: serde::de::Error,
    {
        match base64::engine::general_purpose::STANDARD_NO_PAD.decode(v) {
            Ok(bytes) => {
                let bytes = bytes
                    .iter()
                    .tuples()
                    .map(|(high, low)| {
                        let high = (*high as u16) << 8;
                        let low = *low as u16;
                        high + low
                    })
                    .collect();
                Ok(bytes)
            }
            Err(e) => Err(serde::de::Error::custom(e.to_string())),
        }
    }
}
impl<'de> Deserialize<'de> for Base64Image {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        let bytes = deserializer.deserialize_string(Base64ImageVisitor)?;
        Ok(Base64Image(bytes))
    }
}

#[derive(Deserialize, Debug)]
pub struct StarImage {
    pub frame: usize,
    pub width: usize,
    pub height: usize,
    pub star_pos: [f64; 2],
    pub pixels: Base64Image,
}

#[derive(Serialize, Debug, PartialEq)]
pub enum PulseDirection {
    N,
    S,
    E,
    W,
    Up,
    Down,
    Left,
    Right,
}