Merge pull request achaudhry#7 from hammady/master

Support configuration as script arguments

Author: achaudhry

.gitignore

@@ -2,3 +2,4 @@
 *.log
 *.pyc
 adhan.log
+.settings

README.md

@@ -12,30 +12,23 @@ This projects uses a python script which automatically calculates [adhan](https:
 1. Install git: Go to raspberry pi terminal (command line interface) and install `git`
   * `$ sudo apt-get install git`
 2. Clone repo: Clone this repository on your raspberry pi in your `home` directory. (Tip: run `$ cd ~` to go to your home directory)
-  * `$ git clone git@github.com:achaudhry/adhan.git`
+  * `$ git clone <get repo clone url from github and put it here>`
   * After doing that you should see an `adhan` direcotry in your `home` directory. 
-3. Go into `adhan` directory: `$cd adhan`
-4. Open `updateAzaanTimers.py` in your favorite editor. For instance, `nano` is a simple one: `$ nano updateAzaanTimers.py`
 
-## Configuration
-The original python script is super configurable. Please see the [manual](http://praytimes.org/manual) for advanced instructions. However, below are the three basic things you'll need to change to get it up and running.
+## Run it for the first time
+Run this command:
 
-* Set the latitude and longitude so it can calculate accurate prayer times for that location. Modify the following lines:
-```
-#Set latitude and longitude here
-#--------------------
-lat = 42.3601
-long = -71.0589
-```
-* Set adhan time [calculation method](http://praytimes.org/manual#Set_Calculation_Method). Modify the following line:
+```bash
+$ python /home/pi/adhan/updateAzaanTimers.py --lat <YOUR_LAT> --lng <YOUR_LNG> --method <METHOD>
 ```
-PT.setMethod('ISNA')
-```
-Save your changes by pressing `Control X` and then `Y`.
 
-## Run it for the first time
-Run this command `$ python /home/pi/adhan/updateAzaanTimers.py`. If everythig worked, your output will look something like this:
+Replace the arguments above with your location information and calculation method:
+* Set the latitude and longitude so it can calculate accurate prayer times for that location.
+* Set adhan time [calculation method](http://praytimes.org/manual#Set_Calculation_Method).
+
+If everythig worked, your output will look something like this:
 ```
+20 60 Egypt 0 0
 05:51
 11:52
 14:11
@@ -53,8 +46,16 @@ Script execution finished at: 2017-01-06 21:22:31.512667
 
 If you look at the last few lines, you'll see that 5 adhan times have been scheduled. Then there is another line at the end which makes sure that at 1am every day the same script will run and calculate adhan times for that day. And lastly, there is a line to clear logs on a monthly basis so that your log file doesn't grow too big.
 
+Note that for later runs you do not have to supply any arguments as they are saved in `/home/pi/adhan/.settings`.
+
 VOILA! You're done!! Plug in your speakers and enjoy!
 
+Please see the [manual](http://praytimes.org/manual) for advanced configuration instructions. 
+
+There are 2 additional arguments that are optional, you can set them in the first run or
+further runs: `--fajr-azaan-volume` and `azaan-volume`. You can control the volume of the Azaan
+by supplying numbers in millibels. To get more information on how to select the values, run the command with `-h`.
+
 ## Tips:
 1. You can see your currently scheduled jobs by running `crontab -l`
 2. The output of the job that runs at 1am every night is being captured in `/home/pi/adhan/adhan.log`. This way you can keep track of all successful runs and any potential issues. This file will be truncated at midnight on the forst day of each month. To view the output type `$ cat /home/pi/adhan/adhan.log`
@@ -64,4 +65,3 @@ I have made modifications / bug fixes but I've used the following as starting po
 * Python code to calculate adhan times: http://praytimes.org/code/ 
 * Basic code to turn the above into an adhan clock: http://randomconsultant.blogspot.co.uk/2013/07/turn-your-raspberry-pi-into-azaanprayer.html
 * Cron scheduler: https://pypi.python.org/pypi/python-crontab/ 
-

adhan.log

@@ -3,38 +3,71 @@
 import datetime
 import time
 import sys
-sys.path.insert(0, '/home/pi/adhan/crontab')
+from os.path import dirname, abspath, join as pathjoin
+import argparse
+
+root_dir = dirname(abspath(__file__))
+sys.path.insert(0, pathjoin(root_dir, 'crontab'))
 
 from praytimes import PrayTimes
 PT = PrayTimes() 
 
 from crontab import CronTab
 system_cron = CronTab(user='pi')
 
-now = datetime.datetime.now()
-strPlayFajrAzaanMP3Command = 'omxplayer -o local /home/pi/adhan/Adhan-fajr.mp3 > /dev/null 2>&1'
-strPlayAzaanMP3Command = 'omxplayer -o local /home/pi/adhan/Adhan-Makkah.mp3 > /dev/null 2>&1'
-strUpdateCommand = 'python /home/pi/adhan/updateAzaanTimers.py >> /home/pi/adhan/adhan.log 2>&1'
-strClearLogsCommand = 'truncate -s 0 /home/pi/adhan/adhan.log 2>&1'
-strJobComment = 'rpiAdhanClockJob'
-
-#Set latitude and longitude here
-#--------------------
-lat = 42.288788
-long = -71.551678
-
-#Set calculation method, utcOffset and dst here
-#By default system timezone will be used
-#--------------------
-PT.setMethod('ISNA')
-utcOffset = -(time.timezone/3600)
-isDst = time.localtime().tm_isdst
-
-
 #HELPER FUNCTIONS
 #---------------------------------
 #---------------------------------
 #Function to add azaan time to cron
+def parseArgs():
+    parser = argparse.ArgumentParser(description='Calculate prayer times and install cronjobs to play Adhan')
+    parser.add_argument('--lat', type=float, dest='lat',
+                        help='Latitude of the location, for example 30.345621')
+    parser.add_argument('--lng', type=float, dest='lng',
+                        help='Longitude of the location, for example 60.512126')
+    parser.add_argument('--method', choices=['MWL', 'ISNA', 'Egypt', 'Makkah', 'Karachi', 'Tehran', 'Jafari'],
+                        dest='method',
+                        help='Method of calculation')
+    parser.add_argument('--fajr-azaan-volume', type=int, dest='fajr_azaan_vol',
+                        help='Volume for fajr azaan in millibels, 1500 is loud and -30000 is quiet (default 0)')
+    parser.add_argument('--azaan-volume', type=int, dest='azaan_vol',
+                        help='Volume for azaan (other than fajr) in millibels, 1500 is loud and -30000 is quiet (default 0)')
+    return parser
+
+def mergeArgs(args):
+    file_path = pathjoin(root_dir, '.settings')
+    # load values
+    lat = lng = method = fajr_azaan_vol = azaan_vol = None
+    try:
+        with open(file_path, 'rt') as f:
+            lat, lng, method, fajr_azaan_vol, azaan_vol = f.readlines()[0].split(',')
+    except:
+        print('No .settings file found')
+    # merge args
+    if args.lat:
+        lat = args.lat
+    if lat:
+        lat = float(lat)
+    if args.lng:
+        lng = args.lng
+    if lng:
+        lng = float(lng)
+    if args.method:
+        method = args.method
+    if args.fajr_azaan_vol:
+        fajr_azaan_vol = args.fajr_azaan_vol
+    if fajr_azaan_vol:
+        fajr_azaan_vol = int(fajr_azaan_vol)
+    if args.azaan_vol:
+        azaan_vol = args.azaan_vol
+    if azaan_vol:
+        azaan_vol = int(azaan_vol)
+    # save values
+    with open(file_path, 'wt') as f:
+        f.write('{},{},{},{},{}'.format(lat or '', lng or '', method or '',
+                fajr_azaan_vol or 0, azaan_vol or 0))
+    return lat or None, lng or None, method or None, fajr_azaan_vol or 0, azaan_vol or 0 
+
 def addAzaanTime (strPrayerName, strPrayerTime, objCronTab, strCommand):
   job = objCronTab.new(command=strCommand,comment=strPrayerName)  
   timeArr = strPrayerTime.split(':')
@@ -43,15 +76,15 @@ def addAzaanTime (strPrayerName, strPrayerTime, objCronTab, strCommand):
   job.minute.on(int(min))
   job.hour.on(int(hour))
   job.set_comment(strJobComment)
-  print job
+  print(job)
   return
 
 def addUpdateCronJob (objCronTab, strCommand):
   job = objCronTab.new(command=strCommand)
   job.minute.on(15)
   job.hour.on(3)
   job.set_comment(strJobComment)
-  print job
+  print(job)
   return
 
 def addClearLogsCronJob (objCronTab, strCommand):
@@ -60,22 +93,47 @@ def addClearLogsCronJob (objCronTab, strCommand):
   job.minute.on(0)
   job.hour.on(0)
   job.set_comment(strJobComment)
-  print job
+  print(job)
   return
 #---------------------------------
 #---------------------------------
 #HELPER FUNCTIONS END
 
+#Parse arguments
+parser = parseArgs()
+args = parser.parse_args()
+#Merge args with saved values if any
+lat, lng, method, fajr_azaan_vol, azaan_vol = mergeArgs(args)
+print(lat, lng, method, fajr_azaan_vol, azaan_vol)
+#Complain if any mandatory value is missing
+if not lat or not lng or not method:
+    parser.print_usage()
+    sys.exit(1)
+
+#Set calculation method, utcOffset and dst here
+#By default system timezone will be used
+#--------------------
+PT.setMethod(method)
+utcOffset = -(time.timezone/3600)
+isDst = time.localtime().tm_isdst
+
+now = datetime.datetime.now()
+strPlayFajrAzaanMP3Command = 'omxplayer --vol {} -o local {}/Adhan-fajr.mp3 > /dev/null 2>&1'.format(fajr_azaan_vol, root_dir)
+strPlayAzaanMP3Command = 'omxplayer --vol {} -o local {}/Adhan-Madinah.mp3 > /dev/null 2>&1'.format(azaan_vol, root_dir)
+strUpdateCommand = 'python {}/updateAzaanTimers.py >> {}/adhan.log 2>&1'.format(root_dir, root_dir)
+strClearLogsCommand = 'truncate -s 0 {}/adhan.log 2>&1'.format(root_dir)
+strJobComment = 'rpiAdhanClockJob'
+
 # Remove existing jobs created by this script
 system_cron.remove_all(comment=strJobComment)
 
 # Calculate prayer times
-times = PT.getTimes((now.year,now.month,now.day), (lat, long), utcOffset, isDst) 
-print times['fajr']
-print times['dhuhr']
-print times['asr']
-print times['maghrib']
-print times['isha']
+times = PT.getTimes((now.year,now.month,now.day), (lat, lng), utcOffset, isDst) 
+print(times['fajr'])
+print(times['dhuhr'])
+print(times['asr'])
+print(times['maghrib'])
+print(times['isha'])
 
 # Add times to crontab
 addAzaanTime('fajr',times['fajr'],system_cron,strPlayFajrAzaanMP3Command)
@@ -91,4 +149,4 @@ def addClearLogsCronJob (objCronTab, strCommand):
 addClearLogsCronJob(system_cron,strClearLogsCommand)
 
 system_cron.write_to_user(user='pi')
-print 'Script execution finished at: ' + str(now)
+print('Script execution finished at: ' + str(now))