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.magnetometer_packet`
24  ====================================================
25  
26  Bluefruit Connect App Magnetometer data packet.
27  
28  * Author(s): Dan Halbert for Adafruit Industries
29  
30  """
31  
32  from ._xyz_packet import _XYZPacket
33  
34  
35  class MagnetometerPacket(_XYZPacket):
36      """A packet of x, y, z float values from a magnetometer."""
37  
38      # Everything else is handled by _XYZPacket.
39      _TYPE_HEADER = b"!M"
40  
41  
42  # Register this class with the superclass. This allows the user to import only what is needed.
43  MagnetometerPacket.register_packet_type()