Changeset View
Changeset View
Standalone View
Standalone View
README.md
1 | # Mycroft Plasmoid | 1 | # Mycroft Plasmoid | ||
---|---|---|---|---|---|
2 | #### Mycroft Ai Plasmoid and Skills for KDE Plasma 5 Desktop | | |||
3 | 2 | | |||
4 | 1. Installation Requirements | 3 | _Mycroft AI Plasmoid and Skills for KDE Plasma 5 Desktop_ | ||
5 | 4 | | |||
6 | + This plasmoid requires Mycroft Core Installed from http://github.com/MycroftAi/ using the GIT Method: | 5 | * [Installation Requirements](#installation-requirements) | ||
7 | + cd /home/$USER/ | 6 | + [KDE Neon/Kubuntu](#kde-neon-kubuntu) | ||
8 | + git clone https://github.com/MycroftAI/mycroft-core | 7 | + [Fedora](#fedora) | ||
9 | + Run: ./dev_setup.sh | 8 | * [Installation Instructions](#installation-instructions) | ||
10 | 9 | * [Upgrade from Previous Plasmoid Instructions](#upgrade-from-previous-plasmoid-instructions) | |||
11 | + Download / Clone Mycroft Plasmoid from this REPO. | 10 | * [Skills Installation](#skills-installation) | ||
12 | + Unzip to folder if Downloaded | 11 | + [Install Skills from the Plasmoid](#install-skills-from-the-plasmoid) | ||
13 | 12 | + [Install Skills with HTML Data](#install-skills-with-html-data) | |||
14 | + For KDE NEON / Kubuntu 17.10: sudo apt-get install libkf5notifications-data libkf5notifications-dev qml-module-qtquick2 qml-module-qtquick-controls2 qml-module-qtquick-controls qml-module-qtwebsockets qml-module-qt-websockets qtdeclarative5-qtquick2-plugin qtdeclarative5-models-plugin cmake cmake-extras cmake-data qml-module-qtquick-layouts libkf5plasma-dev extra-cmake-modules qtdeclarative5-dev build-essential g++ gettext libqt5webkit5 libqt5webkit5-dev libkf5i18n-data libkf5i18n-dev libkf5i18n5 qml-module-qtgraphicaleffects libqt5dbus5 libkf5dbusaddons-dev libdbus-1-dev libdbus-glib-1-dev -y | 13 | + [To Install Plasma Desktop Skills (Manually)](#to-install-plasma-desktop-skills--manually-) | ||
15 | 14 | * [Skills Dependency Requirements](#skills-dependency-requirements) | |||
16 | + For Fedora 26: sudo dnf install kf5-knotifications-devel qt5-qtbase-devel qt5-qtdeclarative-devel qt5-qtquick1-devel qt5-qtquickcontrols qt5-qtquickcontrols2 qt5-qtwebsockets cmake extra-cmake-modules kf5-plasma-devel kf5-i18n-devel qt5-qtwebkit qt5-qtwebkit-devel | 15 | * [Skills Dependencies for Other Distributions](#skills-dependencies-for-other-distributions) | ||
17 | | ||||
18 | | ||||
19 | 2. Installation Instructions [Go To Downloaded Plasmoid Folder and run the following commands] | | |||
20 | | ||||
21 | + mkdir build | | |||
22 | + cd build | | |||
23 | + cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DKDE_INSTALL_LIBDIR=lib -DKDE_INSTALL_USE_QT_SYS_PATHS=ON | | |||
24 | + make | | |||
25 | + sudo make install | | |||
26 | + sudo chmod +x /usr/share/plasma/plasmoids/org.kde.plasma.mycroftplasmoid/contents/code/startservice.sh | | |||
27 | + sudo chmod +x /usr/share/plasma/plasmoids/org.kde.plasma.mycroftplasmoid/contents/code/stopservice.sh | | |||
28 | + sudo chmod +x /usr/share/plasma/plasmoids/org.kde.plasma.mycroftplasmoid/contents/code/pkgstartservice.sh | | |||
29 | + sudo chmod +x /usr/share/plasma/plasmoids/org.kde.plasma.mycroftplasmoid/contents/code/pkgstopservice.sh | | |||
30 | + Logout / Login or Restart Plasma Shell | | |||
31 | | ||||
32 | Note: This plasmoids default find location for mycroft-core services is /home/$USER/mycroft-core/. This can be changed as per your installation path of mycroft-core in the settings tab. | | |||
33 | | ||||
34 | 3. Upgrade From Previous Plasmoid Instructions | | |||
35 | | ||||
36 | + Install additional dependencies: | | |||
37 | (Neon/Kubuntu): sudo apt-get install libqt5webkit5 libqt5webkit5-dev libkf5i18n-data libkf5i18n-dev libkf5i18n5 libqt5dbus5 libkf5dbusaddons-dev qml-module-qtgraphicaleffects | | |||
38 | (Fedora): sudo dnf install kf5-i18n-devel qt5-qtwebkit qt5-qtwebkit-devel | | |||
39 | + Locate your plasma-mycroft folder | | |||
40 | + cd plasma-mycroft | | |||
41 | + git pull origin master | | |||
42 | + cd build | | |||
43 | + cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DKDE_INSTALL_LIBDIR=lib -DKDE_INSTALL_USE_QT_SYS_PATHS=ON | | |||
44 | + make | | |||
45 | + sudo make install | | |||
46 | + sudo chmod +x /usr/share/plasma/plasmoids/org.kde.plasma.mycroftplasmoid/contents/code/startservice.sh | | |||
47 | + sudo chmod +x /usr/share/plasma/plasmoids/org.kde.plasma.mycroftplasmoid/contents/code/stopservice.sh | | |||
48 | + sudo chmod +x /usr/share/plasma/plasmoids/org.kde.plasma.mycroftplasmoid/contents/code/pkgstartservice.sh | | |||
49 | + sudo chmod +x /usr/share/plasma/plasmoids/org.kde.plasma.mycroftplasmoid/contents/code/pkgstopservice.sh | | |||
50 | + Logout / Login or Restart Plasma Shell | | |||
51 | | ||||
52 | | ||||
53 | 4. Skills Installation | | |||
54 | | ||||
55 | Install Skills from Plasmoid: | | |||
56 | + For Krunner Skill: Install from Plasmoid (Follow Dependency Installation Below). Skill Name: Krunner-Search-Skill | | |||
57 | + For Activities Skill: Install from Plasmoid (Follow Dependency Installation Below). Skill Name: Plasma-Activities-Skill | | |||
58 | + For User Control Skill: Install from Plasmoid (Follow Dependency Installation Below). Skill Name: Plasma-User-Control-Skill | | |||
59 | + For Wallpaper Change Skill: Install from Plasmoid (Follow Dependency Installation Below). Skill Name: Unsplash-Wallpaper-Plasma-Skill | | |||
60 | + For Image Recognition Skill: Follow Instructions at: https://github.com/AIIX/clarifai-image-recognition-skill | | |||
61 | | ||||
62 | To Install Skills With HTML Data: | | |||
63 | + skill-weather: Replace /opt/mycroft/skills/skill-weather with https://github.com/AIIX/skill-weather | | |||
64 | + git clone https://github.com/AIIX/skill-weather | | |||
65 | + cp -R skill-weather/* /opt/mycroft/skills/skill-weather/ | | |||
66 | | ||||
67 | + skill-stocks: Replace /opt/mycroft/skills/skill-stock with https://github.com/AIIX/skill-stock | | |||
68 | + git clone https://github.com/AIIX/skill-stock | | |||
69 | + cp -R skill-stock/* /opt/mycroft/skills/skill-stock/ | | |||
70 | | ||||
71 | + skill-wiki: Replace /opt/mycroft/skills/skill-wiki with https://github.com/AIIX/skill-wiki | | |||
72 | + git clone https://github.com/AIIX/skill-wiki | | |||
73 | + cp -R skill-wiki/* /opt/mycroft/skills/skill-wiki/ | | |||
74 | | ||||
75 | To Install Plasma Desktop Skills(Manually) (Step 5. Dependency Install is Very Important): | | |||
76 | + git clone https://github.com/AIIX/krunner-search-skill | | |||
77 | + cp -R krunner-search-skill/* /opt/mycroft/skills/krunner-search-skill/ | | |||
78 | + git clone https://github.com/AIIX/plasma-activities-skill | | |||
79 | + cp -R plasma-activities-skill/* /opt/mycroft/skills/plasma-activities-skill/ | | |||
80 | + git clone https://github.com/AIIX/plasma-user-control-skill | | |||
81 | + cp -R plasma-user-control-skill/* /opt/mycroft/skills/plasma-user-control-skill/ | | |||
82 | + git clone https://github.com/AIIX/unsplash-wallpaper-plasma-skill | | |||
83 | + cp -R unsplash-wallpaper-plasma-skill/* /opt/mycroft/skills/unsplash-wallpaper-plasma-skill/ | | |||
84 | + git clone https://github.com/AIIX/clarifai-image-recognition-skill | | |||
85 | + cp -R clarifai-image-recognition-skill/* /opt/mycroft/skills/clarifai-image-recognition-skill/ | | |||
86 | | ||||
87 | 5. Skills Dependency Requirements | | |||
88 | | ||||
89 | + For Skills (KDE Neon): sudo apt install python-dbus, python-pyqt5 pyqt5-dev, python-sip, python-sip-dev | | |||
90 | + From Konsole: cp -R /usr/lib/python2.7/dist-packages/dbus* /home/$USER/.virtualenvs/mycroft/lib/python2.7/site-packages/ | | |||
91 | + From Konsole: cp /usr/lib/python2.7/dist-packages/_dbus* /home/$USER/.virtualenvs/mycroft/lib/python2.7/site-packages/ | | |||
92 | + From Konsole: cp -R /usr/lib/python2.7/dist-packages/PyQt5* /home/$USER/.virtualenvs/mycroft/lib/python2.7/site-packages/ | | |||
93 | + From Konsole: cp /usr/lib/python2.7/dist-packages/sip* /home/$USER/.virtualenvs/mycroft/lib/python2.7/site-packages/ | | |||
94 | 16 | | |||
95 | 6. Skills Dependency for Other Distributions | 17 | ## Installation Requirements | ||
96 | 18 | | |||
97 | Python Dbus, PyQT5 and SIP package is required and copying the Python Dbus, Python QT folder and SIP libs from your system python install over to /home/$USER/.virtualenvs/mycroft/lib/python2.7/site-packages/. | 19 | 1. This plasmoid requires [Mycroft Core](https://github.com/MycroftAI/mycroft-core) installed using the GIT Method. | ||
20 | | ||||
21 | ```bash | ||||
22 | cd /home/$USER/ | ||||
23 | git clone https://github.com/MycroftAI/mycroft-core | ||||
24 | ./dev_setup.sh | ||||
25 | ``` | ||||
26 | | ||||
27 | 2. Download or clone this repository. | ||||
28 | 3. Unzip to a folder. | ||||
29 | | ||||
30 | ### KDE Neon/Kubuntu | ||||
31 | | ||||
32 | ```bash | ||||
33 | sudo apt-get install libkf5notifications-data libkf5notifications-dev qml-module-qtquick2 qml-module-qtquick-controls2 qml-module-qtquick-controls qml-module-qtwebsockets qml-module-qt-websockets qtdeclarative5-qtquick2-plugin qtdeclarative5-models-plugin cmake cmake-extras cmake-data qml-module-qtquick-layouts libkf5plasma-dev extra-cmake-modules qtdeclarative5-dev build-essential g++ gettext libqt5webkit5 libqt5webkit5-dev libkf5i18n-data libkf5i18n-dev libkf5i18n5 qml-module-qtgraphicaleffects libqt5dbus5 libkf5dbusaddons-dev libdbus-1-dev libdbus-glib-1-dev -y | ||||
34 | ``` | ||||
35 | | ||||
36 | ### Fedora | ||||
37 | | ||||
38 | ```bash | ||||
39 | sudo dnf install kf5-knotifications-devel qt5-qtbase-devel qt5-qtdeclarative-devel qt5-qtquick1-devel qt5-qtquickcontrols qt5-qtquickcontrols2 qt5-qtwebsockets cmake extra-cmake-modules kf5-plasma-devel kf5-i18n-devel qt5-qtwebkit qt5-qtwebkit-devel | ||||
40 | ``` | ||||
41 | | ||||
42 | ## Installation Instructions | ||||
43 | | ||||
44 | 1. Go to the downloaded plasmoid folder and run the following commands: | ||||
45 | | ||||
46 | ```bash | ||||
47 | mkdir build | ||||
48 | cd build | ||||
49 | cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DKDE_INSTALL_LIBDIR=lib -DKDE_INSTALL_USE_QT_SYS_PATHS=ON | ||||
50 | make | ||||
51 | sudo make install | ||||
52 | sudo chmod +x /usr/share/plasma/plasmoids/org.kde.plasma.mycroftplasmoid/contents/code/startservice.sh | ||||
53 | sudo chmod +x /usr/share/plasma/plasmoids/org.kde.plasma.mycroftplasmoid/contents/code/stopservice.sh | ||||
54 | sudo chmod +x /usr/share/plasma/plasmoids/org.kde.plasma.mycroftplasmoid/contents/code/pkgstartservice.sh | ||||
55 | sudo chmod +x /usr/share/plasma/plasmoids/org.kde.plasma.mycroftplasmoid/contents/code/pkgstopservice.sh | ||||
56 | ``` | ||||
57 | | ||||
58 | 2. Log out and log in or restart the Plasma shell. | ||||
59 | | ||||
60 | Note: This plasmoid's default find location for `mycroft-core` services is `/home/$USER/mycroft-core/`. This can be changed as per your installation path of `mycroft-core` in the settings tab. | ||||
61 | | ||||
62 | ## Upgrade from Previous Plasmoid Instructions | ||||
63 | | ||||
64 | 1. Install additional dependencies: | ||||
65 | | ||||
66 | - KDE Neon/Kubuntu | ||||
67 | | ||||
68 | ```bash | ||||
69 | sudo apt-get install libqt5webkit5 libqt5webkit5-dev libkf5i18n-data libkf5i18n-dev libkf5i18n5 libqt5dbus5 libkf5dbusaddons-dev qml-module-qtgraphicaleffects | ||||
70 | ``` | ||||
71 | | ||||
72 | - Fedora | ||||
73 | | ||||
74 | ```bash | ||||
75 | sudo dnf install kf5-i18n-devel qt5-qtwebkit qt5-qtwebkit-devel | ||||
76 | Locate your plasma-mycroft folder | ||||
77 | cd plasma-mycroft | ||||
78 | git pull origin master | ||||
79 | cd build | ||||
80 | cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DKDE_INSTALL_LIBDIR=lib -DKDE_INSTALL_USE_QT_SYS_PATHS=ON | ||||
81 | make | ||||
82 | sudo make install | ||||
83 | sudo chmod +x /usr/share/plasma/plasmoids/org.kde.plasma.mycroftplasmoid/contents/code/startservice.sh | ||||
84 | sudo chmod +x /usr/share/plasma/plasmoids/org.kde.plasma.mycroftplasmoid/contents/code/stopservice.sh | ||||
85 | sudo chmod +x /usr/share/plasma/plasmoids/org.kde.plasma.mycroftplasmoid/contents/code/pkgstartservice.sh | ||||
86 | sudo chmod +x /usr/share/plasma/plasmoids/org.kde.plasma.mycroftplasmoid/contents/code/pkgstopservice.sh | ||||
87 | ``` | ||||
88 | | ||||
89 | 2. Log out and log in or restart the Plasma shell. | ||||
90 | | ||||
91 | | ||||
92 | ## Skills Installation | ||||
93 | | ||||
94 | ### Install Skills from the Plasmoid | ||||
95 | | ||||
96 | | Skill | Name | Instruction | | ||||
97 | |---|---|---| | ||||
98 | | Krunner Skill | `Krunner-Search-Skill` | Install from plasmoid (follow dependency installation below) | | ||||
99 | | Activities Skill | `Plasma-Activities-Skill` | Install from plasmoid (follow dependency installation below) | | ||||
100 | | User Control Skill | `Plasma-User-Control-Skill` | Install from plasmoid (follow dependency installation below) | | ||||
101 | | Wallpaper Change Skill | `Unsplash-Wallpaper-Plasma-Skill` | Install from plasmoid (follow dependency installation below) | | ||||
102 | | Image Recognition Skill | | Follow instructions at [AIIX/clarifai-image-recognition-skill](https://github.com/AIIX/clarifai-image-recognition-skill) | | ||||
103 | | ||||
104 | | ||||
105 | ### Install Skills with HTML Data | ||||
106 | | ||||
107 | - `skill-weather`: | ||||
108 | Replace `/opt/mycroft/skills/skill-weather` with `https://github.com/AIIX/skill-weather` by running: | ||||
109 | | ||||
110 | ```bash | ||||
111 | git clone https://github.com/AIIX/skill-weather | ||||
112 | cp -R skill-weather/* /opt/mycroft/skills/skill-weather/ | ||||
113 | ``` | ||||
114 | | ||||
115 | - `skill-stocks`: | ||||
116 | Replace `/opt/mycroft/skills/skill-stock` with `https://github.com/AIIX/skill-stock` by running: | ||||
117 | | ||||
118 | ```bash | ||||
119 | git clone https://github.com/AIIX/skill-stock | ||||
120 | cp -R skill-stock/* /opt/mycroft/skills/skill-stock/ | ||||
121 | ``` | ||||
122 | | ||||
123 | - `skill-wiki`: | ||||
124 | Replace `/opt/mycroft/skills/skill-wiki` with `https://github.com/AIIX/skill-wiki` by running: | ||||
125 | | ||||
126 | ```bash | ||||
127 | git clone https://github.com/AIIX/skill-wiki | ||||
128 | cp -R skill-wiki/* /opt/mycroft/skills/skill-wiki/ | ||||
129 | ``` | ||||
130 | | ||||
131 | ### To Install Plasma Desktop Skills (Manually) | ||||
132 | | ||||
133 | If you do this, the step [Skills Dependency Requirements](#skills-dependency-requirements) is very important. | ||||
134 | | ||||
135 | ```bash | ||||
136 | git clone https://github.com/AIIX/krunner-search-skill | ||||
137 | cp -R krunner-search-skill/* /opt/mycroft/skills/krunner-search-skill/ | ||||
138 | git clone https://github.com/AIIX/plasma-activities-skill | ||||
139 | cp -R plasma-activities-skill/* /opt/mycroft/skills/plasma-activities-skill/ | ||||
140 | git clone https://github.com/AIIX/plasma-user-control-skill | ||||
141 | cp -R plasma-user-control-skill/* /opt/mycroft/skills/plasma-user-control-skill/ | ||||
142 | git clone https://github.com/AIIX/unsplash-wallpaper-plasma-skill | ||||
143 | cp -R unsplash-wallpaper-plasma-skill/* /opt/mycroft/skills/unsplash-wallpaper-plasma-skill/ | ||||
144 | git clone https://github.com/AIIX/clarifai-image-recognition-skill | ||||
145 | cp -R clarifai-image-recognition-skill/* /opt/mycroft/skills/clarifai-image-recognition-skill/ | ||||
146 | ``` | ||||
147 | | ||||
148 | ## Skills Dependency Requirements | ||||
149 | | ||||
150 | For Skills (KDE Neon), run: | ||||
151 | | ||||
152 | ```bash | ||||
153 | sudo apt install python-dbus python-pyqt5 pyqt5-dev python-sip python-sip-dev | ||||
154 | cp -R /usr/lib/python2.7/dist-packages/dbus* /home/$USER/.virtualenvs/mycroft/lib/python2.7/site-packages/ | ||||
155 | cp /usr/lib/python2.7/dist-packages/_dbus* /home/$USER/.virtualenvs/mycroft/lib/python2.7/site-packages/ | ||||
156 | cp -R /usr/lib/python2.7/dist-packages/PyQt5* /home/$USER/.virtualenvs/mycroft/lib/python2.7/site-packages/ | ||||
157 | cp /usr/lib/python2.7/dist-packages/sip* /home/$USER/.virtualenvs/mycroft/lib/python2.7/site-packages/ | ||||
158 | ``` | ||||
159 | | ||||
160 | ## Skills Dependencies for Other Distributions | ||||
161 | | ||||
162 | Python Dbus, PyQT5 and SIP packages are required. | ||||
163 | Copy the Python Dbus, Python QT folder and SIP libs from your system Python installation to `/home/$USER/.virtualenvs/mycroft/lib/python2.7/site-packages/`. |