@dobot-plus/template 1.2.7 → 1.2.9

package/Resources/i18n/client/zh.json

@@ -1,11 +1,11 @@
-{
-  "blocks": {
-    "blocksDemoKey": "积木中文翻译内容 %1"
-  },
-  "config": {
-    "configDemoKey": "中文内容"
-  },
-  "scripts": {
-    "scriptDemoKey": "脚本中文翻译内容"
-  }
-}
+{
+  "blocks": {
+    "blocksDemoKey": "积木中文翻译内容 %1"
+  },
+  "config": {
+    "configDemoKey": "中文内容"
+  },
+  "scripts": {
+    "scriptDemoKey": "脚本中文翻译内容"
+  }
+}

package/Resources/i18n/plugin/de.json

@@ -1,3 +1,3 @@
-{
-  "testKey": "This is the control page for plugin"
-}
+{
+  "testKey": "This is the control page for plugin"
+}

package/Resources/i18n/plugin/en.json

@@ -1,3 +1,3 @@
-{
-  "testKey": "This is the control page for plugin"
-}
+{
+  "testKey": "This is the control page for plugin"
+}

package/Resources/i18n/plugin/es.json

@@ -1,3 +1,3 @@
-{
-  "testKey": "This is the control page for plugin"
-}
+{
+  "testKey": "This is the control page for plugin"
+}

package/Resources/i18n/plugin/hk.json

@@ -1,3 +1,3 @@
-{
-  "testKey": "这是插件的控制界面"
-}
+{
+  "testKey": "这是插件的控制界面"
+}

package/Resources/i18n/plugin/ja.json

@@ -1,3 +1,3 @@
-{
-  "testKey": "This is the control page for plugin"
-}
+{
+  "testKey": "This is the control page for plugin"
+}

package/Resources/i18n/plugin/ko.json

@@ -1,3 +1,3 @@
-{
-  "testKey": "This is the control page for plugin"
-}
+{
+  "testKey": "This is the control page for plugin"
+}

package/Resources/i18n/plugin/ru.json

@@ -1,3 +1,3 @@
-{
-  "testKey": "This is the control page for plugin"
-}
+{
+  "testKey": "This is the control page for plugin"
+}

package/Resources/i18n/plugin/zh.json

@@ -1,3 +1,3 @@
-{
-  "testKey": "这是插件的控制界面"
-}
+{
+  "testKey": "这是插件的控制界面"
+}

package/configs/Blocks.json

@@ -1,21 +1,21 @@
-[
-  {
-    "block_name": "DemoBlock",
-    "block_type": "shape_statement",
-    "block_color": "#ffa211",
-    "block_configs": [
-      {
-        "message": "blocksDemoKey",
-        "params": [
-          {
-            "name": "id",
-            "param_type": "input_value",
-            "data_type": "math_number",
-            "default": "9"
-          }
-        ]
-      }
-    ],
-    "block_code": ["demoMethod1({id})\n"]
-  }
-]
+[
+  {
+    "block_name": "DemoBlock",
+    "block_type": "shape_statement",
+    "block_color": "#ffa211",
+    "block_configs": [
+      {
+        "message": "blocksDemoKey",
+        "params": [
+          {
+            "name": "id",
+            "param_type": "input_value",
+            "data_type": "math_number",
+            "default": "9"
+          }
+        ]
+      }
+    ],
+    "block_code": ["demoMethod1({id})\n"]
+  }
+]

package/configs/Main.json

@@ -1,5 +1,5 @@
-{
-  "name": "demo",
-  "version": "1-0-0-test",
-  "description": "%{configDemoKey}"
-}
+{
+  "name": "demo",
+  "version": "1-0-0-test",
+  "description": "%{configDemoKey}"
+}

package/configs/Scripts.json

@@ -1,7 +1,7 @@
-[
-  {
-    "script_name": "DemoScript",
-    "message": "%{scriptDemoKey}",
-    "script_code": "demoMethod1({id = 1})"
-  }
-]
+[
+  {
+    "script_name": "DemoScript",
+    "message": "%{scriptDemoKey}",
+    "script_code": "demoMethod1({id = 1})"
+  }
+]

