From 041188d42d4aed23c1cc95f3175d0d7009e1c7b6 Mon Sep 17 00:00:00 2001 From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com> Date: Wed, 17 Jan 2024 00:31:03 +0100 Subject: [PATCH 01/15] minor fixes --- documentation/README.md | 3 ++- documentation/builders/installation.md | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/documentation/README.md b/documentation/README.md index b10941a55..a659a261e 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -42,7 +42,8 @@ project check out the [documentation of Version 2](https://github.com/MiczFlor/R Version 3 has reached a mature state and will soon be the default version. However, some features may still be missing. Please check the [Feature Status](./developers/status.md), if YOUR feature is already implemented. -> ![NOTE] If version 3 has all the features you need, we recommend using Version 3. +> ![NOTE] +> If version 3 has all the features you need, we recommend using Version 3. If there is a feature missing, please open an issue. diff --git a/documentation/builders/installation.md b/documentation/builders/installation.md index 7ce0e59c0..7dcca24b4 100644 --- a/documentation/builders/installation.md +++ b/documentation/builders/installation.md @@ -26,12 +26,12 @@ Before you can install the Phoniebox software, you need to prepare your Raspberr 8. Confirm the next warning about erasing the SD card with `Yes` 9. Wait for the imaging process to be finished (it'll take a few minutes) + +### Pre-boot preparation
In case you forgot to customize the OS settings, follow these instructions after RPi OS has been written to the SD card. -### Pre-boot preparation - You will need a terminal, like PuTTY for Windows or the Terminal app for Mac to proceed with the next steps. 1. Open a terminal of your choice. From 1849ed0746ce4ca4cf2db2e02b9a750b6e3a96ab Mon Sep 17 00:00:00 2001 From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com> Date: Wed, 17 Jan 2024 00:32:45 +0100 Subject: [PATCH 02/15] add "Pre-install preparation / workarounds" section add "Workaround for network related features on bookworm" --- documentation/builders/installation.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/documentation/builders/installation.md b/documentation/builders/installation.md index 7dcca24b4..da5801185 100644 --- a/documentation/builders/installation.md +++ b/documentation/builders/installation.md @@ -77,6 +77,30 @@ You will need a terminal, like PuTTY for Windows or the Terminal app for Mac to
+### Pre-install preparation / workarounds + +#### Workaround for network related features on Bookworm +
+With Bookworm the network settings have changed. Now "NetworkManager" is used instead of "dhcpcd". +This breaks breaks network related features like "Static IP", "Wifi Setup" and "Autohotspot". +Before running the installation, the network config has to be changed via raspi-config, to use the "old" dhcpcd network settings. + +> [!IMPORTANT] +> If the settings are changed, your network will reset and Wifi will not be configured, so you lose ssh access via wireless network. +> So make sure you perform the following steps in a local terminal with a connected monitor and keyboard. + +Change network config +* run `sudo raspi-config` +* select `6 - Advanced Options` +* select `AA - Network Config` +* select `dhcpcd` + +If you need Wifi, add the information now +* select `1 - System Options` +* select `1 - Wireless LAN` +* enter Wifi information +
+ ## Install Phoniebox software Choose a version, run the corresponding install command in your SSH terminal and follow the instructions. From 4ec0e66bb26c6c69edee89c09a304deb3b777c0a Mon Sep 17 00:00:00 2001 From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com> Date: Wed, 17 Jan 2024 00:39:35 +0100 Subject: [PATCH 03/15] add "Workaround for 64-bit Kernels" harmonize and update description / message --- documentation/builders/installation.md | 11 ++++++++++- installation/install-jukebox.sh | 10 +++++----- 2 files changed, 15 insertions(+), 6 deletions(-) diff --git a/documentation/builders/installation.md b/documentation/builders/installation.md index da5801185..70972296b 100644 --- a/documentation/builders/installation.md +++ b/documentation/builders/installation.md @@ -10,7 +10,7 @@ Before you can install the Phoniebox software, you need to prepare your Raspberr 1. Connect a Micro SD card to your computer (preferable an SD card with high read throughput) 2. Download the [Raspberry Pi Imager](https://www.raspberrypi.com/software/) and run it 3. Click on "Raspberry Pi Device" and select "No filtering" -4. Select **Raspberry Pi OS Lite (32-bit)** (without desktop environment) as the operating system. `future3` does not support 64bit kernels (`aarch64`). +4. Select **Raspberry Pi OS Lite (32-bit)** (without desktop environment) as the operating system. *64-bit is currently not supported.* For Pi 4 and newer also check [this](#workaround-for-64-bit-kernels-pi-4-and-newer). 5. Select your Micro SD card (your card will be formatted) 6. After you click `Next`, a prompt will ask you if you like to customize the OS settings * Click `Edit Settings` @@ -101,6 +101,15 @@ If you need Wifi, add the information now * enter Wifi information +#### Workaround for 64-bit Kernels (Pi 4 and newer) +
+ +The installation process checks if a 32-bit OS is running, as 64-bit is currently not supported. +This check also fails if the kernel is running in 64-bit mode. This is the default for Raspberry Pi models 4 and newer. + +To be able to run the installation, you have to switch to the 32-bit mode by modifying the `config.txt` ([check for the correct location as it has changed since bookworm](https://www.raspberrypi.com/documentation/computers/config_txt.html)) and add/change the line `arm_64bit=0`. Reboot before you proceed. +
+ ## Install Phoniebox software Choose a version, run the corresponding install command in your SSH terminal and follow the instructions. diff --git a/installation/install-jukebox.sh b/installation/install-jukebox.sh index 2df7ab528..77745ea85 100755 --- a/installation/install-jukebox.sh +++ b/installation/install-jukebox.sh @@ -86,9 +86,9 @@ Check install log for details:" exit 1 } -# Check if current distro is a 32 bit version -# Support for 64 bit Distros has not been checked (or precisely: is known not to work) -# All RaspianOS versions report as machine "armv6l" or "armv7l", if 32 bit (even the ARMv8 cores!) +# Check if current distro is a 32-bit version +# Support for 64-bit Distros has not been checked (or precisely: is known not to work) +# All RaspianOS versions report as machine "armv6l" or "armv7l", if 32-bit (even the ARMv8 cores!) _check_os_type() { local os_type=$(uname -m) @@ -97,8 +97,8 @@ _check_os_type() { if [[ $os_type == "armv7l" || $os_type == "armv6l" ]]; then print_lc " ... OK!\n" else - print_lc "ERROR: Only 32 bit operating systems supported. Please use a 32bit version of RaspianOS!" - print_lc "You can fix this problem for 64bit kernels: https://github.com/MiczFlor/RPi-Jukebox-RFID/issues/2041" + print_lc "ERROR: Only 32-bit operating systems are supported. Please use a 32-bit version of RaspianOS!" + print_lc "For Pi 4 models or newer running a 64-bit kernels, also see this: https://github.com/MiczFlor/RPi-Jukebox-RFID/issues/2041" exit 1 fi } From 3f71c474f51b220e0f27f2577b472e53a629426a Mon Sep 17 00:00:00 2001 From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com> Date: Wed, 17 Jan 2024 00:45:28 +0100 Subject: [PATCH 04/15] minor fix --- documentation/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/README.md b/documentation/README.md index a659a261e..bb11dd6f4 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -42,7 +42,7 @@ project check out the [documentation of Version 2](https://github.com/MiczFlor/R Version 3 has reached a mature state and will soon be the default version. However, some features may still be missing. Please check the [Feature Status](./developers/status.md), if YOUR feature is already implemented. -> ![NOTE] +> [!NOTE] > If version 3 has all the features you need, we recommend using Version 3. If there is a feature missing, please open an issue. From d1800b5adf73c4f264f6ba8a9b7c1c6684e019f0 Mon Sep 17 00:00:00 2001 From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com> Date: Wed, 17 Jan 2024 00:58:20 +0100 Subject: [PATCH 05/15] Update warning block as alerts are not supported inside of "details" --- documentation/builders/installation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/builders/installation.md b/documentation/builders/installation.md index 70972296b..cbf970cf5 100644 --- a/documentation/builders/installation.md +++ b/documentation/builders/installation.md @@ -85,9 +85,9 @@ With Bookworm the network settings have changed. Now "NetworkManager" is used in This breaks breaks network related features like "Static IP", "Wifi Setup" and "Autohotspot". Before running the installation, the network config has to be changed via raspi-config, to use the "old" dhcpcd network settings. -> [!IMPORTANT] -> If the settings are changed, your network will reset and Wifi will not be configured, so you lose ssh access via wireless network. -> So make sure you perform the following steps in a local terminal with a connected monitor and keyboard. +:warning: +If the settings are changed, your network will reset and Wifi will not be configured, so you lose ssh access via wireless network. +So make sure you perform the following steps in a local terminal with a connected monitor and keyboard. Change network config * run `sudo raspi-config` From 30713b4f3a17ae8f0de98cfdcabbee3dedf7a250 Mon Sep 17 00:00:00 2001 From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com> Date: Wed, 17 Jan 2024 01:00:03 +0100 Subject: [PATCH 06/15] minor fix --- documentation/builders/installation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/builders/installation.md b/documentation/builders/installation.md index cbf970cf5..62c7f2630 100644 --- a/documentation/builders/installation.md +++ b/documentation/builders/installation.md @@ -86,8 +86,8 @@ This breaks breaks network related features like "Static IP", "Wifi Setup" and " Before running the installation, the network config has to be changed via raspi-config, to use the "old" dhcpcd network settings. :warning: -If the settings are changed, your network will reset and Wifi will not be configured, so you lose ssh access via wireless network. -So make sure you perform the following steps in a local terminal with a connected monitor and keyboard. +If the settings are changed, your network will reset and Wifi will not be configured, so you lose ssh access via wireless connection. +So make sure you use a wired connection or perform the following steps in a local terminal with a connected monitor and keyboard. Change network config * run `sudo raspi-config` From dcd33aea3644a75c5eb4d9d43db2c80564f3f89a Mon Sep 17 00:00:00 2001 From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com> Date: Wed, 17 Jan 2024 01:14:25 +0100 Subject: [PATCH 07/15] fix Raspberry Pi OS name Co-authored-by: s-martin --- installation/install-jukebox.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/installation/install-jukebox.sh b/installation/install-jukebox.sh index 77745ea85..1ec3f9ad5 100755 --- a/installation/install-jukebox.sh +++ b/installation/install-jukebox.sh @@ -88,7 +88,7 @@ Check install log for details:" # Check if current distro is a 32-bit version # Support for 64-bit Distros has not been checked (or precisely: is known not to work) -# All RaspianOS versions report as machine "armv6l" or "armv7l", if 32-bit (even the ARMv8 cores!) +# All Raspberry Pi OS versions report as machine "armv6l" or "armv7l", if 32-bit (even the ARMv8 cores!) _check_os_type() { local os_type=$(uname -m) @@ -97,7 +97,7 @@ _check_os_type() { if [[ $os_type == "armv7l" || $os_type == "armv6l" ]]; then print_lc " ... OK!\n" else - print_lc "ERROR: Only 32-bit operating systems are supported. Please use a 32-bit version of RaspianOS!" + print_lc "ERROR: Only 32-bit operating systems are supported. Please use a 32-bit version of Raspberry Pi OS!" print_lc "For Pi 4 models or newer running a 64-bit kernels, also see this: https://github.com/MiczFlor/RPi-Jukebox-RFID/issues/2041" exit 1 fi From da0e7c74a592a657ef29f7695a3cdf034b2e33df Mon Sep 17 00:00:00 2001 From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com> Date: Wed, 17 Jan 2024 01:21:54 +0100 Subject: [PATCH 08/15] fix Raspberry Pi OS name --- documentation/builders/update.md | 2 +- documentation/developers/docstring/README.md | 2 +- .../components/rfid/hardware/fake_reader_gui/requirements.txt | 2 +- src/jukebox/components/volume/__init__.py | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/documentation/builders/update.md b/documentation/builders/update.md index 94baf0a93..b2b6f077c 100644 --- a/documentation/builders/update.md +++ b/documentation/builders/update.md @@ -35,7 +35,7 @@ $ ./run_rebuild.sh -u ## Migration Path from Version 2 There is no update path coming from Version 2.x of the Jukebox. -You need to do a fresh install of Version 3 on a fresh Raspian Bullseye image. +You need to do a fresh install of Version 3 on a fresh Raspberry Pi OS image. > [!IMPORTANT] > Do start with a fresh SD card image! diff --git a/documentation/developers/docstring/README.md b/documentation/developers/docstring/README.md index dde85b224..aa7cefecc 100644 --- a/documentation/developers/docstring/README.md +++ b/documentation/developers/docstring/README.md @@ -1245,7 +1245,7 @@ This means must also run as user process, as described in ## Misc PulseAudio may switch the sink automatically to a connecting bluetooth device depending on the loaded module -with name module-switch-on-connect. On RaspianOS Bullseye, this module is not part of the default configuration +with name module-switch-on-connect. On Raspberry Pi OS Bullseye, this module is not part of the default configuration in ``/usr/pulse/default.pa``. So, we don't need to worry about it. If the module gets loaded it conflicts with the toggle on connect and the selected primary / secondary outputs from the Jukebox. Remove it from the configuration! diff --git a/src/jukebox/components/rfid/hardware/fake_reader_gui/requirements.txt b/src/jukebox/components/rfid/hardware/fake_reader_gui/requirements.txt index 937256e86..b539a2478 100644 --- a/src/jukebox/components/rfid/hardware/fake_reader_gui/requirements.txt +++ b/src/jukebox/components/rfid/hardware/fake_reader_gui/requirements.txt @@ -1,6 +1,6 @@ # This GUI-based mock reader also requires: tkinter # tkinter is a standard Python package and needs not be installed separately -# It is available on most Unix systems (but not on headless Raspbian RPi where running a GUI is difficult anyway) +# It is available on most Unix systems (but not on headless Raspberry Pi OS where running a GUI is difficult anyway) # You need to install these with `python -m pip install --upgrade --force-reinstall -q -r requirements.txt` ttkthemes diff --git a/src/jukebox/components/volume/__init__.py b/src/jukebox/components/volume/__init__.py index ccc4873d7..4782581ca 100644 --- a/src/jukebox/components/volume/__init__.py +++ b/src/jukebox/components/volume/__init__.py @@ -33,7 +33,7 @@ ## Misc PulseAudio may switch the sink automatically to a connecting bluetooth device depending on the loaded module -with name module-switch-on-connect. On RaspianOS Bullseye, this module is not part of the default configuration +with name module-switch-on-connect. On Raspberry Pi OS Bullseye, this module is not part of the default configuration in ``/usr/pulse/default.pa``. So, we don't need to worry about it. If the module gets loaded it conflicts with the toggle on connect and the selected primary / secondary outputs from the Jukebox. Remove it from the configuration! @@ -635,7 +635,7 @@ def finalize(): global pulse_control # Set default output and start-up volume # Note: PulseAudio may switch the sink automatically to a connecting bluetooth device depending on the loaded module - # with name module-switch-on-connect. On RaspianOS Bullseye, this module is not part of the default configuration. + # with name module-switch-on-connect. On Raspberry Pi OS Bullseye, this module is not part of the default configuration. # So, we shouldn't need to worry about it. Still, set output and startup volume close to each other # to minimize bluetooth connection in between global pulse_control From ce9930f97933ca93b07d77b451cbb408c5ff36c0 Mon Sep 17 00:00:00 2001 From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com> Date: Wed, 17 Jan 2024 01:23:08 +0100 Subject: [PATCH 09/15] fix typo --- installation/includes/02_helpers.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/installation/includes/02_helpers.sh b/installation/includes/02_helpers.sh index f2b60313b..9cd51c824 100644 --- a/installation/includes/02_helpers.sh +++ b/installation/includes/02_helpers.sh @@ -75,7 +75,7 @@ get_architecture() { echo $arch } -is_raspian() { +is_raspbian() { if [[ $( . /etc/os-release; printf '%s\n' "$ID"; ) == *"raspbian"* ]]; then echo true else @@ -89,7 +89,7 @@ get_debian_version_number() { } get_boot_config_path() { - if [ "$(is_raspian)" = true ]; then + if [ "$(is_raspbian)" = true ]; then local debian_version_number=$(get_debian_version_number) # Bullseye and lower From b933f1744130c860b2228f1045594f4823eb8d16 Mon Sep 17 00:00:00 2001 From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com> Date: Wed, 17 Jan 2024 14:31:50 +0100 Subject: [PATCH 10/15] added link to installation --- documentation/builders/update.md | 1 + 1 file changed, 1 insertion(+) diff --git a/documentation/builders/update.md b/documentation/builders/update.md index b2b6f077c..e84655e7c 100644 --- a/documentation/builders/update.md +++ b/documentation/builders/update.md @@ -36,6 +36,7 @@ $ ./run_rebuild.sh -u There is no update path coming from Version 2.x of the Jukebox. You need to do a fresh install of Version 3 on a fresh Raspberry Pi OS image. +See [Installing Phoniebox future3](./installation.md). > [!IMPORTANT] > Do start with a fresh SD card image! From c60d43909b5d6a19bd025e22e5b8bc27e3a4f563 Mon Sep 17 00:00:00 2001 From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com> Date: Wed, 17 Jan 2024 14:32:07 +0100 Subject: [PATCH 11/15] updates from reviews --- documentation/builders/installation.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/documentation/builders/installation.md b/documentation/builders/installation.md index 62c7f2630..1d4b18470 100644 --- a/documentation/builders/installation.md +++ b/documentation/builders/installation.md @@ -10,7 +10,9 @@ Before you can install the Phoniebox software, you need to prepare your Raspberr 1. Connect a Micro SD card to your computer (preferable an SD card with high read throughput) 2. Download the [Raspberry Pi Imager](https://www.raspberrypi.com/software/) and run it 3. Click on "Raspberry Pi Device" and select "No filtering" -4. Select **Raspberry Pi OS Lite (32-bit)** (without desktop environment) as the operating system. *64-bit is currently not supported.* For Pi 4 and newer also check [this](#workaround-for-64-bit-kernels-pi-4-and-newer). +4. As operating system select **Raspberry Pi OS (other)** and then **Raspberry Pi OS Lite (Legacy, 32-bit)** (no desktop environment). *64-bit is currently not supported*. + * Bookworm support is partly broken, see [here](#workaround-for-network-related-features-on-bookworm). + * For Pi 4 and newer also check [this](#workaround-for-64-bit-kernels-pi-4-and-newer). 5. Select your Micro SD card (your card will be formatted) 6. After you click `Next`, a prompt will ask you if you like to customize the OS settings * Click `Edit Settings` @@ -107,7 +109,10 @@ If you need Wifi, add the information now The installation process checks if a 32-bit OS is running, as 64-bit is currently not supported. This check also fails if the kernel is running in 64-bit mode. This is the default for Raspberry Pi models 4 and newer. -To be able to run the installation, you have to switch to the 32-bit mode by modifying the `config.txt` ([check for the correct location as it has changed since bookworm](https://www.raspberrypi.com/documentation/computers/config_txt.html)) and add/change the line `arm_64bit=0`. Reboot before you proceed. +To be able to run the installation, you have to switch to the 32-bit mode by modifying the `config.txt` and add/change the line `arm_64bit=0`. +Up to Bullseye, the `config.txt` file is located at `/boot/`. Since Bookworm, the location changed to `/boot/firmware/` ([see here](https://www.raspberrypi.com/documentation/computers/config_txt.html)). + +Reboot before you proceed. ## Install Phoniebox software From ff8fb3d967dc95444ffce4e57c3126722741915c Mon Sep 17 00:00:00 2001 From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com> Date: Tue, 23 Jan 2024 13:35:25 +0100 Subject: [PATCH 12/15] fix file for synchronisation doc. moved to components --- documentation/builders/README.md | 3 ++- .../synchronisation/rfidcards.md} | 10 ++++------ 2 files changed, 6 insertions(+), 7 deletions(-) rename documentation/builders/{rfid.md => components/synchronisation/rfidcards.md} (97%) diff --git a/documentation/builders/README.md b/documentation/builders/README.md index 8ea5e0648..5f972d27e 100644 --- a/documentation/builders/README.md +++ b/documentation/builders/README.md @@ -9,7 +9,6 @@ ## Configuration * [Audio](./audio.md) -* [RFID](./rfid.md) * [GPIO Recipes](./gpio.md) * [Card Database](./card-database.md) * [Troubleshooting](./troubleshooting.md) @@ -19,6 +18,8 @@ * [OnOff SHIM for safe power on/off](./components/power/onoff-shim.md) * [Soundcards](./components/soundcards/) * [HiFiBerry Boards](./components/soundcards/hifiberry.md) +* [Synchronisation](./components/synchronisation/) + * [RFID Cards](./components/synchronisation/rfidcards.md) ## Advanced diff --git a/documentation/builders/rfid.md b/documentation/builders/components/synchronisation/rfidcards.md similarity index 97% rename from documentation/builders/rfid.md rename to documentation/builders/components/synchronisation/rfidcards.md index f8826f68f..b9912f6bb 100644 --- a/documentation/builders/rfid.md +++ b/documentation/builders/components/synchronisation/rfidcards.md @@ -1,6 +1,4 @@ -# RFID - -## Syncronisation RFID Cards +# Syncronisation RFID Cards This component handles the synchronisation of RFID cards (audiofolder and card database entries). @@ -15,7 +13,7 @@ RFID card to the command. For the \"RFID scan sync\" feature, activate the option in the configuration or bind a RFID card to the command for dynamic activation or deactivation. -### Synchronisation +## Synchronisation The synchronisation will be FROM a server TO the Phoniebox, overriding existing files. A local configuration will be lost after the @@ -26,7 +24,7 @@ To access the files on the server, 2 modes are supported: SSH or MOUNT. Please make sure you have the correct access rights to the source and use key-based authentication for SSH. -#### RFID scan sync +### RFID scan sync If the feature \"RFID scan sync\" is activated, there will be a check on every RFID scan against the server if a matching card entry and audiofolder is available. If so, changes will be synced. The playback @@ -40,7 +38,7 @@ deleted on remote. This is also true for changed card entries (the old audiofolder / -files will remain). To remove not existing items us a \"sync-all\". -### Configuration +## Configuration Set the corresponding setting in `shared\settings\jukebox.yaml` to activate this feature. From 22731c68f1a8a10219edf65106532c86649014ea Mon Sep 17 00:00:00 2001 From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com> Date: Tue, 23 Jan 2024 14:12:42 +0100 Subject: [PATCH 13/15] add docs for samba --- documentation/builders/README.md | 1 + documentation/builders/samba.md | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+) create mode 100644 documentation/builders/samba.md diff --git a/documentation/builders/README.md b/documentation/builders/README.md index 5f972d27e..b45c25876 100644 --- a/documentation/builders/README.md +++ b/documentation/builders/README.md @@ -25,6 +25,7 @@ * [Bluetooth (and audio buttons)](./bluetooth-audio-buttons.md) * [Auto Hotspot](./autohotspot.md) +* [Samba](./samba.md) * [Concepts](./concepts.md) * [System](./system.md) * [RPC Commands](./rpc-commands.md) diff --git a/documentation/builders/samba.md b/documentation/builders/samba.md new file mode 100644 index 000000000..a258566df --- /dev/null +++ b/documentation/builders/samba.md @@ -0,0 +1,18 @@ +# Samba + +To conveniently copy files to your Phoniebox via network `samba` can be setup during the installation process. The folder `./shared/` will be exposed as network share `phoniebox`, giving you access to the audio and config folders. + +## Connect + +To access the share open your OS network environment and select your Phoniebox device. +Alternatively directly access it via url with the file explorer (e.g. Windows `\\`, MacOS `smb://`). + +See also +* [MacOS](https://support.apple.com/lt-lt/guide/mac-help/mchlp1140/mac) + +## Credentials + +As login credentials use the same username you used to run the installation with. The password is `raspberry`. +You can change the password anytime using the command `sudo smbpasswd -a ""`. + + From 4f2605e67a97b5c0072fd26056527037b28d182c Mon Sep 17 00:00:00 2001 From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com> Date: Wed, 24 Jan 2024 08:56:07 +0100 Subject: [PATCH 14/15] Apply suggestions from code review Co-authored-by: s-martin --- .../builders/components/synchronisation/rfidcards.md | 2 +- documentation/builders/samba.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/builders/components/synchronisation/rfidcards.md b/documentation/builders/components/synchronisation/rfidcards.md index b9912f6bb..a4c974b4b 100644 --- a/documentation/builders/components/synchronisation/rfidcards.md +++ b/documentation/builders/components/synchronisation/rfidcards.md @@ -1,4 +1,4 @@ -# Syncronisation RFID Cards +# Synchronisation RFID Cards This component handles the synchronisation of RFID cards (audiofolder and card database entries). diff --git a/documentation/builders/samba.md b/documentation/builders/samba.md index a258566df..ac9a93bbc 100644 --- a/documentation/builders/samba.md +++ b/documentation/builders/samba.md @@ -1,6 +1,6 @@ # Samba -To conveniently copy files to your Phoniebox via network `samba` can be setup during the installation process. The folder `./shared/` will be exposed as network share `phoniebox`, giving you access to the audio and config folders. +To conveniently copy files to your Phoniebox via network `samba` can be configured during the installation. The folder `./shared/` will be exposed as network share `phoniebox`, giving you access to the audio and config folders. ## Connect @@ -10,7 +10,7 @@ Alternatively directly access it via url with the file explorer (e.g. Windows `\ See also * [MacOS](https://support.apple.com/lt-lt/guide/mac-help/mchlp1140/mac) -## Credentials +## User name / Password As login credentials use the same username you used to run the installation with. The password is `raspberry`. You can change the password anytime using the command `sudo smbpasswd -a ""`. From 1b39e9f0ddd342b48c7df4740f02bdcf39db4a44 Mon Sep 17 00:00:00 2001 From: Alvin Schiller <103769832+AlvinSchiller@users.noreply.github.com> Date: Wed, 24 Jan 2024 11:22:39 +0100 Subject: [PATCH 15/15] restructure builders readme --- documentation/builders/README.md | 24 +++++++++++++----------- documentation/builders/configuration.md | 6 +----- documentation/developers/README.md | 2 +- 3 files changed, 15 insertions(+), 17 deletions(-) diff --git a/documentation/builders/README.md b/documentation/builders/README.md index b45c25876..5909596aa 100644 --- a/documentation/builders/README.md +++ b/documentation/builders/README.md @@ -6,26 +6,28 @@ * [Update](./update.md) * [Configuring Phoniebox](./configuration.md) -## Configuration +## Features -* [Audio](./audio.md) +* Audio + * [Audio Output](./audio.md) + * [Bluetooth audio buttons](./bluetooth-audio-buttons.md) * [GPIO Recipes](./gpio.md) * [Card Database](./card-database.md) -* [Troubleshooting](./troubleshooting.md) + * [RFID Cards synchronisation](./components/synchronisation/rfidcards.md) +* [Auto Hotspot](./autohotspot.md) +* File Management + * [Network share / Samba](./samba.md) + +## Hardware Components -## Components * [Power](./components/power/) * [OnOff SHIM for safe power on/off](./components/power/onoff-shim.md) * [Soundcards](./components/soundcards/) * [HiFiBerry Boards](./components/soundcards/hifiberry.md) -* [Synchronisation](./components/synchronisation/) - * [RFID Cards](./components/synchronisation/rfidcards.md) - +* [RFID Readers](./../developers/rfid/README.md) + ## Advanced - -* [Bluetooth (and audio buttons)](./bluetooth-audio-buttons.md) -* [Auto Hotspot](./autohotspot.md) -* [Samba](./samba.md) +* [Troubleshooting](./troubleshooting.md) * [Concepts](./concepts.md) * [System](./system.md) * [RPC Commands](./rpc-commands.md) diff --git a/documentation/builders/configuration.md b/documentation/builders/configuration.md index dba2da7dc..2e1c4ff23 100644 --- a/documentation/builders/configuration.md +++ b/documentation/builders/configuration.md @@ -7,11 +7,7 @@ The majority of configuration options is only available by editing the config fi *when the service is not running!* Don't fear (overly), they contain commentaries. -For several aspects we have [configuration tools](../developers/coreapps.md#configuration-tools) and detailed guides: - -* [Audio Configuration](./audio.md#audio-configuration) -* [RFID Reader Configuration](../developers/rfid/basics.md#reader-configuration) -* [GPIO Recipes](./gpio.md) +For several aspects we have [configuration tools](../developers/coreapps.md#configuration-tools) and [detailed guides](./README.md#features). Even after running the tools, certain aspects can only be changed by modifying the configuration files directly. diff --git a/documentation/developers/README.md b/documentation/developers/README.md index f6ec65dc4..5598f34d7 100644 --- a/documentation/developers/README.md +++ b/documentation/developers/README.md @@ -9,7 +9,7 @@ * [Jukebox Apps](./coreapps.md) * [Web App](./webapp.md) -* [RFID Readers](./rfid) +* [RFID Readers](./rfid/README.md) * [Docstring API Docs (from py files)](./docstring/README.md) * [Plugin Reference](./docstring/README.md#jukeboxplugs) * [Feature Status](./status.md)