jeep 0.0.1

CAN event handling for Jeep JL
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

// MIT License

// Copyright (c) 2023 Michael de Gans

// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:

// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

use super::Display;

bitflags::bitflags! {
  /// State of the jeep's [`Locks`].
  #[cfg_attr(rustfmt, rustfmt_skip)]
  #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
  #[derive(Display)]
  #[repr(align(8))]
  pub struct Locks: u8 {
      // FIXME(mdegans): 2021 4xE Sahara - All these are wrong. More testing
      // is needed.
      const DRIVER                    = 0b00000001;
      const PASSENGER                 = 0b00000010;
      const REAR_DRIVER               = 0b00000100;
      const REAR_PASSENGER            = 0b00001000;
      const MYSTERY_DOOR_0            = 0b00010000;
      const SWING_GATE                = 0b00100000;
      const MYSTERY_DOOR_1            = 0b01000000;
      const MYSTERY_DOOR_2            = 0b10000000;
      const ALL_JEEP_DOORS            = 0b00101111;
  }
}

impl Locks {
    /// Returns true if all doors are locked.
    #[inline]
    pub const fn all_locked(self) -> bool {
        self.intersection(Self::ALL_JEEP_DOORS).is_empty()
    }
    /// Returns true if any door is unlocked.
    #[inline]
    pub const fn any_unlocked(self) -> bool {
        !self.all_locked()
    }
}