Update

Author: SICKAppSpace-dev

LICENSE

@@ -22,3 +22,4 @@ ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
 
 For more information, please refer to <https://unlicense.org>
+

StringStreaming/project.mf.xml

@@ -1,18 +1,18 @@
-<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<manifest>
-    <application name="StringStreaming">
-        <crown name="StringStreaming">
-            <desc>user script</desc>
-        </crown>
-        <meta key="author">AppSpace Sample</meta>
-        <meta key="version">2.5.0</meta>
-        <meta key="licensed">false</meta>
-        <meta key="priority">low</meta>
-        <meta key="copy-protected">false</meta>
-        <meta key="read-protected">false</meta>
-        <meta key="tags">Lua</meta>
-        <entry path="scripts" default="StringStreaming.lua">
-            <file type="text/x-lua">StringStreaming.lua</file>
-        </entry>
-    </application>
-</manifest>
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<manifest>
+    <application name="StringStreaming">
+        <crown name="StringStreaming">
+            <desc>user script</desc>
+        </crown>
+        <meta key="author">AppSpace Sample</meta>
+        <meta key="version">2.5.0</meta>
+        <meta key="licensed">false</meta>
+        <meta key="priority">low</meta>
+        <meta key="copy-protected">false</meta>
+        <meta key="read-protected">false</meta>
+        <meta key="tags">Lua</meta>
+        <entry path="scripts" default="StringStreaming.lua">
+            <file type="text/x-lua">StringStreaming.lua</file>
+        </entry>
+    </application>
+</manifest>

StringStreaming/scripts/StringStreaming.lua

@@ -1,50 +1,48 @@
-
---Start of Global Scope---------------------------------------------------------
-
--- Data which is streamed
-local SHORT = 1346
-local BYTE = 76
-local LONG = 2464321
-
---End of Global Scope-----------------------------------------------------------
-
---Start of Function and Event Scope-----------------------------------------------
-
---@packStringString()
-local function packString()
-  --'HBL' = Unsinged short (H), unsinged byte (B) and unsinged long (L)
-  --More information about the format can be found in the string component description
-  local binaryString = string.pack('HBL', SHORT, BYTE, LONG)
-  -- Writing data to file
-  local file = File.open('/private/TestStringPacks.bin', 'wb')
-  assert(file, 'File could not be opened to write')
-  File.write(file, binaryString)
-  File.close(file)
-end
-
---@unpackString()
-local function unpackString()
-  -- Reading binary data from file
-  local file = File.open('/private/TestStringPacks.bin', 'rb')
-  assert(file, 'File could not be opened to read')
-  local data = File.read(file)
-  File.close(file)
-
-  -- Unpacking binary data read from file
-  local value1, value2, value3 = string.unpack('HBL', data)
-  print('value 1 read: ' .. tostring(value1))
-  print('value 2 read: ' .. tostring(value2))
-  print('value 3 read: ' .. tostring(value3))
-end
-
---Declaration of the 'main' function as an entry point for the event loop.
---@main()
-local function main()
-  packString()
-  unpackString()
-end
---The following registration is part of the global scope which runs once after startup
---Registration of the 'main' function to the Engine.OnStarted event
-Script.register('Engine.OnStarted', main)
-
---End of Function and Event Scope-----------------------------------------------
+
+--Start of Global Scope---------------------------------------------------------
+
+-- Data which is streamed
+local SHORT = 1346
+local BYTE = 76
+local LONG = 2464321
+
+--End of Global Scope-----------------------------------------------------------
+
+--Start of Function and Event Scope-----------------------------------------------
+
+local function packString()
+  --'HBL' = Unsinged short (H), unsinged byte (B) and unsinged long (L)
+  --More information about the format can be found in the string component description
+  local binaryString = string.pack('HBL', SHORT, BYTE, LONG)
+  -- Writing data to file
+  local file = File.open('/private/TestStringPacks.bin', 'wb')
+  assert(file, 'File could not be opened to write')
+  File.write(file, binaryString)
+  File.close(file)
+end
+
+local function unpackString()
+  -- Reading binary data from file
+  local file = File.open('/private/TestStringPacks.bin', 'rb')
+  assert(file, 'File could not be opened to read')
+  local data = File.read(file)
+  File.close(file)
+
+  -- Unpacking binary data read from file
+  local value1, value2, value3 = string.unpack('HBL', data)
+  print('value 1 read: ' .. tostring(value1))
+  print('value 2 read: ' .. tostring(value2))
+  print('value 3 read: ' .. tostring(value3))
+end
+
+---Declaration of the 'main' function as an entry point for the event loop.
+local function main()
+  packString()
+  unpackString()
+end
+
+--The following registration is part of the global scope which runs once after startup
+--Registration of the 'main' function to the Engine.OnStarted event
+Script.register('Engine.OnStarted', main)
+
+--End of Function and Event Scope-----------------------------------------------

readme.md

@@ -1,7 +1,9 @@
 ## StringStreaming
+
 Streaming binary data using the Lua functions string.pack() / string.unpack().
 
 ### Description
+
 This sample shows the streaming of data packed with the Lua string.pack function.
 First the data is packed (serialized in binary form) and written to a file.
 Then the same file is read, unpacked and the data is stored back to variables.
@@ -11,4 +13,5 @@ information about the format string can be found in the component description or
 in the Lua reference manual.
 
 ### Topics
-Programming-Pattern, Sample, SICK-AppSpace
+
+programming-pattern, sample, sick-appspace