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
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
//
// Copyright (C) 2018 Kubos Corporation
//
// Licensed under the Apache License, Version 2.0 (the "License")
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

#[cfg(not(feature = "nos3"))]
use crate::ffi;
use crate::parse::*;
use failure::Fail;
#[cfg(feature = "nos3")]
use nom::*;
#[cfg(feature = "nos3")]
use rust_i2c::{Command, Connection};
#[cfg(feature = "nos3")]
use std::error::Error;
#[cfg(feature = "nos3")]
use std::io;
#[cfg(not(feature = "nos3"))]
use std::ptr;
#[cfg(feature = "nos3")]
use std::time::Duration;

/// Common Error for AntS Actions
#[derive(Fail, Debug, Clone)]
pub enum AntsError {
    /// Catch-all error
    #[fail(display = "Generic error")]
    GenericError,
    /// Configuration error. Thrown when a parameter passed to a C API function
    /// is out-of-bounds.
    #[fail(display = "Configuration error")]
    ConfigError,
    /// Error resulting from underlying Io functions
    #[fail(display = "IO Error: {}", description)]
    IoError {
        /// Underlying cause captured from io function
        cause: std::io::ErrorKind,
        /// Error description
        description: String,
    },
    /// Unsupported command error. Thrown when calling a command which an antenna system
    /// does not support
    #[cfg(feature = "nos3")]
    #[fail(display = "Unsupported Command error")]
    UnsupportedCmdError,
    /// Parsing Error. Thrown when the raw data received from the bus cannot be parsed or recognized
    #[cfg(feature = "nos3")]
    #[fail(display = "Parsing error")]
    ParsingFailure,
}

/// Convience converter from io::Error to AntsError
#[cfg(feature = "nos3")]
impl From<io::Error> for AntsError {
    fn from(error: std::io::Error) -> Self {
        AntsError::IoError {
            cause: error.kind(),
            description: error.description().to_owned(),
        }
    }
}

/// Custom result type for antenna operations
pub type AntSResult<T> = Result<T, AntsError>;

/// Trait used to represent the AntS object. Allows for mock objects to be created for unit tests
pub trait IAntS: Send {
    /// Construct a new AntS instance
    fn new(bus: &str, primary: u8, secondary: u8, ant_count: u8, timeout: u32) -> AntSResult<Self>
    where
        Self: ::std::marker::Sized;
    /// Configure which microcontroller should be used to control the system
    fn configure(&self, config: KANTSController) -> AntSResult<()>;
    /// Perform a software reset of the microcontrollers
    fn reset(&self) -> AntSResult<()>;
    /// Arm the system for deployment
    fn arm(&self) -> AntSResult<()>;
    /// Disable deployment
    fn disarm(&self) -> AntSResult<()>;
    /// Deploy one antenna
    fn deploy(&self, antenna: KANTSAnt, force: bool, timeout: u8) -> AntSResult<()>;
    /// Automatically deploy all antennas
    fn auto_deploy(&self, timeout: u8) -> AntSResult<()>;
    /// Cancel all current deployment actions
    fn cancel_deploy(&self) -> AntSResult<()>;
    /// Get the current deployment status of the system
    fn get_deploy(&self) -> AntSResult<DeployStatus>;
    /// Get the system uptime
    fn get_uptime(&self) -> AntSResult<u32>;
    /// Get the system telemetry data
    fn get_system_telemetry(&self) -> AntSResult<AntsTelemetry>;
    /// Get an antenna's activation count
    fn get_activation_count(&self, antenna: KANTSAnt) -> AntSResult<u8>;
    /// Get the amount of time spent attempting to deploy an antenna
    fn get_activation_time(&self, antenna: KANTSAnt) -> AntSResult<u16>;
    /// Kick the hardware watchdog
    fn watchdog_kick(&self) -> AntSResult<()>;
    /// Start automatic watchdog kicking
    fn watchdog_start(&self) -> AntSResult<()>;
    /// Stop automatic watchdog kicking
    fn watchdog_stop(&self) -> AntSResult<()>;
    /// Pass a data packet directly through to the device
    fn passthrough(&self, tx: &[u8], rx_in: &mut [u8]) -> AntSResult<()>;
}

