From 3d4366fcafaf55fb3eaa8a80fcbbc266d514d34c Mon Sep 17 00:00:00 2001 From: Jakob Stendahl <14180120+JakobST1n@users.noreply.github.com> Date: Tue, 2 Feb 2021 16:58:33 +0100 Subject: Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 49a7fba..5724574 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ docker run -v $(pwd):/app --rm microbit-tools [Refer to this repo's readme](https://github.com/lancaster-university/microbit-v2-samples). This is in theory not hard, but if you like me have a lot of toolchains for compiling to other architectures already installed, it could be a bit of work to make function properly. ## Known issues -- [ ] No multitouch support on webapp yet, this makes it difficult to use it, to make it a bit easier you can enable `Sticky controls`. +- [ ] No multitouch support on webapp yet, this makes it difficult to use it, to make it a bit easier you can enable `Sticky controls`. (Current plan is to use [nipplejs](https://yoannmoi.net/nipplejs/) as joysticks) - [ ] Things often stop working if you have been connected, drop the connection and then reconnect. I don't know exacly why, to circumvent this you can restart the webapp, and boot the micro:bit. - [ ] There is no failsafe-mode currently, this should be implemented according to the spektsat protocol. -- cgit v1.2.3 From 0b0961846dbb59d2c04f50ad82108b4c3acb15be Mon Sep 17 00:00:00 2001 From: Jakob Stendahl <14180120+JakobST1n@users.noreply.github.com> Date: Tue, 2 Feb 2021 18:44:12 +0100 Subject: Update README.md --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5724574..00d84f3 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # HOVER:BIT Bluetooth Controller software This is software for controlling the HOVER:BIT kit with a progressive web app. -The web app lives in the [controller](https://github.com/JakobST1n/hoverbit-ble/tree/controller) branch, it uses the [micro:bit Web Bluetooth](https://github.com/thegecko/microbit-web-bluetooth) library. +The web app lives in the [controller](https://github.com/JakobST1n/hoverbit-ble/tree/controller) branch, you can access it [here](https://github.com/JakobST1n/hoverbit-ble). It works the best if you install it on your device, usually you should get a prompt to install it when accessing the site. ## Usage ### Flashing the micro:bit @@ -28,9 +28,12 @@ docker run -v $(pwd):/app --rm microbit-tools [Refer to this repo's readme](https://github.com/lancaster-university/microbit-v2-samples). This is in theory not hard, but if you like me have a lot of toolchains for compiling to other architectures already installed, it could be a bit of work to make function properly. ## Known issues -- [ ] No multitouch support on webapp yet, this makes it difficult to use it, to make it a bit easier you can enable `Sticky controls`. (Current plan is to use [nipplejs](https://yoannmoi.net/nipplejs/) as joysticks) +- [ ] Webapp is a bit ugly. - [ ] Things often stop working if you have been connected, drop the connection and then reconnect. I don't know exacly why, to circumvent this you can restart the webapp, and boot the micro:bit. - [ ] There is no failsafe-mode currently, this should be implemented according to the spektsat protocol. +- [X] No multitouch support on webapp yet, this makes it difficult to use it, to make it a bit easier you can enable `Sticky controls`. ## Credits +- The [micro:bit Web Bluetooth](https://github.com/thegecko/microbit-web-bluetooth) library is used by the webapp for bluetooth communication with the MICRO:BIT. +- Joysticks on webapp is from the [nipplejs](https://yoannmoi.net/nipplejs/) library. - Current icon [made by strip](https://www.flaticon.com/authors/srip) from [Flaticon](https://www.flaticon.com/) -- cgit v1.2.3 From d6acce5f9306fed6518eae7f7ada50c796a62f9f Mon Sep 17 00:00:00 2001 From: Jakob Stendahl <14180120+JakobST1n@users.noreply.github.com> Date: Tue, 9 Feb 2021 09:39:32 +0100 Subject: Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 00d84f3..f804592 100644 --- a/README.md +++ b/README.md @@ -36,4 +36,3 @@ docker run -v $(pwd):/app --rm microbit-tools ## Credits - The [micro:bit Web Bluetooth](https://github.com/thegecko/microbit-web-bluetooth) library is used by the webapp for bluetooth communication with the MICRO:BIT. - Joysticks on webapp is from the [nipplejs](https://yoannmoi.net/nipplejs/) library. -- Current icon [made by strip](https://www.flaticon.com/authors/srip) from [Flaticon](https://www.flaticon.com/) -- cgit v1.2.3 From 86004e52f2af645a52a3733a3927dc56722b35af Mon Sep 17 00:00:00 2001 From: Jakob Stendahl <14180120+JakobST1n@users.noreply.github.com> Date: Tue, 9 Feb 2021 09:48:46 +0100 Subject: :memo: Mark utils folder as docs/vendored --- .gitattributes | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 .gitattributes diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..ab46ae6 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +utils/* linguist-documentation +utils/* linguist-vendored -- cgit v1.2.3 From 62ae4f4e24aa65d56bce9e87000a5335eb48b21c Mon Sep 17 00:00:00 2001 From: Jakob Stendahl <14180120+JakobST1n@users.noreply.github.com> Date: Tue, 9 Feb 2021 12:07:02 +0100 Subject: Update .gitattributes --- .gitattributes | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitattributes b/.gitattributes index ab46ae6..e3839c0 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,2 +1,3 @@ utils/* linguist-documentation utils/* linguist-vendored +CMakeLists.txt linguist-vendored -- cgit v1.2.3 From 773c3fe0458e4eb5a833df1d1bbe2481ab0b14dd Mon Sep 17 00:00:00 2001 From: Jakob Stendahl <14180120+JakobST1n@users.noreply.github.com> Date: Tue, 9 Feb 2021 12:08:24 +0100 Subject: :memo: Add build.py as vendored --- .gitattributes | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitattributes b/.gitattributes index e3839c0..547b9d4 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,3 +1,4 @@ utils/* linguist-documentation utils/* linguist-vendored CMakeLists.txt linguist-vendored +build.py linguist-vendored -- cgit v1.2.3 From 57b806df6fee45887c689020b9c5c727245434ea Mon Sep 17 00:00:00 2001 From: Jakob Stendahl <14180120+JakobST1n@users.noreply.github.com> Date: Tue, 9 Feb 2021 12:11:59 +0100 Subject: :memo: Change some links, update some descriptions --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f804592..acd8350 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # HOVER:BIT Bluetooth Controller software This is software for controlling the HOVER:BIT kit with a progressive web app. -The web app lives in the [controller](https://github.com/JakobST1n/hoverbit-ble/tree/controller) branch, you can access it [here](https://github.com/JakobST1n/hoverbit-ble). It works the best if you install it on your device, usually you should get a prompt to install it when accessing the site. +The web app lives in the [controller](https://github.com/JakobST1n/hoverbit-ble/tree/controller) branch, you can access it [here](http://jakobst1n.github.io/hoverbit-ble/). It works the best if you install it on your device, usually you should get a prompt to install it when accessing the site. ## Usage ### Flashing the micro:bit -Get the last [hex file](https://github.com/JakobST1n/hoverbit-ble/releases/) for the Releases, and flash your micro:bit with this file. +Get the last [hex file](https://github.com/JakobST1n/hoverbit-ble/releases/) from Releases, and flash your micro:bit with this file. To do this, plug the micro:bit into your computer. The micro:bit will then appear as a removable flash drive, then simply copy (drag-drop) the hex-file into the flash-drive folder. @@ -17,7 +17,7 @@ the hover:bit. ## Compiling the hex-file yourself Clone or fork this repo locally, and navigate to that folder in your terminal of choice. At this point you have two choises: ### Docker image -I have been using the docker image provided by [Lancaster university](https://github.com/lancaster-university/microbit-v2-samples/blob/master/Dockerfile), because it is rather convenient and a lot less work to get up and running. Just build the container, and run it with a volume as a bind-mount to the code-directory. +I a docker image to compile the source. The [Dockerfile](https://github.com/JakobST1n/hoverbit-ble/blob/master/Dockerfile) is in the root of this repo. Using a docker container is rather convenient and a lot less work to get up and running. Just build the container, and run it with a volume as a bind-mount to the code-directory. ```sh # Build the image on your machine docker build -t microbit-tools . -- cgit v1.2.3 From d1242e4b8ac8a92c4cb9890e995715475a3c43ac Mon Sep 17 00:00:00 2001 From: Jakob Stendahl <14180120+JakobST1n@users.noreply.github.com> Date: Tue, 9 Feb 2021 12:13:09 +0100 Subject: :memo: Fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index acd8350..97ada8d 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ the hover:bit. ## Compiling the hex-file yourself Clone or fork this repo locally, and navigate to that folder in your terminal of choice. At this point you have two choises: ### Docker image -I a docker image to compile the source. The [Dockerfile](https://github.com/JakobST1n/hoverbit-ble/blob/master/Dockerfile) is in the root of this repo. Using a docker container is rather convenient and a lot less work to get up and running. Just build the container, and run it with a volume as a bind-mount to the code-directory. +I have used a docker image to compile the source. The [Dockerfile](https://github.com/JakobST1n/hoverbit-ble/blob/master/Dockerfile) is in the root of this repo. Using a docker container is rather convenient and a lot less work to get up and running. Just build the container, and run it with a volume as a bind-mount to the code-directory. ```sh # Build the image on your machine docker build -t microbit-tools . -- cgit v1.2.3 From 6d1a228684350e98afc5449deab709c9db22311c Mon Sep 17 00:00:00 2001 From: Jakob Stendahl <14180120+JakobST1n@users.noreply.github.com> Date: Tue, 9 Feb 2021 20:47:05 +0100 Subject: :memo: Add browser recommendation --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 97ada8d..683df83 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # HOVER:BIT Bluetooth Controller software This is software for controlling the HOVER:BIT kit with a progressive web app. -The web app lives in the [controller](https://github.com/JakobST1n/hoverbit-ble/tree/controller) branch, you can access it [here](http://jakobst1n.github.io/hoverbit-ble/). It works the best if you install it on your device, usually you should get a prompt to install it when accessing the site. +The web app lives in the [controller](https://github.com/JakobST1n/hoverbit-ble/tree/controller) branch, you can access it [here](http://jakobst1n.github.io/hoverbit-ble/). It works the best if you install it on your device, usually you should get a prompt to install it when accessing the site. + +Only tested on __Google Chrome__! Will __NOT__ work on Safari (as apple doesn't allow web bluetooth). I have not tested on IOS, but it should work with chrome there as well. ## Usage ### Flashing the micro:bit -- cgit v1.2.3 From 47fe54915c1ec79590d3596525aa35b5988ed321 Mon Sep 17 00:00:00 2001 From: Jakob Stendahl <14180120+JakobST1n@users.noreply.github.com> Date: Tue, 9 Feb 2021 21:33:19 +0100 Subject: :memo: Add issues note --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index 683df83..b5f21db 100644 --- a/README.md +++ b/README.md @@ -30,10 +30,7 @@ docker run -v $(pwd):/app --rm microbit-tools [Refer to this repo's readme](https://github.com/lancaster-university/microbit-v2-samples). This is in theory not hard, but if you like me have a lot of toolchains for compiling to other architectures already installed, it could be a bit of work to make function properly. ## Known issues -- [ ] Webapp is a bit ugly. -- [ ] Things often stop working if you have been connected, drop the connection and then reconnect. I don't know exacly why, to circumvent this you can restart the webapp, and boot the micro:bit. -- [ ] There is no failsafe-mode currently, this should be implemented according to the spektsat protocol. -- [X] No multitouch support on webapp yet, this makes it difficult to use it, to make it a bit easier you can enable `Sticky controls`. +Take a look at [active issues](https://github.com/JakobST1n/hoverbit-ble/issues). Submit a issue there if find any problems. ## Credits - The [micro:bit Web Bluetooth](https://github.com/thegecko/microbit-web-bluetooth) library is used by the webapp for bluetooth communication with the MICRO:BIT. -- cgit v1.2.3 From 047d3eee876181ba4794eb4cc7218aeab4abf577 Mon Sep 17 00:00:00 2001 From: Jakob Stendahl <14180120+JakobST1n@users.noreply.github.com> Date: Wed, 10 Feb 2021 07:22:27 +0100 Subject: :memo: Update link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b5f21db..3638a25 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Only tested on __Google Chrome__! Will __NOT__ work on Safari (as apple doesn't ## Usage ### Flashing the micro:bit -Get the last [hex file](https://github.com/JakobST1n/hoverbit-ble/releases/) from Releases, and flash your micro:bit with this file. +Get the last [hex file](https://github.com/JakobST1n/hoverbit-ble/releases/latest) from Releases, and flash your micro:bit with this file. To do this, plug the micro:bit into your computer. The micro:bit will then appear as a removable flash drive, then simply copy (drag-drop) the hex-file into the flash-drive folder. -- cgit v1.2.3 From 6b8575bb2aafc05ce143993a0ebe98c13e895c04 Mon Sep 17 00:00:00 2001 From: Jakob Stendahl <14180120+JakobST1n@users.noreply.github.com> Date: Wed, 10 Feb 2021 12:06:49 +0100 Subject: Update README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 3638a25..8d677ee 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,9 @@ docker run -v $(pwd):/app --rm microbit-tools ### Manually [Refer to this repo's readme](https://github.com/lancaster-university/microbit-v2-samples). This is in theory not hard, but if you like me have a lot of toolchains for compiling to other architectures already installed, it could be a bit of work to make function properly. +## Versions +There is no connection between the version of the app and the version of the MICRO:BIT code, other than that major versions is supposed to be compatible. Meaning that if you come over some problems, and don't find a [issue](https://github.com/JakobST1n/hoverbit-ble/issues) describing your problem. You should first check that the major version of both the app and microbit hex is the same (e.g. app `1.0.8-alpha.0`and MICRO:BIT `1.0.1`, where the first number is the major). + ## Known issues Take a look at [active issues](https://github.com/JakobST1n/hoverbit-ble/issues). Submit a issue there if find any problems. -- cgit v1.2.3