setup.txt

################################################################################
#
#  Setup Guide for moOde audio player
#
#  These instructions are designed for an initial configuration of moOde audio
#  player. Additional configuration help is provided within the player via Menu,
#  Quick help and the (i) information buttons.
#
#  Version: 1.2 2022-08-09
#
#  (C) Tim Curtis 2017 http://moodeaudio.org
#
################################################################################

GENERAL INFORMATION

To access the moOde UI open a Web Browser and enter one of the URL's below. The
system is configured via the "m" menu Configure and Preferences selections.

- http://moode
- http://moode.local
- http://IP_ADDRESS

To access the operating system command console use Secure Shell (SSH). An easy
to use Web SSH terminal is available in System Config.

- Userid    pi
- Password  moodeaudio

ACCESS POINT (AP) MODE

To use to Access Point (AP) mode which is moOde's private 2.4 GHz WiFi network
refer to the settings below.

- IP address    172.24.1.1
- SSID          Moode
- Password      moodeaudio
- Channel       6

AP mode starts automatically when any of the following are true.

- WiFi SSID is set to "None (activates AP mode)" in Network Config, Router
  mode is Off and there is no active Ethernet connection.

- WiFi SSID is defined in Network Config but no IP address was assigned after
  attempting to connect to the SSID and there is no active Ethernet connection.

- Router mode is On in Network Config and either WiFi SSID is defined but no IP
  address was assigned or SSID is set to "None (activates AP mode)". An active
  Ethernet connection is required for Router mode to function but it does not
  need to be active at the time AP Router mode starts.

FILE SHARING

- SMB File Sharing can be turned On in System Config. 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 can be turned On in System Config. Access and options defaults
  are provided but can be manually overridden. Each USB disk will have an NFS
  export created whose path is /media/disk_label.

WIFI ADAPTERS THAT ARE REPORTED TO SUPPORT Access Point (AP) MODE

- Raspberry Pi integrated WiFi adapter
- Comfast CF-912AC dual-band WiFi adapter
- For all other adapters consult the manufacturer

IN-PLACE SOFTWARE UPDATES

- Updates to moOde software are made available periodically and can be downloaded
  and installed by clicking "CHECK for software update" in System Config.
- Click VIEW to see a list of what is contained in the update package.
- Click INSTALL to download and install the update package.

IMAGE WRITING UTILITIES

THe official Raspberry Pi Imager can be downloaded via the URL below.
https://www.raspberrypi.org/documentation/installation/installing-images/

PLAYER SETUP AND CONFIGURATON

1. INITIAL SETUP

   a) Insert boot SD card or USB drive
   b) Connect USB or I2S audio device
   c) Connect USB storage devices
   - Ethernet mode
   a) Insert ethernet cable
   b) Power on
   c) http://moode, moode.local or IP_ADDRESS
   - Access Point (AP) mode
   a) Insert WiFi adapter that supports AP mode
   b) Power on
   c) Join network: SSID = Moode, password = moodeaudio
   d) http://172.24.1.1 or http://moode.local

2. AUDIO DEVICE SETUP

   - USB DEVICE

   a) Menu, Configure, Audio
   b) Set Named I2S device and DT overlay to "None" if needed and then restart
   c) Menu, Configure, Audio
   d) Set Output device to to the name of the USB audio device
   e) If the audio device supports hardware volume set Volume type to
      Hardware otherwise set it to Software, Fixed or Null
   f) Restart

   - I2S DEVICE

   a) Menu, Configure, Audio
   b) Set Named I2S device or DT overlay to the correct device or overlay name
   c) Restart
   d) Menu, Configure, Audio
   e) If the audio device supports hardware volume set Volume type to
      Hardware otherwise set it to Software, Fixed or Null

3. TIME ZONE

   a) Menu, Configure, System
   b) Set the appropriate timezone

4. ADD SOURCE(S) CONTAINING MUSIC FILES

   - USB STORAGE DEVICES

   a) Insert USB storage device
   b) Menu, Update library
   c) Wait for completion (no spinner)

   - BOOT SDCARD STORAGE

   a) Menu, Update library
   b) Wait for completion (no spinner)

   - NAS DEVICE

   a) Menu, Configure, Library
   b) CREATE Music source
   c) After SAVE, return to Playback or Library
   d) Menu, Update library
   e) Wait for completion (no spinner)

   - MUSIC DATABASE UTILITIES

   a) Menu, Configure, Library
   b) Various utilities will be listed in the Music Library section

