Merge pull request #44 from kaulketh/develop

Develop

Author: kaulketh

bot/conf/ext_greenhouse_lib.py

@@ -1,6 +1,10 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
-# author: Thomas Kaulke, [email protected]
+# ext_greenhouse_lib.py
+
+"""
+author: Thomas Kaulke, [email protected]
+"""
 
 from __future__ import absolute_import
 from conf.access import token, thk

bot/conf/greenhouse_config.py

@@ -1,7 +1,11 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
-# configs, command strings and constants
-# author: Thomas Kaulke, [email protected]
+# greenhouse_config.py
+
+"""
+configs, command strings and constants
+author: Thomas Kaulke, [email protected]
+"""
 
 from __future__ import absolute_import
 import conf.access as access

bot/conf/greenhouse_lib_english.py

@@ -1,6 +1,9 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
-# author: Thomas Kaulke, [email protected]
+# greenhouse_lib_english.py
+"""
+author: Thomas Kaulke, [email protected]
+"""
 
 empty = ''
 space = ' '
@@ -38,7 +41,7 @@
 msg_live = '[Click here for the live stream]({})'
 msg_temperature = '`{}Current values\n{}, {}\n{}`'
 msg_welcome = '`Hello {}!`'
-msg_stop = '` S T A N D B Y  `'
+msg_stop = '` S T A N D B Y  \n Restart ->` /start'
 msg_duration = '`Specify switching time for \'{}\' in ' + time_units_name[time_units_index] + ':`'
 water_on = '`\'{}\' is switched on for {}' + time_units_sign[time_units_index] + '.`'
 water_on_group = '`{} are switched on for {}' + time_units_sign[time_units_index] + '.`'

bot/conf/greenhouse_lib_german.py

@@ -1,6 +1,9 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
-# author: Thomas Kaulke, [email protected]
+# greenhouse_lib_german.py
+"""
+author: Thomas Kaulke, [email protected]
+"""
 
 empty = ''
 space = ' '
@@ -37,7 +40,7 @@
 msg_live = '[Hier gehts zum Live Stream]({})'
 msg_temperature = '`{}Aktuelle Werte\n{}, {}\n{}`'
 msg_welcome = '`Hallo {}!`'
-msg_stop = '` S T A N D B Y  `'
+msg_stop = '` S T A N D B Y  \n Neustart ->` /start'
 msg_duration = '`Schaltzeit für \'{}\' in ' + time_units_name[time_units_index] + ' angeben:`'
 water_on = '`\'{}\' wird jetzt für {}' + time_units_sign[time_units_index] + ' eingeschaltet.`'
 water_on_group = '`{} werden jetzt für {}' + time_units_sign[time_units_index] + ' eingeschalten.`'

bot/ext_greenhouse.py

@@ -1,10 +1,12 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
-# script for "panic" mode - extended bot
-# using telepot as Python framework for Telegram Bot API
-# https://telepot.readthedocs.io/en/latest/reference.html
-# author: Thomas Kaulke, [email protected]
-
+# ext_greenhouse.py
+"""
+script for "panic" mode - extended bot
+using telepot as Python framework for Telegram Bot API
+https://telepot.readthedocs.io/en/latest/reference.html
+author: Thomas Kaulke, [email protected]
+"""
 
 from __future__ import absolute_import
 import conf.greenhouse_config as conf
@@ -39,44 +41,30 @@
 group_two = (relais06, relais07, relais08)
 group_three = (relais04, relais05)
 
-# API token and chat Id
-apiToken = conf.token
-Id = sys.argv[1]
-
 
 # water a group of targets
-def _water_on_group(group):
+def __water_on_group(group):
     for member in group:
         utils.switch_on(member)
     return
 
 
 # water off for a  group of targets
-def _water_off_group(group):
+def __water_off_group(group):
     for member in group:
         utils.switch_off(member)
     return
 
 
-# Assign default output (stdout 1 and stderr 2) to file and read in
-# variable and get back
-def _read_cmd(cmd):
-    os.system(cmd + ' > ' + lib.tmp_file + ' 2>&1')
-    file = open(lib.tmp_file, 'r')
-    data = file.read()
-    file.close()
-    return data
-
-
-def _send_msg(message, parse_mode):
+def __send_msg(message, parse_mode):
     os.system(
         'curl -s -k https://api.telegram.org/bot{0}/sendMessage -d text="{1}" -d chat_id={2} {3}'.format(
-            apiToken, message.replace("`", "\\`"), str(Id), parse_mode))
+            apiToken, message.replace("`", "\\`"), str(chat_id), parse_mode))
     logging.info('Message send: {0}'.format(message))
     return
 
 
