MycroftAI
/
mycroft-precise
mirror of https://github.com/MycroftAI/mycroft-precise.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update SNAPCRAFT.md wording

pull/143/head
Åke Forslund 2020-04-14 15:52:20 +02:00
parent 89fc7b9dd9
commit 475fa56294
1 changed files with 5 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
SNAPCRAFT.md
View File

@ -1,31 +1,18 @@
# Mycroft-Precise Snap package
## Package details
The package is a fairly standard configuration using the Snap [Python Plugin](https://snapcraft.io/docs/python-plugin).
The package is farily standard package using the Snap [Python Plugin](https://snapcraft.io/docs/python-plugin).
The package version is extracted from the `setup.py` script to remain consistent with the pip information. In addition a comparison with the repo is made to see if this commit matches the latest release commit. If it doesn't match _-dev_ is appended to the version info.
The package version is extracted from the setup.py script to remain consistent with the pip information. In addition a comparison with the repo is made to see if this is commit matches the latest release commit, if it doesn't match _-dev_ is applied to the version info.
Since Precise uses pyaudio, ALSA is required for the audio to work. This Snap uses the [alsa-mixin](https://snapcraft-alsa.readthedocs.io/en/latest/snapcraft_usage.html) to setup the ALSA components. This results in some minor issues that need to be handled. Library conflicts may occur if audio packages are included as part of the main application part, making them appear twice in conflicting versions. This is the reason that libportaudio2 and pulseaudio are in the stage-packages for the alsa-mixin part.
Since Precise uses pyaudio, ALSA is required for things to work. This requires the [alsa-mixin](https://snapcraft-alsa.readthedocs.io/en/latest/snapcraft_usage.html) and results in some minor issues that needs to be handled. Library conflicts may occur if audio packages are included as part of the main application part, making them appear twice in conflicting versions. This is the reason that libportaudio2 and pulseaudio are in the stage-packages for the alsa-mixin part.
The snap package also includes a the current pretrained "hey mycroft" model accessed through `/snap/mycroft-precise/current/hey-mycroft/hey-mycroft.pb`
This package also includes the current pretrained "hey mycroft" model accessed through `/snap/mycroft-precise/current/hey-mycroft/hey-mycroft.pb`.
## Plugs
Plugs allows connecting the snap to the rest of the system, without any specified plugs the application will run without being able to access the system outside of the snap container, a read-only file system dedicated to the application.
Plugs allow the Snap to connect to specific aspects of the host system. Without any specified plugs the application will run entirely within a read-only file system dedicated to the application. It will not be able to access the system, including audio devices, that are outside of the Snap container.
**Plugs used:**
- home: access to the user's home directory (excluding hidden files)
- audio-record: Access to the system's audio input devices
- audio-playback: Access to the system's audio output devices
## Entry points
Below are some of the entry-points of interest.
- mycroft-precise
Alias for the mycroft-precise.engine, run precise against a data stream over stdio.
- mycroft-precise.listen
Run a model on microphone audio input.
- mycroft-precise.train
Train a new model on a dataset.