Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Yes
  • Loading branch information
dhrone committed Oct 21, 2017
2 parents 35019b8 + 41d785c commit 9413cdc
Showing 1 changed file with 36 additions and 34 deletions.
70 changes: 36 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,40 +78,42 @@ IMPORTANT: There must be one and only one ExecStart enabled within the file.

The general format for the ExecStart lines is as follows:

#ExecStart=/usr/bin/docker run --network=host --privileged -v /var/log:/var/log:rw dhrone/pydpiper:latest python /app/pydPiper.py --<musicdistro> --driver <driver> --width <width> --height <height> --i2caddress <i2caddress> --i2cport <i2cport> --rs <rs> --e <e> --d4 <d4> --d5 <d5> --d6 <d6> --d7 <d7> --timezone <timezone> --temperature <temperature> --lmsplayer <lmsplayer> --pages <pagefile>
#
# Definitions for command line Parameters
#
# <driver> -- Driver for your display. Possible values are 'winstar_weg', 'hd44780', 'hd44780_i2c', 'ssd1306_i2c'
#
# <musicdistro> -- Sets the type of music player pydPiper is installed on. Possible values are 'volumio', 'rune', 'lms'
#
# <width> -- width of your display in pixels. If you are using a character display, each column is 5 pixels wide
# <height> -- height of your display in pixels. If you are using a character display, each line is 8 pixels high
#
# For I2C displays
# <i2caddress> -- The I2C address your display is installed on. Normally 0x27.
# <i2cport> -- The I2C port your display is attached to. Normally 1.
#
# For parallel interface displays
# <e>, <rs>, <d4>, <d5>, <d6>, <d7> -- The GPIO pins your display is connected to
#
# timezone -- Sets what timezone is local for this system (e.g. 'US/Eastern', 'France/Paris')
# temperature -- Sets whether to use fahrenheit or celcius
#
# If using a logitech media server player
# lmsplayer -- The MAC address for the player. Should be the localhost's MAC address if running Squeezeplayer on the same system as pydPiper. Example: 'b8:27:eb:f9:88:1e'
#
# If using Weather Underground services
# wapi -- weather underground API key. Go to https://www.wunderground.com/weather/api/ to request a key.
# wlocale -- location to pull weather for. General format is Zipcode, State/City, Country/City, or Latitude,Longitude (e.g. '20001', 'CA/San_Francisco', 'France/Paris', '37.77,-122.39').
#
# Page files have been created for
# HD44780 style LCDs (16x2 and 20x4 dimensions) -- pages_lcd_16x2.py, pages_lcd_20x4.py
# Winstar WEH style OLEDs (16x2 dimensions) -- pages_weh_80x16.py
# Winstar WEG style OLEDS (100x16 pixel dimensions) -- pages_weg_100x16.py
# SSD1306 style OLEDs (128x64 pixel dimensions) -- pages_ssd1306.py
# <pagefile> -- The name of the pages file to use for your display

ExecStart=/usr/bin/docker run --network=host --privileged -v /var/log:/var/log:rw dhrone/pydpiper:latest python /app/pydPiper.py --<musicdistro> --driver <driver> --width <width> --height <height> --i2caddress <i2caddress> --i2cport <i2cport> --rs <rs> --e <e> --d4 <d4> --d5 <d5> --d6 <d6> --d7 <d7> --timezone <timezone> --temperature <temperature> --lmsplayer <lmsplayer> --pages <pagefile>

Definitions for command line Parameters

<driver> -- Driver for your display. Possible values are 'winstar_weg', 'hd44780', 'hd44780_i2c', 'ssd1306_i2c'

<musicdistro> -- Sets the type of music player pydPiper is installed on. Possible values are 'volumio', 'rune', 'lms'

<width> -- width of your display in pixels. If you are using a character display, each column is 5 pixels wide
<height> -- height of your display in pixels. If you are using a character display, each line is 8 pixels high

For I2C displays
<i2caddress> -- The I2C address your display is installed on. Normally 0x27.
<i2cport> -- The I2C port your display is attached to. Normally 1.

For parallel interface displays
<e>, <rs>, <d4>, <d5>, <d6>, <d7> -- The GPIO pins your display is connected to

timezone -- Sets what timezone is local for this system (e.g. 'US/Eastern', 'France/Paris')
temperature -- Sets whether to use fahrenheit or celcius

If using a logitech media server player
lmsplayer -- The MAC address for the player. Should be the localhost's MAC address if running Squeezeplayer on the same system as pydPiper. Example: 'b8:27:eb:f9:88:1e'

If using Weather Underground services
wapi -- weather underground API key. Go to https://www.wunderground.com/weather/api/ to request a key.
wlocale -- location to pull weather for. General format is Zipcode, State/City, Country/City, or Latitude,Longitude (e.g. '20001', 'CA/San_Francisco', 'France/Paris', '37.77,-122.39').

Page files have been created for
HD44780 style LCDs (16x2 and 20x4 dimensions) -- pages_lcd_16x2.py, pages_lcd_20x4.py
Winstar WEH style OLEDs (16x2 dimensions) -- pages_weh_80x16.py
Winstar WEG style OLEDS (100x16 pixel dimensions) -- pages_weg_100x16.py
SSD1306 style OLEDs (128x64 pixel dimensions) -- pages_ssd1306.py

<pagefile> -- The name of the pages file to use for your display

Once you have finished editing the file, save it and exit.

Expand Down

0 comments on commit 9413cdc

Please sign in to comment.