actions doc draft

eez-open · Jul 26, 2023 · 0e19cc3 · 0e19cc3
1 parent 8f7b72d
commit 0e19cc3
Show file tree

Hide file tree

Showing 182 changed files with 2,493 additions and 771 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -5,7 +5,7 @@
         "eezstudio-win32-x64": true,
         "eezstudio-linux-x64": true,
         "node_modules": true,
-        "libs": true,
+        "libs": false,
         "build": false,
         "dist": true
     },

diff --git a/docs/components/html/en-US/AddToInstrumentHistory.html b/docs/components/html/en-US/AddToInstrumentHistory.html
diff --git a/docs/components/html/en-US/Animate.html b/docs/components/html/en-US/Animate.html
diff --git a/docs/components/html/en-US/AppView.html b/docs/components/html/en-US/AppView.html
diff --git a/docs/components/html/en-US/BarGraph.html b/docs/components/html/en-US/BarGraph.html
diff --git a/docs/components/html/en-US/Bitmap.html b/docs/components/html/en-US/Bitmap.html
diff --git a/docs/components/html/en-US/Button.html b/docs/components/html/en-US/Button.html
diff --git a/docs/components/html/en-US/ButtonGroup.html b/docs/components/html/en-US/ButtonGroup.html
diff --git a/docs/components/html/en-US/CSVParse.html b/docs/components/html/en-US/CSVParse.html
diff --git a/docs/components/html/en-US/CSVStringify.html b/docs/components/html/en-US/CSVStringify.html
diff --git a/docs/components/html/en-US/Canvas.html b/docs/components/html/en-US/Canvas.html
diff --git a/docs/components/html/en-US/CatchError.html b/docs/components/html/en-US/CatchError.html
diff --git a/docs/components/html/en-US/Checkbox.html b/docs/components/html/en-US/Checkbox.html
diff --git a/docs/components/html/en-US/CollectStream.html b/docs/components/html/en-US/CollectStream.html
diff --git a/docs/components/html/en-US/Comment.html b/docs/components/html/en-US/Comment.html
diff --git a/docs/components/html/en-US/Compare.html b/docs/components/html/en-US/Compare.html
diff --git a/docs/components/html/en-US/ConnectInstrument.html b/docs/components/html/en-US/ConnectInstrument.html
diff --git a/docs/components/html/en-US/Constant.html b/docs/components/html/en-US/Constant.html
diff --git a/docs/components/html/en-US/Container.html b/docs/components/html/en-US/Container.html
diff --git a/docs/components/html/en-US/Counter.html b/docs/components/html/en-US/Counter.html
diff --git a/docs/components/html/en-US/DateNow.html b/docs/components/html/en-US/DateNow.html
diff --git a/docs/components/html/en-US/Delay.html b/docs/components/html/en-US/Delay.html
diff --git a/docs/components/html/en-US/DisconnectInstrument.html b/docs/components/html/en-US/DisconnectInstrument.html
@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<title>DisconnectInstrument</title>
+<link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
+<script src="https://code.jquery.com/jquery-3.7.0.min.js" integrity="sha256-2Pmvv0kuTBOenSvLm6bvfBSSHrUJ+3A7x6P5Ebd07/g=" crossorigin="anonymous"></script>
+<style>
+.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation{flex:1;padding:10px;background-color:#fff;overflow:auto}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .markdown{margin-left:1rem}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_BodySection>div>div.markdown{margin-left:0}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_TitleEnclosure{padding-bottom:10px;border-bottom:1px solid #e0e0e0;margin-bottom:20px;display:flex;align-items:center;justify-content:space-between}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_TitleEnclosure .EezStudio_Component_Documentation_Title{display:flex;align-items:center;font-size:32px;border-radius:8px;padding:5px 15px;width:fit-content}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_TitleEnclosure .EezStudio_Component_Documentation_Title>div:nth-child(1){display:inline-flex}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_TitleEnclosure .EezStudio_Component_Documentation_Title>div:nth-child(1) img,.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_TitleEnclosure .EezStudio_Component_Documentation_Title>div:nth-child(1) svg{height:36px;object-fit:contain}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_TitleEnclosure .EezStudio_Component_Documentation_Title>div:nth-child(2){padding-left:10px}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_TitleEnclosure .EezStudio_Component_Documentation_Title_ProjectTypes img,.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_TitleEnclosure .EezStudio_Component_Documentation_Title_ProjectTypes svg{margin-right:10px}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_TitleEnclosure .EezStudio_Component_Documentation_Title_ProjectTypes img:last_child,.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_TitleEnclosure .EezStudio_Component_Documentation_Title_ProjectTypes svg:last_child{margin-right:0}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_Body .EezStudio_Component_Documentation_BodySection{margin-bottom:15px}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_Body .EezStudio_Component_Documentation_BodySection>h2:first-child{font-size:12pt;font-weight:700;font-style:italic;text-transform:uppercase;color:#06c}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_Body .EezStudio_Component_Documentation_BodySection>div:nth-child(2){padding-left:1rem}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_Body .EezStudio_Component_Documentation_BodySection div>dl>dt{display:flex;margin-bottom:10px}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_Body .EezStudio_Component_Documentation_BodySection div>dl>dt h3{margin-top:0;margin-bottom:0;margin-right:20px;font-size:14px;line-height:var(--bs-body-line-height)}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_Body .EezStudio_Component_Documentation_BodySection div>dl>dt p{margin-bottom:0}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_Body .EezStudio_Component_Documentation_BodySection .EezStudio_Component_Documentation_Properties .EezStudio_Component_Documentation_PropertiesGroup{margin-bottom:1rem;border:1px solid #e0e0e0}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_Body .EezStudio_Component_Documentation_BodySection .EezStudio_Component_Documentation_Properties .EezStudio_Component_Documentation_PropertiesGroup h3{font-size:14px;font-weight:700;background-color:#f0f0f0;border-bottom:1px solid #e0e0e0;border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px);margin:0;padding:.8rem 1.25rem .5rem 0;text-transform:uppercase;cursor:pointer;display:flex;align-items:center}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_Body .EezStudio_Component_Documentation_BodySection .EezStudio_Component_Documentation_Properties .EezStudio_Component_Documentation_PropertiesGroup h3:before{content:"";display:block;width:24px;height:24px;margin-top:-3px;background:url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewbox='0 0 24 24' fill='none' stroke='currentColor' stroke-linecap='round' stroke-linejoin='round' stroke-width='2'%3E%3Cpath stroke='none' d='M0 0h24v24H0z'/%3E%3Cpath d='m6 9 6 6 6-6'/%3E%3C/svg%3E") 0 0 repeat;transition-duration:250ms;transition-property:transform}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_Body .EezStudio_Component_Documentation_BodySection .EezStudio_Component_Documentation_Properties .EezStudio_Component_Documentation_PropertiesGroup.collapsed h3{background-color:#fff;border-bottom:none}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_Body .EezStudio_Component_Documentation_BodySection .EezStudio_Component_Documentation_Properties .EezStudio_Component_Documentation_PropertiesGroup.collapsed h3:before{transform:rotate(-90deg)}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_Body .EezStudio_Component_Documentation_BodySection .EezStudio_Component_Documentation_Properties .EezStudio_Component_Documentation_PropertiesGroup.collapsed>dl{display:none}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_Body .EezStudio_Component_Documentation_BodySection .EezStudio_Component_Documentation_Properties .EezStudio_Component_Documentation_PropertiesGroup dl{margin:1rem 1.25rem}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_Body .EezStudio_Component_Documentation_BodySection .EezStudio_Component_Documentation_Properties .EezStudio_Component_Documentation_PropertiesGroup dl dt{display:flex;margin-bottom:10px}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_Body .EezStudio_Component_Documentation_BodySection .EezStudio_Component_Documentation_Properties .EezStudio_Component_Documentation_PropertiesGroup dl dt h4{margin-bottom:0;margin-top:0;margin-right:20px;font-size:14px;line-height:var(--bs-body-line-height)}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_Body .EezStudio_Component_Documentation_BodySection .EezStudio_Component_Documentation_Properties .EezStudio_Component_Documentation_PropertiesGroup dl dt p{margin-bottom:0}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_Body .EezStudio_Component_Documentation_BodySection .EezStudio_Component_Documentation_Properties .EezStudio_Component_Documentation_PropertiesGroup:last-child{margin-bottom:0}.EezStudio_DocumentationBrowser_Content_Help .EezStudio_Component_Documentation .EezStudio_Component_Documentation_Body .EezStudio_Component_Documentation_BodySection:last-child{margin-bottom:0}
+</style>
+<script id="component-doc-script">
+function live(eventType, elementQuerySelector, cb) { document.addEventListener(eventType, function (event) { var qs = document.querySelectorAll(elementQuerySelector); if (qs) { var el = event.target, index = -1; while ( el && (index = Array.prototype.indexOf.call(qs, el)) === -1 ) { el = el.parentElement; } if (index > -1) { cb.call(el, event); } } }); } live( "click", ".EezStudio_Component_Documentation_PropertiesGroup h3", function (event) { event.preventDefault(); event.target.parentElement.classList.toggle("collapsed"); } ); 
+</script>
+</head>
+<body>
+<div class="EezStudio_DocumentationBrowser_Content_Help generateHTML"><div class="EezStudio_Component_Documentation"><div class="EezStudio_Component_Documentation_TitleEnclosure"><div class="EezStudio_Component_Documentation_Title" style="background-color: rgb(253, 208, 162); color: rgb(0, 0, 0);"><div><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" height="24" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"><path stroke="none" d="M0 0h24v24H0z"></path><path d="m20 16-4 4M7 12l5 5-1.5 1.5a3.536 3.536 0 1 1-5-5L7 12zM17 12l-5-5 1.5-1.5a3.536 3.536 0 1 1 5 5L17 12zM3 21l2.5-2.5M18.5 5.5 21 3M10 11l-2 2M13 14l-2 2M16 16l4 4"></path></svg></div><div>DisconnectInstrument</div></div><div class="EezStudio_Component_Documentation_Title_ProjectTypes"><svg viewBox="0 0 560 510" width="36" height="36"><g><path d="M509.09 0A50.91 50.91 0 0 1 560 50.91v305.454a50.91 50.91 0 0 1-50.91 50.909H330.91v50.909h50.908v50.909H178.182v-50.91h50.909v-50.908H50.909C22.655 407.273 0 384.363 0 356.363V50.91A50.733 50.733 0 0 1 50.91 0h458.18" stroke-width="25.4545" fill="#adb5bd" fill-opacity="1"></path><path d="M527.5 368.937h-495v-334h495z" fill="#fefefe" fill-opacity="1" stroke-width="1.23022"></path><path d="M54.633 102.161h70v70h-70zM54.592 192.49h70v70h-70zM54.93 281.458h70v70h-70z" fill="#502d16" fill-opacity="1" stroke-width="24.7486"></path><path d="M32.5 34.937h495v46h-495v-46" fill="#d4aa00" fill-opacity="1" stroke-width="22.4944"></path><circle cx="240.475" cy="182.325" r="68.5" fill="#502d16" fill-opacity="1" stroke="#000" stroke-width="0" stroke-linecap="square" stroke-opacity="1" paint-order="fill markers stroke"></circle><circle cx="414.7" cy="182.325" r="68.5" fill="#502d16" fill-opacity="1" stroke="#000" stroke-width="0" stroke-linecap="square" stroke-opacity="1" paint-order="fill markers stroke"></circle></g></svg></div></div><div class="EezStudio_Component_Documentation_Body"><div class="EezStudio_Component_Documentation_BodySection"><h2>Description</h2><div><div class="markdown"><p>Initiates asynchronous disconnection from the instrument, i.e. the Action will not wait for us to disconnect from the instrument before exiting to <code>seqout</code>, but exits immediately. We can check whether we are disconnected or not with <code>instrument_variable.isConnected</code>. For example we can monitor this expression within the <em>Watch</em> Action in order to catch the moment when disconnection from the instrument occurred.</p></div></div></div><div class="EezStudio_Component_Documentation_BodySection"><h2>Properties</h2><div><div class="EezStudio_Component_Documentation_Properties"><div class="EezStudio_Component_Documentation_PropertiesGroup"><h3>Specific</h3><dl><dt><h4>Instrument</h4><span style="font-weight: normal; font-style: italic;">EXPRESSSION (object:Instrument)</span></dt><dd><div class="markdown"><p>Instrument object to disconnect from.</p></div></dd></dl></div><div class="EezStudio_Component_Documentation_PropertiesGroup collapsed"><h3>General</h3><dl><dt><h4>Description</h4><span style="font-weight: normal; font-style: italic;">String</span></dt><dd><div class="markdown"><p>This is the description of the Action component. Description is displayed below the component in the Project editor/viewer. In the main toolbar, it is possible to hide or display descriptions of all components with one click.</p></div></dd></dl></div><div class="EezStudio_Component_Documentation_PropertiesGroup collapsed"><h3>Position and size</h3><dl><dt><h4>Align and distribute</h4><span style="font-weight: normal; font-style: italic;">Any</span></dt><dd><div class="markdown"><p>Alignment icons and component distribution. Alignment icons appear when two or more components are selected, and distribution icons appear when three or more components are selected.</p>
+<p><img src="images/align_and_distribute.png" alt="Alt text"></p></div></dd></dl></div><div class="EezStudio_Component_Documentation_PropertiesGroup collapsed"><h3>Flow</h3><dl><dt><h4>Inputs</h4><span style="font-weight: normal; font-style: italic;">Array</span></dt><dd><div class="markdown"><p>Additional component inputs that the user can add as desired in order to use them to receive additional data needed when evaluating expressions in properties. Each input is given a name and type. Name is used when referencing an input within an expression. A type is used to project <em>Check</em> to check whether a data line that transmits data of that type is connected to the input or not.</p></div></dd><dt><h4>Outputs</h4><span style="font-weight: normal; font-style: italic;">Array</span></dt><dd><div class="markdown"><p>Additional component outputs that the user can add to send data through. Each output is assigned a name and type. An example of using this output is e.g. in the <em>Loop</em> component, where we can put the output name for the <code>Variable</code> property instead of e.g. variable name. In that case, the <em>Loop</em> component will not change the content of the variable in each step, but will send the current value through that output.</p></div></dd><dt><h4>Catch error</h4><span style="font-weight: normal; font-style: italic;">Boolean</span></dt><dd><div class="markdown"><p>If this checkbox is enabled then an <code>@Error</code> output will be added to the component and if an error occurs in this component during the execution of the Flow, the Flow will continue through that output. The data that will be passed through that output is the textual description of the error.</p></div></dd></dl></div></div></div></div><div class="EezStudio_Component_Documentation_BodySection"><h2>Inputs</h2><div><dl><dt><h3>seqin</h3><span style="font-weight: normal; font-style: italic;">SEQ | MANDATORY</span></dt><dd><div class="markdown"><p>A standard sequence input.</p></div></dd></dl></div></div><div class="EezStudio_Component_Documentation_BodySection"><h2>Outputs</h2><div><dl><dt><h3>seqout</h3><span style="font-weight: normal; font-style: italic;">SEQ | OPTIONAL</span></dt><dd><div class="markdown"><p>A standard sequence output.</p></div></dd></dl></div></div></div></div></div>
+</body>
+</html>