Beremiz_service.py
author Edouard Tisserant <edouard.tisserant@gmail.com>
Fri, 11 Mar 2022 14:43:37 +0100
branchwxPython4
changeset 3438 24fbd4d1fe80
parent 3426 c2c366964913
child 3443 a47d9debb0d9
permissions -rwxr-xr-x
Tests: Re-introduced pytest based tests. Fixed them a bit, commented-out otherwise. Application tests only runs with logging test, and PLCOpenEditor tests seem broken.
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
     1
#!/usr/bin/env python
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
     2
# -*- coding: utf-8 -*-
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
     3
1571
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1458
diff changeset
     4
# This file is part of Beremiz, a Integrated Development Environment for
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1458
diff changeset
     5
# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
     6
#
1571
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1458
diff changeset
     7
# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD
1680
6db967480b7d make run Beremiz and PLCOpen Editor, if full path contain non-lating
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1598
diff changeset
     8
# Copyright (C) 2017: Andrey Skvortsov
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
     9
#
1571
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1458
diff changeset
    10
# See COPYING file for copyrights details.
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
    11
#
1571
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1458
diff changeset
    12
# This program is free software; you can redistribute it and/or
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1458
diff changeset
    13
# modify it under the terms of the GNU General Public License
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1458
diff changeset
    14
# as published by the Free Software Foundation; either version 2
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1458
diff changeset
    15
# of the License, or (at your option) any later version.
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
    16
#
1571
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1458
diff changeset
    17
# This program is distributed in the hope that it will be useful,
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1458
diff changeset
    18
# but WITHOUT ANY WARRANTY; without even the implied warranty of
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1458
diff changeset
    19
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1458
diff changeset
    20
# GNU General Public License for more details.
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
    21
#
1571
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1458
diff changeset
    22
# You should have received a copy of the GNU General Public License
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1458
diff changeset
    23
# along with this program; if not, write to the Free Software
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1458
diff changeset
    24
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
    25
1826
91796f408540 fix usage of python2-only print statement
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1790
diff changeset
    26
1881
091005ec69c4 fix pylint py3k conversion warning: "(no-absolute-import) import missing `from __future__ import absolute_import`"
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1872
diff changeset
    27
from __future__ import absolute_import
1826
91796f408540 fix usage of python2-only print statement
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1790
diff changeset
    28
from __future__ import print_function
1732
94ffe74e6895 clean-up: fix PEP8 E401 multiple imports on one line
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1730
diff changeset
    29
import os
94ffe74e6895 clean-up: fix PEP8 E401 multiple imports on one line
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1730
diff changeset
    30
import sys
94ffe74e6895 clean-up: fix PEP8 E401 multiple imports on one line
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1730
diff changeset
    31
import getopt
1783
3311eea28d56 clean-up: fix PEP8 E402 module level import not at top of file
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1780
diff changeset
    32
import threading
2644
769fefae7c81 Add --on-plc-start --on-plc-stop and --status-change to runtime command line, calling given command respectively on start stop or any event. Command line string is python formated (to eventually include status with {}) before being split (supports quoted strings) and passed to Popen for non-blocking execution.
Edouard Tisserant
parents: 2601
diff changeset
    33
import shlex
3282
725d3e9ac913 Runtime: Handle errors in user's python code more gracefully : make exceptions and allow repair.
Edouard Tisserant
parents: 2738
diff changeset
    34
import traceback
3420
da8cceaa247d Runtime : force using monotonic time in Timer (threading). Prevent watchdog to trigger when changing system time.
Edouard Tisserant
parents: 3282
diff changeset
    35
import threading
2484
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
    36
from threading import Thread, Semaphore, Lock, currentThread
2450
5024c19ca8f0 python3 support: pylint, W1652 # (deprecated-types-field) Accessing a deprecated fields on the types module
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2443
diff changeset
    37
from builtins import str as text
2443
75a274023970 python3 support: pylint, W1606 # (execfile-builtin) execfile built-in referenced
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2439
diff changeset
    38
from past.builtins import execfile
2431
6923074540dd python3 support: pylint, W1648 # (bad-python3-import) Module moved in Python 3
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2427
diff changeset
    39
from six.moves import builtins
2270
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
    40
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
    41
import runtime
2476
1881d0ff5ae2 PyroServer: fixed naming of class, and reorganized methods in order to ease subclassing, in case of customization of service publication on the local network (i.e. zeroconf)
Edouard Tisserant
parents: 2459
diff changeset
    42
from runtime.PyroServer import PyroServer
2000
9fa2f8ede5d6 Fixed random segfault happening when loading new PLC in runtime, when using Xenonai.
Edouard Tisserant
parents: 1999
diff changeset
    43
from runtime.xenomai import TryPreloadXenomai
2270
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
    44
from runtime import LogMessageAndException
2416
1ca207782dde Use predefined constants for PlcStatus instead of string literals
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2349
diff changeset
    45
from runtime import PlcStatus
2585
fc6f441582cb Now default_evaluator is provided by runtime package
Edouard Tisserant
parents: 2537
diff changeset
    46
from runtime import default_evaluator
2492
7dd551ac2fa0 check_sources.sh makes me become even less productive
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2489
diff changeset
    47
from runtime.Stunnel import ensurePSK
1783
3311eea28d56 clean-up: fix PEP8 E402 module level import not at top of file
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1780
diff changeset
    48
import util.paths as paths
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
    49
3420
da8cceaa247d Runtime : force using monotonic time in Timer (threading). Prevent watchdog to trigger when changing system time.
Edouard Tisserant
parents: 3282
diff changeset
    50
# In case system time is ajusted, it is better to use
da8cceaa247d Runtime : force using monotonic time in Timer (threading). Prevent watchdog to trigger when changing system time.
Edouard Tisserant
parents: 3282
diff changeset
    51
# monotonic timers for timers and other timeout based operations.
da8cceaa247d Runtime : force using monotonic time in Timer (threading). Prevent watchdog to trigger when changing system time.
Edouard Tisserant
parents: 3282
diff changeset
    52
# hot-patch threading module to force using monitonic time for all 
da8cceaa247d Runtime : force using monotonic time in Timer (threading). Prevent watchdog to trigger when changing system time.
Edouard Tisserant
parents: 3282
diff changeset
    53
# Thread/Timer/Event/Condition
da8cceaa247d Runtime : force using monotonic time in Timer (threading). Prevent watchdog to trigger when changing system time.
Edouard Tisserant
parents: 3282
diff changeset
    54
da8cceaa247d Runtime : force using monotonic time in Timer (threading). Prevent watchdog to trigger when changing system time.
Edouard Tisserant
parents: 3282
diff changeset
    55
from runtime.monotonic_time import monotonic
da8cceaa247d Runtime : force using monotonic time in Timer (threading). Prevent watchdog to trigger when changing system time.
Edouard Tisserant
parents: 3282
diff changeset
    56
threading._time = monotonic
da8cceaa247d Runtime : force using monotonic time in Timer (threading). Prevent watchdog to trigger when changing system time.
Edouard Tisserant
parents: 3282
diff changeset
    57
2644
769fefae7c81 Add --on-plc-start --on-plc-stop and --status-change to runtime command line, calling given command respectively on start stop or any event. Command line string is python formated (to eventually include status with {}) before being split (supports quoted strings) and passed to Popen for non-blocking execution.
Edouard Tisserant
parents: 2601
diff changeset
    58
try:
769fefae7c81 Add --on-plc-start --on-plc-stop and --status-change to runtime command line, calling given command respectively on start stop or any event. Command line string is python formated (to eventually include status with {}) before being split (supports quoted strings) and passed to Popen for non-blocking execution.
Edouard Tisserant
parents: 2601
diff changeset
    59
    from runtime.spawn_subprocess import Popen
769fefae7c81 Add --on-plc-start --on-plc-stop and --status-change to runtime command line, calling given command respectively on start stop or any event. Command line string is python formated (to eventually include status with {}) before being split (supports quoted strings) and passed to Popen for non-blocking execution.
Edouard Tisserant
parents: 2601
diff changeset
    60
except ImportError:
769fefae7c81 Add --on-plc-start --on-plc-stop and --status-change to runtime command line, calling given command respectively on start stop or any event. Command line string is python formated (to eventually include status with {}) before being split (supports quoted strings) and passed to Popen for non-blocking execution.
Edouard Tisserant
parents: 2601
diff changeset
    61
    from subprocess import Popen
1736
7e61baa047f0 clean-up: fix PEP8 E302 expected 2 blank lines, found 1
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1734
diff changeset
    62
2294
da288f63612f Make Beremiz_service print version information
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2249
diff changeset
    63
def version():
da288f63612f Make Beremiz_service print version information
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2249
diff changeset
    64
    from version import app_version
da288f63612f Make Beremiz_service print version information
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2249
diff changeset
    65
    print("Beremiz_service: ", app_version)
da288f63612f Make Beremiz_service print version information
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2249
diff changeset
    66
da288f63612f Make Beremiz_service print version information
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2249
diff changeset
    67
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
    68
def usage():
2294
da288f63612f Make Beremiz_service print version information
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2249
diff changeset
    69
    version()
