Edouard@2745: #!/usr/bin/env python
Edouard@2745: # -*- coding: utf-8 -*-
Edouard@2745:
Edouard@2745: # This file is part of Beremiz
edouard@3197: # Copyright (C) 2021: Edouard TISSERANT
Edouard@2745: #
Edouard@2745: # See COPYING file for copyrights details.
Edouard@2745:
Edouard@2745: from __future__ import absolute_import
Edouard@2745: import os
Edouard@2745: import shutil
Edouard@2789: import hashlib
Edouard@2823: import shlex
edouard@3156: import time
Edouard@2745:
Edouard@2745: import wx
Edouard@2816:
Edouard@2816: from lxml import etree
Edouard@2816: from lxml.etree import XSLTApplyError
Edouard@2745:
Edouard@2745: import util.paths as paths
Edouard@2745: from POULibrary import POULibrary
Edouard@2756: from docutil import open_svg, get_inkscape_path
Edouard@2745:
Edouard@2756: from util.ProcessLogger import ProcessLogger
Edouard@2764: from runtime.typemapping import DebugTypesSize
Edouard@2767: import targets
Edouard@2816: from editors.ConfTreeNodeEditor import ConfTreeNodeEditor
Edouard@2816: from XSLTransform import XSLTransform
edouard@3201: from svghmi.i18n import EtreeToMessages, SaveCatalog, ReadTranslations,\
edouard@3201: MatchTranslations, TranslationToEtree, open_pofile
edouard@3197: from svghmi.hmi_tree import HMI_TYPES, HMITreeNode, SPECIAL_NODES
edouard@3201: from svghmi.ui import SVGHMI_UI
Edouard@2745:
Edouard@2753:
Edouard@2753: ScriptDirectory = paths.AbsDir(__file__)
Edouard@2753:
Edouard@2788:
Edouard@2763: # module scope for HMITree root
Edouard@2763: # so that CTN can use HMITree deduced in Library
Edouard@2817: # note: this only works because library's Generate_C is
Edouard@2763: # systematicaly invoked before CTN's CTNGenerate_C
Edouard@2763:
Edouard@2763: hmi_tree_root = None
Edouard@2757:
Edouard@2817: on_hmitree_update = None
Edouard@2816:
Edouard@2745: class SVGHMILibrary(POULibrary):
Edouard@2745: def GetLibraryPath(self):
Edouard@2750: return paths.AbsNeighbourFile(__file__, "pous.xml")
Edouard@2745:
Edouard@2749: def Generate_C(self, buildpath, varlist, IECCFLAGS):
Edouard@2822: global hmi_tree_root, on_hmitree_update
Edouard@2749:
Edouard@2757: """
Edouard@2757: PLC Instance Tree:
Edouard@2757: prog0
Edouard@2757: +->v1 HMI_INT
Edouard@2757: +->v2 HMI_INT
Edouard@2757: +->fb0 (type mhoo)
Edouard@2814: | +->va HMI_NODE
Edouard@2757: | +->v3 HMI_INT
Edouard@2757: | +->v4 HMI_INT
Edouard@2757: |
Edouard@2757: +->fb1 (type mhoo)
Edouard@2814: | +->va HMI_NODE
Edouard@2757: | +->v3 HMI_INT
Edouard@2757: | +->v4 HMI_INT
Edouard@2757: |
Edouard@2757: +->fb2
Edouard@2757: +->v5 HMI_IN
Edouard@2757:
Edouard@2757: HMI tree:
Edouard@2757: hmi0
Edouard@2757: +->v1
Edouard@2757: +->v2
Edouard@2814: +->fb0 class:va
Edouard@2757: | +-> v3
Edouard@2757: | +-> v4
Edouard@2757: |
Edouard@2814: +->fb1 class:va
Edouard@2757: | +-> v3
Edouard@2757: | +-> v4
Edouard@2757: |
Edouard@2757: +->v5
Edouard@2757:
Edouard@2757: """
Edouard@2757:
Edouard@2749: # Filter known HMI types
Edouard@2749: hmi_types_instances = [v for v in varlist if v["derived"] in HMI_TYPES]
Edouard@2758:
edouard@2890: hmi_tree_root = None
edouard@2890:
edouard@2890: # take first HMI_NODE (placed as special node), make it root
edouard@2890: for i,v in enumerate(hmi_types_instances):
edouard@2890: path = v["IEC_path"].split(".")
edouard@2890: derived = v["derived"]
Edouard@2965: if derived == "HMI_NODE":
edouard@2890: hmi_tree_root = HMITreeNode(path, "", derived, v["type"], v["vartype"], v["C_path"])
edouard@2890: hmi_types_instances.pop(i)
edouard@2890: break
edouard@2890:
Edouard@3051: if hmi_tree_root is None:
Edouard@3051: self.FatalError("SVGHMI : Library is selected but not used. Please either deselect it in project config or add a SVGHMI node to project.")
Edouard@2757:
Edouard@2757: # deduce HMI tree from PLC HMI_* instances
Edouard@2757: for v in hmi_types_instances:
Edouard@2822: path = v["IEC_path"].split(".")
Edouard@2758: # ignores variables starting with _TMP_
Edouard@2758: if path[-1].startswith("_TMP_"):
Edouard@2758: continue
Edouard@2814: derived = v["derived"]
Edouard@2814: kwargs={}
Edouard@2814: if derived == "HMI_NODE":
Edouard@2822: # TODO : make problem if HMI_NODE used in CONFIG or RESOURCE
Edouard@2814: name = path[-2]
Edouard@2814: kwargs['hmiclass'] = path[-1]
Edouard@2814: else:
Edouard@2814: name = path[-1]
Edouard@2822: new_node = HMITreeNode(path, name, derived, v["type"], v["vartype"], v["C_path"], **kwargs)
Edouard@2965: placement_result = hmi_tree_root.place_node(new_node)
Edouard@2965: if placement_result is not None:
Edouard@2965: cause, problematic_node = placement_result
Edouard@2965: if cause == "Non_Unique":
Edouard@2965: message = _("HMI tree nodes paths are not unique.\nConflicting variable: {} {}").format(
Edouard@2965: ".".join(problematic_node.path),
Edouard@2965: ".".join(new_node.path))
Edouard@2965:
Edouard@2965: last_FB = None
Edouard@2965: for v in varlist:
Edouard@2965: if v["vartype"] == "FB":
Edouard@2965: last_FB = v
Edouard@2965: if v["C_path"] == problematic_node:
Edouard@2965: break
Edouard@2965: if last_FB is not None:
Edouard@2965: failing_parent = last_FB["type"]
Edouard@2965: message += "\n"
Edouard@2965: message += _("Solution: Add HMI_NODE at beginning of {}").format(failing_parent)
Edouard@2965:
Edouard@2965: elif cause in ["Late_HMI_NODE", "Duplicate_HMI_NODE"]:
Edouard@2965: cause, problematic_node = placement_result
Edouard@2965: message = _("There must be only one occurrence of HMI_NODE before any HMI_* variable in POU.\nConflicting variable: {} {}").format(
Edouard@2965: ".".join(problematic_node.path),
Edouard@2965: ".".join(new_node.path))
Edouard@2965:
Edouard@2965: self.FatalError("SVGHMI : " + message)
Edouard@2757:
Edouard@2817: if on_hmitree_update is not None:
edouard@3201: on_hmitree_update(hmi_tree_root)
Edouard@2816:
Edouard@2764: variable_decl_array = []
Edouard@2764: extern_variables_declarations = []
Edouard@2765: buf_index = 0
Edouard@2775: item_count = 0
Edouard@2822: found_heartbeat = False
Edouard@2822:
Edouard@2822: hearbeat_IEC_path = ['CONFIG', 'HEARTBEAT']
Edouard@2828:
Edouard@2764: for node in hmi_tree_root.traverse():
Edouard@2828: if not found_heartbeat and node.path == hearbeat_IEC_path:
Edouard@2822: hmi_tree_hearbeat_index = item_count
Edouard@2822: found_heartbeat = True
Edouard@2822: extern_variables_declarations += [
Edouard@2822: "#define heartbeat_index "+str(hmi_tree_hearbeat_index)
Edouard@2822: ]
Edouard@2866: if hasattr(node, "iectype"):
Edouard@2764: sz = DebugTypesSize.get(node.iectype, 0)
Edouard@2764: variable_decl_array += [
Edouard@2822: "{&(" + node.cpath + "), " + node.iectype + {
Edouard@2764: "EXT": "_P_ENUM",
Edouard@2764: "IN": "_P_ENUM",
Edouard@2764: "MEM": "_O_ENUM",
Edouard@2764: "OUT": "_O_ENUM",
Edouard@2764: "VAR": "_ENUM"
Edouard@2765: }[node.vartype] + ", " +
Edouard@2768: str(buf_index) + ", 0, }"]
Edouard@2765: buf_index += sz
Edouard@2775: item_count += 1
Edouard@2764: if len(node.path) == 1:
Edouard@2764: extern_variables_declarations += [
Edouard@2764: "extern __IEC_" + node.iectype + "_" +
Edouard@2764: "t" if node.vartype is "VAR" else "p"
Edouard@2822: + node.cpath + ";"]
Edouard@2828:
Edouard@2822: assert(found_heartbeat)
Edouard@2764:
Edouard@2764: # TODO : filter only requiered external declarations
Edouard@2828: for v in varlist:
Edouard@2828: if v["C_path"].find('.') < 0:
Edouard@2764: extern_variables_declarations += [
Edouard@2764: "extern %(type)s %(C_path)s;" % v]
Edouard@2764:
Edouard@2764: # TODO check if programs need to be declared separately
Edouard@2764: # "programs_declarations": "\n".join(["extern %(type)s %(C_path)s;" %
Edouard@2764: # p for p in self._ProgramList]),
Edouard@2764:
Edouard@2771: # C code to observe/access HMI tree variables
Edouard@2749: svghmi_c_filepath = paths.AbsNeighbourFile(__file__, "svghmi.c")
Edouard@2749: svghmi_c_file = open(svghmi_c_filepath, 'r')
Edouard@2749: svghmi_c_code = svghmi_c_file.read()
Edouard@2749: svghmi_c_file.close()
Edouard@2817: svghmi_c_code = svghmi_c_code % {
Edouard@2764: "variable_decl_array": ",\n".join(variable_decl_array),
Edouard@2764: "extern_variables_declarations": "\n".join(extern_variables_declarations),
Edouard@2767: "buffer_size": buf_index,
Edouard@2775: "item_count": item_count,
Edouard@2768: "var_access_code": targets.GetCode("var_access.c"),
Edouard@2788: "PLC_ticktime": self.GetCTR().GetTicktime(),
Edouard@2789: "hmi_hash_ints": ",".join(map(str,hmi_tree_root.hash()))
Edouard@2764: }
Edouard@2749:
Edouard@2749: gen_svghmi_c_path = os.path.join(buildpath, "svghmi.c")
Edouard@2749: gen_svghmi_c = open(gen_svghmi_c_path, 'w')
Edouard@2749: gen_svghmi_c.write(svghmi_c_code)
Edouard@2749: gen_svghmi_c.close()
Edouard@2749:
Edouard@2771: # Python based WebSocket HMITree Server
Edouard@2771: svghmiserverfile = open(paths.AbsNeighbourFile(__file__, "svghmi_server.py"), 'r')
Edouard@2771: svghmiservercode = svghmiserverfile.read()
Edouard@2771: svghmiserverfile.close()
Edouard@2771:
Edouard@2993: runtimefile_path = os.path.join(buildpath, "runtime_00_svghmi.py")
Edouard@2771: runtimefile = open(runtimefile_path, 'w')
Edouard@2771: runtimefile.write(svghmiservercode)
Edouard@2771: runtimefile.close()
Edouard@2771:
edouard@3176: # Backup HMI Tree in XML form so that it can be loaded without building
edouard@3176: hmitree_backup_path = os.path.join(buildpath, "hmitree.xml")
edouard@3180: hmitree_backup_file = open(hmitree_backup_path, 'wb')
edouard@3176: hmitree_backup_file.write(etree.tostring(hmi_tree_root.etree()))
edouard@3176: hmitree_backup_file.close()
edouard@3176:
Edouard@2771: return ((["svghmi"], [(gen_svghmi_c_path, IECCFLAGS)], True), "",
Edouard@2993: ("runtime_00_svghmi.py", open(runtimefile_path, "rb")))
Edouard@2993: # ^
Edouard@2993: # note the double zero after "runtime_",
Edouard@2993: # to ensure placement before other CTN generated code in execution order
Edouard@2745:
Edouard@2816:
edouard@3201: def Register_SVGHMI_UI_for_HMI_tree_updates(ref):
edouard@3201: global on_hmitree_update
edouard@3201: def HMITreeUpdate(_hmi_tree_root):
edouard@3201: obj = ref()
edouard@3201: if obj is not None:
edouard@3201: obj.HMITreeUpdate(_hmi_tree_root)
edouard@3201:
edouard@3201: on_hmitree_update = HMITreeUpdate
Edouard@2818:
Edouard@2818:
Edouard@2818: class SVGHMIEditor(ConfTreeNodeEditor):
Edouard@2818: CONFNODEEDITOR_TABS = [
edouard@3201: (_("HMI Tree"), "CreateSVGHMI_UI")]
edouard@3201:
edouard@3201: def CreateSVGHMI_UI(self, parent):
edouard@3176: global hmi_tree_root
edouard@3176:
edouard@3176: if hmi_tree_root is None:
edouard@3176: buildpath = self.Controler.GetCTRoot()._getBuildPath()
edouard@3176: hmitree_backup_path = os.path.join(buildpath, "hmitree.xml")
edouard@3176: if os.path.exists(hmitree_backup_path):
edouard@3180: hmitree_backup_file = open(hmitree_backup_path, 'rb')
edouard@3176: hmi_tree_root = HMITreeNode.from_etree(etree.parse(hmitree_backup_file).getroot())
edouard@3176:
edouard@3201: return SVGHMI_UI(parent, Register_SVGHMI_UI_for_HMI_tree_updates)
Edouard@2818:
Edouard@2745: class SVGHMI(object):
Edouard@2771: XSD = """
Edouard@2745: