├── RetroPie-Clcd01.jpg
├── clcd.service
├── runcommand-onend.sh
├── COPYRIGHT.md
├── I2C_Address.sh
├── 10.CLCD.sh
├── .gitignore
├── runcommand-onstart.sh
├── README.md
├── lcdScroll.py
├── I2C_LCD_driver.py
├── retropie_clcd.py
└── LICENSE
/RetroPie-Clcd01.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/zzeromin/RetroPie-Clcd/HEAD/RetroPie-Clcd01.jpg
--------------------------------------------------------------------------------
/clcd.service:
--------------------------------------------------------------------------------
1 | # systemd service about auto-start clcd.service after booting
2 | # path and command: sudo nano /lib/systemd/system/clcd.service
3 |
4 | [Unit]
5 | Description=Retropie 16x2 CLCD Service
6 | After=multi-user.target
7 |
8 | [Service]
9 | Type=idle
10 | ExecStart=/usr/bin/python /home/pi/RetroPie-Clcd/retropie_clcd.py
11 |
12 | [Install]
13 | WantedBy=multi-user.target
14 |
--------------------------------------------------------------------------------
/runcommand-onend.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | # edited by zzeromin ( 2016-10-14 )
3 | # special thanks to zerocool
4 | # Reference:
5 | # runcommand of Retorpie: https://github.com/retropie/retropie-setup/wiki/runcommand
6 | # edit and path: $ sudo nano /opt/retropie/configs/all/runcommand-onend.sh
7 |
8 | sed '1,$d' /dev/shm/runcommand.log > /dev/shm/runcommand.log
9 | echo "notice" >&2
10 | echo "PLZ GO TO SLEEP!" >&2
11 |
--------------------------------------------------------------------------------
/COPYRIGHT.md:
--------------------------------------------------------------------------------
1 | The RetroPie CLCD Project Copyright (C) 2016 by the following:
2 |
3 | We are members of Raspberrypi Village & Raspberrypi Gamer Cafe.
4 |
5 | * zzeromin
6 | * smyani (The Father of RAS-Joy-Box)
7 | * zerocool
8 | * superstar
9 |
10 | # Raspberrypi Village
11 | * http://rasplay.org
12 | * http://forums.rasplay.org/
13 | * http://wiki.rasplay.org/
14 | * https://www.facebook.com/openmake
15 |
16 | # Raspberrypi Gamer Cafe
17 | * http://cafe.naver.com/raspigamer
18 |
--------------------------------------------------------------------------------
/I2C_Address.sh:
--------------------------------------------------------------------------------
1 | ## i2c_address.sh
2 | # Title : Automatic I2C Address Changer for RAS Console-Pi
3 | # Author : zerocool, member of raspigamer
4 | # Creation Date: Dec 1, 2016
5 | # Web : http://cafe.naver.com/raspigamer
6 | # Free and open for all to use. But put credit where credit is due.
7 | #
8 | # How to Setup :
9 | # cd /home/pi/RetroPie-Clcd/
10 | # chmod 755 I2C_Address.sh
11 | # sudo ./I2C_Address.sh
12 |
13 | # I2C ADDRESS DETECT
14 | I2C_DETECT=`i2cdetect -y 1 | grep '\-\-' | cut -d: -f2 | grep [0-9a-fA-F] | awk '{ i = 1; while (i <= NF) { if($i != "--") print $i; i++} }'`
15 |
16 | I2C_ADDRESS="0x${I2C_DETECT}"
17 |
18 | # Get value already installed
19 | I2C_ADDRESS_PREV=`grep '^ADDRESS' /home/pi/RetroPie-Clcd/I2C_LCD_driver.py | cut -d= -f2 | sed 's/ //'`
20 |
21 | # Change config and restart service when different value detect
22 | if [ $I2C_ADDRESS != $I2C_ADDRESS_PREV ]
23 | then
24 | # Change config file
25 | sed -i "s/ADDRESS = 0x[0-9a-fA-F][0-9a-fA-F]/ADDRESS = ${I2C_ADDRESS}/" /home/pi/RetroPie-Clcd/I2C_LCD_driver.py
26 |
27 | # Restart CLCD Service
28 | systemctl restart clcd
29 | fi
30 |
--------------------------------------------------------------------------------
/10.CLCD.sh:
--------------------------------------------------------------------------------
1 | ## 10.CLCD.sh
2 | # Title : Scrolling Game Title for Retropie v4.0.2 using 16x2 CLCD on RAS Console-Pi
3 | # Author : zzeromin, member of Raspberrypi Village & raspigamer
4 | # Creation Date: Oct 28, 2016
5 | # Blog : http://rasplay.org, http://forums.rasplay.org/, https://zzeromin.tumblr.com/
6 | # Thanks to : smyani, zerocool, superstar
7 | # Free and open for all to use. But put credit where credit is due.
8 | #
9 | # How to Setup :
10 | # cd /home/pi
11 | # git clone https://github.com/zzeromin/RetroPie-Clcd.git
12 | # cd /home/pi/RetroPie-Clcd/
13 | # chmod 755 10.CLCD.sh
14 | # sudo ./10.CLCD.sh
15 |
16 | cd /home/pi/
17 | git clone https://github.com/zzeromin/RetroPie-Clcd.git
18 | cd RetroPie-Clcd/
19 | cp runcommand-onstart.sh /opt/retropie/configs/all/
20 | cp runcommand-onend.sh /opt/retropie/configs/all/
21 | cp clcd.service /lib/systemd/system/
22 | systemctl enable clcd
23 | echo "CLCD Setup Complete."
24 | echo "I2C Setup is Starting Now"
25 | sleep 1
26 | apt-get update
27 | apt-get -y install python-smbus i2c-tools
28 | echo "i2c-bcm2708" >> /etc/modules
29 | echo "i2c-dev" >> /etc/modules
30 | sed -i 's/#dtparam=i2c_arm/dtparam=i2c_arm/' /boot/config.txt
31 | #echo "dtparam=i2c_arm=on" >> /boot/config.txt
32 | echo "I2C Setup Complete. Reboot after 3 Seconds."
33 | sleep 3
34 | reboot
35 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Byte-compiled / optimized / DLL files
2 | __pycache__/
3 | *.py[cod]
4 | *$py.class
5 |
6 | # C extensions
7 | *.so
8 |
9 | # Distribution / packaging
10 | .Python
11 | env/
12 | build/
13 | develop-eggs/
14 | dist/
15 | downloads/
16 | eggs/
17 | .eggs/
18 | lib/
19 | lib64/
20 | parts/
21 | sdist/
22 | var/
23 | *.egg-info/
24 | .installed.cfg
25 | *.egg
26 |
27 | # PyInstaller
28 | # Usually these files are written by a python script from a template
29 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
30 | *.manifest
31 | *.spec
32 |
33 | # Installer logs
34 | pip-log.txt
35 | pip-delete-this-directory.txt
36 |
37 | # Unit test / coverage reports
38 | htmlcov/
39 | .tox/
40 | .coverage
41 | .coverage.*
42 | .cache
43 | nosetests.xml
44 | coverage.xml
45 | *,cover
46 | .hypothesis/
47 |
48 | # Translations
49 | *.mo
50 | *.pot
51 |
52 | # Django stuff:
53 | *.log
54 | local_settings.py
55 |
56 | # Flask stuff:
57 | instance/
58 | .webassets-cache
59 |
60 | # Scrapy stuff:
61 | .scrapy
62 |
63 | # Sphinx documentation
64 | docs/_build/
65 |
66 | # PyBuilder
67 | target/
68 |
69 | # IPython Notebook
70 | .ipynb_checkpoints
71 |
72 | # pyenv
73 | .python-version
74 |
75 | # celery beat schedule file
76 | celerybeat-schedule
77 |
78 | # dotenv
79 | .env
80 |
81 | # virtualenv
82 | venv/
83 | ENV/
84 |
85 | # Spyder project settings
86 | .spyderproject
87 |
88 | # Rope project settings
89 | .ropeproject
90 |
--------------------------------------------------------------------------------
/runcommand-onstart.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | # added and modified by zzeromin, zerocool ( 2016-10-13 )
3 | # special thanks to zerocool
4 | # Reference:
5 | # runcommand of Retorpie: https://github.com/retropie/retropie-setup/wiki/runcommand
6 | # basic script: https://retropie.org.uk/forum/topic/3731/solved-variables-with-runcommand-onstart-sh/9
7 | # edit and path: $ sudo nano /opt/retropie/configs/all/runcommand-onstart.sh
8 |
9 | # get the system name
10 | system=$1
11 |
12 | # get the emulator name
13 | emul=$2
14 |
15 | # get the full path filename of the ROM
16 | rom=$3
17 |
18 | # rom_bn receives $rom excluding everything from the first char to the last slash '/'
19 | rom_bn="${rom##*/}"
20 |
21 | # rom_bn receives $rom_bn excluding everything from the last char to the first dot '.'
22 | #rom_bn="${rom_bn%.*}"
23 |
24 | # For English User
25 | # Display Game name to EmulationStation and CLCD from same gamelist.xml
26 | GAMELIST1="/home/pi/RetroPie/roms/${system}/gamelist.xml"
27 | GAMELIST2="/home/pi/.emulationstation/gamelists/${system}/gamelist.xml"
28 |
29 | # For 2Byte Language User(Korean, Japanese, etc..)
30 | # Display Game name to EmulationStation from gamelist.xml(Korean Game name)
31 | # Display Game name to CLCD from gamelist_en.xml(English Game name)
32 | #GAMELIST1="/home/pi/RetroPie/roms/${system}/gamelist_en.xml"
33 | #GAMELIST2="/home/pi/.emulationstation/gamelists/${system}/gamelist_en.xml"
34 |
35 | if [ -f ${GAMELIST1} ]
36 | then
37 | GAMELIST=${GAMELIST1}
38 | else
39 | GAMELIST=${GAMELIST2}
40 | fi
41 |
42 | title=`grep -A1 "${rom_bn}" ${GAMELIST} | awk '{getline;print}' | awk 'BEGIN {FS=""} {print $2}' | awk 'BEGIN {FS=""} {print $1}'`
43 |
44 | echo "$system" >&2
45 | echo "$title" >&2
46 | #echo "$rom_bn" >&2
47 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # RetroPie-Clcd
2 | Scrolling Game Title for RetroPie v4.0.2 using 16x2 CLCD on RAS Console-Pi
3 |
4 | 
5 |
6 | ## About
7 | Small script written in Python for RetroPie project (https://retropie.org.uk/)
8 | running on Raspberry Pi 2,3, which displays all necessary info on a 16x2 CLCD display
9 |
10 | ## Features
11 | * Current Date and Time, IP address of eth0, wlan0
12 | * CPU Temperature and Speed
13 | * Emulation and ROM information
14 |
15 | ## Youtube
16 | * https://youtu.be/W6jqBTqPqjw
17 | * https://youtu.be/5KBNl-k6-SA
18 | * https://youtu.be/_7mxhkkjFqk
19 |
20 | ## Development Environment
21 | * Raspberry Pi 2, 3
22 | * RetroPie v4.0.2 and later
23 | * 16x2 I2C Character LCD
24 |
25 | ## Install
26 | First, you should install Scraper( https://github.com/retropie/retropie-setup/wiki/scraper )
27 |
28 | Second, Install below:
29 | cd /home/pi
30 | git clone https://github.com/zzeromin/RetroPie-Clcd.git
31 | cd /home/pi/RetroPie-Clcd/
32 | chmod 755 10.CLCD.sh
33 | sudo ./10.CLCD.sh
34 |
35 |
36 | ## Check
37 | You should check your I2C address of 16x2 CLCD.
38 | I saw two types of I2C LCD modules. Those are two address each other normally => 0x27 or 0x3f.
39 |
40 | sudo i2cdetect -y 1
41 | 0 1 2 3 4 5 6 7 8 9 a b c d e f
42 | 00: -- -- -- -- -- -- -- -- -- -- -- -- --
43 | 10: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
44 | 20: -- -- -- -- -- -- -- 27 -- -- -- -- -- -- -- --
45 | 30: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
46 | 40: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
47 | 50: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
48 | 60: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
49 |
50 | edit line #22 in I2C_LCD_driver.py 0x27 or 0x3f.
51 |
52 | cd RetroPie-Clcd/
53 | sudo nano I2C_LCD_driver.py
54 |
55 | # LCD Address
56 | ADDRESS = 0x27 # or 0x3f
57 |
58 |
59 | * Raspberry Pi I2C GPIO Pinout
60 |
61 | 
62 |
63 | * http://forums.rasplay.org/topic/318/scrolling-game-title-for-retropie-v4-0-2-using-16x2-clcd-on-ras-console-pi
64 |
65 | ## Reference
66 | * https://retropie.org.uk/forum/topic/5061/scrolling-game-title-using-16x2-clcd-on-ras-console-pi
67 | * https://retropie.org.uk/forum/topic/2211/questions-about-runcommand-sh
68 | * https://retropie.org.uk/forum/topic/3134/meet-the-retrog-update-17-8-paintjob-pics
69 | * https://retropie.org.uk/forum/topic/3731/solved-variables-with-runcommand-onstart-sh
70 | * https://github.com/retropie/retropie-setup/wiki/runcommand
71 |
72 |
--------------------------------------------------------------------------------
/lcdScroll.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/python
2 | """
3 | lcdScroll.py
4 | Author : Eric Pavey
5 | Creation Date : 2014-02-08
6 | Blog : http://www.akeric.com/blog
7 |
8 | Free and open for all to use. But put credit where credit is due.
9 |
10 | OVERVIEW:-----------------------------------------------------------------------
11 | Create scrolling text on a LCD display. Designed to work on the the
12 | Adafruit LCD + keypad, but it's not tied to any specific hardware, and should
13 | work on a LCD of any size.
14 |
15 | See lcdScrollTest.py for simple example usage.
16 | """
17 |
18 | class Scroller(object):
19 | """
20 | Object designed to auto-scroll text on a LCD screen. Every time the scroll()
21 | method is called to, it will scroll the text from right to left by one character
22 | on any line that is greater than the provided with.
23 | If the lines ever need to be reset \ updated, call to the setLines() method.
24 | """
25 | def __init__(self, lines=[], space = " :: ", width=16, height=2):
26 | """
27 | Instance a LCD scroller object.
28 |
29 | Parameters:
30 | lines : list / string : Default empty list : If a list is passed in, each
31 | entry in the list is a string that should be displayed on the LCD,
32 | one line after the next. If a string, it will be split by any embedded
33 | linefeed \n characers into a list of multiple lines .
34 | Ultimately, the number of entries in this list must be equal to or
35 | less than the height argument.
36 | space : string : Default " :: " : If a given line is longer than the width
37 | argument, this string will be added to the end to help designate the
38 | end of the line has been hit during the scroll.
39 | width : int : Default 16 : The width of the LCD display, number of columns.
40 | height : int : Default 2 : the height of the LCD, number of rows.
41 | """
42 | self.width = width
43 | self.height = height
44 | self.space = space
45 | self.setLines(lines)
46 |
47 | def setLines(self, lines):
48 | """
49 | Set (for the first time) or reset (at any time) the lines to display.
50 | Sets self.lines
51 |
52 | Parameters:
53 | lines : list : Each entry in the list is a string
54 | that should be displayed on the LCD, one line after the next. The
55 | number of entries in this list must be equal to or less than the
56 | height argument.
57 | """
58 | # Just in case a string is passed in, turn it into a list, and split
59 | # by any linefeed chars:
60 | if isinstance(lines, basestring):
61 | lines = lines.split("\n")
62 | elif not isinstance(lines, list):
63 | raise Exception("Argument passed to lines parameter must be list, instead got: %s"%type(lines))
64 | if len(lines) > self.height:
65 | raise Exception("Have more lines to display (%s) than you have lcd rows (%s)"%(len(lines), height))
66 | self.lines = lines
67 | # If the line is over the width, add in the extra spaces to help separate
68 | # the scroll:
69 | for i,ln in enumerate(self.lines[:]):
70 | if len(ln) > self.width:
71 | self.lines[i] = "%s%s"%(ln,self.space)
72 |
73 | def scroll(self):
74 | """
75 | Scroll the text by one character from right to left each time this is
76 | called to.
77 |
78 | Return : string : The message to display to the LCD. Each line is separated
79 | by the \n (linefeed) character that the Adafruit LCD expects. Each line
80 | will also be clipped to self.width, so as to not confuse the LCD when
81 | later drawn.
82 | """
83 | for i,ln in enumerate(self.lines[:]):
84 | if len(ln) > 16:
85 | shift = "%s%s"%(ln[1:], ln[0])
86 | self.lines[i] = shift
87 | truncated = [ln[:self.width] for ln in self.lines]
88 | return "\n".join(truncated)
89 |
--------------------------------------------------------------------------------
/I2C_LCD_driver.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | # Original code found at:
3 | # https://gist.github.com/DenisFromHR/cc863375a6e19dce359d
4 |
5 | """
6 | Compiled, mashed and generally mutilated 2014-2015 by Denis Pleic
7 | Made available under GNU GENERAL PUBLIC LICENSE
8 |
9 | # Modified Python I2C library for Raspberry Pi
10 | # as found on http://www.recantha.co.uk/blog/?p=4849
11 | # Joined existing 'i2c_lib.py' and 'lcddriver.py' into a single library
12 | # added bits and pieces from various sources
13 | # By DenisFromHR (Denis Pleic)
14 | # 2015-02-10, ver 0.1
15 |
16 | """
17 |
18 | # i2c bus (0 -- original Pi, 1 -- Rev 2 Pi)
19 | I2CBUS = 1
20 |
21 | # LCD i2c Address 0x27 or 0x3f
22 | #ADDRESS = 0x27
23 | ADDRESS = 0x3f
24 |
25 | import smbus
26 | from time import sleep
27 |
28 | class i2c_device:
29 | def __init__(self, addr, port=I2CBUS):
30 | self.addr = addr
31 | self.bus = smbus.SMBus(port)
32 |
33 | # Write a single command
34 | def write_cmd(self, cmd):
35 | self.bus.write_byte(self.addr, cmd)
36 | sleep(0.0001)
37 |
38 | # Write a command and argument
39 | def write_cmd_arg(self, cmd, data):
40 | self.bus.write_byte_data(self.addr, cmd, data)
41 | sleep(0.0001)
42 |
43 | # Write a block of data
44 | def write_block_data(self, cmd, data):
45 | self.bus.write_block_data(self.addr, cmd, data)
46 | sleep(0.0001)
47 |
48 | # Read a single byte
49 | def read(self):
50 | return self.bus.read_byte(self.addr)
51 |
52 | # Read
53 | def read_data(self, cmd):
54 | return self.bus.read_byte_data(self.addr, cmd)
55 |
56 | # Read a block of data
57 | def read_block_data(self, cmd):
58 | return self.bus.read_block_data(self.addr, cmd)
59 |
60 |
61 | # commands
62 | LCD_CLEARDISPLAY = 0x01
63 | LCD_RETURNHOME = 0x02
64 | LCD_ENTRYMODESET = 0x04
65 | LCD_DISPLAYCONTROL = 0x08
66 | LCD_CURSORSHIFT = 0x10
67 | LCD_FUNCTIONSET = 0x20
68 | LCD_SETCGRAMADDR = 0x40
69 | LCD_SETDDRAMADDR = 0x80
70 |
71 | # flags for display entry mode
72 | LCD_ENTRYRIGHT = 0x00
73 | LCD_ENTRYLEFT = 0x02
74 | LCD_ENTRYSHIFTINCREMENT = 0x01
75 | LCD_ENTRYSHIFTDECREMENT = 0x00
76 |
77 | # flags for display on/off control
78 | LCD_DISPLAYON = 0x04
79 | LCD_DISPLAYOFF = 0x00
80 | LCD_CURSORON = 0x02
81 | LCD_CURSOROFF = 0x00
82 | LCD_BLINKON = 0x01
83 | LCD_BLINKOFF = 0x00
84 |
85 | # flags for display/cursor shift
86 | LCD_DISPLAYMOVE = 0x08
87 | LCD_CURSORMOVE = 0x00
88 | LCD_MOVERIGHT = 0x04
89 | LCD_MOVELEFT = 0x00
90 |
91 | # flags for function set
92 | LCD_8BITMODE = 0x10
93 | LCD_4BITMODE = 0x00
94 | LCD_2LINE = 0x08
95 | LCD_1LINE = 0x00
96 | LCD_5x10DOTS = 0x04
97 | LCD_5x8DOTS = 0x00
98 |
99 | # flags for backlight control
100 | LCD_BACKLIGHT = 0x08
101 | LCD_NOBACKLIGHT = 0x00
102 |
103 | En = 0b00000100 # Enable bit
104 | Rw = 0b00000010 # Read/Write bit
105 | Rs = 0b00000001 # Register select bit
106 |
107 | class lcd:
108 | #initializes objects and lcd
109 | def __init__(self):
110 | self.lcd_device = i2c_device(ADDRESS)
111 |
112 | self.lcd_write(0x03)
113 | self.lcd_write(0x03)
114 | self.lcd_write(0x03)
115 | self.lcd_write(0x02)
116 |
117 | self.lcd_write(LCD_FUNCTIONSET | LCD_2LINE | LCD_5x8DOTS | LCD_4BITMODE)
118 | self.lcd_write(LCD_DISPLAYCONTROL | LCD_DISPLAYON)
119 | self.lcd_write(LCD_CLEARDISPLAY)
120 | self.lcd_write(LCD_ENTRYMODESET | LCD_ENTRYLEFT)
121 | sleep(0.2)
122 |
123 |
124 | # clocks EN to latch command
125 | def lcd_strobe(self, data):
126 | self.lcd_device.write_cmd(data | En | LCD_BACKLIGHT)
127 | sleep(.0005)
128 | self.lcd_device.write_cmd(((data & ~En) | LCD_BACKLIGHT))
129 | sleep(.0001)
130 |
131 | def lcd_write_four_bits(self, data):
132 | self.lcd_device.write_cmd(data | LCD_BACKLIGHT)
133 | self.lcd_strobe(data)
134 |
135 | # write a command to lcd
136 | def lcd_write(self, cmd, mode=0):
137 | self.lcd_write_four_bits(mode | (cmd & 0xF0))
138 | self.lcd_write_four_bits(mode | ((cmd << 4) & 0xF0))
139 |
140 | # write a character to lcd (or character rom) 0x09: backlight | RS=DR<
141 | # works!
142 | def lcd_write_char(self, charvalue, mode=1):
143 | self.lcd_write_four_bits(mode | (charvalue & 0xF0))
144 | self.lcd_write_four_bits(mode | ((charvalue << 4) & 0xF0))
145 |
146 | # put string function with optional char positioning
147 | def lcd_display_string(self, string, line=1, pos=0):
148 | if line == 1:
149 | pos_new = pos
150 | elif line == 2:
151 | pos_new = 0x40 + pos
152 | elif line == 3:
153 | pos_new = 0x14 + pos
154 | elif line == 4:
155 | pos_new = 0x54 + pos
156 |
157 | self.lcd_write(0x80 + pos_new)
158 |
159 | for char in string:
160 | self.lcd_write(ord(char), Rs)
161 |
162 | # clear lcd and set to home
163 | def lcd_clear(self):
164 | self.lcd_write(0x0)
165 | self.lcd_write(LCD_CLEARDISPLAY)
166 | self.lcd_write(LCD_RETURNHOME)
167 |
168 | # define backlight on/off (lcd.backlight(1); off= lcd.backlight(0)
169 | def backlight(self, state): # for state, 1 = on, 0 = off
170 | if state == 1:
171 | self.lcd_device.write_cmd(LCD_BACKLIGHT)
172 | elif state == 0:
173 | self.lcd_device.write_cmd(LCD_NOBACKLIGHT)
174 |
175 | # add custom characters (0 - 7)
176 | def lcd_load_custom_chars(self, fontdata):
177 | self.lcd_write(0x40);
178 | for char in fontdata:
179 | for line in char:
180 | self.lcd_write_char(line)
181 |
182 | # define precise positioning (addition from the forum)
183 | def lcd_display_string_pos(self, string, line, pos):
184 | if line == 1:
185 | pos_new = pos
186 | elif line == 2:
187 | pos_new = 0x40 + pos
188 | elif line == 3:
189 | pos_new = 0x14 + pos
190 | elif line == 4:
191 | pos_new = 0x54 + pos
192 |
193 | self.lcd_write(0x80 + pos_new)
194 |
195 | for char in string:
196 | self.lcd_write(ord(char), Rs)
197 |
--------------------------------------------------------------------------------
/retropie_clcd.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/python
2 | """
3 | retropie_clcd.py
4 | Author : zzeromin, member of Raspberrypi Village
5 | Creation Date: Oct 11, 2016
6 | Blog : http://rasplay.org, http://forums.rasplay.org/, https://zzeromin.tumblr.com/
7 | Thanks to : smyani, zerocool, GreatKStar
8 |
9 | Free and open for all to use. But put credit where credit is due.
10 |
11 | #Reference:
12 | runcommand of Retorpie: https://github.com/retropie/retropie-setup/wiki/runcommand
13 | I2C_LCD_driver developed by: Denis Pleic ( https://gist.github.com/DenisFromHR/cc863375a6e19dce359d )
14 | IP_Script Developed by: AndyPi ( http://andypi.co.uk/ )
15 | lcdScroll Developed by: Eric Pavey ( https://bitbucket.org/AK_Eric/my-pi-projects/src/28302f8f5657599e29cb5d55573d192b9fa30265/Adafruit_CharLCDPlate/lcdScroll.py?at=master&fileviewer=file-view-default )
16 |
17 | #Notice:
18 | retropie_clcd.py require I2C_LCD_driver.py, lcdScroll.py
19 |
20 | Small script written in Python for Retropie project (https://retropie.org.uk/)
21 | running on Raspberry Pi 2,3, which displays all neccessary info on a 16x2 LCD display
22 | #Features:
23 | 1. Current date and time, IP address of eth0, wlan0
24 | 2. CPU temperature and speed
25 | 3. Emulation and ROM information
26 | """
27 |
28 | import I2C_LCD_driver
29 | import os
30 | from sys import exit
31 | from subprocess import *
32 | from time import *
33 | from datetime import datetime
34 | from lcdScroll import Scroller
35 |
36 | def run_cmd(cmd):
37 | # runs whatever is in the cmd variable in the terminal
38 | p = Popen(cmd, shell=True, stdout=PIPE)
39 | output = p.communicate()[0]
40 | return output
41 |
42 | def get_cpu_temp():
43 | tempFile = open("/sys/class/thermal/thermal_zone0/temp")
44 | cpu_temp = tempFile.read()
45 | tempFile.close()
46 | return float(cpu_temp)/1000
47 |
48 | def get_cpu_speed():
49 | tempFile = open("/sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq")
50 | cpu_speed = tempFile.read()
51 | tempFile.close()
52 | return float(cpu_speed)/1000
53 |
54 | mylcd = I2C_LCD_driver.lcd()
55 | mylcd.lcd_clear()
56 |
57 | #get ip address of eth0 connection
58 | cmdeth = "ip addr show eth0 | grep 'inet ' | awk '{print $2}' | cut -d/ -f1"
59 | #get ip address of wlan0 connection
60 | cmd = "ip addr show wlan0 | grep 'inet ' | awk '{print $2}' | cut -d/ -f1"
61 | #cmd = "ip addr show wlan1 | grep 'inet ' | awk '{print $2}' | cut -d/ -f1"
62 |
63 | old_Temp = new_Temp = get_cpu_temp()
64 | old_Speed = new_Speed = get_cpu_speed()
65 |
66 | icons = [
67 | [ 0b00000, 0b11111, 0b11011, 0b10001, 0b10001, 0b10001, 0b11111, 0b00000 ], # Ethernet
68 | [ 0b00000, 0b00000, 0b00001, 0b00001, 0b00101, 0b00101, 0b10101, 0b00000 ] # Wireless
69 | ]
70 |
71 | # Load logo chars (icons)
72 | mylcd.lcd_load_custom_chars(icons)
73 |
74 | mylcd.lcd_display_string("Welcome", 1, 5)
75 | mylcd.lcd_display_string("RAS Console Pi", 2, 1)
76 | sleep(5) # 5 sec delay
77 | mylcd.lcd_clear()
78 |
79 | mylcd.lcd_display_string("RPi Village", 1, 3)
80 | mylcd.lcd_display_string("www.rasplay.org", 2, 1)
81 | sleep(5) # 5 sec delay
82 | mylcd.lcd_clear()
83 |
84 | mylcd.lcd_display_string("cafe.naver.com/", 1, 1)
85 | mylcd.lcd_display_string("raspigamer", 2, 3)
86 | sleep(5) # 5 sec delay
87 | mylcd.lcd_clear()
88 |
89 | while 1:
90 |
91 | mylcd.lcd_clear()
92 | sec = 0
93 | while ( sec < 5 ) :
94 | # wlan ip address
95 | ipaddr = run_cmd(cmd).replace("\n","")
96 |
97 | # selection of wlan or eth address
98 | length = len(ipaddr)
99 | space = ""
100 |
101 | if length == 0 :
102 | ipaddr = run_cmd(cmdeth).replace("\n","")
103 |
104 | if len(ipaddr) == 0 :
105 | ipaddr = unichr(0)+unichr(1)+" Not connected"
106 | else:
107 | if len(ipaddr) == 15 :
108 | ipaddr = unichr(0)+run_cmd(cmdeth)
109 | else :
110 | for i in range( 15-len(ipaddr) ) :
111 | space = space + " "
112 | ipaddr = unichr(0)+space+run_cmd(cmdeth)
113 |
114 | else :
115 | if len(ipaddr) == 15 :
116 | ipaddr = unichr(1)+run_cmd(cmd)
117 | else :
118 | for i in range( 15-len(ipaddr) ) :
119 | space = space + " "
120 | ipaddr = unichr(1)+space+run_cmd(cmd)
121 |
122 | #print datetime.now().strftime( "%b %d %H:%M:%S" )
123 | #print "IP " + str( ipaddr )
124 | mylcd.lcd_display_string( datetime.now().strftime( "%b %d %H:%M:%S" ), 1, 0 )
125 | mylcd.lcd_display_string( ipaddr, 2, 0 )
126 | sec = sec + 1
127 | sleep(1)
128 |
129 | mylcd.lcd_clear()
130 | sec = 0
131 | while ( sec < 5 ) :
132 | space = ""
133 | # cpu Temp & Speed information
134 | new_Temp = get_cpu_temp()
135 | new_Speed = int( get_cpu_speed() )
136 |
137 | if old_Temp != new_Temp or old_Speed != new_Speed :
138 | old_Temp = new_Temp
139 | old_Speed = new_Speed
140 | #print "CPU Temp: " + str( new_Temp )
141 | #print "CPU Speed: " + str( new_Speed )
142 | for i in range( 5 - len( str(new_Speed) ) ) :
143 | space = space + " "
144 | mylcd.lcd_display_string( "CPU Temp :" + str( new_Temp ), 1, 0 )
145 | mylcd.lcd_display_string( "CPU Speed: " + space + str( new_Speed ), 2, 0 )
146 | sec = sec + 1
147 | sleep(1)
148 |
149 | mylcd.lcd_clear()
150 | sec = 0
151 | while ( sec < 5 ) :
152 | # show system & rom file information
153 |
154 | try:
155 | f = open('/dev/shm/runcommand.log', 'r')
156 | # except FileNotFoundError:
157 | except IOError:
158 | mylcd.lcd_display_string( "You should play", 1, 0 )
159 | mylcd.lcd_display_string( "a game first!!", 2, 0 )
160 | sleep(3)
161 | break
162 | pass
163 | else:
164 | system = f.readline()
165 | system = system.replace("\n","")
166 | systemMap = {
167 | "Berrycade":"Berrycade",
168 | "fba":"FinalBurn Alpha",
169 | "gba":"GameBoy Advance",
170 | "kodi":"KODI",
171 | "mame-mame4all":"MAME4ALL",
172 | "mame-advmame":"AdvanceMAME",
173 | "mame-libretro":"MAME-libretro",
174 | "msx":"MSX",
175 | "nes":"Famicom", # Nintendo Entertainment System
176 | "psp":"PSPortable", # PlayStation Portable
177 | "psx":"Playstation",
178 | "ports":"Ports",
179 | "snes":"Super Famicom", # Super Nintendo Entertainment System
180 | "notice":"TURN OFF",
181 | }
182 | system = systemMap.get(system)
183 | rom = f.readline()
184 | rom = rom.replace("\n","")
185 | mylcd.lcd_display_string( rom[0:16], 1 )
186 | mylcd.lcd_display_string( rom[16:32], 2 )
187 | # mylcd.lcd_display_string( "%s" %(rom), 2 )
188 | # mylcd.lcd_display_string( "%s" %(system), 1, 0 )
189 | sec = sec + 1
190 | sleep(1)
191 | f.close()
192 |
193 | flag = "TURN OFF"
194 | lines = rom
195 | """
196 | wait = 0
197 | speed = 0.1
198 |
199 | # Create scroller instance:
200 | scroller = Scroller(lines=lines)
201 |
202 | while True :
203 | if wait < 10 and system != flag:
204 | message = scroller.scroll()
205 | mylcd.lcd_display_string( "%s" %(system), 1, 0 )
206 | mylcd.lcd_display_string( "%s" %(message), 2 )
207 | sleep(speed)
208 | wait = wait + 0.1
209 | else :
210 | break
211 | sec = sec + 1
212 | sleep(1)
213 | """
214 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | {project} Copyright (C) {year} {fullname}
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------