forked from moode-player/moode
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsetup.txt
333 lines (250 loc) · 10.5 KB
/
setup.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
################################################################################
#
# 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-05-09
#
# (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
SECURITY AND OPERATING SYSTEM (OS) IMAGE
For improved 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 a userid and password and optionally a WiFi SSID and password.
*** READ THIS ***
1. SSH and userid/password are REQUIRED for correct operation of moOde.
2. Do not set the host name using the Imager. Refer to CUSTOM CONFIGURATIONS
in this guide for information on changing the host name.
- An Access Point password can be set using the Network Configuration screen
after accessing the moOde WebUI, or before first boot via a moodecfg.ini
file as described in the CUSTOM CONFIGURATIONS section.
- The moOde OS images are listed in the "Media Player OS" category of the Pi
Imager, 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/
To access the OS command console use Secure Shell (SSH). An easy to use WebSSH
terminal is available in the WebUI, System Config screen.
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
################################################################################