--- a/PLCControler.py Tue Sep 10 10:37:42 2013 +0200
+++ b/PLCControler.py Tue Sep 10 23:10:58 2013 +0200
@@ -30,7 +30,7 @@
from time import localtime
from graphics.GraphicCommons import *
from PLCGenerator import *
@@ -1297,14 +1297,16 @@
# Add a global var to configuration to configuration
- def AddConfigurationGlobalVar(self, config_name, type, var_name,
+ def AddConfigurationGlobalVar(self, config_name, var_type, var_name, location="", description=""):
if self.Project is not None:
# Found the configuration corresponding to name
configuration = self.Project.getconfiguration(config_name)
if configuration is not None:
# Set configuration global vars
- configuration.addglobalVar(type, var_name, location, description)
+ configuration.addglobalVar( + self.GetVarTypeObject(var_type), + var_name, location, description) # Replace the configuration globalvars by those given
def SetConfigurationGlobalVars(self, name, vars):
@@ -1635,6 +1637,10 @@
result = project.getpou(typename)
+ for standardlibrary in [StdBlockLibrary, AddnlBlockLibrary]: + result = standardlibrary.getpou(typename) for confnodetype in self.ConfNodeTypes:
result = confnodetype["types"].getpou(typename)
@@ -2410,21 +2416,36 @@
connection.setconnectionParameter(idx, None)
- def AddEditedElementPouVar(self, tagname, type, name, location="", description=""):
+ def GetVarTypeObject(self, var_type): + var_type_obj = PLCOpenParser.CreateElement("type", "variable") + if not var_type.startswith("ANY") and TypeHierarchy.get(var_type): + var_type_obj.setcontent(PLCOpenParser.CreateElement( + var_type.lower() if var_type in ["STRING", "WSTRING"] + else var_type, "dataType")) + derived_type = PLCOpenParser.CreateElement("derived", "dataType") + derived_type.setname(var_type) + var_type_obj.setcontent(derived_type) + def AddEditedElementPouVar(self, tagname, var_type, name, location="", description=""): if self.Project is not None:
words = tagname.split("::")
if words[0] in ['P', 'T', 'A']:
pou = self.Project.getpou(words[1])
- pou.addpouLocalVar(type, name, location, description)
+ self.GetVarTypeObject(var_type), + name, location, description) - def AddEditedElementPouExternalVar(self, tagname, type, name):
+ def AddEditedElementPouExternalVar(self, tagname, var_type, name): if self.Project is not None:
words = tagname.split("::")
if words[0] in ['P', 'T', 'A']:
pou = self.Project.getpou(words[1])
- pou.addpouExternalVar(type, name)
+ self.GetVarTypeObject(var_type), name) def ChangeEditedElementPouVar(self, tagname, old_type, old_name, new_type, new_name):
if self.Project is not None:
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/plcopen/Additional_Function_Blocks.xml Tue Sep 10 23:10:58 2013 +0200
@@ -0,0 +1,522 @@
+<?xml version='1.0' encoding='utf-8'?> +<project xmlns:ns1="http://www.plcopen.org/xml/tc6_0201" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.plcopen.org/xml/tc6_0201"> + <fileHeader companyName="Beremiz" productName="Additional Function Blocks Library" productVersion="1.0" creationDateTime="2013-09-09T09:56:11"/> + <contentHeader name="Standard Funtion Blocks" author="Laurent Bessard" modificationDateTime="2013-09-10T22:45:31"> + <pou name="RTC" pouType="functionBlock"> + <xhtml:p><![CDATA[0 - current time, 1 - load time from PDT]]></xhtml:p> + <xhtml:p><![CDATA[Preset datetime]]></xhtml:p> + <simpleValue value="FALSE"/> + <xhtml:p><![CDATA[Copy of IN]]></xhtml:p> + <xhtml:p><![CDATA[Datetime, current or relative to PDT]]></xhtml:p> + <variable name="PREV_IN"> + <simpleValue value="FALSE"/> + <variable name="OFFSET"> + <variable name="CURRENT_TIME"> + <xhtml:p><![CDATA[{__SET_VAR(data__->,CURRENT_TIME,__CURRENT_TIME)} + OFFSET := PDT - CURRENT_TIME; + (* PDT + time since PDT was loaded *) + CDT := CURRENT_TIME + OFFSET; + <xhtml:p><![CDATA[The real time clock has many uses including time stamping, setting dates and times of day in batch reports, in alarm messages and so on.]]></xhtml:p> + <pou name="INTEGRAL" pouType="functionBlock"> + <xhtml:p><![CDATA[1 = integrate, 0 = hold]]></xhtml:p> + <xhtml:p><![CDATA[Overriding reset]]></xhtml:p> + <xhtml:p><![CDATA[Input variable]]></xhtml:p> + <xhtml:p><![CDATA[Initial value]]></xhtml:p> + <variable name="CYCLE"> + <xhtml:p><![CDATA[Sampling period]]></xhtml:p> + <xhtml:p><![CDATA[NOT R1]]></xhtml:p> + <xhtml:p><![CDATA[Integrated output]]></xhtml:p> + <xhtml:p><![CDATA[Q := NOT R1 ; +ELSIF RUN THEN XOUT := XOUT + XIN * TIME_TO_REAL(CYCLE); + <xhtml:p><![CDATA[The integral function block integrates the value of input XIN over time.]]></xhtml:p> + <pou name="DERIVATIVE" pouType="functionBlock"> + <xhtml:p><![CDATA[0 = reset]]></xhtml:p> + <xhtml:p><![CDATA[Input to be differentiated]]></xhtml:p> + <variable name="CYCLE"> + <xhtml:p><![CDATA[Sampling period]]></xhtml:p> + <xhtml:p><![CDATA[Differentiated output]]></xhtml:p> + <xhtml:p><![CDATA[IF RUN THEN + XOUT := (3.0 * (XIN - X3) + X1 - X2) + / (10.0 * TIME_TO_REAL(CYCLE)); + <xhtml:p><![CDATA[The derivative function block produces an output XOUT proportional to the rate of change of the input XIN.]]></xhtml:p> + <pou name="PID" pouType="functionBlock"> + <xhtml:p><![CDATA[0 - manual , 1 - automatic]]></xhtml:p> + <xhtml:p><![CDATA[Process variable]]></xhtml:p> + <xhtml:p><![CDATA[Set point]]></xhtml:p> + <xhtml:p><![CDATA[Manual output adjustment - Typically from transfer station]]></xhtml:p> + <xhtml:p><![CDATA[Proportionality constant]]></xhtml:p> + <xhtml:p><![CDATA[Reset time]]></xhtml:p> + <xhtml:p><![CDATA[Derivative time constant]]></xhtml:p> + <variable name="CYCLE"> + <xhtml:p><![CDATA[Sampling period]]></xhtml:p> + <variable name="ERROR"> + <xhtml:p><![CDATA[PV - SP]]></xhtml:p> + <variable name="ITERM"> + <derived name="INTEGRAL"/> + <xhtml:p><![CDATA[FB for integral term]]></xhtml:p> + <variable name="DTERM"> + <derived name="DERIVATIVE"/> + <xhtml:p><![CDATA[FB for derivative term]]></xhtml:p> + <xhtml:p><![CDATA[ERROR := PV - SP ; +(*** Adjust ITERM so that XOUT := X0 when AUTO = 0 ***) +ITERM(RUN := AUTO, R1 := NOT AUTO, XIN := ERROR, + X0 := TR * (X0 - ERROR), CYCLE := CYCLE); +DTERM(RUN := AUTO, XIN := ERROR, CYCLE := CYCLE); +XOUT := KP * (ERROR + ITERM.XOUT/TR + DTERM.XOUT*TD);]]></xhtml:p> + <xhtml:p><![CDATA[The PID (proportional, Integral, Derivative) function block provides the classical three term controller for closed loop control.]]></xhtml:p> + <pou name="RAMP" pouType="functionBlock"> + <xhtml:p><![CDATA[0 - track X0, 1 - ramp to/track X1]]></xhtml:p> + <xhtml:p><![CDATA[Ramp duration]]></xhtml:p> + <variable name="CYCLE"> + <xhtml:p><![CDATA[Sampling period]]></xhtml:p> + <xhtml:p><![CDATA[BUSY = 1 during ramping period]]></xhtml:p> + <simpleValue value="0.0"/> + <xhtml:p><![CDATA[Initial value]]></xhtml:p> + <simpleValue value="T#0s"/> + <xhtml:p><![CDATA[Elapsed time of ramp]]></xhtml:p> + <xhtml:p><![CDATA[BUSY := RUN ; + ELSE XOUT := XI + (X1-XI) * TIME_TO_REAL(T) + <xhtml:p><![CDATA[The RAMP function block is modelled on example given in the standard.]]></xhtml:p> + <pou name="HYSTERESIS" pouType="functionBlock"> + <xhtml:p><![CDATA[IF Q THEN + IF XIN1 < (XIN2 - EPS) THEN +ELSIF XIN1 > (XIN2 + EPS) THEN + <xhtml:p><![CDATA[The hysteresis function block provides a hysteresis boolean output driven by the difference of two floating point (REAL) inputs XIN1 and XIN2.]]></xhtml:p> --- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/plcopen/Standard_Function_Blocks.xml Tue Sep 10 23:10:58 2013 +0200
@@ -0,0 +1,1469 @@
+<?xml version='1.0' encoding='utf-8'?> +<project xmlns:ns1="http://www.plcopen.org/xml/tc6_0201" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.plcopen.org/xml/tc6_0201"> + <fileHeader companyName="Beremiz" productName="Standard Function Blocks Library" productVersion="1.0" creationDateTime="2013-09-09T09:56:11"/> + <contentHeader name="Standard Funtion Blocks" author="Laurent Bessard" modificationDateTime="2013-09-09T10:58:13"> + <pou name="SR" pouType="functionBlock"> + <xhtml:p><![CDATA[Q1 := S1 OR ((NOT R) AND Q1);]]></xhtml:p> + <xhtml:p><![CDATA[The SR bistable is a latch where the Set dominates.]]></xhtml:p> + <pou name="RS" pouType="functionBlock"> + <xhtml:p><![CDATA[Q1 := (NOT R1) AND (S OR Q1);]]></xhtml:p> + <xhtml:p><![CDATA[The RS bistable is a latch where the Reset dominates.]]></xhtml:p> + <pou name="SEMA" pouType="functionBlock"> + <variable name="CLAIM"> + <variable name="RELEASE"> + <variable name="Q_INTERNAL"> + <xhtml:p><![CDATA[Q_INTERNAL := CLAIM OR ( Q_INTERNAL AND (NOT RELEASE)); +BUSY := Q_INTERNAL;]]></xhtml:p> + <xhtml:p><![CDATA[The semaphore provides a mechanism to allow software elements mutually exclusive access to certain ressources.]]></xhtml:p> + <pou name="R_TRIG" pouType="functionBlock"> + <localVars retain="true"> + <xhtml:p><![CDATA[Q := CLK AND NOT M; + <xhtml:p><![CDATA[The output produces a single pulse when a rising edge is detected.]]></xhtml:p> + <pou name="F_TRIG" pouType="functionBlock"> + <localVars retain="true"> + <xhtml:p><![CDATA[Q := NOT CLK AND NOT M; +M := NOT CLK;]]></xhtml:p> + <xhtml:p><![CDATA[The output produces a single pulse when a falling edge is detected.]]></xhtml:p> + <pou name="CTU" pouType="functionBlock"> + <derived name="R_TRIG"/> + <xhtml:p><![CDATA[CU_T(CU); +ELSIF CU_T.Q AND (CV < PV) +Q := (CV >= PV);]]></xhtml:p> + <xhtml:p><![CDATA[The up-counter can be used to signal when a count has reached a maximum value.]]></xhtml:p> + <pou name="CTU_DINT" pouType="functionBlock"> + <derived name="R_TRIG"/> + <xhtml:p><![CDATA[CU_T(CU); +ELSIF CU_T.Q AND (CV < PV) +Q := (CV >= PV);]]></xhtml:p> + <xhtml:p><![CDATA[The up-counter can be used to signal when a count has reached a maximum value.]]></xhtml:p> + <pou name="CTU_LINT" pouType="functionBlock"> + <derived name="R_TRIG"/> + <xhtml:p><![CDATA[CU_T(CU); +ELSIF CU_T.Q AND (CV < PV) +Q := (CV >= PV);]]></xhtml:p> + <xhtml:p><![CDATA[The up-counter can be used to signal when a count has reached a maximum value.]]></xhtml:p> + <pou name="CTU_UDINT" pouType="functionBlock"> + <derived name="R_TRIG"/> + <xhtml:p><![CDATA[CU_T(CU); +ELSIF CU_T.Q AND (CV < PV) +Q := (CV >= PV);]]></xhtml:p> + <xhtml:p><![CDATA[The up-counter can be used to signal when a count has reached a maximum value.]]></xhtml:p> + <pou name="CTU_ULINT" pouType="functionBlock"> + <derived name="R_TRIG"/> + <xhtml:p><![CDATA[CU_T(CU); +ELSIF CU_T.Q AND (CV < PV) +Q := (CV >= PV);]]></xhtml:p> + <xhtml:p><![CDATA[The up-counter can be used to signal when a count has reached a maximum value.]]></xhtml:p> + <pou name="CTD" pouType="functionBlock"> + <derived name="R_TRIG"/> + <xhtml:p><![CDATA[CD_T(CD); +ELSIF CD_T.Q AND (CV > 0) +Q := (CV <= 0);]]></xhtml:p> + <xhtml:p><![CDATA[The down-counter can be used to signal when a count has reached zero, on counting down from a preset value.]]></xhtml:p> + <pou name="CTD_DINT" pouType="functionBlock"> + <derived name="R_TRIG"/> + <xhtml:p><![CDATA[CD_T(CD); +ELSIF CD_T.Q AND (CV > 0) +Q := (CV <= 0);]]></xhtml:p> + <xhtml:p><![CDATA[The down-counter can be used to signal when a count has reached zero, on counting down from a preset value.]]></xhtml:p> + <pou name="CTD_LINT" pouType="functionBlock"> + <derived name="R_TRIG"/> + <xhtml:p><![CDATA[CD_T(CD); +ELSIF CD_T.Q AND (CV > 0) +Q := (CV <= 0);]]></xhtml:p> + <xhtml:p><![CDATA[The down-counter can be used to signal when a count has reached zero, on counting down from a preset value.]]></xhtml:p> + <pou name="CTD_UDINT" pouType="functionBlock"> + <derived name="R_TRIG"/> + <xhtml:p><![CDATA[CD_T(CD); +ELSIF CD_T.Q AND (CV > 0) +Q := (CV <= 0);]]></xhtml:p> + <xhtml:p><![CDATA[The down-counter can be used to signal when a count has reached zero, on counting down from a preset value.]]></xhtml:p> + <pou name="CTD_ULINT" pouType="functionBlock"> + <derived name="R_TRIG"/> + <xhtml:p><![CDATA[CD_T(CD); +ELSIF CD_T.Q AND (CV > 0) +Q := (CV <= 0);]]></xhtml:p> + <xhtml:p><![CDATA[The down-counter can be used to signal when a count has reached zero, on counting down from a preset value.]]></xhtml:p> + <pou name="CTUD" pouType="functionBlock"> + <derived name="R_TRIG"/> + <derived name="R_TRIG"/> + <xhtml:p><![CDATA[CD_T(CD); + IF NOT (CU_T.Q AND CD_T.Q) THEN + IF CU_T.Q AND (CV < PV) + ELSIF CD_T.Q AND (CV > 0) +QD := (CV <= 0);]]></xhtml:p> + <xhtml:p><![CDATA[The up-down counter has two inputs CU and CD. It can be used to both count up on one input and down on the other.]]></xhtml:p> + <pou name="CTUD_DINT" pouType="functionBlock"> + <derived name="R_TRIG"/> + <derived name="R_TRIG"/> + <xhtml:p><![CDATA[CD_T(CD); + IF NOT (CU_T.Q AND CD_T.Q) THEN + IF CU_T.Q AND (CV < PV) + ELSIF CD_T.Q AND (CV > 0) +QD := (CV <= 0);]]></xhtml:p> + <xhtml:p><![CDATA[The up-down counter has two inputs CU and CD. It can be used to both count up on one input and down on the other.]]></xhtml:p> + <pou name="CTUD_LINT" pouType="functionBlock"> + <derived name="R_TRIG"/> + <derived name="R_TRIG"/> + <xhtml:p><![CDATA[CD_T(CD); + IF NOT (CU_T.Q AND CD_T.Q) THEN + IF CU_T.Q AND (CV < PV) + ELSIF CD_T.Q AND (CV > 0) +QD := (CV <= 0);]]></xhtml:p> + <xhtml:p><![CDATA[The up-down counter has two inputs CU and CD. It can be used to both count up on one input and down on the other.]]></xhtml:p> + <pou name="CTUD_UDINT" pouType="functionBlock"> + <derived name="R_TRIG"/> + <derived name="R_TRIG"/> + <xhtml:p><![CDATA[CD_T(CD); + IF NOT (CU_T.Q AND CD_T.Q) THEN + IF CU_T.Q AND (CV < PV) + ELSIF CD_T.Q AND (CV > 0) +QD := (CV <= 0);]]></xhtml:p> + <xhtml:p><![CDATA[The up-down counter has two inputs CU and CD. It can be used to both count up on one input and down on the other.]]></xhtml:p> + <pou name="CTUD_ULINT" pouType="functionBlock"> + <derived name="R_TRIG"/> + <derived name="R_TRIG"/> + <xhtml:p><![CDATA[CD_T(CD); + IF NOT (CU_T.Q AND CD_T.Q) THEN + IF CU_T.Q AND (CV < PV) + ELSIF CD_T.Q AND (CV > 0) +QD := (CV <= 0);]]></xhtml:p> + <xhtml:p><![CDATA[The up-down counter has two inputs CU and CD. It can be used to both count up on one input and down on the other.]]></xhtml:p> + <pou name="TP" pouType="functionBlock"> + <xhtml:p><![CDATA[first input parameter]]></xhtml:p> + <xhtml:p><![CDATA[second input parameter]]></xhtml:p> + <simpleValue value="FALSE"/> + <xhtml:p><![CDATA[first output parameter]]></xhtml:p> + <simpleValue value="T#0s"/> + <xhtml:p><![CDATA[second output parameter]]></xhtml:p> + <variable name="STATE"> + <simpleValue value="0"/> + <xhtml:p><![CDATA[internal state: 0-reset, 1-counting, 2-set]]></xhtml:p> + <variable name="PREV_IN"> + <simpleValue value="FALSE"/> + <variable name="CURRENT_TIME"> + <variable name="START_TIME"> + <xhtml:p><![CDATA[{__SET_VAR(data__->,CURRENT_TIME,__CURRENT_TIME)} +IF ((STATE = 0) AND NOT(PREV_IN) AND IN) (* found rising edge on IN *) + START_TIME := CURRENT_TIME; + IF ((START_TIME + PT) <= CURRENT_TIME) + ET := CURRENT_TIME - START_TIME; +IF ((STATE = 2) AND NOT(IN)) + <xhtml:p><![CDATA[The pulse timer can be used to generate output pulses of a given time duration.]]></xhtml:p> + <pou name="TON" pouType="functionBlock"> + <xhtml:p><![CDATA[first input parameter]]></xhtml:p> + <xhtml:p><![CDATA[second input parameter]]></xhtml:p> + <simpleValue value="FALSE"/> + <xhtml:p><![CDATA[first output parameter]]></xhtml:p> + <simpleValue value="T#0s"/> + <xhtml:p><![CDATA[second output parameter]]></xhtml:p> + <variable name="STATE"> + <simpleValue value="0"/> + <xhtml:p><![CDATA[internal state: 0-reset, 1-counting, 2-set]]></xhtml:p> + <variable name="PREV_IN"> + <simpleValue value="FALSE"/> + <variable name="CURRENT_TIME"> + <variable name="START_TIME"> + <xhtml:p><![CDATA[{__SET_VAR(data__->,CURRENT_TIME,__CURRENT_TIME)} +IF ((STATE = 0) AND NOT(PREV_IN) AND IN) (* found rising edge on IN *) + START_TIME := CURRENT_TIME; + (* STATE is 1 or 2 !! *) + IF ((START_TIME + PT) <= CURRENT_TIME) + ET := CURRENT_TIME - START_TIME; + <xhtml:p><![CDATA[The on-delay timer can be used to delay setting an output true, for fixed period after an input becomes true.]]></xhtml:p> + <pou name="TOF" pouType="functionBlock"> + <xhtml:p><![CDATA[first input parameter]]></xhtml:p> + <xhtml:p><![CDATA[second input parameter]]></xhtml:p> + <simpleValue value="FALSE"/> + <xhtml:p><![CDATA[first output parameter]]></xhtml:p> + <simpleValue value="T#0s"/> + <xhtml:p><![CDATA[second output parameter]]></xhtml:p> + <variable name="STATE"> + <simpleValue value="0"/> + <xhtml:p><![CDATA[internal state: 0-reset, 1-counting, 2-set]]></xhtml:p> + <variable name="PREV_IN"> + <simpleValue value="FALSE"/> + <variable name="CURRENT_TIME"> + <variable name="START_TIME"> + <xhtml:p><![CDATA[{__SET_VAR(data__->,CURRENT_TIME,__CURRENT_TIME)} +IF ((STATE = 0) AND PREV_IN AND NOT(IN)) (* found falling edge on IN *) + START_TIME := CURRENT_TIME; + (* STATE is 1 or 2 !! *) + IF ((START_TIME + PT) <= CURRENT_TIME) + ET := CURRENT_TIME - START_TIME; + <xhtml:p><![CDATA[The off-delay timer can be used to delay setting an output false, for fixed period after input goes false.]]></xhtml:p> --- a/plcopen/plcopen.py Tue Sep 10 10:37:42 2013 +0200
+++ b/plcopen/plcopen.py Tue Sep 10 23:10:58 2013 +0200
@@ -23,7 +23,6 @@
#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-from structures import *
@@ -296,16 +295,13 @@
def setcontentHeader(self, contentheader):
contentheader_obj = self.contentHeader
for attr, value in contentheader.iteritems():
- if attr == "projectName":
- contentheader_obj.setname(value)
- elif attr == "projectVersion":
- contentheader_obj.setversion(value)
- elif attr == "authorName":
- contentheader_obj.setauthor(value)
- elif attr == "pageSize":
- contentheader_obj.setpageSize(*contentheader["pageSize"])
- elif attr == "scaling":
- contentheader_obj.setscaling(contentheader["scaling"])
+ func = {"projectName": contentheader_obj.setname, + "projectVersion": contentheader_obj.setversion, + "authorName": contentheader_obj.setauthor, + "pageSize": lambda v: contentheader_obj.setpageSize(*v), + "scaling": contentheader_obj.setscaling}.get(attr) elif attr in ["modificationDateTime", "organization", "language"]:
setattr(contentheader_obj, attr, value)
setattr(cls, "setcontentHeader", setcontentHeader)
@@ -607,16 +603,7 @@
globalvars.append(PLCOpenParser.CreateElement("varList"))
var = PLCOpenParser.CreateElement("variable", "varListPlain")
- var_type_obj = PLCOpenParser.CreateElement("dataType")
- if not var_type.startswith("ANY") and TypeHierarchy.get(var_type):
- var_type_obj.setcontent(PLCOpenParser.CreateElement(
- var_type.lower() if var_type in ["STRING", "WSTRING"]
- else vartype, "dataType"))
- derived_type = PLCOpenParser.CreateElement("derived", "dataType")
- derived_type.setname(var_type)
- var_type_obj.setcontent(derived_type)
- var.settype(var_type_obj)
@@ -1164,16 +1151,7 @@
content[-1].addnext(varlist)
var = PLCOpenParser.CreateElement("variable", "varListPlain")
- var_type_obj = PLCOpenParser.CreateElement("type", "variable")
- if not var_type.startswith("ANY") and TypeHierarchy.get(var_type):
- var_type_obj.setcontent(PLCOpenParser.CreateElement(
- var_type.lower() if var_type in ["STRING", "WSTRING"]
- else var_type, "dataType"))
- derived_type = PLCOpenParser.CreateElement("derived", "dataType")
- derived_type.setname(var_type)
- var_type_obj.setcontent(derived_type)
- var.settype(var_type_obj)
--- a/plcopen/structures.py Tue Sep 10 10:37:42 2013 +0200
+++ b/plcopen/structures.py Tue Sep 10 23:10:58 2013 +0200
@@ -23,6 +23,7 @@
#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
import string, os, sys, re
+from plcopen import LoadProject LANGUAGES = ["IL","ST","FBD","LD","SFC"]
@@ -38,6 +39,44 @@
# Function Block Types definitions
#-------------------------------------------------------------------------------
+ScriptDirectory = os.path.split(os.path.realpath(__file__))[0] +StdBlockLibrary = LoadProject(os.path.join(ScriptDirectory, "Standard_Function_Blocks.xml")) +AddnlBlockLibrary = LoadProject(os.path.join(ScriptDirectory, "Additional_Function_Blocks.xml")) + "SR": _("SR bistable\nThe SR bistable is a latch where the Set dominates."), + "RS": _("RS bistable\nThe RS bistable is a latch where the Reset dominates."), + "SEMA": _("Semaphore\nThe semaphore provides a mechanism to allow software elements mutually exclusive access to certain ressources."), + "R_TRIG": _("Rising edge detector\nThe output produces a single pulse when a rising edge is detected."), + "F_TRIG": _("Falling edge detector\nThe output produces a single pulse when a falling edge is detected."), + "CTU": _("Up-counter\nThe up-counter can be used to signal when a count has reached a maximum value."), + "CTD": _("Down-counter\nThe down-counter can be used to signal when a count has reached zero, on counting down from a preset value."), + "CTUD": _("Up-down counter\nThe up-down counter has two inputs CU and CD. It can be used to both count up on one input and down on the other."), + "TP": _("Pulse timer\nThe pulse timer can be used to generate output pulses of a given time duration."), + "TON": _("On-delay timer\nThe on-delay timer can be used to delay setting an output true, for fixed period after an input becomes true."), + "TOF": _("Off-delay timer\nThe off-delay timer can be used to delay setting an output false, for fixed period after input goes false."), + "RTC": _("Real time clock\nThe real time clock has many uses including time stamping, setting dates and times of day in batch reports, in alarm messages and so on."), + "INTEGRAL": _("Integral\nThe integral function block integrates the value of input XIN over time."), + "DERIVATIVE": _("Derivative\nThe derivative function block produces an output XOUT proportional to the rate of change of the input XIN."), + "PID": _("PID\nThe PID (proportional, Integral, Derivative) function block provides the classical three term controller for closed loop control."), + "RAMP": _("Ramp\nThe RAMP function block is modelled on example given in the standard."), + "HYSTERESIS": _("Hysteresis\nThe hysteresis function block provides a hysteresis boolean output driven by the difference of two floating point (REAL) inputs XIN1 and XIN2."), +for block_type in ["CTU", "CTD", "CTUD"]: + for return_type in ["DINT", "LINT", "UDINT", "ULINT"]: + StdBlockComments["%s_%s" % (block_type, return_type)] = StdBlockComments[block_type] + infos = pou.getblockInfos() + infos["comment"] = StdBlockComments[infos["name"]] + (var_name, var_type, "rising") + if var_name in ["CU", "CD"] + else (var_name, var_type, var_modifier) + for var_name, var_type, var_modifier in infos["inputs"]] Ordored list of common Function Blocks defined in the IEC 61131-3
@@ -56,81 +95,9 @@
StdBlckLst = [{"name" : _("Standard function blocks"), "list":
- [{"name" : "SR", "type" : "functionBlock", "extensible" : False,
- "inputs" : [("S1","BOOL","none"),("R","BOOL","none")],
- "outputs" : [("Q1","BOOL","none")],
- "comment" : _("SR bistable\nThe SR bistable is a latch where the Set dominates.")},
- {"name" : "RS", "type" : "functionBlock", "extensible" : False,
- "inputs" : [("S","BOOL","none"),("R1","BOOL","none")],
- "outputs" : [("Q1","BOOL","none")],
- "comment" : _("RS bistable\nThe RS bistable is a latch where the Reset dominates.")},
- {"name" : "SEMA", "type" : "functionBlock", "extensible" : False,
- "inputs" : [("CLAIM","BOOL","none"),("RELEASE","BOOL","none")],
- "outputs" : [("BUSY","BOOL","none")],
- "comment" : _("Semaphore\nThe semaphore provides a mechanism to allow software elements mutually exclusive access to certain ressources.")},
- {"name" : "R_TRIG", "type" : "functionBlock", "extensible" : False,
- "inputs" : [("CLK","BOOL","none")],
- "outputs" : [("Q","BOOL","none")],
- "comment" : _("Rising edge detector\nThe output produces a single pulse when a rising edge is detected.")},
- {"name" : "F_TRIG", "type" : "functionBlock", "extensible" : False,
- "inputs" : [("CLK","BOOL","none")],
- "outputs" : [("Q","BOOL","none")],
- "comment" : _("Falling edge detector\nThe output produces a single pulse when a falling edge is detected.")},
- {"name" : "CTU", "type" : "functionBlock", "extensible" : False,
- "inputs" : [("CU","BOOL","rising"),("R","BOOL","none"),("PV","INT","none")],
- "outputs" : [("Q","BOOL","none"),("CV","INT","none")],
- "comment" : _("Up-counter\nThe up-counter can be used to signal when a count has reached a maximum value.")},
- {"name" : "CTD", "type" : "functionBlock", "extensible" : False,
- "inputs" : [("CD","BOOL","rising"),("LD","BOOL","none"),("PV","INT","none")],
- "outputs" : [("Q","BOOL","none"),("CV","INT","none")],
- "comment" : _("Down-counter\nThe down-counter can be used to signal when a count has reached zero, on counting down from a preset value.")},
- {"name" : "CTUD", "type" : "functionBlock", "extensible" : False,
- "inputs" : [("CU","BOOL","rising"),("CD","BOOL","rising"),("R","BOOL","none"),("LD","BOOL","none"),("PV","INT","none")],
- "outputs" : [("QU","BOOL","none"),("QD","BOOL","none"),("CV","INT","none")],
- "comment" : _("Up-down counter\nThe up-down counter has two inputs CU and CD. It can be used to both count up on one input and down on the other.")},
- {"name" : "TP", "type" : "functionBlock", "extensible" : False,
- "inputs" : [("IN","BOOL","none"),("PT","TIME","none")],
- "outputs" : [("Q","BOOL","none"),("ET","TIME","none")],
- "comment" : _("Pulse timer\nThe pulse timer can be used to generate output pulses of a given time duration.")},
- {"name" : "TON", "type" : "functionBlock", "extensible" : False,
- "inputs" : [("IN","BOOL","none"),("PT","TIME","none")],
- "outputs" : [("Q","BOOL","none"),("ET","TIME","none")],
- "comment" : _("On-delay timer\nThe on-delay timer can be used to delay setting an output true, for fixed period after an input becomes true.")},
- {"name" : "TOF", "type" : "functionBlock", "extensible" : False,
- "inputs" : [("IN","BOOL","none"),("PT","TIME","none")],
- "outputs" : [("Q","BOOL","none"),("ET","TIME","none")],
- "comment" : _("Off-delay timer\nThe off-delay timer can be used to delay setting an output false, for fixed period after input goes false.")},
+ [GetBlockInfos(pou) for pou in StdBlockLibrary.getpous()]}, {"name" : _("Additional function blocks"), "list":
- [{"name" : "RTC", "type" : "functionBlock", "extensible" : False,
- "inputs" : [("IN","BOOL","none"),("PDT","DATE_AND_TIME","none")],
- "outputs" : [("Q","BOOL","none"),("CDT","DATE_AND_TIME","none")],
- "comment" : _("Real time clock\nThe real time clock has many uses including time stamping, setting dates and times of day in batch reports, in alarm messages and so on.")},
- {"name" : "INTEGRAL", "type" : "functionBlock", "extensible" : False,
- "inputs" : [("RUN","BOOL","none"),("R1","BOOL","none"),("XIN","REAL","none"),("X0","REAL","none"),("CYCLE","TIME","none")],
- "outputs" : [("Q","BOOL","none"),("XOUT","REAL","none")],
- "comment" : _("Integral\nThe integral function block integrates the value of input XIN over time.")},
- {"name" : "DERIVATIVE", "type" : "functionBlock", "extensible" : False,
- "inputs" : [("RUN","BOOL","none"),("XIN","REAL","none"),("CYCLE","TIME","none")],
- "outputs" : [("XOUT","REAL","none")],
- "comment" : _("Derivative\nThe derivative function block produces an output XOUT proportional to the rate of change of the input XIN.")},
- {"name" : "PID", "type" : "functionBlock", "extensible" : False,
- "inputs" : [("AUTO","BOOL","none"),("PV","REAL","none"),("SP","REAL","none"),("X0","REAL","none"),("KP","REAL","none"),("TR","REAL","none"),("TD","REAL","none"),("CYCLE","TIME","none")],
- "outputs" : [("XOUT","REAL","none")],
- "comment" : _("PID\nThe PID (proportional, Integral, Derivative) function block provides the classical three term controller for closed loop control.")},
- {"name" : "RAMP", "type" : "functionBlock", "extensible" : False,
- "inputs" : [("RUN","BOOL","none"),("X0","REAL","none"),("X1","REAL","none"),("TR","TIME","none"),("CYCLE","TIME","none")],
- "outputs" : [("BUSY","BOOL","none"),("XOUT","REAL","none")],
- "comment" : _("Ramp\nThe RAMP function block is modelled on example given in the standard.")},
- {"name" : "HYSTERESIS", "type" : "functionBlock", "extensible" : False,
- "inputs" : [("XIN1","REAL","none"),("XIN2","REAL","none"),("EPS","REAL","none")],
- "outputs" : [("Q","BOOL","none")],
- "comment" : _("Hysteresis\nThe hysteresis function block provides a hysteresis boolean output driven by the difference of two floating point (REAL) inputs XIN1 and XIN2.")},
-## {"name" : "RATIO_MONITOR", "type" : "functionBlock", "extensible" : False,
-## "inputs" : [("PV1","REAL","none"),("PV2","REAL","none"),("RATIO","REAL","none"),("TIMON","TIME","none"),("TIMOFF","TIME","none"),("TOLERANCE","BOOL","none"),("RESET","BOOL","none"),("CYCLE","TIME","none")],
-## "outputs" : [("ALARM","BOOL","none"),("TOTAL_ERR","BOOL","none")],
-## "comment" : _("Ratio monitor\nThe ratio_monitor function block checks that one process value PV1 is always a given ratio (defined by input RATIO) of a second process value PV2.")}
+ [GetBlockInfos(pou) for pou in AddnlBlockLibrary.getpous()]}, @@ -446,7 +413,7 @@
return Standard_Functions_Decl
-std_decl = get_standard_funtions(csv_file_to_table(open(os.path.join(os.path.split(__file__)[0],"iec_std.csv"))))#, True)
+std_decl = get_standard_funtions(csv_file_to_table(open(os.path.join(ScriptDirectory,"iec_std.csv"))))#, True) StdBlckLst.extend(std_decl)
@@ -458,12 +425,11 @@
words = desc["comment"].split('"')
desc["comment"] = words[1]
- str([ " " + fctdecl[1]+":"+fctdecl[0] for fctdecl in desc["inputs"]]).strip("[]").replace("'",'') +
- str([ " " + fctdecl[1]+":"+fctdecl[0] for fctdecl in desc["outputs"]]).strip("[]").replace("'",'') +
+ desc["usage"] = ("\n (%s) => (%s)" % + (", ".join(["%s:%s" % (input[1], input[0]) + for input in desc["inputs"]]), + ", ".join(["%s:%s" % (output[1], output[0]) + for output in desc["outputs"]]))) BlkLst = StdBlckDct.setdefault(desc["name"],[])
BlkLst.append((section["name"], desc))