Skip to content

Latest commit

 

History

History
302 lines (233 loc) · 12.6 KB

setup_guide.md

File metadata and controls

302 lines (233 loc) · 12.6 KB

Setup Guide

(C) Tim Curtis 2024
(C) @azimuth 2024 Pi Imager tutorial

Table of Contents

1. Introduction

Moode audio player is a Free Open Source Software (FOSS) music streamer for the wonderful Raspberry Pi family of Single Board Computers (SBC). To access the player enter http://moode, moode.local or ip_address in a Web Browser. If you are using a Smartphone use the "Save to Home Screen" option on IOS or Android to create a moOde App.

Quick help contains instructions for navigating Moode and using its features including Multiroom audio. Quick help is located on the Main Menu which is accessed via the m in the upper right of the WebUI.

2. Creating a boot SD Card

Before you can access Moode a pre-built image must be configured and written to a micro SD Card using the official Raspberry Pi Imager.

IMPORTANT! The image must be configured with a userid, password and SSH enabled or Moode will not function correctly. Refer to the Pi Imager Tutorial section for step by step instructions.

Download links for the Pi Imager and Moode pre-built images are available on the Download page at moodeaudio.org Pre-built images can also be conveniently selected directly in the Media Player OS section of the Imager.

3. Starting up the system

The first startup will take a while. The system automatically reboots 3 times after initially starting to import and apply the settings from the Pi Imager and complete Moode startup configuration.

4. After Startup

After Moode starts up and you access it in your Web Browser you can configure your audio device, add music files to create your Library, connect an HDMI display and make use of all the advanced, Audiophile-grade features to create a great listening experience.

Back to Top

4.1. Audio Devices

USB audio device

  • Plug in the device
  • Menu > Configure > Audio
  • Set Output device to the name of the USB audio device

I2S audio device

  • Power down the Pi and attach the device to the 40-pin header
  • Power up the Pi
  • Menu > Configure > Audio
  • Set Named I2S device or DT overlay to the correct device or overlay name
  • Restart the Pi
  • Menu > Configure > Audio
  • Set Output device to the name of the I2S audio device

Audio device options

There are many other audio device options available for example Volume type, Chip options, and ALSA output mode just to name a few. For more information on a given option read the help text underneath it or the expandable info help next to it.

4.2. Music Files

USB storage device

  • Plug in the device
  • Menu > Update library
  • Stay on the screen and wait for the activity spinner to be cleared

Boot SD Card storage

  • Place your music files under the directory /mnt/SDCARD
  • Menu > Update library
  • Stay on the screen and wait for the activity spinner to be cleared

Network Attached Storage (NAS) Device

  • Menu > Configure > Library
  • Click CREATE music source
  • Enter the Type, Path and credentials that provides access to your NAS
  • Click SAVE
  • A green checkmark will appear if the NAS was successfully mounted
  • Click the Arrow or Home icon in the upper left of the screen to return to Playback view
  • Menu > Update library
  • Stay on the screen and wait for the activity spinner to be cleared

4.3. Hotspot

Moode provides a WiFi Hotspot on the 2.4 GHz WiFi band. Note that since the image does not contain any default passwords the Hotspot password can only be set via the Network Config screen in the WebUI thus the Pi must first be connected via WiFi or Ethernet. Refer to the default settings below.

Setting Value
SSID Moode
Password As set in the Network Config screen
URL http://moode.local or http://172.24.1.1

The Hotspot starts when one of the following are true.

  • WiFi SSID is set to "Activate Hotspot" in Network Config.
  • WiFi SSID is configured in Network Config but no IP address was assigned after attempting to connect to the configured SSID or any saved SSID's.

4.4. File Sharing

Moode can be used as a File Server by turning on one or more of the file sharing protocols listed below. These protocols and their respective options are in the File Sharing section of System Config.

  • SMB File Sharing. SMB (Samba) shares named NAS, Playlists, and SDCard are automatically created. Each USB disk will also have a Samba share created that is named after its Disk Label.

  • NFS File Sharing. Access and option defaults are provided but can be manually overridden. Each USB disk will have an NFS export created whose path is /media/Disk Label.

  • DLNA File Sharing. The DLNA media server indexes music sources defined for MPD and makes them available to a UPnP control point.

4.5. Software Updates

Updates to Moode are available via CHECK for software update in System Config. The updates are keyed to a major release series for example Moode 9. There are no in-place updates across major releases for example Moode 8 to Moode 9. Each new major release requires a fresh image.

Back to Top

5. Pi Imager Tutorial

Moode requires using the official Raspberry Pi Imager to configure the OS image before writing it to an SD Card. Follow these step by step instructions to carry out this process.

IMPORTANT! The image must be configured with a userid, password and SSH enabled or Moode will not function correctly.

  1. Download the official Raspberry Pi Imager.
  1. Click CHOOSE OS and scroll down to Media Player OS and then to moOde audio player and then click the version of moOde you would like to install.