-def _check_pins_state():
+def __check_pins_state():
     global pins_state
     for pin in group_all:
         if not utils.get_pin_state(pin):
@@ -86,10 +74,13 @@ def _check_pins_state():
         else:
             display.show_off()
             pins_state = True
+
+    if not pins_state:
+        __send_msg('Attention, something is still opened!', no_parse_mode)
     return
 
 
-def _handle(msg):
+def __handle(msg):
     if pins_state:
         display.show_extended()
 
@@ -98,66 +89,69 @@ def _handle(msg):
 
     # commands
     if command == lib.cmd_restart:
-        _send_msg(_read_cmd('sudo reboot'), no_parse_mode)
+        __send_msg(utils.read_cmd('sudo reboot', lib.tmp_file), no_parse_mode)
         display.show_boot()
     elif command == lib.cmd_update:
-        _read_cmd(lib.update_bot)
-        _send_msg(lib.msg_update, no_parse_mode)
+        utils.read_cmd(lib.update_bot, lib.tmp_file)
+        __send_msg(lib.msg_update, no_parse_mode)
         display.show_update()
         time.sleep(3)
     elif command == lib.cmd_logrotate:
-        _send_msg(_read_cmd(lib.logrotate_bot), no_parse_mode)
+        __send_msg(utils.read_cmd(lib.logrotate_bot, lib.tmp_file), no_parse_mode)
     elif command == lib.cmd_all_on:
-        _send_msg(utils.get_timestamp() + ' all on', no_parse_mode)
-        _water_on_group(group_all)
+        __send_msg(utils.get_timestamp() + ' all on', no_parse_mode)
+        __water_on_group(group_all)
     elif command == lib.cmd_all_off:
-        _send_msg('all off.', no_parse_mode)
-        _water_off_group(group_all)
+        __send_msg('all off.', no_parse_mode)
+        __water_off_group(group_all)
     elif command == lib.cmd_group1_on:
-        _send_msg(utils.get_timestamp() + 'group 1 on', no_parse_mode)
-        _water_on_group(group_one)
+        __send_msg(utils.get_timestamp() + 'group 1 on', no_parse_mode)
+        __water_on_group(group_one)
     elif command == lib.cmd_group1_off:
-        _send_msg('group 1 off', no_parse_mode)
-        _water_off_group(group_one)
+        __send_msg('group 1 off', no_parse_mode)
+        __water_off_group(group_one)
     elif command == lib.cmd_group2_on:
-        _send_msg(utils.get_timestamp() + 'group 2  on', no_parse_mode)
-        _water_on_group(group_two)
+        __send_msg(utils.get_timestamp() + 'group 2  on', no_parse_mode)
+        __water_on_group(group_two)
     elif command == lib.cmd_group2_off:
-        _send_msg('group 2 off', no_parse_mode)
-        _water_off_group(group_two)
+        __send_msg('group 2 off', no_parse_mode)
+        __water_off_group(group_two)
     elif command == lib.cmd_group3_on:
-        _send_msg(conf.get_timestamp() + 'group 3 on', no_parse_mode)
-        _water_on_group(group_three)
+        __send_msg(utils.get_timestamp() + 'group 3 on', no_parse_mode)
+        __water_on_group(group_three)
     elif command == lib.cmd_group3_off:
-        _send_msg('group 3 off', no_parse_mode)
-        _water_off_group(group_three)
+        __send_msg('group 3 off', no_parse_mode)
+        __water_off_group(group_three)
     elif command == lib.cmd_kill:
         # disable camera
         logging.info('Disable camera module.')
-        _read_cmd(conf.disable_camera)
-        pid2 = _read_cmd(lib.get_pid2)
-        # logging.info('Got own PID to kill me and prepare the other bot for proper using: {0}'.format(str(pid2)))
-        _read_cmd(lib.restart_bot)
-        _send_msg(conf.lib.msg_stop, markdown)
-        _read_cmd('kill -9 ' + pid2)
+        utils.read_cmd(conf.disable_camera, lib.tmp_file)
+        pid2 = utils.read_cmd(lib.get_pid2, lib.tmp_file)
+        utils.read_cmd(lib.restart_bot, lib.tmp_file)
+        __send_msg(conf.lib.msg_stop, markdown)
+        utils.read_cmd('kill -9 ' + pid2, lib.tmp_file)
     elif command == '/live':