1826
91796f408540 fix usage of python2-only print statement
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1790
diff changeset
    70
    print("""
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
    71
Usage of Beremiz PLC execution service :\n
644
b511cab580eb Better naming of IP address related variables in Beremiz_service.py, Ignore errors that occur on shutdown in Zeroconf.py, fixed discovery dialog crash due to asynchronous call from zeroconf
Edouard Tisserant
parents: 641
diff changeset
    72
%s {[-n servicename] [-i IP] [-p port] [-x enabletaskbar] [-a autostart]|-h|--help} working_dir
2323
33a0dbabccd3 Runtime : Ensure that a random PSK secret compatible with stunnel is generated if -s commandline switch is used. Stunnel service is restarted after generation, using spawn_subprocess. TODO : give stunnel restart command as a commandline parameter.
Edouard Tisserant
parents: 2321
diff changeset
    73
  -n  service name (default:None, zeroconf discovery disabled)
2221
e03f7649bfb3 WAMP: now config and secret given in project files always override those given in commandline. Also made extensions web customisations happen before registration of web interface.
Edouard Tisserant
parents: 2220
diff changeset
    74
  -i  IP address of interface to bind to (default:localhost)
e03f7649bfb3 WAMP: now config and secret given in project files always override those given in commandline. Also made extensions web customisations happen before registration of web interface.
Edouard Tisserant
parents: 2220
diff changeset
    75
  -p  port number default:3000
e03f7649bfb3 WAMP: now config and secret given in project files always override those given in commandline. Also made extensions web customisations happen before registration of web interface.
Edouard Tisserant
parents: 2220
diff changeset
    76
  -h  print this help text and quit
e03f7649bfb3 WAMP: now config and secret given in project files always override those given in commandline. Also made extensions web customisations happen before registration of web interface.
Edouard Tisserant
parents: 2220
diff changeset
    77
  -a  autostart PLC (0:disable 1:enable) (default:0)
e03f7649bfb3 WAMP: now config and secret given in project files always override those given in commandline. Also made extensions web customisations happen before registration of web interface.
Edouard Tisserant
parents: 2220
diff changeset
    78
  -x  enable/disable wxTaskbarIcon (0:disable 1:enable) (default:1)
e03f7649bfb3 WAMP: now config and secret given in project files always override those given in commandline. Also made extensions web customisations happen before registration of web interface.
Edouard Tisserant
parents: 2220
diff changeset
    79
  -t  enable/disable Twisted web interface (0:disable 1:enable) (default:1)
e03f7649bfb3 WAMP: now config and secret given in project files always override those given in commandline. Also made extensions web customisations happen before registration of web interface.
Edouard Tisserant
parents: 2220
diff changeset
    80
  -w  web server port or "off" to disable web server (default:8009)
e03f7649bfb3 WAMP: now config and secret given in project files always override those given in commandline. Also made extensions web customisations happen before registration of web interface.
Edouard Tisserant
parents: 2220
diff changeset
    81
  -c  WAMP client config file (can be overriden by wampconf.json in project)
2323
33a0dbabccd3 Runtime : Ensure that a random PSK secret compatible with stunnel is generated if -s commandline switch is used. Stunnel service is restarted after generation, using spawn_subprocess. TODO : give stunnel restart command as a commandline parameter.
Edouard Tisserant
parents: 2321
diff changeset
    82
  -s  PSK secret path (default:PSK disabled)
2221
e03f7649bfb3 WAMP: now config and secret given in project files always override those given in commandline. Also made extensions web customisations happen before registration of web interface.
Edouard Tisserant
parents: 2220
diff changeset
    83
  -e  python extension (absolute path .py)
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
    84
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
    85
           working_dir - directory where are stored PLC files
1826
91796f408540 fix usage of python2-only print statement
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1790
diff changeset
    86
""" % sys.argv[0])
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
    87
1749
d73b64672238 clean-up: fix PEP8 E305 expected 2 blank lines after class or function definition
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1747
diff changeset
    88
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
    89
try:
2644
769fefae7c81 Add --on-plc-start --on-plc-stop and --status-change to runtime command line, calling given command respectively on start stop or any event. Command line string is python formated (to eventually include status with {}) before being split (supports quoted strings) and passed to Popen for non-blocking execution.
Edouard Tisserant
parents: 2601
diff changeset
    90
    opts, argv = getopt.getopt(sys.argv[1:], "i:p:n:x:t:a:w:c:e:s:h", ["help", "version", "status-change=", "on-plc-start=", "on-plc-stop="])
2303
03ea6837a0b4 Use Python 3 compatible syntax for exceptions
Yegor Yefremov <yegorslists@googlemail.com>
parents: 2294
diff changeset
    91
except getopt.GetoptError as err:
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
    92
    # print help information and exit:
1826
91796f408540 fix usage of python2-only print statement
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1790
diff changeset
    93
    print(str(err))  # will print something like "option -a not recognized"
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
    94
    usage()
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
    95
    sys.exit(2)
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
    96
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
    97
# default values
2311
bef2b4b87370 Beremiz_service now binds both pyro and nevow ports to interface given with '-i' argument.
Edouard Tisserant
parents: 2305
diff changeset
    98
interface = ''
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
    99
port = 3000
1439
a68cd4253259 Added stub code for runtime WAMP client. Added runtime command line switch to select WAMP url and Nevow web site port. Web port is now fixed, next port number is not tested if bind fails.
Edouard Tisserant
parents: 1438
diff changeset
   100
webport = 8009
2324
1cf3768ebf85 Automatically get PSK and ID when connecting to PYRO[S], so that future connection through PYROS can use that same key. Also fixed case to UPPER for *PSK.
Edouard Tisserant
parents: 2323
diff changeset
   101
PSKpath = None
1893
971de876b1af WAMP runtime : changes from dporopat and agregorcic, adding CRA (-s) and changed way to load WAMP conf (-c)
Edouard Tisserant
parents: 1889
diff changeset
   102
wampconf = None
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   103
servicename = None
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   104
autostart = False
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   105
enablewx = True
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   106
havewx = False
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   107
enabletwisted = True
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   108
havetwisted = False
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   109
1742
92932cd370a4 clean-up: fix PEP8 E225 missing whitespace around operator
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1741
diff changeset
   110
extensions = []
2644
769fefae7c81 Add --on-plc-start --on-plc-stop and --status-change to runtime command line, calling given command respectively on start stop or any event. Command line string is python formated (to eventually include status with {}) before being split (supports quoted strings) and passed to Popen for non-blocking execution.
Edouard Tisserant
parents: 2601
diff changeset
   111
statuschange = []
769fefae7c81 Add --on-plc-start --on-plc-stop and --status-change to runtime command line, calling given command respectively on start stop or any event. Command line string is python formated (to eventually include status with {}) before being split (supports quoted strings) and passed to Popen for non-blocking execution.
Edouard Tisserant
parents: 2601
diff changeset
   112
def status_change_call_factory(wanted, args):
769fefae7c81 Add --on-plc-start --on-plc-stop and --status-change to runtime command line, calling given command respectively on start stop or any event. Command line string is python formated (to eventually include status with {}) before being split (supports quoted strings) and passed to Popen for non-blocking execution.
Edouard Tisserant
parents: 2601
diff changeset
   113
    def status_change_call(status):
769fefae7c81 Add --on-plc-start --on-plc-stop and --status-change to runtime command line, calling given command respectively on start stop or any event. Command line string is python formated (to eventually include status with {}) before being split (supports quoted strings) and passed to Popen for non-blocking execution.
Edouard Tisserant
parents: 2601
diff changeset
   114
        if wanted is None or status is wanted:
769fefae7c81 Add --on-plc-start --on-plc-stop and --status-change to runtime command line, calling given command respectively on start stop or any event. Command line string is python formated (to eventually include status with {}) before being split (supports quoted strings) and passed to Popen for non-blocking execution.
Edouard Tisserant
parents: 2601
diff changeset
   115
            cmd = shlex.split(args.format(status))
769fefae7c81 Add --on-plc-start --on-plc-stop and --status-change to runtime command line, calling given command respectively on start stop or any event. Command line string is python formated (to eventually include status with {}) before being split (supports quoted strings) and passed to Popen for non-blocking execution.
Edouard Tisserant
parents: 2601
diff changeset
   116
            Popen(cmd)
769fefae7c81 Add --on-plc-start --on-plc-stop and --status-change to runtime command line, calling given command respectively on start stop or any event. Command line string is python formated (to eventually include status with {}) before being split (supports quoted strings) and passed to Popen for non-blocking execution.
Edouard Tisserant
parents: 2601
diff changeset
   117
    return status_change_call
1437
04177743b066 Added Beremiz_service.py command line switch to load python extention for runtime independently from PLC program
Edouard Tisserant
parents: 1434
diff changeset
   118
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   119
for o, a in opts:
2294
da288f63612f Make Beremiz_service print version information
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2249
diff changeset
   120
    if o == "-h" or o == "--help":
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   121
        usage()
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   122
        sys.exit()
2294
da288f63612f Make Beremiz_service print version information
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2249
diff changeset
   123
    if o == "--version":
da288f63612f Make Beremiz_service print version information
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2249
diff changeset
   124
        version()
da288f63612f Make Beremiz_service print version information
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2249
diff changeset
   125
        sys.exit()
2644
769fefae7c81 Add --on-plc-start --on-plc-stop and --status-change to runtime command line, calling given command respectively on start stop or any event. Command line string is python formated (to eventually include status with {}) before being split (supports quoted strings) and passed to Popen for non-blocking execution.
Edouard Tisserant
parents: 2601
diff changeset
   126
    if o == "--on-plc-start":
769fefae7c81 Add --on-plc-start --on-plc-stop and --status-change to runtime command line, calling given command respectively on start stop or any event. Command line string is python formated (to eventually include status with {}) before being split (supports quoted strings) and passed to Popen for non-blocking execution.
Edouard Tisserant
parents: 2601
diff changeset
   127
        statuschange.append(status_change_call_factory(PlcStatus.Started, a))
