@dobot-plus/template 1.3.6 → 1.3.8

package/lua/control.lua

@@ -1,19 +1,19 @@
 --- @module $PLUGIN_NAME$
 --- @description This is the control module for the plugin.
---- 该模块为插件的功能模块，用于实现各种控制功能。
+--- This module contains the main control functions that will be called by the plugin's main logic.
 
 local $PLUGIN_NAME$ = {}
 
 $PLUGIN_NAME$.controlMethod1 = function(params)
-  -- TODO 实现函数逻辑
+  -- TODO implement the logic for controlMethod1
 end
 
 $PLUGIN_NAME$.controlMethod2 = function(params)
-  -- TODO 实现函数逻辑
+  -- TODO implement the logic for controlMethod2
 end
 
 $PLUGIN_NAME$.controlMethod3 = function(params)
-	-- TODO 实现函数逻辑
+	-- TODO implement the logic for controlMethod3
 end
 
 return $PLUGIN_NAME$

package/lua/daemon.lua

@@ -1,6 +1,7 @@
 --- @module daemon
 --- @description This is the daemon module for the plugin.
---- 该模块插件的入口进程，在插件安装成功后自动执行该文件中的 EventLoop 方法，该方法会不断的执行，直到程序退出。
+--- This module is the entry process of the plugin, and the EventLoop method in this file will be automatically executed after the plugin is successfully installed.
+--- The method will continue to execute until the program exits.
 
 local mqtt = require('$PLUGIN_NAME$.mqtt')
 
@@ -11,7 +12,7 @@ end
 
 function StopHandler()
   print('program is stopped')
-  -- 在这里执行任何需要在程序停止时的操作
+  -- Execute any operations that need to be performed when the program stops
 end
 
 local function EventLoop()

package/lua/httpAPI.lua

@@ -1,27 +1,24 @@
 --- @module httpAPI
 --- @description This is the http module for the plugin.
---- 该模块为控制器处理插件的 http 请求提供接口
+--- This module provides interfaces for the controller to handle HTTP requests for the plugin.
 
 local $PLUGIN_NAME$ = require("$PLUGIN_NAME$")
 
 local httpModule = {}
 
---- This function will be called when plugin uninstalled
---- 插件卸载时执行该函数
+--- This function will be called when the plugin is uninstalled
 httpModule.OnUninstall = function()
-	-- TODO 需要在插件卸载时执行的操作
+	-- TODO implement the operations that need to be performed when the plugin is uninstalled
 end
 
---- This function will be called when plugin installed
---- 插件安装时自动执行该函数
+--- This function will be called when the plugin is installed
 httpModule.OnInstall = function()
-  -- TODO 需要在插件安装时执行的操作
+  -- TODO implement the operations that need to be performed when the plugin is installed
 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
+	-- Short press: optional demoMethod1 demoMethod2, Long press: optional demoMethod3
 	return {press = {"demoMethod1", "demoMethod2"}, longPress = {"demoMethod3"}}
 end
 
@@ -29,12 +26,12 @@ end
 --- 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。
+--- This method will be automatically executed when the HTTP request is received, corresponding to the URL: http://<controller_ip>:<plugin_port>/dobotPlus/[plugin_name]_[plugin_version]/demoMethod1
 httpModule.demoMethod1 = function(params)
-	-- TODO 需要在接收到http请求后执行的操作
+	-- TODO implement the operations that need to be performed when the HTTP request is received
 	$PLUGIN_NAME$.controlMethod1(params)
 	return {
-		--- Your responce data
+		--- Your response data
     status = true
 	}
 end
@@ -46,7 +43,7 @@ end
 httpModule.demoMethod2 = function(params)
 	$PLUGIN_NAME$.controlMethod2(params)
 	return {
-		--- Your responce data
+		--- Your response data
 		status = true
 	}
 end

package/lua/userAPI.lua

@@ -1,6 +1,6 @@
 --- @module userAPI
 --- @description This is the user API module for the plugin.
---- 该模块为脚本编程和积木编程提供插件接口
+--- This module provides plugin interfaces for script programming and blockly programming.
 
 require("$PLUGIN_NAME$.modbus")
 local $PLUGIN_NAME$ = require("$PLUGIN_NAME$")
@@ -8,7 +8,7 @@ local $PLUGIN_NAME$ = require("$PLUGIN_NAME$")
 local userApiModule = {}
 
 function PauseHandler()