/// Structure for interacting with an ISIS Antenna System
#[cfg(not(feature = "nos3"))]
pub struct AntS;

#[cfg(not(feature = "nos3"))]
impl IAntS for AntS {
    /// Constructor
    ///
    /// Opens a connection to the underlying I<sup>2</sup>C device
    ///
    /// # Arguments
    ///
    /// * bus - The I<sup>2</sup>C bus to use to communicate with the device
    /// * primary - The I<sup>2</sup>C address of the system's primary microcontroller
    /// * secondary - The I<sup>2</sup>C address of the system's secondary microcontroller
    ///	  (should be `0x00` if no secondary microcontroller is available)
    /// * ant_count - The number of antennas present in the antenna system
    /// * timeout - The watchdog timeout interval, in seconds
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, an [`AntsError`] variant will be returned.
    ///
    /// # Examples
    ///
    /// ```
    /// use isis_ants_api::*;
    ///
    /// # fn func() -> AntSResult<()> {
    /// let ants = AntS::new("KI2C1", 0x31, 0x32, 4, 10)?;
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// [`AntsError`]: enum.AntsError.html
    fn new(bus: &str, primary: u8, secondary: u8, ant_count: u8, timeout: u32) -> AntSResult<AntS> {
        match unsafe { ffi::k_ants_init(bus.as_ptr(), primary, secondary, ant_count, timeout) } {
            ffi::KANTSStatus::AntsOK => {
                if timeout > 0 {
                    match unsafe { ffi::k_ants_watchdog_start() } {
                        ffi::KANTSStatus::AntsOK => Ok(AntS),
                        ffi::KANTSStatus::AntsErrorConfig => Err(AntsError::ConfigError),
                        _ => Err(AntsError::GenericError),
                    }
                } else {
                    Ok(AntS)
                }
            }
            ffi::KANTSStatus::AntsErrorConfig => Err(AntsError::ConfigError),
            _ => Err(AntsError::GenericError),
        }
    }

    /// Configure the system to send future commands to the requested microcontroller
    ///
    /// # Arguments
    ///
    /// * config - The microcontroller which should be used for future commands to the antenna system
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, an [`AntsError`] variant will be returned.
    ///
    /// # Examples
    ///
    /// ```
    /// # use isis_ants_api::*;
    /// # fn func() -> AntSResult<()> {
    /// let ants = AntS::new("KI2C1", 0x31, 0x00, 2, 20)?;
    /// ants.configure(KANTSController::Secondary)?;
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// [`AntsError`]: enum.AntsError.html
    fn configure(&self, config: KANTSController) -> AntSResult<()> {
        match unsafe { ffi::k_ants_configure(convert_controller(&config)) } {
            ffi::KANTSStatus::AntsOK => Ok(()),
            ffi::KANTSStatus::AntsErrorConfig => Err(AntsError::ConfigError),
            _ => Err(AntsError::GenericError),
        }
    }

    /// Reset both of the antenna's microcontrollers
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, an [`AntsError`] variant will be returned.
    ///
    /// # Examples
    ///
    /// ```
    /// # use isis_ants_api::*;
    /// # fn func() -> AntSResult<()> {
    /// let ants = AntS::new("KI2C1", 0x31, 0x32, 4, 10)?;
    /// ants.reset()?;
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// [`AntsError`]: enum.AntsError.html
    fn reset(&self) -> AntSResult<()> {
        match unsafe { ffi::k_ants_reset() } {
            ffi::KANTSStatus::AntsOK => Ok(()),
            ffi::KANTSStatus::AntsErrorConfig => Err(AntsError::ConfigError),
            _ => Err(AntsError::GenericError),
        }
    }

    /// Arm the antenna system for deployment
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, an [`AntsError`] variant will be returned.
    ///
    /// # Examples
    ///
    /// ```
    /// # use isis_ants_api::*;
    /// # fn func() -> AntSResult<()> {
    /// let ants = AntS::new("KI2C1", 0x31, 0x32, 4, 10)?;
    /// ants.arm()?;
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// [`AntsError`]: enum.AntsError.html
    fn arm(&self) -> AntSResult<()> {
        match unsafe { ffi::k_ants_arm() } {
            ffi::KANTSStatus::AntsOK => Ok(()),
            ffi::KANTSStatus::AntsErrorConfig => Err(AntsError::ConfigError),
            _ => Err(AntsError::GenericError),
        }
    }

