From e22caa967397088befbf5f76a5a9d79423ecafd9 Mon Sep 17 00:00:00 2001 From: dhrone Date: Sat, 21 Oct 2017 16:17:28 -0400 Subject: [PATCH 1/2] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 5412ed1..79395fa 100755 --- a/README.md +++ b/README.md @@ -78,6 +78,7 @@ 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 -- --driver --width --height --i2caddress --i2cport --rs --e --d4 --d5 --d6 --d7 --timezone --temperature --lmsplayer --pages # # Definitions for command line Parameters @@ -112,6 +113,7 @@ The general format for the ExecStart lines is as follows: # Winstar WEG style OLEDS (100x16 pixel dimensions) -- pages_weg_100x16.py # SSD1306 style OLEDs (128x64 pixel dimensions) -- pages_ssd1306.py # -- The name of the pages file to use for your display +''' Once you have finished editing the file, save it and exit. From 41d785ca2cf592efb507e28b06eaebe0e7c48a35 Mon Sep 17 00:00:00 2001 From: dhrone Date: Sat, 21 Oct 2017 16:18:53 -0400 Subject: [PATCH 2/2] Update README.md --- README.md | 72 +++++++++++++++++++++++++++---------------------------- 1 file changed, 36 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 79395fa..799d831 100755 --- a/README.md +++ b/README.md @@ -78,42 +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 -- --driver --width --height --i2caddress --i2cport --rs --e --d4 --d5 --d6 --d7 --timezone --temperature --lmsplayer --pages -# -# Definitions for command line Parameters -# -# -- Driver for your display. Possible values are 'winstar_weg', 'hd44780', 'hd44780_i2c', 'ssd1306_i2c' -# -# -- Sets the type of music player pydPiper is installed on. Possible values are 'volumio', 'rune', 'lms' -# -# -- width of your display in pixels. If you are using a character display, each column is 5 pixels wide -# -- height of your display in pixels. If you are using a character display, each line is 8 pixels high -# -# For I2C displays -# -- The I2C address your display is installed on. Normally 0x27. -# -- The I2C port your display is attached to. Normally 1. -# -# For parallel interface displays -# , , , , , -- 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 -# -- 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 -- --driver --width --height --i2caddress --i2cport --rs --e --d4 --d5 --d6 --d7 --timezone --temperature --lmsplayer --pages + +Definitions for command line Parameters + + -- Driver for your display. Possible values are 'winstar_weg', 'hd44780', 'hd44780_i2c', 'ssd1306_i2c' + + -- Sets the type of music player pydPiper is installed on. Possible values are 'volumio', 'rune', 'lms' + + -- width of your display in pixels. If you are using a character display, each column is 5 pixels wide + -- height of your display in pixels. If you are using a character display, each line is 8 pixels high + +For I2C displays + -- The I2C address your display is installed on. Normally 0x27. + -- The I2C port your display is attached to. Normally 1. + +For parallel interface displays +, , , , , -- 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 + + -- The name of the pages file to use for your display Once you have finished editing the file, save it and exit.