ir_tx/test.py

   1 # ir_tx.test Test for nonblocking NEC/SONY/RC-5/RC-6 mode 0 IR blaster.
   2
   3 # Released under the MIT License (MIT). See LICENSE.
   4
   5 # Copyright (c) 2020 Peter Hinch
   6
   7 # Implements a 2-button remote control on a Pyboard with auto repeat.
   8 from sys import platform
   9 ESP32 = platform == 'esp32'
  10 if ESP32:
  11     from machine import Pin
  12 else:
  13     from pyb import Pin, LED
  14 import uasyncio as asyncio
  15 from aswitch import Switch, Delay_ms
  16 # Import all implemented classes
  17 from ir_tx.nec import NEC
  18 from ir_tx.sony import SONY_12, SONY_15, SONY_20
  19 from ir_tx.philips import RC5, RC6_M0
  20
  21 loop = asyncio.get_event_loop()
  22
  23 # If button is held down normal behaviour is to retransmit
  24 # but most NEC models send a REPEAT code
  25 class Rbutton:
  26     toggle = 1  # toggle is ignored in NEC mode
  27     def __init__(self, irb, pin, addr, data, proto):
  28         self.irb = irb
  29         self.sw = Switch(pin)
  30         self.addr = addr
  31         self.data = data
  32         self.proto = proto
  33
  34         self.sw.close_func(self.cfunc)
  35         self.sw.open_func(self.ofunc)
  36         self.tim = Delay_ms(self.repeat)
  37
  38     def cfunc(self):  # Button push: send data
  39         tog = 0 if self.proto < 3 else Rbutton.toggle  # NEC, sony 12, 15: toggle==0
  40         self.irb.transmit(self.addr, self.data, tog, True)  # Test validation
  41         # Auto repeat. The Sony protocol specifies 45ms but this is tight.
  42         # In 20 bit mode a data burst can be upto 39ms long.
  43         self.tim.trigger(108)
  44
  45     def ofunc(self):  # Button release: cancel repeat timer
  46         self.tim.stop()
  47         Rbutton.toggle ^= 1  # Toggle control
  48
  49     async def repeat(self):
  50         await asyncio.sleep(0)  # Let timer stop before retriggering
  51         if not self.sw():  # Button is still pressed: retrigger
  52             self.tim.trigger(108)
  53             if self.proto == 0:
  54                 self.irb.repeat()  # NEC special case: send REPEAT code
  55             else:
  56                 tog = 0 if self.proto < 3 else Rbutton.toggle  # NEC, sony 12, 15: toggle==0
  57                 self.irb.transmit(self.addr, self.data, tog, True)  # Test validation
  58
  59 async def main(proto):
  60     # Test uses a 38KHz carrier.
  61     if ESP32:  # Pins for IR LED gate
  62         pin = (Pin(23, Pin.OUT, value = 0), Pin(21, Pin.OUT, value = 0))
  63     else:
  64         pin = Pin('X1')
  65     classes = (NEC, SONY_12, SONY_15, SONY_20, RC5, RC6_M0)
  66     irb = classes[proto](pin, 38000)  # My decoder chip is 38KHz
  67     # Uncomment the following to print transmit timing
  68     # irb.timeit = True
  69
  70     b = []  # Rbutton instances
  71     px3 = Pin(18, Pin.IN, Pin.PULL_UP) if ESP32 else Pin('X3', Pin.IN, Pin.PULL_UP)
  72     px4 = Pin(19, Pin.IN, Pin.PULL_UP) if ESP32 else Pin('X4', Pin.IN, Pin.PULL_UP)
  73     b.append(Rbutton(irb, px3, 0x1, 0x7, proto))
  74     b.append(Rbutton(irb, px4, 0x10, 0xb, proto))
  75     if ESP32:
  76         while True:
  77             print('Running')
  78             await asyncio.sleep(5)
  79     else:
  80         led = LED(1)
  81         while True:
  82             await asyncio.sleep_ms(500)  # Obligatory flashing LED.
  83             led.toggle()
  84
  85 # Greeting strings. Common:
  86 s = '''Test for IR transmitter. Run:
  87 from ir_tx.test import test
  88 test() for NEC protocol
  89 test(1) for Sony SIRC 12 bit
  90 test(2) for Sony SIRC 15 bit
  91 test(3) for Sony SIRC 20 bit
  92 test(4) for Philips RC-5 protocol
  93 test(5) for Philips RC-6 mode 0.
  94 '''
  95
  96 # Pyboard:
  97 spb = '''
  98 IR LED on pin X1
  99 Ground pin X3 to send addr 1 data 7
 100 Ground pin X4 to send addr 0x10 data 0x0b.'''
 101
 102 # ESP32
 103 sesp = '''
 104 IR LED gate on pins 23, 21
 105 Ground pin 18 to send addr 1 data 7
 106 Ground pin 19 to send addr 0x10 data 0x0b.'''
 107
 108 print(''.join((s, sesp)) if ESP32 else ''.join((s, spb)))
 109
 110 def test(proto=0):
 111     loop.run_until_complete(main(proto))