script/libs/necir.lua

   1 --[[
   2 @module necir
   3 @summary necir NEC协议红外接收
   4 @version 3.5
   5 @date    2023.09.03
   6 @author  lulipro
   7 @usage
   8 --注意:
   9 --1、本库在Air101和Air103测试通过，Air105由于SPI传输帧与帧之间存在间隔因此暂不支持。
  10 --2、本库实现了NEC红外数据接收，发送请使用LuatOS底层固件自带的ir.sendNEC()函数。
  11 --3、由于本库基于标准四线SPI接口实现，所以虽然只用到了MISO引脚，但是其他3个SPI相关引脚在使用期间
  12 --  无法作为其他用途，除非执行necir.close()并等待necir.isClosed()为true后，SPI将完全释放，才可以用于其他用途。
  13 --硬件模块：VS1838及其兼容的一体化接收头
  14 --接线示意图：
  15 --1、支持单IO模式，即仅使用一个SPI_MISO引脚，此时necir.init的irq_pin参数必须是SPI_MISO所在引脚。
  16 --2、支持多从机，如果SPI总线上需要挂接其他从设备，为了在不使用红外通信期间，避免VS1838干扰总线的MISO，则可以用
  17 --  一个NMOS（例如AO3400）控制VS1838的电源地，如下所示，GPIO充当VS1838的片选信号，当GPIO输出低
  18 --  则禁用VS1838，此时VS1838不工作，其OUT引脚为高阻，不会干扰MISO；当GPIO输出高，则启用VS1838，
  19 --  此时其OUT引脚会输出红外通信信号到单片机。由于一般的SPI从机片选逻辑为低使能，因此这样可以用
  20 --  同一个片选GPIO来控制VS1838以及另一个SPI从机，因为片选逻辑是相反的。配合necir库的necir.close()
  21 --  和necir.isClosed()可以最大化的复用SPI接口，避免SPI的独占而浪费。
  22 --  ____________________                ____________________
  23 -- |                    |    单IO      |                    |
  24 -- |           SPI_MISO |--------------| OUT                |
  25 -- | Air10x             |              |       VS1838       |
  26 -- |                    |              |     一体化接收头    |
  27 -- |               GPIO |----      ----| GND                |
  28 -- |____________________|   |      |   |____________________|
  29 --                          |      |
  30 --                          |  ____|________
  31 --                          | |    D        |
  32 --                          --| G      NMOS |
  33 --                            |____S________|
  34 --                                 |
  35 --                                GND
  36 --用法实例：演示用同一个SPI接口驱动VS1838和W25QXX
  37 --用法实例：
  38 local necir = require("necir")
  39
  40 --定义用户回调函数
  41 local function my_ir_cb(frameTab)
  42     log.info('get ir msg','addr=',frameTab[1],frameTab[2],'data=',frameTab[3])
  43 end
  44
  45 sys.taskInit(function()
  46     local CS = gpio.setup(pin.PA07,0)  --VS1838(NMOS控制其GND)与W25QXX共用的片选引脚
  47     necir.init(spi.SPI_0,pin.PB03,my_ir_cb)
  48
  49     while 1 do
  50         --===============================
  51         log.info('------necir start------')
  52         CS(1)     --使能VS1838
  53         necir.start()  --开启necir数据接收过程
  54         sys.wait(10000)
  55         log.info('necir request to close')
  56         necir.close()   --请求关闭necir
  57         while not (necir.isClosed()) do
  58             sys.wait(200)
  59         end
  60         CS(0)    --除能VS1838
  61         log.info('necir closed')
  62         sys.wait(1000)
  63
  64         --===============================
  65         log.info('------setup to read w25qxx chip id------')
  66         spi.setup(spi.SPI_0,nil,
  67             0,--CPHA
  68             0,--CPOL
  69             8,--数据宽度
  70             100000,--频率
  71             spi.MSB,--高低位顺序
  72             spi.master,--主模式
  73             spi.full--全双工
  74         )
  75         --读取W25QXX chi id，0XEF15,表示芯片型号为W25Q32，0XEF16,表示芯片型号为W25Q64
  76         CS(0)   --片选W25QXX
  77         spi.send(spi.SPI_0,string.char(0x90)..string.char(0x00)..string.char(0x00)..string.char(0x00))
  78         local chip_id = spi.recv(spi.SPI_0,2)
  79         log.info('w25qxx id=',chip_id:toHex())
  80         CS(1)   --取消片选W25QXX
  81         sys.wait(1000)
  82     end
  83 end)
  84 ]]
  85
  86 local necir = {}
  87
  88 local sys = require "sys"
  89
  90 local NECIR_IRQ_PIN               --上升沿中断检测引脚
  91 local NECIR_SPI_ID                --使用的SPI接口的ID
  92 local NECIR_SPI_BAUDRATE       = (14222*4)        --SPI时钟频率，单位HZ
  93 local NECIR_SPI_RECV_BUFF_LEN  = (32+192+192)     --SPI接收数据的长度
  94
  95 local recvBuff              --SPI接收数据缓冲区
  96 local recvNECFrame={}       --依次存储：地址码，地址码取反，数据码，数据码取反
  97
  98 local recvCallback          --NEC报文接收成功后的用户回调函数
  99 local isNeedTaskFlag        --接收任务是否需要运行的标志
 100 local isClosedFlag          --necir是否已经完全关闭的标志
 101 --[[
 102 ==============实现原理================================================
 103 NEC协议中无论是引导信号，逻辑0还是逻辑1，都由若干个562.5us的周期组成。
 104 例如
 105   引导信号: 16个562.5us的低电平+8个562.5us的高电平组成
 106   逻 辑 1 ：1个562.5us的低电平+3个562.5us的高电平组成
 107   逻 辑 0 ：1个562.5us的低电平+1个562.5us的高电平组成
 108
 109 采样定理告诉我们，一切数字信号，都可以通过高倍速采样还原。
 110 我们使用SPI的MISO引脚对红外接收管的输出进行【连续采样】。
 111 我们使用4个SPI字节去采样一个562.5us的红外信号周期，因此SPI的时钟频率设置为 (14222*4) Hz
 112 则
 113   引导信号: 16*4个0x00 + 8*4个0xff组成
 114   逻 辑 1 ：1*4个0x00 + 3*4个0xff组成，共16字节
 115   逻 辑 0 ：1*4个0x00 + 1*4个0xff组成 ，共8字节
 116
 117 NEC的引导信号由一段低电平+一段高电平组成，为了降低采样深度，避免空间占用，我们选择
 118 从后面的高电平产生的上升沿开始进行SPI接收采样 而不是从第一个下降沿就开始。
 119
 120 确定采样深度。NEC协议中，地址码和数据码都是连续传输2次，连续的2个字节是相互取反的关系，
 121 因此这2个字节的总的传输时间是固定，因为前一个字节的某个位是1，则必定后一个字节对应位是0，
 122 则总传输时间就是 = （逻辑1传输时间+逻辑0传输时间）* 8，
 123 则（地址码+ 地址码取反） 和 （数据码+数据码取反）的采样深度都是 (16+8)*8 = 192字节。
 124 引导码高电平部分则是8*4字节。这样我们就确定了SPI的总传输字节数= 32 + 192 + 192=416字节。
 125
 126 理想情况下中断检测到引导码产生的上升沿就会立刻开始SPI数据采集，这样SPI传输 416 字节
 127 能刚好采集引导码的4.5ms高电平加后面的4字节数据，但由于LuatOS中断响应存在一定延迟，导致真正开始
 128 SPI采集会在引导码上升沿开始后的若干个毫秒延迟后才开始，经过测试一般延迟在1ms以内，但具体延迟取决于
 129 LuatOS的行为，只要这个延迟能让SPI采集到完整的引导码后面的4字节数据就都是可以接受的，即延迟不能超过
 130 4.5ms，一般这个情况是能满足的。
 131
 132 本方法需要的SPI频率为56888Hz，而Air101和Air103的SPI频率 = 40MHz/(2*(div_REG+1))，
 133 则div_REG = 350即可实现。如果芯片的SPI无法配置频率也将不支持此方案。
 134
 135 考虑到LuatOS中断响应存在一定延迟，导致SPI接收的信号与实际输出的信号存在一定的
 136 滞后导致字节错位。因此对接收到的SPI字节数据 依次向后 采用16字节长度的窗口切出子串，
 137 对这个子串进行模式匹配，来确定当前片段对应是NEC的逻辑1还是逻辑0。
 138 即：
 139   在当前位置开始的后面的16个字节形成的子串中，如果存在连续的9个0xff，
 140   则认为当前位置是逻辑1，否则认为是逻辑0。
 141   为什什么是9个，考虑下面的情形：
 142
 143 逻辑1: 0x00 0x00 0x00 0x00  0xff 0xff 0xff 0xff ... 0xff
 144        [     4  个       ]  [         12 个            ]
 145
 146 逻辑0: 0x00 0x00 0x00 0x00  0xff 0xff 0xff 0xff  0x00 0x00 0x00 0x00 0xff 0xff 0xff 0xff
 147        [     4  个       ]  [       4 个      ]  [    下一个逻辑位（部分）               ]
 148
 149 可以发现，如果是逻辑0，则连续的16个字节窗口中最多出现4个连续的0xff，因此可以作为区分。
 150 lua中的string.find()可以方便的实现字符串模式匹配，因此代码实现很简单。
 151 ]]
 152
 153
 154 --从收到的SPI数据中解析出NEC报文
 155 local function parseRecvData()
 156     local fs,fe
 157     local si
 158
 159     --数据重新初始化
 160     recvNECFrame[1] = 0
 161     recvNECFrame[2] = 0
 162     recvNECFrame[3] = 0
 163     recvNECFrame[4] = 0
 164
 165     --尝试找到第一个不是0xff出现的位置，用于跳过引导信号字节，这部分最多32字节
 166     si=1
 167     while si <= 32+5 do
 168         if 0xff ~= string.byte(string.sub(recvBuff,si,si)) then
 169             break
 170         end
 171         si = si + 1
 172     end
 173
 174     --32+5个0xff后依然没有出现地址数据，属于不正常的信号，直接退出
 175     if 0xff == string.byte(string.sub(recvBuff,si,si)) then
 176         return
 177     end
 178
 179     --遍历引导信号后续的信号，整个收到的SPI数据进行NEC数据解析还原
 180     while si<=NECIR_SPI_RECV_BUFF_LEN do
 181
 182         for k = 1, 4, 1 do  --解析出NEC报文的4个字节
 183             for i = 0, 7, 1 do  --每个字节8位
 184                 --在当前位置开始的后面的16个字节中，如果存在连续的9个0xff的值，
 185                 --则认为当前位置是逻辑1
 186                 fs,fe = string.find(
 187                     string.sub(recvBuff,si,si+16-1),
 188                     '\xff\xff\xff\xff\xff\xff\xff\xff\xff'
 189                 )
 190                 if fs and fe then --找到这种模式
 191                     --这个bit为1(NEC协议大小端为LSB First)
 192                     recvNECFrame[k] = (recvNECFrame[k] | (1<<i))
 193                     si = si + 16
 194                 else  --没找到这种模式
 195                     --这个bit为0
 196                     si = si + 8
 197                 end
 198             end  --每个字节8位
 199         end --解析出NEC报文的4个字节
 200
 201         break  --成功解析出4个字节后跳出循环
 202
 203     end --遍历整个收到的SPI数据
 204
 205     --对收到的红外数据进行校验并调用 用户回调函数
 206     --有的遥控的2个地址字节不是相互取反的关系，因此这里不对地址码校验
 207     if ((recvNECFrame[3]+recvNECFrame[4]) == 255) then
 208         --log.info('necir','DataValid,go CallBack')
 209         if recvCallback then recvCallback(recvNECFrame) end
 210     end
 211     --log.info('necir',recvNECFrame[1],recvNECFrame[2],recvNECFrame[3],recvNECFrame[4])
 212 end
 213
 214
 215 --检测引导产生的上升沿的的中断函数
 216 local function irq_func()
 217     gpio.close(NECIR_IRQ_PIN)  --关闭GPIO功能，防止中断反复触发
 218     spi.setup(NECIR_SPI_ID,nil,0,0,8,NECIR_SPI_BAUDRATE,spi.MSB,spi.master,spi.full)--重新打开SPI接口
 219
 220     recvBuff =  spi.recv(NECIR_SPI_ID, NECIR_SPI_RECV_BUFF_LEN) --通过SPI接收红外接收头输出的解调数据
 221     sys.publish('NECIR_SPI_DONE')  --发布消息，让任务对收到的SPI数据分析处理
 222 end
 223
 224
 225 local function recvTaskFunc()
 226
 227     while true do
 228         sys.waitUntil('NECIR_START',5000)
 229
 230         while isNeedTaskFlag do
 231             spi.close(NECIR_SPI_ID)  --关闭SPI接口在，这样才能把MISO空出来做中断检测
 232             gpio.setup(NECIR_IRQ_PIN,irq_func,gpio.PULLUP ,gpio.RISING)--打开GPIO中断检测功能
 233
 234             local result, _ = sys.waitUntil('NECIR_SPI_DONE',1000)
 235             if result then  --SPI完成采集，开始解析数据
 236                 parseRecvData()
 237             end
 238         end
 239         --关闭接收过程时做清理工作
 240         if not isClosedFlag then
 241             gpio.close(NECIR_IRQ_PIN)  --关闭GPIO功能
 242             spi.close(NECIR_SPI_ID)   --关闭SPI接口
 243             isClosedFlag = true
 244             --log.info('necir','recv task closed')
 245         end
 246     end --task main loop
 247 end
 248
 249 --[[
 250 necir初始化
 251 @api necir.init(spi_id,irq_pin,recv_cb)
 252 @number spi_id,使用的SPI接口的ID
 253 @number irq_pin,使用的中断引脚，在单IO模式下这个引脚必须是SPI的MISO引脚
 254 @function recv_cb,红外数据接收完成后的回调函数，回调函数有1个table类型参数，分别存储了地址码，地址码取反，数据码，数据码取反
 255 @usage
 256 local function my_ir_cb(frameTab)
 257     log.info('get ir msg','addr=',frameTab[1],frameTab[2],'data=',frameTab[3])
 258 end
 259
 260 necir.init(spi.SPI_0,pin.PB03,my_ir_cb)
 261 ]]
 262 function necir.init(spi_id,irq_pin,recv_cb)
 263     NECIR_SPI_ID     = spi_id
 264     NECIR_IRQ_PIN    = irq_pin
 265     recvCallback     = recv_cb
 266
 267     isNeedTaskFlag = false      --接收任务是否需要运行的标志
 268     isClosedFlag   = true       --necir是否已经完全关闭的标志
 269     --启动红外数据接收任务
 270     sys.taskInit(recvTaskFunc)
 271 end
 272
 273 --[[
 274 开启necir数据接收过程
 275 @api necir.start()
 276 @usage
 277 necir.start()
 278 ]]
 279 function necir.start()
 280     isNeedTaskFlag     = true
 281     isClosedFlag       = false
 282     sys.publish('NECIR_START')
 283 end
 284
 285 --[[
 286 请求关闭necir数据接收过程。此函数执行后并不能保证立刻关闭，具体是否已经关闭需要使用necir.isClosed()来查询。
 287 @api necir.close()
 288 @usage
 289 necir.close()
 290 ]]
 291 function necir.close()
 292     isNeedTaskFlag = false
 293 end
 294
 295 --[[
 296 判断necir是否已经完全关闭，关闭后所使用的SPI接口将释放，可以复用为其他功能。如需再次开启，则需要再次调用necir.start()
 297 @api necir.isClosed()
 298 @return bool   关闭成功返回true
 299 @usage
 300 necir.isClosed()
 301 ]]
 302 function necir.isClosed()
 303     return isClosedFlag
 304 end
 305
 306 return necir