-	--- 程序运行暂停时的回调函数
+	--- This function will be called when the program is paused
 	print(" --- PauseHandler ....  --- ")
 end
 
@@ -35,18 +35,18 @@ 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 来使用该函数 
+-- This function will be automatically executed after the plugin is installed, and the ExportFunction function will export the method in the second parameter for use in script programming and blockly programming
+-- For example: ExportFunction('A', B) will export the B function in the current module and rename it to 'A'
+-- In script programming and blockly programming, you can use A to use this function
 function userApiModule.OnRegist()
 	EcoLog(" --- OnRegist ....  --- ")
-	--- 程序运行暂停时的回调函数
+	--- This function will be called when the program is paused
 	RegistePauseHandler('PauseHandler')
-	-- 0. 接口导出
+	-- 0. Export functions
 	local isErr = ExportFunction("demoMethod1", userApiModule.demoMethod1) or
 		ExportFunction("demoMethod2", userApiModule.demoMethod2) or
 		ExportFunction("demoMethod3", userApiModule.demoMethod3)
-	-- 1. 错误的处理		
+	-- 1. Error handling		
 	if isErr then
 		EcoLog(" --- ERR to  register .... --- ", isErr)
 		dobotTool.SetError(0)

package/lua/utils/modbus.lua

@@ -2,12 +2,15 @@ require('$PLUGIN_NAME$.variables')
 require("$PLUGIN_NAME$.util")
 local lockerName = "dobot_485_lock"
 
+local modbus = {}
+
 --- SetTool485(baudrate, parity, stop, identify)
 --- err, id = ModbusCreate(ip, port, slaveId, isRTU): use endTool for 485 communication
 --- err:int, 0: success, 1: over max master num, 2: master init failed, 3: master connect to poll failed
 --- err, id = ModbusRTUCreate(slave_id, baud, parity, data_bit, stop_bit): use controller for 485 communication
-function createModbusMasterClient(slaveID)
-    SetTool485(115200, 'E', 1, 1)
+modbus.createModbusMasterClient = function(slaveID)
+    --- SetTool485(baudrate, parity, stop)
+    SetTool485(115200, 'E', 1)
     local err, id = ModbusCreate("127.0.0.1", 60000, tonumber(slaveID), true)
     --- local err, id = ModbusRTUCreate(slave_id, baud, parity, data_bit, stop_bit)
     if err ~= 0 then
@@ -18,8 +21,8 @@ function createModbusMasterClient(slaveID)
 end
 
 --- @param reg table {addrDec: number, length: number}
-function getRegsData(reg, slaveID)
-    local clientID = createModbusMasterClient(slaveID)
+modbus.getRegsData = function(reg, slaveID)
+    local clientID = modbus.createModbusMasterClient(slaveID)
     if clientID == nil then
         return {}
     end
@@ -40,8 +43,8 @@ end
 --- @param reg table {addrDec: number, length: number}
 --- @param values table length should be the same as reg.length
 --- @return err int, 0: success, -1: failed
-function setRegsData(reg, values, slaveID)
-    local clientID = createModbusMasterClient(slaveID)
+modbus.setRegsData = function(reg, values, slaveID)
+    local clientID = modbus.createModbusMasterClient(slaveID)
     if clientID == nil then
         return -1
     end

package/lua/utils/mqtt.lua

@@ -9,8 +9,8 @@ mqttFunc.MQTTConnect(connectId)
 
 return {
   mqtt = mqttFunc,
-  --- 发布数据到指定的 MQTT 主题。
-  --- @param data table  要发布的数据，数据将被编码为 JSON 格式。
+  --- Publish data to the specified MQTT topic.
+  --- @param data table  The data to be published, which will be encoded in JSON format.
   publish = function(data)
     mqttFunc.MQTTPublish(connectId, MQTT_PUBLISH_TOPIC, jsonLuaUtils.encode(data), 0, false)
   end

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dobot-plus/template",
-  "version": "1.3.6",
+  "version": "1.3.8",
   "engines": {
     "node": "20"
   },

package/ui/Blocks.tsx

@@ -1,5 +1,5 @@
 function App() {
-  return <div className="app">这是点击积木时的弹窗页面</div>
+  return <div className="app">This is the blocks page</div>
 }
 
 export default App

package/ui/Toolbar.tsx

@@ -1,5 +1,5 @@
 function App() {
-  return <div className="app">这是导航栏界面</div>
+  return <div className="app">This is the toolbar page</div>
 }
 
 export default App