Release 3.1.0 (#2)

# Release 3.1.0

## Improvements
- Automatically start image provider after 3 seconds if used within FlowConfig
- React on "OnStopFlowConfigProviders" event of FlowConfig module to stop provider
- Optionally setup image path, type and cycle time within FlowConfig block
- Prevent changing of image type if player is currently active

Author: golluroSICKAG

CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## Release 3.1.0
+
+### Improvements
+- Automatically start image provider after 3 seconds if used within FlowConfig
+- React on "OnStopFlowConfigProviders" event of FlowConfig module to stop provider
+- Optionally setup image path, type and cycle time within FlowConfig block
+- Prevent changing of image type if player is currently active
+
 ## Release 3.0.0
 
 ### New features

CSK_Module_ImagePlayer/pages/pages/CSK_Module_ImagePlayer/CSK_Module_ImagePlayer.html

@@ -285,6 +285,13 @@
                                                     class="myCustomFrameLabel_CSK_Module_ImagePlayer"
                                                     label="Configuration" style="align-self: flex-start">
                                                 </davinci-value-display>
+                                                <curie-callout id="DC_FlowConfigInfo" type="info"
+                                                    value="FlowConfig priority active.">
+                                                    <crown-edpws-binding property="hidden"
+                                                        name="CSK_ImagePlayer/OnNewStatusFlowConfigPriority"
+                                                        update-on-resume converter="function(value) {return !value;}">
+                                                    </crown-edpws-binding>
+                                                </curie-callout>
                                                 <layout-row id="RowLayout9"
                                                     style="justify-content: space-between; align-items: center">
                                                     <layout-column id="ColumnLayout13" style="align-items: stretch">
@@ -383,6 +390,9 @@
                                                                 name="CSK_ImagePlayer/setImageType"
                                                                 path="param/args/imgType" auto-commit>
                                                             </crown-binding>
+                                                            <crown-edpws-binding property="disabled"
+                                                                name="CSK_ImagePlayer/OnPlayerActive" update-on-resume>
+                                                            </crown-edpws-binding>
                                                         </davinci-drop-down>
                                                     </layout-column>
                                                 </layout-row>

CSK_Module_ImagePlayer/project.mf.xml

@@ -206,6 +206,9 @@ INFO: If the internal resizeFactor is changed, this module will notify the "OnNe
                     <function name="create">
                         <trait>released</trait>
                         <desc>Internally used CSK_FlowConfig create function.</desc>
+                        <param desc="Path to load images.&#10;(e.g. &quot;resources/CSK_Module_ImagePlayer/ColorPins&quot; (default) or &quot;public/Images&quot;)" multiplicity="?" name="Path" type="string"/>
+                        <param desc="Image type (jpg is default)" multiplicity="?" name="ImageType" ref="CSK_ImagePlayer.ImageTypes" type="enum"/>
+                        <param desc="Cycle time to trigger new image in ms (1000 is default)." multiplicity="?" name="CycleTime" type="int"/>
                         <return desc="Handle to internally used FlowConfig instance." multiplicity="1" name="handle" type="handle"/>
                     </function>
                     <function name="register">
@@ -220,7 +223,7 @@ INFO: If the internal resizeFactor is changed, this module will notify the "OnNe
             </crown>
         </crown>
         <meta key="author">SICK AG</meta>
-        <meta key="version">3.0.0</meta>
+        <meta key="version">3.1.0</meta>
         <meta key="priority">low</meta>
         <meta key="copy-protected">false</meta>
         <meta key="read-protected">false</meta>

CSK_Module_ImagePlayer/scripts/Sensors/ImagePlayer/FlowConfig/ImagePlayer_FlowConfig.lua

@@ -7,12 +7,13 @@
 
 require('Sensors.ImagePlayer.FlowConfig.ImagePlayer_OnNewImage')
 
---- Function to react if FlowConfig was updated
+--- Function to react if FlowConfig was updated or stopped
 local function handleOnClearOldFlow()
   if _G.availableAPIs.default and _G.availableAPIs.specific then
     if imagePlayer_Model.parameters.flowConfigPriority then
       CSK_ImagePlayer.clearFlowConfigRelevantConfiguration()
     end
   end
 end
-Script.register('CSK_FlowConfig.OnClearOldFlow', handleOnClearOldFlow)
+Script.register('CSK_FlowConfig.OnClearOldFlow', handleOnClearOldFlow)
+Script.register('CSK_FlowConfig.OnStopFlowConfigProviders', handleOnStopProvider)

CSK_Module_ImagePlayer/scripts/Sensors/ImagePlayer/FlowConfig/ImagePlayer_OnNewImage.lua

@@ -2,6 +2,17 @@
 local BLOCK_NAMESPACE = "ImagePlayer_FC.OnNewImage"
 local nameOfModule = 'CSK_ImagePlayer'
 
+-- Timer to start image provdider
+local tmrStartProvider = Timer.create()
+tmrStartProvider:setExpirationTime(3000)
+tmrStartProvider:setPeriodic(false)
+
+--- Function to start image timer
+local function startImageTimer()
+  CSK_ImagePlayer.startProvider()
+end
+Timer.register(tmrStartProvider, "OnExpired", startImageTimer)
+
 --*************************************************************
 --*************************************************************
 
@@ -10,6 +21,25 @@ local function register(handle, _ , callback)
   Container.remove(handle, "CB_Function")
   Container.add(handle, "CB_Function", callback)
 
+  local imageType = Container.get(handle, 'ImageType')
+  local cycleTime = Container.get(handle, 'CycleTime')
+  local path = Container.get(handle, 'Path')
+
+  if imageType ~= '' then
+    CSK_ImagePlayer.setImageType(imageType)
+  end
+
+  if cycleTime ~= '' then
+    local time = tonumber(cycleTime)
+    if time then
+      CSK_ImagePlayer.setCycleTime(time)
+    end
+  end
+
+  if path ~= '' then
+    CSK_ImagePlayer.setPath(path)
+  end
+
   local function localCallback()
     if callback ~= nil then
       Script.callFunction(callback, 'CSK_ImagePlayer.OnNewImage')
@@ -19,15 +49,20 @@ local function register(handle, _ , callback)
   end
   Script.register('CSK_FlowConfig.OnNewFlowConfig', localCallback)
 
+  tmrStartProvider:start()
+
   return true
 end
 Script.serveFunction(BLOCK_NAMESPACE ..".register", register)
 
 --*************************************************************
 --*************************************************************
 
-local function create()
+local function create(path, imageType, cycleTime)
   local container = Container.create()
+  Container.add(container, "Path", path or "")
+  Container.add(container, "ImageType", imageType or "")
+  Container.add(container, "CycleTime", cycleTime or "")
   Container.add(container, "CB_Function", "")
   return(container)
 end

README.md

@@ -15,6 +15,7 @@ Tested on
 
 |Device|Firmware|Module version|
 |--|--|--|
+|SICK AppEngine|V1.7.0|V3.1.0|
 |SICK AppEngine|V1.7.0|V3.0.0|
 |SICK AppEngine|V1.3.2|<V3.0.0|
 |SIM1012|V2.4.2|V3.0.0|

docu/CSK_Module_ImagePlayer.html

@@ -6,7 +6,7 @@
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="generator" content="Asciidoctor 2.0.12">
 <meta name="author" content="SICK AG">
-<title>Documentation - CSK_Module_ImagePlayer 3.0.0</title>
+<title>Documentation - CSK_Module_ImagePlayer 3.1.0</title>
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
 <style>
 /* Stylesheet for CodeRay to match GitHub theme | MIT License | http://foundation.zurb.com */
@@ -615,11 +615,11 @@
 </head>
 <body class="article toc2 toc-left">
 <div id="header">
-<h1>Documentation - CSK_Module_ImagePlayer 3.0.0</h1>
+<h1>Documentation - CSK_Module_ImagePlayer 3.1.0</h1>
 <div class="details">
 <span id="author" class="author">SICK AG</span><br>
-<span id="revnumber">version 3.0.0,</span>
-<span id="revdate">2024-10-11</span>
+<span id="revnumber">version 3.1.0,</span>
+<span id="revdate">2025-02-18</span>
 </div>
 <div id="toc" class="toc2">
 <div id="toctitle">Table of Contents</div>
@@ -736,11 +736,11 @@ <h2 id="_document_metadata">Document metadata</h2>
 </tr>
 <tr>
 <th class="tableblock halign-left valign-top"><p class="tableblock">Version</p></th>
-<td class="tableblock halign-left valign-top"><p class="tableblock">3.0.0</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">3.1.0</p></td>
 </tr>
 <tr>
 <th class="tableblock halign-left valign-top"><p class="tableblock">Date</p></th>
-<td class="tableblock halign-left valign-top"><p class="tableblock">2024-10-11</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">2025-02-18</p></td>
 </tr>
 <tr>
 <th class="tableblock halign-left valign-top"><p class="tableblock">Author</p></th>
@@ -2735,6 +2735,47 @@ <h6 id="_short_description_46">Short description</h6>
 </div>
 </div>
 <div class="sect5">
+<h6 id="_parameters_11">Parameters</h6>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 25%;">
+<col style="width: 25%;">
+<col style="width: 12.5%;">
+<col style="width: 37.5%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Name</th>
+<th class="tableblock halign-left valign-top">Type</th>
+<th class="tableblock halign-left valign-top">Multiplicity</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Path</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">STRING</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">?</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Path to load images.
+(e.g. "resources/CSK_Module_ImagePlayer/ColorPins" (default) or "public/Images")</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">ImageType</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">ENUM<br>
+<a href="#API:Enum:CSK_ImagePlayer.ImageTypes">CSK_ImagePlayer.ImageTypes</a></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">?</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Image type (jpg is default)</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">CycleTime</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">INT</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">?</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Cycle time to trigger new image in ms (1000 is default).</p></td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="sect5">
 <h6 id="_return_values_5">Return values</h6>
 <table class="tableblock frame-all grid-all stretch">
 <colgroup>
@@ -2765,7 +2806,7 @@ <h6 id="_return_values_5">Return values</h6>
 <h6 id="_sample_auto_generated_42">Sample (auto-generated)</h6>
 <div class="listingblock">
 <div class="content">
-<pre class="CodeRay highlight"><code data-lang="lua">handle = ImagePlayer_FC.OnNewImage.create()</code></pre>
+<pre class="CodeRay highlight"><code data-lang="lua">handle = ImagePlayer_FC.OnNewImage.create(Path, ImageType, CycleTime)</code></pre>
 </div>
 </div>
 </div>
@@ -2779,7 +2820,7 @@ <h6 id="_short_description_47">Short description</h6>
 </div>
 </div>
 <div class="sect5">
-<h6 id="_parameters_11">Parameters</h6>
+<h6 id="_parameters_12">Parameters</h6>
 <table class="tableblock frame-all grid-all stretch">
 <colgroup>
 <col style="width: 25%;">
@@ -2977,8 +3018,8 @@ <h3 id="API:Enum:CSK_ImagePlayer.ImageTypes"><span class="api-enum">CSK_ImagePla
 </div>
 <div id="footer">
 <div id="footer-text">
-Version 3.0.0<br>
-Last updated 2024-10-11 10:46:16 +0200
+Version 3.1.0<br>
+Last updated 2025-02-18 13:44:15 +0100
 </div>
 </div>
 <script type="text/javascript">