    /// Disarm the antenna system
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, an [`AntsError`] variant will be returned.
    ///
    /// # Examples
    ///
    /// ```
    /// # use isis_ants_api::*;
    /// # fn func() -> AntSResult<()> {
    /// let ants = AntS::new("KI2C1", 0x31, 0x32, 4, 10)?;
    /// ants.disarm()?;
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// [`AntsError`]: enum.AntsError.html
    fn disarm(&self) -> AntSResult<()> {
        match unsafe { ffi::k_ants_disarm() } {
            ffi::KANTSStatus::AntsOK => Ok(()),
            ffi::KANTSStatus::AntsErrorConfig => Err(AntsError::ConfigError),
            _ => Err(AntsError::GenericError),
        }
    }

    /// Deploy a particular antenna
    ///
    /// # Arguments
    ///
    /// * antenna - The antenna to deploy
    /// * force - Whether the system should ignore previous successful deployment
    /// * timeout - The maximum time, in seconds, the system should spend deploying the antenna
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, an [`AntsError`] variant will be returned.
    ///
    /// # Examples
    ///
    /// ```
    /// # use isis_ants_api::*;
    /// # fn func() -> AntSResult<()> {
    /// let ants = AntS::new("KI2C1", 0x31, 0x00, 2, 20)?;
    /// ants.deploy(KANTSAnt::Ant2, false, 10)?;
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// [`AntsError`]: enum.AntsError.html
    fn deploy(&self, antenna: KANTSAnt, force: bool, timeout: u8) -> AntSResult<()> {
        match unsafe { ffi::k_ants_deploy(convert_antenna(&antenna), force, timeout) } {
            ffi::KANTSStatus::AntsOK => Ok(()),
            ffi::KANTSStatus::AntsErrorConfig => Err(AntsError::ConfigError),
            _ => Err(AntsError::GenericError),
        }
    }

    /// Auto-deploy all antennas sequentially.
    ///
    /// # Arguments
    ///
    /// * timeout - The maximum time, in seconds, the system should spend deploying each antenna
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, an [`AntsError`] variant will be returned.
    ///
    /// # Examples
    ///
    /// ```
    /// # use isis_ants_api::*;
    /// # fn func() -> AntSResult<()> {
    /// let ants = AntS::new("KI2C1", 0x31, 0x00, 2, 20)?;
    /// ants.auto_deploy(5)?;
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// [`AntsError`]: enum.AntsError.html
    fn auto_deploy(&self, timeout: u8) -> AntSResult<()> {
        match unsafe { ffi::k_ants_auto_deploy(timeout) } {
            ffi::KANTSStatus::AntsOK => Ok(()),
            ffi::KANTSStatus::AntsErrorConfig => Err(AntsError::ConfigError),
            _ => Err(AntsError::GenericError),
        }
    }

    /// Cancel all current deployment actions
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, an [`AntsError`] variant will be returned.
    ///
    /// # Examples
    ///
    /// ```
    /// # use isis_ants_api::*;
    /// # fn func() -> AntSResult<()> {
    /// let ants = AntS::new("KI2C1", 0x31, 0x32, 4, 10)?;
    /// ants.cancel_deploy()?;
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// [`AntsError`]: enum.AntsError.html
    fn cancel_deploy(&self) -> AntSResult<()> {
        match unsafe { ffi::k_ants_cancel_deploy() } {
            ffi::KANTSStatus::AntsOK => Ok(()),
            ffi::KANTSStatus::AntsErrorConfig => Err(AntsError::ConfigError),
            _ => Err(AntsError::GenericError),
        }
    }

