ak-rpi

This is a repository for synchronizing Raspberry Pis with AccessKit.

• Github repository: https://github.com/access-kit/ak-rpi/
• Documentation https://access-kit.github.io/ak-rpi/ (coming soon...)

Getting Started: Linux/Raspberry Pi Mode

This instructions will handle automatically installing the required dependencies, configuring the connection to AccessKit, and setting up autostarting via systemd or running manually. They assume you have already setup your Raspberry Pi and connected it to the internet (either through Ethernet or WiFi).

1. Open a terminal and navigate to the directory where you want to clone the repository; the default home location is typically fine.
2. First, download the repository using git clone https://github.com/access-kit/ak-rpi.git which will clone the repository into a directory named ak-rpi.
3. Next, navigate into the ak-rpi directory using cd ak-rpi
4. Finally, run make setup, which will install the necessary dependencies and configure the connection to AccessKit, along with optional autostart via a systemd service.

Audio Configuration

The Raspberry Pi supports various audio output options, including:

• Built-in audio jack (on models that have it)
• HDMI audio output
• USB audio devices (e.g., USB sound cards, DACs)
• Bluetooth audio (requires additional configuration)

To configure your audio device:

1. Connect your audio device (if using USB or external device)
2. Configure your default audio device:

   make configure-audio

   This interactive script will:
   • Show available audio devices
   • Let you choose which card and device to use as default
   • Create either system-wide (/etc/asound.conf) or user-specific (~/.asoundrc) configuration
   • Automatically backup any existing configuration
   • Test the audio output
3. After configuration, you may need to reboot your Raspberry Pi for changes to take effect.

Common audio devices and their typical card numbers:

• Card 0: Usually the built-in audio (if present)
• Card 1: Often the first USB audio device
• Card 2+: Additional USB devices or HDMI outputs

Troubleshooting tips:

• If no sound is playing, check the volume levels using alsamixer
• For USB devices, try unplugging and reconnecting the device
• Some USB audio devices may need additional power; use a powered USB hub if necessary
• If using HDMI audio, ensure it's enabled in /boot/config.txt

Getting Started: Desktop/User Mode

1. Make sure your system has poetry installed and can run Makefiles.
2. Add a config.json file to the root directory with the syncUrl and password fields completed.
3. Add an audio file (.wav or .mp3) to the media/ directory.
4. Execute make install-and-run.

Getting Started: Dev Mode

make install