From b37ea4af65890551f00c1d1603c75f5c224ac888 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 5 Jun 2024 09:05:15 +0200 Subject: [PATCH] docs: update SEPTIC documentation for latest (#575) Autogenerated from SEPTIC repository Co-authored-by: einarsi <2356425+einarsi@users.noreply.github.com> --- public/latest/calcs.yaml | 62 ++++++++++++++++++------ public/latest/meta.yaml | 2 +- public/latest/objectsDoc.yaml | 89 +++++++++++++++++++++++------------ public/latest/snippets.yaml | 10 ++-- 4 files changed, 113 insertions(+), 50 deletions(-) diff --git a/public/latest/calcs.yaml b/public/latest/calcs.yaml index fb4e8a79..2d4d73a5 100644 --- a/public/latest/calcs.yaml +++ b/public/latest/calcs.yaml @@ -389,8 +389,9 @@ quality: GOOD if valid cvr else BAD retr: 'Standard deviation between measurement and nominal value: 0 if BAD' signature: cvmodeldevstd(cvr, nsamp) -- detailedDescription: Gets the last generated open loop prediction generated in an - iterative sequence +- detailedDescription: "Gets the open loop prediction point n sample ahead. If n<1,\ + \ current value (n=0, nomval + bias) is given, if\r\n n>last evaluation point,\ + \ then prediction at last evaluation (end value) is given" name: cvopenloop parameters: - arity: '1' @@ -399,10 +400,16 @@ description: Cvr direction: in name: cvr + - arity: '?' + datatype: + - value + description: npred + direction: in + name: n quality: GOOD - retr: 'Most future open loop prediction point for Cvr: Cvr.OpenLoop(last evaluation - point)' - signature: cvopenloop(cvr) + retr: "Open loop prediction point for Cvr: Cvr.OpenLoop(n) - end value if npred\ + \ is not given or npred is bad or\r\n nonexisting Xvr" + signature: cvopenloop(cvr, n?) - detailedDescription: Gets the most future prediction point (last point in the prediction) name: cvpo parameters: @@ -2312,7 +2319,7 @@ parameters: [] quality: 'BAD: Nothing saved' retr: "0: Nothing saved. Q = BAD: Reason printed on application .out file, 1: Current\ - \ sample successfully saved\r\n on data file XVRID.txt. May be printouts on .out\ + \ sample successfully saved on\r\n data file XVRID.txt. May be printouts on .out\ \ reflecting file actions" signature: savedata(XVR,SAVE) - detailedDescription: Selects the value of index from list of elements @@ -2474,6 +2481,25 @@ quality: GOOD if valid xvr and value otherwise BAD retr: Resulting fulf signature: setfulf(xvr, value) +- detailedDescription: Sets the fulfdynscale property for given xvr + name: setfulfdynscale + parameters: + - arity: '1' + datatype: + - mvr + - cvr + description: Xvr + direction: in + name: xvr + - arity: '1' + datatype: + - value + description: Value to set. Range 0 to 1 + direction: in + name: value + quality: GOOD if valid xvr and value otherwise BAD + retr: Resulting fulfdynscale value + signature: setfulfdynscale(xvr, value) - detailedDescription: Sets the fulf rescale property for given xvr name: setfulfrescale parameters: @@ -2852,8 +2878,8 @@ quality: GOOD if valid xvr retr: 'Updated meas validation mode: 1/0 for ON/OFF' signature: setmeasvalidation(xvr, mode) -- detailedDescription: "Sets the mode of the given Xvr. If given mode is higher than\ - \ possible mode for Xvr, it is set to the\r\n highest possible." +- detailedDescription: Sets the mode of the given Xvr. If given mode is higher than + possible, it is set to the highest possible name: setmode parameters: - arity: '1' @@ -3104,13 +3130,19 @@ quality: quality(x) retr: Sine value of x signature: sin(x) -- detailedDescription: "Debugging code. Will sleep for sleepmsecs\r\n Not part of\ - \ release-builds, intended for debugging of Master<->RUI issues to introduce a\ - \ long \"exe-time\" in Master" +- detailedDescription: "Debugging code. Will sleep for sleepmsecs. Not part of release-builds,\ + \ intended for debugging of Master<->RUI\r\n issues to introduce a long \"exe-time\"\ + \ in Master" name: sleep - parameters: [] - quality: BAD if input sleepmsecs is BAD, else GOOD - retr: sleeptime [msec] + parameters: + - arity: '1' + datatype: + - value + description: Time to sleep [msecs] + direction: in + name: sleepmsecs + quality: BAD if input sleepmsecs is BAD or empty input, else GOOD + retr: max(0, sleepmsecs), 0 if BAD input signature: sleep(sleepmsecs) - detailedDescription: Sets the desired mode for Cvr.SetPnt or Mvr.Iv. If MODE is not exactly 0 or 1, no action is performed @@ -3267,7 +3299,7 @@ description: Mvr direction: in,out name: mvr - quality: GOOD if valid mvr otherwise BAD + quality: GOOD if valid mvr, otherwise BAD retr: Status of windup. Set Mvr.Mode to min of Mode and TRACKING if status is 3 signature: windup(mvr) - detailedDescription: '' diff --git a/public/latest/meta.yaml b/public/latest/meta.yaml index e13c62ce..c6ea0c34 100644 --- a/public/latest/meta.yaml +++ b/public/latest/meta.yaml @@ -1,2 +1,2 @@ -commit: 42a7a90 +commit: 87f9c7b version: latest diff --git a/public/latest/objectsDoc.yaml b/public/latest/objectsDoc.yaml index d9c81d32..80d8d86f 100644 --- a/public/latest/objectsDoc.yaml +++ b/public/latest/objectsDoc.yaml @@ -1004,32 +1004,6 @@ postfix: [] snippet: '' tags: [] - - calc: false - dataType: float - default: - - '0' - description: High constraint maximum relaxation - enums: [] - list: false - name: HighLimit - noCnfg: false - nosnippet: false - postfix: [] - snippet: '1000' - tags: [] - - calc: false - dataType: float - default: - - '0' - description: Low constraint maximum relaxation - enums: [] - list: false - name: LowLimit - noCnfg: false - nosnippet: false - postfix: [] - snippet: '1000' - tags: [] - calc: false dataType: int default: @@ -1071,6 +1045,19 @@ postfix: [] snippet: '' tags: [] + - calc: false + dataType: float + default: + - '1' + description: Rescale fulf when solving the dynamic problem + enums: [] + list: false + name: FulfDynScale + noCnfg: false + nosnippet: false + postfix: [] + snippet: '' + tags: [] - calc: false dataType: enum default: @@ -4442,6 +4429,19 @@ postfix: [] snippet: '' tags: [] + - calc: false + dataType: float + default: + - '1' + description: Rescaling of fulf when solving the dynamic problem + enums: [] + list: false + name: FulfDynScale + noCnfg: false + nosnippet: false + postfix: [] + snippet: '' + tags: [] - calc: false dataType: float default: @@ -9215,6 +9215,22 @@ postfix: [] snippet: '' tags: [] + - calc: false + dataType: enum + default: + - UA_MESSAGESECURITYMODE_SIGN + description: Security Mode + enums: + - UA_MESSAGESECURITYMODE_NONE + - UA_MESSAGESECURITYMODE_SIGN + - UA_MESSAGESECURITYMODE_SIGNANDENCRYPT + list: false + name: SecurityMode + noCnfg: false + nosnippet: false + postfix: [] + snippet: '' + tags: [] - calc: false dataType: string default: @@ -9256,6 +9272,19 @@ postfix: [] snippet: '' tags: [] + - calc: false + dataType: string + default: + - '""' + description: Schedule time tag + enums: [] + list: false + name: xSchedule + noCnfg: false + nosnippet: false + postfix: [] + snippet: '' + tags: [] - calc: false dataType: enum default: @@ -9280,10 +9309,10 @@ dataType: string default: - '""' - description: Measurement + description: Measurement tag to write enums: [] list: false - name: MeasTag + name: xMeas noCnfg: false nosnippet: false postfix: [] @@ -9293,10 +9322,10 @@ dataType: string default: - '""' - description: Not valid tag. 1 = Not Valid + description: Not valid tag.1 = Not Valid enums: [] list: false - name: NotValidTag + name: xNotValid noCnfg: false nosnippet: false postfix: [] diff --git a/public/latest/snippets.yaml b/public/latest/snippets.yaml index 7fa76cd9..be7fafdc 100644 --- a/public/latest/snippets.yaml +++ b/public/latest/snippets.yaml @@ -112,11 +112,10 @@ - ' Fulf= 1' - ' HighPnlty= 1' - ' LowPnlty= 1' - - ' HighLimit= 1000' - - ' LowLimit= 1000' - ' RelxParam= 3 1 30 90' - ' FulfReScale= 0.001' - ' FulfUniScale= 1' + - ' FulfDynScale= 1' - SetPntChangeMode= FILTER - ' SetpTref= 0' - ' SetPntRocUp= 1' @@ -494,6 +493,7 @@ - ' IvPrio= 99' - ' Fulf= 1' - ' FulfReScale= 0' + - ' FulfDynScale= 1' - ' Price= 0' - ' Blocking= 6 2 4 7 11 16 22' - MeasValidation= OFF @@ -955,16 +955,18 @@ - ' yPulse= ""' - ' UserName= ""' - ' Password= ""' + - ' SecurityMode= UA_MESSAGESECURITYMODE_SIGN' - DefaultNameSpaceURI= "" - credentialsPath= "" - useSubscription= OFF + - ' xSchedule= ""' - writeOnChangeOnly= OFF description: UAProc description prefix: uaproc - body: - ' UATvr: ${1:UATvrName}' - - ' MeasTag= ""' - - ' NotValidTag= ""' + - ' xMeas= ""' + - ' xNotValid= ""' description: Trending variable (TV) OPC connection prefix: uatvr - body: