From 1b8861fa3b961dde88f3a829432b6bf397be26f6 Mon Sep 17 00:00:00 2001 From: limitless-code Date: Thu, 26 Aug 2021 18:11:12 +0100 Subject: [PATCH 1/5] update readme --- README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 48 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 2f411b71..8d68238a 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ A minimalistic Linux OS bringing the open source voice assistant Mycroft A.I. to - Buildroot 2021.02.x (LTS) - Mycroft 20.08.x (mycroft-lib pip installable version) - Raspberry Pi 3|3b|3b+ (Initial development hardware = 3b) -- Raspberry Pi 4 (Current development hardware) +- Raspberry Pi 4 (Current development hardware, minimum recommended RAM 2GB) ## Stats: @@ -21,10 +21,43 @@ A minimalistic Linux OS bringing the open source voice assistant Mycroft A.I. to | [![Uptime Robot status](https://img.shields.io/website-up-down-green-red/https/shields.io.svg?label=j1nx.nl)](https://stats.uptimerobot.com/Y5L6rSB07) | [![Buy me a](https://img.shields.io/badge/BuyMeABeer-Paypal-blue.svg)](https://www.paypal.me/j1nxnl) | | I use uptime robot to monitor for things i can't monitor when the connection drops. | If you feel the need, now it's as easy as clicking this button! | + ## Getting started. At this moment development is in very early stages and focussed on the Raspberry Pi 3B & 4. As soon as an initial first workable version is created, other hardware might be added. +### Build Environment + +Only use x86_64 based architecture/ hardware to build the image. + +The following example Build environment has been tested : + + Architecture: x86_64 + Hardware: Intel Core i5 processor, 8GB RAM, 240GB SSD (you can build on 2GB RAM and slower storage but more RAM and faster the storage the quicker the build) + + OS: Ubuntu 20.04 LTS desktop + +#### Installing System Build Dependencies +The following system packages are required to build the image: +- gcc +- subversion +- qttools5-dev +- qttools5-dev-tools +- python +- git +- make +- g++ +- curl +- wget +- qtdeclarative5-dev + +#### The following firewall ports need to be allowed to the internet. +In addition to the usual http/https ports (tcp 80, tcp 443) a couple of other ports need to be allowed to the internet : +- tcp 9418 (git). +- tcp 21 (ftp PASV) and random ports for DATA channel. This can be optional but better to have this allowed along with the corresponding random data channel ports. (knowledge of firewalls required) + + + ### Getting the code. First, get the code on your system! The simplest method is via git.
@@ -39,13 +72,6 @@ First, get the code on your system! The simplest method is via git.
This will patch the Buildroot packages. -### Installing System Build Dependencies -The following system packages are required to build the image: -- gcc -- subversion -- qttools5-dev -- qttools5-dev-tools -- python ## Building the image. Building the image(s) can be done by utilizing a proper Makefile; @@ -73,6 +99,20 @@ Then you can continue the build process by re-running the "make rpi4_64-gui" com