package/configs/Toolbar.json

@@ -1,5 +1,5 @@
-{
-  "name": "Toolbar",
-  "width": 800,
-  "height": 900
-}
+{
+  "name": "Toolbar",
+  "width": 800,
+  "height": 900
+}

package/dpt.json

@@ -1,4 +1,4 @@
-{
-  "ip": "192.168.5.1",
-  "port": 22001
-}
+{
+  "ip": "192.168.5.1",
+  "port": 22001
+}

package/lua/control.lua

@@ -1,19 +1,19 @@
---- @module control
---- @description This is the control module for the plugin.
---- 该模块为插件的功能模块，用于实现各种控制功能。
-
-local control = {}
-
-control.controlMethod1 = function(params)
-  -- TODO 实现函数逻辑
-end
-
-control.controlMethod2 = function(params)
-  -- TODO 实现函数逻辑
-end
-
-control.controlMethod3 = function(params)
-	-- TODO 实现函数逻辑
-end
-
+--- @module control
+--- @description This is the control module for the plugin.
+--- 该模块为插件的功能模块，用于实现各种控制功能。
+
+local control = {}
+
+control.controlMethod1 = function(params)
+  -- TODO 实现函数逻辑
+end
+
+control.controlMethod2 = function(params)
+  -- TODO 实现函数逻辑
+end
+
+control.controlMethod3 = function(params)
+	-- TODO 实现函数逻辑
+end
+
 return control

package/lua/daemon.lua

@@ -1,22 +1,22 @@
---- @module daemon
---- @description This is the daemon module for the plugin.
---- 该模块插件的入口进程，在插件安装成功后自动执行该文件中的 EventLoop 方法，该方法会不断的执行，直到程序退出。
-
-local mqtt = require('utils.mqtt')
-
-local function handleInLoop()
-  local data = {}
-  mqtt.publish(data)
-end
-
-local function EventLoop()
-  while true do
-    handleInLoop()
-    Wait(1000)
-  end
-end
-
-local thread = systhread.create(EventLoop, 1)
-thread:wait()
-
-
+--- @module daemon
+--- @description This is the daemon module for the plugin.
+--- 该模块插件的入口进程，在插件安装成功后自动执行该文件中的 EventLoop 方法，该方法会不断的执行，直到程序退出。
+
+local mqtt = require('utils.mqtt')
+
+local function handleInLoop()
+  local data = {}
+  mqtt.publish(data)
+end
+
+local function EventLoop()
+  while true do
+    handleInLoop()
+    Wait(1000)
+  end
+end
+
+local thread = systhread.create(EventLoop, 1)
+thread:wait()
+
+

package/lua/httpAPI.lua

