Merge pull request #46 from kaulketh/develop

Develop

Author: kaulketh

README.md

@@ -188,10 +188,11 @@ _**Make them executable and chown root:root!**_
 * access.py - external file, content will not provided, contains api token, chat IDs and other sensitive data
 * [greenhouse_config.py](bot/conf/greenhouse_config.py) - contains settings and properties
 * [greenhouse.py](bot/greenhouse.py) - main bot
-* [greenhouse_lib_german.py](bot/conf/greenhouse_lib_german.py) - file with constants, contains strings for descriptions and messages
+* [lib_global.py](bot/conf/lib_global.py) - global constants and time settings 
+* [lib_german.py](bot/conf/lib_german.py) - file with constants, contains strings for descriptions and messages
 * [ext_greenhouse.py](bot/ext_greenhouse.py) - extended bot
-* [ext_greenhouse_lib.py](bot/conf/ext_greenhouse_lib.py) - some constants, contains strings for commands and texts
-* [greenhouse_lib_english.py](bot/conf/greenhouse_lib_english.py) - English translation of German version, if required adapt import in config!
+* [lib_ext_greenhouse.py](bot/conf/lib_ext_greenhouse.py) - some constants, contains strings for commands and texts
+* [lib_english.py](bot/conf/lib_english.py) - English translation of German version, if required adapt import in config!
 * [gpio_check.py](bot/peripherals/gpio_check.py) - to check state of GPIOs and logs state, in case it is wished
 * [update_bot.sh](bot/update_bot.sh) - to updates all scripts from this repository by using last commit ID
 

bot/conf/greenhouse_config.py

