Просмотр исходного кода

update: 优化一下ec11的注释

Wendal Chen 3 лет назад
Родитель
Сommit
f98a69fbe2
1 измененных файлов с 13 добавлено и 8 удалено
  1. 13 8
      script/libs/ec11.lua

+ 13 - 8
script/libs/ec11.lua

@@ -1,24 +1,29 @@
 --[[
 @module ec11
-@summary ec11 编码器驱动(一定一脉冲)
+@summary ec11 旋转编码器
 @version 1.0
 @date    2023.03.27
 @author  Dozingfiretruck
 @usage
--- 用法实例
+-- 用法实例, 当前支持一定一脉冲
 local ec11 = require("ec11")
 
-local GPIO_A = pin.PB02
-local GPIO_B = pin.PB05
+-- 按实际接线写
+local GPIO_A = 6
+local GPIO_B = 7
 ec11.init(GPIO_A,GPIO_B)
+
+-- 演示接收旋转效果
 local count = 0
 local function ec11_callBack(direction)
     if direction == "left" then
+        -- 往左选,逆时针
         count = count - 1
     else
+        -- 往右旋,顺时针
         count = count + 1
     end
-    print(direction,count)
+    log.info("ec11", direction, count)
 end
 
 sys.subscribe("ec11",ec11_callBack)
@@ -32,10 +37,10 @@ local A = false
 local B = false
 
 --[[
-ec11
+初始化ec11
 @api ec11.init(GPIO_A,GPIO_B)
-@number GPIO_A A引脚
-@number GPIO_B B引脚
+@number GPIO_A A引脚对应的GPIO编号, 例如 GPIO6, 就写6
+@number GPIO_B B引脚对应的GPIO编号, 例如 GPIO7, 就写7
 @usage
 ec11.init(6,7)
 ]]