When everything goes fine the xz compressed image will be available within the release directory. + +### Booting image from sd card for the first time (setting up Wifi and backend). +1.Ensure all required peripherals (mic, speakers, HDMI, usb mouse etc) are plugged in before powering on your RPI4. +2. Skip this step if RPI4 is plugged in using ethernet cable. Once powered on, the screen will present the Wifi setup screen ( a Wifi HotSpot is created). Connect to the Wifi HotSpot (ssid OVOS) from another device and follow the on-screen instructions to setup Wifi. + +Once Wifi is setup a choice of Mycroft backend and Local backend is presented. Choose the Mycroft backend for now and follow the on-screen instructions, Local backend is not ready to use yet. After the pairing process has completed and skills downloaded it's time to test/ use it. + + +### Accessing the CLI. + +- SSH to ip address of RPI4 +- default credentials 'mycroft/mycroft' + + ## Documentation. More information and instructions can be found within the "documentation" folder. From 37c2c2a81e8375bf245c71d40c6e957518becf08 Mon Sep 17 00:00:00 2001 From: limitless-code Date: Thu, 26 Aug 2021 18:32:57 +0100 Subject: [PATCH 2/5] update readme --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8d68238a..0eb37ba0 100644 --- a/README.md +++ b/README.md @@ -32,10 +32,9 @@ Only use x86_64 based architecture/ hardware to build the image. The following example Build environment has been tested : - Architecture: x86_64 - Hardware: Intel Core i5 processor, 8GB RAM, 240GB SSD (you can build on 2GB RAM and slower storage but more RAM and faster the storage the quicker the build) - - OS: Ubuntu 20.04 LTS desktop +- Architecture: x86_64 +- Hardware: Intel Core i5 processor, 8GB RAM, 240GB SSD (you can build on 2GB RAM and slower storage but more RAM and faster the storage the quicker the build) +- OS: Ubuntu 20.04 LTS desktop #### Installing System Build Dependencies The following system packages are required to build the image: From 8ca8ba2965f31bc1954dd7eff8081eaa8aa98f10 Mon Sep 17 00:00:00 2001 From: limitless-code Date: Thu, 26 Aug 2021 18:38:35 +0100 Subject: [PATCH 3/5] update readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0eb37ba0..5accc90d 100644 --- a/README.md +++ b/README.md @@ -101,7 +101,7 @@ When everything goes fine the xz compressed image will be available within the r ### Booting image from sd card for the first time (setting up Wifi and backend). 1.Ensure all required peripherals (mic, speakers, HDMI, usb mouse etc) are plugged in before powering on your RPI4. -2. Skip this step if RPI4 is plugged in using ethernet cable. Once powered on, the screen will present the Wifi setup screen ( a Wifi HotSpot is created). Connect to the Wifi HotSpot (ssid OVOS) from another device and follow the on-screen instructions to setup Wifi. +2. Skip this step if RPI4 is using an ethernet cable. Once powered on, the screen will present the Wifi setup screen ( a Wifi HotSpot is created). Connect to the Wifi HotSpot (ssid OVOS) from another device and follow the on-screen instructions to setup Wifi. Once Wifi is setup a choice of Mycroft backend and Local backend is presented. Choose the Mycroft backend for now and follow the on-screen instructions, Local backend is not ready to use yet. After the pairing process has completed and skills downloaded it's time to test/ use it. From 382610cf9b73b706b0b06b11ec49a0dddca5f78d Mon Sep 17 00:00:00 2001 From: limitless-code Date: Thu, 26 Aug 2021 18:59:13 +0100 Subject: [PATCH 4/5] update readme --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5accc90d..c56cec0a 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Only use x86_64 based architecture/ hardware to build the image. The following example Build environment has been tested : - Architecture: x86_64 -- Hardware: Intel Core i5 processor, 8GB RAM, 240GB SSD (you can build on 2GB RAM and slower storage but more RAM and faster the storage the quicker the build) +- Hardware: Intel Core i5 processor, 8GB RAM, 240GB SSD (you can build on less RAM (2GB) and slower storage but more RAM, faster storage = quicker image building) - OS: Ubuntu 20.04 LTS desktop #### Installing System Build Dependencies @@ -101,8 +101,9 @@ When everything goes fine the xz compressed image will be available within the r ### Booting image from sd card for the first time (setting up Wifi and backend). 1.Ensure all required peripherals (mic, speakers, HDMI, usb mouse etc) are plugged in before powering on your RPI4. +
2. Skip this step if RPI4 is using an ethernet cable. Once powered on, the screen will present the Wifi setup screen ( a Wifi HotSpot is created). Connect to the Wifi HotSpot (ssid OVOS) from another device and follow the on-screen instructions to setup Wifi. - +
Once Wifi is setup a choice of Mycroft backend and Local backend is presented. Choose the Mycroft backend for now and follow the on-screen instructions, Local backend is not ready to use yet. After the pairing process has completed and skills downloaded it's time to test/ use it. From 1ba3699989941887fdf8c7a2cfcb57dde569d564 Mon Sep 17 00:00:00 2001 From: limitless-code Date: Thu, 26 Aug 2021 19:06:15 +0100 Subject: [PATCH 5/5] update readme --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c56cec0a..4aff9973 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,7 @@ The following example Build environment has been tested : #### Installing System Build Dependencies The following system packages are required to build the image: + - gcc - subversion - qttools5-dev @@ -100,11 +101,11 @@ When everything goes fine the xz compressed image will be available within the r ### Booting image from sd card for the first time (setting up Wifi and backend). -1.Ensure all required peripherals (mic, speakers, HDMI, usb mouse etc) are plugged in before powering on your RPI4. +1.Ensure all required peripherals (mic, speakers, HDMI, usb mouse etc) are plugged in before powering on your RPI4 for the first time.
2. Skip this step if RPI4 is using an ethernet cable. Once powered on, the screen will present the Wifi setup screen ( a Wifi HotSpot is created). Connect to the Wifi HotSpot (ssid OVOS) from another device and follow the on-screen instructions to setup Wifi.
-Once Wifi is setup a choice of Mycroft backend and Local backend is presented. Choose the Mycroft backend for now and follow the on-screen instructions, Local backend is not ready to use yet. After the pairing process has completed and skills downloaded it's time to test/ use it. +3.Once Wifi is setup a choice of Mycroft backend and Local backend is presented. Choose the Mycroft backend for now and follow the on-screen instructions, Local backend is not ready to use yet. After the pairing process has completed and skills downloaded it's time to test/ use it. ### Accessing the CLI.