From 2e87dfefd80aaf1877118452f8ac9ea80e958ae6 Mon Sep 17 00:00:00 2001 From: Felix Erdmann Date: Fri, 20 Dec 2024 13:39:11 +0100 Subject: [PATCH 1/2] docs: add /libraries to readme --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 626daf5..b8ff094 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,24 @@ Responses have a `content-type: application/octet-stream` header and contain the It also have a `Content-Disposition: attachment; filename:{filename}.bin|hex` header to force download. +#### `GET /libraries` + +Shows a list of all installed Arduino libraries. + +``` +https://compiler.sensebox.de/libraries +``` + +Parameters: + +- `format` specifies the output format. Possible value: `json` + +``` +https://compiler.sensebox.de/libraries?format=json +``` + +Will return a list of all installed libraries in JSON format. + ## Scaling with docker-compose Newer versions of docker allows to give the same alias to multiple containers in the same network. We exploit this to run multiple instances at the same time to balance load. From 0adb1c8b5d5cf4a50effa4cd4bb9396477f9e232 Mon Sep 17 00:00:00 2001 From: Felix Erdmann Date: Fri, 20 Dec 2024 13:41:47 +0100 Subject: [PATCH 2/2] docs: fix typo and remove section --- README.md | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/README.md b/README.md index b8ff094..40bd54c 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ Downloads a compiled sketch. Parameters: - `id` is the returned `id` from `/compile` -- `board` specifies which compiled file should be downloaded. Posibile values `sensebox-mcu` or `sensebox` +- `board` specifies which compiled file should be downloaded. Possible values `sensebox-mcu` or `sensebox` - `filename` name for the sketch. Default value is `sketch` ``` @@ -102,13 +102,3 @@ Just start multiple instances using docker-compose up -d --scale compiler=4 Then reference the containers by its `compiler` alias and multiple requests will be served by different containers. - -## In the container - -### Compiling senseBox MCU Sketches Examples - - arduino-builder -hardware /arduino-ide/hardware -hardware /root/.arduino15/packages -tools /arduino-ide/tools-builder -tools /root/.arduino15/packages -libraries /arduino-ide/libraries -fqbn=sensebox:samd:sb:power=on -build-cache /arduino-ide/build-cache -build-path /arduino-ide/builds /root/.arduino15/packages/sensebox/hardware/samd/1.0.4/libraries/senseBox/examples/Blink/Blink.ino - -### Compiling for Arduino Uno - - arduino-builder -hardware /arduino-ide/hardware -hardware /root/.arduino15/packages -tools /arduino-ide/tools-builder -tools /root/.arduino15/packages -libraries /arduino-ide/libraries -fqbn=arduino:avr:uno -build-cache /arduino-ide/build-cache -build-path /arduino-ide/builds /root/.arduino15/packages/sensebox/hardware/samd/1.0.4/libraries/senseBox/examples/Blink/Blink.ino