src/onewireio.py

   1 # SPDX-FileCopyrightText: 2021 Melissa LeBlanc-Williams for Adafruit Industries
   2 #
   3 # SPDX-License-Identifier: MIT
   4 """
   5 `onewireio` - 1-wire bus protocol
   6 =================================================
   7
   8 See `CircuitPython:onewireio` in CircuitPython for more details.
   9
  10 * Author(s): cefn
  11 """
  12
  13 # pylint: disable=import-outside-toplevel,too-many-branches,too-many-statements
  14 # pylint: disable=too-many-arguments,too-many-function-args,too-many-return-statements
  15
  16
  17 class OneWire:
  18     """
  19     Stub class for OneWire, which is currently not implemented
  20     """
  21
  22     def __init__(self, pin):
  23         raise NotImplementedError("OneWire has not been implemented")
  24
  25     def deinit(self):
  26         """
  27         Deinitialize the OneWire bus and release any hardware resources for reuse.
  28         """
  29         raise NotImplementedError("OneWire has not been implemented")
  30
  31     def reset(self):
  32         """
  33         Reset the OneWire bus and read presence
  34         """
  35         raise NotImplementedError("OneWire has not been implemented")
  36
  37     def read_bit(self):
  38         """
  39         Read in a bit
  40         """
  41         raise NotImplementedError("OneWire has not been implemented")
  42
  43     def write_bit(self, value):
  44         """
  45         Write out a bit based on value.
  46         """
  47         raise NotImplementedError("OneWire has not been implemented")