karen-plugin-panel 0.7.1
Project Karen: Control Panel Device Plugin
License: MIT
Requires Python: >=3.6
Keywords: Artificial Intelligence,AI,Personal Assistant

Project Karen: Panel (Plugin) · |GitHub license| |Python Versions| |Read the Docs| |GitHub release (latest by date)|
====================================================================================================================

This project is dedicated to building a "Synthetic Human" which is
called Karen (for now) for which we have assigned the female gender
pronoun of "She". She has visual face recognition
(`opencv/opencv <https://github.com/opencv/opencv>`__), speech
transcription
(`mozilla/deepspeech <https://github.com/mozilla/DeepSpeech>`__), and
speech synthesis
(`festival <http://www.cstr.ed.ac.uk/projects/festival/>`__). Karen is
written in Python and is targeted primarily at the single board computer
(SBC) platforms like the `Raspberry
Pi <https://www.raspberrypi.org/>`__.

Visit our main site: https://projectkaren.ai/

Installation
------------

Karen is available as separate components that together create an
extensible environment for devices and the processing of input/output.
These components can be installed together or separately depending on
your needs. This project covers the panel plugin module alone. For more
information on all of the components please visit the
`documentation <https://docs.projectkaren.ai>`__.

The Panel plugin allows Karen to display items on a screen and accept
touchscreen input. It interacts with the Brain to both control and
consume inputs for displaying. To install the panel follow the steps
below:

::

    sudo apt-get install python3-pyqt5

::

    pip3 install karen-device karen-plugin-panel

See more details in the `configuration
overview <https://docs.projectkaren.ai/en/latest/config.overview/>`__ on
how to include a panel device in your device container configuration. It
will then be started with the Device Container in which it is included.

::

    import karen, karen_device, karen_panel

    brain_url = "http://localhost:8080"
    device = karen_device.DeviceContainer(brain_url=brain_url)
    panel = karen_panel.Panel(callback=device.callbackHandler)
    device.addDevice("karen_panel.Panel", panel, autoStart=True)
    device.start()
    device.wait()

Additional Documentation
------------------------

To read more about Karen and all the components available please visit:
https://docs.projectkaren.ai

--------------

Help & Support
--------------

Help and additional details is available at https://projectkaren.ai

Third Party Features
--------------------

To speed up the development this routine leverages icons from
http://fontawesome.com which are licensed under the `Creative Commons
4.0 Attribution license <https://fontawesome.com/license>`__. These
icons are the Home, Tools, and Camera icons displayed on the buttons.
These icons were modified from their default "currentColor" fill setting
to be a static white (hex #FFFFFF) so that they are visible on the dark
background of the panel.

.. |GitHub license| image:: https://img.shields.io/github/license/lnxusr1/karen-panel
   :target: https://github.com/lnxusr1/karen-panel/blob/master/LICENSE
.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/yt2mp3.svg
.. |Read the Docs| image:: https://img.shields.io/readthedocs/project-karen
.. |GitHub release (latest by date)| image:: https://img.shields.io/github/v/release/lnxusr1/karen-panel