#+=============================================================================================
#!
#!		Readme for RevPiTimer
#| 
#+=============================================================================================
#|	
#|		File-ID:		$Id: readme.txt 777 2017-06-02 12:15:17Z dconzelmann $
#|		Date:			$Date: 2017-06-02 14:15:17 +0200 (Fr, 02 Jun 2017) $
#|		File Revision:	$Rev: 777 $
#|	
#|		Author:			$Author: dconzelmann $
#|		Company:		$Cpn: KUNBUS GmbH $
#|
#+=============================================================================================


I   : Description

	The RevPiTimer is a weekly based timer for you can use for free in your RevPi Core.


II  : Preparation

	Before you begin please take some time to make an image of your system.
	How to do this? It is described here: https://revolution.kunbus.de/tutorials/video-tutorials/
	Tutorial #01 Creation of an image


III : Installation
	
	1) Download the "RevPiTimer Sample Code" from the downloads area
	https://revolution.kunbus.de/tutorials/downloads/
	
	2) Copy the file "RevPiTimer.py" to your device i.e. by using the
	FileZilla software. Lets assume you copy it here:
	/home/pi/RevPiTimer/RevPiTimer.py
	
	3) Make the script executable by typing this command
	chmod u+x /home/pi/RevPiTimer/RevPiTimer.py
	
	4) Test if the script is executable by executing it as follows
	/home/pi/RevPiTimer/RevPiTimer.py --verbose
	timer modules found : 0
	
	4) Now we let the script execute once every minute by using the linux crontab. 
	Execute "crontab -e". If the dialog appears "select an editor ..." 
	just press enter to use the default editor which is the user friendly nano editor.
	
	Now go to the end of the file and add the following line:
	
	* * * * *  /home/pi/RevPiTimer/RevPiTimer.py
	
	Close and save the file by pressing [CTRL] + X and Y for Yes.
	

IV  : Usage

	Open PiCtory, configure one or more RevPiTimer modules which you can find in 
	the "Virtual Devices" section.
	Save your configuration and restart the driver. 
	Menu File -> Save, File -> Reset Driver
	
	A tutorial on how to use the RevPiTimer you can find here:
	
	https://revolution.kunbus.de/tutorial-revpitimer/

	Have Fun!
	
	