ovos-ui-enclosure-protocol 0.0.1__tar.gz

ovos_ui_enclosure_protocol-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 Casimiro Ferreira
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ovos_ui_enclosure_protocol-0.0.1/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: ovos-ui-enclosure-protocol
+Version: 0.0.1
+Summary: Legacy Mark-1 hardware enclosure protocol listener for OpenVoiceOS
+Author-email: JarbasAi <jarbasai@mailfence.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/OpenVoiceOS/ovos-ui-enclosure-protocol
+Project-URL: Repository, https://github.com/OpenVoiceOS/ovos-ui-enclosure-protocol
+Keywords: enclosure,mark1,mycroft,OVOS,OpenVoiceOS,PHAL
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ovos-bus-client
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Dynamic: license-file
+
+# ovos-ui-enclosure-protocol
+
+The consumer/listener home of the legacy **Mark-1 hardware enclosure protocol**
+for OpenVoiceOS.
+
+The `enclosure.*` bus messages control the Mark-1 hardware enclosure: the LED
+eyes, the mouth/faceplate display, and the system LEDs. This package provides
+`EnclosureProtocolListener`, a consumer mix-in that a hardware enclosure plugin
+inherits to wire the `enclosure.*` subscriptions to overridable no-op handlers.
+[`ovos-PHAL-plugin-mk1`](https://github.com/OpenVoiceOS/ovos-PHAL-plugin-mk1)
+is the reference listener implementation.
+
+The producer side — `EnclosureAPI`, the skill-facing helper that *emits*
+`enclosure.*` — lives in
+[`ovos-gui-api-client`](https://github.com/OpenVoiceOS/ovos-gui-api-client)
+alongside `GUIInterface`, so `self.gui` and `self.enclosure` come from the same
+client.
+
+The enclosure protocol is **no longer a core abstraction**: `PHALPlugin` in
+`ovos-plugin-manager` no longer bakes in the `enclosure.*` handlers, and modern
+visual output is done through `GUIInterface` (OVOS-GUI-1). This package exists
+so hardware enclosure plugins keep a stable, dependency-light home for the
+listener side of the protocol. It does **not** reimplement GUI templates.
+
+## Install
+
+```bash
+pip install ovos-ui-enclosure-protocol
+```
+
+## Implementing a listener
+
+```python
+from ovos_ui_enclosure_protocol import EnclosureProtocolListener
+
+class MyEnclosure(EnclosureProtocolListener):
+    def __init__(self, bus):
+        self.bus = bus
+        self.register_enclosure_namespace()
+
+    def on_eyes_color(self, message=None):
+        ...  # drive the hardware
+
+    def shutdown(self):
+        self.shutdown_enclosure_namespace()
+```
+
+Every handler defaults to a no-op, so a plugin only overrides the commands its
+hardware supports. `ovos-PHAL-plugin-mk1` is the reference listener
+implementation.
+
+## Documentation
+
+- [`docs/index.md`](docs/index.md) — overview, install, listener guide.
+- [`docs/enclosure-protocol.md`](docs/enclosure-protocol.md) — the full
+  `enclosure.*` message contract with producers and listeners.
+
+## License
+
+Apache-2.0

ovos_ui_enclosure_protocol-0.0.1/README.md

@@ -0,0 +1,60 @@
+# ovos-ui-enclosure-protocol
+
+The consumer/listener home of the legacy **Mark-1 hardware enclosure protocol**
+for OpenVoiceOS.
+
+The `enclosure.*` bus messages control the Mark-1 hardware enclosure: the LED
+eyes, the mouth/faceplate display, and the system LEDs. This package provides
+`EnclosureProtocolListener`, a consumer mix-in that a hardware enclosure plugin
+inherits to wire the `enclosure.*` subscriptions to overridable no-op handlers.
+[`ovos-PHAL-plugin-mk1`](https://github.com/OpenVoiceOS/ovos-PHAL-plugin-mk1)
+is the reference listener implementation.
+
+The producer side — `EnclosureAPI`, the skill-facing helper that *emits*
+`enclosure.*` — lives in
+[`ovos-gui-api-client`](https://github.com/OpenVoiceOS/ovos-gui-api-client)
+alongside `GUIInterface`, so `self.gui` and `self.enclosure` come from the same
+client.
+
+The enclosure protocol is **no longer a core abstraction**: `PHALPlugin` in
+`ovos-plugin-manager` no longer bakes in the `enclosure.*` handlers, and modern
+visual output is done through `GUIInterface` (OVOS-GUI-1). This package exists
+so hardware enclosure plugins keep a stable, dependency-light home for the
+listener side of the protocol. It does **not** reimplement GUI templates.
+
+## Install
+
+```bash
+pip install ovos-ui-enclosure-protocol
+```
+
+## Implementing a listener
+
+```python
+from ovos_ui_enclosure_protocol import EnclosureProtocolListener
+
+class MyEnclosure(EnclosureProtocolListener):
+    def __init__(self, bus):
+        self.bus = bus
+        self.register_enclosure_namespace()
+
+    def on_eyes_color(self, message=None):
+        ...  # drive the hardware
+
+    def shutdown(self):
+        self.shutdown_enclosure_namespace()
+```
+
+Every handler defaults to a no-op, so a plugin only overrides the commands its
+hardware supports. `ovos-PHAL-plugin-mk1` is the reference listener
+implementation.
+
+## Documentation
+
+- [`docs/index.md`](docs/index.md) — overview, install, listener guide.
+- [`docs/enclosure-protocol.md`](docs/enclosure-protocol.md) — the full
+  `enclosure.*` message contract with producers and listeners.
+
+## License
+
+Apache-2.0

ovos_ui_enclosure_protocol-0.0.1/ovos_ui_enclosure_protocol/__init__.py

@@ -0,0 +1,24 @@
+"""ovos-ui-enclosure-protocol.
+
+Consumer side of the legacy Mark-1 hardware enclosure protocol.
+
+``EnclosureProtocolListener`` is a mix-in that a hardware enclosure plugin
+inherits to wire the ``enclosure.*`` bus subscriptions to overridable no-op
+handlers, so a plugin only implements the commands its hardware supports.
+``ovos-PHAL-plugin-mk1`` is the reference listener implementation.
+
+The producer side (``EnclosureAPI``, the skill-facing helper that emits the
+``enclosure.*`` messages) lives in ``ovos-gui-api-client`` alongside
+``GUIInterface`` — ``self.gui`` and ``self.enclosure`` come from the same
+client. This package does not reimplement it.
+
+The enclosure protocol is **no longer a core abstraction**: ``PHALPlugin`` in
+``ovos-plugin-manager`` no longer wires ``enclosure.*`` handlers. A hardware
+plugin that wants enclosure-protocol support mixes in
+``EnclosureProtocolListener`` from this package instead. Modern visual output
+is handled by ``GUIInterface`` (OVOS-GUI-1) and its template system.
+"""
+from ovos_ui_enclosure_protocol.listener import EnclosureProtocolListener
+from ovos_ui_enclosure_protocol.version import __version__
+
+__all__ = ["EnclosureProtocolListener", "__version__"]

ovos_ui_enclosure_protocol-0.0.1/ovos_ui_enclosure_protocol/listener.py

@@ -0,0 +1,273 @@
+"""Consumer side of the enclosure protocol.
+
+``EnclosureProtocolListener`` is a mix-in that wires the ``enclosure.*`` bus
+messages emitted by :class:`EnclosureAPI` to overridable no-op handler methods.
+A hardware enclosure plugin inherits this mix-in to get the subscriptions wired
+up and only overrides the handlers it cares about.
+
+This deliberately does NOT include the general PHAL lifecycle (Thread/run/
+shutdown/register_core_events) — those stay in ``ovos-plugin-manager``'s
+``PHALPlugin``. The listener base only needs ``self.bus``.
+
+``ovos-PHAL-plugin-mk1`` is the reference implementation that subclasses this
+listener.
+"""
+
+
+class EnclosureProtocolListener:
+    """Mix-in that subscribes a hardware plugin to the ``enclosure.*`` protocol.
+
+    Subclasses are expected to provide a ``self.bus`` (a connected
+    ``MessageBusClient``) before calling :meth:`register_enclosure_namespace`,
+    and to override the ``on_*`` handlers they support. Every handler defaults
+    to a no-op so unsupported commands are simply ignored.
+    """
+
+    _mouth_events = False
+
+    def register_enclosure_namespace(self):
+        """Wire all ``enclosure.*`` messages to this listener's handlers."""
+        self.bus.on("enclosure.notify.no_internet", self.on_no_internet)
+        self.bus.on("enclosure.reset", self.on_reset)
+
+        # enclosure commands for the system
+        self.bus.on("enclosure.system.reset", self.on_system_reset)
+        self.bus.on("enclosure.system.mute", self.on_system_mute)
+        self.bus.on("enclosure.system.unmute", self.on_system_unmute)
+        self.bus.on("enclosure.system.blink", self.on_system_blink)
+
+        # enclosure commands for eyes
+        self.bus.on("enclosure.eyes.on", self.on_eyes_on)
+        self.bus.on("enclosure.eyes.off", self.on_eyes_off)
+        self.bus.on("enclosure.eyes.blink", self.on_eyes_blink)
+        self.bus.on("enclosure.eyes.narrow", self.on_eyes_narrow)
+        self.bus.on("enclosure.eyes.look", self.on_eyes_look)
+        self.bus.on("enclosure.eyes.color", self.on_eyes_color)
+        self.bus.on("enclosure.eyes.level", self.on_eyes_brightness)
+        self.bus.on("enclosure.eyes.volume", self.on_eyes_volume)
+        self.bus.on("enclosure.eyes.spin", self.on_eyes_spin)
+        self.bus.on("enclosure.eyes.timedspin", self.on_eyes_timed_spin)
+        self.bus.on("enclosure.eyes.reset", self.on_eyes_reset)
+        self.bus.on("enclosure.eyes.setpixel", self.on_eyes_set_pixel)
+        self.bus.on("enclosure.eyes.fill", self.on_eyes_fill)
+
+        # enclosure commands for mouth
+        self.bus.on("enclosure.mouth.events.activate", self._activate_mouth_events)
+        self.bus.on("enclosure.mouth.events.deactivate", self._deactivate_mouth_events)
+        self.bus.on("enclosure.mouth.talk", self._on_mouth_talk)
+        self.bus.on("enclosure.mouth.think", self._on_mouth_think)
+        self.bus.on("enclosure.mouth.listen", self._on_mouth_listen)
+        self.bus.on("enclosure.mouth.smile", self._on_mouth_smile)
+        self.bus.on("enclosure.mouth.viseme", self._on_mouth_viseme)
+        self.bus.on("enclosure.mouth.viseme_list", self._on_mouth_viseme_list)
+
+        # mouth / matrix display
+        self.bus.on("enclosure.mouth.reset", self.on_display_reset)
+        self.bus.on("enclosure.mouth.text", self.on_text)
+        self.bus.on("enclosure.mouth.display", self.on_display)
+        self.bus.on("enclosure.weather.display", self.on_weather_display)
+
+    def shutdown_enclosure_namespace(self):
+        """Remove all ``enclosure.*`` subscriptions wired by this listener."""
+        self.bus.remove("enclosure.notify.no_internet", self.on_no_internet)
+        self.bus.remove("enclosure.reset", self.on_reset)
+
+        self.bus.remove("enclosure.system.reset", self.on_system_reset)
+        self.bus.remove("enclosure.system.mute", self.on_system_mute)
+        self.bus.remove("enclosure.system.unmute", self.on_system_unmute)
+        self.bus.remove("enclosure.system.blink", self.on_system_blink)
+
+        self.bus.remove("enclosure.eyes.on", self.on_eyes_on)
+        self.bus.remove("enclosure.eyes.off", self.on_eyes_off)
+        self.bus.remove("enclosure.eyes.blink", self.on_eyes_blink)
+        self.bus.remove("enclosure.eyes.narrow", self.on_eyes_narrow)
+        self.bus.remove("enclosure.eyes.look", self.on_eyes_look)
+        self.bus.remove("enclosure.eyes.color", self.on_eyes_color)
+        self.bus.remove("enclosure.eyes.level", self.on_eyes_brightness)
+        self.bus.remove("enclosure.eyes.volume", self.on_eyes_volume)
+        self.bus.remove("enclosure.eyes.spin", self.on_eyes_spin)
+        self.bus.remove("enclosure.eyes.timedspin", self.on_eyes_timed_spin)
+        self.bus.remove("enclosure.eyes.reset", self.on_eyes_reset)
+        self.bus.remove("enclosure.eyes.setpixel", self.on_eyes_set_pixel)
+        self.bus.remove("enclosure.eyes.fill", self.on_eyes_fill)
+
+        self.bus.remove("enclosure.mouth.events.activate", self._activate_mouth_events)
+        self.bus.remove("enclosure.mouth.events.deactivate", self._deactivate_mouth_events)
+        self.bus.remove("enclosure.mouth.talk", self._on_mouth_talk)
+        self.bus.remove("enclosure.mouth.think", self._on_mouth_think)
+        self.bus.remove("enclosure.mouth.listen", self._on_mouth_listen)
+        self.bus.remove("enclosure.mouth.smile", self._on_mouth_smile)
+        self.bus.remove("enclosure.mouth.viseme", self._on_mouth_viseme)
+        self.bus.remove("enclosure.mouth.viseme_list", self._on_mouth_viseme_list)
+
+        self.bus.remove("enclosure.mouth.reset", self.on_display_reset)
+        self.bus.remove("enclosure.mouth.text", self.on_text)
+        self.bus.remove("enclosure.mouth.display", self.on_display)
+        self.bus.remove("enclosure.weather.display", self.on_weather_display)
+
+    # Lifecycle
+    def on_reset(self, message=None):
+        """The enclosure should restore itself to a started state.
+        Typically this would be represented by the eyes being 'open'
+        and the mouth reset to its default (smile or blank).
+        """
+        pass
+
+    def on_no_internet(self, message=None):
+        """Handle the no-internet notification."""
+        pass
+
+    # System events
+    def on_system_reset(self, message=None):
+        """The enclosure hardware should reset any CPUs, etc."""
+        pass
+
+    def on_system_mute(self, message=None):
+        """Mute (turn off) the system speaker."""
+        pass
+
+    def on_system_unmute(self, message=None):
+        """Unmute (turn on) the system speaker."""
+        pass
+
+    def on_system_blink(self, message=None):
+        """The 'eyes' should blink the given number of times."""
+        pass
+
+    # Eyes events
+    def on_eyes_on(self, message=None):
+        """Illuminate or show the eyes."""
+        pass
+
+    def on_eyes_off(self, message=None):
+        """Turn off or hide the eyes."""
+        pass
+
+    def on_eyes_fill(self, message=None):
+        """Use the eyes as a type of progress meter."""
+        pass
+
+    def on_eyes_blink(self, message=None):
+        """Make the eyes blink."""
+        pass
+
+    def on_eyes_narrow(self, message=None):
+        """Make the eyes look narrow, like a squint."""
+        pass
+
+    def on_eyes_look(self, message=None):
+        """Make the eyes look to the given side."""
+        pass
+
+    def on_eyes_color(self, message=None):
+        """Change the eye color to the given RGB color."""
+        pass
+
+    def on_eyes_brightness(self, message=None):
+        """Set the brightness of the eyes in the display."""
+        pass
+
+    def on_eyes_reset(self, message=None):
+        """Restore the eyes to their default (ready) state."""
+        pass
+
+    def on_eyes_timed_spin(self, message=None):
+        """Make the eyes 'roll' for the given time."""
+        pass
+
+    def on_eyes_volume(self, message=None):
+        """Indicate the volume using the eyes."""
+        pass
+
+    def on_eyes_spin(self, message=None):
+        """Make the eyes 'roll'."""
+        pass
+
+    def on_eyes_set_pixel(self, message=None):
+        """Set individual pixels of the neopixel eyes."""
+        pass
+
+    # Mouth events (gated by mouth_events_active)
+    def _on_mouth_talk(self, message=None):
+        """Show a generic 'talking' animation for non-synched speech."""
+        if self.mouth_events_active:
+            self.on_talk(message)
+
+    def _on_mouth_think(self, message=None):
+        """Show a 'thinking' image or animation."""
+        if self.mouth_events_active:
+            self.on_think(message)
+
+    def _on_mouth_listen(self, message=None):
+        """Show a 'listening' image or animation."""
+        if self.mouth_events_active:
+            self.on_listen(message)
+
+    def _on_mouth_smile(self, message=None):
+        """Show a 'smile' image or animation."""
+        if self.mouth_events_active:
+            self.on_smile(message)
+
+    def _on_mouth_viseme(self, message=None):
+        """Display a viseme mouth shape for synched speech."""
+        if self.mouth_events_active:
+            self.on_viseme(message)
+
+    def _on_mouth_viseme_list(self, message=None):
+        """Handle mouth visemes sent as a list in a single message."""
+        if self.mouth_events_active:
+            self.on_viseme_list(message)
+
+    # Display (faceplate) events
+    def on_display_reset(self, message=None):
+        """Restore the mouth display to normal (blank)."""
+        pass
+
+    def on_talk(self, message=None):
+        """Show a generic 'talking' animation for non-synched speech."""
+        pass
+
+    def on_think(self, message=None):
+        """Show a 'thinking' image or animation."""
+        pass
+
+    def on_listen(self, message=None):
+        """Show a 'listening' image or animation."""
+        pass
+
+    def on_smile(self, message=None):
+        """Show a 'smile' image or animation."""
+        pass
+
+    def on_viseme(self, message=None):
+        """Display a viseme mouth shape for synched speech."""
+        pass
+
+    def on_viseme_list(self, message=None):
+        """Handle mouth visemes sent as a list in a single message."""
+        pass
+
+    def on_text(self, message=None):
+        """Display text (scrolling as needed)."""
+        pass
+
+    def on_display(self, message=None):
+        """Display images on the faceplate."""
+        pass
+
+    def on_weather_display(self, message=None):
+        """Show the temperature and a weather icon."""
+        pass
+
+    # Mouth-event gating
+    @property
+    def mouth_events_active(self):
+        return self._mouth_events
+
+    def _activate_mouth_events(self, message=None):
+        """Enable movement of the mouth with speech."""
+        self._mouth_events = True
+
+    def _deactivate_mouth_events(self, message=None):
+        """Disable movement of the mouth with speech."""
+        self._mouth_events = False

ovos_ui_enclosure_protocol-0.0.1/ovos_ui_enclosure_protocol/version.py

@@ -0,0 +1,10 @@
+# START_VERSION_BLOCK
+VERSION_MAJOR = 0
+VERSION_MINOR = 0
+VERSION_BUILD = 1
+VERSION_ALPHA = 0
+# END_VERSION_BLOCK
+
+__version__ = f"{VERSION_MAJOR}.{VERSION_MINOR}.{VERSION_BUILD}" + (
+    f"a{VERSION_ALPHA}" if VERSION_ALPHA else ""
+)

ovos_ui_enclosure_protocol-0.0.1/ovos_ui_enclosure_protocol.egg-info/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: ovos-ui-enclosure-protocol
+Version: 0.0.1
+Summary: Legacy Mark-1 hardware enclosure protocol listener for OpenVoiceOS
+Author-email: JarbasAi <jarbasai@mailfence.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/OpenVoiceOS/ovos-ui-enclosure-protocol
+Project-URL: Repository, https://github.com/OpenVoiceOS/ovos-ui-enclosure-protocol
+Keywords: enclosure,mark1,mycroft,OVOS,OpenVoiceOS,PHAL
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ovos-bus-client
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Dynamic: license-file
+
+# ovos-ui-enclosure-protocol
+
+The consumer/listener home of the legacy **Mark-1 hardware enclosure protocol**
+for OpenVoiceOS.
+
+The `enclosure.*` bus messages control the Mark-1 hardware enclosure: the LED
+eyes, the mouth/faceplate display, and the system LEDs. This package provides
+`EnclosureProtocolListener`, a consumer mix-in that a hardware enclosure plugin
+inherits to wire the `enclosure.*` subscriptions to overridable no-op handlers.
+[`ovos-PHAL-plugin-mk1`](https://github.com/OpenVoiceOS/ovos-PHAL-plugin-mk1)
+is the reference listener implementation.
+
+The producer side — `EnclosureAPI`, the skill-facing helper that *emits*
+`enclosure.*` — lives in
+[`ovos-gui-api-client`](https://github.com/OpenVoiceOS/ovos-gui-api-client)
+alongside `GUIInterface`, so `self.gui` and `self.enclosure` come from the same
+client.
+
+The enclosure protocol is **no longer a core abstraction**: `PHALPlugin` in
+`ovos-plugin-manager` no longer bakes in the `enclosure.*` handlers, and modern
+visual output is done through `GUIInterface` (OVOS-GUI-1). This package exists
+so hardware enclosure plugins keep a stable, dependency-light home for the
+listener side of the protocol. It does **not** reimplement GUI templates.
+
+## Install
+
+```bash
+pip install ovos-ui-enclosure-protocol
+```
+
+## Implementing a listener
+
+```python
+from ovos_ui_enclosure_protocol import EnclosureProtocolListener
+
+class MyEnclosure(EnclosureProtocolListener):
+    def __init__(self, bus):
+        self.bus = bus
+        self.register_enclosure_namespace()
+
+    def on_eyes_color(self, message=None):
+        ...  # drive the hardware
+
+    def shutdown(self):
+        self.shutdown_enclosure_namespace()
+```
+
+Every handler defaults to a no-op, so a plugin only overrides the commands its
+hardware supports. `ovos-PHAL-plugin-mk1` is the reference listener
+implementation.
+
+## Documentation
+
+- [`docs/index.md`](docs/index.md) — overview, install, listener guide.
+- [`docs/enclosure-protocol.md`](docs/enclosure-protocol.md) — the full
+  `enclosure.*` message contract with producers and listeners.
+
+## License
+
+Apache-2.0

ovos_ui_enclosure_protocol-0.0.1/ovos_ui_enclosure_protocol.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+ovos_ui_enclosure_protocol/__init__.py
+ovos_ui_enclosure_protocol/listener.py
+ovos_ui_enclosure_protocol/version.py
+ovos_ui_enclosure_protocol.egg-info/PKG-INFO
+ovos_ui_enclosure_protocol.egg-info/SOURCES.txt
+ovos_ui_enclosure_protocol.egg-info/dependency_links.txt
+ovos_ui_enclosure_protocol.egg-info/requires.txt
+ovos_ui_enclosure_protocol.egg-info/top_level.txt

ovos_ui_enclosure_protocol-0.0.1/ovos_ui_enclosure_protocol.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ovos_ui_enclosure_protocol-0.0.1/ovos_ui_enclosure_protocol.egg-info/requires.txt

@@ -0,0 +1,5 @@
+ovos-bus-client
+
+[test]
+pytest
+pytest-cov

ovos_ui_enclosure_protocol-0.0.1/ovos_ui_enclosure_protocol.egg-info/top_level.txt

@@ -0,0 +1 @@
+ovos_ui_enclosure_protocol

ovos_ui_enclosure_protocol-0.0.1/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ovos-ui-enclosure-protocol"
+dynamic = ["version"]
+description = "Legacy Mark-1 hardware enclosure protocol listener for OpenVoiceOS"
+readme = "README.md"
+license = "Apache-2.0"
+authors = [{name = "JarbasAi", email = "jarbasai@mailfence.com"}]
+requires-python = ">=3.10"
+keywords = ["enclosure", "mark1", "mycroft", "OVOS", "OpenVoiceOS", "PHAL"]
+dependencies = [
+    "ovos-bus-client",
+]
+
+[project.optional-dependencies]
+test = [
+    "pytest",
+    "pytest-cov",
+]
+
+[project.urls]
+Homepage = "https://github.com/OpenVoiceOS/ovos-ui-enclosure-protocol"
+Repository = "https://github.com/OpenVoiceOS/ovos-ui-enclosure-protocol"
+
+[tool.setuptools.packages.find]
+include = ["ovos_ui_enclosure_protocol*"]
+
+[tool.setuptools.dynamic]
+version = {attr = "ovos_ui_enclosure_protocol.version.__version__"}

ovos_ui_enclosure_protocol-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+