diff --git a/documentation/builders/audio.md b/documentation/builders/audio.md index 2cf36dad9..0bb5a7163 100644 --- a/documentation/builders/audio.md +++ b/documentation/builders/audio.md @@ -10,14 +10,14 @@ Stream transfer happens on user input or automatically on the connection of an a This is mainly targeted at Bluetooth Headsets/Speakers. Audio outputs run via PulseAudio and the basic configuration should be easy. -There is a [configuration tool](../developers/coreapps.md#run_configure_audio.py), +There is a [configuration tool](../developers/coreapps.md#Audio), to setup the configuration for the Jukebox Core App. To set up the audio 1. Follow the setup steps according to your sound card 2. Check that the sound output works [as described below](audio.md#checking-system-sound-output) -3. Run the [audio configuration tool](../developers/coreapps.md#run_configure_audio.py) +3. Run the [audio configuration tool](../developers/coreapps.md#Audio) 4. [Fine-tune audio parameters](audio.md#additional-options) ## Checking system sound output @@ -134,4 +134,4 @@ You are, of course, free to modify the PulseAudio configuration to your needs. R 1. [PulseAudio Documentation](https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User) 2. [PulseAudio Examples](https://wiki.archlinux.org/title/PulseAudio/Examples) -In this case, run the [audio configuration tool](../developers/coreapps.md#run_configure_audio.py) with the parameter `--ro_pulse` to avoid touching the PulseAudio configuration file. +In this case, run the [audio configuration tool](../developers/coreapps.md#Audio) with the parameter `--ro_pulse` to avoid touching the PulseAudio configuration file. diff --git a/documentation/builders/concepts.md b/documentation/builders/concepts.md index a14592d75..37c13db89 100644 --- a/documentation/builders/concepts.md +++ b/documentation/builders/concepts.md @@ -16,10 +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). -We also have a [tool to send RPC commands](../developers/coreapps.md#run_rpc_tool.py) to the running Jukebox application. +We also have a [tool to send RPC commands](../developers/coreapps.md#RPC) to the running Jukebox application. ## 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](../developers/coreapps.md#run_publicity_sniffer.py) exists which listens and prints the incoming status messages. +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](../developers/coreapps.md#Publicity-Sniffer) exists which listens and prints the incoming status messages. diff --git a/documentation/builders/rpc-commands.md b/documentation/builders/rpc-commands.md index fa367f588..f98da8cb4 100644 --- a/documentation/builders/rpc-commands.md +++ b/documentation/builders/rpc-commands.md @@ -107,6 +107,6 @@ You will find some more examples the configuration of the [Card Database](card-d ## For developers -To send RPC commands for testing and debugging purpose you can use the [CLI Tool](../developers/coreapps.md#run_rpc_tool.py). +To send RPC commands for testing and debugging purpose you can use the [CLI Tool](../developers/coreapps.md#RPC). 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 9023a5e6f..35568e3eb 100644 --- a/documentation/developers/coreapps.md +++ b/documentation/developers/coreapps.md @@ -10,8 +10,6 @@ $ ./run_python.sh ./src/jukebox/ -h ## Jukebox Core -### `run_jukebox.py` - [run_jukebox.py](../../src/jukebox/run_jukebox.py) This is the main app and starts the Jukebox Core. @@ -26,9 +24,9 @@ For debugging, it is usually desirable to run the Jukebox directly from the cons Before running the configuration tools, stop the Jukebox Core service. See [Best practice procedure](../builders/configuration.md#best-practice-procedure). -### `run_configure_audio.py` +### Audio -[run_configure_audio.py](../../src/jukebox/run_configure_audio.py) +Scriptname: [run_configure_audio.py](../../src/jukebox/run_configure_audio.py) Setup tool to register the PulseAudio sinks as primary and secondary audio outputs. @@ -36,9 +34,9 @@ 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](../builders/audio.md). -### `run_register_rfid_reader.py` +### RFID Reader -[run_register_rfid_reader.py](../../src/jukebox/run_register_rfid_reader.py) +Scriptname: [run_register_rfid_reader.py](../../src/jukebox/run_register_rfid_reader.py) Setup tool to configure the RFID Readers. @@ -50,9 +48,9 @@ Run this once to register and configure the RFID readers with the Jukebox. Can b ## Developer Tools -### `run_rpc_tool.py` +### RPC -[run_rpc_tool.py](../../src/jukebox/run_rpc_tool.py) +Scriptname: [run_rpc_tool.py](../../src/jukebox/run_rpc_tool.py) Command Line Interface to the Jukebox RPC Server. @@ -62,9 +60,8 @@ The tool features auto-completion and command history. The list of available commands is fetched from the running Jukebox service. +### Publicity Sniffer -### `run_publicity_sniffer.py` - - [run_publicity_sniffer.py](../../src/jukebox/run_publicity_sniffer.py) +Scriptname: [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/rfid/basics.md b/documentation/developers/rfid/basics.md index 078340236..7d557ed06 100644 --- a/documentation/developers/rfid/basics.md +++ b/documentation/developers/rfid/basics.md @@ -35,7 +35,7 @@ Readers operate on one of two different frequencies: 125kHz or 13.56 MHz. Make s ## Reader Configuration During the installation process, you can already configure a RFID -reader. To manually configure RFID reader(s) run the [RFID reader configuration tool](../coreapps.md#run_register_rfid_reader.py). +reader. To manually configure RFID reader(s) run the [RFID reader configuration tool](../coreapps.md#RFID-Reader). It will generate a reader configuration file at `shared/settings/rfid.yaml`. You can re-run the tool to change the @@ -66,7 +66,7 @@ Indicates the Python package used for this reader. Filled by the RFID configurat #### config: -Filled by the [RFID reader configuration tool](../coreapps.md#run_register_rfid_reader.py) based on default values and user input. After running the tool, you may manually change some settings here, as not everything can be configured through the tool. Note that re-running the tool will completely rewrite the configuration file. +Filled by the [RFID reader configuration tool](../coreapps.md#RFID-Reader) based on default values and user input. After running the tool, you may manually change some settings here, as not everything can be configured through the tool. Note that re-running the tool will completely rewrite the configuration file. #### same_id_delay: float \| integer diff --git a/documentation/developers/rfid/genericusb.md b/documentation/developers/rfid/genericusb.md index 924550f8f..544f0245c 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 [RFID reader configuration tool](../coreapps.md#run_register_rfid_reader.py). +sure to connect all of them before running the [RFID reader configuration tool](../coreapps.md#RFID-Reader). > [!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/mfrc522_spi.md b/documentation/developers/rfid/mfrc522_spi.md index d8cb4fd26..5dc46aab6 100644 --- a/documentation/developers/rfid/mfrc522_spi.md +++ b/documentation/developers/rfid/mfrc522_spi.md @@ -6,7 +6,7 @@ RC522 RFID reader via SPI connection. ## Installation -Run the [RFID reader configuration tool](../coreapps.md#run_register_rfid_reader.py) for guided +Run the [RFID reader configuration tool](../coreapps.md#RFID-Reader) for guided installation. ## Options diff --git a/documentation/developers/rfid/template_reader.md b/documentation/developers/rfid/template_reader.md index 541b20a00..6a7a8b0c3 100644 --- a/documentation/developers/rfid/template_reader.md +++ b/documentation/developers/rfid/template_reader.md @@ -9,7 +9,7 @@ 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 [RFID reader configuration tool](../coreapps.md#run_register_rfid_reader.py). +the Phoniebox. Just re-run [RFID reader configuration tool](../coreapps.md#RFID-Reader). Follow the instructions in [template_new_reader.py](../../../src/jukebox/components/rfid/hardware/template_new_reader/template_new_reader.py)