    /// Get the current deployment status
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, an [`AntsError`] variant will be returned.
    ///
    /// # Examples
    ///
    /// ```
    /// # use isis_ants_api::*;
    /// # fn func() -> AntSResult<()> {
    /// let ants = AntS::new("KI2C1", 0x31, 0x32, 4, 10)?;
    /// let deploy = ants.get_deploy()?;
    /// println!("Antenna 1 deployed: {}", !deploy.ant_1_not_deployed);
    /// println!("Antenna 2 deployment active: {}", deploy.ant_2_active);
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// [`AntsError`]: enum.AntsError.html
    fn get_deploy(&self) -> AntSResult<DeployStatus> {
        let mut status: [u8; 2] = [0; 2];

        match unsafe { ffi::k_ants_get_deploy_status(status.as_mut_ptr()) } {
            ffi::KANTSStatus::AntsOK => {
                let decoded = DeployStatus::new(&status)?;
                Ok(decoded)
            }
            ffi::KANTSStatus::AntsErrorConfig => Err(AntsError::ConfigError),
            _ => Err(AntsError::GenericError),
        }
    }

    /// Get the system's uptime
    ///
    /// Returns the systems uptime, in seconds
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, an [`AntsError`] variant will be returned.
    ///
    /// # Examples
    ///
    /// ```
    /// # use isis_ants_api::*;
    /// # fn func() -> AntSResult<()> {
    /// let ants = AntS::new("KI2C1", 0x31, 0x32, 4, 10)?;
    /// let uptime = ants.get_uptime()?;
    /// println!("Antenna system uptime: {}", uptime);
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// [`AntsError`]: enum.AntsError.html
    fn get_uptime(&self) -> AntSResult<u32> {
        let mut uptime = 0;

        match unsafe { ffi::k_ants_get_uptime(&mut uptime) } {
            ffi::KANTSStatus::AntsOK => Ok(uptime),
            ffi::KANTSStatus::AntsErrorConfig => Err(AntsError::ConfigError),
            _ => Err(AntsError::GenericError),
        }
    }

    /// Get the current system telemetry
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, an [`AntsError`] variant will be returned.
    ///
    /// # Examples
    ///
    /// ```
    /// # use isis_ants_api::*;
    /// # fn func() -> AntSResult<()> {
    /// let ants = AntS::new("KI2C1", 0x31, 0x32, 4, 10)?;
    /// let sys_telem = ants.get_system_telemetry()?;
    ///
    /// println!("Antenna system telemetry:");
    /// println!("    raw_temp: {}", sys_telem.raw_temp);
    /// println!("    deploy_status:");
    /// println!("        Antenna 1 deployed: {}", !sys_telem.deploy_status.ant_1_not_deployed);
    /// println!("        Antenna 2 deployment active: {}", sys_telem.deploy_status.ant_2_active);
    /// println!("    uptime: {}\n", sys_telem.uptime);
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// [`AntsError`]: enum.AntsError.html
    fn get_system_telemetry(&self) -> AntSResult<AntsTelemetry> {
        let mut c_telem = ffi::AntsTelemetry {
            raw_temp: 0,
            deploy_status: 0,
            uptime: 0,
        };

        match unsafe { ffi::k_ants_get_system_telemetry(&mut c_telem) } {
            ffi::KANTSStatus::AntsOK => {
                let telem = AntsTelemetry::new(&c_telem)?;
                Ok(telem)
            }
            ffi::KANTSStatus::AntsErrorConfig => Err(AntsError::ConfigError),
            _ => Err(AntsError::GenericError),
        }
    }

    /// Get an antenna's activation count
    ///
    /// # Arguments
    ///
    /// * antenna - Antenna to query
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, an [`AntsError`] variant will be returned.
    ///
    /// # Examples
    ///
    /// ```
    /// # use isis_ants_api::*;
    /// # fn func() -> AntSResult<()> {
    /// let ants = AntS::new("KI2C1", 0x31, 0x00, 2, 20)?;
    /// let act_count = ants.get_activation_count(KANTSAnt::Ant3)?;
    ///
    /// println!("Antenna 3 activation count - {}", act_count);
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// [`AntsError`]: enum.AntsError.html
    fn get_activation_count(&self, antenna: KANTSAnt) -> AntSResult<u8> {
        let mut count: u8 = 0;

        match unsafe { ffi::k_ants_get_activation_count(convert_antenna(&antenna), &mut count) } {
            ffi::KANTSStatus::AntsOK => Ok(count),
            ffi::KANTSStatus::AntsErrorConfig => Err(AntsError::ConfigError),
            _ => Err(AntsError::GenericError),
        }
    }