769fefae7c81 Add --on-plc-start --on-plc-stop and --status-change to runtime command line, calling given command respectively on start stop or any event. Command line string is python formated (to eventually include status with {}) before being split (supports quoted strings) and passed to Popen for non-blocking execution.
Edouard Tisserant
parents: 2601
diff changeset
   128
    elif o == "--on-plc-stop":
769fefae7c81 Add --on-plc-start --on-plc-stop and --status-change to runtime command line, calling given command respectively on start stop or any event. Command line string is python formated (to eventually include status with {}) before being split (supports quoted strings) and passed to Popen for non-blocking execution.
Edouard Tisserant
parents: 2601
diff changeset
   129
        statuschange.append(status_change_call_factory(PlcStatus.Stopped, a))
769fefae7c81 Add --on-plc-start --on-plc-stop and --status-change to runtime command line, calling given command respectively on start stop or any event. Command line string is python formated (to eventually include status with {}) before being split (supports quoted strings) and passed to Popen for non-blocking execution.
Edouard Tisserant
parents: 2601
diff changeset
   130
    elif o == "--status-change":
769fefae7c81 Add --on-plc-start --on-plc-stop and --status-change to runtime command line, calling given command respectively on start stop or any event. Command line string is python formated (to eventually include status with {}) before being split (supports quoted strings) and passed to Popen for non-blocking execution.
Edouard Tisserant
parents: 2601
diff changeset
   131
        statuschange.append(status_change_call_factory(None, a))
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   132
    elif o == "-i":
2311
bef2b4b87370 Beremiz_service now binds both pyro and nevow ports to interface given with '-i' argument.
Edouard Tisserant
parents: 2305
diff changeset
   133
        if len(a.split(".")) == 4:
bef2b4b87370 Beremiz_service now binds both pyro and nevow ports to interface given with '-i' argument.
Edouard Tisserant
parents: 2305
diff changeset
   134
            interface = a
bef2b4b87370 Beremiz_service now binds both pyro and nevow ports to interface given with '-i' argument.
Edouard Tisserant
parents: 2305
diff changeset
   135
        elif a == "localhost":
bef2b4b87370 Beremiz_service now binds both pyro and nevow ports to interface given with '-i' argument.
Edouard Tisserant
parents: 2305
diff changeset
   136
            interface = '127.0.0.1'
644
b511cab580eb Better naming of IP address related variables in Beremiz_service.py, Ignore errors that occur on shutdown in Zeroconf.py, fixed discovery dialog crash due to asynchronous call from zeroconf
Edouard Tisserant
parents: 641
diff changeset
   137
        else:
b511cab580eb Better naming of IP address related variables in Beremiz_service.py, Ignore errors that occur on shutdown in Zeroconf.py, fixed discovery dialog crash due to asynchronous call from zeroconf
Edouard Tisserant
parents: 641
diff changeset
   138
            usage()
b511cab580eb Better naming of IP address related variables in Beremiz_service.py, Ignore errors that occur on shutdown in Zeroconf.py, fixed discovery dialog crash due to asynchronous call from zeroconf
Edouard Tisserant
parents: 641
diff changeset
   139
            sys.exit()
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   140
    elif o == "-p":
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   141
        # port: port that the service runs on
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   142
        port = int(a)
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   143
    elif o == "-n":
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   144
        servicename = a
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   145
    elif o == "-x":
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   146
        enablewx = int(a)
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   147
    elif o == "-t":
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   148
        enabletwisted = int(a)
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   149
    elif o == "-a":
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   150
        autostart = int(a)
1439
a68cd4253259 Added stub code for runtime WAMP client. Added runtime command line switch to select WAMP url and Nevow web site port. Web port is now fixed, next port number is not tested if bind fails.
Edouard Tisserant
parents: 1438
diff changeset
   151
    elif o == "-w":
a68cd4253259 Added stub code for runtime WAMP client. Added runtime command line switch to select WAMP url and Nevow web site port. Web port is now fixed, next port number is not tested if bind fails.
Edouard Tisserant
parents: 1438
diff changeset
   152
        webport = None if a == "off" else int(a)
a68cd4253259 Added stub code for runtime WAMP client. Added runtime command line switch to select WAMP url and Nevow web site port. Web port is now fixed, next port number is not tested if bind fails.
Edouard Tisserant
parents: 1438
diff changeset
   153
    elif o == "-c":
a68cd4253259 Added stub code for runtime WAMP client. Added runtime command line switch to select WAMP url and Nevow web site port. Web port is now fixed, next port number is not tested if bind fails.
Edouard Tisserant
parents: 1438
diff changeset
   154
        wampconf = None if a == "off" else a
1893
971de876b1af WAMP runtime : changes from dporopat and agregorcic, adding CRA (-s) and changed way to load WAMP conf (-c)
Edouard Tisserant
parents: 1889
diff changeset
   155
    elif o == "-s":
2324
1cf3768ebf85 Automatically get PSK and ID when connecting to PYRO[S], so that future connection through PYROS can use that same key. Also fixed case to UPPER for *PSK.
Edouard Tisserant
parents: 2323
diff changeset
   156
        PSKpath = None if a == "off" else a
1437
04177743b066 Added Beremiz_service.py command line switch to load python extention for runtime independently from PLC program
Edouard Tisserant
parents: 1434
diff changeset
   157
    elif o == "-e":
1955
a1ea9856013a Attempt to make BitBuket's version of pep8 and pylint happy.
Edouard Tisserant
parents: 1953
diff changeset
   158
        fnameanddirname = list(os.path.split(os.path.realpath(a)))
a1ea9856013a Attempt to make BitBuket's version of pep8 and pylint happy.
Edouard Tisserant
parents: 1953
diff changeset
   159
        fnameanddirname.reverse()
a1ea9856013a Attempt to make BitBuket's version of pep8 and pylint happy.
Edouard Tisserant
parents: 1953
diff changeset
   160
        extensions.append(fnameanddirname)
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   161
    else:
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   162
        usage()
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   163
        sys.exit()
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   164
1783
3311eea28d56 clean-up: fix PEP8 E402 module level import not at top of file
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1780
diff changeset
   165
1680
6db967480b7d make run Beremiz and PLCOpen Editor, if full path contain non-lating
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1598
diff changeset
   166
beremiz_dir = paths.AbsDir(__file__)
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   167
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   168
if len(argv) > 1:
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   169
    usage()
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   170
    sys.exit()
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   171
elif len(argv) == 1:
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   172
    WorkingDir = argv[0]
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   173
    os.chdir(WorkingDir)
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   174
elif len(argv) == 0:
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   175
    WorkingDir = os.getcwd()
1742
92932cd370a4 clean-up: fix PEP8 E225 missing whitespace around operator
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1741
diff changeset
   176
    argv = [WorkingDir]
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   177
2459
21164625b393 Merged. Some changes that should already have been incuded during previous merge (mostly about PlcStatus) have been included this time.
Edouard Tisserant
parents: 2429 2450
diff changeset
   178
builtins.__dict__['_'] = lambda x: x
2319
0a951f528c69 Useless __name__ == '__main__' tests.
Edouard Tisserant
parents: 2315
diff changeset
   179
# TODO: add a cmdline parameter if Trying Preloading Xenomai makes problem
0a951f528c69 Useless __name__ == '__main__' tests.
Edouard Tisserant
parents: 2315
diff changeset
   180
TryPreloadXenomai()
0a951f528c69 Useless __name__ == '__main__' tests.
Edouard Tisserant
parents: 2315
diff changeset
   181
version()
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   182
1736
7e61baa047f0 clean-up: fix PEP8 E302 expected 2 blank lines, found 1
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1734
diff changeset
   183
1595
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   184
def Bpath(*args):
1740
b789b695b5c6 clean-up: fix PEP8 E231 missing whitespace after ':' or ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1739
diff changeset
   185
    return os.path.join(beremiz_dir, *args)
1595
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   186
1736
7e61baa047f0 clean-up: fix PEP8 E302 expected 2 blank lines, found 1
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1734
diff changeset
   187
1595
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   188
def SetupI18n():
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   189
    # Get folder containing translation files
1740
b789b695b5c6 clean-up: fix PEP8 E231 missing whitespace after ':' or ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1739
diff changeset
   190
    localedir = os.path.join(beremiz_dir, "locale")
1595
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   191
    # Get the default language
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   192
    langid = wx.LANGUAGE_DEFAULT
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   193
    # Define translation domain (name of translation files)
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   194
    domain = "Beremiz"
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   195
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   196
    # Define locale for wx
2431
6923074540dd python3 support: pylint, W1648 # (bad-python3-import) Module moved in Python 3
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2427
diff changeset
   197
    loc = builtins.__dict__.get('loc', None)
1595
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   198
    if loc is None:
2349
645eb1bce0a5 Suppress message box in case current locale is unsupported or missing in wx
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2294
diff changeset
   199
        wx.LogGui.EnableLogging(False)
1595
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   200
        loc = wx.Locale(langid)
2349
645eb1bce0a5 Suppress message box in case current locale is unsupported or missing in wx
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2294
diff changeset
   201
        wx.LogGui.EnableLogging(True)
2431
6923074540dd python3 support: pylint, W1648 # (bad-python3-import) Module moved in Python 3
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2427
diff changeset
   202
        builtins.__dict__['loc'] = loc
