/ adafruit_ble / services / circuitpython.py
circuitpython.py
 1  # The MIT License (MIT)
 2  #
 3  # Copyright (c) 2019 Scott Shawcroft 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  `circuitpython`
24  ====================================================
25  
26  This module provides Services defined by CircuitPython. **Out of date.**
27  
28  """
29  
30  from . import Service
31  from ..characteristics import Characteristic
32  from ..characteristics.stream import StreamOut
33  from ..characteristics.string import StringCharacteristic
34  from ..uuid import VendorUUID
35  
36  __version__ = "0.0.0-auto.0"
37  __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_BLE.git"
38  
39  
40  class CircuitPythonUUID(VendorUUID):
41      """UUIDs with the CircuitPython base UUID."""
42  
43      def __init__(self, uuid16):
44          uuid128 = bytearray("nhtyPtiucriC".encode("utf-8") + b"\x00\x00\xaf\xad")
45          uuid128[-3] = uuid16 >> 8
46          uuid128[-4] = uuid16 & 0xFF
47          super().__init__(uuid128)
48  
49  
50  class CircuitPythonService(Service):
51      """Core CircuitPython service that allows for file modification and REPL access.
52         Unimplemented."""
53  
54      uuid = CircuitPythonUUID(0x0100)
55      filename = StringCharacteristic(
56          uuid=CircuitPythonUUID(0x0200),
57          properties=(Characteristic.READ | Characteristic.WRITE),
58      )
59      contents = StreamOut(uuid=CircuitPythonUUID(0x0201))