@@ -6,14 +6,20 @@
 configs, command strings and constants
 author: Thomas Kaulke, [email protected]
 """
-
 from __future__ import absolute_import
 import conf.access as access
-
-# language selection
-""" for English import greenhouse_lib_english """
-import conf.greenhouse_lib_german as lib
-
+from conf.lib_global import language_index
+"""
+ language settings
+ import required lib
+ set index in global library 
+ """
+if language_index == 0:
+    import conf.lib_english as lib
+elif language_index == 1:
+    import conf.lib_german as lib
+else:
+    import conf.lib_english as lib
 
 # API Token and Chat Id's from external file
 admins = [access.thk, access.annett]

bot/conf/greenhouse_lib_english.py bot/conf/lib_english.py

@@ -1,24 +1,25 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
-# greenhouse_lib_english.py
+# lib_english.py
 """
 author: Thomas Kaulke, [email protected]
 """
-
-empty = ''
-space = ' '
-colon_space = ': '
-pipe_space = '| '
-line_break = '\n'
+from __future__ import absolute_import
+import conf.lib_global as global_lib
+
+empty = global_lib.empty
+space = global_lib.space
+colon_space = global_lib.colon_space
+pipe_space = global_lib.pipe_space
+line_break = global_lib.line_break
 decimal = '.'
 
-# time unit
-# time units settings (0 == seconds, 1 == minutes)
-time_units_index = 0
-time_units_name = ('seconds', 'minutes')
-time_units_sign = ('s', 'm')
-time_units_conversion = (1, 60)
-time_conversion = time_units_conversion[time_units_index]
+# time units
+time_units_index = global_lib.time_units_index
+time_units_name = ('seconds', 'minutes', 'hours')
+time_units_sign = global_lib.time_units_sign
+time_units_conversion = global_lib.time_units_conversion
+time_conversion = global_lib.time_conversion
 
 # commands and descriptions
 panic = 'Panic'
@@ -36,7 +37,6 @@
 hum = 'Humidity'
 core = 'Core temperature'
 
-
 # messages
 msg_live = '[Click here for the live stream]({})'
 msg_temperature = '`{}Current values\n{}, {}\n{}`'

bot/conf/ext_greenhouse_lib.py bot/conf/lib_ext_greenhouse.py

@@ -1,15 +1,16 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
-# ext_greenhouse_lib.py
+# lib_ext_greenhouse.py
 
 """
 author: Thomas Kaulke, [email protected]
 """
 
 from __future__ import absolute_import
 from conf.access import token, thk
+from conf.lib_global import line_break, commit_id, bot_dir, bot_backup
 
-newline = '\n'
+newline = line_break
 cmd_prefix = '/'
 cmd_restart = '{0}RESTART'.format(cmd_prefix)
 cmd_update = '{0}UPDATE'.format(cmd_prefix)
@@ -53,20 +54,17 @@
 tmp_file = 'cmd.tmp'
 del_tmp = 'rm -r ' + tmp_file
 
-# get_pid1 = 'pgrep -lfo greenhouse.py | awk \'{print $1}\''
 get_pid1 = 'ps -o pid,args -C python | awk \'/greenhouse.py/ { print $1 }\''
-# get_pid2 = 'pgrep -lfo ext_greenhouse.py | awk \'{print $1}\''
 get_pid2 = 'ps -o pid,args -C python | awk \'/ext_greenhouse.py/ { print $1 }\''
 
-restart_bot = 'python /home/pi/scripts/TelegramBot/greenhouse.py &'
+restart_bot = 'python ' + str(bot_dir) + 'greenhouse.py &'
 
-"""Ensure same file names in update_bot.sh!"""
-"""Ensure same file names in peripherals/oled/display.py!"""
-update_bot = 'rm /greenhouseRepoCommit.id && bash /home/pi/scripts/TelegramBot/update_bot.sh ' \
+update_bot = 'rm '+ str(commit_id) + ' && bash ' + str(bot_dir) + 'update_bot.sh ' \
              + str(token) + ' ' + str(thk) + ' &'
 
-backup_all = 'tar -zcf /home/pi/backups/greenhouse.tgz --exclude=\'*.pyc\' /home/pi/scripts/TelegramBot/ &'
+backup_all = 'tar -zcf ' + str(bot_backup) + ' --exclude=\'*.pyc\' ' + str(bot_dir) + ' &'
 logrotate_bot = 'logrotate -f /etc/logrotate.conf &'
 
+
 if __name__ == '__main__':
     pass

bot/conf/greenhouse_lib_german.py bot/conf/lib_german.py

@@ -1,24 +1,25 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
-# greenhouse_lib_german.py
+# lib_german.py
 """
 author: Thomas Kaulke, [email protected]
 """
+from __future__ import absolute_import
+import conf.lib_global as global_lib
 
-empty = ''
-space = ' '
-colon_space = ': '
-pipe_space = '| '
-line_break = '\n'
+empty = global_lib.empty
+space = global_lib.space
+colon_space = global_lib.colon_space
+pipe_space = global_lib.pipe_space
+line_break = global_lib.line_break
 decimal = ','
 
-# time unit
-# time units settings (0 == seconds, 1 == minutes)
-time_units_index = 0
-time_units_name = ('Sekunden', 'Minuten')
-time_units_sign = ('s', 'm')
-time_units_conversion = (1, 60)
-time_conversion = time_units_conversion[time_units_index]
+# time units
+time_units_index = global_lib.time_units_index
+time_units_name = ('Sekunden', 'Minuten', 'Stunden')
+time_units_sign = global_lib.time_units_sign
+time_units_conversion = global_lib.time_units_conversion
+time_conversion = global_lib.time_conversion
 
 # commands and descriptions
 panic = 'Panik'

bot/conf/lib_global.py

@@ -0,0 +1,42 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# lib_global.py
+"""
+author: Thomas Kaulke, [email protected]
+"""
+
+empty = ''
+space = ' '
+colon_space = ': '
+pipe_space = '| '
+line_break = '\n'
+
+""" language settings
+0 - English
+1 - German
+"""
+language_index = 1
+
+""" time units settings 
+0 == seconds
+1 == minutes
+2 == hours
+"""
+time_units_index = 0
+time_units_conversion = (1, 60, 3600)
+time_units_sign = ('s', 'm', 'h')
+time_conversion = time_units_conversion[time_units_index]
+
+
+# TODO: make accessible in bash and vice versa!!!!
+file_log_greenhouse = '/greenhouse.log'
+file_log_debug = '/greenhouse_console.log'
+file_log_update = '/update_bot.log'
+commit_id = '/greenhouseRepoCommit.id'
+cloned_branch = '/greenhouseRepoBranch.name'
+bot_dir = '/home/pi/scripts/TelegramBot/'
+bot_backup = '/home/pi/backups/greenhouse.tgz'
+
+
+if __name__ == '__main__':
+    pass

bot/ext_greenhouse.py

@@ -10,7 +10,7 @@
 
 from __future__ import absolute_import
 import conf.greenhouse_config as conf
-import conf.ext_greenhouse_lib as lib
+import conf.lib_ext_greenhouse as lib
 import utils.utils as utils
 import peripherals.four_digit.display as display
 import sys

bot/greenhouse.py

@@ -3,13 +3,12 @@
 # greenhouse.py
 
 """