1595
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   203
        # Define location for searching translation files
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   204
    loc.AddCatalogLookupPathPrefix(localedir)
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   205
    # Define locale domain
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   206
    loc.AddCatalog(domain)
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   207
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   208
    import locale
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   209
    global default_locale
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   210
    default_locale = locale.getdefaultlocale()[1]
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   211
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   212
    # sys.stdout.encoding = default_locale
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   213
    # if Beremiz_service is started from Beremiz IDE
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   214
    # sys.stdout.encoding is None (that means 'ascii' encoding').
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   215
    # And unicode string returned by wx.GetTranslation() are
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   216
    # automatically converted to 'ascii' string.
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   217
    def unicode_translation(message):
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   218
        return wx.GetTranslation(message).encode(default_locale)
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   219
2459
21164625b393 Merged. Some changes that should already have been incuded during previous merge (mostly about PlcStatus) have been included this time.
Edouard Tisserant
parents: 2429 2450
diff changeset
   220
    builtins.__dict__['_'] = unicode_translation
21164625b393 Merged. Some changes that should already have been incuded during previous merge (mostly about PlcStatus) have been included this time.
Edouard Tisserant
parents: 2429 2450
diff changeset
   221
    # builtins.__dict__['_'] = wx.GetTranslation
1595
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   222
1749
d73b64672238 clean-up: fix PEP8 E305 expected 2 blank lines after class or function definition
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1747
diff changeset
   223
1919
ccea0fa6ea91 Another set of meaningless changes to satisfy PEP8 and PyLint.
Edouard Tisserant
parents: 1916
diff changeset
   224
# Life is hard... have a candy.
ccea0fa6ea91 Another set of meaningless changes to satisfy PEP8 and PyLint.
Edouard Tisserant
parents: 1916
diff changeset
   225
# pylint: disable=wrong-import-position,wrong-import-order
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   226
if enablewx:
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   227
    try:
1451
94e620cbd9de Added Ronan Bignaux (genesis) patch to use wxversion. Fixed side effects with sys.path. Other cosmetic fixes about path included.
Edouard Tisserant
parents: 1447
diff changeset
   228
        import wx
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   229
        havewx = True
1780
c52d1460cea8 clean-up: fix PEP8 E722 do not use bare except'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1773
diff changeset
   230
    except ImportError:
1826
91796f408540 fix usage of python2-only print statement
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1790
diff changeset
   231
        print("Wx unavailable !")
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   232
        havewx = False
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   233
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   234
    if havewx:
1451
94e620cbd9de Added Ronan Bignaux (genesis) patch to use wxversion. Fixed side effects with sys.path. Other cosmetic fixes about path included.
Edouard Tisserant
parents: 1447
diff changeset
   235
        import re
3307
eeec6e0ea269 More WxPython 3.x->4.x API update
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3282
diff changeset
   236
        import wx.adv
1590
cdf95900d44f add python-wxgtk3.0 support to Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   237
cdf95900d44f add python-wxgtk3.0 support to Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   238
        if wx.VERSION >= (3, 0, 0):
cdf95900d44f add python-wxgtk3.0 support to Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   239
            app = wx.App(redirect=False)
cdf95900d44f add python-wxgtk3.0 support to Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   240
        else:
cdf95900d44f add python-wxgtk3.0 support to Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   241
            app = wx.PySimpleApp(redirect=False)
cdf95900d44f add python-wxgtk3.0 support to Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   242
        app.SetTopWindow(wx.Frame(None, -1))
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   243
1595
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   244
        default_locale = None
b3cc68dd037d add internatialization support for Beremiz_service.py
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1594
diff changeset
   245
        SetupI18n()
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   246
1067
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   247
        defaulticon = wx.Image(Bpath("images", "brz.png"))
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   248
        starticon = wx.Image(Bpath("images", "icoplay24.png"))
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   249
        stopicon = wx.Image(Bpath("images", "icostop24.png"))
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   250
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   251
        class ParamsEntryDialog(wx.TextEntryDialog):
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   252
1744
69dfdb26f600 clean-up: fix PEP8 E251 unexpected spaces around keyword / parameter equals
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1742
diff changeset
   253
            def __init__(self, parent, message, caption=_("Please enter text"), defaultValue="",
1767
c74815729afd clean-up: fix PEP8 E127 continuation line over-indented for visual indent
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1766
diff changeset
   254
                         style=wx.OK | wx.CANCEL | wx.CENTRE, pos=wx.DefaultPosition):
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   255
                wx.TextEntryDialog.__init__(self, parent, message, caption, defaultValue, style, pos)
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   256
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   257
                self.Tests = []
2177
10aa87518401 Drop support for wxPython 2.6 and below
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2002
diff changeset
   258
                self.Bind(wx.EVT_BUTTON, self.OnOK, id=self.GetAffirmativeId())
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   259
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   260
            def OnOK(self, event):
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   261
                value = self.GetValue()
1739
ec153828ded2 clean-up: fix PEP8 E203 whitespace before ':' and whitespace before ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1738
diff changeset
   262
                texts = {"value": value}
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   263
                for function, message in self.Tests:
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   264
                    if not function(value):
1745
f9d32913bad4 clean-up: fix PEP8 E227 missing whitespace around bitwise or shift operator
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1744
diff changeset
   265
                        message = wx.MessageDialog(self, message % texts, _("Error"), wx.OK | wx.ICON_ERROR)
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   266
                        message.ShowModal()
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   267
                        message.Destroy()
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   268
                        return
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   269
                self.EndModal(wx.ID_OK)
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   270
                event.Skip()
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   271
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   272
            def GetValue(self):
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   273
                return self.GetSizer().GetItem(1).GetWindow().GetValue()
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   274
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   275
            def SetTests(self, tests):
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   276
                self.Tests = tests
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   277
3307
eeec6e0ea269 More WxPython 3.x->4.x API update
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3282
diff changeset
   278
        class BeremizTaskBarIcon(wx.adv.TaskBarIcon):
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   279
            TBMENU_START = wx.NewId()
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   280
            TBMENU_STOP = wx.NewId()
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   281
            TBMENU_CHANGE_NAME = wx.NewId()
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   282
            TBMENU_CHANGE_PORT = wx.NewId()
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   283
            TBMENU_CHANGE_INTERFACE = wx.NewId()
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   284
            TBMENU_LIVE_SHELL = wx.NewId()
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   285
            TBMENU_WXINSPECTOR = wx.NewId()
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   286
            TBMENU_CHANGE_WD = wx.NewId()
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   287
            TBMENU_QUIT = wx.NewId()
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   288
2270
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   289
            def __init__(self, pyroserver):
3307
eeec6e0ea269 More WxPython 3.x->4.x API update
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3282
diff changeset
   290
                wx.adv.TaskBarIcon.__init__(self)
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   291
                self.pyroserver = pyroserver
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   292
                # Set the image
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   293
                self.UpdateIcon(None)
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   294
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   295
                # bind some events
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   296
                self.Bind(wx.EVT_MENU, self.OnTaskBarStartPLC, id=self.TBMENU_START)
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   297
                self.Bind(wx.EVT_MENU, self.OnTaskBarStopPLC, id=self.TBMENU_STOP)
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   298
                self.Bind(wx.EVT_MENU, self.OnTaskBarChangeName, id=self.TBMENU_CHANGE_NAME)
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   299
                self.Bind(wx.EVT_MENU, self.OnTaskBarChangeInterface, id=self.TBMENU_CHANGE_INTERFACE)
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   300
                self.Bind(wx.EVT_MENU, self.OnTaskBarLiveShell, id=self.TBMENU_LIVE_SHELL)
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   301
                self.Bind(wx.EVT_MENU, self.OnTaskBarWXInspector, id=self.TBMENU_WXINSPECTOR)
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   302
                self.Bind(wx.EVT_MENU, self.OnTaskBarChangePort, id=self.TBMENU_CHANGE_PORT)
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   303
                self.Bind(wx.EVT_MENU, self.OnTaskBarChangeWorkingDir, id=self.TBMENU_CHANGE_WD)
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   304
                self.Bind(wx.EVT_MENU, self.OnTaskBarQuit, id=self.TBMENU_QUIT)
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   305
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   306
            def CreatePopupMenu(self):
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   307
                """
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   308
                This method is called by the base class when it needs to popup
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   309
                the menu for the default EVT_RIGHT_DOWN event.  Just create
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   310
                the menu how you want it and return it from this function,
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   311
                the base class takes care of the rest.
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   312
                """
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   313
                menu = wx.Menu()
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   314
                menu.Append(self.TBMENU_START, _("Start PLC"))
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   315
                menu.Append(self.TBMENU_STOP, _("Stop PLC"))
2270
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   316
                menu.AppendSeparator()
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   317
                menu.Append(self.TBMENU_CHANGE_NAME, _("Change Name"))
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   318
                menu.Append(self.TBMENU_CHANGE_INTERFACE, _("Change IP of interface to bind"))
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   319
                menu.Append(self.TBMENU_CHANGE_PORT, _("Change Port Number"))
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   320
                menu.Append(self.TBMENU_CHANGE_WD, _("Change working directory"))
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   321
                menu.AppendSeparator()
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   322
                menu.Append(self.TBMENU_LIVE_SHELL, _("Launch a live Python shell"))
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   323
                menu.Append(self.TBMENU_WXINSPECTOR, _("Launch WX GUI inspector"))
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   324
                menu.AppendSeparator()
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   325
                menu.Append(self.TBMENU_QUIT, _("Quit"))
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   326
                return menu
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   327
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   328
            def MakeIcon(self, img):
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   329
                """
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   330
                The various platforms have different requirements for the
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   331
                icon size...
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   332
                """
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   333
                if "wxMSW" in wx.PlatformInfo:
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   334
                    img = img.Scale(16, 16)
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   335
                elif "wxGTK" in wx.PlatformInfo:
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   336
                    img = img.Scale(22, 22)
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   337
                # wxMac can be any size upto 128x128, so leave the source img alone....