5. VERIFY AUDIO PLAYBACK

   - Ethernet mode

   a) http://moode, moode.local, IP_ADDRESS
   b) Play one of the radio stations

   - AP mode

   a) http://172.24.1.1 or http://moode.local
   b) Switch to Library Folder view
   c) Navigate to the SDCARD/Stereo Test
   c) Play the  "LR Channel And Phase" track

At this point a FULLY OPERATIONAL PLAYER exists.

CUSTOM CONFIGURATIONS

Customize the player by using any of the following procedures.

1. CONFIGURE FOR WIFI CONNECTION

   - Ethernet mode
   a) Leave eth cable connected
   b) Insert wifi adapter (while Pi running)
   c) http://moode
   d) Menu, Configure, Network
   e) Configure a wifi connection
   f) Menu, Power, Shutdown
   g) Unplug eth cable
   h) Power on

   - Access Point (AP) mode
   a) Join network SSID=Moode, pwd=moodeaudio
   b) http://moode.local
   c) Menu, Configure, Network
   d) Configure a wifi connection
   e) Menu, Power, Restart

2. CHANGE HOST AND SERVICE NAMES

   a) Menu, Configure, System (and Audio)
   b) SET after entering appropriate value in each name field
   c) Restart is required if changing Host name

3. AUTO-CONFIGURE AT BOOT

   a) Mount the SDCard which will make the boot partition accessible
   b) Copy the file /boot/moodecfg.ini.default to your PC, Mac or Linux client
   c) Rename it to moodecfg.ini
   d) Edit the settings as needed
   e) Copy moodecfg.ini to /boot/
   f) Insert SD Card in Pi and power up
   g) Join AP SSID if using AP mode, then http://hostname.local or http://172.24.1.1

AFTER PLAYER SETUP

Follow these instructions for making certain types of changes.

1. Switching from USB to I2S audio device
   a) Unplug USB audio device
   b) Menu, Power, Shutdown
   c) Install I2S audio device
   d) Power on
   e) Menu, Configure, Audio
   f) Select appropriate I2S audio device then SET
   g) Menu, Power, Restart
   h) Menu, Configure, Audio, EDIT MPD config
   i) Verify Audio output is set to "I2S audio device"
   j) SAVE

2. Switching from I2S to USB audio device
   a) Menu, Configure, Audio
   b) Select "None" for I2S audio device then SET
   c) Menu, Power, Shutdown
   d) Optionally unplug I2S audio device
   e) Plug in USB audio device
   f) Power on
   g) Menu, Configure, Audio,  EDIT MPD config
   h) Set Device type to "USB audio device"
   i) SAVE
   j) Menu, Power, Restart

3. Switching from WiFi back to Ethernet
   a) Plug in Ethernet cable
   b) Menu, Configure, Network
   c) RESET network configuration to defaults
   d) Menu, Power, Shutdown
   e) Remove WiFi adapter
   f) Power on

COMMAND API

Below are a list of commands that can be submitted to moOde via http or ssh.

1. Base URL is http://moode/command/?cmd=
2. MPD commands that are listed in MPC help
3. Volume commands that are listed in /var/www/vol.sh --help
4. Library update is via the command libupd-submit.php
5. CoverView on/off is via the command coverview.php on/off
6. Other commands
   a) get_currentsong
      Returns contents of the file /var/local/www/currentsong encoded as JSON

HTTP examples:

# Other
http://moode/command/?cmd=get_currentsong
{"file":"http:\/\/west-aac-64.streamthejazzgroove.com\/stream",
"artist":"Radio station",
"album":"The Jazz Groove",
"title":"Russell Malone - You Will Know",
"coverurl":"imagesw%2Fradio-logos%2FThe%20Jazz%20Groove.jpg",
"track":"",
"date":"",
"composer":"",
"encoded":"VBR",
"bitrate":"",
"outrate":"Multiroom sender",
"volume":"15",
"mute":"0",
"state":"play"}

# MPD
http://moode/command/?cmd=stop
http://moode/command/?cmd=play

# Volume
http://moode/command/?cmd=vol.sh -up 2
http://moode/command/?cmd=vol.sh -mute

# Library update
http://moode/command/?cmd=libupd-submit.php

SSH examples:

# MPD
mpc stop
mpc play

# Volume
/var/www/vol.sh -up 2
/var/www/vol.sh -mute

# Library update
sudo /var/www/libupd-submit.php

# CoverView on/off
/var/www/util/coverview.php -on
/var/www/util/coverview.php -off

################################################################################
#  Post questions regarding this guide to http://moodeaudio.org/forum
################################################################################