├── A125_User_Manuel_revise_04.pdf ├── AP-UMzzzz(R,T)zzzz-zzzzzT.pdf ├── lcd_preinit.sc ├── lcd_preinit.sh ├── lcd_shutdown.sc ├── lcd_shutdown.sh ├── lcd_postinit.sh ├── lcd_postinit.sc ├── README.md ├── _lcd-functions.ksh ├── lcd-control.ksh └── LICENSE /A125_User_Manuel_revise_04.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/elvisimprsntr/QnapFreeLCD/HEAD/A125_User_Manuel_revise_04.pdf -------------------------------------------------------------------------------- /AP-UMzzzz(R,T)zzzz-zzzzzT.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/elvisimprsntr/QnapFreeLCD/HEAD/AP-UMzzzz(R,T)zzzz-zzzzzT.pdf -------------------------------------------------------------------------------- /lcd_preinit.sc: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | NAME="`hostname -s`" 4 | 5 | #stty -f /dev/cuau1.lock 1200 6 | #stty -f /dev/cuau1.init 1200 7 | stty -F /dev/ttyS1 1200 8 | 9 | # clear display 10 | printf '\115\015' > /dev/ttyS1 11 | sleep 1 12 | 13 | # turn on display 14 | printf '\115\136\001' > /dev/ttyS1 15 | sleep 1 16 | 17 | # print hostname on line 1 18 | printf '\115\014\000 '$NAME > /dev/ttyS1 19 | sleep 1 20 | 21 | # print message on line 2 22 | printf '\115\014\001 System Booting' > /dev/ttyS1 23 | 24 | -------------------------------------------------------------------------------- /lcd_preinit.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | NAME="`hostname -s`" 4 | 5 | stty -f /dev/cuau1.lock 1200 6 | stty -f /dev/cuau1.init 1200 7 | stty -f /dev/cuau1 1200 8 | 9 | # clear display 10 | printf '\115\015' > /dev/cuau1 11 | sleep 1 12 | 13 | # turn on display 14 | printf '\115\136\001' > /dev/cuau1 15 | sleep 1 16 | 17 | # print hostname on line 1 18 | printf '\115\014\000 '$NAME > /dev/cuau1 19 | sleep 1 20 | 21 | # print message on line 2 22 | printf '\115\014\001 System Booting' > /dev/cuau1 23 | 24 | -------------------------------------------------------------------------------- /lcd_shutdown.sc: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | NAME="`hostname -s`" 4 | 5 | #stty -f /dev/cuau1.lock 1200 6 | #stty -f /dev/cuau1.init 1200 7 | stty -F /dev/ttyS1 1200 8 | 9 | # clear display 10 | printf '\115\015' > /dev/ttyS1 11 | sleep 1 12 | 13 | # turn on display 14 | printf '\115\136\001' > /dev/ttyS1 15 | sleep 1 16 | 17 | # print hostname on line 1 18 | printf '\115\014\000 '$NAME > /dev/ttyS1 19 | sleep 1 20 | 21 | # print message on line 2 22 | printf '\115\014\001 Shutting Down' > /dev/ttyS1 23 | 24 | -------------------------------------------------------------------------------- /lcd_shutdown.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | NAME="`hostname -s`" 4 | 5 | stty -f /dev/cuau1.lock 1200 6 | stty -f /dev/cuau1.init 1200 7 | stty -f /dev/cuau1 1200 8 | 9 | # clear display 10 | printf '\115\015' > /dev/cuau1 11 | sleep 1 12 | 13 | # turn on display 14 | printf '\115\136\001' > /dev/cuau1 15 | sleep 1 16 | 17 | # print hostname on line 1 18 | printf '\115\014\000 '$NAME > /dev/cuau1 19 | sleep 1 20 | 21 | # print message on line 2 22 | printf '\115\014\001 Shutting Down' > /dev/cuau1 23 | 24 | -------------------------------------------------------------------------------- /lcd_postinit.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | NAME="`hostname -s`" 4 | 5 | stty -f /dev/cuau1.lock 1200 6 | stty -f /dev/cuau1.init 1200 7 | stty -f /dev/cuau1 1200 8 | 9 | # clear display 10 | printf '\115\015' > /dev/cuau1 11 | sleep 1 12 | 13 | # turn on display 14 | printf '\115\136\001' > /dev/cuau1 15 | sleep 1 16 | 17 | # print hostname on line 1 18 | printf '\115\014\000 '$NAME > /dev/cuau1 19 | sleep 1 20 | 21 | # print message on line 2 22 | printf '\115\014\001 Startup Complete' > /dev/cuau1 23 | sleep 30 24 | 25 | # turn off display 26 | printf '\115\136\000' > /dev/cuau1 27 | 28 | -------------------------------------------------------------------------------- /lcd_postinit.sc: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | NAME="`hostname -s`" 4 | 5 | #stty -f /dev/cuau1.lock 1200 6 | #stty -f /dev/cuau1.init 1200 7 | stty -F /dev/ttyS1 1200 8 | 9 | # clear display 10 | printf '\115\015' > /dev/ttyS1 11 | sleep 1 12 | 13 | # turn on display 14 | printf '\115\136\001' > /dev/ttyS1 15 | sleep 1 16 | 17 | # print hostname on line 1 18 | printf '\115\014\000 '$NAME > /dev/ttyS1 19 | sleep 1 20 | 21 | # print message on line 2 22 | printf '\115\014\001 Startup Complete' > /dev/ttyS1 23 | sleep 30 24 | 25 | # turn off display 26 | printf '\115\136\000' > /dev/ttyS1 27 | 28 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | QnapFreeLCD 2 | =========== 3 | Original author Dirk Brenken (dibdot@gmail.com) 4 | 5 | 6 | WARNING 7 | ======== 8 | This is a beta version, at the time of writing it was only tested on a TS-453A. 9 | https://www.techpowerup.com/review/qnap-ts-453a/ 10 | 11 | This script is only for QNAP-devices running TrueNAS CORE (stock QNAP firmware is not supported!). 12 | 13 | SCOPE 14 | ====== 15 | This script does (should do ;-) the following: 16 | - read input for LCD status messages from a separate helper script (see sample function library) 17 | - display status messages on LCD panel 18 | - auto-cycling through status messages 19 | - non-blocking manual navigation via LCD front panel buttons between messages 20 | - fully configurable input-, message-,display- cycles & timeouts 21 | 22 | REQUIREMENTS 23 | ============= 24 | - QNAP device with LCD display & TrueNAS CORE 25 | 26 | GET STARTED 27 | ============ 28 | - Make this script executable (chmod a+x). 29 | - Adjust path & timeout parameters to your needs (see comments for all configurable options below) 30 | - Rename & adjust distributed sample function library script to your needs 31 | - Start this script ... 32 | 33 | CHANGELOG 34 | ========== 35 | version 0.1: initial test release for TrueNAS CORE 36 | 37 | TODO 38 | ===== 39 | - Add HD temps 40 | - Add multiple zfs pools 41 | 42 | -------------------------------------------------------------------------------- /_lcd-functions.ksh: -------------------------------------------------------------------------------- 1 | #!/usr/local/bin/ksh93 2 | # 3 | # function library sample for lcd-control 4 | # original author Dirk Brenken (dibdot@gmail.com) 5 | # 6 | # LICENSE 7 | # ============ 8 | # QnapFreeLcd Copyright (C) 2014 Dirk Brenken and Justin Duplessis 9 | # 10 | # This program is free software: you can redistribute it and/or modify 11 | # it under the terms of the GNU General Public License as published by 12 | # the Free Software Foundation, either version 3 of the License, or 13 | # any later version. 14 | # 15 | # This program is distributed in the hope that it will be useful, 16 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 17 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 | # GNU General Public License for more details. 19 | # 20 | # You should have received a copy of the GNU General Public License 21 | # along with this program. If not, see . 22 | # 23 | # GET STARTED 24 | # ============ 25 | # This is a sample script to gather and prepare system information for a QNAP TS-453A box with 2x16 LCD display. 26 | # It's a helper script which will be automatically sourced by lcd-control.ksh during runtime as input. 27 | # All query results have to fill up the "ROW" array and increment the array index accordingly. 28 | # Please make sure, that the result sets match your LCD dimensions/rows, 29 | # For most QNAP boxes (maybe all?) every single result set should consist of two rows. 30 | # Please keep in mind, that this function library acts as a normal shell script, 31 | # therefore it might be a good idea to test your queries and result sets stand alone before lcd-control.ksh integration. 32 | # Feel free to build your own system queries and result sets (see examples below). 33 | # Contributions for other QNAP boxes or better examples to enlarge this function library are very welcome! 34 | 35 | # enable shell debug mode 36 | # 37 | #set -x 38 | 39 | # treats unset variables as an error 40 | # 41 | set -u 42 | 43 | # reset pre-defined message array 44 | # 45 | set -A ROW 46 | 47 | #------------------------------------------------------------------------------- 48 | # 1. network 49 | # get host and ip address 50 | #------------------------------------------------------------------------------- 51 | # 52 | # get current index count as start value 53 | INDEX=${#ROW[@]} 54 | # query 55 | HOST="$(hostname -s)" 56 | IP=$(ifconfig igb1 | grep "inet " | cut -f 2 -d " " | grep -v "127.0.") 57 | # result 58 | ROW[${INDEX}]="${HOST}" 59 | (( INDEX ++ )) 60 | ROW[${INDEX}]="${IP}" 61 | 62 | #------------------------------------------------------------------------------- 63 | # 2. os/kernel 64 | # get kernel and OS information 65 | #------------------------------------------------------------------------------- 66 | # 67 | # get current index count as start value 68 | INDEX=${#ROW[@]} 69 | # query 70 | OS_LINE="Unknown"; 71 | if [ -f /etc/version ];then 72 | OS_LINE=$(cut -d' ' -f1 /etc/version) 73 | else 74 | echo "Could not find proper file to retrieve OS info." 75 | fi 76 | #kernel info 77 | KERNEL=$(uname -r) 78 | # result 79 | ROW[${INDEX}]=$OS_LINE 80 | (( INDEX ++ )) 81 | ROW[${INDEX}]="${KERNEL}" 82 | 83 | #------------------------------------------------------------------------------- 84 | # 4. Pool info (zfs) 85 | # detect which is installed and how many pools are present 86 | #------------------------------------------------------------------------------- 87 | # 88 | ZFS_POOLS=0 89 | R_DEVICES="" 90 | 91 | if (( $(whereis zfs | wc -w) != 1 )) 92 | then 93 | ZFS_POOLS=$(zpool list -H | wc -l) 94 | echo "Found $ZFS_POOLS zfs pools !" 95 | fi 96 | 97 | 98 | #------------------------------------------------------------------------------- 99 | # 4.1 Pool info zfs 100 | # TODO add support for multiple pools ? 101 | #------------------------------------------------------------------------------- 102 | # 103 | # get current index count as start value 104 | if (( $ZFS_POOLS > 0 )) 105 | then 106 | INDEX=${#ROW[@]} 107 | # query 108 | PREV_TOTAL=0 109 | PREV_IDLE=0 110 | FREE=$(zpool list -H data | cut -f 4) 111 | HEALTH=$(zpool list -H data | cut -f 10) 112 | CAP=$(zpool list -H data | cut -f 8) 113 | # result 114 | ROW[${INDEX}]="$(zpool list -H data | cut -f 1) $(zpool list -H data | cut -f 2)" 115 | (( INDEX ++ )) 116 | ROW[${INDEX}]="$FREE $HEALTH" 117 | (( INDEX ++ )) 118 | R_DEVICES=$(ls -l /dev/ada[0-9] | awk '{print$9}') 119 | echo $R_DEVICES 120 | fi 121 | 122 | #------------------------------------------------------------------------------- 123 | # 5. HDD temps 124 | # get hdd temperature (re-use device information from zfs) 125 | #------------------------------------------------------------------------------- 126 | # 127 | # get current index count as start value 128 | if [ "$R_DEVICES" != "" ]; then 129 | INDEX=${#ROW[@]} 130 | # query 131 | DEVICES="${R_DEVICES}" 132 | DRIVE_TEMPS=$(smartctl -A ${DEVICES} | grep Temperature_Celsius | awk '{print$10}') 133 | # result 134 | ROW[${INDEX}]="Drive Temps" 135 | (( INDEX ++ )) 136 | ROW[${INDEX}]="$DRIVE_TEMPS" 137 | (( INDEX ++ )) 138 | else 139 | echo "No devices were found to probe for temperature !" 140 | fi 141 | #------------------------------------------------------------------------------- 142 | # 6. CPU load 143 | # get current cpu load 144 | #------------------------------------------------------------------------------- 145 | # 146 | # get current index count as start value 147 | INDEX=${#ROW[@]} 148 | # query 149 | PREV_TOTAL=0 150 | PREV_IDLE=0 151 | # result 152 | ROW[${INDEX}]="Load Average" 153 | (( INDEX ++ )) 154 | ROW[${INDEX}]=$(uptime | awk -F'load averages: ' '{ print $2 }') 155 | (( INDEX ++ )) 156 | 157 | #------------------------------------------------------------------------------- 158 | # 7. update 159 | # display uptime 160 | #------------------------------------------------------------------------------- 161 | # 162 | # get current index count as start value 163 | INDEX=${#ROW[@]} 164 | # query 165 | PREV_TOTAL=0 166 | PREV_IDLE=0 167 | # result 168 | ROW[${INDEX}]="Uptime" 169 | (( INDEX ++ )) 170 | ROW[${INDEX}]=$(uptime | grep -ohe 'up .*' | sed 's/,//g' | awk '{ print $2" "$3 }') 171 | (( INDEX ++ )) 172 | 173 | #------------------------------------------------------------------------------- 174 | # 8. last update 175 | # display the data update time 176 | #------------------------------------------------------------------------------- 177 | # 178 | # get current index count as start value 179 | INDEX=${#ROW[@]} 180 | # query 181 | PREV_TOTAL=0 182 | PREV_IDLE=0 183 | # result 184 | ROW[${INDEX}]="Last Updated" 185 | (( INDEX ++ )) 186 | ROW[${INDEX}]=$(date +"%H:%M %D") 187 | (( INDEX ++ )) 188 | -------------------------------------------------------------------------------- /lcd-control.ksh: -------------------------------------------------------------------------------- 1 | #!/usr/local/bin/ksh93 2 | # 3 | # lcd-control 4 | # Copyright (C) 2014, written by Dirk Brenken (dibdot@gmail.com) 5 | # 6 | # LICENSE 7 | # ======== 8 | # This program is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | # 13 | # This program is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU General Public License for more details. 17 | # 18 | # You should have received a copy of the GNU General Public License 19 | # along with this program. If not, see . 20 | # 21 | # WARNING 22 | # ======== 23 | # This is a developer version, at the time of writing it was only tested on a few QNAP devices (TS-453A). 24 | # This script is only for QNAP-devices running TrueNAS CORE (stock QNAP firmware currently not supported!). 25 | # 26 | # SCOPE 27 | # ====== 28 | # Main script features: 29 | # - read input for LCD status messages from a separate helper script (see sample function library) 30 | # - display status messages on LCD panel 31 | # - auto-cycling through status messages 32 | # - non-blocking manual navigation via LCD frontpanel buttons between messages 33 | # - error handling & logging to stdout/logfile (incl. logfile housekeeping) 34 | # - fully configurable input-, message-,display- cycles & timeouts 35 | # 36 | # REQUIREMENTS 37 | # ============= 38 | # - QNAP device with LCD display, migrated to TrueNAS CORE 39 | # 40 | # GET STARTED 41 | # ============ 42 | # Make this script executable (chmod a+w) 43 | # Adjust script parameters to your needs (see comments for all configurable options below) 44 | # Rename & adjust distributed sample function library script to your needs 45 | # Start the script ... 46 | # 47 | # AUTOSTART 48 | # ========== 49 | # To start the script automatically during boot, simply add an appropriate entry to /etc/rc.local 50 | # example: //lcd-control.ksh & 51 | # Please modify INP_DIR and LOG_DIR to accordingly 52 | # 53 | 54 | # enable shell debug mode 55 | # 56 | #set -x 57 | 58 | # treats unset variables as an error 59 | # 60 | set -u 61 | 62 | # script basics 63 | # 64 | SCRIPT_VER="0.6" 65 | SCRIPT_PID=$$ 66 | 67 | # tty settings 68 | # TTY_PRG => reference to stty program (default: /bin/stty) 69 | # TTY_TIMEOUT => tty read timeout in tenths of a second (default: 10) 70 | # 71 | TTY_PRG="/bin/stty" 72 | TTY_TIMEOUT=10 73 | TTY_MIN=0 74 | 75 | # input settings 76 | # INP_DIR => reference to input directory (default: current directory) 77 | # INP_FILE => reference to function library (default: _lcd-functions.ksh) 78 | # INP_PIPE => reference to named pipe (default: /var/run/lcd.pipe) 79 | # INP_TIMEOUT => input refresh timeout in seconds (default: 60), "0" (without quotes) to disable input auto-refresh 80 | # INP_FD => number of used file descriptor for named pipe (default: 5) 81 | # 82 | INP_DIR="." 83 | INP_FILE="_lcd-functions.ksh" 84 | INP_PIPE="/var/run/lcd.pipe" 85 | INP_TIMEOUT=60 86 | INP_FD=5 87 | INP_BUFFER="" 88 | INP_RT=0 89 | INP_ID=0 90 | 91 | # display environment/control codes 92 | # LCD_DEV => LCD device node (default: /dev/ttyS1) 93 | # LCD_BAUD => BAUD rate for LCD display (default: 1200) 94 | # LCD_MAXROW => number of display rows (default: 2) 95 | # LCD_MAXCOL => number of display cols (default:16) 96 | # LCD_TIMEOUT => timeout of the LCD in seconds (default: 300), "0" (without quotes) to disable LCD timeout 97 | # 98 | LCD_DEV="/dev/cuau1" 99 | LCD_BAUD=1200 100 | LCD_MAXROW=2 101 | LCD_MAXCOL=16 102 | LCD_TIMEOUT=300 103 | LCD_ON="M\x5E\x1" 104 | LCD_OFF="M\x5E\x0" 105 | LCD_CODE="M\x0C\x" 106 | LCD_CLEAR="M\x0D" 107 | LCD_RESET="M\xFF" 108 | LCD_RT=0 109 | LCD_ID=0 110 | 111 | # message settings 112 | # MSG_TIMEOUT => timeout between the message blocks (default: 5), "0" (without quotes) to disable message auto-cycling 113 | # 114 | MSG_TIMEOUT=5 115 | MSG_FILLER=" " 116 | MSG_RT=0 117 | MSG_ID=0 118 | 119 | # logfile settings 120 | # LOG_DIR => reference to logfile directory (default: current directory) 121 | # LOG_FILE => reference to logfile (default: lcd-control.log), keep it empty to write to stdout 122 | # LOG_HISTORY => delete logfiles older than n days (default: 5) 123 | # 124 | LOG_DIR="." 125 | LOG_FILE="lcd-control.log" 126 | LOG_HISTORY=5 127 | LOG_COUNT=0 128 | 129 | #===============================================================================# 130 | # please do not change anything after this line! # 131 | #===============================================================================# 132 | 133 | #===============================================================================# 134 | # functions # 135 | #===============================================================================# 136 | # function for basic trap handling 137 | # 138 | function f_trap_exit 139 | { 140 | #set -x 141 | # kill nav_pipe process 142 | kill -9 ${BG_PID} 143 | # close custom file descriptor 144 | exec {INP_FD}<&- 145 | exec {INP_FD}>&- 146 | # remove pipe from filesystem 147 | if [[ -f "${INP_PIPE}" || -p "${INP_PIPE}" ]] 148 | then 149 | rm -f "${INP_PIPE}" 150 | fi 151 | # clear LCD display & lights out 152 | printf "${LCD_CLEAR}" > "${LCD_DEV}" 153 | printf "${LCD_OFF}" > "${LCD_DEV}" 154 | # write message to log device and kill script 155 | LOG_MSG[0]="Info => normal program termination!" 156 | f_logwrite 157 | kill -9 ${SCRIPT_PID} 158 | } 159 | 160 | # function to get button input and write it to nav pipe 161 | # 162 | function f_nav_pipe 163 | { 164 | #set -x 165 | while : 166 | do 167 | # read button input 168 | INP_NAV=$(cat -vet "${LCD_DEV}") 169 | if [[ -n "${INP_NAV}" ]] 170 | then 171 | # filter/replace input stream 172 | INP_NAV="${INP_NAV//[!A-B]/}" 173 | INP_NAV="${INP_NAV//A/UP }" 174 | INP_NAV="${INP_NAV//B/DOWN }" 175 | # send only vaild input to nav pipe/custom file descriptor 176 | if [[ -n "${INP_NAV}" ]] 177 | then 178 | NAV_RT=0 179 | printf "%s\n" "${INP_NAV}" >&${INP_FD} 180 | printf "%s\n" "" >&${INP_FD} 181 | fi 182 | fi 183 | done 184 | } 185 | 186 | # function for log writing and logfile housekeeping 187 | # 188 | function f_logwrite 189 | { 190 | #set -x 191 | if [[ -n "${LOG_FILE}" ]] 192 | then 193 | # generate separate logfile per day 194 | LOG_DATE=$(date "+%Y%m%d") 195 | LOG_DEVICE="${LOG_DIR}/${LOG_FILE}.${LOG_DATE}" 196 | # logfile housekeeping 197 | if [[ ! -f "${LOG_DEVICE}" ]] 198 | then 199 | DELETE_COUNT=$(find "${LOG_DIR}" -maxdepth 1 -type f -mtime +${LOG_HISTORY} -name "${LOG_FILE}.*" 2>/dev/null | wc -l) 200 | if (( DELETE_COUNT > 0 )) 201 | then 202 | # delete logfiles older than n days 203 | find "${LOG_DIR}" -maxdepth 1 -type f -mtime +${LOG_HISTORY} -name "${LOG_FILE}.*" -print0 2>/dev/null | xargs -0 rm -f >/dev/null 2>&1 204 | if (( $? == 0 )) 205 | then 206 | LOG_MSG[0]="Info => ${DELETE_COUNT} logfiles deleted!" 207 | else 208 | LOG_MSG[0]="Error => old logfiles could not be deleted!" 209 | fi 210 | fi 211 | # reset log counter 212 | LOG_COUNT=0 213 | fi 214 | else 215 | # no logfile defined, redirect to stdout 216 | LOG_DEVICE="/dev/stdout" 217 | fi 218 | # write static header 219 | if (( LOG_COUNT == 0 )) 220 | then 221 | printf "%s\n" "lcd-control, version ${SCRIPT_VER}" >> "${LOG_DEVICE}" 222 | printf "%s\n" "Copyright (C) 2014, written by Dirk Brenken (dibdot@gmail.com)" >> "${LOG_DEVICE}" 223 | printf "%s\n" "This program is distributed in the hope that it will be useful," >> "${LOG_DEVICE}" 224 | printf "%s\n" "but WITHOUT ANY WARRANTY; without even the implied warranty of" >> "${LOG_DEVICE}" 225 | printf "%s\n" "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the" >> "${LOG_DEVICE}" 226 | printf "%s\n" "GNU General Public License for more details." >> "${LOG_DEVICE}" 227 | printf "%s\n" "==============================================================" >> "${LOG_DEVICE}" 228 | LOG_COUNT=1 229 | fi 230 | # write log message array 231 | LOG_INDEX=0 232 | MAX_INDEX=${#LOG_MSG[@]} 233 | while (( LOG_INDEX < MAX_INDEX )) 234 | do 235 | if [[ -n "${LOG_MSG[${LOG_INDEX}]}" ]] 236 | then 237 | LOG_DATE=$(date "+%Y%m%d %H:%M:%S") 238 | printf "%s\n" "${LOG_DATE} ${LOG_MSG[${LOG_INDEX}]}" >> "${LOG_DEVICE}" 239 | fi 240 | (( LOG_INDEX++ )) 241 | done 242 | # write static footer and reset log message array 243 | printf "%s\n" "--------------------------------------------------------------" >> "${LOG_DEVICE}" 244 | unset LOG_MSG 245 | } 246 | 247 | #===============================================================================# 248 | # main program # 249 | #===============================================================================# 250 | # call trap function (EXIT, HUP, INT, QUIT, BUS, SEGV, TERM) 251 | # 252 | trap "f_trap_exit" 0 1 2 3 10 11 15 253 | 254 | # prepare serial communication (send & receive) 255 | # 256 | "${TTY_PRG}" -f "${LCD_DEV}" ${LCD_BAUD} cread cbreak time ${TTY_TIMEOUT} min ${TTY_MIN} 257 | if (( $? == 0 )) 258 | then 259 | LOG_MSG[0]="Info => serial port initialized!" 260 | f_logwrite 261 | else 262 | LOG_MSG[0]="Error => serial port could not be initialized!" 263 | f_logwrite 264 | f_trap_exit 265 | fi 266 | 267 | # create named pipe 268 | # 269 | if [[ ! -p "${INP_PIPE}" ]] 270 | then 271 | mkfifo "${INP_PIPE}" 272 | if (( $? == 0 )) 273 | then 274 | LOG_MSG[0]="Info => named pipe initialized!" 275 | f_logwrite 276 | else 277 | LOG_MSG[0]="Error => named pipe could not be initialized!" 278 | f_logwrite 279 | f_trap_exit 280 | fi 281 | else 282 | LOG_MSG[0]="Error => named pipe already running!" 283 | f_logwrite 284 | f_trap_exit 285 | fi 286 | 287 | # assign nav pipe to custom file descriptor 288 | # 289 | exec {INP_FD}<> "${INP_PIPE}" 290 | 291 | # start nav pipe function in background and get PID 292 | # 293 | f_nav_pipe & 294 | BG_PID=$! 295 | 296 | # initialize LCD display at beginning 297 | # 298 | printf "${LCD_RESET}" > "${LCD_DEV}" 299 | printf "${LCD_ON}" > "${LCD_DEV}" 300 | LOG_MSG[0]="Info => startup LCD display!" 301 | f_logwrite 302 | 303 | #===============================================================================# 304 | # main (endless) loop # 305 | #===============================================================================# 306 | while : 307 | do 308 | # input preparation 309 | # 310 | if (( INP_ID == 0 )) 311 | then 312 | INP_ID=1 313 | if [[ -f "${INP_DIR}/${INP_FILE}" ]] 314 | then 315 | # source/execute function library 316 | # 317 | 318 | # check if helper script exists 319 | if [[ -x "${INP_DIR}/${INP_FILE}" ]] 320 | then 321 | . ${INP_DIR}/${INP_FILE} 322 | LOG_MSG[0]="Info => (re-)read input!" 323 | f_logwrite 324 | elif [[ -e "${INP_DIR}/${INP_FILE}" ]] 325 | then 326 | ROW[0]="${INP_DIR}/${INP_FILE}" 327 | ROW[1]="Fix permissions" 328 | ROW[2]="${INP_DIR}/${INP_FILE}" 329 | ROW[3]="chmod +x" 330 | LOG_MSG[0]="Error => Helper file '${INP_DIR}/${INP_FILE}' not executable ! Please fix permissions" 331 | f_logwrite 332 | else 333 | ROW[0]="${INP_DIR}/${INP_FILE}" 334 | ROW[1]="does not exist" 335 | ROW[2]="${INP_DIR}/${INP_FILE}" 336 | ROW[3]="Create file" 337 | LOG_MSG[0]="Error => Helper file '${INP_DIR}/${INP_FILE}' does not exist ! Please create helper file or fallback to default script" 338 | f_logwrite 339 | fi 340 | 341 | # prepare raw messages for log writing 342 | # 343 | LOG_INDEX=0 344 | for (( INDEX=0; INDEX <= (( ${#ROW[@]} - LCD_MAXROW )); )) 345 | do 346 | LOG_MSG[${LOG_INDEX}]= 347 | INDEX_NEW=$(( INDEX + LCD_MAXROW )) 348 | until (( INDEX == INDEX_NEW )) 349 | do 350 | if [[ -n "${LOG_MSG[${LOG_INDEX}]}" ]] 351 | then 352 | LOG_MSG[${LOG_INDEX}]="${LOG_MSG[${LOG_INDEX}]} => ${ROW[${INDEX}]}" 353 | else 354 | LOG_MSG[${LOG_INDEX}]="$(printf "%-${LCD_MAXCOL}s" "${ROW[${INDEX}]}")" 355 | fi 356 | (( INDEX++ )) 357 | done 358 | (( LOG_INDEX++ )) 359 | done 360 | f_logwrite 361 | 362 | # prepare messages for LCD output 363 | # 364 | for INDEX in "${!ROW[@]}" 365 | do 366 | MSG="${ROW[${INDEX}]}" 367 | # set/cut message to max display length 368 | MSG_LEN=${#MSG} 369 | if (( MSG_LEN < LCD_MAXCOL )) 370 | then 371 | until (( MSG_LEN == LCD_MAXCOL )) 372 | do 373 | MSG="${MSG}${MSG_FILLER}" 374 | (( MSG_LEN ++ )) 375 | done 376 | elif (( MSG_LEN > LCD_MAXCOL )) 377 | then 378 | MSG="${MSG:0:${LCD_MAXCOL}}" 379 | fi 380 | # escape special message characters 381 | MSG="${MSG//\%/\\%}" 382 | # write modified message back to array 383 | ROW[${INDEX}]="${MSG}" 384 | done 385 | # reset index 386 | INDEX=0 387 | else 388 | # write error to log device and exit 389 | LOG_MSG[0]="Error => function library not found!" 390 | f_logwrite 391 | f_trap_exit 392 | fi 393 | fi 394 | 395 | # message output 396 | # 397 | if (( MSG_ID == 0 )) 398 | then 399 | MSG_ID=1 400 | LCD_ROW=0 401 | # reset index at the end of the array 402 | if (( INDEX == ${#ROW[@]} )) 403 | then 404 | INDEX=0 405 | fi 406 | INDEX_OLD=$(( INDEX )) 407 | INDEX_NEW=$(( INDEX + LCD_MAXROW )) 408 | while (( INDEX < INDEX_NEW )) 409 | do 410 | # due to LCD timing issues send message twice per row 411 | printf "${LCD_CODE}${LCD_ROW} ${ROW[${INDEX}]}" > "${LCD_DEV}" 412 | printf "${LCD_CODE}${LCD_ROW} ${ROW[${INDEX}]}" > "${LCD_DEV}" 413 | (( LCD_ROW ++ )) 414 | (( INDEX ++ )) 415 | done 416 | fi 417 | 418 | # read nav pipe/custom file descriptor 419 | # 420 | read -t1 INP_BUFFER <&${INP_FD} 421 | 422 | # check input buffer and change message index accordingly 423 | # 424 | if [[ -n "${INP_BUFFER}" ]] 425 | then 426 | INDEX=$(( INDEX_OLD )) 427 | for BUTTON in ${INP_BUFFER} 428 | do 429 | # lights on 430 | if (( LCD_ID == 1 )) 431 | then 432 | INP_ID=0 433 | LCD_ID=0 434 | MSG_ID=0 435 | MSG_RT=0 436 | INP_RT=0 437 | LCD_RT=0 438 | printf "${LCD_ON}" > "${LCD_DEV}" 439 | LOG_MSG[0]="Info => button pressed (lights on)!" 440 | f_logwrite 441 | continue 442 | fi 443 | MSG_ID=0 444 | MSG_RT=0 445 | INP_RT=0 446 | LCD_RT=0 447 | # nav up 448 | if [[ "${BUTTON}" == "UP" ]] 449 | then 450 | if (( INDEX < ${#ROW[@]} - LCD_MAXROW )) 451 | then 452 | (( INDEX = INDEX + LCD_MAXROW )) 453 | elif (( INDEX == ${#ROW[@]} - LCD_MAXROW )) 454 | then 455 | (( INDEX = 0 )) 456 | fi 457 | LOG_MSG[0]="Info => button pressed (up)!" 458 | f_logwrite 459 | # nav down 460 | elif [[ "${BUTTON}" == "DOWN" ]] 461 | then 462 | if (( INDEX > 0 )) 463 | then 464 | (( INDEX = INDEX - LCD_MAXROW )) 465 | elif (( INDEX == 0 )) 466 | then 467 | (( INDEX = ${#ROW[@]} - LCD_MAXROW )) 468 | fi 469 | LOG_MSG[0]="Info => button pressed (down)!" 470 | f_logwrite 471 | fi 472 | done 473 | fi 474 | 475 | # lights out 476 | # 477 | if (( LCD_RT >= LCD_TIMEOUT && LCD_TIMEOUT > 0 )) 478 | then 479 | if (( LCD_ID == 0 )) 480 | then 481 | LCD_ID=1 482 | printf "${LCD_OFF}" > "${LCD_DEV}" 483 | LOG_MSG[0]="Info => lcd timeout, lights out!" 484 | f_logwrite 485 | else 486 | # reduce workload during LCD sleep mode 487 | sleep 1 488 | fi 489 | else 490 | # re-initialize timers 491 | if (( INP_RT >= INP_TIMEOUT && INP_TIMEOUT > 0 )) 492 | then 493 | INP_ID=0 494 | INP_RT=0 495 | elif (( MSG_RT >= MSG_TIMEOUT && MSG_TIMEOUT > 0 )) 496 | then 497 | MSG_ID=0 498 | MSG_RT=0 499 | fi 500 | fi 501 | 502 | # raise runtime counters 503 | # 504 | (( INP_RT ++ )) 505 | (( MSG_RT ++ )) 506 | (( LCD_RT ++ )) 507 | done 508 | -------------------------------------------------------------------------------- /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 | 635 | Copyright (C) 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 | Copyright (C) 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 | --------------------------------------------------------------------------------