-main script for greenhouse bot
-using telegram.ext as Python framework for Telegram Bot API
-https://core.telegram.org/api#bot-api
-original: author: Stefan Weigert  http://www.stefan-weigert.de/php_loader/raspi.php
-adapted: author: Thomas Kaulke, [email protected]
+ main script for greenhouse bot
+ using telegram.ext as Python framework for Telegram Bot API
+ https://core.telegram.org/api#bot-api
+ original: author: Stefan Weigert  http://www.stefan-weigert.de/php_loader/raspi.php
+ adapted: Thomas Kaulke, [email protected]
 """
-
 from __future__ import absolute_import
 import os
 import time
@@ -91,12 +90,12 @@ def __start(bot, update):
         return ConversationHandler.END
     else:
         display.show_run()
-        logging.info('Bot started.')
+        logging.info('Bot started...')
         __message_values(update)
         __cam_on()
         display.show_ready()
         update.message.reply_text('{0}{1}{2}'.format(
-            lib.msg_welcome.format(update.message.from_user.first_name), lib.line_break, lib.msg_choice),
+            lib.msg_welcome.format(update.message.from_user.first_name), lib.space, lib.msg_choice),
             parse_mode=ParseMode.MARKDOWN, reply_markup=markup1)
         logging.info('Bot is using by: {0} - {1},{2}'.format(
             str(user_id), update.message.from_user.last_name, update.message.from_user.first_name))
@@ -309,7 +308,9 @@ def __water_group(bot, update, group):
     return
 
 
-""" humidity and temperature """
+""" 
+ get humidity and temperature values 
+"""
 def __message_values(update):
     """  to avoid refresh intervals shorter than 3 seconds """
     time.sleep(3)
@@ -345,8 +346,9 @@ def __stop(bot, update):
     return ConversationHandler.END
 
 
-""" [#39] Implement emergency stop"""
-"""# emergency stop """
+""" 
+ [#39] Implement emergency stop
+"""
 @run_async
 def __emergency_stop_handler(bot, update, chat_data):
     emergency = update.message.text
@@ -364,21 +366,26 @@ def __start_emergency_stop(bot, update):
     return
 
 
-""" [#30] implement standby after given time without user activity """
+""" 
+ [#30] implement standby 
+ init after given time without user activity 
+"""
 def __start_standby_timer(bot, update):
     global timer_job
     timer_job = jq.run_once(__job_stop_and_restart, conf.standby_timeout, context=update)
-    logging.info("Init standby timer of {0} seconds, added to queue.".format(conf.standby_timeout))
+    logging.warning("Init standby timer of {0} seconds, added to queue.".format(conf.standby_timeout))
     return
 
 
 def __stop_standby_timer(bot, upadate):
     timer_job.schedule_removal()
-    logging.info("Timer job removed from the queue.")
+    logging.warning("Timer job removed from the queue.")
     return
 
 
-""" job to stop and restart application """
+""" 
+ job to stop and restart application 
+"""
 def __job_stop_and_restart(bot, job):
     logging.warning("Job: Stop and restart called!")
     stop_and_restart.stop_and_restart(job.context)

bot/logger/logger.ini

@@ -1,5 +1,3 @@
-# logger.ini
-# author: Thomas Kaulke, [email protected]
 [loggers]
 keys=root
 

bot/peripherals/oled/display.py

@@ -10,6 +10,7 @@
 from PIL import Image, ImageFont, ImageDraw
 from lib_oled96 import Ssd1306
 from smbus import SMBus
+from ...conf.lib_global import commit_id, cloned_branch, bot_dir
 
 
 # Display setup, methods and members
@@ -23,24 +24,23 @@
 switch_time = 15
 
 
-"""Ensure same file names in update_bot.sh!"""
 def get_last_commit():
     commit = None
     branch = None
 
     try:
-        commit = open("/greenhouseRepoCommit.id").read()
+        commit = open(str(commit_id)).read()
         if commit is None:
             commit = '-------'
         else:
             commit = commit[0:7]
-        branch = open("/greenhouseRepoBranch.name").read()
+        branch = open(str(cloned_branch)).read()
         if branch is None:
             branch = '-------'
         else:
             branch = branch.replace("\n", "")
     except Exception:
-        build = '!!!ERROR!!!'
+        build = '---ERROR---'
         return build
 
     build = commit + " " + branch
@@ -56,8 +56,8 @@ def get_core_temp():
 
 
 # Fonts
-font = ImageFont.truetype('/home/pi/scripts/TelegramBot/peripherals/oled/fonts/arial.ttf', 12)
-font2 = ImageFont.truetype('/home/pi/scripts/TelegramBot/peripherals/oled/fonts/FreeSans.ttf', 12)
+font = ImageFont.truetype(str(bot_dir) + 'peripherals/oled/fonts/arial.ttf', 12)
+font2 = ImageFont.truetype(str(bot_dir) + 'peripherals/oled/fonts/FreeSans.ttf', 12)
 
 
 def animate(time):
@@ -80,7 +80,7 @@ def show_pi(time):
     oled.cls()
     # image inverted
     draw.rectangle((32, top - 3, 95, 63), outline=1, fill=1)
-    draw.bitmap((32, top - 3), Image.open('/home/pi/scripts/TelegramBot/peripherals/oled/pi_logo.png'), fill=0)
+    draw.bitmap((32, top - 3), Image.open(str(bot_dir) + 'peripherals/oled/pi_logo.png'), fill=0)
     oled.display()
     sleep(time)
 

bot/utils/stop_and_restart.py

@@ -9,7 +9,7 @@
 from __future__ import absolute_import
 from telegram import (ReplyKeyboardRemove, ParseMode)
 import time
-import conf.ext_greenhouse_lib as lib
+import conf.lib_ext_greenhouse as lib
 import conf.greenhouse_config as conf
 import peripherals.four_digit.display as display
 import logger.logger as log