mpf 0.80.0.dev8__tar.gz → 0.80.0.dev10__tar.gz

{mpf-0.80.0.dev8 → mpf-0.80.0.dev10}/.github/workflows/build_wheels.yml

@@ -22,7 +22,7 @@ jobs:
       - name: Setup python
         uses: actions/setup-python@v5
         with:
-          python-version: 3.11
+          python-version: 3.12
 
       - name: Install MPF
         run: |

{mpf-0.80.0.dev8 → mpf-0.80.0.dev10}/.github/workflows/prospector.yml

@@ -6,7 +6,7 @@ jobs:
   prospector:
     name: Run Prospector on all Python files
     runs-on: ubuntu-latest
-    
+
     steps:
       - name: Checkout repository
         uses: actions/checkout@v2
@@ -14,6 +14,7 @@ jobs:
       - name: Setup python
         uses: actions/setup-python@v4
         with:
+          # Ubuntu can't run 3.12 because Pillow dependencies.
           python-version: 3.11
 
       - name: Install MPF

{mpf-0.80.0.dev8 → mpf-0.80.0.dev10}/.github/workflows/run_tests.yml

@@ -10,30 +10,32 @@ jobs:
       fail-fast: false
       matrix:
         include:
-        - os: windows-latest
-          python-version: 3.8
-        - os: windows-latest
-          python-version: 3.9
         - os: windows-latest
           python-version: "3.10"
         - os: windows-latest
           python-version: 3.11
-        - os: ubuntu-latest
-          python-version: 3.8
-        - os: ubuntu-latest
-          python-version: 3.9
+        - os: windows-latest
+          python-version: 3.12
+        - os: windows-latest
+          python-version: 3.13
+
         - os: ubuntu-latest
           python-version: "3.10"
         - os: ubuntu-latest
           python-version: 3.11
-        - os: macos-latest
-          python-version: 3.8
-        - os: macos-latest
-          python-version: 3.9
+        - os: ubuntu-latest
+          python-version: 3.12
+        - os: ubuntu-latest
+          python-version: 3.13
+
         - os: macos-latest
           python-version: "3.10"
         - os: macos-latest
           python-version: 3.11
+        - os: macos-latest
+          python-version: 3.12
+        - os: macos-latest
+          python-version: 3.13
 
     steps:
       - name: Checkout MPF

