From 2a0bb20bcb83000a9d7b0f0898aba0c8e811841b Mon Sep 17 00:00:00 2001 From: pabera <1260686+pabera@users.noreply.github.com> Date: Fri, 24 Nov 2023 23:24:29 +0100 Subject: [PATCH 1/5] Update some links in the documentation (#2122) * Update some links in the documentation * Rename docs folder userguide to builders * Update some headlines --- README.md | 2 +- documentation/README.md | 14 ++++++++------ .../content/{userguide => builders}/README.md | 2 +- .../content/{userguide => builders}/audio.md | 0 .../{userguide => builders}/autohotspot.md | 0 .../bluetooth-audio-buttons.md | 0 .../{userguide => builders}/card-database.md | 2 +- .../content/{userguide => builders}/concepts.md | 0 .../{userguide => builders}/configuration.md | 0 .../{userguide => builders}/installation.md | 2 +- .../content/{userguide => builders}/mock_gpio.png | Bin .../content/{userguide => builders}/rfid.md | 0 .../content/{userguide => builders}/system.md | 0 .../{userguide => builders}/troubleshooting.md | 0 .../content/{userguide => builders}/update.md | 0 documentation/content/developers/coreapps.md | 8 ++++---- .../content/developers/development-environment.md | 2 +- documentation/content/developers/rfid/basics.md | 4 ++-- .../content/developers/rfid/mock_reader.md | 2 +- documentation/content/developers/status.md | 2 +- 20 files changed, 21 insertions(+), 19 deletions(-) rename documentation/content/{userguide => builders}/README.md (97%) rename documentation/content/{userguide => builders}/audio.md (100%) rename documentation/content/{userguide => builders}/autohotspot.md (100%) rename documentation/content/{userguide => builders}/bluetooth-audio-buttons.md (100%) rename documentation/content/{userguide => builders}/card-database.md (97%) rename documentation/content/{userguide => builders}/concepts.md (100%) rename documentation/content/{userguide => builders}/configuration.md (100%) rename documentation/content/{userguide => builders}/installation.md (97%) rename documentation/content/{userguide => builders}/mock_gpio.png (100%) rename documentation/content/{userguide => builders}/rfid.md (100%) rename documentation/content/{userguide => builders}/system.md (100%) rename documentation/content/{userguide => builders}/troubleshooting.md (100%) rename documentation/content/{userguide => builders}/update.md (100%) diff --git a/README.md b/README.md index b95b0e8c3..8b494698d 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ project check out the [documentation of Version 2]( [!IMPORTANT] -> Currently, the installation does only work on Raspberry Pi's with ARMv7 and ARMv8 architecture, so 2, 3 and 4! Pi 1 and Zero's are currently unstable and will require a bit more work! +> Currently, the installation does only work on Raspberry Pi's with ARMv7 and ARMv8 architecture, so 2, 3 and 4! Pi 1 and Zero's are currently unstable and will require a bit more work! Pi 4 and 5 are an excess ;-) Before you can install the Phoniebox software, you need to prepare your Raspberry Pi. diff --git a/documentation/content/userguide/mock_gpio.png b/documentation/content/builders/mock_gpio.png similarity index 100% rename from documentation/content/userguide/mock_gpio.png rename to documentation/content/builders/mock_gpio.png diff --git a/documentation/content/userguide/rfid.md b/documentation/content/builders/rfid.md similarity index 100% rename from documentation/content/userguide/rfid.md rename to documentation/content/builders/rfid.md diff --git a/documentation/content/userguide/system.md b/documentation/content/builders/system.md similarity index 100% rename from documentation/content/userguide/system.md rename to documentation/content/builders/system.md diff --git a/documentation/content/userguide/troubleshooting.md b/documentation/content/builders/troubleshooting.md similarity index 100% rename from documentation/content/userguide/troubleshooting.md rename to documentation/content/builders/troubleshooting.md diff --git a/documentation/content/userguide/update.md b/documentation/content/builders/update.md similarity index 100% rename from documentation/content/userguide/update.md rename to documentation/content/builders/update.md diff --git a/documentation/content/developers/coreapps.md b/documentation/content/developers/coreapps.md index 757af2ae4..be15f133a 100644 --- a/documentation/content/developers/coreapps.md +++ b/documentation/content/developers/coreapps.md @@ -13,14 +13,14 @@ $ ./run_app_name.py -h This is the main app and starts the Jukebox Core. -Usually this runs as a service, which is started automatically after boot-up. At times, it may be necessary to restart the service. For example after a configuration change. Not all configuration changes can be applied on-the-fly. See [Jukebox Configuration](../userguide/configuration.md#jukebox-configuration). +Usually this runs as a service, which is started automatically after boot-up. At times, it may be necessary to restart the service. For example after a configuration change. Not all configuration changes can be applied on-the-fly. See [Jukebox Configuration](../builders/configuration.md#jukebox-configuration). -For debugging, it is usually desirable to run the Jukebox directly from the console rather than as service. This gives direct logging info in the console and allows changing command line parameters. See [Troubleshooting](../userguide/troubleshooting.md). +For debugging, it is usually desirable to run the Jukebox directly from the console rather than as service. This gives direct logging info in the console and allows changing command line parameters. See [Troubleshooting](../builders/troubleshooting.md). ## Configuration Tools Before running the configuration tools, stop the Jukebox Core service. -See [Best practice procedure](../userguide/configuration.md#best-practice-procedure). +See [Best practice procedure](../builders/configuration.md#best-practice-procedure). ### `run_configure_audio.py` @@ -28,7 +28,7 @@ Setup tool to register the PulseAudio sinks as primary and secondary audio outpu Will also setup equalizer and mono down mixer in the pulseaudio config file. -Run this once after installation. Can be re-run at any time to change the settings. For more information see [Audio Configuration](../userguide/audio.md). +Run this once after installation. Can be re-run at any time to change the settings. For more information see [Audio Configuration](../builders/audio.md). ### `run_register_rfid_reader.py` diff --git a/documentation/content/developers/development-environment.md b/documentation/content/developers/development-environment.md index 62eaeaec6..d79a6101e 100644 --- a/documentation/content/developers/development-environment.md +++ b/documentation/content/developers/development-environment.md @@ -16,7 +16,7 @@ developing. 1. Install the latest Pi OS on a SD card. 2. Boot up your Raspberry Pi. -3. [Install](../userguide/installation.md) the Jukebox software as if you were building a +3. [Install](../builders/installation.md) the Jukebox software as if you were building a Phoniebox. You can install from your own fork and feature branch if you wish which can be changed later as well. The original repository will be set as `upstream`. diff --git a/documentation/content/developers/rfid/basics.md b/documentation/content/developers/rfid/basics.md index 5cd1d1e9f..ec8844263 100644 --- a/documentation/content/developers/rfid/basics.md +++ b/documentation/content/developers/rfid/basics.md @@ -6,7 +6,7 @@ Cards placed on the reader trigger an action. An action may be any callable plugin function through the RPC with any arguments. Typically, this would be "play some folder", but can also be "activate shutdown timer", or "increase volume". This is configured in the -[Card Database](../../userguide/card-database.md). +[Card Database](../../builders/card-database.md). You may configure a single or even multiple parallel readers (of different or identical types). @@ -79,7 +79,7 @@ For place-capable RFID readers enable dual action mode: a start action (e.g. pla #### card_removal_action: Dictionary -Executes the given function on card removal. Only relevant if place_not_swipe is true. The action is identical for all cards read on that reader. The removal-action can be set to ignored on a card-by-card basis. More on card action configurations in [RPC Commands](../userguide/rpc-commands.md). +Executes the given function on card removal. Only relevant if place_not_swipe is true. The action is identical for all cards read on that reader. The removal-action can be set to ignored on a card-by-card basis. More on card action configurations in [RPC Commands](../builders/rpc-commands.md). > [!NOTE] > Developer's note: The reason for a unique removal action for all cards is that card triggering and card removal are happening in two separate threads. Removal needs to be in a time-out thread. Thus, we would need to transport information from one thread to another. This can be done of course but is not implemented (yet). Ignoring card removal is much easier and works for now. diff --git a/documentation/content/developers/rfid/mock_reader.md b/documentation/content/developers/rfid/mock_reader.md index da90d5405..ece44f653 100644 --- a/documentation/content/developers/rfid/mock_reader.md +++ b/documentation/content/developers/rfid/mock_reader.md @@ -6,7 +6,7 @@ machine - probably in a Python virtual environment. **place-capable**: yes -If you [mock the GPIO pins](../userguide/gpio.md), this GUI will show the GPIO devices. +If you [mock the GPIO pins](../builders/gpio.md), this GUI will show the GPIO devices. ![image](mock_reader.png) diff --git a/documentation/content/developers/status.md b/documentation/content/developers/status.md index 3cc8d7f47..50968293c 100644 --- a/documentation/content/developers/status.md +++ b/documentation/content/developers/status.md @@ -183,7 +183,7 @@ Topics marked _in progress_ are already in the process of implementation by comm ### GPIO -- [x] All done! Read the docs at [GPIO Recipes](#userguide/gpioz:GPIO Recipes)! +- [x] All done! Read the docs at [GPIO Recipes](#builders/gpioz:GPIO Recipes)! - [ ] USB Buttons: It's a different category as it works similar to the RFID cards (in progress) ### WLAN From 94aa9dc6231a5d42337ade19fccf9885984af0e1 Mon Sep 17 00:00:00 2001 From: pabera <1260686+pabera@users.noreply.github.com> Date: Sat, 25 Nov 2023 00:14:29 +0100 Subject: [PATCH 2/5] Future3/update docs (#2123) * Update pulseaudio link for docker mac setup * Update Docker docs --- documentation/content/developers/docker.md | 112 ++++++++++----------- 1 file changed, 54 insertions(+), 58 deletions(-) diff --git a/documentation/content/developers/docker.md b/documentation/content/developers/docker.md index 0def11610..96b5a64b6 100644 --- a/documentation/content/developers/docker.md +++ b/documentation/content/developers/docker.md @@ -14,16 +14,8 @@ need to adapt some of those commands to your needs. ## Prerequisites -1. Install required software - * Linux - * [Docker](https://docs.docker.com/engine/install/debian/) - * [Compose](https://docs.docker.com/compose/install/) - * Mac - * [Docker & Compose (Mac)](https://docs.docker.com/docker-for-mac/install/) - * [pulseaudio (Docker)](https://devops.datenkollektiv.de/running-a-docker-soundbox-on-mac.html) - * Windows - * [Docker & Compose (Windows)](https://docs.docker.com/docker-for-windows/install/) - * [pulseaudio (Windows)](https://www.freedesktop.org/wiki/Software/PulseAudio/Ports/Windows/Support/) +1. Install required software: Docker, Compose and pulseaudio + * Check installations guide for [Mac](#mac), [Windows](#windows) or [Linux](#linux) 2. Pull the Jukebox repository: @@ -52,47 +44,10 @@ practice to isolate different components in different Docker images. They can be run individually or in combination. To do that, we use `docker-compose`. -### Linux - -Make sure you don\'t use `sudo` to run your `docker-compose`. Check out -Docker\'s [post-installation guide](https://docs.docker.com/engine/install/linux-postinstall/) for more information. - -```bash -// Build Images -$ docker-compose -f docker/docker-compose.yml -f docker/docker-compose.linux.yml build - -// Run Docker Environment -$ docker-compose -f docker/docker-compose.yml -f docker/docker-compose.linux.yml up - -// Shuts down Docker containers and Docker network -$ docker-compose -f docker/docker-compose.yml -f docker/docker-compose.linux.yml down -``` - -Note: if you have `mpd` running on your system, you need to stop it -using: - -``` bash -$ sudo systemctl stop mpd.socket -$ sudo mpd --kill -``` - -Otherwise you might get the error message: - -``` bash -$ docker-compose -f docker-compose.yml -f docker-compose.linux.yml up -Starting mpd ... -Starting mpd ... error -(...) -Error starting userland proxy: listen tcp4 0.0.0.0:6600: bind: address already in use -``` - -Read these threads for details: [thread 1](https://unix.stackexchange.com/questions/456909/socket-already-in-use-but-is-not-listed-mpd) and [thread 2](https://stackoverflow.com/questions/5106674/error-address-already-in-use-while-binding-socket-with-address-but-the-port-num/5106755#5106755) - ### Mac -Remember, pulseaudio is a prerequisite. [Follow these -instructions](https://stackoverflow.com/a/50939994/1062438) for Mac -hosts. +1. [Install Docker & Compose (Mac)](https://docs.docker.com/docker-for-mac/install/) +2. [Install pulseaudio](https://gist.github.com/seongyongkim/b7d630a03e74c7ab1c6b53473b592712) (Other references: [[1]](https://devops.datenkollektiv.de/running-a-docker-soundbox-on-mac.html), [[2]](https://stackoverflow.com/a/50939994/1062438)) ``` bash // Build Images @@ -107,31 +62,32 @@ $ docker-compose -f docker/docker-compose.yml -f docker/docker-compose.mac.yml d ### Windows -1. Download - [pulseaudio](https://www.freedesktop.org/wiki/Software/PulseAudio/Ports/Windows/Support/) +1. Install [Docker & Compose (Windows)](https://docs.docker.com/docker-for-windows/install/) + +2. Download [pulseaudio](https://www.freedesktop.org/wiki/Software/PulseAudio/Ports/Windows/Support/) -2. Uncompress somewhere in your user folder +3. Uncompress somewhere in your user folder -3. Edit `$INSTALL_DIR/etc/pulse/default.pa` +4. Edit `$INSTALL_DIR/etc/pulse/default.pa` -4. Add the following line +5. Add the following line ``` bash load-module module-native-protocol-tcp auth-ip-acl=127.0.0.1 ``` -5. Edit `$INSTALL_DIR/etc/pulse//etc/pulse/daemon.conf`, find the +6. Edit `$INSTALL_DIR/etc/pulse//etc/pulse/daemon.conf`, find the following line and change it to: ``` bash exit-idle-time = -1 ``` -6. Execute `$INSTALL_DIR/bin/pulseaudio.exe` +7. Execute `$INSTALL_DIR/bin/pulseaudio.exe` -7. Make sure Docker is running (e.g. start Docker Desktop) +8. Make sure Docker is running (e.g. start Docker Desktop) -8. Run `docker-compose` +9. Run `docker-compose` ``` bash // Build Images @@ -144,6 +100,46 @@ $ docker-compose -f docker/docker-compose.yml -f docker/docker-compose.mac.yml d $ docker-compose -f docker/docker-compose.yml down ``` +### Linux + +1. Install Docker & Compose + * [Docker](https://docs.docker.com/engine/install/debian/) + * [Compose](https://docs.docker.com/compose/install/) +2. Make sure you don\'t use `sudo` to run your `docker-compose`. Check out +Docker\'s [post-installation guide](https://docs.docker.com/engine/install/linux-postinstall/) for more information. + +```bash +// Build Images +$ docker-compose -f docker/docker-compose.yml -f docker/docker-compose.linux.yml build + +// Run Docker Environment +$ docker-compose -f docker/docker-compose.yml -f docker/docker-compose.linux.yml up + +// Shuts down Docker containers and Docker network +$ docker-compose -f docker/docker-compose.yml -f docker/docker-compose.linux.yml down +``` + +Note: if you have `mpd` running on your system, you need to stop it +using: + +``` bash +$ sudo systemctl stop mpd.socket +$ sudo mpd --kill +``` + +Otherwise you might get the error message: + +``` bash +$ docker-compose -f docker-compose.yml -f docker-compose.linux.yml up +Starting mpd ... +Starting mpd ... error +(...) +Error starting userland proxy: listen tcp4 0.0.0.0:6600: bind: address already in use +``` + +Read these threads for details: [thread 1](https://unix.stackexchange.com/questions/456909/socket-already-in-use-but-is-not-listed-mpd) and [thread 2](https://stackoverflow.com/questions/5106674/error-address-already-in-use-while-binding-socket-with-address-but-the-port-num/5106755#5106755) + + ## Test & Develop The Dockerfile is defined to start all Phoniebox related services. From 924c7f3a4db584d26d45e188b44209e0f053d320 Mon Sep 17 00:00:00 2001 From: pabera <1260686+pabera@users.noreply.github.com> Date: Sat, 25 Nov 2023 19:46:42 +0100 Subject: [PATCH 3/5] Remove content folder from docs (#2124) --- documentation/README.md | 12 ++++++------ documentation/{content => }/builders/README.md | 0 documentation/{content => }/builders/audio.md | 0 documentation/{content => }/builders/autohotspot.md | 0 .../builders/bluetooth-audio-buttons.md | 0 .../{content => }/builders/card-database.md | 0 documentation/{content => }/builders/concepts.md | 0 .../{content => }/builders/configuration.md | 0 .../{content => }/builders/installation.md | 0 documentation/{content => }/builders/mock_gpio.png | Bin documentation/{content => }/builders/rfid.md | 0 documentation/{content => }/builders/system.md | 0 .../{content => }/builders/troubleshooting.md | 0 documentation/{content => }/builders/update.md | 0 .../calendars/2019-Phoniebox-Calendar.jpg | Bin .../calendars/2020-Phoniebox-Calendar.jpg | Bin .../calendars/2021-Phoniebox-Calendar.jpg | Bin documentation/{content => }/developers/README.md | 2 +- documentation/{content => }/developers/coreapps.md | 0 .../{content => }/developers/developer-issues.md | 0 .../developers/development-environment.md | 0 documentation/{content => }/developers/docker.md | 0 .../{content => }/developers/known-issues.md | 0 .../{content => }/developers/rfid/README.md | 0 .../{content => }/developers/rfid/basics.md | 0 .../{content => }/developers/rfid/genericusb.md | 0 .../{content => }/developers/rfid/mfrc522_spi.md | 0 .../{content => }/developers/rfid/mock_reader.md | 0 .../{content => }/developers/rfid/mock_reader.png | Bin .../{content => }/developers/rfid/pn532_i2c.md | 0 .../{content => }/developers/rfid/rdm6300.md | 0 .../developers/rfid/template_reader.md | 0 documentation/{content => }/developers/status.md | 0 33 files changed, 7 insertions(+), 7 deletions(-) rename documentation/{content => }/builders/README.md (100%) rename documentation/{content => }/builders/audio.md (100%) rename documentation/{content => }/builders/autohotspot.md (100%) rename documentation/{content => }/builders/bluetooth-audio-buttons.md (100%) rename documentation/{content => }/builders/card-database.md (100%) rename documentation/{content => }/builders/concepts.md (100%) rename documentation/{content => }/builders/configuration.md (100%) rename documentation/{content => }/builders/installation.md (100%) rename documentation/{content => }/builders/mock_gpio.png (100%) rename documentation/{content => }/builders/rfid.md (100%) rename documentation/{content => }/builders/system.md (100%) rename documentation/{content => }/builders/troubleshooting.md (100%) rename documentation/{content => }/builders/update.md (100%) rename documentation/{content => }/calendars/2019-Phoniebox-Calendar.jpg (100%) rename documentation/{content => }/calendars/2020-Phoniebox-Calendar.jpg (100%) rename documentation/{content => }/calendars/2021-Phoniebox-Calendar.jpg (100%) rename documentation/{content => }/developers/README.md (93%) rename documentation/{content => }/developers/coreapps.md (100%) rename documentation/{content => }/developers/developer-issues.md (100%) rename documentation/{content => }/developers/development-environment.md (100%) rename documentation/{content => }/developers/docker.md (100%) rename documentation/{content => }/developers/known-issues.md (100%) rename documentation/{content => }/developers/rfid/README.md (100%) rename documentation/{content => }/developers/rfid/basics.md (100%) rename documentation/{content => }/developers/rfid/genericusb.md (100%) rename documentation/{content => }/developers/rfid/mfrc522_spi.md (100%) rename documentation/{content => }/developers/rfid/mock_reader.md (100%) rename documentation/{content => }/developers/rfid/mock_reader.png (100%) rename documentation/{content => }/developers/rfid/pn532_i2c.md (100%) rename documentation/{content => }/developers/rfid/rdm6300.md (100%) rename documentation/{content => }/developers/rfid/template_reader.md (100%) rename documentation/{content => }/developers/status.md (100%) diff --git a/documentation/README.md b/documentation/README.md index 087b57ad8..d15d6c599 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -11,13 +11,13 @@ project check out the [documentation of Version 2](https://github.com/MiczFlor/R ## Quickstart * For Builders: Building a Phoniebox - * [Installing Phoniebox future3](./content/builders/installation.md) - * [Builder Guides](./content/builders/README.md) - * [Update](./content/builders/update.md) + * [Installing Phoniebox future3](./builders/installation.md) + * [Builder Guides](./builders/README.md) + * [Update](./builders/update.md) * For Developers: Add features or fix bugs - * [Developer Reference](./content/developers/README.md) - * [Feature Status](./content/developers/status.md) - * [Known Issues](./content/developers/known-issues.md) + * [Developer Guides](./developers/README.md) + * [Feature Status](./developers/status.md) + * [Known Issues](./developers/known-issues.md) ## future3 diff --git a/documentation/content/builders/README.md b/documentation/builders/README.md similarity index 100% rename from documentation/content/builders/README.md rename to documentation/builders/README.md diff --git a/documentation/content/builders/audio.md b/documentation/builders/audio.md similarity index 100% rename from documentation/content/builders/audio.md rename to documentation/builders/audio.md diff --git a/documentation/content/builders/autohotspot.md b/documentation/builders/autohotspot.md similarity index 100% rename from documentation/content/builders/autohotspot.md rename to documentation/builders/autohotspot.md diff --git a/documentation/content/builders/bluetooth-audio-buttons.md b/documentation/builders/bluetooth-audio-buttons.md similarity index 100% rename from documentation/content/builders/bluetooth-audio-buttons.md rename to documentation/builders/bluetooth-audio-buttons.md diff --git a/documentation/content/builders/card-database.md b/documentation/builders/card-database.md similarity index 100% rename from documentation/content/builders/card-database.md rename to documentation/builders/card-database.md diff --git a/documentation/content/builders/concepts.md b/documentation/builders/concepts.md similarity index 100% rename from documentation/content/builders/concepts.md rename to documentation/builders/concepts.md diff --git a/documentation/content/builders/configuration.md b/documentation/builders/configuration.md similarity index 100% rename from documentation/content/builders/configuration.md rename to documentation/builders/configuration.md diff --git a/documentation/content/builders/installation.md b/documentation/builders/installation.md similarity index 100% rename from documentation/content/builders/installation.md rename to documentation/builders/installation.md diff --git a/documentation/content/builders/mock_gpio.png b/documentation/builders/mock_gpio.png similarity index 100% rename from documentation/content/builders/mock_gpio.png rename to documentation/builders/mock_gpio.png diff --git a/documentation/content/builders/rfid.md b/documentation/builders/rfid.md similarity index 100% rename from documentation/content/builders/rfid.md rename to documentation/builders/rfid.md diff --git a/documentation/content/builders/system.md b/documentation/builders/system.md similarity index 100% rename from documentation/content/builders/system.md rename to documentation/builders/system.md diff --git a/documentation/content/builders/troubleshooting.md b/documentation/builders/troubleshooting.md similarity index 100% rename from documentation/content/builders/troubleshooting.md rename to documentation/builders/troubleshooting.md diff --git a/documentation/content/builders/update.md b/documentation/builders/update.md similarity index 100% rename from documentation/content/builders/update.md rename to documentation/builders/update.md diff --git a/documentation/content/calendars/2019-Phoniebox-Calendar.jpg b/documentation/calendars/2019-Phoniebox-Calendar.jpg similarity index 100% rename from documentation/content/calendars/2019-Phoniebox-Calendar.jpg rename to documentation/calendars/2019-Phoniebox-Calendar.jpg diff --git a/documentation/content/calendars/2020-Phoniebox-Calendar.jpg b/documentation/calendars/2020-Phoniebox-Calendar.jpg similarity index 100% rename from documentation/content/calendars/2020-Phoniebox-Calendar.jpg rename to documentation/calendars/2020-Phoniebox-Calendar.jpg diff --git a/documentation/content/calendars/2021-Phoniebox-Calendar.jpg b/documentation/calendars/2021-Phoniebox-Calendar.jpg similarity index 100% rename from documentation/content/calendars/2021-Phoniebox-Calendar.jpg rename to documentation/calendars/2021-Phoniebox-Calendar.jpg diff --git a/documentation/content/developers/README.md b/documentation/developers/README.md similarity index 93% rename from documentation/content/developers/README.md rename to documentation/developers/README.md index a2cb94c42..9136c5f31 100644 --- a/documentation/content/developers/README.md +++ b/documentation/developers/README.md @@ -1,4 +1,4 @@ -# Developers +# Developer Guides ## Getting started diff --git a/documentation/content/developers/coreapps.md b/documentation/developers/coreapps.md similarity index 100% rename from documentation/content/developers/coreapps.md rename to documentation/developers/coreapps.md diff --git a/documentation/content/developers/developer-issues.md b/documentation/developers/developer-issues.md similarity index 100% rename from documentation/content/developers/developer-issues.md rename to documentation/developers/developer-issues.md diff --git a/documentation/content/developers/development-environment.md b/documentation/developers/development-environment.md similarity index 100% rename from documentation/content/developers/development-environment.md rename to documentation/developers/development-environment.md diff --git a/documentation/content/developers/docker.md b/documentation/developers/docker.md similarity index 100% rename from documentation/content/developers/docker.md rename to documentation/developers/docker.md diff --git a/documentation/content/developers/known-issues.md b/documentation/developers/known-issues.md similarity index 100% rename from documentation/content/developers/known-issues.md rename to documentation/developers/known-issues.md diff --git a/documentation/content/developers/rfid/README.md b/documentation/developers/rfid/README.md similarity index 100% rename from documentation/content/developers/rfid/README.md rename to documentation/developers/rfid/README.md diff --git a/documentation/content/developers/rfid/basics.md b/documentation/developers/rfid/basics.md similarity index 100% rename from documentation/content/developers/rfid/basics.md rename to documentation/developers/rfid/basics.md diff --git a/documentation/content/developers/rfid/genericusb.md b/documentation/developers/rfid/genericusb.md similarity index 100% rename from documentation/content/developers/rfid/genericusb.md rename to documentation/developers/rfid/genericusb.md diff --git a/documentation/content/developers/rfid/mfrc522_spi.md b/documentation/developers/rfid/mfrc522_spi.md similarity index 100% rename from documentation/content/developers/rfid/mfrc522_spi.md rename to documentation/developers/rfid/mfrc522_spi.md diff --git a/documentation/content/developers/rfid/mock_reader.md b/documentation/developers/rfid/mock_reader.md similarity index 100% rename from documentation/content/developers/rfid/mock_reader.md rename to documentation/developers/rfid/mock_reader.md diff --git a/documentation/content/developers/rfid/mock_reader.png b/documentation/developers/rfid/mock_reader.png similarity index 100% rename from documentation/content/developers/rfid/mock_reader.png rename to documentation/developers/rfid/mock_reader.png diff --git a/documentation/content/developers/rfid/pn532_i2c.md b/documentation/developers/rfid/pn532_i2c.md similarity index 100% rename from documentation/content/developers/rfid/pn532_i2c.md rename to documentation/developers/rfid/pn532_i2c.md diff --git a/documentation/content/developers/rfid/rdm6300.md b/documentation/developers/rfid/rdm6300.md similarity index 100% rename from documentation/content/developers/rfid/rdm6300.md rename to documentation/developers/rfid/rdm6300.md diff --git a/documentation/content/developers/rfid/template_reader.md b/documentation/developers/rfid/template_reader.md similarity index 100% rename from documentation/content/developers/rfid/template_reader.md rename to documentation/developers/rfid/template_reader.md diff --git a/documentation/content/developers/status.md b/documentation/developers/status.md similarity index 100% rename from documentation/content/developers/status.md rename to documentation/developers/status.md From 12f4f92e15c26b719f702d8af49342d92b31867b Mon Sep 17 00:00:00 2001 From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com> Date: Sat, 25 Nov 2023 23:36:44 +0100 Subject: [PATCH 4/5] Future3/documentation (#2127) * fixed typo * restored "rpc-commands" * fixed broken links * switched placed for leading documentation * added docu for changing swap size * unified links to source --- documentation/README.md | 2 +- documentation/builders/README.md | 2 +- documentation/builders/audio.md | 2 +- documentation/builders/card-database.md | 2 +- documentation/builders/concepts.md | 6 +- documentation/builders/configuration.md | 2 +- documentation/builders/rpc-commands.md | 112 ++++++++++++++++++ documentation/developers/coreapps.md | 13 +- documentation/developers/developer-issues.md | 12 ++ documentation/developers/rfid/basics.md | 2 +- documentation/developers/rfid/genericusb.md | 2 +- documentation/developers/rfid/mock_reader.md | 2 +- .../developers/rfid/template_reader.md | 42 ++++++- .../rfid/hardware/fake_reader_gui/README.md | 2 +- .../rfid/hardware/generic_usb/README.md | 2 +- .../rfid/hardware/pn532_i2c_py532/README.md | 2 +- .../rfid/hardware/rc522_spi/README.md | 2 +- .../rfid/hardware/rdm6300_serial/README.md | 2 +- .../hardware/template_new_reader/README.md | 41 +------ 19 files changed, 193 insertions(+), 59 deletions(-) create mode 100644 documentation/builders/rpc-commands.md diff --git a/documentation/README.md b/documentation/README.md index d15d6c599..71ef9010f 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -6,7 +6,7 @@ The exciting, new Version 3 of the RPi Jukebox RFID. A complete rewrite of the J > This documentation applies to the Version 3 which is developed in the branches `future3/main` and `future3/develop`. Currently the default Version is 2.x To find out more about the RPi Jukebox RFID -project check out the [documentation of Version 2](https://github.com/MiczFlor/RPi-Jukebox-RFID) or [www.phoniebox.de](https://www.phoniebox.de/). +project check out the [documentation of Version 2](https://github.com/MiczFlor/RPi-Jukebox-RFID) or [www.phoniebox.de](https://phoniebox.de/). ## Quickstart diff --git a/documentation/builders/README.md b/documentation/builders/README.md index 22128308f..3d70bca15 100644 --- a/documentation/builders/README.md +++ b/documentation/builders/README.md @@ -21,4 +21,4 @@ * [System](./system.md) * [Feature Status](../developers/status.md) * [Known Issues](../developers/known-issues.md) -* [Developer Reference](../developers) +* [Developer Reference](../developers/README.md) diff --git a/documentation/builders/audio.md b/documentation/builders/audio.md index d4b06b481..07d24e40f 100644 --- a/documentation/builders/audio.md +++ b/documentation/builders/audio.md @@ -99,7 +99,7 @@ Rerun the config tool to register the Bluetooth device with the Jukebox core app For other audio configuration options, please look at the `jukebox.yaml` for now. -Directly edit `jukebox.yaml` following the steps: [Best practice procedure](configuraton.md#best-practice-procedure). +Directly edit `jukebox.yaml` following the steps: [Best practice procedure](configuration.md#best-practice-procedure). ## Developer Information diff --git a/documentation/builders/card-database.md b/documentation/builders/card-database.md index 99c213571..67dbf5dae 100644 --- a/documentation/builders/card-database.md +++ b/documentation/builders/card-database.md @@ -4,7 +4,7 @@ In the card database, an RPC command is assigned to every card. This RPC command is called every time when the card is swiped (or placed) on the reader. Every RPC callable function can be called. See -[RPC Commands](builders/rpc_commands.md) for an introduction. +[RPC Commands](rpc-commands.md) for an introduction. The card database is stored in `shared\settings\cards.yaml`. Here are some examples for RPC command assignments to cards \'0001\' to \'0003\' diff --git a/documentation/builders/concepts.md b/documentation/builders/concepts.md index 70f285973..c08a33caa 100644 --- a/documentation/builders/concepts.md +++ b/documentation/builders/concepts.md @@ -16,12 +16,10 @@ The Remote Procedure Call (RPC) server allows remotely triggering actions (e.g., Why should you care? Because we use the same protocol when triggering actions from other inputs like a card swipe, a GPIO button press, etc. How that works is described in [RPC Commands](rpc-commands.md). -You will find a full list of RPC callable functions in [RPC Command Reference](rpc-command-reference.md) and aliases for convenience in [RPC Command Alias Reference](rpc-command-alias-reference.md). - -We also have a tool to send RPC commands to the running Jukebox application: [run_rpc_tool.py](../../../src/jukebox/run_rpc_tool.py). +We also have a tool to send RPC commands to the running Jukebox application: [run_rpc_tool.py](../developers/coreapps.md#run_rpc_toolpy) ## Publishing Message Queue The Publishing Message Queue is the complementary part to the RPC where the core application publishes its status and status updates. As a user, you need not worry about it. -If you want to interact with the Jukebox from your own application, this is where you get the current state from. Details about the protocol can be found here (TBD). A sniffer tool exists which listens and prints the incoming status messages: [run_publicity_sniffer.py](../../../src/jukebox/run_rpc_tool.py). +If you want to interact with the Jukebox from your own application, this is where you get the current state from. Details about the protocol can be found here (TBD). A sniffer tool exists which listens and prints the incoming status messages: [run_publicity_sniffer.py](../developers/coreapps.md#run_publicity_snifferpy). diff --git a/documentation/builders/configuration.md b/documentation/builders/configuration.md index 2aaa3184b..e0240ddbe 100644 --- a/documentation/builders/configuration.md +++ b/documentation/builders/configuration.md @@ -10,7 +10,7 @@ Don't fear (overly), they contain commentaries. For several aspects we have :ref:`developer/coreapps:Configuration Tools` and detailed guides: * [Audio Configuration](./audio.md#audio-configuration) -* [RFID Reader Configuration](./rfid/basics.md#reader-configuration) +* [RFID Reader Configuration](../developers/rfid/basics.md#reader-configuration) Even after running the tools, certain aspects can only be changed by modifying the configuration files directly. diff --git a/documentation/builders/rpc-commands.md b/documentation/builders/rpc-commands.md new file mode 100644 index 000000000..f578ccd99 --- /dev/null +++ b/documentation/builders/rpc-commands.md @@ -0,0 +1,112 @@ +# RPC Commands + + +We use the RPC commands when triggering actions from different inputs like a card swipe, +a GPIO button press, etc. Triggering an action is equal to sending an RPC function call. +In many places the command to send when an input is triggered is configurable in a YAML-file. + +## Basics + +Consequently, you need to know how to specify the RPC command in the YAML file. +Here is the essence of what you need to know: + +An RPC command consists of up to three parts + + #. the function to execute (e.g. play_folder, change_volume) + #. the positional arguments (optional) + #. the keyword arguments (optional) + +The function specification consists of two (e.g., ``host.shutdown``) or three terms (e.g., ``volume.ctrl.change_volume``). +In configuration files, this will look like this: + +.. code-block:: yaml + + package: host + plugin: shutdown + +Or like this for a three part function with the argument set to ``5``: + +.. code-block:: yaml + + package: volume + plugin: ctrl + method: change_volume + args: [5] + +The keyword ``method`` is optional. If needs to be used depends on the function you want to call. + +## Aliases + + +Not so complicated, right? It will get even easier. For common commands we have defined aliases. An alias simply maps +to a pre-defined RPC command, e.g. ``play_card`` maps to ``player.ctrl.play_card``. + +Instead of + +.. code-block:: yaml + + package: player + plugin: ctrl + method: play_card + args: [path/to/folder] + +you can simply specify instead : + +.. code-block:: yaml + + alias: play_card + args: [path/to/folder] + +Using in alias is optional. But if the keyword is present in the configuration it takes precedence over an explicit +specified RPC command. + +## Arguments + +Arguments can be specified in similar fashion to Python function arguments: as positional arguments and / or +keyword arguments. Let's check out play_card, which is defined as: + +.. py:function:: play_card(...) -> player.ctrl.play_card(folder: str, recursive: bool = False) + :noindex: + + :param folder: Folder path relative to music library path + :param recursive: Add folder recursively + +This means it takes two arguments: + + * folder of type string + * recursive of type bool + +In the following examples, we will always use the alias for smaller configuration text. All three examples +do exactly the same, but use different ways of specifying the command. + +.. code-block:: yaml + + alias: play_card + args: [path/to/folder, True] + +.. code-block:: yaml + + alias: play_card + args: [path/to/folder] + kwargs: + recursive: True + +.. code-block:: yaml + + alias: play_card + kwargs: + folder: path/to/folder + recursive: True + + +.. important:: *args* must be a **list** of arguments to be passed! Even if only a single argument is passed. + So, use *args: [value]*. We try catch mis-uses but that might not always work. + + +You will find some more examples the configuration of the [Card Database](card-database.md) + +## For developers + +To send RPC commands for testing and debugging purpose you can use the CLI Tool [`run_rpc_tool.py`](../developers/coreapps.md#run_rpc_toolpy) +Also here is a ready-to-use decoding functions which decodes an RPC command (with or without alias) +from a YAML entry:func:`jukebox.utils.decode_rpc_command`. diff --git a/documentation/developers/coreapps.md b/documentation/developers/coreapps.md index be15f133a..2fa8b84e9 100644 --- a/documentation/developers/coreapps.md +++ b/documentation/developers/coreapps.md @@ -11,6 +11,8 @@ $ ./run_app_name.py -h ### `run_jukebox.py` +[run_jukebox.py](../../src/jukebox/run_jukebox.py) + This is the main app and starts the Jukebox Core. Usually this runs as a service, which is started automatically after boot-up. At times, it may be necessary to restart the service. For example after a configuration change. Not all configuration changes can be applied on-the-fly. See [Jukebox Configuration](../builders/configuration.md#jukebox-configuration). @@ -24,6 +26,8 @@ See [Best practice procedure](../builders/configuration.md#best-practice-procedu ### `run_configure_audio.py` +[run_configure_audio.py](../../src/jukebox/run_configure_audio.py) + Setup tool to register the PulseAudio sinks as primary and secondary audio outputs. Will also setup equalizer and mono down mixer in the pulseaudio config file. @@ -32,6 +36,8 @@ Run this once after installation. Can be re-run at any time to change the settin ### `run_register_rfid_reader.py` +[run_register_rfid_reader.py](../../src/jukebox/run_register_rfid_reader.py) + Setup tool to configure the RFID Readers. Run this once to register and configure the RFID readers with the Jukebox. Can be re-run at any time to change the settings. For more information see [RFID Readers](./rfid/README.md). @@ -43,7 +49,9 @@ Run this once to register and configure the RFID readers with the Jukebox. Can b ### `run_rpc_tool.py` -Command Line Interface to the Jukebox RPC Server +[run_rpc_tool.py](../../src/jukebox/run_rpc_tool.py) + +Command Line Interface to the Jukebox RPC Server. A command line tool for sending RPC commands to the running jukebox app. This uses the same interface as the WebUI. Can be used for additional control or for debugging. @@ -51,6 +59,9 @@ The tool features auto-completion and command history. The list of available commands is fetched from the running Jukebox service. + ### `run_publicity_sniffer.py` + [run_publicity_sniffer.py](../../src/jukebox/run_publicity_sniffer.py) + A command line tool that monitors all messages being sent out from the Jukebox via the publishing interface. Received messages are printed in the console. Mainly used for debugging. diff --git a/documentation/developers/developer-issues.md b/documentation/developers/developer-issues.md index 4b1bd4794..1ed531738 100644 --- a/documentation/developers/developer-issues.md +++ b/documentation/developers/developer-issues.md @@ -49,6 +49,18 @@ Alternatively, use the provided script, which sets the variable for you $ ./run_rebuild.sh ``` +**Changing Swap Size** + +This will set the swapsize to 1024 MB (and will deactivate swapfactor). Change accordingly if you have a SD Card with small capacity. + +``` +sudo dphys-swapfile swapoff +sudo sed -i "s|.*CONF_SWAPSIZE=.*|CONF_SWAPSIZE=1024|g" /etc/dphys-swapfile +sudo sed -i "s|^\s*CONF_SWAPFACTOR=|#CONF_SWAPFACTOR=|g" /etc/dphys-swapfile +sudo dphys-swapfile setup +sudo dphys-swapfile swapon +``` + ### Process exited too early // kill -9 ``` {.bash emphasize-lines="8,9"} diff --git a/documentation/developers/rfid/basics.md b/documentation/developers/rfid/basics.md index ec8844263..7a5aa37d9 100644 --- a/documentation/developers/rfid/basics.md +++ b/documentation/developers/rfid/basics.md @@ -79,7 +79,7 @@ For place-capable RFID readers enable dual action mode: a start action (e.g. pla #### card_removal_action: Dictionary -Executes the given function on card removal. Only relevant if place_not_swipe is true. The action is identical for all cards read on that reader. The removal-action can be set to ignored on a card-by-card basis. More on card action configurations in [RPC Commands](../builders/rpc-commands.md). +Executes the given function on card removal. Only relevant if place_not_swipe is true. The action is identical for all cards read on that reader. The removal-action can be set to ignored on a card-by-card basis. More on card action configurations in [RPC Commands](../../builders/rpc-commands.md). > [!NOTE] > Developer's note: The reason for a unique removal action for all cards is that card triggering and card removal are happening in two separate threads. Removal needs to be in a time-out thread. Thus, we would need to transport information from one thread to another. This can be done of course but is not implemented (yet). Ignoring card removal is much easier and works for now. diff --git a/documentation/developers/rfid/genericusb.md b/documentation/developers/rfid/genericusb.md index a9a6565b5..23975cf14 100644 --- a/documentation/developers/rfid/genericusb.md +++ b/documentation/developers/rfid/genericusb.md @@ -4,7 +4,7 @@ This module covers all types of USB-based RFID input readers. If you plan to connect multiple USB-based RFID readers to the Jukebox, make -sure to connect all of them before running the registration tool [run_register_rfid_reader.py](../coreapps.md). +sure to connect all of them before running the registration tool [run_register_rfid_reader.py](../coreapps.md#run_register_rfid_readerpy). > [!NOTE] > The user needs to be part of the group \'input\' for evdev to work. This should usually be the case. However, a user can be added with: diff --git a/documentation/developers/rfid/mock_reader.md b/documentation/developers/rfid/mock_reader.md index ece44f653..5daee0ab5 100644 --- a/documentation/developers/rfid/mock_reader.md +++ b/documentation/developers/rfid/mock_reader.md @@ -6,7 +6,7 @@ machine - probably in a Python virtual environment. **place-capable**: yes -If you [mock the GPIO pins](../builders/gpio.md), this GUI will show the GPIO devices. +If you [mock the GPIO pins](../../../src/jukebox/components/gpio/gpioz/README.rst#use-mock-pins), this GUI will show the GPIO devices. ![image](mock_reader.png) diff --git a/documentation/developers/rfid/template_reader.md b/documentation/developers/rfid/template_reader.md index 48275d619..0f4c3e939 100644 --- a/documentation/developers/rfid/template_reader.md +++ b/documentation/developers/rfid/template_reader.md @@ -1,2 +1,42 @@ -For documentation see [src/jukebox/components/rfid/hardware/template_new_reader/README.md](../../../../src/jukebox/components/rfid/hardware/template_new_reader/README.md). +# Template Reader + +*Template for creating and integrating a new RFID Reader* + +> [!NOTE] +> For developers only + +This template provides the skeleton API for a new Reader. If you follow +the conventions outlined below, your new reader will be picked up +automatically There is no extra need to register the reader module with +the Phoniebox. Just re-run `the reader config tool `. + +Follow the instructions in [template_new_reader.py] + +Also have a look at the other reader subpackages to see how stuff works +with an example + +## File structure + +Your new reader is a python subpackage with these three mandatory files + +``` bash +components/rfid/hardware/awesome_reader/ + +- awesome_reader.py <-- The actual reader module + +- description.py <-- A description module w/o dependencies. Do not change the filename! + +- README.rst <-- The Readme +``` + +The module documentation must go into a separate file, called README.ME. + +## Conventions + +- Single reader per directory / subpackage +- reader module directory name and reader module file name must be + identical +- Obviously awesome_reader will be replaced with something more + descriptive. The naming scheme for the subpackage is + - \\_\\_\ + - e.g. generic_usb/generic_usb.py + - e.g. pn532_spi/pn532_spi.py + - ... diff --git a/src/jukebox/components/rfid/hardware/fake_reader_gui/README.md b/src/jukebox/components/rfid/hardware/fake_reader_gui/README.md index 9ba73355a..6144ac1f5 100644 --- a/src/jukebox/components/rfid/hardware/fake_reader_gui/README.md +++ b/src/jukebox/components/rfid/hardware/fake_reader_gui/README.md @@ -1,2 +1,2 @@ -For documentation see [documentation/content/developers/rfid/mock_reader.md](../../../../../../documentation/content/developers/rfid/mock_reader.md). +For documentation see [documentation/developers/rfid/mock_reader.md](../../../../../../documentation/developers/rfid/mock_reader.md). diff --git a/src/jukebox/components/rfid/hardware/generic_usb/README.md b/src/jukebox/components/rfid/hardware/generic_usb/README.md index e82e9005b..cf61d5822 100644 --- a/src/jukebox/components/rfid/hardware/generic_usb/README.md +++ b/src/jukebox/components/rfid/hardware/generic_usb/README.md @@ -1,2 +1,2 @@ -For documentation see [documentation/content/developers/rfid/genericusb.md](../../../../../../documentation/content/developers/rfid/genericusb.md). +For documentation see [documentation/developers/rfid/genericusb.md](../../../../../../documentation/developers/rfid/genericusb.md). diff --git a/src/jukebox/components/rfid/hardware/pn532_i2c_py532/README.md b/src/jukebox/components/rfid/hardware/pn532_i2c_py532/README.md index d92a17c37..6a342e1d6 100644 --- a/src/jukebox/components/rfid/hardware/pn532_i2c_py532/README.md +++ b/src/jukebox/components/rfid/hardware/pn532_i2c_py532/README.md @@ -1,2 +1,2 @@ -For documentation see [documentation/content/developers/rfid/pn532_i2c.md](../../../../../../documentation/content/developers/rfid/pn532_i2c.md). +For documentation see [documentation/developers/rfid/pn532_i2c.md](../../../../../../documentation/developers/rfid/pn532_i2c.md). diff --git a/src/jukebox/components/rfid/hardware/rc522_spi/README.md b/src/jukebox/components/rfid/hardware/rc522_spi/README.md index a78a7a890..8fcbb38a8 100644 --- a/src/jukebox/components/rfid/hardware/rc522_spi/README.md +++ b/src/jukebox/components/rfid/hardware/rc522_spi/README.md @@ -1,2 +1,2 @@ -For documentation see [documentation/content/developers/rfid/mfrc522_spi.md](../../../../../../documentation/content/developers/rfid/mfrc522_spi.md). +For documentation see [documentation/developers/rfid/mfrc522_spi.md](../../../../../../documentation/developers/rfid/mfrc522_spi.md). diff --git a/src/jukebox/components/rfid/hardware/rdm6300_serial/README.md b/src/jukebox/components/rfid/hardware/rdm6300_serial/README.md index 895c24bbf..9f0f39fad 100644 --- a/src/jukebox/components/rfid/hardware/rdm6300_serial/README.md +++ b/src/jukebox/components/rfid/hardware/rdm6300_serial/README.md @@ -1,2 +1,2 @@ -For documentation see [documentation/content/developers/rfid/rdm6300.md](../../../../../../documentation/content/developers/rfid/rdm6300.md). +For documentation see [documentation/developers/rfid/rdm6300.md](../../../../../../documentation/developers/rfid/rdm6300.md). diff --git a/src/jukebox/components/rfid/hardware/template_new_reader/README.md b/src/jukebox/components/rfid/hardware/template_new_reader/README.md index 77f3008c2..2ff93198c 100644 --- a/src/jukebox/components/rfid/hardware/template_new_reader/README.md +++ b/src/jukebox/components/rfid/hardware/template_new_reader/README.md @@ -1,41 +1,2 @@ -# Template Reader -*Template for creating and integrating a new RFID Reader* - -> [!NOTE] -> For developers only - -This template provides the skeleton API for a new Reader. If you follow -the conventions outlined below, your new reader will be picked up -automatically There is no extra need to register the reader module with -the Phoniebox. Just re-run `the reader config tool `. - -Follow the instructions in [template_new_reader.py] - -Also have a look at the other reader subpackages to see how stuff works -with an example - -## File structure - -Your new reader is a python subpackage with these three mandatory files - -``` bash -components/rfid/hardware/awesome_reader/ - +- awesome_reader.py <-- The actual reader module - +- description.py <-- A description module w/o dependencies. Do not change the filename! - +- README.rst <-- The Readme -``` - -The module documentation must go into a separate file, called README.ME. - -## Conventions - -- Single reader per directory / subpackage -- reader module directory name and reader module file name must be - identical -- Obviously awesome_reader will be replaced with something more - descriptive. The naming scheme for the subpackage is - - \\_\\_\ - - e.g. generic_usb/generic_usb.py - - e.g. pn532_spi/pn532_spi.py - - ... +For documentation see [documentation/developers/rfid/template_reader.md](../../../../../../documentation/developers/rfid/template_reader.md). From c0d5a20f5bb521d09a0b0d910fc2b83dcca79e61 Mon Sep 17 00:00:00 2001 From: pabera <1260686+pabera@users.noreply.github.com> Date: Sat, 25 Nov 2023 23:48:28 +0100 Subject: [PATCH 5/5] future3 V3.3 - reference webapp build (#2126) --- installation/routines/setup_jukebox_webapp.sh | 2 +- src/jukebox/jukebox/version.py | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/installation/routines/setup_jukebox_webapp.sh b/installation/routines/setup_jukebox_webapp.sh index a0e195622..54be3119c 100644 --- a/installation/routines/setup_jukebox_webapp.sh +++ b/installation/routines/setup_jukebox_webapp.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # Constants -GD_ID_COMPILED_WEBAPP="1EE_1MdneGtKL5V7GyYZC0nb6ODQWTsPb" # https://drive.google.com/file/d/1EE_1MdneGtKL5V7GyYZC0nb6ODQWTsPb/view?usp=sharing +GD_ID_COMPILED_WEBAPP="1um-smyfsVPzVZn18hhwuFt97XR3PjAbB" # https://drive.google.com/file/d/1um-smyfsVPzVZn18hhwuFt97XR3PjAbB/view?usp=sharing # For ARMv7+ NODE_MAJOR=20 diff --git a/src/jukebox/jukebox/version.py b/src/jukebox/jukebox/version.py index ff86e01fc..de575e0b4 100644 --- a/src/jukebox/jukebox/version.py +++ b/src/jukebox/jukebox/version.py @@ -1,7 +1,7 @@ VERSION_MAJOR = 3 -VERSION_MINOR = 2 -VERSION_PATCH = 1 +VERSION_MINOR = 3 +VERSION_PATCH = 0 VERSION_EXTRA = "" __version__ = '%i.%i.%i' % (VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH)