Merge branch 'develop' into feature/game-execution

.github/workflows/build-action.yml

@@ -9,30 +9,36 @@ jobs:
         steps:
             - uses: actions/checkout@v2
             - uses: actions/setup-node@v1
+            -
+              name: Set up QEMU
+              uses: docker/setup-qemu-action@v2
+            -
+              name: Set up Docker Buildx
+              uses: docker/setup-buildx-action@v2
 
-            - name: Install npm dependencies
-              run: npm install
+            # - name: Install npm dependencies
+            #   run: npm install
 
-            - name: Build & run
-              run: docker build .
+            # - name: Build & run
+            #   run: docker build .
 
     #        - name: SonarCloud Scan
     #          uses: sonarsource/sonarcloud-github-action@master
     #          env:
     #            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     #            SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
 
-            - name: Start Mosquitto
-              uses: namoshek/mosquitto-github-action@v1
-              with:
-                version: '1.6'
-                ports: '1883:1883 9001:9001'
-                certificates: ${{ github.workspace }}/modules/web-ui/.ci/tls-certificates
-                config: ${{ github.workspace }}/modules/web-ui/.ci/mosquitto.conf
-                container-name: 'mqtt'
+            # - name: Start Mosquitto
+            #   uses: namoshek/mosquitto-github-action@v1
+            #   with:
+            #     version: '1.6'
+            #     ports: '1883:1883 9001:9001'
+            #     certificates: ${{ github.workspace }}/modules/web-ui/.ci/tls-certificates
+            #     config: ${{ github.workspace }}/modules/web-ui/.ci/mosquitto.conf
+            #     container-name: 'mqtt'
 
-            - name: Wait a bit until MQTT broker has started
-              run: sleep 30
+            # - name: Wait a bit until MQTT broker has started
+            #   run: sleep 30
 
             # - name: Cypress Test
             #   run: npm run cytest
@@ -44,9 +50,19 @@ jobs:
                 username: ${{ github.actor }}
                 password: ${{ secrets.GHCR_PAT }}
 
-            - name: Push container to GHCR
-              uses: docker/build-push-action@v2
+            - name: Push Web UI container to GHCR
+              uses: docker/build-push-action@v3
               with:
                 context: ./modules/web-ui
+                platforms: linux/amd64,linux/arm
                 push: true
                 tags: ghcr.io/cmcrobotics/microsquad-web-ui:latest
+
+            - name: Push Web UI container to GHCR
+              uses: docker/build-push-action@v3
+              with:
+                context: ./modules/gateway
+                platforms: linux/amd64,linux/arm
+                push: true
+                tags: ghcr.io/cmcrobotics/microsquad-gateway:latest
+

.gitignore

@@ -14,8 +14,6 @@ dist/
 downloads/
 eggs/
 .eggs/
-lib/
-lib64/
 parts/
 sdist/
 var/

.gitlab-ci.yml

@@ -41,11 +41,10 @@ Build Web UI image:
       entrypoint: [""]
     script:
       - echo "{\"auths\":{\"$CI_REGISTRY\":{\"username\":\"$CI_REGISTRY_USER\",\"password\":\"$CI_REGISTRY_PASSWORD\"}}}" > /kaniko/.docker/config.json
-      - echo Building latest Docker Image $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_NAME
-      - /kaniko/executor --context $CI_PROJECT_DIR/modules/web-ui --dockerfile $CI_PROJECT_DIR/modules/web-ui/Dockerfile --destination $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_NAME
+      - echo Building latest Docker Image $CI_REGISTRY_IMAGE/web-ui:$CI_COMMIT_REF_NAME
+      - /kaniko/executor --context $CI_PROJECT_DIR/modules/web-ui --dockerfile $CI_PROJECT_DIR/modules/web-ui/Dockerfile --destination $CI_REGISTRY_IMAGE/web-ui:$CI_COMMIT_REF_NAME
     only:
-      - master
-      - develop
+      refs: [master, develop]
 
 
 Update deployment:

.mvn/wrapper/MavenWrapperDownloader.java

