config.txt

This chapter explains the meaning of the properties in config.txt file.

screen.info

The properties in this section allow to define screen information.

[screen.info]
width = 480
height = 320
depth = 32
frame.rate = 30
hdmi = False
no.frame = False
flip.touch.xy = False
multi.touch = False

The property frame.rate defines the screen frame rate. 30 frames per second is the default value. This property affects the animation speed of the scrolling title.

The property hdmi should be used if HDMI display was connected to the Raspberry Pi board. It defines that double-buffering will be switched off.

no.frame property allows to display Peppy UI without window frame. That can be useful when player was started in X Window and there is the need to use it in full-screen mode.

Using property flip.touch.xy it's possible to flip X,Y coordinates for touchscreen events.

The property multi.touch should be used with multi-touch displays (e.g. the Official 7" Raspberry Pi display).

usage

This section contains properties which can switch on/off different functionality in Peppy player.

[usage]
touchscreen = True
mouse = True
lirc = False
rotary.encoders = False
web = True
stream.server = False
browser.stream.player = False
voice.assistant = False
headless = False
vu.meter = False
album.art = True
auto.play = True
long.press.time.ms = 700
desktop = True
check.for.updates = False
bluetooth = False
samba = False

In order to use web client the property use.web should be set to True

For using voice assistant functionality the property use.voice.assistant should be set to True

The property use.headless should be set to True to run Peppy player in a headless mode.

If Peppy player was installed on some graphical desktop then property poweroff should be set to False to avoid system shutdown when Poweroff button was clicked twice in GUI.

When Bluetooth device is in use the property bluetoot should be set to True.

logging

The properties required for logging configuration were grouped in this section.

file.logging = False
log.filename = /home/pi/Peppy/peppy.log
console.logging = False
enable.stdout = True
show.mouse.events = False

• file.logging - enable/disable logging to file.
• log.filename - log file name. Log messages will be saved in this file if file logging was enabled.
• console.logging - enable/disable console log messages.
• enable.stdout - enables stdout for messages. Should be set to True in most cases.
• show.mouse.events - enable/disable log messages for mouse events.

file.browser

This section defines the properties for the File Browser and File Player. Here are the default properties:

[file.browser]
audio.file.extensions = aac,ac3,aiff,ape,flac,m4a,mp3,mp4,ogg,opus,wav,wma,wv
playlist.file.extensions = m3u,cue
folder.images = folder.jpg,folder.png,cover.jpg,cover.png,front.jpg,front.png
cover.art.folders = covers,artwork,scans,art
show.embedded.images = mp3,flac,mp4,m4a
hide.folder.name = False
image.area = 18
image.size = 90
image.size.without.label = 96
icon.size = 60
padding = 2
rows = 5
columns = 2
alignment = left
sort.by.type = False
wrap.lines = False
horizontal.layout = True
font.height = 38

• audio.file.extensions - only files with extensions listed in this property will be displayed in the File Browser.
• playlist.file.extensions - defines file extensions for supported playlists
• folder.images - file names listed in this property define album art images which will be displayed in the File Player
• cover.art.folders - this property lists folder names which will be used by Slideshow screensaver. The screensaver will display all images from these folders in the loop.
• auto.play.next.track - starts playing next track automatically if True.
• cyclic.playback - starts playing the first track automatically if True.
• hide.folder.name - True will cause file browser to show only images and hide text info.
• folder.image.scale.ratio - defines the scale ratio of images displayed in the file browser.
• rows - the number of rows in the file menu.
• columns - the number of columns in the file menu.
• alignment - image alignment in the button. Possible values: center, left, right
• sort.by.type - True - sort files in file menu by type (folder, playlist, file), False - sort alphabetically
• wrap.lines - True - wrap lines, False - don't wrap lines
• horizontal.layout - True - use horizontal layout in the File Menu, False - use vertical layout
• font.height - menu item label font height

web.server

The only property necessary to configure web server is the port number. The host IP address will be detected by the Peppy player automatically.

[web.server]
http.port = 8000
https = False

The property https will make web server use HTTPS protocol instead of the default HTTP.

stream.server

This property defines port number which will be used by Peppy web client to listen to the stream

[stream.server]
stream.server.port = 8080

podcasts

podcasts.folder = /home/pi/podcasts

This property defines the folder name where podcasts will be saved for the offline usage.

collection

database.file = 
base.folder = 
show.numbers = 

home.menu

These properties allow to enable/disable different player modes.

[home.menu]
radio = True
audio-files = True
audiobooks = True
stream = False
cd-player = False
podcasts = True
airplay = False
spotify-connect = False
collection = False

home.navigator

back = True
screensaver = True
equalizer = True
language = True
timer = True
network = True
player = True
about = True

screensaver.menu

These properties allow to enable/disable the particular screensaver. When disabled it will not show up in the Screensaver menu.

[screensaver.menu]
clock = True
logo = True
slideshow = True
peppymeter = True
peppyweather = True
spectrum = True
lyrics = True
random = True

languages.menu

These properties allow to switch on/off the particular language. After switching off the language will not show up in the menu.

[languages.menu]
English-USA = True
German = True
French = True
Italian = True
Spanish = True
Russian = True

voice.assistant

The properties specific for the Voice Assistant should be defined in this section.

[voice.assistant]
type = Google Assistant
credentials = /home/pi/credentials.json
device.model.id = Peppy
device.id = my_peppy
command.display.time = 1

colors

The colors in this section define the color scheme of the whole UI.

[colors]
color.web.bgr = 0,38,40
color.dark = 0,70,75
color.dark.light = 20,90,100
color.medium = 70,140,150
color.bright = 160,190,210
color.contrast = 255,190,120
color.logo = 20,190,160
color.mute = 242,107,106

icons

type = monochrome
color.1.main = 160,190,210
color.1.on = 255,190,120
color.2.main = 70,140,150
color.2.on = 155,90,20

font

The font for Peppy player is located in folder Peppy/font/. It can be changed for any other font and its name should be defined here. This allows to switch between fonts placed in that folder.

[font]
font.name = FiraSans.ttf

volume.control

type = amixer
amixer.scale = linear
amixer.control = PCM

player.screen

top.height = 14
bottom.height = 16
button.height = 38
popup.width = 14
image.location = center

display.backlight

use.display.backlight = False
screen.brightness = 100
screensaver.brightness = 50
screensaver.display.power.off = False
sleep.now.display.power.off = True

scripts

script.player.start =
script.player.stop =
script.screensaver.start =
script.screensaver.stop =
script.timer.start =
script.timer.stop =

gpio

use.buttons = False
use.rotary.encoders = False
rotary.encoder.volume.up = 16
rotary.encoder.volume.down = 26
rotary.encoder.volume.mute = 13
rotary.encoder.navigation.left = 6
rotary.encoder.navigation.right = 12
rotary.encoder.navigation.select = 5
rotary.encoder.jitter.filter = 1
button.left =
button.right =
button.up =
button.down =
button.select =
button.volume.up =
button.volume.down =
button.mute =
button.play.pause =
button.next =
button.previous =
button.home =
button.poweroff =

<<Previous | Next>>