@@ -1,66 +1,66 @@
---- @module httpAPI
---- @description This is the http module for the plugin.
---- 该模块为控制器处理插件的 http 请求提供接口
-
-local control = require("control")
-
-local httpModule = {}
-
---- This function will be called when plugin uninstalled
---- 插件卸载时执行该函数
-httpModule.OnUninstall = function()
-	-- TODO 需要在插件卸载时执行的操作
-end
-
---- This function will be called when plugin installed
---- 插件安装时自动执行该函数
-httpModule.OnInstall = function()
-  -- TODO 需要在插件安装时执行的操作
-end
-
---- This function will be called when plugin installed, this action will export some http method for device hotkey binding
---- 插件安装时自动执行该函数，该函数会导出一些的http方法，供设备热键绑定使用
-httpModule.OnRegistHotKey = function() 
-	-- 短按：可选 demoMethod1 demoMethod2 长按：可选 demoMethod3
-	return {press = {"demoMethod1", "demoMethod2"}, longPress = {"demoMethod3"}}
-end
-
---- This method will be called when a http '/dobotPlus/[plugin name]_[plugin version]/demoMethod1' request arrived
---- The return value will response the http request, the return value is not necessory
---- @param params table 
---- @return string The return value will response the http request, the return value is not necessory
---- 该方法会在http请求接收到后，自动执行，对应请求的 url为: http://<控制器ip>:<插件端口>/dobotPlus/[插件名]_[插件版本]/demoMethod1。
-httpModule.demoMethod1 = function(params)
-	-- TODO 需要在接收到http请求后执行的操作
-	control.controlMethod1(params)
-	return {
-		--- Your responce data
-    status = true
-	}
-end
-
---- This method will be called when a http '/dobotPlus/[plugin name]_[plugin version]/demoMethod2' request arrived
---- The return value will response the http request, the return value is not necessory
---- @param params table
---- @return string 
-httpModule.demoMethod2 = function(params)
-	control.controlMethod2(params)
-	return {
-		--- Your responce data
-		status = true
-	}
-end
-
---- This method will be called when a http '/dobotPlus/[plugin name]_[plugin version]/demoMethod3' request arrived
---- The return value will response the http request, the return value is not necessory
---- @param params table
---- @return string The return value will response the http request, the return value is not necessory
-httpModule.demoMethod3 = function(params)
-	control.controlMethod3(params)
-	return {
-		--- Your responce data
-		status = true
-  }
-end
-
-return httpModule
+--- @module httpAPI
+--- @description This is the http module for the plugin.
+--- 该模块为控制器处理插件的 http 请求提供接口
+
+local control = require("control")
+
+local httpModule = {}
+
+--- This function will be called when plugin uninstalled
+--- 插件卸载时执行该函数
+httpModule.OnUninstall = function()
+	-- TODO 需要在插件卸载时执行的操作
+end
+
+--- This function will be called when plugin installed
+--- 插件安装时自动执行该函数
+httpModule.OnInstall = function()
+  -- TODO 需要在插件安装时执行的操作
+end
+
+--- This function will be called when plugin installed, this action will export some http method for device hotkey binding
+--- 插件安装时自动执行该函数，该函数会导出一些的http方法，供设备热键绑定使用
+httpModule.OnRegistHotKey = function() 
+	-- 短按：可选 demoMethod1 demoMethod2 长按：可选 demoMethod3
+	return {press = {"demoMethod1", "demoMethod2"}, longPress = {"demoMethod3"}}
+end
+
+--- This method will be called when a http '/dobotPlus/[plugin name]_[plugin version]/demoMethod1' request arrived
+--- The return value will response the http request, the return value is not necessory
+--- @param params table 
+--- @return string The return value will response the http request, the return value is not necessory
+--- 该方法会在http请求接收到后，自动执行，对应请求的 url为: http://<控制器ip>:<插件端口>/dobotPlus/[插件名]_[插件版本]/demoMethod1。
+httpModule.demoMethod1 = function(params)
+	-- TODO 需要在接收到http请求后执行的操作
+	control.controlMethod1(params)
+	return {
+		--- Your responce data
+    status = true
+	}
+end
+
+--- This method will be called when a http '/dobotPlus/[plugin name]_[plugin version]/demoMethod2' request arrived
+--- The return value will response the http request, the return value is not necessory
+--- @param params table
+--- @return string 
+httpModule.demoMethod2 = function(params)
+	control.controlMethod2(params)
+	return {
+		--- Your responce data
+		status = true
+	}
+end
+
+--- This method will be called when a http '/dobotPlus/[plugin name]_[plugin version]/demoMethod3' request arrived
+--- The return value will response the http request, the return value is not necessory
+--- @param params table
+--- @return string The return value will response the http request, the return value is not necessory
+httpModule.demoMethod3 = function(params)
+	control.controlMethod3(params)
+	return {
+		--- Your responce data
+		status = true
+  }
+end
+
+return httpModule

package/lua/userAPI.lua