3307
eeec6e0ea269 More WxPython 3.x->4.x API update
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3282
diff changeset
   338
                icon = wx.Icon(img.ConvertToBitmap())
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   339
                return icon
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   340
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   341
            def OnTaskBarStartPLC(self, evt):
2270
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   342
                runtime.GetPLCObjectSingleton().StartPLC()
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   343
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   344
            def OnTaskBarStopPLC(self, evt):
2270
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   345
                runtime.GetPLCObjectSingleton().StopPLC()
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   346
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   347
            def OnTaskBarChangeInterface(self, evt):
1593
6a27490fed96 don't crash on trying to change IP interface for Beremiz_service using taskbar icon if IP wasn't previously
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1592
diff changeset
   348
                ip_addr = self.pyroserver.ip_addr
6a27490fed96 don't crash on trying to change IP interface for Beremiz_service using taskbar icon if IP wasn't previously
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1592
diff changeset
   349
                ip_addr = '' if ip_addr is None else ip_addr
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1680
diff changeset
   350
                dlg = ParamsEntryDialog(None, _("Enter the IP of the interface to bind"), defaultValue=ip_addr)
2439
f0a040f1de1b Fix pep8 warning: W605 invalid escape sequence ?x?
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2431
diff changeset
   351
                dlg.SetTests([(re.compile(r'\d{1,3}(?:\.\d{1,3}){3}$').match, _("IP is not valid!")),
1767
c74815729afd clean-up: fix PEP8 E127 continuation line over-indented for visual indent
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1766
diff changeset
   352
                              (lambda x:len([x for x in x.split(".") if 0 <= int(x) <= 255]) == 4,
1773
38fde37c3766 clean-up: fix PEP8 E124 closing bracket does not match visual indentation
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1767
diff changeset
   353
                               _("IP is not valid!"))])
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   354
                if dlg.ShowModal() == wx.ID_OK:
644
b511cab580eb Better naming of IP address related variables in Beremiz_service.py, Ignore errors that occur on shutdown in Zeroconf.py, fixed discovery dialog crash due to asynchronous call from zeroconf
Edouard Tisserant
parents: 641
diff changeset
   355
                    self.pyroserver.ip_addr = dlg.GetValue()
1887
1b9907ef770b Moved code from to Beremiz_service.py Server class Start method to Loop method to allow customisation by hot patching. Also renamed Stop method as _stop and use Restart instead of Stop from everywhere else to make it clear that _stop actually does restart...
Edouard Tisserant
parents: 1881
diff changeset
   356
                    self.pyroserver.Restart()
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   357
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   358
            def OnTaskBarChangePort(self, evt):
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   359
                dlg = ParamsEntryDialog(None, _("Enter a port number "), defaultValue=str(self.pyroserver.port))
2450
5024c19ca8f0 python3 support: pylint, W1652 # (deprecated-types-field) Accessing a deprecated fields on the types module
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2443
diff changeset
   360
                dlg.SetTests([(text.isdigit, _("Port number must be an integer!")), (lambda port: 0 <= int(port) <= 65535, _("Port number must be 0 <= port <= 65535!"))])
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   361
                if dlg.ShowModal() == wx.ID_OK:
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   362
                    self.pyroserver.port = int(dlg.GetValue())
1887
1b9907ef770b Moved code from to Beremiz_service.py Server class Start method to Loop method to allow customisation by hot patching. Also renamed Stop method as _stop and use Restart instead of Stop from everywhere else to make it clear that _stop actually does restart...
Edouard Tisserant
parents: 1881
diff changeset
   363
                    self.pyroserver.Restart()
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   364
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   365
            def OnTaskBarChangeWorkingDir(self, evt):
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   366
                dlg = wx.DirDialog(None, _("Choose a working directory "), self.pyroserver.workdir, wx.DD_NEW_DIR_BUTTON)
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   367
                if dlg.ShowModal() == wx.ID_OK:
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   368
                    self.pyroserver.workdir = dlg.GetPath()
1887
1b9907ef770b Moved code from to Beremiz_service.py Server class Start method to Loop method to allow customisation by hot patching. Also renamed Stop method as _stop and use Restart instead of Stop from everywhere else to make it clear that _stop actually does restart...
Edouard Tisserant
parents: 1881
diff changeset
   369
                    self.pyroserver.Restart()
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   370
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   371
            def OnTaskBarChangeName(self, evt):
2321
0a3103cd825d Small cosmetic change to enhance readability and avoid confusion.
Edouard Tisserant
parents: 2319
diff changeset
   372
                _servicename = self.pyroserver.servicename
0a3103cd825d Small cosmetic change to enhance readability and avoid confusion.
Edouard Tisserant
parents: 2319
diff changeset
   373
                _servicename = '' if _servicename is None else _servicename
0a3103cd825d Small cosmetic change to enhance readability and avoid confusion.
Edouard Tisserant
parents: 2319
diff changeset
   374
                dlg = ParamsEntryDialog(None, _("Enter a name "), defaultValue=_servicename)
1739
ec153828ded2 clean-up: fix PEP8 E203 whitespace before ':' and whitespace before ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1738
diff changeset
   375
                dlg.SetTests([(lambda name: len(name) is not 0, _("Name must not be null!"))])
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   376
                if dlg.ShowModal() == wx.ID_OK:
1594
049b7144a710 fix issue with changing annonced Pyro service name via taskbar icon
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1593
diff changeset
   377
                    self.pyroserver.servicename = dlg.GetValue()
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   378
                    self.pyroserver.Restart()
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   379
959
046aeae0d71c Python shell and wx inspector now both available even when PLC not started
Edouard Tisserant
parents: 867
diff changeset
   380
            def _LiveShellLocals(self):
2270
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   381
                return {"locals": runtime.GetPLCObjectSingleton().python_runtime_vars}
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   382
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   383
            def OnTaskBarLiveShell(self, evt):
959
046aeae0d71c Python shell and wx inspector now both available even when PLC not started
Edouard Tisserant
parents: 867
diff changeset
   384
                from wx import py
046aeae0d71c Python shell and wx inspector now both available even when PLC not started
Edouard Tisserant
parents: 867
diff changeset
   385
                frame = py.crust.CrustFrame(**self._LiveShellLocals())
046aeae0d71c Python shell and wx inspector now both available even when PLC not started
Edouard Tisserant
parents: 867
diff changeset
   386
                frame.Show()
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   387
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   388
            def OnTaskBarWXInspector(self, evt):
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   389
                # Activate the widget inspection tool
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   390
                from wx.lib.inspection import InspectionTool
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   391
                if not InspectionTool().initialized:
959
046aeae0d71c Python shell and wx inspector now both available even when PLC not started
Edouard Tisserant
parents: 867
diff changeset
   392
                    InspectionTool().Init(**self._LiveShellLocals())
046aeae0d71c Python shell and wx inspector now both available even when PLC not started
Edouard Tisserant
parents: 867
diff changeset
   393
046aeae0d71c Python shell and wx inspector now both available even when PLC not started
Edouard Tisserant
parents: 867
diff changeset
   394
                wnd = wx.GetApp()
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   395
                InspectionTool().Show(wnd, True)
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   396
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   397
            def OnTaskBarQuit(self, evt):
1121
d3838e8f1b90 Fixed Beremiz_service not closing on Windows
Laurent Bessard
parents: 1067
diff changeset
   398
                if wx.Platform == '__WXMSW__':
d3838e8f1b90 Fixed Beremiz_service not closing on Windows
Laurent Bessard
parents: 1067
diff changeset
   399
                    Thread(target=self.pyroserver.Quit).start()
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   400
                self.RemoveIcon()
1121
d3838e8f1b90 Fixed Beremiz_service not closing on Windows
Laurent Bessard
parents: 1067
diff changeset
   401
                wx.CallAfter(wx.GetApp().ExitMainLoop)
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   402
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   403
            def UpdateIcon(self, plcstatus):
2416
1ca207782dde Use predefined constants for PlcStatus instead of string literals
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2349
diff changeset
   404
                if plcstatus is PlcStatus.Started:
1067
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   405
                    currenticon = self.MakeIcon(starticon)
2416
1ca207782dde Use predefined constants for PlcStatus instead of string literals
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2349
diff changeset
   406
                elif plcstatus is PlcStatus.Stopped:
1067
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   407
                    currenticon = self.MakeIcon(stopicon)
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   408
                else:
1067
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   409
                    currenticon = self.MakeIcon(defaulticon)
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   410
                self.SetIcon(currenticon, "Beremiz Service")
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   411
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   412
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   413
if not os.path.isdir(WorkingDir):
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   414
    os.mkdir(WorkingDir)
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   415
1736
7e61baa047f0 clean-up: fix PEP8 E302 expected 2 blank lines, found 1
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1734
diff changeset
   416
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   417
if enabletwisted:
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   418
    import warnings
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   419
    with warnings.catch_warnings():
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   420
        warnings.simplefilter("ignore")
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   421
        try:
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   422
            if havewx:
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   423
                from twisted.internet import wxreactor
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   424
                wxreactor.install()
1438
19ebe96b41c0 Moved twisted/nevow/athena away from Berermiz_service.py + some minor cleanup
Edouard Tisserant
parents: 1437
diff changeset
   425
            from twisted.internet import reactor
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   426
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   427
            havetwisted = True
