ovos-PHAL-plugin-mk1 0.1.2__tar.gz

ovos-PHAL-plugin-mk1-0.1.2/LICENSE

@@ -0,0 +1,203 @@
+
+                                 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 2024 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-PHAL-plugin-mk1-0.1.2/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 1.1
+Name: ovos-PHAL-plugin-mk1
+Version: 0.1.2
+Summary: A PHAL plugin for mycroft
+Home-page: https://github.com/OpenVoiceOS/ovos-PHAL-plugin-mk1
+Author: JarbasAi
+Author-email: jarbasai@mailfence.com
+License: Apache-2.0
+Description: UNKNOWN
+Platform: UNKNOWN
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Text Processing :: Linguistic
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6

ovos-PHAL-plugin-mk1-0.1.2/README.md

@@ -0,0 +1,83 @@
+# ovos-PHAL-plugin - Mark1
+
+handles integration with the Mycroft Mark1 hardware
+
+the firmware for mark1 arduino that controls the eyes and faceplate can be found [here](https://github.com/OpenVoiceOS/mycroft-mark1-firmware)
+
+utits to interact with the faceplate pixel by pixel can be found in [ovos-mark1-utils](https://github.com/OpenVoiceOS/ovos-mark1-utils) 
+
+# Serial Port Protocols
+
+See the file [protocols.txt](./protocols.txt) for a description of commands that can be sent to the faceplate.
+
+Commands can be sent from the command line on a Raspberry Pi, such as this:
+```
+$ echo "eyes.blink" > /dev/ttyAMA0
+$ echo "eyes.color=16711680" > /dev/ttyAMA0
+$ echo "mouth.text=I am angry!" > /dev/ttyAMA0
+```
+Which will blink the eyes, turn them red, then display the phrase on the faceplate.
+
+
+# Graphics
+The `mouth.icon=` command takes a custom format for it's black and white images.  You can use the [HTML editor](http://htmlpreview.github.io/?https://raw.githubusercontent.com/MycroftAI/enclosure-mark1/master/editor.html) to create the image strings that can be sent. 
+
+# IO pins
+When looking at the device from the back, pins are laid out as:
+
+```
+             -----------------------------------------------------------------------------------------------
+RCA Port    | 2 | 4 | 6 | 8 | 10 | 12 | 14 | 16 | 18 | 20 | 22 | 24 | 26 | 28 | 30 | 32 | 34 | 36 | 38 | 40 |
+            | 1 | 3 | 5 | 7 |  9 | 11 | 13 | 15 | 17 | 19 | 21 | 23 | 25 | 27 | 29 | 31 | 33 | 35 | 37 | 39 |
+             -----------------------------------------------------------------------------------------------
+
+ HDMI                         Ethernet                        USB     USB
+```
+
+Where:
+
+| Pin| Description          |
+|:--:|:---------------------|
+| 1  | GND                  |
+| 2  | +12V                 |
+| 3  | GND                  |
+| 4  | +5V                  |
+| 5  | GND                  |
+| 6  | +3.3V                |
+| 7  | Arduino Reset        |
+| 8  | Arduino D5           |
+| 9  | Arduino D6           |
+| 10 | Arduino D10          |
+| 11 | Arduino A2           |
+| 12 | Arduino A3           |
+| 13 | +3.3V                |
+| 14 | +3.3V                |
+| 15 | +3.3V                |
+| 16 | GND                  |
+| 17 | GND                  |
+| 18 | GND                  |
+| 19 | +5V                  |
+| 20 | +5V                  |
+| 21 | +5V                  |
+| 22 | +5V                  |
+| 23 | GND                  |
+| 24 | GND                  |
+| 25 | Raspberry Pi ID_SC   |
+| 26 | Raspberry Pi ID_SD   |
+| 27 | Raspberry Pi GPIO 4  |
+| 28 | Raspberry Pi GPIO 5  |
+| 29 | Raspberry Pi GPIO 6  |
+| 30 | Raspberry Pi GPIO 7  |
+| 31 | Raspberry Pi GPIO 8  |
+| 32 | Raspberry Pi GPIO 9  |
+| 33 | Raspberry Pi GPIO 10 |
+| 34 | Raspberry Pi GPIO 11 |
+| 35 | Raspberry Pi GPIO 12 |
+| 36 | Raspberry Pi GPIO 16 |
+| 37 | Raspberry Pi GPIO 25 |
+| 38 | Raspberry Pi GPIO 26 |
+| 39 | GND                  |
+| 40 | GND                  |
+
+**WARNING: This is not the same as the standard Raspberry Pi GPIO headers!**
+

ovos-PHAL-plugin-mk1-0.1.2/ovos_PHAL_plugin_mk1/__init__.py

@@ -0,0 +1,591 @@
+import time
+from threading import Event
+from time import sleep
+
+import serial
+from ovos_bus_client.message import Message
+from ovos_utils import create_daemon
+from ovos_utils.log import LOG
+from ovos_utils.network_utils import is_connected
+
+from ovos_mark1.faceplate.icons import MusicIcon, WarningIcon, SnowIcon, StormIcon, SunnyIcon, \
+    CloudyIcon, PartlyCloudyIcon, WindIcon, RainIcon, LightRainIcon
+from ovos_PHAL_plugin_mk1.arduino import EnclosureReader, EnclosureWriter
+from ovos_plugin_manager.phal import PHALPlugin
+
+
+# The Mark 1 hardware consists of a Raspberry Pi main CPU which is connected
+# to an Arduino over the serial port.  A custom serial protocol sends
+# commands to control various visual elements which are controlled by the
+# Arduino (e.g. two circular rings of RGB LEDs; and four 8x8 white LEDs).
+#
+# The Arduino can also send back notifications in response to either
+# pressing or turning a rotary encoder.
+
+
+class MycroftMark1Validator:
+    @staticmethod
+    def validate(config=None):
+        """ this method is called before loading the plugin.
+        If it returns False the plugin is not loaded.
+        This allows a plugin to run platform checks"""
+        # TODO how to detect if running in a mark1 ?
+        #  detect "/dev/ttyAMA0" ?
+        return True
+
+
+class MycroftMark1(PHALPlugin):
+    """
+       Serves as a communication interface between Arduino and Mycroft Core.
+
+       ``Enclosure`` initializes and aggregates all enclosures implementation.
+
+       E.g. ``EnclosureEyes``, ``EnclosureMouth`` and ``EnclosureArduino``
+
+       It also listens to the basic messages in order to perform those core actions
+       on the unit.
+
+       E.g. Start and Stop talk animation
+       """
+    validator = MycroftMark1Validator
+
+    def __init__(self, bus=None, config=None):
+        super().__init__(bus=bus, name="ovos-PHAL-plugin-mk1", config=config)
+        self.stopped = Event()
+        self.config = config or {
+            "port": "/dev/ttyAMA0",
+            "rate": 9600,
+            "timeout": 5.0
+        }
+        self.__init_serial()
+        self.reader = EnclosureReader(self.serial, self.bus, self.handle_button_press)
+        self.writer = EnclosureWriter(self.serial, self.bus)
+
+        self._num_pixels = 12 * 2
+        self._current_rgb = [(255, 255, 255) for i in range(self._num_pixels)]
+        self.showing_visemes = False
+        self.speaking = False
+        self.listening = False
+
+        LOG.debug("clearing eyes and mouth")
+        self.__reset()
+
+        # TODO settings
+        #  - default eye color
+        #  - narrow / half / full eyes default position
+        self._init_animation()
+
+        self.bus.on("system.factory.reset.ping", self.handle_register_factory_reset_handler)
+        self.bus.on("system.factory.reset.phal", self.handle_factory_reset)
+
+        self.bus.on("mycroft.internet.connected", self.on_display_reset)
+        self.bus.on("mycroft.stop", self.on_display_reset)
+        self.bus.on("ovos.common_play.play", self.on_music)
+        self.bus.on("ovos.common_play.stop", self.on_display_reset)
+        self.bus.on("mycroft.audio.service.play", self.on_music)
+        self.bus.on("mycroft.audio.service.stop", self.on_display_reset)
+
+        self.bus.emit(Message("system.factory.reset.register",
+                              {"skill_id": "ovos-phal-plugin-mk1"}))
+
+    def _init_animation(self):
+        # change eye color
+        r = 0
+        g = 0
+        b = 255
+        color = (r * 65536) + (g * 256) + b
+        self._current_rgb = [(r, g, b) for i in range(self._num_pixels)]
+        self.writer.write("eyes.color=" + str(color))
+
+        # narrow eyes while we do system checks
+        self.on_eyes_narrow()
+
+        # signal no internet
+        if not is_connected():
+            self.on_no_internet()
+
+        # if core is ready, reset eyes
+        self.bus.once("mycroft.ready", self.on_eyes_reset)
+        if self._check_services_ready():
+            self.on_eyes_reset()
+
+    def _check_services_ready(self):
+        """Report if all specified services are ready.
+
+        services (iterable): service names to check.
+        """
+        services = {k: False for k in ["skills",  # ovos-core
+                                       "audio",  # ovos-audio
+                                       "voice"  # ovos-dinkum-listener
+                                       ]}
+
+        for ser, rdy in services.items():
+            if rdy:
+                # already reported ready
+                continue
+            response = self.bus.wait_for_response(
+                Message(f'mycroft.{ser}.is_ready',
+                        context={"source": "mk1", "destination": "skills"}))
+            if response and response.data['status']:
+                services[ser] = True
+        return all([services[ser] for ser in services])
+
+    def __init_serial(self):
+        LOG.info("Connecting to mark1 faceplate")
+        try:
+            self.port = self.config.get("port", "/dev/ttyAMA0")
+            self.rate = self.config.get("rate", 9600)
+            self.timeout = self.config.get("timeout", 5.0)
+            self.serial = serial.serial_for_url(
+                url=self.port, baudrate=self.rate, timeout=self.timeout)
+            LOG.info("Connected to: %s rate: %s timeout: %s" %
+                     (self.port, self.rate, self.timeout))
+        except Exception as e:
+            LOG.exception(f"Impossible to connect to serial: {self.port}")
+            raise
+
+    def __reset(self, message=None):
+        self.writer.write("eyes.reset")
+        self.writer.write("mouth.reset")
+
+    def handle_button_press(self):
+        if self.speaking or self.listening:
+            self.bus.emit(Message("mycroft.stop"))
+        else:
+            self.bus.emit(Message("mycroft.mic.listen"))
+
+    def on_music(self, message=None):
+        MusicIcon(bus=self.bus).display()
+
+    def handle_get_color(self, message):
+        """Get the eye RGB color for all pixels
+        Returns:
+           (list) list of (r,g,b) tuples for each eye pixel
+        """
+        self.bus.emit(message.reply("enclosure.eyes.rgb",
+                                    {"pixels": self._current_rgb}))
+
+    def handle_factory_reset(self, message):
+        self.writer.write("eyes.spin")
+        self.writer.write("mouth.reset")
+        # TODO re-flash firmware to faceplate
+
+    def handle_register_factory_reset_handler(self, message):
+        self.bus.emit(message.reply("system.factory.reset.register",
+                                    {"skill_id": "ovos-phal-plugin-mk1"}))
+
+    # Audio Events
+    def on_record_begin(self, message=None):
+        # NOTE: ignore self._mouth_events, listening should ALWAYS be obvious
+        self.listening = True
+        self.on_listen(message)
+
+    def on_record_end(self, message=None):
+        self.listening = False
+        self.on_display_reset(message)
+
+    def on_audio_output_start(self, message=None):
+        self.speaking = True
+        if self._mouth_events:
+            self.on_talk(message)
+
+    def on_audio_output_end(self, message=None):
+        self.speaking = False
+        if self._mouth_events:
+            self.on_display_reset(message)
+
+    def on_awake(self, message=None):
+        ''' on wakeup animation
+        triggered by "mycroft.awoken"
+        '''
+        self.writer.write("eyes.reset")
+        sleep(1)
+        self.writer.write("eyes.blink=b")
+        sleep(1)
+        # brighten the rest of the way
+        self.writer.write("eyes.level=" + str(self.old_brightness))
+
+    def on_sleep(self, message=None):
+        ''' on naptime animation
+        triggered by "recognizer_loop:sleep"
+        '''
+        # Dim and look downward to 'go to sleep'
+        # TODO: Get current brightness from somewhere
+        self.old_brightness = 30
+        for i in range(0, (self.old_brightness - 10) // 2):
+            level = self.old_brightness - i * 2
+            self.writer.write("eyes.level=" + str(level))
+            time.sleep(0.15)
+        self.writer.write("eyes.look=d")
+
+    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).
+        triggered by "enclosure.reset"
+        """
+        self.writer.write("eyes.reset")
+        self.writer.write("mouth.reset")
+
+    # System Events
+    def on_no_internet(self, message=None):
+        """
+        triggered by "enclosure.notify.no_internet"
+        """
+        WarningIcon(bus=self.bus).display()
+
+    def on_system_reset(self, message=None):
+        """The enclosure hardware should reset any CPUs, etc.
+        triggered by "enclosure.system.reset"
+        """
+        self.writer.write("system.reset")
+
+    def on_system_mute(self, message=None):
+        """Mute (turn off) the system speaker.
+        triggered by "enclosure.system.mute"
+        """
+        self.writer.write("system.mute")
+
+    def on_system_unmute(self, message=None):
+        """Unmute (turn on) the system speaker.
+        triggered by "enclosure.system.unmute"
+        """
+        self.writer.write("system.unmute")
+
+    def on_system_blink(self, message=None):
+        """The 'eyes' should blink the given number of times.
+        triggered by "enclosure.system.blink"
+
+        Args:
+            times (int): number of times to blink
+        """
+        times = 1
+        if message and message.data:
+            times = message.data.get("times", times)
+        self.writer.write("system.blink=" + str(times))
+
+    # Eyes messages
+    def on_eyes_on(self, message=None):
+        """Illuminate or show the eyes.
+        triggered by "enclosure.eyes.on"
+        """
+        self.writer.write("eyes.on")
+
+    def on_eyes_off(self, message=None):
+        """Turn off or hide the eyes.
+        triggered by "enclosure.eyes.off"
+        """
+        self.writer.write("eyes.off")
+
+    def on_eyes_fill(self, message=None):
+        """triggered by "enclosure.eyes.fill" """
+        amount = 0
+        if message and message.data:
+            percent = int(message.data.get("percentage", 0))
+            amount = int(round(23.0 * percent / 100.0))
+        self.writer.write("eyes.fill=" + str(amount))
+
+    def on_eyes_blink(self, message=None):
+        """Make the eyes blink
+        triggered by "enclosure.eyes.blink"
+        Args:
+            side (str): 'r', 'l', or 'b' for 'right', 'left' or 'both'
+        """
+        side = "b"
+        if message and message.data:
+            side = message.data.get("side", side)
+        self.writer.write("eyes.blink=" + side)
+
+    def on_eyes_narrow(self, message=None):
+        """Make the eyes look narrow, like a squint
+        triggered by "enclosure.eyes.narrow"
+        """
+        self.writer.write("eyes.narrow")
+
+    def on_eyes_look(self, message=None):
+        """Make the eyes look to the given side
+        triggered by "enclosure.eyes.look"
+        Args:
+            side (str): 'r' for right
+                        'l' for left
+                        'u' for up
+                        'd' for down
+                        'c' for crossed
+        """
+        if message and message.data:
+            side = message.data.get("side", "")
+            self.writer.write("eyes.look=" + side)
+
+    def on_eyes_color(self, message=None):
+        """Change the eye color to the given RGB color
+        triggered by "enclosure.eyes.color"
+        Args:
+            r (int): 0-255, red value
+            g (int): 0-255, green value
+            b (int): 0-255, blue value
+        """
+        r, g, b = 255, 255, 255
+        if message and message.data:
+            r = int(message.data.get("r", r))
+            g = int(message.data.get("g", g))
+            b = int(message.data.get("b", b))
+        color = (r * 65536) + (g * 256) + b
+        self._current_rgb = [(r, g, b) for i in range(self._num_pixels)]
+        self.writer.write("eyes.color=" + str(color))
+
+    def on_eyes_brightness(self, message=None):
+        """Set the brightness of the eyes in the display.
+        triggered by "enclosure.eyes.brightness"
+        Args:
+            level (int): 1-30, bigger numbers being brighter
+        """
+        level = 30
+        if message and message.data:
+            level = message.data.get("level", level)
+        self.writer.write("eyes.level=" + str(level))
+
+    def on_eyes_reset(self, message=None):
+        """Restore the eyes to their default (ready) state
+        triggered by "enclosure.eyes.reset".
+        """
+        self.writer.write("eyes.reset")
+
+    def on_eyes_timed_spin(self, message=None):
+        """Make the eyes 'roll' for the given time.
+        triggered by "enclosure.eyes.timedspin"
+        Args:
+            length (int): duration in milliseconds of roll, None = forever
+        """
+        length = 5000
+        if message and message.data:
+            length = message.data.get("length", length)
+        self.writer.write("eyes.spin=" + str(length))
+
+    def on_eyes_volume(self, message=None):
+        """Indicate the volume using the eyes
+        triggered by "enclosure.eyes.volume"
+        Args:
+            volume (int): 0 to 11
+        """
+        volume = 4
+        if message and message.data:
+            volume = message.data.get("volume", volume)
+        self.writer.write("eyes.volume=" + str(volume))
+
+    def on_eyes_spin(self, message=None):
+        """
+        triggered by "enclosure.eyes.spin"
+        """
+        self.writer.write("eyes.spin")
+
+    def on_eyes_set_pixel(self, message=None):
+        """
+        triggered by "enclosure.eyes.set_pixel"
+        """
+        idx = 0
+        r, g, b = 255, 255, 255
+        if message and message.data:
+            idx = int(message.data.get("idx", idx))
+            r = int(message.data.get("r", r))
+            g = int(message.data.get("g", g))
+            b = int(message.data.get("b", b))
+        self._current_rgb[idx] = (r, g, b)
+        color = (r * 65536) + (g * 256) + b
+        self.writer.write("eyes.set=" + str(idx) + "," + str(color))
+
+    # Display (faceplate) messages
+    def on_display_reset(self, message=None):
+        """Restore the mouth display to normal (blank)
+        triggered by "enclosure.mouth.reset" / "recognizer_loop:record_end"
+        """
+        self.writer.write("mouth.reset")
+
+    def on_talk(self, message=None):
+        """Show a generic 'talking' animation for non-synched speech
+        triggered by "enclosure.mouth.talk"
+        """
+        self.writer.write("mouth.talk")
+
+    def on_think(self, message=None):
+        """Show a 'thinking' image or animation
+        triggered by "enclosure.mouth.think"
+        """
+        self.writer.write("mouth.think")
+
+    def on_listen(self, message=None):
+        """Show a 'thinking' image or animation
+        triggered by "enclosure.mouth.listen" / "recognizer_loop:record_begin"
+        """
+        self.writer.write("mouth.listen")
+
+    def on_smile(self, message=None):
+        """Show a 'smile' image or animation
+        triggered by "enclosure.mouth.smile"
+        """
+        self.writer.write("mouth.smile")
+
+    def on_viseme(self, message=None):
+        """Display a viseme mouth shape for synced speech
+
+        triggered by "enclosure.mouth.viseme"
+
+        Args:
+            code (int):  0 = shape for sounds like 'y' or 'aa'
+                         1 = shape for sounds like 'aw'
+                         2 = shape for sounds like 'uh' or 'r'
+                         3 = shape for sounds like 'th' or 'sh'
+                         4 = neutral shape for no sound
+                         5 = shape for sounds like 'f' or 'v'
+                         6 = shape for sounds like 'oy' or 'ao'
+        """
+        if message and message.data:
+            code = message.data["code"]
+            self.writer.write('mouth.viseme=' + code)
+
+    def on_viseme_list(self, message=None):
+        """ Send mouth visemes as a list in a single message.
+
+            Args:
+                start (int):    Timestamp for start of speech
+                viseme_pairs:   Pairs of viseme id and cumulative end times
+                                (code, end time)
+
+                                codes:
+                                 0 = shape for sounds like 'y' or 'aa'
+                                 1 = shape for sounds like 'aw'
+                                 2 = shape for sounds like 'uh' or 'r'
+                                 3 = shape for sounds like 'th' or 'sh'
+                                 4 = neutral shape for no sound
+                                 5 = shape for sounds like 'f' or 'v'
+                                 6 = shape for sounds like 'oy' or 'ao'
+        """
+        if message and message.data:
+            start = message.data['start']
+            visemes = message.data['visemes']
+
+            def animate_mouth():
+                nonlocal start, visemes
+                self.showing_visemes = True
+                previous_end = -1
+                for code, end in visemes:
+                    if not self.showing_visemes:
+                        break
+                    if end < previous_end:
+                        start = time.time()
+                    previous_end = end
+                    if time.time() < start + end:
+                        self.writer.write('mouth.viseme=' + code)
+                        sleep(start + end - time.time())
+                self.writer.write("mouth.reset")
+                self.showing_visemes = False
+
+            # use a thread to not block FakeBus (eg, voice sat)
+            create_daemon(animate_mouth)
+
+    def on_text(self, message=None):
+        """Display text (scrolling as needed)
+
+        triggered by "enclosure.mouth.text"
+
+        Args:
+            text (str): text string to display
+        """
+        text = ""
+        if message and message.data:
+            text = message.data.get("text", text)
+        self.writer.write("mouth.text=" + text)
+
+    def on_display(self, message=None):
+        """Display images on faceplate. Currently supports images up to 16x8,
+           or half the face. You can use the 'x' parameter to cover the other
+           half of the faceplate.
+
+       triggered by "enclosure.mouth.display"
+
+        Args:
+            img_code (str): text string that encodes a black and white image
+            x (int): x offset for image
+            y (int): y offset for image
+            refresh (bool): specify whether to clear the faceplate before
+                            displaying the new image or not.
+                            Useful if you'd like to display muliple images
+                            on the faceplate at once.
+        """
+        code = ""
+        x_offset = ""
+        y_offset = ""
+        clear_previous = ""
+        if message and message.data:
+            code = message.data.get("img_code", code)
+            x_offset = int(message.data.get("xOffset", x_offset))
+            y_offset = int(message.data.get("yOffset", y_offset))
+            clear_previous = message.data.get("clearPrev", clear_previous)
+
+        clear_previous = int(str(clear_previous) == "True")
+        clear_previous = "cP=" + str(clear_previous) + ","
+        x_offset = "x=" + str(x_offset) + ","
+        y_offset = "y=" + str(y_offset) + ","
+
+        message = "mouth.icon=" + x_offset + y_offset + clear_previous + code
+        # Check if message exceeds Arduino's serial buffer input limit 64 bytes
+        if len(message) > 60:
+            message1 = message[:31] + "$"
+            message2 = "mouth.icon=$" + message[31:]
+            self.writer.write(message1)
+            sleep(0.25)  # writer bugs out if sending messages too rapidly
+            self.writer.write(message2)
+        else:
+            sleep(0.1)
+            self.writer.write(message)
+
+    def on_weather_display(self, message=None):
+        """Show a the temperature and a weather icon
+
+        triggered by "enclosure.weather.display"
+
+        Args:
+            img_code (char): one of the following icon codes
+                         0 = sunny
+                         1 = partly cloudy
+                         2 = cloudy
+                         3 = light rain
+                         4 = raining
+                         5 = stormy
+                         6 = snowing
+                         7 = wind/mist
+            temp (int): the temperature (either C or F, not indicated)
+        """
+        if message and message.data:
+            # Convert img_code to icon
+            img_code = message.data.get("img_code", None)
+            icon = None
+            if img_code == 0:
+                # sunny
+                icon = SunnyIcon(bus=self.bus).encode()
+            elif img_code == 1:
+                # partly cloudy
+                icon = PartlyCloudyIcon(bus=self.bus).encode()
+            elif img_code == 2:
+                # cloudy
+                icon = CloudyIcon(bus=self.bus).encode()
+            elif img_code == 3:
+                # light rain
+                icon = LightRainIcon(bus=self.bus).encode()
+            elif img_code == 4:
+                # raining
+                icon = RainIcon(bus=self.bus).encode()
+            elif img_code == 5:
+                # storming
+                icon = StormIcon(bus=self.bus).encode()
+            elif img_code == 6:
+                # snowing
+                icon = SnowIcon(bus=self.bus).encode()
+            elif img_code == 7:
+                # wind/mist
+                icon = WindIcon(bus=self.bus).encode()
+
+            temp = message.data.get("temp", None)
+            if icon is not None and temp is not None:
+                icon = "x=2," + icon
+                msg = "weather.display=" + str(temp) + "," + str(icon)
+                self.writer.write(msg)

ovos-PHAL-plugin-mk1-0.1.2/ovos_PHAL_plugin_mk1/arduino.py

@@ -0,0 +1,157 @@
+# Copyright 2017 Mycroft AI Inc.
+#
+# 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.
+import time
+from queue import Queue
+from threading import Thread
+
+from ovos_bus_client import Message
+from ovos_utils.log import LOG
+from ovos_utils.signal import check_for_signal
+
+
+class EnclosureReader(Thread):
+    """
+    Reads data from Serial port.
+
+    Listens to all commands sent by Arduino that must be be performed on
+    Mycroft Core.
+
+    E.g. Mycroft Stop Feature
+        # . Arduino sends a Stop command after a button press on a Mycroft unit
+        # . ``EnclosureReader`` captures the Stop command
+        # . Notify all Mycroft Core processes (e.g. skills) to be stopped
+
+    Note: A command is identified by a line break
+    """
+
+    def __init__(self, serial, bus, button_callback=None):
+        super(EnclosureReader, self).__init__(target=self.read)
+        self.alive = True
+        self.daemon = True
+        self.serial = serial
+        self.bus = bus
+        self.button_callback = button_callback
+        self.start()
+
+    def read(self):
+        while self.alive:
+            try:
+                data = self.serial.readline()[:-2]
+                if data:
+                    try:
+                        data_str = data.decode()
+                    except UnicodeError as e:
+                        data_str = data.decode('utf-8', errors='replace')
+                        LOG.warning('Invalid characters in response from '
+                                    ' enclosure: {}'.format(repr(e)))
+                    self.process(data_str)
+            except Exception as e:
+                LOG.error("Reading error: {0}".format(e))
+
+    def process(self, data):
+        LOG.info(f"faceplate event: {data}")
+
+        if "Command: system.version" in data:
+            # This happens in response to the "system.version" message
+            # sent during the construction of Enclosure()
+            self.bus.emit(Message("enclosure.started"))
+
+        if "mycroft.stop" in data:
+            if self.button_callback:
+                self.button_callback()
+            else:
+                self.bus.emit(Message("mycroft.stop"))
+
+        if "volume.up" in data:
+            self.bus.emit(Message("mycroft.volume.increase",
+                                  {'play_sound': True}))
+
+        if "volume.down" in data:
+            self.bus.emit(Message("mycroft.volume.decrease",
+                                  {'play_sound': True}))
+
+        if "unit.shutdown" in data:
+            # Eyes to soft gray on shutdown
+            self.bus.emit(Message("enclosure.eyes.color",
+                                  {'r': 70, 'g': 65, 'b': 69}))
+            self.bus.emit(
+                Message("enclosure.eyes.timedspin",
+                        {'length': 12000}))
+            self.bus.emit(Message("enclosure.mouth.reset"))
+            time.sleep(0.5)  # give the system time to pass the message
+            self.bus.emit(Message("system.shutdown"))
+
+        if "unit.reboot" in data:
+            # Eyes to soft gray on reboot
+            self.bus.emit(Message("enclosure.eyes.color",
+                                  {'r': 70, 'g': 65, 'b': 69}))
+            self.bus.emit(Message("enclosure.eyes.spin"))
+            self.bus.emit(Message("enclosure.mouth.reset"))
+            time.sleep(0.5)  # give the system time to pass the message
+            self.bus.emit(Message("system.reboot"))
+
+        if "unit.setwifi" in data:
+            self.bus.emit(Message("system.wifi.setup"))
+        if "unit.factory-reset" in data:
+            self.bus.emit(Message("system.factory.reset"))  # not in mycroft-core!
+        if "unit.enable-ssh" in data:
+            # This is handled by the wifi client
+            self.bus.emit(Message("system.ssh.enable"))
+        if "unit.disable-ssh" in data:
+            # This is handled by the wifi client
+            self.bus.emit(Message("system.ssh.disable"))
+
+    def stop(self):
+        self.alive = False
+
+
+class EnclosureWriter(Thread):
+    """
+    Writes data to Serial port.
+        # . Enqueues all commands received from Mycroft enclosures
+           implementation
+        # . Process them on the received order by writing on the Serial port
+
+    E.g. Displaying a text on Mycroft's Mouth
+        # . ``EnclosureMouth`` sends a text command
+        # . ``EnclosureWriter`` captures and enqueue the command
+        # . ``EnclosureWriter`` removes the next command from the queue
+        # . ``EnclosureWriter`` writes the command to Serial port
+
+    Note: A command has to end with a line break
+    """
+
+    def __init__(self, serial, bus, size=16):
+        super(EnclosureWriter, self).__init__(target=self.flush)
+        self.alive = True
+        self.daemon = True
+        self.serial = serial
+        self.bus = bus
+        self.commands = Queue(size)
+        self.start()
+
+    def flush(self):
+        while self.alive:
+            try:
+                cmd = self.commands.get() + '\n'
+                self.serial.write(cmd.encode())
+                self.commands.task_done()
+            except Exception as e:
+                LOG.error("Writing error: {0}".format(e))
+
+    def write(self, command):
+        self.commands.put(str(command))
+
+    def stop(self):
+        self.alive = False

ovos-PHAL-plugin-mk1-0.1.2/ovos_PHAL_plugin_mk1/version.py

@@ -0,0 +1,6 @@
+# START_VERSION_BLOCK
+VERSION_MAJOR = 0
+VERSION_MINOR = 1
+VERSION_BUILD = 2
+VERSION_ALPHA = 0
+# END_VERSION_BLOCK

ovos-PHAL-plugin-mk1-0.1.2/ovos_PHAL_plugin_mk1.egg-info/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 1.1
+Name: ovos-PHAL-plugin-mk1
+Version: 0.1.2
+Summary: A PHAL plugin for mycroft
+Home-page: https://github.com/OpenVoiceOS/ovos-PHAL-plugin-mk1
+Author: JarbasAi
+Author-email: jarbasai@mailfence.com
+License: Apache-2.0
+Description: UNKNOWN
+Platform: UNKNOWN
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Text Processing :: Linguistic
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6

ovos-PHAL-plugin-mk1-0.1.2/ovos_PHAL_plugin_mk1.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+setup.py
+ovos_PHAL_plugin_mk1/__init__.py
+ovos_PHAL_plugin_mk1/arduino.py
+ovos_PHAL_plugin_mk1/version.py
+ovos_PHAL_plugin_mk1.egg-info/PKG-INFO
+ovos_PHAL_plugin_mk1.egg-info/SOURCES.txt
+ovos_PHAL_plugin_mk1.egg-info/dependency_links.txt
+ovos_PHAL_plugin_mk1.egg-info/entry_points.txt
+ovos_PHAL_plugin_mk1.egg-info/requires.txt
+ovos_PHAL_plugin_mk1.egg-info/top_level.txt
+ovos_PHAL_plugin_mk1.egg-info/zip-safe

ovos-PHAL-plugin-mk1-0.1.2/ovos_PHAL_plugin_mk1.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ovos-PHAL-plugin-mk1-0.1.2/ovos_PHAL_plugin_mk1.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[ovos.plugin.phal]
+ovos-phal-mk1=ovos_PHAL_plugin_mk1:MycroftMark1
+

ovos-PHAL-plugin-mk1-0.1.2/ovos_PHAL_plugin_mk1.egg-info/requires.txt

@@ -0,0 +1,4 @@
+ovos-plugin-manager>=0.0.24
+ovos-mark1-utils>=0.0.1
+ovos-utils>=0.0.38
+pyserial~=3.0

ovos-PHAL-plugin-mk1-0.1.2/ovos_PHAL_plugin_mk1.egg-info/top_level.txt

@@ -0,0 +1 @@
+ovos_PHAL_plugin_mk1

ovos-PHAL-plugin-mk1-0.1.2/ovos_PHAL_plugin_mk1.egg-info/zip-safe

@@ -0,0 +1 @@
+

ovos-PHAL-plugin-mk1-0.1.2/setup.cfg

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

ovos-PHAL-plugin-mk1-0.1.2/setup.py

@@ -0,0 +1,66 @@
+#!/usr/bin/env python3
+import os
+from os.path import join, dirname
+
+from setuptools import setup
+
+BASEDIR = os.path.abspath(os.path.dirname(__file__))
+
+
+def required(requirements_file):
+    """ Read requirements file and remove comments and empty lines. """
+    with open(os.path.join(BASEDIR, requirements_file), 'r') as f:
+        requirements = f.read().splitlines()
+        if 'MYCROFT_LOOSE_REQUIREMENTS' in os.environ:
+            print('USING LOOSE REQUIREMENTS!')
+            requirements = [r.replace('==', '>=').replace('~=', '>=') for r in requirements]
+        return [pkg for pkg in requirements
+                if pkg.strip() and not pkg.startswith("#")]
+
+
+def get_version():
+    """ Find the version of this skill"""
+    version_file = join(BASEDIR, 'ovos_PHAL_plugin_mk1/version.py')
+    major, minor, build, alpha = (None, None, None, None)
+    with open(version_file) as f:
+        for line in f:
+            if 'VERSION_MAJOR' in line:
+                major = line.split('=')[1].strip()
+            elif 'VERSION_MINOR' in line:
+                minor = line.split('=')[1].strip()
+            elif 'VERSION_BUILD' in line:
+                build = line.split('=')[1].strip()
+            elif 'VERSION_ALPHA' in line:
+                alpha = line.split('=')[1].strip()
+
+            if ((major and minor and build and alpha) or
+                    '# END_VERSION_BLOCK' in line):
+                break
+    version = f"{major}.{minor}.{build}"
+    if int(alpha):
+        version += f"a{alpha}"
+    return version
+
+
+PLUGIN_ENTRY_POINT = 'ovos-phal-mk1=ovos_PHAL_plugin_mk1:MycroftMark1'
+setup(
+    name='ovos-PHAL-plugin-mk1',
+    version=get_version(),
+    description='A PHAL plugin for mycroft',
+    url='https://github.com/OpenVoiceOS/ovos-PHAL-plugin-mk1',
+    author='JarbasAi',
+    author_email='jarbasai@mailfence.com',
+    license='Apache-2.0',
+    packages=['ovos_PHAL_plugin_mk1'],
+    install_requires=required("requirements.txt"),
+    zip_safe=True,
+    classifiers=[
+        'Development Status :: 3 - Alpha',
+        'Intended Audience :: Developers',
+        'Topic :: Text Processing :: Linguistic',
+        'License :: OSI Approved :: Apache Software License',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+    ],
+    entry_points={'ovos.plugin.phal': PLUGIN_ENTRY_POINT}
+)