Dice shell-related changes:

- allow to change Dice shell without device reconnection
- renaming DiceType -> DiceShell

Author: anton-ptashnik

README.md

@@ -51,7 +51,7 @@ import godice
 async def main():
     mac = "00:00:00:00:00:00"
     client = bleak.BleakClient(mac, timeout=15)
-    async with godice.create(client, godice.DiceType.D6) as dice:
+    async with godice.create(client, godice.DiceShell.D6) as dice:
 		print("Connected")
         blue_rgb = (0, 0, 255)
         yellow_rgb = (255, 255, 0)

godice/__init__.py

@@ -5,7 +5,7 @@
 
 from .factory import (
     create,
-    DiceType
+    DiceShell
 )
 from .dice import (
     StabilityDescriptor,

godice/demo.py

@@ -19,7 +19,7 @@ async def main():
     dev, _adv_data = select_closest_device(dev_advdata_tuples)
     client = bleak.BleakClient(dev, timeout=15)
 
-    async with godice.create(client, godice.DiceType.D6) as dice:
+    async with godice.create(client, godice.DiceShell.D6) as dice:
         print(f"Connected to {dev.name}")
 
         blue_rgb = (0, 0, 255)

godice/dice.py

@@ -33,14 +33,14 @@ class Dice:
     """
     Represents a dice providing API to features
     """
-    def __init__(self, ble_client, xyz_interpret_fn) -> None:
+    def __init__(self, ble_client) -> None:
         self._client = ble_client
         self._rx_char = None
         self._tx_char = None
         self._color = None
         self._color_upd_q = asyncio.Queue()
         self._battery_lvl_upd_q = asyncio.Queue()
-        self._xyz_interpret_fn = xyz_interpret_fn
+        self._xyz_interpret_fn = None
         self._nop_cb = lambda _: None
         self._position_upd_cb = self._nop_cb
 

godice/factory.py

@@ -1,5 +1,5 @@
 """
-A factory for all dice types
+GoDice factory returning a proper Dice based on a shell
 """
 import enum
 import bleak
@@ -8,9 +8,9 @@
 from . import xyzinterpret
 
 
-class DiceType(enum.Enum):
+class DiceShell(enum.Enum):
     """
-    Available types of a dice (shells)
+    Available shells a dice may be wrapped into
     """
     D6 = 0
     D20 = 1
@@ -21,19 +21,29 @@ class DiceType(enum.Enum):
     D12 = 6
 
 xyz_interpret_map = {
-    DiceType.D6: xyzinterpret.get_rolled_number_d6,
-    DiceType.D10: xyzinterpret.get_rolled_number_d10,
-    DiceType.D10X: xyzinterpret.get_rolled_number_d10x,
-    DiceType.D20: xyzinterpret.get_rolled_number_d20,
-    DiceType.D4: xyzinterpret.get_rolled_number_d4,
-    DiceType.D8: xyzinterpret.get_rolled_number_d8,
-    DiceType.D12: xyzinterpret.get_rolled_number_d12,
+    DiceShell.D6: xyzinterpret.get_rolled_number_d6,
+    DiceShell.D10: xyzinterpret.get_rolled_number_d10,
+    DiceShell.D10X: xyzinterpret.get_rolled_number_d10x,
+    DiceShell.D20: xyzinterpret.get_rolled_number_d20,
+    DiceShell.D4: xyzinterpret.get_rolled_number_d4,
+    DiceShell.D8: xyzinterpret.get_rolled_number_d8,
+    DiceShell.D12: xyzinterpret.get_rolled_number_d12,
 }
 
 
-def create(ble_client: bleak.BleakClient, dice_type: DiceType):
+def create(ble_client: bleak.BleakClient, dice_shell: DiceShell):
     """
     Creates Dice API object representing the specified type of a dice
     """
-    _xyzinterpret_fn = xyz_interpret_map[dice_type]
-    return dice.Dice(ble_client, _xyzinterpret_fn)
+    _dice = dice.Dice(ble_client)
+    set_shell(_dice, dice_shell)
+    return _dice
+
+
+def set_shell(_dice: dice.Dice, dice_shell: DiceShell):
+    """
+    Change a dice shell.
+    Should be called in order to receive correct number notifications corresponding to a newly set shell
+    """
+    _xyzinterpret_fn = xyz_interpret_map[dice_shell]
+    _dice._xyz_interpret_fn = _xyzinterpret_fn

godice/xyzinterpret.py

@@ -1,5 +1,5 @@
 """
-Tools needed to translate coords sent by a dice to a resulting number based on a dice type
+Tools needed to translate coords sent by a dice to a resulting number based on a dice shell
 """
 
 import math