Commit 4587029c authored by claes's avatar claes

Documentation changes

parent 9c4c1fd8
......@@ -8,7 +8,11 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_logic.h
! @Summary Arithmetical expression in the C programming language
! Arithmetical expression in the C programming language.
!
! @image orm_aarithm_fo.gif
!
! Optional programmable arithmetical expression in the C
! programming language. The expression is edited by means
! of the Attribute Editor at the object's Expression
......@@ -51,17 +55,17 @@
! (d1 && d2) ? A1 + A2 : A3, means that VAL = A1+ A2,
! if d1 and d2 are TRUE , otherwise VAL = A3
!
! Example
! @b Example
!
! This example shows how digital signals can be counted. Some signals
! are counted if they are TRUE others if they are FALSE and then the
! sum is stored. Node thad Di1 and Di2 are included in the sum if
! sum is stored. Note that Di2 and Di3 are included in the sum if
! they are FALSE.
! @image orm_en1-17.gif
! @image orm_aarithm_1.gif
! See Also
! DArithm, which calculates the value of logical
! expressions.
! @b See Also
! @classlink DArithm pwrb_darithm.html
! @classlink CArithm pwrb_carithm.html
!*/
SObject pwrb:Class
Object AArithm $ClassDef 2
......@@ -316,13 +320,6 @@ SObject pwrb:Class
! Arithmetic expression in the C programming language.
! The expression is edited by means of the Attribute
! Editor and cannot be changed in the target environment.
!
! Example
!
! This example shows how digital signals can be counted.
! Some signals are counted if they are TRUE others if
! they are FALSE and then the sum is stored. Note that
! Di1 and Di2 are included in the sum if they are FALSE.
!*/
Object Expression $Intern 1
Body SysBody
......
......@@ -8,19 +8,22 @@
!/**
! @Version 1.0
! @Code rt_plc_arithm.c
! @Summary Time delay of an analog signal
! Time delay of an analog signal.
! @image orm_adelay_fo.gif
!
! The time delay Tim can vary within the interval:
! { 0 - 100 x MaxCount x ScanTime }
!
! { 0 - 100 * MaxCount * ScanTime }
!
! The delay is implemented in a 100-step shift register.
! The time resolution per step is MaxCount ScanTime and
! maximum time delay is 100 MaxCount ScanTime.
! The time resolution per step is MaxCount * ScanTime and
! maximum time delay is 100 * MaxCount * ScanTime.
!
! Several Adelay objects can be connected in series when
! a higher resolution is needed.
! If the time resolution per step is worse than the
! program cycle time (i.e. MaxCount >1) a mean value is
! program cycle time (i.e. MaxCount > 1) a mean value is
! formed and stored in shift register 1.
!
! The very first sample is stored in every shift
......@@ -36,10 +39,10 @@
! The output signal is fetched from the register
! representing the actual delay.
!
! Example
! @b Example
!
! 1. With MaxCount = 1 anad ScanTime = 20 ms the maximum delay time
! is 100 1 1 / 50 seconds.
! 1. With MaxCount = 1 and ScanTime = 20 ms the maximum delay time
! is 100 * 1 * 1 / 50 seconds.
! if the delay Tim = 1, ActVal(t) will be = In(t-50), i.e. the input
! signal is delayed by 50 execution cycles.
!
......
......@@ -9,13 +9,13 @@
!
!/**
! @Version 1.0
! @Summary Analog input signal
! Analog input.
!
! Configures an analog input signal in the Plant
! Configuration.
!
! Hints
!
! @b Hints
! Put the object below a $PlantHier object in the
! development environment in such a way that it belongs
! to the same target node as its associated channel
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_logic.h
! @Summary And gate
! AND-gate for up to 8 inputs. Used inputs do not have to
! be chosen consecutively.
! @image orm_and_fo.gif
......
......@@ -9,13 +9,13 @@
!
!/**
! @Version 1.0
! @Summary Analog ouput signal
! Analog output.
!
! Configures an analog output signal in the Plant
! Configuration.
!
! Hints
!
! @b Hints
! Put the object below a $PlantHier object in the
! development environment in such a way that it belongs
! to the same target node as its associated channel
......
......@@ -29,20 +29,20 @@
! object. An input doesn't has to be connected, the value can be set at
! runtime or in the configurator.
!
! Example
! @b Example
!
! This is the code in a DataArithm which has a ApCollect object connected
! to the Da1 input.
!
! classdef Da1 ApCollect;
! int i;
! classdef Da1 ApCollect;
! int i;
!
! OA1 = 0;
! for ( i = 0; i < Da1->MaxIndex; i++)
! if ( Da1->Ap[i])
! OA1++;
! OA1 = 0;
! for ( i = 0; i < Da1->MaxIndex; i++)
! if ( Da1->Ap[i])
! OA1++;
!
! Se also
! @b See also
! @classlink DataArithm pwrb_dataarithm.html
! @classlink DpCollect pwrb_dpcollect.html
! @classlink ApDistribute pwrb_apdistribute.html
......
......@@ -12,6 +12,7 @@
! The ApDistribute expands the number of analog outputs that can be
! handled in a DataArithm object.
! @image orm_apdistribute_fo.gif
!
! The DpDistribute has 24 analog outputs, which values can be set from
! an array of Float32 declared in the code of a DataArithm. By connecting
! the data input of the ApDistribute to an data output of a DataArithm,
......@@ -32,19 +33,19 @@
! greater or equal to the value in MaxIndex. Use the type pwr_sApDistribute
! defined in $pwr_inc/rt_plc_data.h.
!
! Example
! @b Example
!
! This is the code in a DataArithm witch has a ApDistribute object connected
! to the ODa1 output.
!
! static pwr_sApDistribute vect;
! int i;
! static pwr_sApDistribute vect;
! int i;
!
! ODa1 = vect;
! for ( i = 0; i < 24; i++)
! vect[i] = 0.1 * i;
! ODa1 = vect;
! for ( i = 0; i < 24; i++)
! vect[i] = 0.1 * i;
!
! Se also
! @b See also
! @classlink DataArithm pwrb_dataarithm.html
! @classlink ApCollect pwrb_apcollect.html
! @classlink DpDistribute pwrb_dpdistribute.html
......
......@@ -22,7 +22,7 @@
! The distribution is carried out by the distribution window in the
! navigator, or by pwr_cmd with the command 'copy appl' or 'copy all'.
!
! Se also
! @b See also
! @classlink NodeConfig pwrb_nodeconfig.html
! @classlink GraphDistribute pwrb_graphdistribute.html
!*/
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_sup.h
! @Summary Analog supervisory
! Analog Supervisory.
! @image orm_asup_fo.gif
!
......@@ -73,8 +74,7 @@
! specifies the hierarchies from which messages are to be
! received.
!
! Hints
!
! @b Hints
! The supervised quantity may belongs to an arbitrary
! object. This means not only signal objects but also
! other objects may supervised; e.g. attributes in a
......@@ -88,9 +88,8 @@
! @image orm_en1-23.gif
! The Supervisory Objects may also be used Outside PLC Programs
!
! See Also
!
! DSup, which handles digital supervisions.
! @b See Also
! @classlink DSup pwrb_dsup.html
!*/
SObject pwrb:Class
Object ASup $ClassDef 18
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_string.h
! @Summary Convert analog value to string
! Convert analog value to string.
! @image orm_atostr_fo.gif
!
......
......@@ -9,13 +9,13 @@
!
!/**
! @Version 1.0
! @Summary Analog value
! Analog value.
!
! Configures a calculated analog value ( floating point
! number) in the Plant Configuration.
!
! Hints
!
! @b Hints
! Put the object below a $PlantHier object in the
! development environment.
! The object is assigned an initial value (!= 0 ) in the
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_logic.h
! @Summary Backup of objects or attributes
! Points out a data segment in rtdb where the items will
! be backed up on a file.
! @image orm_backup_fo.gif
......@@ -26,6 +27,7 @@
! the object referred to have to reside on the same
! target node, else no backup will be done. DataName
! specifies what to backup.
!
! The input of a backup object configured by the PLC
! Editor, is connected to the output of the object that
! will be backed up. It is assumed that this output is
......@@ -39,11 +41,9 @@
! attribute. The corresponding backup object is also
! configured and created in run time.
!
! Hints
!
! Note! Whole signal objects, see table 2-4 on p. 2-4, should
! not be backed up, as this might cause problems after
! booting.
! @b Hints
! Note! Whole signal objects should not be backed up, as
! this might cause problems after booting.
!
! Every type of signal object has a pointer *ActualValue
! and it is not likely that this will be the  same after
......@@ -55,15 +55,15 @@
! Instances in the backup file which,
!
! - are to be found in node's rtdb will be updated
! according to the back-up
! according to the back-up
! - are missed in rtdb, because they are deleted, or
! have got a new name e.g., will be skipped
! have got a new name e.g., will be skipped
!
! One cannot presuppose at change of PROVIEW distribution
! that the back-up file will works.
!
! See Also
! Backup_Conf
! @b See Also
! @classlink Backup_Conf pwrb_backup_conf.html
!*/
SObject pwrb:Class
Object Backup $ClassDef 22
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Configuration of the backup process
! Configures the backup-function of a node.
!
! The objects or parts of objects that will be included
......@@ -21,9 +22,8 @@
! The object has to be configured direct below a $Node
! object representing a process node.
!
! See Also
!
! Backup
! @b See Also
! @classlink Backup pwrb_backup.html
!*/
SObject pwrb:Class
Object Backup_Conf $ClassDef 23
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_io.c
! @Summary Binary coded decimal digital output.
! Binary Coded Decimal Digital output.
! @image orm_en1-25.gif
!
......@@ -29,8 +30,7 @@
!
! Used for example to govern a character display.
!
! Example
!
! @b Example
! Suppose the input signal has the value 235 016.7
! The BCD-value becomes 5016 because
! BCD1 and BCD2 are both set => 6
......@@ -42,9 +42,8 @@
! In that case also the the decimal digits are
! representing 10 000 and 100 000 binary coded decimal.
!
! See Also
!
! DiBCD, which implements the reverse function; see p.
! @b See Also
! @classlink DiBCD pwrb_dibcd.html
!*/
SObject pwrb:Class
Object BCDDo $ClassDef 24
......
......@@ -9,12 +9,13 @@
!
!/**
! @Version 1.0
! @Summary Multi-row comment in plc document
! Object to create a multi-row text.
!
! Used when a larger description is to be done; e.g. in a
! Document object.
!
! Example
! @b Example
! @image orm_en1-28.gif
!*/
SObject pwrb:Class
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_logic.h
! @Summary User programmable object in the C programming language
! User programmable object in the C programming language.
! @image orm_carithm_fo.gif
!
......@@ -18,26 +19,26 @@
!
! Up to 8 analog inputs respectively outputs and up to 8
! digital inputs respectively outputs.
!
! Digital inputs may be inverted either by means of the
! Attribute Editor, or by the logical operator '!' in the
! Code attribute.
!
! Example
!
! @b Example
! This application starts to declare a variable 'r1'. The r1 is
! assigned the sum of A1 and A2. As A2 is left open it will be
! given a value internally. If r1 is greater then 2.7 OA1 will
! be increased by one, otherwise cleard.
! @image orm_en1-30.gif
! @image orm_carithm_1.gif
!
! Hints
!
! @b Hints
! The symbol of the CArithm accommodates to the Code
! attribute. To avoid very wide CArithm objects finish
! statements with return.
!
! See Also
! AArithm, DArithm.
! @b See Also
! @classlink AArithm pwrb_aarithm.html
! @classlink DArithm pwrb_darithm.html
!*/
SObject pwrb:Class
Object CArithm $ClassDef 26
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Configures an analog input channel
! Configures an analog input channel independent of the
! type of physical Ai-card. The conversion from signal
! value to actual value is done by polynomials.
......@@ -29,13 +30,7 @@
! -- sensor polynomial p, is determined by SensorPolyType
! -- filter function f, is determined by FilterType in Ai object
!
! See Also
!
! ChanAit, whose conversion to ActualValue is based on a
! table.
!
! Hints
!
! @b Hints
! ChanAi objects are configured below a suitable card
! object.
!
......@@ -44,6 +39,9 @@
! To create card object with channel objects belonging to
! it the function 'Configure Card' in "Utility Window" is
! recommended.
!
! @b See also
! @classlink ChanAit pwrb_chanait.html
!*/
SObject pwrb:Class
Object ChanAi $ClassDef 28
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Configures an analog input channel with table conversion
! Configures an analog input channel independent of the
! type of physical Ai-card. The conversion from signal
! value to actual value is done by means of a table.
......@@ -47,10 +48,11 @@
! In the target environment the following occurs with the
! SigValue:
!
! If SigValuemin <= s(SigValue) >= SigValuemax , then
! - the index n is calculated as SigValue(n) = s(SigValue) < SigValue(n+1)
! t( s(SigValue) ) = Intercept(n) + Slope(n)* s(SigValue)
! otherwise, t( s(SigValue) ) = OutValue for the first
! - If SigValuemin <= s(SigValue) >= SigValuemax , then
! - the index n is calculated as
! SigValue(n) = s(SigValue) < SigValue(n+1)
! - t( s(SigValue) ) = Intercept(n) + Slope(n)* s(SigValue)
! - otherwise, t( s(SigValue) ) = OutValue for the first
! or the last pair of numbers depending on
! s(SigValue) < s(SigValuemin) or s(SigValuemax) > s(SigValuemax)
!
......@@ -58,12 +60,12 @@
! put in, for each NoOfCoordinates, the corresponding
! pair of numbers (InValue, OutValue ) respectively (Intercept, Slope).
!
! See Also
!
! ChanAi, whose conversion to ActualValue is based on a
! polynomial.
! ChanAit objects are configured below a suitable card
! object.
!
! @b See also
!
! @classlink ChanAi pwrb_chanai.html
!*/
SObject pwrb:Class
Object ChanAit $ClassDef 29
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Configures an analog output channel
! Configures an analog output channel independent of the
! type of physical Ao-card.
!
......@@ -23,8 +24,7 @@
! the output is based on FixedOutValue. Otherwise TestOn
! will settles which attribute the output is based on.
!
! Hints
!
! @bHints
! ChanAo objects are configured below a suitable card
! object.
!
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Configures a pulse counter channel
! Configures a pulse counter channel independent of the
! type of physical Co-card.
!
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Configures a digital input channel
! Configures a digital input channel independent of the
! type of physical Di-card.
!
......@@ -22,8 +23,7 @@
! InvMask1 and ConvMask1 to card object, but InvertOn and
! ConversionOn belongs to this object.
!
! Hints
!
! @b Hints
! ChanDi objects are configured below a suitable Di-card
! object.
! Rack and card objects to different I/O systems are
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Configures a digital output channel
! Configures a digital output channel independent of the
! type of physical Do-card.
!
......@@ -23,8 +24,7 @@
! the output is based on FixedOutValue. Otherwise TestOn
! will settles which attribute the output is based on.
!
! Hints
!
! @b Hints
! ChanDo objects are configured below a suitable Do-card
! object.
! Rack and card objects to different I/O systems are
......
......@@ -19,8 +19,8 @@
!
! The name of the object states the volume to load.
!
! @b See also
! @classlink NodeConfig pwrb_nodeconfig.html
! @classlink ClassVolumeLoad pwrb_classvolumeload.html
!
!*/
!
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_logic.h
! @Summary Configures a counter input signal
! Counter.
!
! Configures a counter input signal in the Plant
......@@ -19,8 +20,7 @@
! I/O-system are read by a PLC job and converted to
! Actual Value by the IO job.
!
! Hints
!
! @b Hints
! Put the object below a $PlantHier object in the
! development environment in such a way that it belong to
! the same target node as its associated channel object.
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_arithm.c
! @Summary Compares an analog value to a high limit
! Compares an analog value ( signal or parameter) to a high
! limit.
! @image orm_en1-36.gif
......@@ -24,9 +25,8 @@
! output becomes FALSE as soon as the input becomes less
! than or equal to the high limit minus the hysteresis.
!
! See Also
!
! Compl.
! @b See Also
! @classlink Compl pwrb_compl.html
!*/
SObject pwrb:Class
Object Comph $ClassDef 39
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_arithm.c
! @Summary Compares an analog value with a low limit
! Compares an analog value (signal or parameter) with a
! low limit.
! @image orm_en1-38.gif
......@@ -25,9 +26,8 @@
! as the input becomes greater than or equal to the low
! limit plus the hysteresis.
!
! See Also
!
! Comph.
! @b See Also
! @classlink Comph pwrb_comph.html
!*/
SObject pwrb:Class
Object Compl $ClassDef 40
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_io.c
! @Summary Pulse counter
! Pulse counter.
! @image orm_count_fo.gif
!
......@@ -17,8 +18,7 @@
! equal to a present value.
! The counter is triggered on leading edges.
!
! Hints
!
! @b Hints
! The object can be used as a 'pulse counter card' in the
! software at maximum one pulse every second (edge
! detecting) loop , i.e. a maximum of 25 Hz, if the base
......
......@@ -10,17 +10,20 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_io.h
! @Summary Conditional storage of Ai signal
! Conditional Storage Analog input.
! @image orm_cstoai_fo.gif
!
! @image orm_cstoai_fo.gif
!
! Conditional storage of an analog value on a specified
! local Ai-signal (= Ai object).
!
! Conditional is aimed at the con-input, which is
! supposed to be connected.
! Note! This object is used for simulation purposes.
! IOSimulFlag will be set TRUE and IOReadWriteFlag FALSE
! in the $Node object, i.e. any physical I/O-hardware may
!
! @b Note!
! This object is used for simulation purposes.
! SimulFlag will be set TRUE and ReadWriteFlag FALSE
! in the IOHandler object, i.e. any physical I/O-hardware may
! not be used on the node in connection to this object.
!*/
SObject pwrb:Class
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_io.h
! @Summary Conditional storage of Ao signal
! Conditional Storage Analog output.
! @image orm_cstoao_fo.gif
!
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_io.h
! @Summary Conditional storage of analog attribute
! Conditional Storage Analog parameter.
! @image orm_cstoap_fo.gif
!
......@@ -30,7 +31,7 @@
! It is not allowed, by means of a function in C or PLC
! programs, to write in any of the inputs.
!
! Example
! @b Example
!
! At Gain-Scheduling it would be possible to use CStoAp
! objects with the analog inputs left open; see below.
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_io.h
! @Summary Conditional storage of integer attribute
! Conditional Storage Integer parameter.
! @image orm_cstoip_fo.gif
!
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_string.h
! @Summary Conditional storage of string attribute.
! Conditional Storage of string attribute.
! @image orm_cstosp_fo.gif
!
......@@ -26,8 +27,9 @@
! It is not allowed, by means of a function in C or PLC
! programs, to write in any of the inputs.
!
! Example
! It would be possible to use CStoSp to change the DetectText.
! @b Example
! It is possible to use CStoSp to change the DetectText in
! ASup or DSup objects.
!*/
SObject pwrb:Class
Object CStoSp $ClassDef 311
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_string.h
! @Summary Conditional storage of string value.
! Conditional storage of string value.
! @image orm_cstosv_fo.gif
!
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_grafcet.h
! @Summary Conditional execution of plc-objects in a sub-window
! Conditional execution of objects located in a
! Sub-window.
! @image orm_csub_fo.gif
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_arithm.c
! @Summary Interpolates in a table
! Interpolates in a table.
! @image orm_curve_fo.gif
!
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_logic.h
! @Summary User-defined logical expression
! User-defined logical expression.
! @image orm_darithm_fo.gif
!
......@@ -40,7 +41,7 @@
! easier to get access from the object display. Unused
! inputs make compilation errors.
!
! Example
! @b Example
!
! 1 Combinational circuit. In the following example '&&' means
! logical and, '||' means logical or and '!' means not.
......@@ -58,8 +59,9 @@
!
! Expression: (A1 + 3.5 * A2) < A3
!
! See Also
! AArithm that calculates the value of arithmetic
! @b See Also
! @classlink AArithm pwrb_aarithm.html
! @classlink CArithm pwrb_carithm.html
!*/
SObject pwrb:Class
Object DArithm $ClassDef 82
......
......@@ -52,7 +52,7 @@
! DpDistribute, ApDistribute, DpCollect and ApCollect objects can be used
! to expand the number of inputs and outputs to the DataArithm.
!
! Se also
! @b See also
! @classlink GetData pwrb_getdata.html
! @classlink DpCollect pwrb_dpcollect.html
! @classlink ApCollect pwrb_apcollect.html
......
......@@ -27,18 +27,18 @@
! MaxIndex should be assigned the number of used inputs in the DataCollect
! object.
!
! Example
! @b Example
!
! This is the code in a DataArithm which has a DataCollect object connected
! to the Da1 input.
!
! classdef Da1 DataCollect;
! int i;
! classdef Da1 DataCollect;
! int i;
!
! OA1 = 0;
! for ( i = 0; i < Da1->MaxIndex; i++)
! if ( ((pwr_sClass_Mtrl *)(Da1->DataP[i]))->Length > 10.0)
! OA1++;
! OA1 = 0;
! for ( i = 0; i < Da1->MaxIndex; i++)
! if ( ((pwr_sClass_Mtrl *)(Da1->DataP[i]))->Length > 10.0)
! OA1++;
!
!*/
SObject pwrb:Class
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Digital input signal
! Digital input.
!
! Configures a digital input signal in the Plant
......@@ -28,8 +29,7 @@
! sampled signal latest become FALSE until it is
! allowed to be TRUE again.
!
! Hints
!
! @b Hints
! Put the object below a $PlantHier object in the
! development environment in such a way that it belongs
! to the same target node as its associated channel
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_io.c
! @Summary Digital input binary coded decimal
! Digital input Binary Coded Decimal.
! @image orm_en1-55.gif
!
......@@ -24,7 +25,7 @@
! BCD4 - BCD7 represents integers in the interval {10,20,...,90}
! BCD8 - BCDB represents integers in the interval {100,200,...,900}
!
! Example
! @b Example
! 1 BCD1 = BCD4 = BCD7 = TRUE and the rest FALSE.
!
! VAL gets the value BCD1 * 2 + BCD4 * 10 + BCD7 * 80 = 92
......@@ -34,12 +35,12 @@
!
! VAL = last valid value and err is TRUE, i.e. one
!
! Hints
! @b Hints
! More DiBCD objects can be connected in parallel to
! additional BCD-input signals.
!
! See Also
! BCDDo, which implements the reverse function.
! @b See Also
! @classlink BCDDo pwrb_bcddo.html
!*/
SObject pwrb:Class
Object DiBCD $ClassDef 87
......
......@@ -10,13 +10,13 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_logic.h
! @Summary Digital output signal
! Digital output.
!
! Configures a digital output signal in the Plant
! Configuration.
!
! Hints
!
! @b Hints
! Put the object below a $PlantHier object in the
! development environment in such a way that it belongs
! to the same target node as its associated channel
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Configures documents in the PLC editor
! Configures in the working area of the PLC Editor an
! area in A-format.
! @image orm_en1-56.gif
......@@ -35,22 +36,6 @@
! object will be created. The file is default located on
! 'pwrp_tmp'.
!
! By the pwr_plc commands:
! · document /repage -- the Document objects are page
! numbered on the form x.y. The number before point
! specifies a PlcPgm within the PROVIEW system and the
! number after specifies Document objects in the same
! order as they have been created in the PLC program.
! If the pages have to be numbered in a certain order
! they have to be ordered in the wanted way in the
! work-bench database.
!
! · document /list -- writes an alphabetic list with the
! name on all Document objects in the system.
! The transcription is default sent to the
! same window as from where the development environment
! was started.
!
! If there is a need for a larger working surface choose
! A3 format in the Document object. The objects in the
! transcription will be somewhat reduced in scale
......
......@@ -29,20 +29,20 @@
! object. An input doesn't has to be connected, the value can be set at
! runtime or in the configurator.
!
! Example
! @b Example
!
! This is the code in a DataArithm which has a DpCollect object connected
! to the Da1 input.
!
! classdef Da1 DpCollect;
! int i;
! classdef Da1 DpCollect;
! int i;
!
! OA1 = 0;
! for ( i = 0; i < Da1->MaxIndex; i++)
! if ( Da1->Dp[i])
! OA1++;
! OA1 = 0;
! for ( i = 0; i < Da1->MaxIndex; i++)
! if ( Da1->Dp[i])
! OA1++;
!
! Se also
! @b See also
! @classlink DataArithm pwrb_dataarithm.html
! @classlink ApCollect pwrb_apcollect.html
! @classlink DpDistribute pwrb_dpdistribute.html
......
......@@ -32,23 +32,22 @@
! greater or equal to the value in MaxIndex. Use the type pwr_sDpDistribute
! defined in $pwr_inc/rt_plc_data.h.
!
! Example
!
! @b Example
! This is the code in a DataArithm witch has a DpDistribute object connected
! to the ODa1 output.
!
! static pwr_sDpDistribute vect;
! int i;
! static pwr_sDpDistribute vect;
! int i;
!
! ODa1 = vect;
! for ( i = 0; i < 24; i++) {
! if ( d1)
! vect[i] = 1;
! else
! vect[i] = 0;
! }
! ODa1 = vect;
! for ( i = 0; i < 24; i++) {
! if ( d1)
! vect[i] = 1;
! else
! vect[i] = 0;
! }
!
! Se also
! @b See also
! @classlink DataArithm pwrb_dataarithm.html
! @classlink DpCollect pwrb_dpcollect.html
! @classlink ApDistribute pwrb_apdistribute.html
......
......@@ -10,13 +10,15 @@
!/**
! @Version 1.0
! @Code rt_plc_drive.c
! @Summary Start/Stop motor control
! START/ STOP motor control with supervision of contactor
! response and motion guard.
! @image orm_en1-58.gif
! Three different types of interlockings:
! · safety interlocking SafeStop
! · production interlocking ProdStop
! · 'prevent to start' interlocking, NoStart
!
! - safety interlocking SafeStop
! - production interlocking ProdStop
! - 'prevent to start' interlocking, NoStart
!
! SafeStop and ProdStop disable, each separately, the
! internal alarms (Alarm1, ..., Alarm3), i.e. when
......@@ -30,33 +32,33 @@
! output signal ManMode in the following way:
! @image orm_en1-59.gif
!
! LOCAL
! · Used at operation from for example an outer
! @b LOCAL
! - Used at operation from for example an outer
! operator's console, switching equipment etc.
! · Only safety interlocking SafeStop is taken
! - Only safety interlocking SafeStop is taken
! into account.
! · LocStart has a spring back push button
! - LocStart has a spring back push button
! function with a closing start function. The
! signal has to be set until ConOn is TRUE;
! see below.
! · LocDrive has a spring back push button
! - LocDrive has a spring back push button
! function with an opening stop function. STOP
! is also done when Local is reset.
! @image orm_en1-60.gif
!
! MANUAL/AUTO
! · Both production and safety interlockings are
! @b MANUAL/AUTO
! - Both production and safety interlockings are
! concerned.
! · In MANUAL mode START/STOP request is handled
! - In MANUAL mode START/STOP request is handled
! by the operator by means of the attributes
! ManSta respectively ManSto.
! · In AUTO mode START request is done on a
! - In AUTO mode START request is done on a
! leading edge on AutoStart; STOP request when
! AutoStart is FALSE, i.e. not at any edge but
! on the level.
! · The changes,
! - The changes,
! -- AUTO -> MANUAL, do not influence the
! operational order, Order.
! operational order, Order.
! -- MANUAL -> AUTO. If the operational order
!
! Supervision. If contactor response respectively motion
......@@ -66,9 +68,9 @@
! value of ProdTim or SpeedTim itself that determines if
! these are concerned or not.
!
! Examples
! @h1 Examples
!
! Worm Conveyer with Motion Guard
! @b Worm Conveyer with Motion Guard
!
! Assumptions:
!
......@@ -85,7 +87,7 @@
! @image orm_en1-61.gif
! Periodical Control of a Contactor
!
! Forward/Backward operation
! @b Forward/Backward operation
!
! Driving only in the operational mode AUTO. Forward/backward operation
! is controlled by Dv-signals. Response from the contactor exists, but
......@@ -95,7 +97,7 @@
! @image orm_en1-62.gif
! Configuration of a Forward/Backward Operation
!
! Two Conveyers
! @b Two Conveyers
! @image orm_en1-63.gif
!
! The conveyer Trp1 may start only if the conveyer Trp2 is already running
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Stores data for a fast graph à la storage oscilloscope.
! Stores data for a fast graph à la storage oscilloscope.
!
! In every node where fast graphs should be stored there
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Configuration of DsFast process
! Specifies attributes of a single DsFast.
!
! In every node where fast graphs should be stored there
......@@ -16,8 +17,7 @@
! DsFast objects.
! @image orm_en1-67.gif
!
! Hints
!
! @b Hints
! The DsFastConf object is placed below the $Node object.
! If a Ds_Fast job is loaded to a node, which has no
! DsFastConf object, it will execute with 10 Hz.
......@@ -30,8 +30,8 @@
! EBUILD-file.
! @image orm_en1-68.gif
!
! See Also
! DsFast
! @b See Also
! @classlink DsFast pwrb_dsfast.html
!*/
SObject pwrb:Class
Object DsFastConf $ClassDef 105
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Long time storage of data for a trend graph
! Long time storage of data for a trend graph.
!
! In every node where trend graphs shall be stored there
......@@ -54,8 +55,7 @@
! - pwr_tInt8, pwr_tInt16, pwr_tInt32
! - pwr_tUInt8, pwr_tUInt16, pwr_tUInt32
!
! Hints
!
! @b Hints
! If a signal is associated with an object by the type
! DsTrend, DsFast, or DsHist this relation may be marked
! by putting the object direct below the current signal
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Configuration of DsTrend process
! Specifies attributes of a single DsTrend job.
!
! In every node where trend graphs shall be stored there
......@@ -17,8 +18,7 @@
! @image orm_en1-71.gif
! DsTrend Job with Matching Objects
!
! Hints
!
! @b Hints
! Because a DsTrend job default is loaded to each OpenVMS
! node it is suitable to configure DsTrendConf object on
! this nodes. The DsTrendConf objects are placed below
......@@ -27,8 +27,8 @@
! If a Ds_Trend job is loaded to a node that has no
! DsTrendConf object, it will execute with 1 Hz.
!
! See Also
! DsTrend.
! @b See Also
! @classlink DsTrend pwrb_dstrend.html
!*/
SObject pwrb:Class
Object DsTrendConf $ClassDef 109
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_sup.h
! @Summary Digital supervisory
! Digital Supervisory.
! @image orm_dsup_fo.gif
!
......@@ -59,13 +60,14 @@
! unacknowledged C- resp. D-alarms is shown, while the
! text is put into the alarm list, where the
! acknowledgement can be done too.
!
! Different types of out units exist:
!
! · OPERATOR: The select list is defined by an attribute
! in a User object.
! · PRINTER: The select list is defined by an
! attribute in an EventPrinter
! object.
! - OPERATOR: The select list is defined by an attribute
! in a User object.
! - PRINTER: The select list is defined by an
! attribute in an EventPrinter
! object.
!
! Note! A message created by an DSup object gets the same
! identity as the supervised object. The attribute
......@@ -73,7 +75,7 @@
! specifies the hierarchies from which messages are to be
! received.
!
! Hints
! @b Hints
! Supervision of a trailing edge can be done when the In-signal
! has been inverted.
!
......@@ -88,8 +90,8 @@
! Editor and the eventmonitor takes care of the
! supervision.
!
! See Also
! ASup which handles analog supervision.
! @b See Also
! @classlink ASup pwrb_asup.html
!*/
SObject pwrb:Class
Object DSup $ClassDef 110
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_string.h
! @Summary Convert digital value to string
! Convert digital value to string.
! @image orm_dtostr_fo.gif
!
......
......@@ -9,13 +9,14 @@
!
!/**
! @Version 1.0
! @Summary Digital value
! Digital value.
!
! Configures a calculated binary value in the Plant
! Configuration. The value is used as a binary flag with
! the values TRUE or FALSE.
!
! Hints
! @b Hints
! Put the object below a $PlantHier object in the
! development environment.
!
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_logic.h
! @Summary Edge detector
! Edge detector.
! @image orm_edge_fo.gif
!
......
......@@ -10,22 +10,25 @@
!/**
! @Version 1.0
! @Code rt_plc_arithm.c
! @Summary First order lag filter
! First Order Lag Filter.
! @image orm_filter_fo.gif
!
! The input signal gets an exponential smoothing.
! VAL = a * In+ (1 - a) * X = X + a (In - X) , where
! X = FeedB, if FeedB is connected, ActValt - 1, otherwise
!
! VAL = a * In + (1 - a) * X = X + a * (In - X) , where
!
! X = FeedB, if FeedB is connected,
! ActValt - 1, otherwise
!
! a = ScanTime / FiltCon and 0 < a < 1.0. If a >= 1.0
! no filtering is done.
! a = ScanTime / FiltCon and 0 < a < 1.0.
! If a >= 1.0 no filtering is done.
!
! An external signal may also be used as feedback; e.g.
! @image orm_en1-77.gif
!
! Example
!
! If a (= ScanTime / FiltCon ) is small, 0.1 - 0.2, the output gets
! @b Example
! If a (= ScanTime / FiltCon) is small, 0.1 - 0.2, the output gets
! a character of a slowly moving average.
! @image orm_en1-78.gif
!*/
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Frame object
! Single-row text object.
!
! If no text is specified, in e.g. a Frame object, the
......@@ -16,12 +17,12 @@
!
! The only difference between Frame, Head, Text, and
! Title is the default values of the attributes.
! @image orm_en1-79.gif
! @image orm_text_3.gif
! They are used in Document objects where, for instance,
! Title specifies what the configuration is doing, i.e.
! - Title specifies what the configuration is doing, i.e.
! the function.
! Sub-functions are named by Head objects.
! Frame and Text are used to information of details.
! - Sub-functions are named by Head objects.
! - Frame and Text are used to information of details.
!*/
SObject pwrb:Class
Object Frame $ClassDef 119
......@@ -34,7 +35,7 @@ SObject pwrb:Class
!/**
! Specifies if the text is to be surrounded by a some
! kind of frame.
! @image orm_en1-81.gif
! @image orm_text_2.gif
!*/
Object FrameAttribute $Intern 1
Body SysBody
......@@ -73,7 +74,7 @@ SObject pwrb:Class
!/**
! The attribute influence the appearance of the text. The
! following values are used: 0, 1, 2, 3.
! @image orm_en1-80.gif
! @image orm_text_1.gif
!*/
Object TextAttribute $Intern 5
Body SysBody
......
......@@ -15,7 +15,7 @@
! The FriendNodeConfig object is created in the project volume as a toplevel
! object in the node-hierachy.
!
! Se also
! @b See also
! @classlink NodeConfig pwrb_nodeconfig.html
!
!*/
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Get Ai signal
! Get Analog input.
! @image orm_getai_fo.gif
!
......@@ -18,11 +19,12 @@
! The complete name of the Ai-signal has to be supplied;
! its last segment is shown in the right empty part of
! the symbol.
!
! The GetAi object
! is a pure address reference to the I/O-copied area
! - is a pure address reference to the I/O-copied area
! for Ai-signals,
! contains no relevant information (=data) in rtdb,
! is without executable code.
! - contains no relevant information (=data) in rtdb,
! - is without executable code.
!*/
SObject pwrb:Class
Object GetAi $ClassDef 120
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Get Ao signal
! Get Analog output.
! @image orm_getao_fo.gif
!
......@@ -19,10 +20,10 @@
! the symbol.
!
! The GetAo object
! is a pure address reference to the I/O-copied area
! - is a pure address reference to the I/O-copied area
! for Ao-signals,
! contains no relevant information (=data) in rtdb,
! is without executable code.
! - contains no relevant information (=data) in rtdb,
! - is without executable code.
!*/
SObject pwrb:Class
Object GetAo $ClassDef 121
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Get analog attribute
! Get Analog parameter.
! @image orm_getap_fo.gif
!
......@@ -16,13 +17,12 @@
! parameter, in- or output signal) in an arbitrary
! object.
!
! The complete name of quantity has to be supplied; se
! hints below.
! The GetAp object
!
! is a pure address reference,
! contains no relevant information (=data) in rtdb,
! is without executable code.
! The complete name of quantity has to be supplied.
!
! The GetAp object
! - is a pure address reference,
! - contains no relevant information (=data) in rtdb,
! - is without executable code.
!*/
SObject pwrb:Class
Object GetAp $ClassDef 122
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Get analog value
! Get Analog value.
! @image orm_getav_fo.gif
!
......@@ -19,11 +20,10 @@
! of the symbol.
!
! The GetAv object
! is a pure address reference to the I/O-copied area
! - is a pure address reference to the I/O-copied area
! for Av-signals,
!
! contains no relevant information (=data) in rtdb,
! is without executable code.
! - contains no relevant information (=data) in rtdb,
! - is without executable code.
!*/
SObject pwrb:Class
Object GetAv $ClassDef 123
......
......@@ -14,7 +14,7 @@
! DataArithm-objects by connecting the output of the GetData
! in the plc editor.
!
! Se also
! @b See also
! @classlink DataArithm pwrb_dataarithm.html
!*/
!
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Get Di signal
! Get Digital input.
! @image orm_getdi_fo.gif
!
......@@ -19,10 +20,10 @@
! of the symbol.
!
! The GetDi object
! is a pure address reference to the I/O-copied area
! - is a pure address reference to the I/O-copied area
! for Di-signals,
! contains no relevant information (=data) in rtdb,
! is without executable code.
! - contains no relevant information (=data) in rtdb,
! - is without executable code.
!*/
SObject pwrb:Class
Object GetDi $ClassDef 124
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Get Do signal
! Get Digital output.
! @image orm_getdo_fo.gif
!
......@@ -19,10 +20,10 @@
! of the symbol.
!
! The GetDo object
! is a pure address reference to the I/O-copied area
! - is a pure address reference to the I/O-copied area
! for Do-signals,
! contains no relevant information (=data) in rtdb,
! is without executable code.
! - contains no relevant information (=data) in rtdb,
! - is without executable code.
!*/
SObject pwrb:Class
Object GetDo $ClassDef 125
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Get digital attribute
! Get Digital parameter.
! @image orm_getdp_fo.gif
!
......@@ -18,11 +19,10 @@
!
! The complete name of the quantity has to be supplied.
!
! The GetDp object
!
! is a pure address reference to a binary quantity,
! contains no relevant information (=data) in rtdb,
! is without executable code.
! The GetDp object
! - is a pure address reference to a binary quantity,
! - contains no relevant information (=data) in rtdb,
! - is without executable code.
!*/
SObject pwrb:Class
Object GetDp $ClassDef 126
......
......@@ -9,7 +9,9 @@
!
!/**
! @Version 1.0
! @Summary Get digital value
! Get Digital value.
!
! @image orm_getdv_fo.gif
!
! Fetches the engineering value for specified Dv-signal
......@@ -18,11 +20,12 @@
! The complete name of the Dv-signal has to be supplied;
! its last segment name is shown in the right empty part
! of the symbol.
!
! The GetDv object
! is a pure address reference to the I/O-copied area
! - is a pure address reference to the I/O-copied area
! for Dv-signals,
! contains no relevant information (=data) in rtdb,
! is without executable code.
! - contains no relevant information (=data) in rtdb,
! - is without executable code.
!*/
SObject pwrb:Class
Object GetDv $ClassDef 127
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_io.h
! @Summary Get integer attribute
! Get Integer parameter.
! @image orm_getip_fo.gif
!
......@@ -18,16 +19,15 @@
!
! The complete name of the parameter has to be supplied.
! The GetIp object
! is a pure address reference,
! contains no relevant information (=data) in rtdb,
! is without executable code.
!
! Example
! - is a pure address reference,
! - contains no relevant information (=data) in rtdb,
! - is without executable code.
!
! @b Example
! In the example below the value of the integer parameter, AccMod is stored:
!
! - unconditionally by STOIP
! _ conditionally by CSTOIP
! - unconditionally by StoIp
! - conditionally by CStoIp
!
! The value is also unconditionally stored as a pwr_tFloat32 on an attribute
! pwr_float32 in the object named TIC2M
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_io.h
! @Summary Get Co signal
! Get Pulse input.
! @image orm_getpi_fo.gif
!
......@@ -23,10 +24,11 @@
! The name of the object is shown in the button of the
! GetPi-symbol.
! @image orm_en1-95.gif
!
! The GetPi object
! is a pure address reference,
! contains no relevant information (=data) in rtdb,
! is without executable code.
! - is a pure address reference,
! - contains no relevant information (=data) in rtdb,
! - is without executable code.
!*/
SObject pwrb:Class
Object GetPi $ClassDef 129
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Get String attribute
! Get String parameter.
! @image orm_getsp_fo.gif
!
......@@ -19,9 +20,9 @@
! The complete name of quantity has to be supplied.
!
! The GetSp object
! is a pure address reference,
! contains no relevant information (=data) in rtdb,
! is without executable code.
! - is a pure address reference,
! - contains no relevant information (=data) in rtdb,
! - is without executable code.
!*/
SObject pwrb:Class
Object GetSp $ClassDef 309
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Get string value
! Get String value.
! @image orm_getsv_fo.gif
!
......@@ -17,9 +18,10 @@
! The complete name of the Sv-signal has to be supplied;
! its last segment name is shown in the right empty part
! of the symbol.
!
! The GetSv object
! contains no relevant information (=data) in rtdb,
! is without executable code.
! - contains no relevant information (=data) in rtdb,
! - is without executable code.
!*/
SObject pwrb:Class
Object GetSv $ClassDef 304
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Configures a window to display GMS-graphic
! Configures a window to display GMS-graphic.
!
! To display GMS-graphics on a monitor the graphics have
......
......@@ -22,7 +22,7 @@
! The distribution is carried out by the distribution window in the
! navigator, or by pwr_cmd with the command 'copy graph' or 'copy all'.
!
! Se also
! @b See also
! @classlink NodeConfig pwrb_nodeconfig.html
! @classlink ApplDistribute pwrb_appldistribute.html
!*/
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_io.c
! @Summary Converts a 16-bits Gray code value into its decimal equivalent
! Converts a 16-bits Gray code value into its decimal
! equivalent.
! @image orm_gray_fo.gif
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Header object
! Single-row text object.
!
! If no text is specified, in e.g. a Frame object, the
......@@ -16,15 +17,15 @@
!
! The only difference between Frame, Head, Text, and
! Title is the default values of the attributes.
! @image orm_en1-79.gif
! @image orm_text_3.gif
!
! They are used in Document objects where, for instance,
! Title specifies what the configuration is doing, i.e.
! - Title specifies what the configuration is doing, i.e.
! the function.
! Sub-functions are named by Head objects.
! Frame and Text are used to information of details.
! Hints
! - Sub-functions are named by Head objects.
! - Frame and Text are used to information of details.
!
! @b Hints
! A well-done PLC program ought to contain not only objects necessary
! to the computer execution but also objects whose purpose are to make
! the program more easy to understand to later readers. See figure below.
......@@ -52,7 +53,7 @@ SObject pwrb:Class
!/**
! The attribute influence the appearance of the text. The
! following values are used: 0, 1, 2, 3.
! @image orm_en1-80.gif
! @image orm_text_1.gif
!*/
Object TextAttribute $Intern 2
Body SysBody
......@@ -62,7 +63,7 @@ SObject pwrb:Class
!/**
! Specifies if the text is to be surrounded by a some
! kind of frame.
! @image orm_en1-81.gif
! @image orm_text_2.gif
!*/
Object FrameAttribute $Intern 3
Body SysBody
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_pid.c
! @Summary Incremental 3-point output with dead zone
! Incremental 3-point output with dead zone. Incremental
! comes from the type of input and the digit 3 of the
! output, which can have three distinct values, e.g. open
......@@ -31,6 +32,7 @@
! down respectively up with a time amount of ScanTime, at
! every scanning when an increment or decrement signal
! has been set.
!
! To avoid ripple on the outputs, which may be
! destructive to the actuator at small control errors,
! the absolute value of the Acc-attribute has to exceed
......@@ -50,9 +52,9 @@
! by a frequency determined by the PlcPgm object. But
! only the signals may be reset by the timer control.
!
! Example
! @h1 Example
!
! Timer Control of Outputs
! @b Timer Control of Outputs
!
! Suppose a flow control with an electrically-activated valve
! with increment/decrement control. The flow signal ( here kalle2)
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_grafcet.h
! @Summary The first step in a Grafcet-chain
! The first step in a Grafcet-chain.
! @image orm_initstep_fo.gif
!
......@@ -24,10 +25,10 @@
! sequential chains in the PLC program in the following
! way. When the reset signal makes the transition:
!
! 0 -> 1 each Step, InitStep and Order object in the
! - 0 -> 1 each Step, InitStep and Order object in the
! PLC program becomes inactive. Stored orders are
! aborted.
! 1 -> 0 the InitStep object(s) of the PLC program
! - 1 -> 0 the InitStep object(s) of the PLC program
! becomes active.
!
! If individual reset signals are required for every
......@@ -42,7 +43,7 @@
! on page 3-328. It may also be left open or used as an
! ordinary binary signal; see figure 3-22 on page 3-184.
!
! Examples
! @b Examples
!
! Figure below shows how an InitStep , ISO, may be configured
! in a straight sequential chain. A chain is said to be straight
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_logic.h
! @Summary Logical inverter
! Logical inverter.
! @image orm_inv_fo.gif
! Inverts a logical signal.
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Configures the IO handler
! Contains attributes which are used by the IO job.
!
! The IO job handles,
......
......@@ -10,7 +10,8 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_string.h
! Convert analog value to string.
! @Summary Convert integer value to string.
! Convert integer value to string.
! @image orm_itostr_fo.gif
!
! The ItoStr object converts the value of the integer input to
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_arithm.c
! @Summary Limits an analog signal up/downwards
! Limits an analog signal up/downwards and signals if a
! limitation has taken place.
! @image orm_limit_fo.gif
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Describes the contents and appearance of a single list.
! Describes the contents and appearance of a single list.
!
! The utility pwr_plc contains functions to handle the
......@@ -162,6 +163,18 @@ SObject pwrb:Class
! the current signal object? The searching will be
! carried out among all the objects in the work-bench
! database. The attribute is used in signal lists.
! @image orm_en1-116.gif
! Figure above shows that there are two signal objects below a
! hierarchy H1-A1. One Dv-signal object named H1-A1-A1_HitTk
! and one Do-signal object named H1-A1-A1_HitIND_2514. For each
! signal object three fields are printed; the last segment of the
! signals object name is printed to the left (controlled by
! PrintObjName ), the two last segments of the name of connected
! channel objects in the middle (controlled by PrintSigChan) and
! finally the Description attribute of the signal object. A
! cross-reference list is printed out for each signal object. The
! '#' character precedes the name of objects which write into a signal
! object.
!*/
Object Crossreference $Attribute 3
Body SysBody
......@@ -191,6 +204,9 @@ SObject pwrb:Class
! selected object. Specify "3" to involve the
! names of objects ( signal objects excluded) in
! other hierarchies with this type of references.
! @image orm_en1-117.gif
! @image orm_en1-118.gif
! Advanced Transcription with External References
!*/
Object Externreference $Attribute 4
Body SysBody
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_arithm.c
! @Summary Max/Min selector
! Max/Min selector.
! @image orm_maxmin_fo.gif
!
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Configures the event monitor
! Specifies attributes to a single message handler.
!
! Every message handler job needs a MessageHandler
......
......@@ -10,16 +10,18 @@
!/**
! @Version 1.0
! @Code rt_plc_pid.c
! @Summary Select control modes or forced control of Pid objects.
! Used to select control modes (MANUAL / AUTO / CASCADE)
! or forced control of Pid objects.
! @image orm_en1-121.gif
!
! The control modes are:
! · MANUAL -- when the 'operator' sets the output of the
!
! - MANUAL -- when the 'operator' sets the output of the
! Pid object
! · AUTO -- when the 'operator' chooses the set point
! - AUTO -- when the 'operator' chooses the set point
! value
! · CASCADE -- the output from a Pid object is used to
! - CASCADE -- the output from a Pid object is used to
! adjust the set point value in a
! secondary Pid object.
!
......@@ -27,6 +29,9 @@
! Pid object is not taken from the PID-algorithm but from
! the XForcVal-attribute in the Mode object. See control
! examples at the Pid object.
!
! @b See also
! @classlink PID pwrb_pid.html
!*/
SObject pwrb:Class
Object Mode $ClassDef 147
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_drive.c
! @Summary Motor valve positioner
! Motor valve positioner with three operating states and
! supervision of operation time and contactor response.
! @image orm_en1-123.gif
......@@ -41,9 +42,9 @@
! operation. A new order resets the alarms and initiates
! a new operation.
!
! Example
! @h1 Example
!
! Carriage Operation
! @b Carriage Operation
! @image orm_en1-126.gif
!
! The carriage is run only in MANUAL mode.
......@@ -53,7 +54,7 @@
! @image orm_en1-127.gif
! MValve Object Used in Motor Control
!
! Control Valve
! @b Control Valve
! @image orm_en1-127.gif
! Motor Valve Control
!
......
......@@ -26,13 +26,12 @@
! Distribution objects (ApplDistribute, GraphDistribute) configures
! application programs and other files that should be copied to the node.
!
! Se also
! @b See also
! @classlink RootVolumeLoad pwrb_rootvolumeload.html
! @classlink ClassVolumeLoad pwrb_classvolumeload.html
! @classlink FriendNodeConfig pwrb_friendnodeconfig.html
! @classlink ApplDistribute pwrb_appldistribute.html
! @classlink GraphDistribute pwrb_graphdistribute.html
! @classlink SystemDistribute pwrb_systemdistribute.html
!
!*/
SObject pwrb:Class
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Configures a logical operator station for operator
! Configures a logical operator station for operator
! dialogue. A logical operator station represents a work
! station, X-terminal etc.
......@@ -35,26 +36,26 @@
! continually activating the acoustic signal:
!
! 1 At 'alarm streams' this may be done by demanding a
! certain time between acknowledgement ( of acoustic
! signal or event ) until an arriving event that
! demands acknowledgement once again is allowed to
! activate the acoustic signal in the normal way. This
! blocking time is specified by means of
! TimeBeforeNextBell.
! certain time between acknowledgement ( of acoustic
! signal or event ) until an arriving event that
! demands acknowledgement once again is allowed to
! activate the acoustic signal in the normal way. This
! blocking time is specified by means of
! TimeBeforeNextBell.
!
! 2 Reminder of any unacknowledged event. To remind the
! operator, after an acknowledgement of acoustic
! signal or after an alarm acknowledgement, about
! remaining unacknowledged events a short acoustic
! signal sounds with the period of ReactivateBellTime.
! After a certain number of such periods (
! ReactivateBellCount specifies the numbers) the
! reminder time has expired and the acoustic signal
! is activated in the normal way again. If there is no
! unacknowledged event at present and
! TimeBeforeNextBell > 0 then an arriving event that
! demands acknowledgement first will be announced by
! the reminder function.
! operator, after an acknowledgement of acoustic
! signal or after an alarm acknowledgement, about
! remaining unacknowledged events a short acoustic
! signal sounds with the period of ReactivateBellTime.
! After a certain number of such periods
! (ReactivateBellCount specifies the numbers) the
! reminder time has expired and the acoustic signal
! is activated in the normal way again. If there is no
! unacknowledged event at present and
! TimeBeforeNextBell > 0 then an arriving event that
! demands acknowledgement first will be announced by
! the reminder function.
!*/
SObject pwrb:Class
Object OpPlace $ClassDef 164
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_logic.h
! @Summary Or gate
! OR-gate.
! @image orm_or_fo.gif
!
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_grafcet.h
! @Summary A Grafcet order
! A Grafcet order.
! @image orm_en1-131.gif
! To every sequential step one or more Order objects can
......@@ -60,21 +61,20 @@
!
! We talk about a C-order when the condition attribute is
! set. The condition of a C-order can be defined in one
! of the following two ways (see figure 3-55, p. 3-366):
! of the following two ways:
!
! 1 by direct connecting of a binary condition to the
! symbol's vertical input.
! symbol's vertical input.
!
! 2 by a combinational circuit in a conditional window.
! A SetCond object in the conditional window stores
! the condition state in the Order object. The objects
! in the window get a WindowCond object (see p. 3-394)
! as parent object.
! Opposite to an activity window a conditional window is
! evaluated each time when the PLC program executes.
!
! Example
! A SetCond object in the conditional window stores
! the condition state in the Order object. The objects
! in the window get a WindowCond object (see p. 3-394)
! as parent object.
! Opposite to an activity window a conditional window is
! evaluated each time when the PLC program executes.
!
! @b Example
! Figure below illustrates the use of Order objects:
!
! - Several orders (Ord0, Ord1, ... ) can be connected to a step, here S0.
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_grafcet.h
! @Summary Fetches the status of the order object in an order activity window
! Fetches from an activity window the status of an
! associated Order object.
! @image orm_orderact_fo.gif
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_pid.c
! @Summary Converts an analog signal into a pulsed binary signal
! Converts an analog signal into a binary signal which
! varies in the time. The binary output has a
! pulse-proportional relay action in the dead zone, if
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_pid.c
! @Summary Implements the robust PID control algorithm
! Implements the robust PID control algorithm.
! @image orm_en1-141.gif
!
......@@ -18,9 +19,9 @@
! interface for the Pid object. From the Mode object it
! is possible to select:
!
! · control modes ( MANUAL / AUTO / CASCADE)
! · forced control regarding the control signal of the
! controller.
! - control modes ( MANUAL / AUTO / CASCADE)
! - forced control regarding the control signal of the
! controller.
!
! Different PID strategies are implemented for
! incremental as well as positional form, see PidAlg
......@@ -42,9 +43,13 @@
! info forms containing e.g. a time diagram with process
! value, setpoint value and output signal.
!
! Examples
! @h1 Function
! @image orm_pid_1.gif
! @image orm_pid_2.gif
!
! Flow Control
! @h1 Examples
!
! @b Flow Control
!
! Flow control by speed control of a pump; see figure See Speed Control of a Pump.
!
......@@ -97,7 +102,7 @@
! forced against ForcVal = XForcVal (=0), i.e. MinOut and MaxOut
! represent no limitation at all at forced control.
!
! Alternate Controllers with Tracking
! @b Alternate Controllers with Tracking
!
! @image orm_en1-155.gif
! Shunt Control
......@@ -144,7 +149,8 @@
! TIC2 returns to AUTO when TT2 goes below the limit.
! The flow through the heat exchanger is enough to put the TT1 above the set
! point value. Switches to TT1-control, i.e. TIC1 controls the shunt valve.
! Cascade Control
!
! @b Cascade Control
! Temperature control in a furnace with two separate fuel loops, apart from
! the control of combustion air for the furnace, is shown in figure See Block
! Diagram Temperature Control. TT is the temperature transmitter, FT the flow
......@@ -160,7 +166,7 @@
! @image orm_en1-158.gif
! Traditional Cascade Configuration
!
! Common or Individual Control of Several Control Loops
! @b Common or Individual Control of Several Control Loops
! In figure 3-41 two control loops share a common Mode object to a synchronous
! behaviour in AUTO and MANUAL mode. But every single loop can also be controlled
! individually from separate Mode objects with an internal set point and its own
......@@ -169,7 +175,7 @@
! @image orm_en1-159.gif
! Two Levels with Mode Objects in a Control Loop
!
! Ratio Control
! @b Ratio Control
! Figure See Addition of a Reagent shows addition of a reagent. The ratio of the
! mixing is to be kept constant and independent of the FT2-flow. FT is the flow
! transmitter and FIC the flow controller.
......@@ -184,6 +190,9 @@
!
! @image orm_en1-161.gif
! Ratio Control
!
! @b See also
! @classlink Mode pwrb_mode.html
!*/
SObject pwrb:Class
Object PID $ClassDef 174
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_io.c
! @Summary Translates a pulse counter value into an engineering value
! Translates a pulse counter value into an engineering
! value, e.g. position, volume etc.
! @image orm_en1-162.gif
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_arithm.c
! @Summary Derivative a pulse Co-signal
! Derivative a pulse Pi-signal.
! @image orm_pispeed_fo.gif
!
......@@ -18,7 +19,7 @@
! The pulse difference becomes correct even if the input
! signal gets overflow.
!
! Example
! @b Example
! If Gain is in m/pulse the division gives m/seconds.
! By TimFact = 3600 seconds/h the result will be in m/h.
!*/
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Configures a PLC program
! Configures a PLC program.
!
! The name of the PlcPgm object is used to identify a
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Configures a group of trend or fast graphs
! Configures a group of trend or fast graphs.
!
! The PlotGroup object brings together a number of fast or
......@@ -27,8 +28,7 @@
! Between samples in a slowly sampled graph interpolation
! takes place.
!
! Hints
!
! @b Hints
! The buttons 'Trend' and 'Fast' in the operator
! environment display both lists of those PlotGroup objects
! ( or graphs) that are available on the node independent
......
......@@ -9,6 +9,7 @@
!
!/**
! @Version 1.0
! @Summary Pulse output signal
! Pulse Output. A modified Do object to make specified
! pulses on a Do-channel.
!
......@@ -37,7 +38,7 @@
! equal to TestValue when TestOn is TRUE, i.e. no
! filtering in this cases.
!
! Hints
! @b Hints
! Put the object below a $PlantHier object in the
! development environment in such a way that it belongs
! to the same target node as its associated channel
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_pid.c
! @Summary Positional 3-step controller
! Positional 3-step controller with position feedback and
! dead zone. Positional is aimed at the input signal and
! the digit 3 on the fact that the output signals specify
......@@ -47,9 +48,9 @@
! It is possible to use the outputs Open / Close and the
! signals named by DoOpen/DoClose at the same time.
!
! Example
! @h1 Example
!
! Timer Control of Outputs
! @b Timer Control of Outputs
!
! Suppose a flow control with an electrically-activated valve
! with increment/decrement control. The flow signal (here kalle2)
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_drive.c
! @Summary Positioner
! Positioner.
! @image orm_en1-172.gif
!
......@@ -19,7 +20,8 @@
! by means of the output signal ManMode in the following
! way:
! @image orm_en1-173.gif
! MANUAL The MANUAL mode is thought to be handled from the object\s display.
! @b Manual
! The MANUAL mode is thought to be handled from the object\s display.
!
! * A set point value is set in SetPos.
! * The positioning is started by setting PosOn to TRUE.
......@@ -33,7 +35,7 @@
!
! - (the input signal) Reset becomes TRUE.
!
!
! @b Auto
! The positioning starts on a leading edge on the input signal AutoPos.
! It can be finished of different reasons:
! - TimerTime > 0. The process value has been within the dead zone
......@@ -46,9 +48,9 @@
!
! - (the input signal) Reset becomes TRUE.
!
! Example
! @h1 Example
!
! Position Controlled Carriage.
! @b Position Controlled Carriage.
!
! By means of a push button the positioning starts, and the carriage runs
! to a set point value set by a potentiometer. The positioning is to be
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_macro_logic.h
! @Summary One-shot pulse with variable width
! One-shot pulse with variable width.
! @image orm_pulse_fo.gif
!
......@@ -22,8 +23,7 @@
! leading edge of the input signal.
! @image orm_en1-182.gif
!
! Hints
!
! @b Hints
! If a reset function is needed instead of a pulse with a
! certain period the pulse can be realized by a Wait, And,
! Or, Edge, and a SR_R object.
......
......@@ -10,6 +10,7 @@
!/**
! @Version 1.0
! @Code rt_plc_arithm.c
! @Summary Limits a quantity's rate of change
! Limits a quantity's rate of change.
! @image orm_ramp_fo.gif
!
......@@ -21,8 +22,7 @@
!
! An external signal may also be used as feedback. See example below.
!
! Example
!
! @b Example
! In this example an external signal is connected to the FB-input of
! the Ramp object. The feedback connection from the Select object to
! the Ramp object is of the type analog feedback.
......
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment