itchcraft.types
===============

.. py:module:: itchcraft.types

.. autoapi-nested-parse::

   Types used in several places



Submodules
----------

.. toctree::
   :maxdepth: 1

   /api/itchcraft/types/usb/index


Attributes
----------

.. autoapisummary::

   itchcraft.types.SizedPayload


Classes
-------

.. autoapisummary::

   itchcraft.types.Preferences
   itchcraft.types.BiteHealer


Package Contents
----------------

.. py:class:: Preferences

   User preferences for a bite healer demo session.


   .. py:attribute:: skin_sensitivity
      :type:  SkinSensitivity


   .. py:attribute:: generation
      :type:  Generation


   .. py:attribute:: duration
      :type:  Duration


.. py:data:: SizedPayload

   Helper union type consisting of :py:class:`bytes` and :py:class:`collections.abc.Collection[int]`.


.. py:class:: BiteHealer

   Bases: :py:obj:`abc.ABC`


   Abstraction for a bite healer.


   .. py:method:: self_test()
      :abstractmethod:


      Tests the device to make sure it is online and
      functional.



   .. py:method:: start_with_preferences(preferences)
      :abstractmethod:


      Tells the device to start heating up.

      :param preferences:
          how the user wants the device to be configured.