setup.txt

########################################################
#
# Setup Guide for moOde audio player
#
# These instructions are designed for initial configuration
# of moOde audio player. Additional configuration help is
# provided within the player via the (i) information buttons.
#
# Updated: 2020-02-12
#
# (C) Tim Curtis 2017 http://moodeaudio.org
#
#########################################################

////////////////////////////////////////////////////////
//
// GENERAL INFORMATION
//
////////////////////////////////////////////////////////

NOTE: Use http://moode, moode.local or IP address, whichever works on your network.
Typically Android OS will only work with IP address.

- SSH login user: pi, pwd: moodeaudio
- Preface commands requiring root permission with sudo
- Access Point (AP) mode:
  (a) IP address: 172.24.1.1
  (b) SSID: Moode
  (c) Password: moodeaudio
  (d) Channel: 6
- AP mode starts automatically when:
  (a) WiFi SSID is set to 'None' in Network config and there is no Ethernet connection
  (b) WiFi SSID is defined but no IP address was assigned by DHCP. This typically
  occurs when connection to the SSID fails.
- Default Samba shares are NAS, Playlists, Radio, and SDCard
- Each USB disk will also have a Samba share named after its Disk Label

WIFI ADAPTERS THAT ARE REPORTED TO SUPPORT AP MODE

- Raspberry Pi 3, 4 and Zero W integrated WiFi adapters
- 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 from 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

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
    - Access Point (AP) mode
    a) Insert WiFi adapter that supports AP mode
    b) Power on
    c) Join network SSID=Moode, pwd=moodeaudio
    d) http://moode.local or http://172.24.1.1

 2. AUDIO DEVICE SETUP
    - USB DEVICE
	a) Menu, Configure, Audio
    b) Select "None" for I2S audio device then SET
    c) Restart
    d) Menu, Configure, Audio
    e) EDIT MPD config
    f) Leave Volume control set to "Software"
    g) Set Device type to "USB audio device"
    h) SAVE
    i) Restart

    - I2S DEVICE
    a) Menu, Configure, Audio
    b) Select an I2S audio device then SET
    c) Restart
    d) Menu, Configure, Audio
    e) EDIT MPD config
    f) Leave Volume control set to "Software"
    g) Verify Audio device is set to "I2S audio device"
    h) SAVE

 3. TIME ZONE
    a) Menu, Configure, System
    b) Select appropriate timezone then SET

 4. ADD SOURCE(S) CONTAINING MUSIC FILES
    - USB STORAGE DEVICES
    a) Insert USB storage device
    b) Menu, Configure, Library
    c) UPDATE or RE-GEN MPD database
    d) Optionally select Yes to automatically update MPD database on USB insert/remove
    e) Wait for completion (no spinner)
    - SDCARD STORAGE DEVICES
    a) Menu, Configure, Library
    b) UPDATE or RE-GEN MPD database
    c) Wait for completion (no spinner)
    - NAS DEVICE
    a) Menu, Configure, Library
    b) CREATE Music source (MPD database update initiates automatically after SAVE)
    c) Wait for completion (no spinner)
    - ALBUM COVER THUMBNAILS
    a) UPDATE or RE-GEN the album cover thumbnail cache.
    b) VIEW cache status periodically and wait until Done.

 5. VERIFY AUDIO PLAYBACK
    - Ethernet mode
    a) http://moode
    b) Play one of the radio stations
    - AP mode
    a) http://moode.local
    b) Browse, SDCARD, Stereo Test
    c) Menu for "LR Channel And Phase" track
    d) Play

 At this point a FULLY OPERATIONAL PLAYER exists.

////////////////////////////////////////////////////////
//
// CUSTOM CONFIGS
//
// 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

    NOTE: This works only on a fresh image that has never been booted!
    NOTE: To start AP mode at boot set wlanssid to blank e.g., wlanssid=

    a) Change values in the file below
    b) Paste contents into /boot/moodecfg.txt
    c) sudo reboot
    d) Join AP SSID if using AP mode, then http://hostname.local or http://172.24.1.1

##########################################
# Copy this file to /boot/moodecfg.txt
# It will be processed at startup and the
# system will automaticly Restart.
#
# All param=value pairs must be present.
# Set wlanssid= blank to start AP mode.
# Example: wlanssid=
##########################################

[names]
hostname=moode
browsertitle=moOde Player
airplayname=Moode Airplay
spotifyname=Moode Spotify
bluetoothname=Moode Bluetooth
squeezelitename=Moode
upnpname=Moode UPNP
dlnaname=Moode DLNA
mpdzeroconf=Moode MPD

[services]
airplaysvc=0
upnpsvc=0
dlnasvc=0

[network]
wlanssid=MySSID
wlansec=wpa
wlanpwd=MyPassword
wlancountry=US
apdssid=Moode
apdchan=6
apdpwd=moodeaudio

[other]
timezone=America/Detroit
themename=Default
accentcolor=Emerald

////////////////////////////////////////////////////////
//
// 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 Device type 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

////////////////////////////////////////////////////////
//
// Web API
//
// Below are a list of commands that can be submitted to
// moOde via http.
//
////////////////////////////////////////////////////////

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 via the command libupd_submit

Examples:

// 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

////////////////////////////////////////////////////////
//
// END
//
////////////////////////////////////////////////////////