@@ -0,0 +1,117 @@
+/*
+ * Copyright 2007-present the original author or authors.
+ *
+ * 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 java.net.*;
+import java.io.*;
+import java.nio.channels.*;
+import java.util.Properties;
+
+public class MavenWrapperDownloader {
+
+    private static final String WRAPPER_VERSION = "0.5.6";
+    /**
+     * Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided.
+     */
+    private static final String DEFAULT_DOWNLOAD_URL = "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/"
+        + WRAPPER_VERSION + "/maven-wrapper-" + WRAPPER_VERSION + ".jar";
+
+    /**
+     * Path to the maven-wrapper.properties file, which might contain a downloadUrl property to
+     * use instead of the default one.
+     */
+    private static final String MAVEN_WRAPPER_PROPERTIES_PATH =
+            ".mvn/wrapper/maven-wrapper.properties";
+
+    /**
+     * Path where the maven-wrapper.jar will be saved to.
+     */
+    private static final String MAVEN_WRAPPER_JAR_PATH =
+            ".mvn/wrapper/maven-wrapper.jar";
+
+    /**
+     * Name of the property which should be used to override the default download url for the wrapper.
+     */
+    private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl";
+
+    public static void main(String args[]) {
+        System.out.println("- Downloader started");
+        File baseDirectory = new File(args[0]);
+        System.out.println("- Using base directory: " + baseDirectory.getAbsolutePath());
+
+        // If the maven-wrapper.properties exists, read it and check if it contains a custom
+        // wrapperUrl parameter.
+        File mavenWrapperPropertyFile = new File(baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH);
+        String url = DEFAULT_DOWNLOAD_URL;
+        if(mavenWrapperPropertyFile.exists()) {
+            FileInputStream mavenWrapperPropertyFileInputStream = null;
+            try {
+                mavenWrapperPropertyFileInputStream = new FileInputStream(mavenWrapperPropertyFile);
+                Properties mavenWrapperProperties = new Properties();
+                mavenWrapperProperties.load(mavenWrapperPropertyFileInputStream);
+                url = mavenWrapperProperties.getProperty(PROPERTY_NAME_WRAPPER_URL, url);
+            } catch (IOException e) {
+                System.out.println("- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'");
+            } finally {
+                try {
+                    if(mavenWrapperPropertyFileInputStream != null) {
+                        mavenWrapperPropertyFileInputStream.close();
+                    }
+                } catch (IOException e) {
+                    // Ignore ...
+                }
+            }
+        }
+        System.out.println("- Downloading from: " + url);
+
+        File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH);
+        if(!outputFile.getParentFile().exists()) {
+            if(!outputFile.getParentFile().mkdirs()) {
+                System.out.println(
+                        "- ERROR creating output directory '" + outputFile.getParentFile().getAbsolutePath() + "'");
+            }
+        }
+        System.out.println("- Downloading to: " + outputFile.getAbsolutePath());
+        try {
+            downloadFileFromURL(url, outputFile);
+            System.out.println("Done");
+            System.exit(0);
+        } catch (Throwable e) {
+            System.out.println("- Error downloading");
+            e.printStackTrace();
+            System.exit(1);
+        }
+    }
+
+    private static void downloadFileFromURL(String urlString, File destination) throws Exception {
+        if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) {
+            String username = System.getenv("MVNW_USERNAME");
+            char[] password = System.getenv("MVNW_PASSWORD").toCharArray();
+            Authenticator.setDefault(new Authenticator() {
+                @Override
+                protected PasswordAuthentication getPasswordAuthentication() {
+                    return new PasswordAuthentication(username, password);
+                }
+            });
+        }
+        URL website = new URL(urlString);
+        ReadableByteChannel rbc;
+        rbc = Channels.newChannel(website.openStream());
+        FileOutputStream fos = new FileOutputStream(destination);
+        fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE);
+        fos.close();
+        rbc.close();
+    }
+
+}

.mvn/wrapper/maven-wrapper.properties

@@ -1 +1,2 @@
-distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.6.3/apache-maven-3.6.3-bin.zip
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.6.3/apache-maven-3.6.3-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar

README.md

