Migrate default installed skill to OVOS versions.

This commit is contained in:
j1nx 2020-12-31 11:13:25 +01:00
parent 20b6a6c0db
commit 65e2952d94
42 changed files with 641 additions and 8 deletions

12
.gitmodules vendored
View File

@ -3,14 +3,14 @@
url = https://github.com/buildroot/buildroot.git
branch = 2020.11.x
[submodule "skill-mycroftos-enclosure"]
path = buildroot-external/rootfs-overlay/opt/mycroft/skills/skill-mycroftos-enclosure
url = https://github.com/j1nx/skill-mycroftos-enclosure.git
[submodule "skill-ovos-mycroftgui"]
path = buildroot-external/rootfs-overlay/opt/mycroft/skills/skill-ovos-mycroftgui
url = https://github.com/OpenVoiceOS/skill-ovos-mycroftgui.git
branch = master
[submodule "skill-mycroftos-gui"]
path = buildroot-external/rootfs-overlay/opt/mycroft/skills/skill-mycroftos-gui
url = https://github.com/j1nx/skill-mycroftos-gui.git
[submodule "skill-ovos-enclosure"]
path = buildroot-external/rootfs-overlay/opt/mycroft/skills/skill-ovos-enclosure
url = https://github.com/OpenVoiceOS/skill-ovos-enclosure.git
branch = master
[submodule "skill-balena-wifi-setup"]

@ -1 +0,0 @@
Subproject commit b9911967610b0cfefb71e3dfe7ad61f08d15928f

@ -1 +0,0 @@
Subproject commit 73ed87e40de556c556adffd46be899ada646770a

View File

@ -0,0 +1,129 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
pip-wheel-metadata/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
target/
# Jupyter Notebook
.ipynb_checkpoints
# IPython
profile_default/
ipython_config.py
# pyenv
.python-version
# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/
# Celery stuff
celerybeat-schedule
celerybeat.pid
# SageMath parsed files
*.sage.py
# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
.dmypy.json
dmypy.json
# Pyre type checker
.pyre/

View File

@ -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 [yyyy] [name of copyright owner]
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.

View File

@ -0,0 +1,2 @@
# skill-ovos-enclosure
Skill to take control of OpenVoiceOS it's functions and tools as Mycroft skill.

View File