1780
c52d1460cea8 clean-up: fix PEP8 E722 do not use bare except'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1773
diff changeset
   428
        except ImportError:
1826
91796f408540 fix usage of python2-only print statement
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1790
diff changeset
   429
            print(_("Twisted unavailable."))
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   430
            havetwisted = False
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   431
1438
19ebe96b41c0 Moved twisted/nevow/athena away from Berermiz_service.py + some minor cleanup
Edouard Tisserant
parents: 1437
diff changeset
   432
pyruntimevars = {}
19ebe96b41c0 Moved twisted/nevow/athena away from Berermiz_service.py + some minor cleanup
Edouard Tisserant
parents: 1437
diff changeset
   433
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   434
if havetwisted:
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   435
    if havewx:
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   436
        reactor.registerWxApp(app)
1438
19ebe96b41c0 Moved twisted/nevow/athena away from Berermiz_service.py + some minor cleanup
Edouard Tisserant
parents: 1437
diff changeset
   437
2484
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
   438
twisted_reactor_thread_id = None
2492
7dd551ac2fa0 check_sources.sh makes me become even less productive
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2489
diff changeset
   439
ui_thread = None
2484
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
   440
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   441
if havewx:
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   442
    wx_eval_lock = Semaphore(0)
835
8145be14a2ae Fixed runtime GUI freeze when stopping PLC from the menu. Added -x 2 argument to Beremiz_service.py to restrict content of systray icon menu.
Edouard Tisserant
parents: 719
diff changeset
   443
1438
19ebe96b41c0 Moved twisted/nevow/athena away from Berermiz_service.py + some minor cleanup
Edouard Tisserant
parents: 1437
diff changeset
   444
    def statuschangeTskBar(status):
1740
b789b695b5c6 clean-up: fix PEP8 E231 missing whitespace after ':' or ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1739
diff changeset
   445
        wx.CallAfter(taskbar_instance.UpdateIcon, status)
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   446
1438
19ebe96b41c0 Moved twisted/nevow/athena away from Berermiz_service.py + some minor cleanup
Edouard Tisserant
parents: 1437
diff changeset
   447
    statuschange.append(statuschangeTskBar)
19ebe96b41c0 Moved twisted/nevow/athena away from Berermiz_service.py + some minor cleanup
Edouard Tisserant
parents: 1437
diff changeset
   448
867
06495975e8a4 Added caching for python eval (avoid compiling when same code called, but still execute). Cleaned up some evaluator related code.
Edouard Tisserant
parents: 850
diff changeset
   449
    def wx_evaluator(obj, *args, **kwargs):
1740
b789b695b5c6 clean-up: fix PEP8 E231 missing whitespace after ':' or ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1739
diff changeset
   450
        tocall, args, kwargs = obj.call
867
06495975e8a4 Added caching for python eval (avoid compiling when same code called, but still execute). Cleaned up some evaluator related code.
Edouard Tisserant
parents: 850
diff changeset
   451
        obj.res = default_evaluator(tocall, *args, **kwargs)
06495975e8a4 Added caching for python eval (avoid compiling when same code called, but still execute). Cleaned up some evaluator related code.
Edouard Tisserant
parents: 850
diff changeset
   452
        wx_eval_lock.release()
1434
6e0cd0ceabb7 Added runtime side trace buffer, handled in a separate thread, limited to 1MB, and dropped after 3 seconds if not used by IDE. GetTraceVariables is not anymore blocking on next PLC cycle
Edouard Tisserant
parents: 1270
diff changeset
   453
867
06495975e8a4 Added caching for python eval (avoid compiling when same code called, but still execute). Cleaned up some evaluator related code.
Edouard Tisserant
parents: 850
diff changeset
   454
    def evaluator(tocall, *args, **kwargs):
2484
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
   455
        # To prevent deadlocks, check if current thread is not one of the UI
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
   456
        # UI threads can be either the one from WX main loop or
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
   457
        # worker thread from twisted "threadselect" reactor
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
   458
        current_id = currentThread().ident
2489
27e4fd37fea6 Fix previous commit : Using wx.CallAfter shouldn't have been necessary, and was a symptom of failing evaluator's deadlock detection.
Edouard Tisserant
parents: 2484
diff changeset
   459
2484
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
   460
        if ui_thread is not None \
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
   461
            and ui_thread.ident != current_id \
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
   462
            and (not havetwisted or (
2492
7dd551ac2fa0 check_sources.sh makes me become even less productive
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2489
diff changeset
   463
                    twisted_reactor_thread_id is not None
7dd551ac2fa0 check_sources.sh makes me become even less productive
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2489
diff changeset
   464
                    and twisted_reactor_thread_id != current_id)):
2484
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
   465
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
   466
            o = type('', (object,), dict(call=(tocall, args, kwargs), res=None))
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
   467
            wx.CallAfter(wx_evaluator, o)
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
   468
            wx_eval_lock.acquire()
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
   469
            return o.res
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
   470
        else:
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
   471
            # avoid dead lock if called from the wx mainloop
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
   472
            return default_evaluator(tocall, *args, **kwargs)
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   473
else:
2270
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   474
    evaluator = default_evaluator
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   475
1916
b69bea00765a Small pep8 conformity enforcement.
Edouard Tisserant
parents: 1907
diff changeset
   476
# Exception hooks
1736
7e61baa047f0 clean-up: fix PEP8 E302 expected 2 blank lines, found 1
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1734
diff changeset
   477
1906
60edd0c901f1 Trying to get better logging/display of exceptions at runtime's startup
Edouard Tisserant
parents: 1905
diff changeset
   478
1067
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   479
def LogException(*exp):
1919
ccea0fa6ea91 Another set of meaningless changes to satisfy PEP8 and PyLint.
Edouard Tisserant
parents: 1916
diff changeset
   480
    LogMessageAndException("", exp)
1749
d73b64672238 clean-up: fix PEP8 E305 expected 2 blank lines after class or function definition
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1747
diff changeset
   481
1955
a1ea9856013a Attempt to make BitBuket's version of pep8 and pylint happy.
Edouard Tisserant
parents: 1953
diff changeset
   482
1067
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   483
sys.excepthook = LogException
1736
7e61baa047f0 clean-up: fix PEP8 E302 expected 2 blank lines, found 1
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1734
diff changeset
   484
7e61baa047f0 clean-up: fix PEP8 E302 expected 2 blank lines, found 1
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1734
diff changeset
   485
1067
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   486
def installThreadExcepthook():
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   487
    init_old = threading.Thread.__init__
1750
acf02488f37f clean-up: fix PEP8 E306 expected 1 blank line before a nested definition, found X
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1749
diff changeset
   488
1067
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   489
    def init(self, *args, **kwargs):
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   490
        init_old(self, *args, **kwargs)
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   491
        run_old = self.run
1750
acf02488f37f clean-up: fix PEP8 E306 expected 1 blank line before a nested definition, found X
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1749
diff changeset
   492
1067
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   493
        def run_with_except_hook(*args, **kw):
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   494
            try:
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   495
                run_old(*args, **kw)
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   496
            except (KeyboardInterrupt, SystemExit):
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   497
                raise
1780
c52d1460cea8 clean-up: fix PEP8 E722 do not use bare except'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1773
diff changeset
   498
            except Exception:
1067
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   499
                sys.excepthook(*sys.exc_info())
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   500
        self.run = run_with_except_hook
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   501
    threading.Thread.__init__ = init
1749
d73b64672238 clean-up: fix PEP8 E305 expected 2 blank lines after class or function definition
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1747
diff changeset
   502
d73b64672238 clean-up: fix PEP8 E305 expected 2 blank lines after class or function definition
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1747
diff changeset
   503
1067
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   504
installThreadExcepthook()
2222
8ac0f1af5589 WAMP : complains about failure to start WAMP only if it was successfully imported.
Edouard Tisserant
parents: 2221
diff changeset
   505
havewamp = False
1067
4f460c1dffb5 Added exception hook to Beremiz_service, so that exception go in PLC log. Extended Beremiz.py exception hook to threads. Stripped images embedded in Beremiz_service.py, user real images instead.
Edouard Tisserant
parents: 1051
diff changeset
   506
1446
4963e3816641 Split runtime's twisted modules import and setup to ease runtime extensions hotpatching
Edouard Tisserant
parents: 1439
diff changeset
   507
if havetwisted:
1739
ec153828ded2 clean-up: fix PEP8 E203 whitespace before ':' and whitespace before ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1738
diff changeset
   508
    if webport is not None:
1446
4963e3816641 Split runtime's twisted modules import and setup to ease runtime extensions hotpatching
Edouard Tisserant
parents: 1439
diff changeset
   509
        try:
1872
866fb3ab8778 fix pylint error "(undefined-variable) Undefined variable 'X'"
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   510
            import runtime.NevowServer as NS  # pylint: disable=ungrouped-imports
2669
be233279d179 BACnet and Modbus: Remove additional loading and unloading, use the one already in place for extensions.
Edouard Tisserant
parents: 2659
diff changeset
   511
            NS.WorkingDir = WorkingDir
2216
8ae29ec2d1dc Fix misc typos in exception handling code.
Edouard Tisserant
parents: 2213
diff changeset
   512
        except Exception:
2213
73b7034693b9 Better logging of Nevow Server import in case of exception.
Edouard Tisserant
parents: 2212
diff changeset
   513
            LogMessageAndException(_("Nevow/Athena import failed :"))
1446
4963e3816641 Split runtime's twisted modules import and setup to ease runtime extensions hotpatching
Edouard Tisserant
parents: 1439
diff changeset
   514
            webport = None