    /// Get an antenna's activation time
    ///
    /// Returns the total amount of time spent attempting to active the antenna, in seconds
    ///
    /// # Arguments
    ///
    /// * antenna - Antenna to query
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, an [`AntsError`] variant will be returned.
    ///
    /// # Examples
    ///
    /// ```
    /// # use isis_ants_api::*;
    /// # fn func() -> AntSResult<()> {
    /// let ants = AntS::new("KI2C1", 0x31, 0x00, 2, 20)?;
    /// let act_count = ants.get_activation_time(KANTSAnt::Ant1)?;
    ///
    /// println!("Antenna 1 activation time - {}", act_count);
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// [`AntsError`]: enum.AntsError.html
    fn get_activation_time(&self, antenna: KANTSAnt) -> AntSResult<u16> {
        let mut time: u16 = 0;

        match unsafe { ffi::k_ants_get_activation_time(convert_antenna(&antenna), &mut time) } {
            ffi::KANTSStatus::AntsOK => Ok(time),
            ffi::KANTSStatus::AntsErrorConfig => Err(AntsError::ConfigError),
            _ => Err(AntsError::GenericError),
        }
    }

    /// Kick both antenna system's watchdogs once
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, an [`AntsError`] variant will be returned.
    ///
    /// # Examples
    ///
    /// ```
    /// # use isis_ants_api::*;
    /// # fn func() -> AntSResult<()> {
    /// let ants = AntS::new("KI2C1", 0x31, 0x32, 4, 10)?;
    /// ants.watchdog_kick()?;
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// [`AntsError`]: enum.AntsError.html
    fn watchdog_kick(&self) -> AntSResult<()> {
        match unsafe { ffi::k_ants_watchdog_kick() } {
            ffi::KANTSStatus::AntsOK => Ok(()),
            ffi::KANTSStatus::AntsErrorConfig => Err(AntsError::ConfigError),
            _ => Err(AntsError::GenericError),
        }
    }

    /// Start a thread to kick the system's watchdogs at an interval of
    /// (timeout)/3 seconds
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, an [`AntsError`] variant will be returned.
    ///
    /// # Examples
    ///
    /// ```
    /// # use isis_ants_api::*;
    /// # fn func() -> AntSResult<()> {
    /// let ants = AntS::new("KI2C1", 0x31, 0x32, 4, 10)?;
    /// ants.watchdog_start()?;
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// [`AntsError`]: enum.AntsError.html
    fn watchdog_start(&self) -> AntSResult<()> {
        match unsafe { ffi::k_ants_watchdog_start() } {
            ffi::KANTSStatus::AntsOK => Ok(()),
            ffi::KANTSStatus::AntsErrorConfig => Err(AntsError::ConfigError),
            _ => Err(AntsError::GenericError),
        }
    }

    /// Stop the watchdog thread
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, an [`AntsError`] variant will be returned.
    ///
    /// # Examples
    ///
    /// ```
    /// # use isis_ants_api::*;
    /// # fn func() -> AntSResult<()> {
    /// let ants = AntS::new("KI2C1", 0x31, 0x32, 4, 10)?;
    /// ants.watchdog_start()?;
    /// //...
    /// ants.watchdog_stop()?;
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// [`AntsError`]: enum.AntsError.html
    fn watchdog_stop(&self) -> AntSResult<()> {
        match unsafe { ffi::k_ants_watchdog_stop() } {
            ffi::KANTSStatus::AntsOK => Ok(()),
            ffi::KANTSStatus::AntsErrorConfig => Err(AntsError::ConfigError),
            _ => Err(AntsError::GenericError),
        }
    }

