Permalink
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
moode/www/setup.txt
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
327 lines (246 sloc)
10.2 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| ################################################################################ | |
| # | |
| # 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. | |
| # | |
| # Updated: 2023-03-27 | |
| # | |
| # (C) Tim Curtis 2017 http://moodeaudio.org | |
| # | |
| ################################################################################ | |
| GENERAL INFORMATION | |
| Access the moOde WebUI using a Browser and one of the URL's below. Configuration | |
| and other options are available via the "m" moOde menu. | |
| - http://moode | |
| - http://moode.local | |
| - http://IP_ADDRESS | |
| An explanation of how to operate moOde audio player is contained in Quick help | |
| located on the moOde menu and also at the link below. | |
| https://github.com/moode-player/docs/blob/main/Quickhelp.pdf | |
| OS IMAGE AND SECURITY | |
| The OS image does not contain the userid pi, SSH service, WiFi SSID or Access | |
| Point password. | |
| - Use the official Raspberry Pi Imager to choose a moOde OS image, enable SSH, | |
| create the pi userid and password and optionally a WiFi SSID and password. | |
| The moOde OS images are listed in the "Media Player OS" category or if they | |
| were downloaded directly via the Download page at http://moodeaudio.org they | |
| can be selected via the "Use custom" category. | |
| - Refer to the links below for more information on operating system security | |
| and how to download and use the Raspberry Pi Imager. | |
| https://www.raspberrypi.com/software/ | |
| https://www.raspberrypi.com/news/raspberry-pi-bullseye-update-april-2022/ | |
| - The Access Point password can be entered via the WebUI, Network Config screen | |
| after the system starts or via an edited /boot/moodecfg.ini file. The file is | |
| described in this document in the CUSTOM CONFIGURATION section. | |
| To access the operating system command console use Secure Shell (SSH). An easy | |
| to use WebSSH terminal is available in System Config. | |
| 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 Refer to the SECURITY section | |
| - 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 = Refer to SECURITY section | |
| 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) Menu, Power, Restart | |
| - I2S DEVICE | |
| a) Menu, Configure, Audio | |
| b) Set Named I2S device or DT overlay to the correct device or overlay name | |
| c) Menu, Power, 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 or 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 Ethernet cable connected | |
| b) Insert WiFi adapter (while Pi running) | |
| c) http://moode, moode.local or IP_ADDRESS | |
| d) Menu, Configure, Network | |
| e) Configure a WiFi connection | |
| f) Menu, Power, Shutdown | |
| g) Unplug Ethernet cable | |
| h) Power on | |
| - Access Point (AP) mode | |
| a) Join network SSID = Moode, password = Refer to SECURITY section | |
| b) http://172.24.1.1 or http://moode.local | |
| c) Menu, Configure, Network | |
| d) Configure a WiFi connection | |
| e) Menu, Power, Restart | |
| 2. CHANGE HOST AND RENDERER NAMES | |
| a) Menu, Configure, System (and Audio) | |
| b) Click SET after entering an appropriate value in each name field | |
| c) Restart is required if changing Host name | |
| 3. AUTO-CONFIGURE AT BOOT | |
| a) Copy the file /boot/moodecfg.ini.default from the Pi to a PC or Mac | |
| b) Rename it to moodecfg.ini | |
| c) Edit the settings as needed | |
| d) Insert an SD Card into a reader attached to the PC or Mac | |
| e) Copy the moodecfg.ini file from the PC or Mac to /boot on the SD Card | |
| f) Eject the SD Card | |
| f) Insert the SD Card into the Pi and power up | |
| g) The Pi will reboot twice to perform the auto-configuration process | |
| AFTER PLAYER SETUP | |
| Follow these instructions for making certain types of changes. | |
| 1. Switching from a USB to an I2S audio device | |
| a) Unplug the USB audio device | |
| b) Menu, Power, Shutdown | |
| c) Install the I2S audio device | |
| d) Power on | |
| e) Menu, Configure, Audio | |
| b) Set Named I2S device or DT overlay to the correct device or overlay name | |
| g) Menu, Power, Restart | |
| 2. Switching from an I2S to a USB audio device | |
| a) Menu, Configure, Audio | |
| b) Set Named I2S device and DT overlay to "None" | |
| c) Menu, Power, Shutdown | |
| d) Remove the I2S audio device | |
| e) Power on | |
| f) Menu, Configure, Audio | |
| g) Set Output device to to the name of the USB audio device | |
| h) If the audio device supports hardware volume set Volume type to | |
| Hardware otherwise set it to Software, Fixed or Null | |
| i) 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 AND REST API | |
| Commands can be submitted to moOde via HTTP or SSH. If an HTTP command returns | |
| data it is in JSON or plain text format following REST guidelines. | |
| 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. Song info is via the command get_currentsong which returns the contents | |
| of the file /var/local/www/currentsong.txt encoded as JSON | |
| moOde utility command: | |
| The SSH command "moodeutl" can be used for obtaining status or manipulating | |
| certain parts of moOde. For a list of options type moodeutl --help | |
| HTTP examples: | |
| # Get song info | |
| 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 | |
| ################################################################################ |