2669
be233279d179 BACnet and Modbus: Remove additional loading and unloading, use the one already in place for extensions.
Edouard Tisserant
parents: 2659
diff changeset
   515
2220
985f234b0d09 Moved Wamp configuration file selection logic into runtime/wampclient.py. Added Wamp CRA secret file upload and download. Slightly reworked code for config and secret file loading and saving.
Edouard Tisserant
parents: 2216
diff changeset
   516
    try:
985f234b0d09 Moved Wamp configuration file selection logic into runtime/wampclient.py. Added Wamp CRA secret file upload and download. Slightly reworked code for config and secret file loading and saving.
Edouard Tisserant
parents: 2216
diff changeset
   517
        import runtime.WampClient as WC  # pylint: disable=ungrouped-imports
985f234b0d09 Moved Wamp configuration file selection logic into runtime/wampclient.py. Added Wamp CRA secret file upload and download. Slightly reworked code for config and secret file loading and saving.
Edouard Tisserant
parents: 2216
diff changeset
   518
        WC.WorkingDir = WorkingDir
2222
8ac0f1af5589 WAMP : complains about failure to start WAMP only if it was successfully imported.
Edouard Tisserant
parents: 2221
diff changeset
   519
        havewamp = True
2220
985f234b0d09 Moved Wamp configuration file selection logic into runtime/wampclient.py. Added Wamp CRA secret file upload and download. Slightly reworked code for config and secret file loading and saving.
Edouard Tisserant
parents: 2216
diff changeset
   520
    except Exception:
985f234b0d09 Moved Wamp configuration file selection logic into runtime/wampclient.py. Added Wamp CRA secret file upload and download. Slightly reworked code for config and secret file loading and saving.
Edouard Tisserant
parents: 2216
diff changeset
   521
        LogMessageAndException(_("WAMP import failed :"))
1446
4963e3816641 Split runtime's twisted modules import and setup to ease runtime extensions hotpatching
Edouard Tisserant
parents: 1439
diff changeset
   522
1437
04177743b066 Added Beremiz_service.py command line switch to load python extention for runtime independently from PLC program
Edouard Tisserant
parents: 1434
diff changeset
   523
# Load extensions
1905
87c908079bc6 Changed way to deal with extensions arguments (-e) so that path and filename are stored independently and accessible for extensions themselves.
Edouard Tisserant
parents: 1901
diff changeset
   524
for extention_file, extension_folder in extensions:
1437
04177743b066 Added Beremiz_service.py command line switch to load python extention for runtime independently from PLC program
Edouard Tisserant
parents: 1434
diff changeset
   525
    sys.path.append(extension_folder)
1905
87c908079bc6 Changed way to deal with extensions arguments (-e) so that path and filename are stored independently and accessible for extensions themselves.
Edouard Tisserant
parents: 1901
diff changeset
   526
    execfile(os.path.join(extension_folder, extention_file), locals())
1437
04177743b066 Added Beremiz_service.py command line switch to load python extention for runtime independently from PLC program
Edouard Tisserant
parents: 1434
diff changeset
   527
2323
33a0dbabccd3 Runtime : Ensure that a random PSK secret compatible with stunnel is generated if -s commandline switch is used. Stunnel service is restarted after generation, using spawn_subprocess. TODO : give stunnel restart command as a commandline parameter.
Edouard Tisserant
parents: 2321
diff changeset
   528
# Service name is used as an ID for stunnel's PSK
33a0dbabccd3 Runtime : Ensure that a random PSK secret compatible with stunnel is generated if -s commandline switch is used. Stunnel service is restarted after generation, using spawn_subprocess. TODO : give stunnel restart command as a commandline parameter.
Edouard Tisserant
parents: 2321
diff changeset
   529
# Some extension may set 'servicename' to a computed ID or Serial Number
33a0dbabccd3 Runtime : Ensure that a random PSK secret compatible with stunnel is generated if -s commandline switch is used. Stunnel service is restarted after generation, using spawn_subprocess. TODO : give stunnel restart command as a commandline parameter.
Edouard Tisserant
parents: 2321
diff changeset
   530
# instead of using commandline '-n'
2324
1cf3768ebf85 Automatically get PSK and ID when connecting to PYRO[S], so that future connection through PYROS can use that same key. Also fixed case to UPPER for *PSK.
Edouard Tisserant
parents: 2323
diff changeset
   531
if servicename is not None and PSKpath is not None:
1cf3768ebf85 Automatically get PSK and ID when connecting to PYRO[S], so that future connection through PYROS can use that same key. Also fixed case to UPPER for *PSK.
Edouard Tisserant
parents: 2323
diff changeset
   532
    ensurePSK(servicename, PSKpath)
2270
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   533
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   534
runtime.CreatePLCObjectSingleton(
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   535
    WorkingDir, argv, statuschange, evaluator, pyruntimevars)
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   536
2476
1881d0ff5ae2 PyroServer: fixed naming of class, and reorganized methods in order to ease subclassing, in case of customization of service publication on the local network (i.e. zeroconf)
Edouard Tisserant
parents: 2459
diff changeset
   537
pyroserver = PyroServer(servicename, interface, port)
2270
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   538
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   539
if havewx:
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   540
    taskbar_instance = BeremizTaskBarIcon(pyroserver)
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   541
1446
4963e3816641 Split runtime's twisted modules import and setup to ease runtime extensions hotpatching
Edouard Tisserant
parents: 1439
diff changeset
   542
if havetwisted:
1739
ec153828ded2 clean-up: fix PEP8 E203 whitespace before ':' and whitespace before ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1738
diff changeset
   543
    if webport is not None:
1446
4963e3816641 Split runtime's twisted modules import and setup to ease runtime extensions hotpatching
Edouard Tisserant
parents: 1439
diff changeset
   544
        try:
2311
bef2b4b87370 Beremiz_service now binds both pyro and nevow ports to interface given with '-i' argument.
Edouard Tisserant
parents: 2305
diff changeset
   545
            website = NS.RegisterWebsite(interface, webport)
1446
4963e3816641 Split runtime's twisted modules import and setup to ease runtime extensions hotpatching
Edouard Tisserant
parents: 1439
diff changeset
   546
            pyruntimevars["website"] = website
2210
81949104291d Nevow based web interface now show simple Log message sending form for basic runtime, and allow extensions to add their own web settings.
Edouard Tisserant
parents: 2018
diff changeset
   547
            NS.SetServer(pyroserver)
1446
4963e3816641 Split runtime's twisted modules import and setup to ease runtime extensions hotpatching
Edouard Tisserant
parents: 1439
diff changeset
   548
            statuschange.append(NS.website_statuslistener_factory(website))
1906
60edd0c901f1 Trying to get better logging/display of exceptions at runtime's startup
Edouard Tisserant
parents: 1905
diff changeset
   549
        except Exception:
60edd0c901f1 Trying to get better logging/display of exceptions at runtime's startup
Edouard Tisserant
parents: 1905
diff changeset
   550
            LogMessageAndException(_("Nevow Web service failed. "))
1446
4963e3816641 Split runtime's twisted modules import and setup to ease runtime extensions hotpatching
Edouard Tisserant
parents: 1439
diff changeset
   551
2222
8ac0f1af5589 WAMP : complains about failure to start WAMP only if it was successfully imported.
Edouard Tisserant
parents: 2221
diff changeset
   552
    if havewamp:
8ac0f1af5589 WAMP : complains about failure to start WAMP only if it was successfully imported.
Edouard Tisserant
parents: 2221
diff changeset
   553
        try:
8ac0f1af5589 WAMP : complains about failure to start WAMP only if it was successfully imported.
Edouard Tisserant
parents: 2221
diff changeset
   554
            WC.SetServer(pyroserver)
2324
1cf3768ebf85 Automatically get PSK and ID when connecting to PYRO[S], so that future connection through PYROS can use that same key. Also fixed case to UPPER for *PSK.
Edouard Tisserant
parents: 2323
diff changeset
   555
            WC.RegisterWampClient(wampconf, PSKpath)
2222
8ac0f1af5589 WAMP : complains about failure to start WAMP only if it was successfully imported.
Edouard Tisserant
parents: 2221
diff changeset
   556
            WC.RegisterWebSettings(NS)
8ac0f1af5589 WAMP : complains about failure to start WAMP only if it was successfully imported.
Edouard Tisserant
parents: 2221
diff changeset
   557
        except Exception:
8ac0f1af5589 WAMP : complains about failure to start WAMP only if it was successfully imported.
Edouard Tisserant
parents: 2221
diff changeset
   558
            LogMessageAndException(_("WAMP client startup failed. "))
1446
4963e3816641 Split runtime's twisted modules import and setup to ease runtime extensions hotpatching
Edouard Tisserant
parents: 1439
diff changeset
   559
2738
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   560
def FirstWorkerJob():
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   561
    """
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   562
    RPC through pyro/wamp/UI may lead to delegation to Worker,
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   563
    then this function ensures that Worker is already
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   564
    created when pyro starts
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   565
    """
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   566
    global pyro_thread, pyroserver, ui_thread, reactor, twisted_reactor_thread_id
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   567
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   568
    pyro_thread_started = Lock()
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   569
    pyro_thread_started.acquire()
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   570
    pyro_thread = Thread(target=pyroserver.PyroLoop,
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   571
                         kwargs=dict(when_ready=pyro_thread_started.release),
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   572
                         name="PyroThread")
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   573
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   574
    pyro_thread.start()
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   575
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   576
    # Wait for pyro thread to be effective
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   577
    pyro_thread_started.acquire()
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   578
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   579
    pyroserver.PrintServerInfo()
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   580
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   581
    # Beremiz IDE detects LOCAL:// runtime is ready by looking
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   582
    # for self.workdir in the daemon's stdout.
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   583
    sys.stdout.write(_("Current working directory :") + WorkingDir + "\n")
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   584
    sys.stdout.flush()
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   585
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   586
    if not (havetwisted or havewx):
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   587
        return
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   588
1994
1fdc32be71b8 Rework of runtime non-real-time threading, and shared object dynamic loading :
Edouard Tisserant
parents: 1988
diff changeset
   589
    ui_thread_started = Lock()