@ -0,0 +1,227 @@
# Copyright 2019 j1nx - http://www.j1nx.nl.
#
# 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 subprocess
import os
import sys
from mycroft.api import is_paired
from mycroft.messagebus.message import Message
from mycroft.skills.core import MycroftSkill
from mycroft.util.log import LOG
from mycroft.util.parse import normalize
from mycroft.util import play_wav
from mycroft import intent_file_handler
class MycroftOS(MycroftSkill):
"""
The MycroftOS skill handles much of the screen and audio activities
related to Mycroft's core functionality.
"""
def __init__(self):
super().__init__('MycroftOS')
self.skip_list = ('MycroftOS')
self.loading = True
self.airplay_enabled = False
self.sshd_enabled = True
self.spotify_enabled = False
self.btspeaker_enabled = False
self.snapclient_enabled = False
self.airplay_enabled = self.settings.get('airplay')
self.sshd_enabled = self.settings.get('sshd')
self.spotify_enabled = self.settings.get('spotifyd')
self.btspeaker_enabled = self.settings.get('btspeaker')
self.snapclient_enabled = self.settings.get('snapclient')
def initialize(self):
""" Perform initalization.
Registers messagebus handlers.
"""
# Handle settings change
self.settings_change_callback = self.on_websettings_changed
try:
# Handle Device Ready
self.bus.on('mycroft.ready', self.reset_screen)
# Handle volume setting via PulseAudio
#self.add_event('mycroft.volume.set', self.on_volume_set)
#self.add_event('mycroft.volume.get', self.on_volume_get)
#self.add_event('mycroft.volume.duck', self.on_volume_duck)
#self.add_event('mycroft.volume.unduck', self.on_volume_unduck)
# Administrative messages
self.bus.on('system.shutdown', self.on_shutdown)
self.bus.on('system.reboot', self.on_reboot)
except Exception:
LOG.exception('In MycroftOS Enclosure Skill')
def on_websettings_changed(self):
if self.sshd_enabled != self.settings.get('sshd'):
if self.settings.get('sshd') is True:
self.enable_ssh()
else:
self.disable_ssh()
if self.airplay_enabled != self.settings.get('airplay'):
if self.settings.get('airplay') is True:
self.enable_airplay()
else:
self.disable_airplay()
if self.spotify_enabled != self.settings.get('spotifyd'):
if self.settings.get('spotifyd') is True:
self.enable_spotify()
else:
self.disable_spotify()
if self.btspeaker_enabled != self.settings.get('btspeaker'):
if self.settings.get('btspeaker') is True:
self.enable_btspeaker()
else:
self.disable_btspeaker()
if self.snapclient_enabled != self.settings.get('snapclient'):
if self.settings.get('snapclient') is True:
self.enable_snapclient()
else:
self.disable_snapclient()
# System volume
#def on_volume_set(self, message):
# self.muted = False
# self.set_pulse_volume(vol)
#def on_volume_get(self, message):
# self.bus.emit(message.response(data={'percent': self.volume, 'muted': self.muted}))
#def on_volume_duck(self, message):
# self.muted = True
# call(['pactl', 'set-sink-mute', '0', '1'])
#def on_volume_unduck(self, message):
# self.muted = False
# call(['pactl', 'set-sink-mute', '0', '0'])
# Device is fully started
def reset_screen(self, message):
"""Triggered after skills are initialized."""
self.loading = False
if is_paired():
self.speak_dialog('finished.booting')
# System actions
def on_shutdown(self):
self.speak('Till next time')
sleep(5)
os.system('sudo halt')
def on_reboot(self):
self.speak('I will be right back')
sleep(5)
os.system('sudo reboot')
# System services
def enable_ssh(self):
self.settings['sshd'] = True
if not os.path.isfile('/etc/systemd/system/multi-user.target.wants/sshd.service'):
# Service not yet enabled
os.system('sudo systemctl enable sshd.service')
self.speak_dialog('EnabledSSH')
if os.system('sudo systemctl is-active --quiet sshd.service') != 0:
# Service not currently running
os.system('sudo systemctl start sshd.service')
def disable_ssh(self):
self.settings['sshd'] = False
if os.path.isfile('/etc/systemd/system/multi-user.target.wants/sshd.service'):
# Service is enabled
os.system('sudo systemctl disable sshd.service')
self.speak_dialog('DisabledSSH')
os.system('sudo systemctl stop sshd.service')
self.sshd_enabled = False
self.sshd_started = True
def enable_airplay(self):
os.system('sudo systemctl enable shairport-sync.service')
os.system('sudo systemctl start shairport-sync.service')
self.settings['airplay'] = True
self.airplay_enabled = True
self.airplay_started = True
self.speak_dialog('EnabledAirPlay')
def disable_airplay(self):
os.system('sudo systemctl disable shairport-sync.service')
os.system('sudo systemctl stop shairport-sync.service')
self.settings['airplay'] = False
self.airplay_enabled = False
self.airplay_started = False
self.speak_dialog('DisabledAirPlay')
def enable_spotify(self):
os.system('sudo systemctl enable spotifyd.service')
os.system('sudo systemctl start spotifyd.service')
self.settings['spotifyd'] = True
self.spotify_enabled = True
self.spotify_started = True
self.speak_dialog('EnabledSpotify')
def disable_spotify(self):
os.system('sudo systemctl disable spotifyd.service')
os.system('sudo systemctl stop spotifyd.service')
self.settings['spotifyd'] = False
self.spotify_enabled = False
self.spotify_started = False
self.speak_dialog('DisabledSpotify')
def enable_btspeaker(self):
os.system('sudo systemctl enable btspeaker.service')
os.system('sudo systemctl start btspeaker.service')
self.settings['btspeaker'] = True
self.btspeaker_enabled = True
self.btspeaker_started = True
self.speak_dialog('EnabledBTspeaker')
def disable_btspeaker(self):
os.system('sudo systemctl disable btspeaker.service')
os.system('sudo systemctl stop btspeaker.service')
self.settings['btspeaker'] = False
self.btspeaker_enabled = False
self.btspeaker_started = False
self.speak_dialog('DisabledBTspeaker')
def enable_snapclient(self):
os.system('sudo systemctl enable snapclient.service')
os.system('sudo systemctl start snapclient.service')
self.settings['snapclient'] = True
self.snapclient_enabled = True
self.snapclient_started = True
self.speak_dialog('EnabledSnapclient')
def disable_snapclient(self):
os.system('sudo systemctl disable snapclient.service')
os.system('sudo systemctl stop snapclient.service')
self.settings['snapclient'] = False
self.snapclient_enabled = False
self.snapclient_started = False
self.speak_dialog('DisabledSnapclient')
def create_skill():
return MycroftOS()