    /// Pass a command packet directly through to the antenna system
    /// Useful for executing commands which have not been implemented in either the
    /// generic or specific antenna APIs.
    ///
    /// # Arguments
    ///
    /// * tx - Reference to byte array data to send
    /// * rx - Reference to byte array which returned data should be stored in
    ///
    /// # Errors
    ///
    /// If this function encounters any errors, an [`AntsError`] variant will be returned.
    ///
    /// # Examples
    ///
    /// ```
    /// # use isis_ants_api::*;
    /// # fn func() -> AntSResult<()> {
    /// let ants = AntS::new("KI2C1", 0x31, 0x00, 2, 20)?;
    /// let tx: [u8; 1] = [0xC3];
    /// let mut rx: [u8; 2] = [0; 2];
    ///
    /// ants.passthrough(&tx, &mut rx).unwrap();
    /// println!("Antenna passthrough response: {:?}", rx);
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// [`AntsError`]: enum.AntsError.html
    fn passthrough(&self, tx: &[u8], rx_in: &mut [u8]) -> AntSResult<()> {
        let tx_len: u8 = tx.len() as u8;
        let rx_len: u8 = rx_in.len() as u8;

        let rx: *mut u8 = match rx_len {
            0 => ptr::null_mut(),
            _ => rx_in.as_mut_ptr(),
        };

        match unsafe { ffi::k_ants_passthrough(tx.as_ptr(), tx_len, rx, rx_len) } {
            ffi::KANTSStatus::AntsOK => Ok(()),
            ffi::KANTSStatus::AntsErrorConfig => Err(AntsError::ConfigError),
            _ => Err(AntsError::GenericError),
        }
    }
}

/// Structure for interacting with an ISIS Antenna System
#[cfg(feature = "nos3")]
pub struct AntS {
    bus: String,
    controllers: AntSControllers,
    connection: Arc<Mutex<Connection>>,
}

#[cfg(feature = "nos3")]
impl IAntS for AntS {
    /// Constructor
    ///
    /// Creates new instance of AntS structure.
    ///
    /// # Arguments
    /// `connection` - A [`Connection`] used as low-level connection to AntS hardware
    ///
    /// [`Connection`]: ../rust_i2c/struct.Connection.html
    fn new(
        bus: &str,
        primary: u8,
        secondary: u8,
        _ant_count: u8,
        _timeout: u32,
    ) -> AntSResult<Self> {
        let ants = AntS {
            bus: bus.to_string(),
            controllers: AntSControllers {
                side_a: primary,
                side_b: secondary,
            },
            connection: Arc::new(Mutex::new(Connection::from_path(bus, primary as u16))),
        };
        Ok(ants)
    }

    /// Configure the system to send future commands to the requested microcontroller
    fn configure(&self, config: KANTSController) -> AntSResult<()> {
        let path = match config {
            KANTSController::Primary => self.controllers.side_a as u16,
            KANTSController::Secondary => self.controllers.side_b as u16,
        };
        let mut connection = self.connection.lock().unwrap();
        connection = Connection::from_path(&self.bus, path);
        Ok(())
    }

    /// Reset the Ant System
    fn reset(&self) -> AntSResult<()> {
        self.connection.lock().unwrap().write(Command {
            cmd: 0xAA,
            data: vec![],
        })?;
        Ok(())
    }

    /// Ready Ant System for deployment
    fn arm(&self) -> AntSResult<()> {
        self.connection.lock().unwrap().write(Command {
            cmd: 0xAD,
            data: vec![],
        })?;
        Ok(())
    }

    /// Disable deployment
    fn disarm(&self) -> AntSResult<()> {
        self.connection.lock().unwrap().write(Command {
            cmd: 0xAC,
            data: vec![],
        })?;
        Ok(())
    }

    /// Deploy one antenna
    fn deploy(&self, antenna: KANTSAnt, force: bool, timeout: u8) -> AntSResult<()> {
        let cmd = match force {
            true => match antenna {
                KANTSAnt::Ant1 => 0xBA,
                KANTSAnt::Ant2 => 0xBB,
                KANTSAnt::Ant3 => 0xBC,
                KANTSAnt::Ant4 => 0xBD,
            },
            false => match antenna {
                KANTSAnt::Ant1 => 0xA1,
                KANTSAnt::Ant2 => 0xA2,
                KANTSAnt::Ant3 => 0xA3,
                KANTSAnt::Ant4 => 0xA4,
            },
        };
        self.connection.lock().unwrap().write(Command {
            cmd,
            data: vec![timeout],
        })?;
        Ok(())
    }