1fdc32be71b8 Rework of runtime non-real-time threading, and shared object dynamic loading :
Edouard Tisserant
parents: 1988
diff changeset
   590
    ui_thread_started.acquire()
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   591
    if havetwisted:
1984
081265cda5b1 Intermediate state while implementing runtime worker to ensure that PLCObject Load and Unload methods always run main thread.
Edouard Tisserant
parents: 1955
diff changeset
   592
        # reactor._installSignalHandlersAgain()
081265cda5b1 Intermediate state while implementing runtime worker to ensure that PLCObject Load and Unload methods always run main thread.
Edouard Tisserant
parents: 1955
diff changeset
   593
        def ui_thread_target():
1997
d9e8fb47340f PEP-8 and PyLint
Edouard Tisserant
parents: 1994
diff changeset
   594
            # FIXME: had to disable SignaHandlers install because
1984
081265cda5b1 Intermediate state while implementing runtime worker to ensure that PLCObject Load and Unload methods always run main thread.
Edouard Tisserant
parents: 1955
diff changeset
   595
            # signal not working in non-main thread
081265cda5b1 Intermediate state while implementing runtime worker to ensure that PLCObject Load and Unload methods always run main thread.
Edouard Tisserant
parents: 1955
diff changeset
   596
            reactor.run(installSignalHandlers=False)
1997
d9e8fb47340f PEP-8 and PyLint
Edouard Tisserant
parents: 1994
diff changeset
   597
    else:
1984
081265cda5b1 Intermediate state while implementing runtime worker to ensure that PLCObject Load and Unload methods always run main thread.
Edouard Tisserant
parents: 1955
diff changeset
   598
        ui_thread_target = app.MainLoop
081265cda5b1 Intermediate state while implementing runtime worker to ensure that PLCObject Load and Unload methods always run main thread.
Edouard Tisserant
parents: 1955
diff changeset
   599
2600
0e20a0d48fae Named runtime's threads to ease debugging
Edouard Tisserant
parents: 2595
diff changeset
   600
    ui_thread = Thread(target=ui_thread_target, name="UIThread")
1984
081265cda5b1 Intermediate state while implementing runtime worker to ensure that PLCObject Load and Unload methods always run main thread.
Edouard Tisserant
parents: 1955
diff changeset
   601
    ui_thread.start()
081265cda5b1 Intermediate state while implementing runtime worker to ensure that PLCObject Load and Unload methods always run main thread.
Edouard Tisserant
parents: 1955
diff changeset
   602
1994
1fdc32be71b8 Rework of runtime non-real-time threading, and shared object dynamic loading :
Edouard Tisserant
parents: 1988
diff changeset
   603
    # This order ui loop to unblock main thread when ready.
1fdc32be71b8 Rework of runtime non-real-time threading, and shared object dynamic loading :
Edouard Tisserant
parents: 1988
diff changeset
   604
    if havetwisted:
2484
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
   605
        def signal_uithread_started():
2489
27e4fd37fea6 Fix previous commit : Using wx.CallAfter shouldn't have been necessary, and was a symptom of failing evaluator's deadlock detection.
Edouard Tisserant
parents: 2484
diff changeset
   606
            global twisted_reactor_thread_id
2484
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
   607
            twisted_reactor_thread_id = currentThread().ident
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
   608
            ui_thread_started.release()
2318a7cde101 Fixed deadlock when using Wx together with Twisted in runtime.
Edouard Tisserant
parents: 2476
diff changeset
   609
        reactor.callLater(0, signal_uithread_started)
1997
d9e8fb47340f PEP-8 and PyLint
Edouard Tisserant
parents: 1994
diff changeset
   610
    else:
1994
1fdc32be71b8 Rework of runtime non-real-time threading, and shared object dynamic loading :
Edouard Tisserant
parents: 1988
diff changeset
   611
        wx.CallAfter(ui_thread_started.release)
1fdc32be71b8 Rework of runtime non-real-time threading, and shared object dynamic loading :
Edouard Tisserant
parents: 1988
diff changeset
   612
1fdc32be71b8 Rework of runtime non-real-time threading, and shared object dynamic loading :
Edouard Tisserant
parents: 1988
diff changeset
   613
    # Wait for ui thread to be effective
1fdc32be71b8 Rework of runtime non-real-time threading, and shared object dynamic loading :
Edouard Tisserant
parents: 1988
diff changeset
   614
    ui_thread_started.acquire()
1fdc32be71b8 Rework of runtime non-real-time threading, and shared object dynamic loading :
Edouard Tisserant
parents: 1988
diff changeset
   615
    print("UI thread started successfully.")
1fdc32be71b8 Rework of runtime non-real-time threading, and shared object dynamic loading :
Edouard Tisserant
parents: 1988
diff changeset
   616
2738
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   617
    runtime.GetPLCObjectSingleton().AutoLoad(autostart)
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   618
1984
081265cda5b1 Intermediate state while implementing runtime worker to ensure that PLCObject Load and Unload methods always run main thread.
Edouard Tisserant
parents: 1955
diff changeset
   619
try:
2738
58f2e3f22934 Runtime: Fix exception "Worker is disabled" when connecting while PLC runtime is starting.
Edouard Tisserant
parents: 2669
diff changeset
   620
    runtime.MainWorker.runloop(FirstWorkerJob)
1984
081265cda5b1 Intermediate state while implementing runtime worker to ensure that PLCObject Load and Unload methods always run main thread.
Edouard Tisserant
parents: 1955
diff changeset
   621
except KeyboardInterrupt:
081265cda5b1 Intermediate state while implementing runtime worker to ensure that PLCObject Load and Unload methods always run main thread.
Edouard Tisserant
parents: 1955
diff changeset
   622
    pass
081265cda5b1 Intermediate state while implementing runtime worker to ensure that PLCObject Load and Unload methods always run main thread.
Edouard Tisserant
parents: 1955
diff changeset
   623
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   624
pyroserver.Quit()
2601
9c5b20dc2b2e Enure that all threads are joined before trying to exit
Edouard Tisserant
parents: 2600
diff changeset
   625
pyro_thread.join()
2270
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   626
2669
be233279d179 BACnet and Modbus: Remove additional loading and unloading, use the one already in place for extensions.
Edouard Tisserant
parents: 2659
diff changeset
   627
plcobj = runtime.GetPLCObjectSingleton()
3282
725d3e9ac913 Runtime: Handle errors in user's python code more gracefully : make exceptions and allow repair.
Edouard Tisserant
parents: 2738
diff changeset
   628
try:
725d3e9ac913 Runtime: Handle errors in user's python code more gracefully : make exceptions and allow repair.
Edouard Tisserant
parents: 2738
diff changeset
   629
    plcobj.StopPLC()
725d3e9ac913 Runtime: Handle errors in user's python code more gracefully : make exceptions and allow repair.
Edouard Tisserant
parents: 2738
diff changeset
   630
    plcobj.UnLoadPLC()
725d3e9ac913 Runtime: Handle errors in user's python code more gracefully : make exceptions and allow repair.
Edouard Tisserant
parents: 2738
diff changeset
   631
except:
725d3e9ac913 Runtime: Handle errors in user's python code more gracefully : make exceptions and allow repair.
Edouard Tisserant
parents: 2738
diff changeset
   632
    print(traceback.format_exc())
2270
d9175daf6522 Refactoring. Separated PLC Object, PYRO Server and MainWorker :
Edouard Tisserant
parents: 2249
diff changeset
   633
2595
a0d2741a6722 Ensure Beremiz_service.py quits properly when Main Worker stops and wa are using Wx and/or Twisted.
Edouard Tisserant
parents: 2585
diff changeset
   634
if havetwisted:
a0d2741a6722 Ensure Beremiz_service.py quits properly when Main Worker stops and wa are using Wx and/or Twisted.
Edouard Tisserant
parents: 2585
diff changeset
   635
    reactor.stop()
2601
9c5b20dc2b2e Enure that all threads are joined before trying to exit
Edouard Tisserant
parents: 2600
diff changeset
   636
    ui_thread.join()
2595
a0d2741a6722 Ensure Beremiz_service.py quits properly when Main Worker stops and wa are using Wx and/or Twisted.
Edouard Tisserant
parents: 2585
diff changeset
   637
elif havewx:
a0d2741a6722 Ensure Beremiz_service.py quits properly when Main Worker stops and wa are using Wx and/or Twisted.
Edouard Tisserant
parents: 2585
diff changeset
   638
    app.ExitMainLoop()
2601
9c5b20dc2b2e Enure that all threads are joined before trying to exit
Edouard Tisserant
parents: 2600
diff changeset
   639
    ui_thread.join()
2595
a0d2741a6722 Ensure Beremiz_service.py quits properly when Main Worker stops and wa are using Wx and/or Twisted.
Edouard Tisserant
parents: 2585
diff changeset
   640
641
b4eae24d05bf Fixed encoding of Beremiz_service.py
Edouard Tisserant
parents: 622
diff changeset
   641
sys.exit(0)