{mpf-0.80.0.dev8 → mpf-0.80.0.dev10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mpf
-Version: 0.80.0.dev8
+Version: 0.80.0.dev10
 Summary: The Mission Pinball Framework (MPF)
 Author-email: The Mission Pinball Framework Team <brian@missionpinball.org>
 License: MIT
@@ -10,18 +10,17 @@ Keywords: pinball
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Natural Language :: English
 Classifier: Operating System :: MacOS :: MacOS X
 Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Topic :: Artistic Software
 Classifier: Topic :: Games/Entertainment :: Arcade
-Requires-Python: >=3.8
+Requires-Python: <3.14,>=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
 License-File: AUTHORS.md
@@ -35,6 +34,7 @@ Requires-Dist: ruamel.yaml==0.18.6
 Requires-Dist: setuptools~=72.2.0
 Requires-Dist: sortedcontainers==2.4.0
 Requires-Dist: terminaltables==3.1.10
+Requires-Dist: Pillow==10.4.0
 Provides-Extra: crash-reporter
 Requires-Dist: requests==2.28.2; extra == "crash-reporter"
 Provides-Extra: irc

{mpf-0.80.0.dev8 → mpf-0.80.0.dev10}/mpf/_version.py

@@ -10,7 +10,7 @@ PyPI.
 
 """
 
-__version__ = '0.80.0.dev8'
+__version__ = '0.80.0.dev10'
 '''The full version of MPF.'''
 
 __short_version__ = '0.80'
@@ -19,6 +19,9 @@ __short_version__ = '0.80'
 __bcp_version__ = '1.1'
 '''The version of BCP this build of MPF uses.'''
 
+__gmc_version__ = '0.1.5'
+'''The version of GMC this build of MPF requires.'''
+
 __config_version__ = '6'
 '''The config file version this build of MPF uses.'''
 

{mpf-0.80.0.dev8 → mpf-0.80.0.dev10}/mpf/config_spec.yaml

@@ -455,7 +455,7 @@ diverters:
     __type__: device
     activate_events: event_handler|event_handler:ms|None
     activation_coil: single|machine(coils)|None
-    activation_time: single|ms|0
+    activation_time: single|template_ms|None
     activation_switches: list|machine(switches)|None
     allow_multiple_concurrent_ejects_to_same_side: single|bool|true
     cool_down_time: single|ms|0
@@ -628,6 +628,7 @@ fast:
     __type__: config
     net: single|subconfig(fast_net)|None
     exp: single|subconfig(fast_exp)|None
+    exp_int: single|subconfig(fast_exp)|None    
     aud: single|subconfig(fast_aud)|None
     seg: single|subconfig(fast_seg)|None
     dmd: single|subconfig(fast_dmd)|None
@@ -817,6 +818,7 @@ hardware:
     accelerometers: list|str|default
     i2c: list|str|default
     stepper_controllers: list|str|default
+    shaker_controllers: list|str|default
     hardware_sound_system: list|str|default
 hardware_sound_systems:
     __valid_in__: machine
@@ -1811,6 +1813,18 @@ steppers:
 stepper_position_settings:
     event: single|str|
     speed: single|int|None
+shakers:
+    __valid_in__: machine
+    __type__: device
+    default_power: single|float|0.0
+    number: single|str|
+    control_events: dict|str:subconfig(shaker_pulse_settings)|None
+    platform: single|str|None
+    platform_settings: single|dict|None
+shaker_pulse_settings:
+    action: single|enum(pulse,stop)|pulse
+    power: single|float|None
+    duration: single|template_secs|None
 spike_stepper_settings:
     homing_speed: single|int|10
     speed: single|int|20

{mpf-0.80.0.dev8 → mpf-0.80.0.dev10}/mpf/core/bcp/bcp_socket_client.py

@@ -6,7 +6,7 @@ import asyncio
 
 from typing import Tuple
 
-from mpf._version import __version__, __bcp_version__
+from mpf._version import __version__, __bcp_version__, __gmc_version__
 from mpf.core.bcp.bcp_client import BaseBcpClient
 
 BYTE_MARKER = b'&bytes='
@@ -348,7 +348,9 @@ class BCPClientSocket(BaseBcpClient):
         """Send BCP 'hello' command."""
         self.send('hello', {"version": __bcp_version__,
                             "controller_name": 'Mission Pinball Framework',
-                            "controller_version": __version__})
+                            "controller_version": __version__,
+                            "gmc_version": __gmc_version__,
+                            })
 
     def send_goodbye(self):
         """Send BCP 'goodbye' command."""

{mpf-0.80.0.dev8 → mpf-0.80.0.dev10}/mpf/core/machine.py

@@ -61,6 +61,7 @@ if MYPY:   # pragma: no cover
     from mpf.devices.digital_output import DigitalOutput    # pylint: disable-msg=cyclic-import,unused-import
     from logging import Logger  # noqa
     from mpf.devices.autofire import AutofireCoil   # pylint: disable-msg=cyclic-import,unused-import
+    from mpf.devices.shaker import Shaker   # pylint: disable-msg=cyclic-import,unused-import
     from mpf.devices.stepper import Stepper     # pylint: disable-msg=cyclic-import,unused-import
     from mpf.config_players.show_player import ShowPlayer   # pylint: disable-msg=cyclic-import,unused-import
     from mpf.devices.dmd import Dmd     # pylint: disable-msg=cyclic-import,unused-import
@@ -167,6 +168,7 @@ class MachineController(LogMixin):
             self.autofire_coils = {}                    # type: Dict[str, AutofireCoil]
             self.motors = {}                            # type: Dict[str, Motor]
             self.digital_outputs = {}                   # type: Dict[str, DigitalOutput]
+            self.shakers = {}                           # type: Dict[str, Shaker]
             self.shows = {}                             # type: Dict[str, Show]
             self.shots = {}                             # type: Dict[str, Shot]
             self.shot_groups = {}                       # type: Dict[str, ShotGroup]
@@ -444,9 +446,9 @@ class MachineController(LogMixin):
         """
         python_version_info = sys.version_info
 
-        # if not (python_version_info[0] == 3 and python_version_info[1] in (5, 6, 7, 8, 9)):
+        # if not (python_version_info[0] == 3 and python_version_info[1] in (10, 11, 12, 13)):
         #     raise AssertionError("Incorrect Python version. MPF requires "
-        #                          "Python 3.5, 3.6, 3.7, 3.8 or 3.9. You have Python {}.{}.{}."
+        #                          "Python 3.10, 3.11, 3.12 or 3.13. You have Python {}.{}.{}."
         #                          .format(python_version_info[0], python_version_info[1],
         #                                  python_version_info[2]))
 

{mpf-0.80.0.dev8 → mpf-0.80.0.dev10}/mpf/core/platform.py

@@ -12,6 +12,7 @@ from mpf.core.utility_functions import Util
 
 MYPY = False
 if MYPY:   # pragma: no cover
+    from mpf.devices.shaker import Shaker   # pylint: disable-msg=cyclic-import,unused-import
     from mpf.devices.switch import Switch   # pylint: disable-msg=cyclic-import,unused-import
     from mpf.devices.stepper import Stepper     # pylint: disable-msg=cyclic-import,unused-import
     from mpf.devices.servo import Servo     # pylint: disable-msg=cyclic-import,unused-import
@@ -19,6 +20,7 @@ if MYPY:   # pragma: no cover
     from mpf.platforms.interfaces.switch_platform_interface import SwitchPlatformInterface  # pylint: disable-msg=cyclic-import,unused-import; # noqa
     from mpf.platforms.interfaces.light_platform_interface import LightPlatformInterface    # pylint: disable-msg=cyclic-import,unused-import; # noqa
     from mpf.platforms.interfaces.servo_platform_interface import ServoPlatformInterface    # pylint: disable-msg=cyclic-import,unused-import; # noqa
+    from mpf.platforms.interfaces.shaker_platform_interface import ShakerPlatformInterface    # pylint: disable-msg=cyclic-import,unused-import; # noqa
     from mpf.platforms.interfaces.segment_display_platform_interface import SegmentDisplayPlatformInterface     # pylint: disable-msg=cyclic-import,unused-import; # noqa
     from mpf.platforms.interfaces.hardware_sound_platform_interface import HardwareSoundPlatformInterface   # pylint: disable-msg=cyclic-import,unused-import; # noqa
     from mpf.platforms.interfaces.stepper_platform_interface import StepperPlatformInterface    # pylint: disable-msg=cyclic-import,unused-import; # noqa
@@ -60,6 +62,7 @@ class BasePlatform(LogMixin, metaclass=abc.ABCMeta):
         self.features['has_segment_displays'] = False
         self.features['has_hardware_sound_systems'] = True
         self.features['has_steppers'] = False
+        self.features['has_shakers'] = False
         self.features['allow_empty_numbers'] = False
         self.features['hardware_eos_repulse'] = False
 
@@ -404,6 +407,53 @@ class StepperPlatform(BasePlatform, metaclass=abc.ABCMeta):
         raise NotImplementedError
 
 
+class ShakerPlatform(BasePlatform, metaclass=abc.ABCMeta):
+
+    """Baseclass for shaker platforms in MPF."""
+
+    __slots__ = []  # type: List[str]
+
+    def __init__(self, machine):
+        """Add shaker feature."""
+        super().__init__(machine)
+        self.features['has_shakers'] = True
+
+    @classmethod
+    def get_stepper_config_section(cls) -> Optional[str]:
+        """Return config section for additional stepper config items."""
+        return None
+
+    def validate_shaker_section(self, shaker: "Shaker", config: dict) -> dict:
+        """Validate a shaker config for platform.
+
+        Args:
+        ----
+            shaker: Shaker to validate.
+            config: Config to validate.
+
+        Returns: Validated config.
+        """
+        if self.get_shaker_config_section():
+            spec = self.get_shaker_config_section()    # pylint: disable-msg=assignment-from-none
+            config = shaker.machine.config_validator.validate_config(spec, config, shaker.name)
+        elif config:
+            raise AssertionError("No platform_config supported but not empty {} for shaker {}".
+                                 format(config, shaker.name))
+
+        return config
+
+    @abc.abstractmethod
+    async def configure_shaker(self, number: str, config: dict) -> "ShakerPlatformInterface":
+        """Configure a shaker device in platform.
+
+        Args:
+        ----
+            number: Number of the shaker
+            config: Config for this shaker.
+        """
+        raise NotImplementedError
+
+
 class LightConfigColors(Enum):
 
     """Light color for LightConfig."""

{mpf-0.80.0.dev8 → mpf-0.80.0.dev10}/mpf/devices/diverter.py

@@ -258,7 +258,7 @@ class Diverter(SystemWideDevice):
     def schedule_deactivation(self):
         """Schedule a delay to deactivate this diverter."""
         if self.config['activation_time']:
-            self.delay.add(name='deactivate_timed', ms=self.config['activation_time'],
+            self.delay.add(name='deactivate_timed', ms=self.config['activation_time'].evaluate({}),
                            callback=self.deactivate)
 
     def _enable_switches(self):

mpf-0.80.0.dev10/mpf/devices/shaker.py

@@ -0,0 +1,66 @@
+"""A digital output on either a light or driver platform."""
+from typing import Union, Optional
+
+from mpf.core.delays import DelayManager
+from mpf.core.events import event_handler
+
+from mpf.core.machine import MachineController
+from mpf.core.platform import DriverConfig, LightConfig, LightConfigColors
+from mpf.core.system_wide_device import SystemWideDevice
+from mpf.platforms.interfaces.driver_platform_interface import PulseSettings, HoldSettings
+
+MYPY = False
+if MYPY:    # pragma: no cover
+    from mpf.core.platform import ShakerPlatform    # pylint: disable-msg=cyclic-import,unused-import
+    from mpf.platforms.interfaces.shaker_platform_interface import ShakerPlatformInterface  # pylint: disable-msg=cyclic-import,unused-import
+
+class Shaker(SystemWideDevice):
+
+    """A digital output on either a light or driver platform."""
+
+    config_section = 'shakers'
+    collection = 'shakers'
+    class_label = 'shaker'
+
+    __slots__ = ["hw_shaker", "type", "__dict__"]
+
+    def __init__(self, machine: MachineController, name: str) -> None:
+        """Initialize digital output."""
+        self.hw_shaker = None           # type: Optional[ShakerPlatformInterface]
+        self.platform = None            # type: Optional[ShakerPlatform]
+        super().__init__(machine, name)
+        self.delay = DelayManager(self.machine)
+
+    async def _initialize(self):
+        await super()._initialize()
+        self.platform = self.machine.get_platform_sections('shaker_controllers', self.config['platform'])
+        self.platform.assert_has_feature("shakers")
+        self.hw_shaker = await self.platform.configure_shaker(self.config['number'], self.config['platform_settings'])
+        for event, config in self.config['control_events'].items():
+            if config.get('action') == 'stop':
+                self.machine.events.add_handler(event, self.event_stop)
+                continue
+            self.machine.events.add_handler(event,
+                                            self.event_pulse,
+                                            power=config.get('power'),
+                                            duration=config['duration'].evaluate({}))
+
+    @event_handler(1)
+    def event_pulse(self, duration=None, power=None, **kwargs):
+        del kwargs
+        self.pulse(duration, power)
+
+    def pulse(self, duration=None, power=None):
+        if power is None:
+            power = self.config['default_power']
+        if not duration:
+            raise AssertionError("Shaker pulse called with no duration value")
+        self.hw_shaker.pulse(duration, power)
+
+    @event_handler(2)
+    def event_stop(self, **kwargs):
+        del kwargs
+        self.stop()
+
+    def stop(self):
+        self.hw_shaker.stop()

{mpf-0.80.0.dev8 → mpf-0.80.0.dev10}/mpf/devices/shot.py

@@ -425,8 +425,8 @@ class Shot(EnableDisableMixin, ModeDevice):
     def _register_control_event_handlers(self):
         for control_event in self.config['control_events']:
             for event in control_event['events']:
-                self._handlers.append(self.machine.events.add_handler(event, self._control_events,
-                                                                      control_event_config=control_event))
+                self.machine.events.add_handler(event, self._control_events,
+                                                control_event_config=control_event)
 
     @event_handler(7)
     def _control_events(self, control_event_config, **kwargs):

{mpf-0.80.0.dev8 → mpf-0.80.0.dev10}/mpf/modes/carousel/code/carousel.py

@@ -57,11 +57,12 @@ class Carousel(Mode):
             elif not item.condition or item.condition.evaluate({}):
                 self._items.append(item.name)
         if not self._items:
-            self.machine.events.post("{}_items_empty".format(self.name))
-            '''event (carousel_name)_items_empty
+            self.machine.events.post("carousel_items_empty", carousel=self.name)
+            '''event carousel_items_empty
                 desc: A carousel's items are all conditional and all evaluated false.
-                    If this event is posted, the carousel mode will not be started.
-                '''
+                    If this event is posted, the carousel mode will also stop itself
+                    instead of continuing to start and run.
+            '''
             self.stop()
             return
 
@@ -97,15 +98,17 @@ class Carousel(Mode):
     def _update_highlighted_item(self, direction):
         self.debug_log("Highlighted item: " + self._get_highlighted_item())
 
-        self.machine.events.post("item_highlighted",
+        self.machine.events.post("carousel_item_highlighted",
                                  carousel=self.name,
                                  direction=direction,
                                  item=self._get_highlighted_item())
-        '''event (carousel_name)_(item)_highlighted
+        '''event carousel_item_highlighted
             desc: Player highlighted an item in a carousel. Mostly used to play shows or trigger slides.
             args:
+               carousel: The name of the carousel that posted this event.
                direction: The direction the carousel is moving. Either forwards or backwards. None on mode start.
-            '''
+               item: The name of the item that is now highlighted.
+        '''
 
     def _get_available_items(self):
         # Return the default items
@@ -143,13 +146,13 @@ class Carousel(Mode):
         self.debug_log("Selected mode: " + str(self._get_highlighted_item()))
         self._done = True
 
-        self.machine.events.post("{}_{}_selected".format(self.name, self._get_highlighted_item()))
-        '''event (carousel_name)_(item)_selected
-            desc: Player selected an item in a carousel. Can be used to trigger modes. '''
-        self.machine.events.post("{}_item_selected".format(self.name))
-        '''event (carousel_name)_item_selected
-            desc: Player selected any item in a carousel. Used to stop mode. '''
-
+        self.machine.events.post("carousel_item_selected", carousel=self.name, item=self._get_highlighted_item())
+        '''event carousel_item_selected
+            desc: Player selected an item in a carousel.
+            args:
+               carousel: The name of the carousel that posted this event.
+               item: The name of the item that is being selected.
+        '''
     def _block_enable(self, **kwargs):
         del kwargs
         self._is_blocking = True