View File

@ -0,0 +1 @@
Bluetooth speaker is stopped and disabled

View File

@ -0,0 +1 @@
Secure shell is stopped and disabled

View File

@ -0,0 +1 @@
Snapcast client is stopped and disabled

View File

@ -0,0 +1 @@
Spotify connect is stopped and disabled

View File

@ -0,0 +1 @@
Bluetooth speaker is enabled and started

View File

@ -0,0 +1 @@
Secure shell is enabled and started

View File

@ -0,0 +1 @@
Snapcast client is enabled and started

View File

@ -0,0 +1 @@
Spotify connect is enabled and started

View File

@ -0,0 +1,4 @@
I have now finished booting up.
I am now ready.
Hi, this is mycroft and I am ready to work.
You can get started with mycroft.

View File

@ -0,0 +1 @@
{"__mycroft_skill_firstrun": true, "sshd": true, "airplay": false, "spotifyd": false, "btspeaker": false, "snapclient": false}

View File

@ -0,0 +1,40 @@
skillMetadata:
sections:
- name: Smart speaker functionality
fields:
- type: label
label: <p>You can enable or disable smart speaker services and functionality currently present on the MycroftOS system. As every user has different requirements and is using different hardware, devices and network protocols, all these services are disabled by default. You can easily enable or disable any of the below services here, by selecting the enabled checkbox (slightly delayed as you need to wait for settings synchronisation). If you only want to start the service now without enabling them, you can also use your voice command to your MycroftOS device (For example Hey Mycroft, start spotify).</p>
- type: label
label: <hr><br><strong>Airplay audio player (v1)</strong><p>AirPlay is a proprietary protocol stack/suite developed by Apple Inc. that allows wireless streaming between devices of audio, video, device screens, and photos, together with related metadata.</p>
- name: airplay
type: checkbox
label: Enabled
value: "false"
- type: label
label: <br><strong>Spotify Connect</strong><p>Make your Mycroft device available as Spotify Connect device so you can select it as possible output device from within the Spotify app. Be aware this only makes it available within the app, if you want to control spotify by voice you need to install the Spotify skill and configure it.</p>
- name: spotifyd
type: checkbox
label: Enabled
value: "false"
- type: label
label: <br><strong>Bluetooth speaker</strong><p>Make your Mycroft device available as bluetooth speaker. With this enabled you can pair your phone or other device and use your Mycroft as sound output. It should ask for a PIN, which is 0000.</p>
- name: btspeaker
type: checkbox
label: Enabled
value: "false"
- type: label
label: <br><strong>Snapcast client</strong><p>Make your Mycroft device available as Snapcast client. With this enabled you can configure your device as multiroom audio playing device. Anything played on the network via Snapcast server will be played on the device. (NOTE This still needs to be configured on an OS level through SSH and configuration files)</p>
- name: snapclient
type: checkbox
label: Enabled
value: "false"
- name: MycroftOS system configuration
fields:
- type: label
label: <p>MycroftOS is based on a minimalistic linux OS called Buildroot. However, although small and minimalistic in size, MycroftOS comes with certain linux services and applications. This is for advanced users that would like to tinker with their box and or do more with it than only Mycroft related things.</p>
- type: label
label: <br><strong>Secure Shell (SSH)</strong><p>Secure Shell (SSH) is a cryptographic network protocol for operating network services securely over an unsecured network.[1] Typical applications include remote command-line, login, and remote command execution.</p>
- name: sshd
type: checkbox
label: Enabled
value: "true"

@ -0,0 +1 @@
Subproject commit 28c5b09ead07b1d4aab933ccb1ed207bff9c5371