@@ -2,7 +2,6 @@
 
 [![Known Vulnerabilities](https://snyk.io/test/github/lucasvanmol/usquad-web-ui/badge.svg)](https://snyk.io/test/github/lucasvanmol/usquad-web-ui)
 ![Build](https://github.com/cmcrobotics/microsquad/workflows/build-action/badge.svg)
-![Dependencies](https://david-dm.org/lucasvanmol/usquad-web-ui.svg)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=lucasvanmol_usquad-web-ui&metric=alert_status)](https://sonarcloud.io/dashboard?id=lucasvanmol_usquad-web-ui)
 
 A Microbit orchestration library based on [Bitio](https://github.com/AdventuresInMinecraft/bitio) : Using a single Microbit as a gateway, control remote Microbits via the radio.
@@ -33,8 +32,27 @@ For the **uSquad** Web Interface :
 
 ## Flash the Microbits
 
+* The Microbit Gateway uses [https://github.com/AdventuresInMinecraft/Bitio](https://github.com/AdventuresInMinecraft/bitio) - Simply download the latest compatible firmware and copy it to the Microbit flash drive to load it as the new firmware.
+* The client firmware is available as a Github release.
+
+## Configure and start Mosquitto MQTT broker
+
+Place the following file contents at location ```/etc/mosquitto/conf.d/listeners.conf``` :
+
+```conf
+listener 1883
+protocol mqtt
+
+listener 9001
+protocol websockets 
+```
+For a more comprehensive example, consult ``docs/samples/mosquitto.conf``.
+
 ## Start the Gateway
 
-## Connect to the administration web interface
+From ```modules/gateway```, execute :
+```bash
+. ./setup-venv.sh
+python -m microsquad.gateway.mqtt
+```
 
-# How to develop

docs/plantuml/sequence-diagrams/gateway-components.puml → docs/plantuml/gateway-components.puml

@@ -1,6 +1,6 @@
-@startuml Gateway components diagram
+@startuml Gateway components
 
-title Gateway components diagram
+title Gateway components
 frame "Connector Scheduler"{
     [Connector] <<bitio>>
     [Gateway] <<microbit>>

docs/samples/mosquitto.conf

@@ -0,0 +1,27 @@
+# Config file for mosquitto
+retry_interval 20
+sys_interval 10
+max_inflight_messages 40
+max_queued_messages 200
+queue_qos0_messages false
+message_size_limit 0
+allow_zero_length_clientid true
+allow_duplicate_messages false
+# Logging
+connection_messages true
+log_dest stderr
+log_dest stdout
+# log_dest file /mosquitto/log/mosquitto.log
+log_type error
+log_type warning
+log_type notice
+log_type information
+log_type all
+log_type debug
+log_timestamp true
+
+listener 1883
+protocol mqtt
+
+listener 9001
+protocol websockets 

modules/client/src/main/micropython/leftover.py → modules/client-micropython/src/main/micropython/leftover.py

@@ -20,9 +20,43 @@
 #     elif SIMULATOR == True: # Debug
 #       usquad_text({"value":measurement,"wait":"true"} )
 
+# def usquad_text(tags, timestamp=None):
+#   text_str = tags['value'].replace("_", " ")
+#   _delay = int(tags.get('delay',50))
+#   _wait = (tags.get('wait', "true").lower()=="true")
+#   _clear = (tags.get('clear', "true").lower()=="true")
+#   display.show(text_str, delay=_delay, wait=_wait, clear=_clear)
+
+# def usquad_read_accel(tags= None, timestamp=None):
+#   x,y,z = accelerometer.get_values()
+#   usquad_send("read_accel", tags = {"x":x,"y":y,"z":z})
+
+# def usquad_device_id(tags, timestamp=None):
+#   global DEVID
+#   DEVID = tags.get('id',machine.unique_id())
+
+# def usquad_image(tags, timestamp=None):
+#   images_str = tags['value']
+#   img = [(Image(img_str)) for img_str in images_str.split(";")]
+#   _del = int(tags.get('delay',1000))
+#   _slp = int(tags.get('sleep',2000))
+#   _wait = (tags.get('wait', "true").lower()=="true")
+#   _clr = (tags.get('clear', "false").lower()=="true")
+#   display.show(img, delay=_del, wait=_wait, clear=_clr)
+#   sleep(_slp)
 
 
       #incoming = 'image,value="99999:99999:99099:99999:99999;99999:55555:55055:55555:99999",delay=500,clear=false,wait=true'
       #incoming = 'text,value="Show_me_the_money",clear=true,wait=true'
       #incoming = 'accel'
       #incoming = 'vote,value="99999:99999:99099:99999:99999;99999:55555:55055:55555:99999;55555:50005:00000:50005:55555",duration=4000,votes=4'
+
+
+# METHOD_MAP = {
+#   'image'     : usquad_image,
+#   'accel'     : usquad_read_accel,
+#   'text'      : usquad_text,
+#   'vote'      : usquad_vote,
+#   'device_id' : usquad_device_id,
+#   'buttons'   : usquad_buttons
+# }