1  # The MIT License (MIT)
 2  #
 3  # Copyright (c) 2019 Dan Halbert for Adafruit Industries
 4  #
 5  # Permission is hereby granted, free of charge, to any person obtaining a copy
 6  # of this software and associated documentation files (the "Software"), to deal
 7  # in the Software without restriction, including without limitation the rights
 8  # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9  # copies of the Software, and to permit persons to whom the Software is
10  # furnished to do so, subject to the following conditions:
11  #
12  # The above copyright notice and this permission notice shall be included in
13  # all copies or substantial portions of the Software.
14  #
15  # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18  # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20  # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21  # THE SOFTWARE.
22  """
23  `adafruit_bluefruit_connect._xyz_packet`
24  ====================================================
25  
26  Bluefruit Connect App superclass for all data packets with (x, y, z) values
27  
28  * Author(s): Dan Halbert for Adafruit Industries
29  
30  """
31  
32  import struct
33  
34  from .packet import Packet
35  
36  
37  class _XYZPacket(Packet):
38      """A packet of x, y, z float values. Used for several different Bluefruit controller packets."""
39  
40      _FMT_PARSE = "<xxfffx"
41      PACKET_LENGTH = struct.calcsize(_FMT_PARSE)
42      # _FMT_CONSTRUCT doesn't include the trailing checksum byte.
43      _FMT_CONSTRUCT = "<2sfff"
44      # _TYPE_HEADER is set by each concrete subclass.
45  
46      def __init__(self, x, y, z):
47          """Construct an _XYZPacket subclass object
48          from the given x, y, and z float values, and type character.
49          """
50          self._x = x
51          self._y = y
52          self._z = z
53  
54      def to_bytes(self):
55          """Return the bytes needed to send this packet.
56          """
57          partial_packet = struct.pack(
58              self._FMT_CONSTRUCT, self._TYPE_HEADER, self._x, self._y, self._z
59          )
60          return self.add_checksum(partial_packet)
61  
62      @property
63      def x(self):
64          """The x value."""
65          return self._x
66  
67      @property
68      def y(self):
69          """The y value."""
70          return self._y
71  
72      @property
73      def z(self):
74          """The z value."""
75          return self._z