itchcraft.types

Types used in several places

Submodules

Attributes

SizedPayload

Helper union type consisting of bytes and collections.abc.Collection[int].

Classes

Preferences

User preferences for a bite healer demo session.

BiteHealer

Abstraction for a bite healer.

Package Contents

class itchcraft.types.Preferences

User preferences for a bite healer demo session.

skin_sensitivity: SkinSensitivity
generation: Generation
duration: Duration
itchcraft.types.SizedPayload

Helper union type consisting of bytes and collections.abc.Collection[int].

class itchcraft.types.BiteHealer

Bases: abc.ABC

Abstraction for a bite healer.

abstract self_test()

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

Return type:

None

abstract start_with_preferences(preferences)

Tells the device to start heating up.

Parameters:

preferences (Preferences) – how the user wants the device to be configured.

Return type:

None