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 = 320
height = 240
depth = 32
frame.rate = 30
hdmi = False
no.frame = False
flip.touch.xy = 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.

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.

usage

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

[usage]
use.touchscreen = True
use.mouse = True
use.lirc = False
use.rotary.encoders = False
use.web = False
use.stream.server = False
use.browser.stream.player = False
use.voice.assistant = False
use.headless = False
use.vu.meter = False
use.album.art = True
use.auto.play = True

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.

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 = mp3, wav, wv, flac, ape
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
auto.play.next.track = True
cyclic.playback = True

• 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.

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

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

home.menu

These properties allow to enable/disable different player modes.

[home.menu]
radio = True
audio-files = True
audiobooks = True
stream = True
cd-player = False

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

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

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

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

<<Previous | Next>>