Skip to content

Commit

Permalink
docs: update SEPTIC documentation for latest (#575)
Browse files Browse the repository at this point in the history
Autogenerated from SEPTIC repository

Co-authored-by: einarsi <[email protected]>
  • Loading branch information
github-actions[bot] and einarsi authored Jun 5, 2024
1 parent 3ae5cd7 commit b37ea4a
Show file tree
Hide file tree
Showing 4 changed files with 113 additions and 50 deletions.
62 changes: 47 additions & 15 deletions public/latest/calcs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand All @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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: ''
Expand Down
2 changes: 1 addition & 1 deletion public/latest/meta.yaml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
commit: 42a7a90
commit: 87f9c7b
version: latest
89 changes: 59 additions & 30 deletions public/latest/objectsDoc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand All @@ -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: []
Expand All @@ -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: []
Expand Down
10 changes: 6 additions & 4 deletions public/latest/snippets.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -494,6 +493,7 @@
- ' IvPrio= 99'
- ' Fulf= 1'
- ' FulfReScale= 0'
- ' FulfDynScale= 1'
- ' Price= 0'
- ' Blocking= 6 2 4 7 11 16 22'
- MeasValidation= OFF
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit b37ea4a

Please sign in to comment.