Or if you have downloaded moOde directly from the Download page at moodeaudio.org, then scroll down to Use custom and select the downloaded zip file from the file chooser.

  1. After the OS is selected click CHOOSE STORAGE then click the SD card drive where the OS image will be written.
  1. Click NEXT to display the OS customization screen
  1. Click EDIT SETTINGS to display the OS customization screen. On the GENERAL tab enter your desired hostname, userid and password, optional WiFi SSID and password and finally the Locale.
  1. Click the SERVICES tab and enable SSH with password authentication.
  1. Click SAVE which will return you to the OS Customization screen.
  1. Click YES to apply the customizations and display the confirmation screen.
  1. Click YES to proceed and write the OS image to the SD Card and automatically verify it after the write completes.
  1. After verification is complete the SD Card can be removed from the drive and inserted into a Raspberry Pi for initial startup.

Back to Top

6. Advanced

6.1. REST API

The base URL for submitting commands to Moode is http://moode/command/?cmd= If a command returns data it is in JSON format following REST guidelines.

get_currentsong

Gets the contents of the file /var/local/www/currentsong.txt. Turn on the Metadata file in the MPD options section in Audio Config to generate this file.
Returns: contents of metadata file

JSON:
{"file":"NAS\/TRX-FLAC\/Yes\/The Yes Album\/06 Perpetual Change.flac","artist":"Yes","album":"The Yes Album","title":"Perpetual Change","coverurl":"\/coverart.php\/NAS%2FTRX-FLAC%2FYes%2FThe%20Yes%20Album%2F06%20Perpetual%20Change.flac","track":"6","date":"197100","composer":"Anderson\/Squire","encoded":"FLAC 16\/44.1 kHz, 2ch","bitrate":"717 kbps","outrate":"PCM 16\/44.1 kHz, 2ch","volume":"15","mute":"1","state":"play"}

get_output_format

Gets the ALSA output format or Not playing. Returns: output format

JSON:
{"format":"PCM 16\/44.1 kHz, 2ch"}
{"format":"Not playing"}

get_volume

Gets the current Knob volume and mute state.
Returns: volume and mute state.

JSON:
{"volume":"10","muted":"yes"}

set_volume

Sets the knob volume to value N, up or down N or mute toggle.
Arguments: N | -up N | -dn N | -mute
Returns: volume and mute state

JSON:
{"volume":"15","muted":"no"}

playitem | playitem_next

Plays the specified item. If the item does not already exists in the Queue it is added at the end of the Queue for play_item and for play_item_next after the currently selected item in the Queue.
Arguments: URL | URI relative to MPD music root Returns: "OK"

Examples:
play_item RADIO/Soma FM - Fluid.pls
play_item NAS/TRX-FLAC/Yes/The Yes Album/03 Starship Trooper.flac
play_item http://mediaserv38.live-streams.nl:8006/live

JSON:
{"info":"OK"}

get_cdsp_config

Gets the current CamillaDSP signal processing config name. Returns: config name

JSON:
{"config":"off"}

set_cdsp_config

Sets CamillaDSP to the specified config name.
Arguments: A config name from the list of available configs including 'Off'. Returns: config name

JSON:
{"config":"V2-ProtoDAC.yml"}

set_coverview

Sets CoverView screen saver on or off.
Arguments: -on | -off

JSON:
{"info":"CoverView off"}

upd_library

Submits an "Update library" command. Arguments: none Returns: ""Library update submitted""

JSON:
{"info":"Library update submitted"}

restart_renderer

Restarts the specified renderer.
Arguments: --bluetooth | --airplay | --spotify | --squeezelite | --plexamp | --roonbridge Arguments: none Returns: "Render restart submitted"

JSON:
{"info":"Render restart submitted"}

MPD commands

See MPD protocol for list of commands and returns.

Deprecated REST API commands.

In Moode 9 series the following commands have been replaced by the equivalent new commands above and at some point will not be supported. It is recommended to update your scripts to use the new commands.

  • vol.sh
  • coverview.php
  • libupd-submit.php
  • restart-renderer.php

6.2. SSH Commands

There are several useful commands that can be run at the prompt in an SSH terminal.

moodeutl

This command can be used for printing logs, status or for manipulating certain parts of Moode.
moodeutl --help.

mpc

This command can be used to control MPD.
mpc help.

vol.sh

This command can be used to get or set MPD volume and update the Volume Knob.
/var/www/util/vol.sh --help.

libupd-submit.php

This command performs the equivalent of Menu > Library update. Run using sudo. sudo /var/www/util/libupd-submit.php

coverview.php

This command turns the CoverView screen saver on or off.
/var/www/util/coverview.php -on | -off

restart-renderer.php

This command restarts the specified renderer.
/var/www/util/restart-renderer.php --help

Back to Top