Skip to content

Commit

Permalink
updated coreapps doc and references
Browse files Browse the repository at this point in the history
  • Loading branch information
AlvinSchiller committed Dec 10, 2023
1 parent 8ff4d76 commit b0093fc
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 22 deletions.
6 changes: 3 additions & 3 deletions documentation/builders/audio.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
4 changes: 2 additions & 2 deletions documentation/builders/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion documentation/builders/rpc-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
19 changes: 8 additions & 11 deletions documentation/developers/coreapps.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ $ ./run_python.sh ./src/jukebox/<app_scriptname.py> -h

## Jukebox Core

### `run_jukebox.py`

[run_jukebox.py](../../src/jukebox/run_jukebox.py)

This is the main app and starts the Jukebox Core.
Expand All @@ -26,19 +24,19 @@ 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.

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.

Expand All @@ -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.

Expand All @@ -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.
4 changes: 2 additions & 2 deletions documentation/developers/rfid/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion documentation/developers/rfid/genericusb.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion documentation/developers/rfid/mfrc522_spi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion documentation/developers/rfid/template_reader.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down

0 comments on commit b0093fc

Please sign in to comment.