    /// Automatically deploy all antennas
    fn auto_deploy(&self, timeout: u8) -> AntSResult<()> {
        self.connection.lock().unwrap().write(Command {
            cmd: 0xA5,
            data: vec![timeout],
        })?;
        Ok(())
    }

    /// Cancel all current deployment actions
    fn cancel_deploy(&self) -> AntSResult<()> {
        self.connection.lock().unwrap().write(Command {
            cmd: 0xA9,
            data: vec![],
        })?;
        Ok(())
    }

    /// Get the current deployment status of the system
    fn get_deploy(&self) -> AntSResult<DeployStatus> {
        let cmd = Command {
            cmd: 0xC3,
            data: vec![],
        };
        let status = self.connection.transfer(cmd, 2, Duration::from_millis(1))?;
        let decoded = DeployStatus::new(&status)?;
        Ok(decoded)
    }

    /// Get the system uptime
    fn get_uptime(&self) -> AntSResult<u32> {
        Err(AntsError::UnsupportedCmdError)
    }

    /// Get the system telemetry data
    fn get_system_telemetry(&self) -> AntSResult<AntsTelemetry> {
        let cmd = Command {
            cmd: 0xC0,
            data: vec![],
        };
        let temp = self.connection.transfer(cmd, 2, Duration::from_millis(2))?;
        let temp = match le_u16(&temp) {
            Ok((_rem, res)) => res,
            Err(_) => return Err(AntsError::ParsingFailure),
        };
        let status = self.get_deploy()?;
        let uptime = 0;

        let telem = AntsTelemetry {
            raw_temp: temp,
            deploy_status: status,
            uptime,
        };
        Ok(telem)
    }

    /// Get an antenna's activation count
    fn get_activation_count(&self, antenna: KANTSAnt) -> AntSResult<u8> {
        let cmd = match antenna {
            KANTSAnt::Ant1 => 0xB0,
            KANTSAnt::Ant2 => 0xB1,
            KANTSAnt::Ant3 => 0xB2,
            KANTSAnt::Ant4 => 0xB3,
        };
        let cmd = Command { cmd, data: vec![] };
        let count = self.connection.transfer(cmd, 1, Duration::from_millis(1))?;
        Ok(count[0])
    }

    /// Get the amount of time spent attempting to deploy an antenna
    fn get_activation_time(&self, antenna: KANTSAnt) -> AntSResult<u16> {
        let cmd = match antenna {
            KANTSAnt::Ant1 => 0xB4,
            KANTSAnt::Ant2 => 0xB5,
            KANTSAnt::Ant3 => 0xB6,
            KANTSAnt::Ant4 => 0xB7,
        };
        let cmd = Command { cmd, data: vec![] };
        let time = self.connection.transfer(cmd, 2, Duration::from_millis(1))?;

        match le_u16(&time) {
            Ok((_rem, res)) => Ok(res / 20),
            Err(_) => Err(AntsError::ParsingFailure),
        }
    }

    /// Kick the hardware watchdog
    fn watchdog_kick(&self) -> AntSResult<()> {
        Err(AntsError::UnsupportedCmdError)
    }

    /// Start automatic watchdog kicking
    fn watchdog_start(&self) -> AntSResult<()> {
        Err(AntsError::UnsupportedCmdError)
    }

    /// Stop automatic watchdog kicking
    fn watchdog_stop(&self) -> AntSResult<()> {
        Err(AntsError::UnsupportedCmdError)
    }

    /// Pass a data packet directly through to the device
    fn passthrough(&self, _tx: &[u8], _rx_in: &mut [u8]) -> AntSResult<()> {
        Err(AntsError::UnsupportedCmdError)
    }
}

/// Structure for respresenting each microcontroller address
#[cfg(feature = "nos3")]
struct AntSControllers {
    side_a: u8,
    side_b: u8,
}

/// Close the connection to the I2C bus
#[cfg(not(feature = "nos3"))]
impl Drop for AntS {
    fn drop(&mut self) {
        let _ = self.watchdog_stop();
        unsafe { ffi::k_ants_terminate() }
    }
}