-        _send_msg(conf.lib.msg_live.format(conf.live), markdown)
+        __send_msg(conf.lib.msg_live.format(conf.live), markdown)
     elif command == '/help':
-        _send_msg(lib.msg_help, no_parse_mode)
+        __send_msg(lib.msg_help, no_parse_mode)
     else:
-        _send_msg(lib.msg_unknown, no_parse_mode)
-    _check_pins_state()
+        __send_msg(lib.msg_unknown, no_parse_mode)
+    __check_pins_state()
+
 
+def __init_and_start():
+    # API token and chat Id
+    global apiToken, chat_id
+    apiToken = conf.token
+    chat_id = sys.argv[1]
 
-def init_and_start():
-    # kill the still running greenhouse bot script
-    pid1 = _read_cmd(lib.get_pid1)
-    # logging.info('{0} is PID of running default bot, used to kill.'.format(str(pid1)))
-    _read_cmd('kill -9 {0}'.format(str(pid1)))
+   # kill the still running greenhouse bot script.
+    pid1 = utils.read_cmd(lib.get_pid1, lib.tmp_file)
+    utils.read_cmd('kill -9 {0}'.format(str(pid1)), lib.tmp_file)
 
     utils.set_pins()
     bot = telepot.Bot(apiToken)
-    bot.message_loop(_handle)
+    bot.message_loop(__handle)
     logging.info('I am listening...')
     display.show_extended()
     while 1:
@@ -174,7 +168,5 @@ def init_and_start():
             display.show_error()
 
 
-init_and_start()
-
 if __name__ == '__main__':
-    pass
+    __init_and_start()

bot/greenhouse.py

@@ -1,10 +1,14 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
-# 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]
+# 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]
+"""
 
 from __future__ import absolute_import
 import os
@@ -103,7 +107,7 @@ def __start(bot, update):
         return SELECTION
 
 
-# set the target, member of group or group
+""" set the target, member of group or group """
 def __selection(bot, update):
     global target
     target = update.message.text
@@ -137,7 +141,7 @@ def __selection(bot, update):
         return DURATION
 
 
-# set water duration
+""" set water duration """
 def __duration(bot, update):
     global water_time
     global g_duration_update
@@ -233,7 +237,7 @@ def __duration(bot, update):
     return SELECTION
 
 
-# watering targets
+""" watering targets """
 def __all_off():
     logging.info('Switch all off.')
     for channel in all_groups:
@@ -305,9 +309,9 @@ def __water_group(bot, update, group):
     return
 
 
-# humidity and temperature
+""" humidity and temperature """
 def __message_values(update):
-    # to avoid refresh intervals shorter than 3 seconds
+    """  to avoid refresh intervals shorter than 3 seconds """
     time.sleep(3)
     dht.get_values()
     if dht.temperature == 0:
@@ -341,7 +345,8 @@ def __stop(bot, update):
     return ConversationHandler.END
 
 
-# emergency stop
+""" [#39] Implement emergency stop"""
+"""# emergency stop """
 @run_async
 def __emergency_stop_handler(bot, update, chat_data):
     emergency = update.message.text
@@ -355,11 +360,11 @@ def __emergency_stop_handler(bot, update, chat_data):
 def __start_emergency_stop(bot, update):
     global emergency_job
     emergency_job = jq.run_once(__job_stop_and_restart, 0, context=update)
-    logging.info("Initialize emergency stop immediately.")
+    logging.warning("Initialize emergency stop immediately.")
     return
 
 
-# timer
+""" [#30] implement standby 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)
@@ -373,6 +378,7 @@ def __stop_standby_timer(bot, upadate):
     return
 
 
+""" 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/__init__.py

@@ -1,3 +1,7 @@
+# logger.__init__py
+"""
+author: Thomas Kaulke, [email protected]
+"""
 from .logger import get_logger
 from .logger import logging
 logging.getLogger(__name__).addHandler(logging.NullHandler())

bot/logger/logger.ini

@@ -1,25 +1,22 @@
+# logger.ini
+# author: Thomas Kaulke, [email protected]
 [loggers]
 keys=root
 
 [handlers]
-# keys=file_handler
 keys=stream_handler,file_handler
 
 [formatters]
-# keys=file
 keys=console,file
 
 [logger_root]
 level=DEBUG
-# handlers=file_handler
 handlers=stream_handler,file_handler
 
 [handler_stream_handler]
-# class=StreamHandler
 class=FileHandler
 level=DEBUG
 formatter=console
-# args=(sys.stderr,)
 args=('/greenhouse_console.log',)
 
 [handler_file_handler]