@@ -1,51 +1,51 @@
---- @module userAPI
---- @description This is the user API module for the plugin.
---- 该模块为脚本编程和积木编程提供插件接口
-
-require("utils.await485")
-local control = require("control")
-
-local userApiModule = {}
-
---- This function will be called when you add it in the blockly programming or script programming
---- This function can be used in the httpAPI module also
----@param params table
-function userApiModule.demoMethod1(params)
-		return control.controlMethod1(params)
-end
-
---- This function will be called when you add it in the blockly programming or script programming
---- This function can be used in the httpAPI module also
----@param params table
-function userApiModule.demoMethod2(params)
-	return control.controlMethod2(params)
-end
-
---- This function will be called when you add it in the blockly programming or script programming
---- This function can be used in the httpAPI module also
----@param params table
-function userApiModule.demoMethod3(params)
-		return control.controlMethod3(params)
-end
-
--- This function will be called when the plugin is installed
--- The export functions will be registered to the corresponding code block or script in blockly programming or script programming
--- 该函数会在插件安装后自动执行，其中 ExportFunction 函数会将第二个参数的方法导出给脚本编程和积木编程使用
--- 例如：ExportFunction('A', B) 会将当前模块中的 B 函数导出，并重命名为 'A'
--- 在脚本编程和积木编程中可以使用 A 来使用该函数 
-function userApiModule.OnRegist()
-	EcoLog(" --- OnRegist ....  --- ")
-	-- 0. 接口导出
-	local isErr = ExportFunction("demoMethod1", userApiModule.demoMethod1) or
-		ExportFunction("demoMethod2", userApiModule.demoMethod2) or
-		ExportFunction("demoMethod3", userApiModule.demoMethod3)
-	-- 1. 错误的处理		
-	if isErr then
-		EcoLog(" --- ERR to  register .... --- ", isErr)
-		dobotTool.SetError(0)
-	end
-end
-
-return userApiModule
-
-
+--- @module userAPI
+--- @description This is the user API module for the plugin.
+--- 该模块为脚本编程和积木编程提供插件接口
+
+require("utils.await485")
+local control = require("control")
+
+local userApiModule = {}
+
+--- This function will be called when you add it in the blockly programming or script programming
+--- This function can be used in the httpAPI module also
+---@param params table
+function userApiModule.demoMethod1(params)
+		return control.controlMethod1(params)
+end
+
+--- This function will be called when you add it in the blockly programming or script programming
+--- This function can be used in the httpAPI module also
+---@param params table
+function userApiModule.demoMethod2(params)
+	return control.controlMethod2(params)
+end
+
+--- This function will be called when you add it in the blockly programming or script programming
+--- This function can be used in the httpAPI module also
+---@param params table
+function userApiModule.demoMethod3(params)
+		return control.controlMethod3(params)
+end
+
+-- This function will be called when the plugin is installed
+-- The export functions will be registered to the corresponding code block or script in blockly programming or script programming
+-- 该函数会在插件安装后自动执行，其中 ExportFunction 函数会将第二个参数的方法导出给脚本编程和积木编程使用
+-- 例如：ExportFunction('A', B) 会将当前模块中的 B 函数导出，并重命名为 'A'
+-- 在脚本编程和积木编程中可以使用 A 来使用该函数 
+function userApiModule.OnRegist()
+	EcoLog(" --- OnRegist ....  --- ")
+	-- 0. 接口导出
+	local isErr = ExportFunction("demoMethod1", userApiModule.demoMethod1) or
+		ExportFunction("demoMethod2", userApiModule.demoMethod2) or
+		ExportFunction("demoMethod3", userApiModule.demoMethod3)
+	-- 1. 错误的处理		
+	if isErr then
+		EcoLog(" --- ERR to  register .... --- ", isErr)
+		dobotTool.SetError(0)
+	end
+end
+
+return userApiModule
+
+

package/lua/utils/mqtt.lua

@@ -1,17 +1,17 @@
-local jsonLuaUtils = require("luaJson")
-local mqttFunc = require("libplugin_eco")
-
-local MQTT_PUBLISH_TOPIC = "$PLUGIN_MSG_TOPIC$"
-local connectId = "$PLUGIN_NAME$"
-
-mqttFunc.MQTTCreate(connectId,"127.0.0.1",1883,600)
-mqttFunc.MQTTConnect(connectId)
-
-return {
-  mqtt = mqttFunc,
-  --- 发布数据到指定的 MQTT 主题。
-  --- @param data table  要发布的数据，数据将被编码为 JSON 格式。
-  publish = function(data)
-    mqttFunc.MQTTPublish(connectId, MQTT_PUBLISH_TOPIC, jsonLuaUtils.encode(data), 0, false)
-  end
+local jsonLuaUtils = require("luaJson")
+local mqttFunc = require("libplugin_eco")
+
+local MQTT_PUBLISH_TOPIC = "$PLUGIN_MSG_TOPIC$"
+local connectId = "$PLUGIN_NAME$"
+
+mqttFunc.MQTTCreate(connectId,"127.0.0.1",1883,600)
+mqttFunc.MQTTConnect(connectId)
+
+return {
+  mqtt = mqttFunc,
+  --- 发布数据到指定的 MQTT 主题。
+  --- @param data table  要发布的数据，数据将被编码为 JSON 格式。
+  publish = function(data)
+    mqttFunc.MQTTPublish(connectId, MQTT_PUBLISH_TOPIC, jsonLuaUtils.encode(data), 0, false)
+  end
 }

package/lua/utils/num_convert.lua

@@ -1,41 +1,41 @@
-local NumberConversion = {}
-
--- 将二进制字符串转换为十进制数
-function NumberConversion.binaryToDecimal(binaryStr)
-    return tonumber(binaryStr, 2)
-end
-
--- 将十进制数转换为二进制字符串
-function NumberConversion.decimalToBinary(dec)
-    local binaryStr = ""
-    while dec > 0 do
-        local remainder = dec % 2
-        binaryStr = remainder .. binaryStr
-        dec = math.floor(dec / 2)
-    end
-    return binaryStr == "" and "0" or binaryStr
-end
-
--- 将十六进制字符串转换为十进制数
-function NumberConversion.hexToDecimal(hexStr)
-    return tonumber(hexStr, 16)
-end
-
--- 将十进制数转换为十六进制字符串
-function NumberConversion.decimalToHex(dec)
-    return string.format("%X", dec)
-end
-
--- 将二进制字符串转换为十六进制字符串
-function NumberConversion.binaryToHex(binaryStr)
-    local dec = NumberConversion.binaryToDecimal(binaryStr)
-    return NumberConversion.decimalToHex(dec)
-end
-
--- 将十六进制字符串转换为二进制字符串
-function NumberConversion.hexToBinary(hexStr)
-    local dec = NumberConversion.hexToDecimal(hexStr)
-    return NumberConversion.decimalToBinary(dec)
-end
-
-return NumberConversion
+local NumberConversion = {}
+
+-- 将二进制字符串转换为十进制数
+function NumberConversion.binaryToDecimal(binaryStr)
+    return tonumber(binaryStr, 2)
+end
+
+-- 将十进制数转换为二进制字符串
+function NumberConversion.decimalToBinary(dec)
+    local binaryStr = ""
+    while dec > 0 do
+        local remainder = dec % 2
+        binaryStr = remainder .. binaryStr
+        dec = math.floor(dec / 2)
+    end
+    return binaryStr == "" and "0" or binaryStr
+end
+
+-- 将十六进制字符串转换为十进制数
+function NumberConversion.hexToDecimal(hexStr)
+    return tonumber(hexStr, 16)
+end
+
+-- 将十进制数转换为十六进制字符串
+function NumberConversion.decimalToHex(dec)
+    return string.format("%X", dec)
+end
+
+-- 将二进制字符串转换为十六进制字符串
+function NumberConversion.binaryToHex(binaryStr)
+    local dec = NumberConversion.binaryToDecimal(binaryStr)
+    return NumberConversion.decimalToHex(dec)
+end
+
+-- 将十六进制字符串转换为二进制字符串
+function NumberConversion.hexToBinary(hexStr)
+    local dec = NumberConversion.hexToDecimal(hexStr)
+    return NumberConversion.decimalToBinary(dec)
+end
+
+return NumberConversion