diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 662af9989..95c4245c1 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -18,7 +18,7 @@ body: attributes: label: The type of board you are using. options: - - Arduino ATmega328* board (UNO, Nano, etc.) + - Arduino ATmega328* board (Uno, Nano, etc.) - Arduino ATmega2560 board (Mega) - Arduino ATmega32U4 board (Leonardo, etc.) - Arduino ATmega4809 megaAVR board (NanoEvery) diff --git a/.github/workflows/LibraryBuild.yml b/.github/workflows/LibraryBuild.yml index fb7638afe..93aee1426 100644 --- a/.github/workflows/LibraryBuild.yml +++ b/.github/workflows/LibraryBuild.yml @@ -1,7 +1,7 @@ # https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/.github/workflows/LibraryBuild.yml # Github workflow script to test compile all examples of an Arduino library repository. # -# Copyright (C) 2020 Armin Joachimsmeyer +# Copyright (C) 2020-2023 Armin Joachimsmeyer # https://github.com/ArminJo/Github-Actions # # Before being able to push to my .github\workflows directories, @@ -40,14 +40,14 @@ jobs: # # Examples: arduino:avr:uno, arduino:avr:leonardo, arduino:avr:nano, arduino:avr:mega # arduino:sam:arduino_due_x, arduino:samd:arduino_zero_native" - # ATTinyCore:avr:attinyx5:chip=85,clock=1internal, digistump:avr:digispark-tiny, digistump:avr:digispark-pro + # ATTinyCore:avr:attinyx5:chip=85,clock=1internal # STMicroelectronics:stm32:GenF1:pnum=BLUEPILL_F103C8 # esp8266:esp8266:huzzah:eesz=4M3M,xtal=80, esp32:esp32:featheresp32:FlashFreq=80 # You may add a suffix behind the fqbn with "|" to specify one board for e.g. different compile options like arduino:avr:uno|trace ############################################################################################################# arduino-boards-fqbn: - arduino:avr:uno - - arduino:avr:uno|DEBUG + - arduino:avr:uno|DEBUG_TRACE - arduino:avr:uno|USE_NO_SEND_PWM - arduino:avr:uno|SEND_PWM_BY_TIMER - arduino:avr:uno|USE_OPEN_DRAIN_OUTPUT_FOR_SEND_PIN @@ -55,11 +55,12 @@ jobs: - arduino:avr:leonardo - arduino:megaavr:nona4809:mode=off - arduino:samd:arduino_zero_native + - arduino:renesas_uno:unor4wifi - adafruit:samd:adafruit_metro_m4:cache=on,speed=120,opt=small,maxqspi=50,usbstack=arduino,debug=off + - adafruit:samd:adafruit_itsybitsy_m4 - arduino:mbed:nano33ble - arduino:mbed_rp2040:pico - rp2040:rp2040:arduino_nano_connect - - digistump:avr:digispark-tiny:clock=clock16 - ATTinyCore:avr:attinyx5micr:LTO=enable,sketchclock=16pll - ATTinyCore:avr:attinyx7micr:LTO=enable,sketchclock=16external,pinmapping=new,millis=enabled - ATTinyCore:avr:attinyx8micr:LTO=enable,sketchclock=16external,pinmapping=mhtiny,millis=enabled # ATtiny88 China clone board @16 MHz @@ -69,6 +70,7 @@ jobs: - megaTinyCore:megaavr:atxy7:chip=3217,clock=16internal - esp8266:esp8266:d1_mini:eesz=4M3M,xtal=80 - esp32:esp32:featheresp32:FlashFreq=80 + - esp32:esp32:esp32c3 - STMicroelectronics:stm32:GenF1:pnum=BLUEPILL_F103C8 - STMicroelectronics:stm32:GenL0:pnum=THUNDERPACK_L072 - stm32duino:STM32F1:genericSTM32F103C @@ -81,31 +83,34 @@ jobs: include: - arduino-boards-fqbn: arduino:avr:uno build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=100 -DIR_SEND_PIN=3 + ReceiveDemo: -DIR_REMOTE_DISABLE_RECEIVE_COMPLETE_CALLBACK + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=1200 -DIR_SEND_PIN=3 - - arduino-boards-fqbn: arduino:avr:uno|DEBUG + - arduino-boards-fqbn: arduino:avr:uno|DEBUG_TRACE build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=100 -DIR_SEND_PIN=3 - All: -DEBUG + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 -DIR_SEND_PIN=3 + TinyReceiver: -DUSE_CALLBACK_FOR_TINY_RECEIVER + All: -DEBUG -DTRACE - arduino-boards-fqbn: arduino:avr:uno|USE_NO_SEND_PWM build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=100 -DIR_SEND_PIN=3 + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 -DIR_SEND_PIN=3 TinyReceiver: -DUSE_FAST_PROTOCOL TinySender: -DUSE_FAST_PROTOCOL All: -DUSE_NO_SEND_PWM - arduino-boards-fqbn: arduino:avr:uno|SEND_PWM_BY_TIMER - sketches-exclude: UnitTest + sketches-exclude: UnitTest,MultipleSendPins build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=100 -DIR_SEND_PIN=3 -DSEND_PWM_BY_TIMER + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 -DIR_SEND_PIN=3 -DSEND_PWM_BY_TIMER + ReceiveDemo: -DDECODE_ONKYO TinyReceiver: -DUSE_ONKYO_PROTOCOL TinySender: -DUSE_ONKYO_PROTOCOL All: -DSEND_PWM_BY_TIMER - arduino-boards-fqbn: arduino:avr:uno|USE_OPEN_DRAIN_OUTPUT_FOR_SEND_PIN build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=100 -DIR_SEND_PIN=3 -DUSE_OPEN_DRAIN_OUTPUT_FOR_SEND_PIN + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 -DIR_SEND_PIN=3 -DUSE_OPEN_DRAIN_OUTPUT_FOR_SEND_PIN SimpleSender: -DSEND_PWM_BY_TIMER TinyReceiver: -DENABLE_NEC2_REPEATS TinySender: -DENABLE_NEC2_REPEATS @@ -113,159 +118,187 @@ jobs: - arduino-boards-fqbn: arduino:avr:mega:cpu=atmega2560 build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=700 + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 SimpleSender: -DSEND_PWM_BY_TIMER TinyReceiver: -DDISABLE_PARITY_CHECKS TinySender: -DDISABLE_PARITY_CHECKS - arduino-boards-fqbn: arduino:avr:leonardo build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=100 + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 TinyReceiver: -DNO_LED_FEEDBACK_CODE TinySender: -DNO_LED_FEEDBACK_CODE -# sketches-exclude: ReceiveAndSend # Not enough RAM for default RAW_BUFFER_LENGTH + sketches-exclude: UnitTest # Sketch uses 28764 bytes (100%) of program storage space. Maximum is 28672 bytes - arduino-boards-fqbn: arduino:megaavr:nona4809:mode=off sketches-exclude: TinyReceiver,IRDispatcherDemo build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=100 + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 SimpleSender: -DSEND_PWM_BY_TIMER - TinyReceiver: -DUSE_ONKYO_PROTOCOL -DENABLE_NEC2_REPEATS -DNO_LED_FEEDBACK_CODE + TinyReceiver: -DUSE_ONKYO_PROTOCOL -DENABLE_NEC2_REPEATS -DNO_LED_FEEDBACK_CODE -DUSE_CALLBACK_FOR_TINY_RECEIVER TinySender: -DUSE_ONKYO_PROTOCOL -DENABLE_NEC2_REPEATS -DNO_LED_FEEDBACK_CODE - arduino-boards-fqbn: arduino:samd:arduino_zero_native sketches-exclude: TinyReceiver,IRDispatcherDemo build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=100 + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 + + - arduino-boards-fqbn: arduino:renesas_uno:unor4wifi + sketches-exclude: TinyReceiver,IRDispatcherDemo + build-properties: # the flags were put in compiler.cpp.extra_flags + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 - arduino-boards-fqbn: adafruit:samd:adafruit_metro_m4:cache=on,speed=120,opt=small,maxqspi=50,usbstack=arduino,debug=off platform-url: https://adafruit.github.io/arduino-board-index/package_adafruit_index.json sketches-exclude: TinyReceiver,IRDispatcherDemo build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=100 + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 + + - arduino-boards-fqbn: adafruit:samd:adafruit_itsybitsy_m4 + platform-url: https://adafruit.github.io/arduino-board-index/package_adafruit_index.json + sketches-exclude: TinyReceiver,IRDispatcherDemo + build-properties: # the flags were put in compiler.cpp.extra_flags + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 + - arduino-boards-fqbn: arduino:mbed:nano33ble build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=100 + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 SimpleSender: -DSEND_PWM_BY_TIMER +# +# RP2040 +# - arduino-boards-fqbn: arduino:mbed_rp2040:pico build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=100 + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=750 SimpleSender: -DSEND_PWM_BY_TIMER - arduino-boards-fqbn: rp2040:rp2040:arduino_nano_connect platform-url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=100 -DSEND_PWM_BY_TIMER + IRremoteExtensionTest: -DSEND_PWM_BY_TIMER SimpleSender: -DSEND_PWM_BY_TIMER - All: -DRAW_BUFFER_LENGTH=700 + All: -DRAW_BUFFER_LENGTH=750 +# +# megaTinyCore +# - arduino-boards-fqbn: megaTinyCore:megaavr:atxy4:chip=1604,clock=16internal - arduino-platform: megaTinyCore:megaavr@2.5.11 # The current 2.6.0 is broken see https://github.com/SpenceKonde/megaTinyCore/issues/805 + arduino-platform: megaTinyCore:megaavr platform-url: http://drazzy.com/package_drazzy.com_index.json - sketches-exclude: AllProtocolsOnLCD + sketches-exclude: AllProtocolsOnLCD,UnitTest # UnitTest region `text' overflowed by 997 bytes build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=100 + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=360 - arduino-boards-fqbn: megaTinyCore:megaavr:atxy7:chip=3217,clock=16internal - arduino-platform: megaTinyCore:megaavr@2.5.11 + arduino-platform: megaTinyCore:megaavr platform-url: http://drazzy.com/package_drazzy.com_index.json sketches-exclude: AllProtocolsOnLCD build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=100 - - - arduino-boards-fqbn: digistump:avr:digispark-tiny:clock=clock16 - platform-url: https://raw.githubusercontent.com/ArminJo/DigistumpArduino/master/package_digistump_index.json - required-libraries: ATtinySerialOut - sketch-names: TinyReceiver.ino,IRremoteInfo.ino,SimpleReceiver.ino,ControlRelay.ino,SimpleSender.ino,SendDemo.ino,SendRawDemo.ino,SendAndReceive.ino - build-properties: # the flags were put in compiler.cpp.extra_flags - SimpleSender: -DSEND_PWM_BY_TIMER + IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=360 +# +# ATTinyCore +# - arduino-boards-fqbn: ATTinyCore:avr:attinyx5micr:LTO=enable,sketchclock=16pll platform-url: http://drazzy.com/package_drazzy.com_index.json required-libraries: ATtinySerialOut - sketch-names: TinyReceiver.ino,IRremoteInfo.ino,SimpleReceiver.ino,ReceiveDemo.ino,ControlRelay.ino,SimpleSender.ino,SendDemo.ino,SendRawDemo.ino,SendAndReceive.ino + sketch-names: TinyReceiver.ino,IRremoteInfo.ino,SimpleReceiver.ino,ReceiveDemo.ino,ControlRelay.ino,SimpleSender.ino,SendDemo.ino,SendRawDemo.ino,SendAndReceive.ino,SimpleReceiverForHashCodes.ino build-properties: # the flags were put in compiler.cpp.extra_flags SimpleSender: -DSEND_PWM_BY_TIMER + SimpleReceiver: -DDECODE_NEC - arduino-boards-fqbn: ATTinyCore:avr:attinyx7micr:LTO=enable,sketchclock=16external,pinmapping=new,millis=enabled platform-url: http://drazzy.com/package_drazzy.com_index.json required-libraries: ATtinySerialOut - sketch-names: TinyReceiver.ino,IRremoteInfo.ino,SimpleReceiver.ino,ReceiveDemo.ino,ControlRelay.ino,SimpleSender.ino,SendDemo.ino,SendRawDemo.ino,SendAndReceive.ino + sketch-names: TinyReceiver.ino,IRremoteInfo.ino,SimpleReceiver.ino,ReceiveDemo.ino,ControlRelay.ino,SimpleSender.ino,SendDemo.ino,SendRawDemo.ino,SendAndReceive.ino,SimpleReceiverForHashCodes.ino build-properties: # the flags were put in compiler.cpp.extra_flags SimpleSender: -DSEND_PWM_BY_TIMER - arduino-boards-fqbn: ATTinyCore:avr:attinyx8micr:LTO=enable,sketchclock=16external,pinmapping=mhtiny,millis=enabled # ATtiny88 China clone board @16 MHz platform-url: http://drazzy.com/package_drazzy.com_index.json required-libraries: ATtinySerialOut - sketch-names: TinyReceiver.ino,IRremoteInfo.ino,SimpleReceiver.ino,ReceiveDemo.ino,ControlRelay.ino,SimpleSender.ino,SendDemo.ino,SendRawDemo.ino,SendAndReceive.ino + sketch-names: TinyReceiver.ino,IRremoteInfo.ino,SimpleReceiver.ino,ReceiveDemo.ino,ControlRelay.ino,SimpleSender.ino,SendDemo.ino,SendRawDemo.ino,SendAndReceive.ino,SimpleReceiverForHashCodes.ino build-properties: # the flags were put in compiler.cpp.extra_flags - SimpleSender: -DSEND_PWM_BY_TIMER + SimpleSender: -DSEND_PWM_BY_TIMER + SimpleReceiver: -DDECODE_NEC +# +# MegaCore +# - arduino-boards-fqbn: MegaCore:avr:128:bootloader=no_bootloader,eeprom=keep,BOD=2v7,LTO=Os_flto,clock=8MHz_internal platform-url: https://mcudude.github.io/MegaCore/package_MCUdude_MegaCore_index.json arduino-platform: arduino:avr,MegaCore:avr # gcc is taken from arduino:avr build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=300 SimpleSender: -DSEND_PWM_BY_TIMER - All: -DRAW_BUFFER_LENGTH=700 + All: -DRAW_BUFFER_LENGTH=750 +# +# ESP +# - arduino-boards-fqbn: esp8266:esp8266:d1_mini:eesz=4M3M,xtal=80 platform-url: https://arduino.esp8266.com/stable/package_esp8266com_index.json sketches-exclude: TinyReceiver build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=200 - All: -DRAW_BUFFER_LENGTH=300 + All: -DRAW_BUFFER_LENGTH=750 - arduino-boards-fqbn: esp32:esp32:featheresp32:FlashFreq=80 platform-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json sketches-exclude: TinyReceiver # undefined reference to `TwoWire::onReceive(void (*)(int))' build-properties: # the flags were put in compiler.cpp.extra_flags. SEND_PWM_BY_TIMER is always enabled! - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=500 -Wno-error=maybe-uninitialized - All: -DRAW_BUFFER_LENGTH=300 -Wno-error=maybe-uninitialized # https://github.com/espressif/arduino-esp32/issues/7024 + IRremoteExtensionTest: -MMD -c # see https://github.com/espressif/arduino-esp32/issues/8815 + All: -DRAW_BUFFER_LENGTH=750 -MMD -c + - arduino-boards-fqbn: esp32:esp32:esp32c3 + platform-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json + sketches-exclude: TinyReceiver # undefined reference to `TwoWire::onReceive(void (*)(int))' + build-properties: # the flags were put in compiler.cpp.extra_flags. SEND_PWM_BY_TIMER is always enabled! + IRremoteExtensionTest: -MMD -c # see https://github.com/espressif/arduino-esp32/issues/8815 + All: -DRAW_BUFFER_LENGTH=750 -MMD -c + +# +# STM +# - arduino-boards-fqbn: STMicroelectronics:stm32:GenF1:pnum=BLUEPILL_F103C8 # ST version platform-url: https://raw.githubusercontent.com/stm32duino/BoardManagerFiles/main/package_stmicroelectronics_index.json sketches-exclude: TinyReceiver build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=700 - All: -DRAW_BUFFER_LENGTH=300 + All: -DRAW_BUFFER_LENGTH=750 - arduino-boards-fqbn: STMicroelectronics:stm32:GenL0:pnum=THUNDERPACK_L072 # ST version platform-url: https://raw.githubusercontent.com/stm32duino/BoardManagerFiles/main/package_stmicroelectronics_index.json sketches-exclude: TinyReceiver,IRDispatcherDemo build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=700 - All: -DRAW_BUFFER_LENGTH=300 + All: -DRAW_BUFFER_LENGTH=750 - arduino-boards-fqbn: stm32duino:STM32F1:genericSTM32F103C # Roger Clark version platform-url: http://dan.drown.org/stm32duino/package_STM32duino_index.json sketches-exclude: TinyReceiver build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=700 - All: -DRAW_BUFFER_LENGTH=300 + All: -DRAW_BUFFER_LENGTH=750 +# +# Others +# - arduino-boards-fqbn: SparkFun:avr:promicro arduino-platform: arduino:avr,SparkFun:avr platform-url: https://raw.githubusercontent.com/sparkfun/Arduino_Boards/master/IDE_Board_Manager/package_sparkfun_index.json # Arduino URL is not required here build-properties: # the flags were put in compiler.cpp.extra_flags. SEND_PWM_BY_TIMER is always enabled! - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=700 - All: -DRAW_BUFFER_LENGTH=300 + All: -DRAW_BUFFER_LENGTH=750 + sketches-exclude: UnitTest # Sketch uses 28762 bytes (100%) of program storage space. Maximum is 28672 bytes. - arduino-boards-fqbn: sandeepmistry:nRF5:BBCmicrobit platform-url: https://sandeepmistry.github.io/arduino-nRF5/package_nRF5_boards_index.json sketches-exclude: IRDispatcherDemo,MicroGirs,TinyReceiver build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=700 - All: -DRAW_BUFFER_LENGTH=300 + All: -DRAW_BUFFER_LENGTH=750 - arduino-boards-fqbn: Seeeduino:samd:seeed_XIAO_m0:usbstack=arduino,debug=off,sercom4=include platform-url: https://files.seeedstudio.com/arduino/package_seeeduino_boards_index.json - sketches-exclude: AllProtocolsOnLCD,UnitTest,ReceiveAndSendDistanceWidth # No print(uint64_t,.) available + sketches-exclude: AllProtocolsOnLCD,UnitTest,ReceiveAndSendDistanceWidth,ReceiveDemo,SimpleReceiverForHashCodes # No print(uint64_t,.) available build-properties: # the flags were put in compiler.cpp.extra_flags - IRremoteExtensionTest: -DRAW_BUFFER_LENGTH=700 - All: -DRAW_BUFFER_LENGTH=300 + All: -DRAW_BUFFER_LENGTH=750 # fail-fast: false # false -> do not cancel all jobs / architectures if one job fails @@ -277,9 +310,12 @@ jobs: uses: ArminJo/arduino-test-compile@master with: arduino-board-fqbn: ${{ matrix.arduino-boards-fqbn }} - arduino-platform: ${{ matrix.arduino-platform }} + arduino-platform: ${{ matrix.arduino-platform }} # for MegaCore platform-url: ${{ matrix.platform-url }} required-libraries: ${{ matrix.required-libraries }} - sketch-names: ${{ matrix.sketch-names }} + sketch-names: ${{ matrix.sketch-names }} # Comma separated list of sketch names (without path, but with extension) or patterns to use in build sketches-exclude: ${{ matrix.sketches-exclude }} build-properties: ${{ toJson(matrix.build-properties) }} +# cli-version: 0.33.0 # to avoid errors for ATTinyCore +# debug-install: true +# debug-compile: true \ No newline at end of file diff --git a/.github/workflows/PlatformIoPublish.yml b/.github/workflows/PlatformIoPublish.yml index cc9b32a1a..d8727408c 100644 --- a/.github/workflows/PlatformIoPublish.yml +++ b/.github/workflows/PlatformIoPublish.yml @@ -36,8 +36,7 @@ jobs: env: PLATFORMIO_AUTH_TOKEN: ${{ secrets.PLATFORMIO_TOKEN }} run: | - pio package publish --owner arminjo --non-interactive + pio package publish --owner Arduino-IRremote --non-interactive # run: | # pio package pack -# pio package publish --owner arminjo --non-interactive - \ No newline at end of file +# pio package publish --owner Arduino-IRremote --non-interactive diff --git a/Contributors.md b/Contributors.md index 00dd4c826..40c040464 100644 --- a/Contributors.md +++ b/Contributors.md @@ -30,5 +30,7 @@ These are the active contributors of this project that you may contact if there - [Daniel Wallner](https://github.com/danielwallner) Bang & Olufsen protocol. - [slott](https://stackoverflow.com/users/11680056/sklott) Seeduino print(unsigned long long...) support. - [Joe Ostrander](https://github.com/joeostrander) Added support for attiny1614. +- [Buzzerb](https://github.com/Buzzerb) Added Extended NEC protocol to TinyIR and making it more consistent. +- [akellai](https://github.com/akellai) Added ESP 3.0 support. Note: Please let [ArminJo](https://github.com/ArminJo) know if you have been missed. diff --git a/Doxyfile b/Doxyfile index 0ce0d4bf5..a879240e6 100644 --- a/Doxyfile +++ b/Doxyfile @@ -58,7 +58,7 @@ PROJECT_LOGO = # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = ..\Arduino-IRremote_gh-pages +OUTPUT_DIRECTORY = E:\WORKSPACE_ARDUINO\lib\Arduino-IRremote_gh-pages # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and diff --git a/README.md b/README.md index 48b0e028b..d630db6e6 100644 --- a/README.md +++ b/README.md @@ -24,54 +24,72 @@ Available as [Arduino library "IRremote"](https://www.arduinolibraries.info/libr     [![Button Contribute](https://img.shields.io/badge/Contribute-752a61?style=for-the-badge&logoColor=white&logo=GitHub)](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/Contributing.md) +#### If you find this program useful, please give it a star. + +🌎 [Google Translate](https://translate.google.com/translate?sl=en&u=https://github.com/Arduino-IRremote/Arduino-IRremote) + -# Overview -- [Supported IR Protocols](https://github.com/Arduino-IRremote/Arduino-IRremote#supported-ir-protocols) -- [Features](https://github.com/Arduino-IRremote/Arduino-IRremote#features) - * [New features with version 3.x](https://github.com/Arduino-IRremote/Arduino-IRremote#new-features-with-version-3x) -- [Converting your 2.x program to the 3.x version](https://github.com/Arduino-IRremote/Arduino-IRremote#converting-your-2x-program-to-the-3x-version) - * [How to convert old MSB first 32 bit IR data codes to new LSB first 32 bit IR data codes](https://github.com/Arduino-IRremote/Arduino-IRremote#how-to-convert-old-msb-first-32-bit-ir-data-codes-to-new-lsb-first-32-bit-ir-data-codes) -- [Errors with using the 3.x versions for old tutorials](https://github.com/Arduino-IRremote/Arduino-IRremote#errors-with-using-the-3x-versions-for-old-tutorials) - * [Staying on 2.x](https://github.com/Arduino-IRremote/Arduino-IRremote#staying-on-2x) -- [Why *.hpp instead of *.cpp](https://github.com/Arduino-IRremote/Arduino-IRremote#why-hpp-instead-of-cpp) -- [Using the new *.hpp files](https://github.com/Arduino-IRremote/Arduino-IRremote#using-the-new-hpp-files) -- [Receiving IR codes](https://github.com/Arduino-IRremote/Arduino-IRremote#receiving-ir-codes) - * [Data format](https://github.com/Arduino-IRremote/Arduino-IRremote#data-format) -- [Sending IR codes](https://github.com/Arduino-IRremote/Arduino-IRremote#sending-ir-codes) - * [Send pin](https://github.com/Arduino-IRremote/Arduino-IRremote#send-pin) - + [List of public IR code databases](https://github.com/Arduino-IRremote/Arduino-IRremote#list-of-public-ir-code-databases) -- [Tiny NEC receiver and sender](https://github.com/Arduino-IRremote/Arduino-IRremote#tiny-nec-receiver-and-sender) -- [The FAST protocol](https://github.com/Arduino-IRremote/Arduino-IRremote#the-fast-protocol) -- [FAQ and hints](https://github.com/Arduino-IRremote/Arduino-IRremote#faq-and-hints) - * [Problems with Neopixels, FastLed etc.](https://github.com/Arduino-IRremote/Arduino-IRremote#problems-with-neopixels-fastled-etc) - * [Does not work/compile with another library](https://github.com/Arduino-IRremote/Arduino-IRremote#does-not-workcompile-with-another-library) - * [Multiple IR receiver](https://github.com/Arduino-IRremote/Arduino-IRremote#multiple-ir-receiver) - * [Increase strength of sent output signal](https://github.com/Arduino-IRremote/Arduino-IRremote#increase-strength-of-sent-output-signal) - * [Minimal CPU clock frequency](https://github.com/Arduino-IRremote/Arduino-IRremote#minimal-cpu-clock-frequency) -- [Handling unknown Protocols](https://github.com/Arduino-IRremote/Arduino-IRremote#handling-unknown-protocols) - * [Disclaimer](https://github.com/Arduino-IRremote/Arduino-IRremote#disclaimer) - * [Protocol=PULSE_DISTANCE](https://github.com/Arduino-IRremote/Arduino-IRremote#protocolpulse_distance) - * [Protocol=UNKNOWN](https://github.com/Arduino-IRremote/Arduino-IRremote#protocolunknown) - * [How to deal with protocols not supported by IRremote](https://github.com/Arduino-IRremote/Arduino-IRremote#how-to-deal-with-protocols-not-supported-by-irremote) -- [Examples for this library](https://github.com/Arduino-IRremote/Arduino-IRremote#examples-for-this-library) -- [WOKWI online examples](https://github.com/Arduino-IRremote/Arduino-IRremote#wokwi-online-examples) -- [Issues and discussions](https://github.com/Arduino-IRremote/Arduino-IRremote#issues-and-discussions) -- [Compile options / macros for this library](https://github.com/Arduino-IRremote/Arduino-IRremote#compile-options--macros-for-this-library) - + [Changing include (*.h) files with Arduino IDE](https://github.com/Arduino-IRremote/Arduino-IRremote#changing-include-h-files-with-arduino-ide) - + [Modifying compile options with Sloeber IDE](https://github.com/Arduino-IRremote/Arduino-IRremote#modifying-compile-options--macros-with-sloeber-ide) -- [Supported Boards](https://github.com/Arduino-IRremote/Arduino-IRremote#supported-boards) -- [Timer and pin usage](https://github.com/Arduino-IRremote/Arduino-IRremote#timer-and-pin-usage) - * [Incompatibilities to other libraries and Arduino commands like tone() and analogWrite()](https://github.com/Arduino-IRremote/Arduino-IRremote#incompatibilities-to-other-libraries-and-arduino-commands-like-tone-and-analogwrite) - * [Hardware-PWM signal generation for sending](https://github.com/Arduino-IRremote/Arduino-IRremote#hardware-pwm-signal-generation-for-sending) - * [Why do we use 30% duty cycle for sending](https://github.com/Arduino-IRremote/Arduino-IRremote#why-do-we-use-30-duty-cycle-for-sending) -- [How we decode signals](https://github.com/Arduino-IRremote/Arduino-IRremote#how-we-decode-signals) -- [NEC encoding diagrams](https://github.com/Arduino-IRremote/Arduino-IRremote#nec-encoding-diagrams) -- [Quick comparison of 5 Arduino IR receiving libraries](https://github.com/Arduino-IRremote/Arduino-IRremote#quick-comparison-of-5-arduino-ir-receiving-libraries) -- [Useful links](https://github.com/Arduino-IRremote/Arduino-IRremote#useful-links) +# Table of content +- [Supported IR Protocols](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#supported-ir-protocols) +- [Common problem with IRremote](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#common-problem-with-irremote) +- [Using the new library version for old examples](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#using-the-new-library-version-for-old-examples) + * [New features of version 4.x](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#new-features-of-version-4x) + * [New features of version 3.x](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#new-features-of-version-3x) + * [Converting your 2.x program to the 4.x version](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#converting-your-2x-program-to-the-4x-version) + * [How to convert old MSB first 32 bit IR data codes to new LSB first 32 bit IR data codes](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#how-to-convert-old-msb-first-32-bit-ir-data-codes-to-new-lsb-first-32-bit-ir-data-codes) + * [Errors when using the 3.x versions for old tutorials](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#errors-when-using-the-3x-versions-for-old-tutorials) + * [Staying on 2.x](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#staying-on-2x) +- [Why *.hpp instead of *.cpp](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#why-hpp-instead-of-cpp) +- [Using the new *.hpp files](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#using-the-new-hpp-files) +- [Tutorials](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#tutorials) +- [3 ways to specify an IR code](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#3-ways-to-specify-an-ir-code) +- [IRReceiver pinouts](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#irreceiver-pinouts) +- [Receiving IR codes](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#receiving-ir-codes) + * [decodedIRData structure](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#decodedirdata-structure) + * [Ambiguous protocols](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#ambiguous-protocols) + * [RAM usage of different protocolsl](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#ram-usage-of-different-protocols) + * [Handling unknown Protocols](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#handling-unknown-protocols) + * [Disclaimer](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#disclaimer) + * [Other libraries, which may cover these protocols](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#other-libraries-which-may-cover-these-protocols) + * [Protocol=PULSE_DISTANCE](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#protocolpulse_distance) + * [Protocol=UNKNOWN](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#protocolunknown) + * [How to deal with protocols not supported by IRremote](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#how-to-deal-with-protocols-not-supported-by-irremote) +- [Sending IR codes](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#sending-ir-codes) + * [Sending IRDB IR codes](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#sending-irdb-ir-codes) + * [Send pin](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#send-pin) + + [List of public IR code databases](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#list-of-public-ir-code-databases) +- [Tiny NEC receiver and sender](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#tiny-nec-receiver-and-sender) +- [The FAST protocol](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#the-fast-protocol) +- [FAQ and hints](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#faq-and-hints) + * [Receiving stops after analogWrite() or tone() or after running a motor](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#receiving-stops-after-analogwrite-or-tone-or-after-running-a-motor) + * [Receiving sets overflow flag](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#receiving-sets-overflow-flag) + * [Problems with Neopixels, FastLed etc.](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#problems-with-neopixels-fastled-etc) + * [Does not work/compile with another library](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#does-not-workcompile-with-another-library) + * [Multiple IR receiver and sender instances](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#multiple-ir-receiver-and-sender-instances) + * [Increase strength of sent output signal](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#increase-strength-of-sent-output-signal) + * [Minimal CPU clock frequency](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#minimal-cpu-clock-frequency) + * [Bang & Olufsen protocol](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#bang--olufsen-protocol) +- [Examples for this library](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#examples-for-this-library) +- [WOKWI online examples](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#wokwi-online-examples) +- [IR control of a robot car](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#ir-control-of-a-robot-car) +- [Issues and discussions](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#issues-and-discussions) +- [Compile options / macros for this library](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#compile-options--macros-for-this-library) + + [Changing include (*.h) files with Arduino IDE](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#changing-include-h-files-with-arduino-ide) + + [Modifying compile options with Sloeber IDE](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#modifying-compile-options--macros-with-sloeber-ide) +- [Supported Boards](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#supported-boards) +- [Timer and pin usage](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#timer-and-pin-usage) + * [Incompatibilities to other libraries and Arduino commands like tone() and analogWrite()](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#incompatibilities-to-other-libraries-and-arduino-commands-like-tone-and-analogwrite) + * [Hardware-PWM signal generation for sending](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#hardware-pwm-signal-generation-for-sending) + * [Why do we use 30% duty cycle for sending](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#why-do-we-use-30-duty-cycle-for-sending) +- [How we decode signals](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#how-we-decode-signals) +- [NEC encoding diagrams](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#nec-encoding-diagrams) +- [Quick comparison of 5 Arduino IR receiving libraries](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#quick-comparison-of-5-arduino-ir-receiving-libraries) +- [History](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/changelog.md) +- [Useful links](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#useful-links) - [Contributors](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/Contributors.md) -- [License](https://github.com/Arduino-IRremote/Arduino-IRremote#license) -- [Copyright](https://github.com/Arduino-IRremote/Arduino-IRremote#copyright) +- [License](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#license) +- [Copyright](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#copyright)
@@ -80,7 +98,9 @@ Available as [Arduino library "IRremote"](https://www.arduinolibraries.info/libr ` JVC `     ` LG `     ` RC5 `     ` RC6 `     ` Samsung `     ` Sony ` -` Universal Pulse Distance `     ` Universal Pulse Width `     ` Hash `     ` Pronto ` +` Universal Pulse Distance `     ` Universal Pulse Width `     ` Universal Pulse Distance Width` + +` Hash `     ` Pronto ` ` BoseWave `     ` Bang & Olufsen `     ` Lego `     ` FAST `     ` Whynter `     ` MagiQuest ` @@ -93,43 +113,48 @@ Protocols can be switched off and on by defining macros before the line `#includ ```
-# Features -- Lots of tutorials and examples. -- Actively maintained. -- Allows receiving and sending of **raw timing data**. +# Common problem with IRremote +Or *"I build a gadged with 2 motors controlled by IR and the [IR stops after the first motor command](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#receiving-stops-after-analogwrite-or-tone-or-after-running-a-motor)"*.
+This is due to the fact, that the motor control by AnalogWrite() uses the same timer as IR receiving.
+See [this table](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#timer-and-pin-usage) for the list of timers and pins. -## New features with version 4.x -- New universal **Pulse Distance / Pulse Width decoder** added, which covers many previous unknown protocols. +# Using the new library version for old examples +This library has been refactored, breaking backward compatibility with the old version, on which many examples on the Internet are based. + +## New features of version 4.x +- **Since 4.3 `IrSender.begin(DISABLE_LED_FEEDBACK)` will no longer work**, use `IrSender.begin(DISABLE_LED_FEEDBACK, 0)` instead. +- New universal **Pulse Distance / Pulse Width / Pulse Distance Width decoder** added, which covers many previous unknown protocols. - Printout of code how to send received command by `IrReceiver.printIRSendUsage(&Serial)`. - RawData type is now 64 bit for 32 bit platforms and therefore `decodedIRData.decodedRawData` can contain complete frame information for more protocols than with 32 bit as before. -- Callback after receiving a command - It calls your code as soon as a message was received. +- **Callback** after receiving a command - It calls your code as soon as a message was received. - Improved handling of `PULSE_DISTANCE` + `PULSE_WIDTH` protocols. - New FAST protocol. +- Automatic printout of the **corresponding send function** with `printIRSendUsage()`. -# Converting your 3.x program to the 4.x version +### Converting your 3.x program to the 4.x version - You must replace `#define DECODE_DISTANCE` by `#define DECODE_DISTANCE_WIDTH` (only if you explicitly enabled this decoder). - The parameter `bool hasStopBit` is not longer required and removed e.g. for function `sendPulseDistanceWidth()`. -## New features with version 3.x -- **Any pin** can be used for sending -if `SEND_PWM_BY_TIMER` is not defined- and receiving. +## New features of version 3.x +- **Any pin** can be used for receiving and if `SEND_PWM_BY_TIMER` is not defined also for sending. - Feedback LED can be activated for sending / receiving. - An 8/16 bit ****command** value as well as an 16 bit **address** and a protocol number is provided for decoding (instead of the old 32 bit value). - Protocol values comply to **protocol standards**.
NEC, Panasonic, Sony, Samsung and JVC decode & send LSB first. - Supports **Universal Distance protocol**, which covers a lot of previous unknown protocols. -- Compatible with **tone()** library. See the [ReceiveDemo](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/21b5747a58e9d47c9e3f1beb056d58c875a92b47/examples/ReceiveDemo/ReceiveDemo.ino#L159-L169) example. +- Compatible with **tone()** library. See the [ReceiveDemo](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/ReceiveDemo/ReceiveDemo.ino#L284-L298) example. - Simultaneous sending and receiving. See the [SendAndReceive](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/SendAndReceive/SendAndReceive.ino#L167-L170) example. - Supports **more platforms**. - Allows for the generation of non PWM signal to just **simulate an active low receiver signal** for direct connect to existent receiving devices without using IR. - Easy protocol configuration, **directly in your [source code](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/SimpleReceiver/SimpleReceiver.ino#L33-L57)**.
Reduces memory footprint and decreases decoding time. -- Contains a [very small NEC only decoder](https://github.com/Arduino-IRremote/Arduino-IRremote#minimal-nec-receiver), which **does not require any timer resource**. +- Contains a [very small NEC only decoder](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#minimal-nec-receiver), which **does not require any timer resource**. -[-> Feature comparison of 5 Arduino IR libraries](https://github.com/Arduino-IRremote/Arduino-IRremote#quick-comparison-of-5-arduino-ir-receiving-libraries). +[-> Feature comparison of 5 Arduino IR libraries](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#quick-comparison-of-5-arduino-ir-receiving-libraries).
-# Converting your 2.x program to the 3.x version +## Converting your 2.x program to the 4.x version Starting with the 3.1 version, **the generation of PWM for sending is done by software**, thus saving the hardware timer and **enabling arbitrary output pins for sending**.
If you use an (old) Arduino core that does not use the `-flto` flag for compile, you can activate the line `#define SUPPRESS_ERROR_MESSAGE_FOR_BEGIN` in IRRemote.h, if you get false error messages regarding begin() during compilation. @@ -138,22 +163,23 @@ If you use an (old) Arduino core that does not use the `-flto` flag for compile, - Since the decoded values are now in `IrReceiver.decodedIRData` and not in `results` any more, remove the line `decode_results results` or similar. - Like for the Serial object, call [`IrReceiver.begin(IR_RECEIVE_PIN, ENABLE_LED_FEEDBACK)`](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/ReceiveDemo/ReceiveDemo.ino#L106) or `IrReceiver.begin(IR_RECEIVE_PIN, DISABLE_LED_FEEDBACK)` instead of the `IrReceiver.enableIRIn()` or `irrecv.enableIRIn()` in setup().
-For sending, call `IrSender.begin(ENABLE_LED_FEEDBACK);` or `IrSender.begin(DISABLE_LED_FEEDBACK);` in setup().
-If IR_SEND_PIN is not defined you must use e.g. `IrSender.begin(3, ENABLE_LED_FEEDBACK, USE_DEFAULT_FEEDBACK_LED_PIN);` +For sending, call `IrSender.begin();` in setup().
+If IR_SEND_PIN is not defined (before the line `#include `) you must use e.g. `IrSender.begin(3, ENABLE_LED_FEEDBACK, USE_DEFAULT_FEEDBACK_LED_PIN);` - Old `decode(decode_results *aResults)` function is replaced by simple `decode()`. So if you have a statement `if(irrecv.decode(&results))` replace it with `if (IrReceiver.decode())`. - The decoded result is now in in `IrReceiver.decodedIRData` and not in `results` any more, therefore replace any occurrences of `results.value` and `results.decode_type` (and similar) to `IrReceiver.decodedIRData.decodedRawData` and `IrReceiver.decodedIRData.protocol`. - Overflow, Repeat and other flags are now in [`IrReceiver.receivedIRData.flags`](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/IRProtocol.h#L90-L101). - Seldom used: `results.rawbuf` and `results.rawlen` must be replaced by `IrReceiver.decodedIRData.rawDataPtr->rawbuf` and `IrReceiver.decodedIRData.rawDataPtr->rawlen`. -- The 5 protocols **NEC, Panasonic, Sony, Samsung and JVC** have been converted to LSB first. Send functions for sending old MSB data for **NEC** and **JVC** were renamed to `sendNECMSB`, and `sendJVCMSB()`. The old `sendSAMSUNG()` and `sendSony()` MSB functions are still available. The old MSB version of `sendPanasonic()` function was deleted, since it had bugs nobody recognized.
-For converting MSB codes to LSB see [below](https://github.com/Arduino-IRremote/Arduino-IRremote#how-to-convert-old-msb-first-32-bit-ir-data-codes-to-new-lsb-first-32-bit-ir-data-codes). +- The 5 protocols **NEC, Panasonic, Sony, Samsung and JVC** have been converted to LSB first. Send functions for sending old MSB data were renamed to `sendNECMSB`, `sendSamsungMSB()`, `sendSonyMSB()` and `sendJVCMSB()`. The old `sendSAMSUNG()` and `sendSony()` MSB functions are still available. The old MSB version of `sendPanasonic()` function was deleted, since it had bugs nobody recognized and therfore was assumed to be never used.
+For converting MSB codes to LSB see [below](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#how-to-convert-old-msb-first-32-bit-ir-data-codes-to-new-lsb-first-32-bit-ir-data-codes). ### Example #### Old 2.x program: ```c++ #include +#define RECV_PIN 2 IRrecv irrecv(RECV_PIN); decode_results results; @@ -161,6 +187,7 @@ decode_results results; void setup() { ... + Serial.begin(115200); // Establish serial communication irrecv.enableIRIn(); // Start the receiver } @@ -174,21 +201,22 @@ void loop() { } ``` -#### New 3.x or 4.x program: +#### New 4.x program: ```c++ #include +#define IR_RECEIVE_PIN 2 void setup() { ... + Serial.begin(115200); // // Establish serial communication IrReceiver.begin(IR_RECEIVE_PIN, ENABLE_LED_FEEDBACK); // Start the receiver } void loop() { if (IrReceiver.decode()) { Serial.println(IrReceiver.decodedIRData.decodedRawData, HEX); // Print "old" raw data - /* USE NEW 3.x FUNCTIONS */ IrReceiver.printIRResultShort(&Serial); // Print complete received data in one line IrReceiver.printIRSendUsage(&Serial); // Print the statement required to send this data ... @@ -198,6 +226,17 @@ void loop() { } ``` +#### Sample output +For more, see the [UnitTest log](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/UnitTest/UnitTest.log). + +``` +Protocol=NEC Address=0xF1 Command=0x76 Raw-Data=0x89760EF1 32 bits LSB first +Send with: IrSender.sendNEC(0xF1, 0x76, ); + +Protocol=Kaseikyo_Denon Address=0xFF1 Command=0x76 Raw-Data=0x9976FF10 48 bits LSB first +Send with: IrSender.sendKaseikyo_Denon(0xFF1, 0x76, ); +``` + ## How to convert old MSB first 32 bit IR data codes to new LSB first 32 bit IR data codes For the new decoders for **NEC, Panasonic, Sony, Samsung and JVC**, the result `IrReceiver.decodedIRData.decodedRawData` is now **LSB-first**, as the definition of these protocols suggests!

@@ -216,12 +255,15 @@ Example: `0xCB340102` is binary `1100 1011 0011 0100 0000 0001 0000 0010`.
`0x40802CD3` is binary `0100 0000 1000 0000 0010 1100 1101 0011`.
If you **read the first binary sequence backwards** (right to left), you get the second sequence. +You may use `bitreverseOneByte()` or `bitreverse32Bit()` for this. + +Sending old MSB codes without conversion can be done by using `sendNECMSB()`, `sendSonyMSB()`, `sendSamsungMSB()`, `sendJVCMSB()`.
-# Errors with using the 3.x versions for old tutorials +## Errors when using the 4.x versions for old tutorials If you suffer from errors with old tutorial code including `IRremote.h` instead of `IRremote.hpp`, just try to rollback to [Version 2.4.0](https://github.com/Arduino-IRremote/Arduino-IRremote/releases/tag/v2.4.0).
-Most likely your code will run and you will not miss the new features... +Most likely your code will run and you will not miss the new features.
@@ -229,16 +271,14 @@ Most likely your code will run and you will not miss the new features... Consider using the [original 2.4 release form 2017](https://github.com/Arduino-IRremote/Arduino-IRremote/releases/tag/v2.4.0) or the last backwards compatible [2.8 version](https://github.com/Arduino-IRremote/Arduino-IRremote/releases/tag/2.8.0) for you project.
It may be sufficient and deals flawlessly with 32 bit IR codes.
-If this doesn't fit your case, be assured that 3.x is at least trying to be backwards compatible, so your old examples should still work fine. +If this doesn't fit your case, be assured that 4.x is at least trying to be backwards compatible, so your old examples should still work fine. -### Drawbacks +### Drawbacks of using 2.x - Only the following decoders are available:
` NEC `     ` Denon `     ` Panasonic `     ` JVC `     ` LG `
` RC5 `     ` RC6 `     ` Samsung `     ` Sony ` - The call of `irrecv.decode(&results)` uses the old MSB first decoders like in 2.x and sets the 32 bit codes in `results.value`. -- The old functions `sendNEC()` and `sendJVC()` are renamed to `sendNECMSB()` and `sendJVCMSB()`.
- Use them to send your **old MSB-first 32 bit IR data codes**. -- No decoding by a (constant) 8/16 bit address and an 8 bit command. +- No decoding to a more meaningful (constant) 8/16 bit address and 8 bit command.
@@ -272,7 +312,7 @@ In **all other files** you must use the following, to **prevent `multiple defini #include ``` -**Ensure that all macros in your main program are defined before any** `#include `.
+**Ensure that all macros in your main program are defined before any** `#include `.
The following macros will definitely be overridden with default values otherwise: - `RAW_BUFFER_LENGTH` - `IR_SEND_PIN` @@ -280,14 +320,67 @@ The following macros will definitely be overridden with default values otherwise
+# Tutorials +- A very elaborated introduction to IR remotes and IRremote library from [DroneBot Workshop ](https://dronebotworkshop.com/ir-remotes/). + + +# 3 ways to specify an IR code +There are 3 different ways of specifying a particular IR code. + +## 1. Timing +The timing of each mark/pulse and space/distance_between_pulses is specified in a list or array. +This enables specifying **all IR codes**, but requires a lot of memory and is **not readable at all**. +One formal definition of such a timing array, including **specification of frequency and repeats** is the [**Pronto** format](http://www.harctoolbox.org/Glossary.html#ProntoSemantics).
+Memory can be saved by using a lower time resolution. +For IRremote you can use a 50 µs resolution which halves the memory requirement by using byte values instead of int16 values. +For receiving purposes you can use the **hash of the timing** provided by the `decodeHash()` decoder. + +## 2. Encoding schemes +There are 3 main encoding schemes which encodes a binary bitstream / hex value: +1. `PULSE_DISTANCE`. The distance between pulses determines the bit value. This requires always a stop bit! +Examples are NEC and KASEIKYO protocols. The pulse width is constant for most protocols. +2. `PULSE_WIDTH`. The width of a pulse determines the bit value, pulse distance is constant. This requires no stop bit! +The only known example is the SONY protocol. +3. [Phase / Manchester encoding](https://en.wikipedia.org/wiki/Manchester_code). +The time of the pulse/pause transition (phase) relative to the clock determines the bit value. Examples are RC5 and RC6 protocols. + +Phase encoding has a **constant bit length**, `PULSE_DISTANCE` with constant pulse width and `PULSE_WIDTH` have **no constant bit length**! + +A well known example for `PULSE_DISTANCE` with non constant pulse width encoding is the **RS232 serial encoding**. +Here the non constant pulse width is used to enable a **constant bit length**. + +Most IR signals have a **special header** to help in setting the automatic gain of the receiver circuit. +This header is not part of the encoding, but is often significant for a special protocol and therefore must be reproducible. + +Be aware that there are codes using a `PULSE_DISTANCE` encoding where more than a binary 0/1 is put into a pulse/pause combination. +This requires more than 2 different pulse or pause length combinations. +The [HobToHood protocol](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/ReceiveAndSendHob2Hood/ReceiveAndSendHob2Hood.ino) uses such an encoding. + +Using encoding schemes reduces the specification of an IR code to a bitstream / hex value, which is LSB by default and pulse / pause timings of header, 0, and 1. +The hex value is **quite readable**. +These schemes can not put any semantics like address, command or checksum on this bitstream. + +## 3. Protocols +There are a few common protocols that are implemented directly in IRremote. +They specify the frequency, the timings of header, 0, and 1 as well as other values like checksum, repeat distance, repeat coding, bit toggling etc. +The semantics of the hex value is also specified, allowing the usage of only 2 parameters **address** and **command** to specify an IR code. +This saves memory and is **highly readable**. +Often the address is also constant, which further reduces memory requirements. + + +# IRReceiver pinouts +![IRReceiver Pinout](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/pictures/IRReceiverPinout.jpg) + +[Adafruit IR Sensor tutorial](https://learn.adafruit.com/ir-sensor) + + # Receiving IR codes -Check for **received data** with:
+In your program you check for a **completely received IR frame** with:
`if (IrReceiver.decode()) {}`
-This also decodes the received data. - -## Data format +This also decodes the received data.
After successful decoding, the IR data is contained in the IRData structure, available as `IrReceiver.decodedIRData`. +## decodedIRData structure ```c++ struct IRData { decode_type_t protocol; // UNKNOWN, NEC, SONY, RC5, PULSE_DISTANCE, ... @@ -295,12 +388,25 @@ struct IRData { uint16_t command; // Decoded command uint16_t extra; // Used for Kaseikyo unknown vendor ID. Ticks used for decoding Distance protocol. uint16_t numberOfBits; // Number of bits received for data (address + command + parity) - to determine protocol length if different length are possible. - uint8_t flags; // See IRDATA_FLAGS_* definitions + uint8_t flags; // IRDATA_FLAGS_IS_REPEAT, IRDATA_FLAGS_WAS_OVERFLOW etc. See IRDATA_FLAGS_* definitions IRRawDataType decodedRawData; // Up to 32 (64 bit for 32 bit CPU architectures) bit decoded raw data, used for sendRaw functions. uint32_t decodedRawDataArray[RAW_DATA_ARRAY_SIZE]; // 32 bit decoded raw data, to be used for send function. irparams_struct *rawDataPtr; // Pointer of the raw timing data to be decoded. Mainly the data buffer filled by receiving ISR. }; ``` +#### Flags +This is the [list of flags](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/IRProtocol.h#L88) contained in the flags field.
+Check it with e.g. `if(IrReceiver.decodedIRData.flags & IRDATA_FLAGS_IS_REPEAT)`. + +| Flag name | Description | +|:---|----| +| IRDATA_FLAGS_IS_REPEAT | The gap between the preceding frame is as smaller than the maximum gap expected for a repeat. !!!We do not check for changed command or address, because it is almost not possible to press 2 different buttons on the remote within around 100 ms!!! +| IRDATA_FLAGS_IS_AUTO_REPEAT | The current repeat frame is a repeat, that is always sent after a regular frame and cannot be avoided. Only specified for protocols DENON, and LEGO. | +| IRDATA_FLAGS_PARITY_FAILED | The current (autorepeat) frame violated parity check. | +| IRDATA_FLAGS_TOGGLE_BIT | Is set if RC5 or RC6 toggle bit is set. | +| IRDATA_FLAGS_EXTRA_INFO | There is extra info not contained in address and data (e.g. Kaseikyo unknown vendor ID, or in decodedRawDataArray). | +| IRDATA_FLAGS_WAS_OVERFLOW | Too many marks and spaces for the specified `RAW_BUFFER_LENGTH`. To avoid endless flagging of overflow, irparams.rawlen is set to 0 in this case. | +| IRDATA_FLAGS_IS_MSB_FIRST | This value is mainly determined by the (known) protocol. | #### To access the **RAW data**, use: ```c++ @@ -325,10 +431,111 @@ The raw data depends on the internal state of the Arduino timer in relation to t IrReceiver.printIRSendUsage(&Serial); ``` +## Ambiguous protocols +### NEC, Extended NEC, ONKYO +The **NEC protocol** is defined as 8 bit address and 8 bit command. But the physical address and data fields are each 16 bit wide. +The additional 8 bits are used to send the inverted address or command for parity checking.
+The **extended NEC protocol** uses the additional 8 parity bit of address for a 16 bit address, thus disabling the parity check for address.
+The **ONKYO protocol** in turn uses the additional 8 parity bit of address and command for a 16 bit address and command. + +The decoder reduces the 16 bit values to 8 bit ones if the parity is correct. +If the parity is not correct, it assumes no parity error, but takes the values as 16 bit values without parity assuming extended NEC or extended NEC protocol protocol. + +But now we have a problem when we want to receive e.g. the **16 bit** address 0x00FF or 0x32CD! +The decoder interprets this as a NEC 8 bit address 0x00 / 0x32 with correct parity of 0xFF / 0xCD and reduces it to 0x00 / 0x32. + +One way to handle this, is to force the library to **always** use the ONKYO protocol interpretation by using `#define DECODE_ONKYO`. +Another way is to check if `IrReceiver.decodedIRData.protocol` is NEC and not ONKYO and to revert the parity reducing manually. + +### NEC, NEC2 +On a long press, the **NEC protocol** does not repeat its frame, it sends a special short repeat frame. +This enables an easy distinction between long presses and repeated presses and saves a bit of battery energy. +This behavior is quite unique for NEC and its derived protocols like LG and Samsung. + +But of course there are also remote control systems, that uses the NEC protocol but only repeat the first frame when a long press is made instead of sending the special short repeat frame. We named this the **NEC2** protocol and it is sent with `sendNEC2()`.
+But be careful, the NEC2 protocol can only be detected by the NEC library decoder **after** the first frame and if you do a long press! + +### Samsung, SamsungLG +On a long press, the **SamsungLG protocol** does not repeat its frame, it sends a special short repeat frame. + +## RAM usage of different protocols +The `RAW_BUFFER_LENGTH` determines the length of the **byte buffer** where the received IR timing data is stored before decoding.
+**100** is sufficient for standard protocols **up to 48 bits**, with 1 bit consisting of one mark and space. +We always require additional 4 bytes, 1 byte for initial gap, 2 bytes for header and 1 byte for stop bit. +- **48** bit protocols are PANASONIC, KASEIKYO, SAMSUNG48, RC6. +- **32** bit protocols like NEC, SAMSUNG, WHYNTER, SONY(20), LG(28) require a **buffer length of 68**. +- **16** bit protocols like BOSEWAVE, DENON, FAST, JVC, LEGO_PF, RC5, SONY(12 or 15) require a **buffer length of 36**. +- MAGIQUEST requires a buffer length of **112**. +- Air conditioners often send a longer protocol data stream **up to 750 bits**. + +If the record gap determined by `RECORD_GAP_MICROS` is changed from the default 8 ms to more than 20 ms, the buffer is no longer a byte but a uint16_t buffer, requiring twice as much RAM. +
+ +## Handling unknown Protocols +### Disclaimer +**This library was designed to fit inside MCUs with relatively low levels of resources and was intended to work as a library together with other applications which also require some resources of the MCU to operate.** + +Use the **ReceiveDemo example** to print out all informations about your IR protocol.
+The **ReceiveDump example** gives you more information but has bad repeat detection due to the time required for printing the information. + +### Other libraries, which may cover these protocols +#### IRMP +If your protocol seems not to be supported by this library, you may try the [IRMP library](https://github.com/IRMP-org/IRMP), which especially supports manchester protocols much better. + +#### IRremoteESP8266 +For **air conditioners** , you may try the [IRremoteESP8266 library](https://github.com/crankyoldgit/IRremoteESP8266), which supports an impressive set of protocols and a lot of air conditioners and works also on ESP32. + +#### rawirdecode and HeatpumpIR +[Raw-IR-decoder-for-Arduino](https://github.com/ToniA/Raw-IR-decoder-for-Arduino) is not a library, but an arduino example sketch, which provides many methods of decoding especially **air conditioner** protocols. Sending of these protocols can be done by the Arduino library [HeatpumpIR](https://github.com/ToniA/arduino-heatpumpir). + + +### Protocol=PULSE_DISTANCE +If you get something like this: +``` +PULSE_DISTANCE: HeaderMarkMicros=8900 HeaderSpaceMicros=4450 MarkMicros=550 OneSpaceMicros=1700 ZeroSpaceMicros=600 NumberOfBits=56 0x43D8613C 0x3BC3BC +``` +then you have a code consisting of **56 bits**, which is probably from an air conditioner remote.
+You can send it with `sendPulseDistanceWidth()`. +```c++ +uint32_t tRawData[] = { 0xB02002, 0xA010 }; +IrSender.sendPulseDistance(38, 3450, 1700, 450, 1250, 450, 400, &tRawData[0], 48, false, 0, 0); +``` +You can send it with calling `sendPulseDistanceWidthData()` twice, once for the first 32 bit and next for the remaining 24 bits.
+The `PULSE_DISTANCE` / `PULSE_WIDTH` decoder just decodes a timing stream to a bitstream stored as hex values. +These decoders can not put any semantics like address, command or checksum on this bitstream. +But the bitstream is way more readable, than a timing stream. This bitstream is read **LSB first by default**. +If LSB does not suit for further research, you can change it [here](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/ir_DistanceProtocol.hpp#L78). + +**If RAM is not more than 2k, the decoder only accepts mark or space durations up to 2500 microseconds to save RAM space, otherwise it accepts durations up to 10 ms.** + +### Protocol=UNKNOWN +If you see something like `Protocol=UNKNOWN Hash=0x13BD886C 35 bits received` as output of e.g. the ReceiveDemo example, you either have a problem with decoding a protocol, or an unsupported protocol. + +- If you have an **odd number of bits** received, your receiver circuit probably has problems. Maybe because the IR signal is too weak. +- If you see timings like `+ 600,- 600 + 550,- 150 + 200,- 100 + 750,- 550` then one 450 µs space was split into two 150 and 100 µs spaces with a spike / error signal of 200 µs between. Maybe because of a defective receiver or a weak signal in conjunction with another light emitting source nearby. +- If you see timings like `+ 500,- 550 + 450,- 550 + 450,- 500 + 500,-1550`, then marks are generally shorter than spaces and therefore `MARK_EXCESS_MICROS` (specified in your ino file) should be **negative** to compensate for this at decoding. +- If you see `Protocol=UNKNOWN Hash=0x0 1 bits received` it may be that the space after the initial mark is longer than [`RECORD_GAP_MICROS`](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/IRremote.h#L124). + This was observed for some LG air conditioner protocols. Try again with a line e.g. `#define RECORD_GAP_MICROS 12000` before the line `#include ` in your .ino file. +- To see more info supporting you to find the reason for your UNKNOWN protocol, you must enable the line `//#define DEBUG` in IRremoteInt.h. + +### How to deal with protocols not supported by IRremote +If you do not know which protocol your IR transmitter uses, you have several choices. +- Just use the hash value to decide which command was received. See the [SimpleReceiverForHashCodes example](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/SimpleReceiverForHashCodes/SimpleReceiverForHashCodes.ino). +- Use the [IRreceiveDemo example](examples/ReceiveDemo) or [IRreceiveDump example](examples/ReceiveDump) to dump out the IR timing. + You can then reproduce/send this timing with the [SendRawDemo example](examples/SendRawDemo). +- The [IRMP AllProtocol example](https://github.com/IRMP-org/IRMP#allprotocol-example) prints the protocol and data for one of the **[40 supported protocols](https://github.com/IRMP-org/IRMP?tab=readme-ov-file#list-of-protocols)**. + The same library can be used to send this codes. +- If you have a bigger Arduino board at hand (> 100 kByte program memory) you can try the + [IRremoteDecode example](https://github.com/bengtmartensson/Arduino-DecodeIR/blob/master/examples/IRremoteDecode/IRremoteDecode.ino) of the Arduino library [DecodeIR](https://github.com/bengtmartensson/Arduino-DecodeIR). +- Use [IrScrutinizer](http://www.harctoolbox.org/IrScrutinizer.html). + It can automatically generate a send sketch for your protocol by exporting as "Arduino Raw". It supports IRremote, + the old [IRLib](https://github.com/cyborg5/IRLib) and [Infrared4Arduino](https://github.com/bengtmartensson/Infrared4Arduino). +
# Sending IR codes -If you have a device at hand which can generate the IR codes you want to work with (aka IR remote), **it is recommended** to receive the codes with the [ReceiveDemo example](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/ReceiveDemo/ReceiveDemo.ino), which will tell you on the serial output how to send them. +If you have a device at hand which can generate the IR codes you want to work with (aka IR remote), +**it is recommended** to receive the codes with the [ReceiveDemo example](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/ReceiveDemo/ReceiveDemo.ino), which will tell you on the serial output how to send them. ``` Protocol=LG Address=0x2 Command=0x3434 Raw-Data=0x23434E 28 bits MSB first @@ -337,49 +544,76 @@ Send with: IrSender.sendLG(0x2, 0x3434, ); You will discover that **the address is a constant** and the commands sometimes are sensibly grouped.
If you are uncertain about the numbers of repeats to use for sending, **3** is a good starting point. If this works, you can check lower values afterwards. -The codes found in the [irdb database](https://github.com/probonopd/irdb/tree/master/codes) specify a **device**, a **subdevice** and a **function**. Most of the times, *device* and *subdevice* can be taken as upper and lower byte of the **address parameter** and *function* is the **command parameter** for the **new structured functions** with address, command and repeat-count parameters like e.g. `IrSender.sendNEC((device << 8) | subdevice, 0x19, 2)`.
-An **exact mapping** can be found in the [IRP definition files for IR protocols](https://github.com/probonopd/MakeHex/tree/master/protocols). "D" and "S" denotes device and subdevice and "F" denotes the function. +If you have enabled `DECODE_DISTANCE_WIDTH`, the code printed by `printIRSendUsage()` **differs between 8 and 32 bit platforms**, so it is best to run the receiving program on the same platform as the sending program. **All sending functions support the sending of repeats** if sensible. Repeat frames are sent at a fixed period determined by the protocol. e.g. 110 ms from start to start for NEC.
Keep in mind, that **there is no delay after the last sent mark**. If you handle the sending of repeat frames by your own, you must insert sensible delays before the repeat frames to enable correct decoding. -The old send*Raw() functions for sending like e.g. `IrSender.sendNECRaw(0xE61957A8,2)` are kept for backward compatibility to **(old)** tutorials and unsupported as well as error prone. +Sending old MSB codes without conversion can be done by using `sendNECMSB()`, `sendSonyMSB()`, `sendSamsungMSB()`, `sendJVCMSB()`. + +## Sending IRDB IR codes +The codes found in the [Flipper-IRDB database](https://github.com/Lucaslhm/Flipper-IRDB) are quite straightforward to convert, because the also use the address / command scheme.
+Protocol matching is NECext -> NECext (or Onkyo), Samsung32 -> Samsung, SIRC20 -> Sony with 20 bits etc. + +The codes found in the [irdb database](https://github.com/probonopd/irdb/tree/master/codes) specify a **device**, a **subdevice** and a **function**. +Most of the times, *device* and *subdevice* can be taken as upper and lower byte of the **address parameter** and *function* is the **command parameter** for the **new structured functions** with address, command and repeat-count parameters like e.g. `IrSender.sendNEC((device << 8) | subdevice, 0x19, 2)`.
+An **exact mapping** can be found in the [IRP definition files for IR protocols](https://github.com/probonopd/MakeHex/tree/master/protocols). "D" and "S" denotes device and subdevice and "F" denotes the function. ## Send pin -Any pin can be choosen as send pin, because the PWM signal is generated by default with software bit banging, since `SEND_PWM_BY_TIMER` is not active. -If `IR_SEND_PIN` is specified (as constant), it reduces program size and improves send timing for AVR. If you want to use a variable to specify send pin e.g. with `setSendPin(uint8_t aSendPinNumber)`, you must disable this macro. Then you can change send pin at any time before sending an IR frame. See also [Compile options / macros for this library](https://github.com/Arduino-IRremote/Arduino-IRremote#compile-options--macros-for-this-library). +Any pin can be chosen as send pin as long as `IR_SEND_PIN` is **not** defined. +This is because the PWM signal is generated by default with software bit banging, since `SEND_PWM_BY_TIMER` is not active.
+On **ESP32** ledc channel 0 is used for generating the IR PWM.
+If `IR_SEND_PIN` is specified (as C macro), it reduces program size and improves send timing for AVR. If you want to use a variable to specify send pin e.g. with `setSendPin(uint8_t aSendPinNumber)`, you must disable this `IR_SEND_PIN` macro e.g. with `#undef IR_SEND_PIN`. +Then you can change send pin at any time before sending an IR frame. See also [Compile options / macros for this library](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#compile-options--macros-for-this-library). ### List of public IR code databases http://www.harctoolbox.org/IR-resources.html +## Flipper Zero +[Flipper IRDB Database](https://github.com/Lucaslhm/Flipper-IRDB) + +| [Flipper decoding](https://github.com/flipperdevices/flipperzero-firmware/tree/release/lib/infrared/encoder_decoder) | [IRremote decoding](https://github.com/Arduino-IRremote/Arduino-IRremote/tree/master/src) | +|-|-| +| Samsung32 | Samsung | +| NEC | NEC | +| NECext | ONKYO | +| [\\\\\\\\\](https://github.com/flipperdevices/flipperzero-firmware/blob/027ea9ea36da137144548295c016d99255af53c3/lib/infrared/encoder_decoder/kaseikyo/infrared_decoder_kaseikyo.c#L26)
and ID is MSB of address.
address: 8A 02 20 00
command: 56 03 00 00
-> **IRremote:**
Address 0x6A8, sendPanasonic (for 02 20) and Command 0x35 | \\\\\\\ | +
# Tiny NEC receiver and sender -For applications only requiring NEC protocol, there is a special receiver / sender included,
+For applications only requiring NEC, NEC variants or FAST -see below- protocol, there is a special receiver / sender included, which has very **small code size of 500 bytes and does NOT require any timer**. -Check out the [TinyReceiver](https://github.com/Arduino-IRremote/Arduino-IRremote#tinyreceiver--tinysender) and [IRDispatcherDemo](https://github.com/Arduino-IRremote/Arduino-IRremote#irdispatcherdemo) examples.
+## Principle of operation +Instead of sampling the input every 50 µs as IRremote does, TinyReceiver receiver uses a **pin change interrupt** for on-the-fly decoding which limits the choice of protocols.
+On each level change, the level and the time since the last change are used to incrementally decode the protocol.
+With this operating principle, we **cannot wait for a timeout** and then decode the protocol as IRremote does.
+Instead, we need to know which is the last bit (level change) of a protocol to do the final decoding +and the call of the optional **user provided callback function** `handleReceivedTinyIRData()`.
+This means, **we need to know the number of bits in a protocol** and therefore the protocol (family). + +Check out the [TinyReceiver](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#tinyreceiver--tinysender) and [IRDispatcherDemo](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#irdispatcherdemo) examples.
Take care to include `TinyIRReceiver.hpp` or `TinyIRSender.hpp` instead of `IRremote.hpp`. ### TinyIRReceiver usage ```c++ +//#define USE_ONKYO_PROTOCOL // Like NEC, but take the 16 bit address and command each as one 16 bit value and not as 8 bit normal and 8 bit inverted value. +//#define USE_FAST_PROTOCOL // Use FAST protocol instead of NEC / ONKYO #include "TinyIRReceiver.hpp" void setup() { initPCIInterruptForTinyReceiver(); // Enables the interrupt generation on change of IR input signal } -void loop() {} - -/* - * This is the function is called if a complete command was received - * It runs in an ISR context with interrupts enabled, so functions like delay() etc. should work here - */ -void handleReceivedTinyIRData(uint8_t aAddress, uint8_t aCommand, uint8_t aFlags) { - printTinyReceiverResultMinimal(&Serial, aAddress, aCommand, aFlags); +void loop() { + if (TinyReceiverDecode()) { + printTinyReceiverResultMinimal(&Serial); + } + // No resume() required :-) } ``` @@ -388,12 +622,14 @@ void handleReceivedTinyIRData(uint8_t aAddress, uint8_t aCommand, uint8_t aFlags #include "TinyIRSender.hpp" void setup() { - sendNECMinimal(3, 0, 11, 2); // Send address 0 and command 11 on pin 3 with 2 repeats. + sendNEC(3, 0, 11, 2); // Send address 0 and command 11 on pin 3 with 2 repeats. } void loop() {} ``` +Another tiny receiver and sender **supporting more protocols** can be found [here](https://github.com/LuisMiCa/IRsmallDecoder). + # The FAST protocol The FAST protocol is a proprietary modified JVC protocol **without address, with parity and with a shorter header**. It is meant to have a quick response to the event which sent the protocol frame on another board. @@ -431,7 +667,22 @@ void loop() {} ```
+The FAST protocol can be received by IRremote and TinyIRReceiver. + # FAQ and hints +## Receiving stops after analogWrite() or tone() or after running a motor. +The receiver sample interval of 50 µs is generated by a timer. On many boards this must be a [hardware timer](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#timer-and-pin-usage). +On some boards where a software timer is available, the software timer is used.
+Be aware that the hardware timer used for receiving should not be used for `analogWrite()`.
+Especially **motor** control often uses the `analogWrite()` function and will therefore stop the receiving if used on the pins indicated [here](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#timer-and-pin-usage).
+On the Uno and other AVR boards the receiver timer ist the same as the tone timer. Thus receiving will stop after a `tone()` command. +See [ReceiveDemo example](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/ReceiveDemo/ReceiveDemo.ino#L284-L298) how to deal with it, i.e. how to use `IrReceiver.restartTimer()`. + +## Receiving sets overflow flag. +The flag `IRDATA_FLAGS_WAS_OVERFLOW` is set, if `RAW_BUFFER_LENGTH` is too small for all the marks and spaces of the protocol. +This can happen on long protocol frames like the ones from air conditioner. +It also can happen, if `RECORD_GAP_MICROS` is smaller than the real gap between a frame and thr repetition frame, thus interpreting both as one consecutive frame. +Best is to dump the timing then, to see which reason holds. ## Problems with Neopixels, FastLed etc. IRremote will not work right when you use **Neopixels** (aka WS2811/WS2812/WS2812B) or other libraries blocking interrupts for a longer time (> 50 µs).
@@ -445,12 +696,16 @@ There are some other solutions to this on more powerful processors, ## Does not work/compile with another library **Another library is only working/compiling** if you deactivate the line `IrReceiver.begin(IR_RECEIVE_PIN, ENABLE_LED_FEEDBACK);`.
-This is often due to **timer resource conflicts** with the other library. Please see [below](https://github.com/Arduino-IRremote/Arduino-IRremote#timer-and-pin-usage). +This is often due to **timer resource conflicts** with the other library. Please see [below](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#timer-and-pin-usage). -## Multiple IR receivers -You can use **multiple IR receiver** by just connecting the output pins of several IR receivers together. -The IR receivers use an NPN transistor as output device with just a 30k resistor to VCC. -This is almost "open collector" and allows connecting of several output pins to one Arduino input pin. +## Multiple IR receiver and sender instances +**This library supports only one IR receiver and one IR sender object (IRrecv and IRsend) per CPU.**
+However since sending is a serial task, you can use `setSendPin()` to switch the pin to send, thus emulating multiple sender.
+The receiver uses a special **timer** triggered function, which reads the digital IR signal value from one pin every 50 µs.
+So **multiple IR receivers** can only be used by connecting the output pins of several IR receivers together. +The IR receiver modules internally use an NPN transistor as output device with just a 30k resistor to VCC. +This is basically an "open collector" and allows multiple output pins to be connected to one Arduino input pin.
+However, keep in mind that any weak / disturbed signal from one of the receivers will also interfere with a good signal from another receiver. ## Increase strength of sent output signal **The best way to increase the IR power for free** is to use 2 or 3 IR diodes in series. One diode requires 1.2 volt at 20 mA or 1.5 volt at 100 mA so you can supply up to 3 diodes with a 5 volt output.
@@ -463,80 +718,38 @@ On my Arduino Nanos, I always use a 100 Ω series resistor and one IR LED :gr ## Minimal CPU clock frequency For receiving, the **minimal CPU clock frequency is 4 MHz**, since the 50 µs timer ISR (Interrupt Service Routine) takes around 12 µs on a 16 MHz ATmega.
-The TinyReceiver, which reqires no polling, runs with 1 MHz.
+The TinyReceiver, which requires no polling, runs with 1 MHz.
For sending, the **default software generated PWM has problems on AVR running with 8 MHz**. The PWM frequency is around 30 instead of 38 kHz and RC6 is not reliable. You can switch to timer PWM generation by `#define SEND_PWM_BY_TIMER`. ## Bang & Olufsen protocol The Bang & Olufsen protocol decoder is not enabled by default, i.e if no protocol is enabled explicitly by #define `DECODE_`. It must always be enabled explicitly by `#define DECODE_BEO`. This is because it has an **IR transmit frequency of 455 kHz** and therefore requires a different receiver hardware (TSOP7000).
-And because **generating a 455 kHz PWM signal is currently not implemented**, sending only works if `USE_NO_SEND_PWM` is defined!
-For more info, see [ir_BangOlufsen.hpp](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/ir_BangOlufsen.hpp#L42). - -# Handling unknown Protocols -## Disclaimer -**This library was designed to fit inside MCUs with relatively low levels of resources and was intended to work as a library together with other applications which also require some resources of the MCU to operate.** - -For **air conditioners** [see this fork](https://github.com/crankyoldgit/IRremoteESP8266), which supports an impressive set of protocols and a lot of air conditioners. - -For **long signals** see the blog entry: ["Recording long Infrared Remote control signals with Arduino"](https://www.analysir.com/blog/2014/03/19/air-conditioners-problems-recording-long-infrared-remote-control-signals-arduino). - - -## Protocol=PULSE_DISTANCE -If you get something like this: -``` -PULSE_DISTANCE: HeaderMarkMicros=8900 HeaderSpaceMicros=4450 MarkMicros=550 OneSpaceMicros=1700 ZeroSpaceMicros=600 NumberOfBits=56 0x43D8613C 0x3BC3BC -``` -then you have a code consisting of **56 bits**, which is probably from an air conditioner remote.
-You can send it with sendPulseDistance(). -```c++ -uint32_t tRawData[] = { 0xB02002, 0xA010 }; -IrSender.sendPulseDistance(38, 3450, 1700, 450, 1250, 450, 400, &tRawData[0], 48, false, 0, 0); -``` -You can send it with calling sendPulseDistanceWidthData() twice, once for the first 32 bit and next for the remaining 24 bits.
-**The PulseDistance or PulseWidth decoders just decode a timing steam to a bit stream**. -They can not put any semantics like address, command or checksum on this bitstream, since it is no known protocol. -But the bitstream is way more readable, than a timing stream. This bitstream is read **LSB first by default**. -If this does not suit you for further research, you can change it [here](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/ir_DistanceProtocol.hpp#L48). - -## Protocol=UNKNOWN -If you see something like `Protocol=UNKNOWN Hash=0x13BD886C 35 bits received` as output of e.g. the ReceiveDemo example, you either have a problem with decoding a protocol, or an unsupported protocol. - -- If you have an **odd number of bits** received, your receiver circuit probably has problems. Maybe because the IR signal is too weak. -- If you see timings like `+ 600,- 600 + 550,- 150 + 200,- 100 + 750,- 550` then one 450 µs space was split into two 150 and 100 µs spaces with a spike / error signal of 200 µs between. Maybe because of a defective receiver or a weak signal in conjunction with another light emitting source nearby. -- If you see timings like `+ 500,- 550 + 450,- 550 + 500,- 500 + 500,-1550`, then marks are generally shorter than spaces and therefore `MARK_EXCESS_MICROS` (specified in your ino file) should be **negative** to compensate for this at decoding. -- If you see `Protocol=UNKNOWN Hash=0x0 1 bits received` it may be that the space after the initial mark is longer than [`RECORD_GAP_MICROS`](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/IRremote.h#L124). - This was observed for some LG air conditioner protocols. Try again with a line e.g. `#define RECORD_GAP_MICROS 12000` before the line `#include ` in your .ino file. -- To see more info supporting you to find the reason for your UNKNOWN protocol, you must enable the line `//#define DEBUG` in IRremoteInt.h. - -## How to deal with protocols not supported by IRremote -If you do not know which protocol your IR transmitter uses, you have several choices. -- Use the [IRreceiveDump example](examples/ReceiveDump) to dump out the IR timing. - You can then reproduce/send this timing with the [SendRawDemo example](examples/SendRawDemo). - For **long codes** with more than 48 bits like from air conditioners, you can **change the length of the input buffer** in [IRremote.h](src/IRremoteInt.h#L36). -- The [IRMP AllProtocol example](https://github.com/IRMP-org/IRMP#allprotocol-example) prints the protocol and data for one of the **40 supported protocols**. - The same library can be used to send this codes. -- If you have a bigger Arduino board at hand (> 100 kByte program memory) you can try the - [IRremoteDecode example](https://github.com/bengtmartensson/Arduino-DecodeIR/blob/master/examples/IRremoteDecode/IRremoteDecode.ino) of the Arduino library [DecodeIR](https://github.com/bengtmartensson/Arduino-DecodeIR). -- Use [IrScrutinizer](http://www.harctoolbox.org/IrScrutinizer.html). - It can automatically generate a send sketch for your protocol by exporting as "Arduino Raw". It supports IRremote, - the old [IRLib](https://github.com/cyborg5/IRLib) and [Infrared4Arduino](https://github.com/bengtmartensson/Infrared4Arduino). - -
+And because **generating a 455 kHz PWM signal is currently only implemented for `SEND_PWM_BY_TIMER`**, sending only works if `SEND_PWM_BY_TIMER` or `USE_NO_SEND_PWM` is defined.
+For more info, see [ir_BangOlufsen.hpp](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/ir_BangOlufsen.hpp#L44). # Examples for this library -In order to fit the examples to the 8K flash of ATtiny85 and ATtiny88, the [Arduino library ATtinySerialOut](https://github.com/ArminJo/ATtinySerialOut) is required for this CPU's. +The examples are available at File > Examples > Examples from Custom Libraries / IRremote.
+ In order to fit the examples to the 8K flash of ATtiny85 and ATtiny88, the [Arduino library ATtinySerialOut](https://github.com/ArminJo/ATtinySerialOut) is required for this CPU's.
+See also [DroneBot Workshop SimpleReceiver](https://dronebotworkshop.com/ir-remotes/#SimpleReceiver_Example_Code) and [SimpleSender](https://dronebotworkshop.com/ir-remotes/#SimpleSender_Example_Code). #### SimpleReceiver + SimpleSender -This examples are a good starting point. +The **[SimpleReceiver](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/SimpleReceiver/SimpleReceiver.ino)** and **[SimpleSender](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/SimpleSender/SimpleSender.ino)** examples are a good starting point. A simple example can be tested online with [WOKWI](https://wokwi.com/projects/338611596994544210). +#### SimpleReceiverForHashCodes +The **[SimpleReceiverForHashCodes](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/SimpleReceiver/SimpleReceiver.ino)** uses only the hash decoder. +It converts all IR frames longer than 6 to a 32 bit hash code, thus enabling receiving of unknown protocols.
+See: http://www.righto.com/2010/01/using-arbitrary-remotes-with-arduino.html + #### TinyReceiver + TinySender If **code size** or **timer usage** matters, look at these examples.
-The **[TinyReceiver](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/TinyReceiver/TinyReceiver.ino)** example uses the **TinyIRReceiver** library which can **only receive NEC, ONKYO and FAST protocols, but does not require any timer**. They use pin change interrupt for on the fly decoding, which is the reason for the restricted protocol choice.
+The **[TinyReceiver](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/TinyReceiver/TinyReceiver.ino)** example uses the **TinyIRReceiver** library +which can **only receive NEC, Extended NEC, ONKYO and FAST protocols, but does not require any timer**. +They use pin change interrupt for on the fly decoding, which is the reason for the restricted protocol choice.
TinyReceiver can be tested online with [WOKWI](https://wokwi.com/arduino/projects/339264565653013075). The **[TinySender](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/TinySender/TinySender.ino)** example uses the **TinyIRSender** library which can **only send NEC, ONKYO and FAST protocols**.
-It sends NEC protocol codes in standard format with 8 bit address and 8 bit command as in SimpleSender example. +It sends NEC protocol codes in standard format with 8 bit address and 8 bit command as in SimpleSender example. It has options to send using Extended NEC, ONKYO and FAST protocols. Saves 780 bytes program memory and 26 bytes RAM compared to SimpleSender, which does the same, but uses the IRRemote library (and is therefore much more flexible). #### SmallReceiver @@ -544,6 +757,7 @@ If the protocol is not NEC and code size matters, look at this [example](https:/ #### ReceiveDemo + AllProtocolsOnLCD [ReceiveDemo](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/ReceiveDemo/ReceiveDemo.ino) receives all protocols and **generates a beep with the Arduino tone() function** on each packet received.
+Long press of one IR button (receiving of multiple repeats for one command) is detected.
[AllProtocolsOnLCD](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/AllProtocolsOnLCD/AllProtocolsOnLCD.ino) additionally **displays the short result on a 1602 LCD**. The LCD can be connected parallel or serial (I2C).
By connecting debug pin to ground, you can force printing of the raw values for each frame. The pin number of the debug pin is printed during setup, because it depends on board and LCD connection type.
This example also serves as an **example how to use IRremote and tone() together**. @@ -554,14 +768,18 @@ Receives all protocols and dumps the received signal in different flavors includ #### SendDemo Sends all available protocols at least once. +#### MultipleSendPins +Demonstrates sending IR codes toggling between 2 **different send pins**. + #### SendAndReceive Demonstrates **receiving while sending**. #### ReceiveAndSend -Record and **play back last received IR signal** at button press. IR frames of known protocols are sent by the approriate protocol encoder. `UNKNOWN` protocol frames are stored as raw data and sent with `sendRaw()`. +Record and **play back last received IR signal** at button press. IR frames of known protocols are sent by the appropriate protocol encoder. `UNKNOWN` protocol frames are stored as raw data and sent with `sendRaw()`. #### ReceiveAndSendDistanceWidth Try to decode each IR frame with the *universal* **DistanceWidth decoder**, store the data and send it on button press with `sendPulseDistanceWidthFromArray()`.
+If RAM is not more than 2k, the decoder only accepts mark or space durations up to 2500 microseconds to save RAM space, otherwise it accepts durations up to 10 ms.
Storing data for distance width protocol requires 17 bytes. The ReceiveAndSend example requires 16 bytes for known protocol data and 37 bytes for raw data of e.g.NEC protocol. @@ -586,6 +804,9 @@ The file *acLG.h* contains the command documentation of the LG air conditioner I IReceiverTimingAnalysis can be tested online with [WOKWI](https://wokwi.com/projects/299033930562011656) Click on the receiver while simulation is running to specify individual IR codes. +#### ReceiveAndSendHob2Hood +[Example](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/SendLGAirConditionerDemo/ReceiveAndSendHobToHood.ino) for receiving and sending AEG / Elektrolux Hob2Hood protocol.
+ #### ReceiverTimingAnalysis This [example](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/ReceiverTimingAnalysis/ReceiverTimingAnalysis.ino) analyzes the signal delivered by your IR receiver module. Values can be used to determine the stability of the received signal as well as a hint for determining the protocol.
@@ -595,6 +816,8 @@ Click on the receiver while simulation is running to specify individual NEC IR c #### UnitTest ReceiveDemo + SendDemo in one program. Demonstrates **receiving while sending**. +Here you see the delay of the receiver output (blue) from the IR diode input (yellow). +![Delay](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/pictures/IR_UnitTest_delay.bmp) # WOKWI online examples - [Simple receiver](https://wokwi.com/projects/338611596994544210) @@ -603,12 +826,20 @@ ReceiveDemo + SendDemo in one program. Demonstrates **receiving while sending**. - [ReceiverTimingAnalysis](https://wokwi.com/projects/299033930562011656) - [Receiver with LCD output and switch statement](https://wokwi.com/projects/298934082074575369) +# IR control of a robot car +This [example](https://github.com/ArminJo/PWMMotorControl?tab=readme-ov-file#basicircontrol) of the **Arduino PWMMotorControl library** controls the basic functions of a robot car using the IRremote library.
+It controls 2 PWM motor channels, 2 motors at each channel.
+[Here](https://www.instructables.com/Arduino-4WD-Car-Assembly-and-Code-With-Optional-In/) you can find the instructable for car assembly and code.
+ +IR_RobotCar with TL1838 IR receiver plugged into expansion board.
+![IR_RobotCar](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/pictures/IR_RobotCar.jpg) +
# Issues and discussions - Do not open an issue without first testing some of the examples! - If you have a problem, please post the MCVE (Minimal Complete Verifiable Example) showing this problem. My experience is, that most of the times you will find the problem while creating this MCVE :smile:. -- [Use code blocks](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code); **it helps us help you when we can read your code!** +- [Use code blocks](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code); **it helps us to help you when we can read your code!**
@@ -618,42 +849,52 @@ These macros must be defined in your program **before** the line `#include ` | all | Selection of individual protocol(s) to be decoded. You can specify multiple protocols. See [here](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/IRremote.hpp#L98-L121) | -| `DECODE_STRICT_CHECKS` | disabled | Check for additional characteristics of protocol timing like length of mark for a constant mark protocol, where space length determines the bit value. Requires up to 194 additional bytes of program memory. | +|-|-:|-| +| `RAW_BUFFER_LENGTH` | 200 | Buffer size of raw input uint16_t buffer. Must be even! If it is too small, overflow flag will be set. 100 is sufficient for *regular* protocols of up to 48 bits, but for most air conditioner protocols a value of up to 750 is required. Use the ReceiveDump example to find smallest value for your requirements. A value of 200 requires 200 bytes RAM. | +| `EXCLUDE_UNIVERSAL_PROTOCOLS` | disabled | Excludes the universal decoder for pulse distance width protocols and decodeHash (special decoder for all protocols) from `decode()`. Saves up to 1000 bytes program memory. | +| `EXCLUDE_EXOTIC_PROTOCOLS` | disabled | Excludes BANG_OLUFSEN, BOSEWAVE, WHYNTER, FAST and LEGO_PF from `decode()` and from sending with `IrSender.write()`. Saves up to 650 bytes program memory. | +| `DECODE_` | all | Selection of individual protocol(s) to be decoded. You can specify multiple protocols. See [here](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/IRremote.hpp#L98-L121) | +| `DECODE_STRICT_CHECKS` | disabled | Check for additional required characteristics of protocol timing like length of mark for a constant mark protocol, where space length determines the bit value. Requires up to 194 additional bytes of program memory. | | `IR_REMOTE_DISABLE_RECEIVE_COMPLETE_CALLBACK` | disabled | Saves up to 60 bytes of program memory and 2 bytes RAM. | -| `MARK_EXCESS_MICROS` | 20 | MARK_EXCESS_MICROS is subtracted from all marks and added to all spaces before decoding, to compensate for the signal forming of different IR receiver modules. | -| `RECORD_GAP_MICROS` | 5000 | Minimum gap between IR transmissions, to detect the end of a protocol.
Must be greater than any space of a protocol e.g. the NEC header space of 4500 µs.
Must be smaller than any gap between a command and a repeat; e.g. the retransmission gap for Sony is around 24 ms.
Keep in mind, that this is the delay between the end of the received command and the start of decoding. | -| `IR_INPUT_IS_ACTIVE_HIGH` | disabled | Enable it if you use a RF receiver, which has an active HIGH output signal. | -| `IR_SEND_PIN` | disabled | If specified (as constant), it reduces program size and improves send timing for AVR. If you want to use a variable to specify send pin e.g. with `setSendPin(uint8_t aSendPinNumber)`, you must not use / disable this macro in your source. | -| `SEND_PWM_BY_TIMER` | disabled | Disables carrier PWM generation in software and use hardware PWM (by timer). Has the advantage of more exact PWM generation, especially the duty cycle (which is not very relevant for most IR receiver circuits), and the disadvantage of using a hardware timer, which in turn is not available for other libraries and to fix the send pin (but not the receive pin) at the [dedicated timer output pin(s)](https://github.com/Arduino-IRremote/Arduino-IRremote#timer-and-pin-usage). Is enabled for ESP32 and RP2040 in all examples, since they support PWM gereration for each pin without using a shared resource (timer). | -| `USE_NO_SEND_PWM` | disabled | Uses no carrier PWM, just simulate an **active low** receiver signal. Overrides `SEND_PWM_BY_TIMER` definition. | -| `IR_SEND_DUTY_CYCLE_PERCENT` | 30 | Duty cycle of IR send signal. | -| `USE_OPEN_DRAIN_OUTPUT_FOR_SEND_PIN` | disabled | Uses or simulates open drain output mode at send pin. **Attention, active state of open drain is LOW**, so connect the send LED between positive supply and send pin! | -| `DISABLE_CODE_FOR_RECEIVER` | disabled | Saves up to 450 bytes program memory and 269 bytes RAM if receiving functionality is not required. | -| `EXCLUDE_EXOTIC_PROTOCOLS` | disabled | Excludes BANG_OLUFSEN, BOSEWAVE, WHYNTER, FAST and LEGO_PF from `decode()` and from sending with `IrSender.write()`. Saves up to 650 bytes program memory. | -| `FEEDBACK_LED_IS_ACTIVE_LOW` | disabled | Required on some boards (like my BluePill and my ESP8266 board), where the feedback LED is active low. | -| `NO_LED_FEEDBACK_CODE` | disabled | Disables the LED feedback code for send and receive. Saves around 100 bytes program memory for receiving, around 500 bytes for sending and halving the receiver ISR (Interrupt Service Routine) processing time. | -| `MICROS_PER_TICK` | 50 | Resolution of the raw input buffer data. Corresponds to 2 pulses of each 26.3 µs at 38 kHz. | -| `TOLERANCE_FOR_DECODERS_MARK_OR_SPACE_MATCHING` | 25 | Relative tolerance (in percent) for matchTicks(), matchMark() and matchSpace() functions used for protocol decoding. | +| `MARK_EXCESS_MICROS` | 20 | MARK_EXCESS_MICROS is subtracted from all marks and added to all spaces before decoding, to compensate for the signal forming of different IR receiver modules. | +| `RECORD_GAP_MICROS` | 5000 | Minimum gap between IR transmissions, to detect the end of a protocol.
Must be greater than any space of a protocol e.g. the NEC header space of 4500 µs.
Must be smaller than any gap between a command and a repeat; e.g. the retransmission gap for Sony is around 24 ms.
Keep in mind, that this is the delay between the end of the received command and the start of decoding. | +| `DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE` | 50 if RAM <= 2k, else 200 | A value of 200 allows to decode mark or space durations up to 10 ms. | +| `IR_INPUT_IS_ACTIVE_HIGH` | disabled | Enable it if you use a RF receiver, which has an active HIGH output signal. | +| `IR_SEND_PIN` | disabled | If specified, it reduces program size and improves send timing for AVR. If you want to use a variable to specify send pin e.g. with `setSendPin(uint8_t aSendPinNumber)`, you must not use / disable this macro in your source. | +| `SEND_PWM_BY_TIMER` | disabled | Disables carrier PWM generation in software and use hardware PWM (by timer). Has the advantage of more exact PWM generation, especially the duty cycle (which is not very relevant for most IR receiver circuits), and the disadvantage of using a hardware timer, which in turn is not available for other libraries and to fix the send pin (but not the receive pin) at the [dedicated timer output pin(s)](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#timer-and-pin-usage). Is enabled for ESP32 and RP2040 in all examples, since they support PWM gereration for each pin without using a shared resource (timer). | +| `IR_SEND_DUTY_CYCLE_PERCENT` | 30 | Duty cycle of IR send signal. | +| `USE_NO_SEND_PWM` | disabled | Uses no carrier PWM, just simulate an **active low** receiver signal. Used for transferring signal by cable instead of IR. Overrides `SEND_PWM_BY_TIMER` definition. | +| `USE_OPEN_DRAIN_OUTPUT_FOR_SEND_PIN` | disabled | Uses or simulates open drain output mode at send pin. **Attention, active state of open drain is LOW**, so connect the send LED between positive supply and send pin! | +| `USE_ACTIVE_HIGH_OUTPUT_FOR_SEND_PIN` | disabled | Only if `USE_NO_SEND_PWM` is enabled. Simulate an **active high** receiver signal instead of an active low signal. | +| `DISABLE_CODE_FOR_RECEIVER` | disabled | Disables static receiver code like receive timer ISR handler and static IRReceiver and irparams data. Saves 450 bytes program memory and 269 bytes RAM if receiving functions are not required. | +| `FEEDBACK_LED_IS_ACTIVE_LOW` | disabled | Required on some boards (like my BluePill and my ESP8266 board), where the feedback LED is active low. | +| `NO_LED_FEEDBACK_CODE` | disabled | Disables the LED feedback code for send and receive. Saves around 100 bytes program memory for receiving, around 500 bytes for sending and halving the receiver ISR (Interrupt Service Routine) processing time. | +| `NO_LED_RECEIVE_FEEDBACK_CODE` | disabled | Disables the LED feedback code for receive. Saves around 100 bytes program memory for receiving and halving the receiver ISR (Interrupt Service Routine) processing time. | +| `NO_LED_SEND_FEEDBACK_CODE` | disabled | Disables the LED feedback code for send. Saves around 500 bytes for sending. | +| `MICROS_PER_TICK` | 50 | Resolution of the raw input buffer data. Corresponds to 2 pulses of each 26.3 µs at 38 kHz. | +| `TOLERANCE_FOR_DECODERS_MARK_OR_SPACE_MATCHING_PERCENT` | 25 | Relative tolerance for matchTicks(), matchMark() and matchSpace() functions used for protocol decoding. | | `DEBUG` | disabled | Enables lots of lovely debug output. | | `IR_USE_AVR_TIMER*` | | Selection of timer to be used for generating IR receiving sample interval. | These next macros for **TinyIRReceiver** must be defined in your program before the line `#include ` to take effect. | Name | Default value | Description | -|:---|---:|----| -| `IR_RECEIVE_PIN` | 2 | The pin number for TinyIRReceiver IR input, which gets compiled in. | +|-|-:|-| +| `IR_RECEIVE_PIN` | 2 | The pin number for TinyIRReceiver IR input, which gets compiled in. Not used in IRremote. | | `IR_FEEDBACK_LED_PIN` | `LED_BUILTIN` | The pin number for TinyIRReceiver feedback LED, which gets compiled in. | -| `NO_LED_FEEDBACK_CODE` | disabled | Disables the feedback LED function. Saves 14 bytes program memory. | +| `NO_LED_FEEDBACK_CODE` | disabled | Disables the feedback LED codefor send and receive. Saves 14 bytes program memory. | +| `NO_LED_RECEIVE_FEEDBACK_CODE` | disabled | Disables the LED feedback code for receive. | +| `NO_LED_SEND_FEEDBACK_CODE` | disabled | Disables the LED feedback code for send. | | `DISABLE_PARITY_CHECKS` | disabled | Disables the addres and command parity checks. Saves 48 bytes program memory. | +| `USE_EXTENDED_NEC_PROTOCOL` | disabled | Like NEC, but take the 16 bit address as one 16 bit value and not as 8 bit normal and 8 bit inverted value. | | `USE_ONKYO_PROTOCOL` | disabled | Like NEC, but take the 16 bit address and command each as one 16 bit value and not as 8 bit normal and 8 bit inverted value. | | `USE_FAST_PROTOCOL` | disabled | Use FAST protocol (no address and 16 bit data, interpreted as 8 bit command and 8 bit inverted command) instead of NEC. | | `ENABLE_NEC2_REPEATS` | disabled | Instead of sending / receiving the NEC special repeat code, send / receive the original frame for repeat. | +| `USE_CALLBACK_FOR_TINY_RECEIVER` | disabled | Call the user provided function `void handleReceivedTinyIRData()` each time a frame or repeat is received. | The next macro for **IRCommandDispatcher** must be defined in your program before the line `#include ` to take effect. +| `USE_TINY_IR_RECEIVER` | disabled | Use [TinyReceiver](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#tinyreceiver--tinysender) for receiving IR codes. | | `IR_COMMAND_HAS_MORE_THAN_8_BIT` | disabled | Enables mapping and dispatching of IR commands consisting of more than 8 bits. Saves up to 160 bytes program memory and 4 bytes RAM + 1 byte RAM per mapping entry. | +| `BUZZER_PIN` | | If `USE_TINY_IR_RECEIVER` is enabled, the pin to be used for the optional 50 ms buzzer feedback before executing a command. Other IR libraries than Tiny are not compatible with tone() command. | ### Changing include (*.h) files with Arduino IDE First, use *Sketch > Show Sketch Folder (Ctrl+K)*.
@@ -673,9 +914,13 @@ If you are using [Sloeber](https://eclipse.baeyens.it) as your IDE, you can easi # Supported Boards **Issues and discussions with the content "Is it possible to use this library with the ATTinyXYZ? / board XYZ" without any reasonable explanations will be immediately closed without further notice.**
+For **ESP8266/ESP32**, [this library](https://github.com/crankyoldgit/IRremoteESP8266) supports an [impressive set of protocols and a lot of air conditioners](https://github.com/crankyoldgit/IRremoteESP8266/blob/master/SupportedProtocols.md)

-ATtiny and Digispark boards are only tested with the recommended [ATTinyCore](https://github.com/SpenceKonde/ATTinyCore) using `New Style` pin mapping for the pro board. +Digispark boards are only tested with [ATTinyCore](https://github.com/SpenceKonde/ATTinyCore) using `New Style` pin mapping for the Digispark Pro board.
+ATtiny boards are only tested with [ATTinyCore](https://github.com/SpenceKonde/ATTinyCore#supported-devices) or [megaTinyCore](https://github.com/SpenceKonde/megaTinyCore). + - Arduino Uno / Mega / Leonardo / Duemilanove / Diecimila / LilyPad / Mini / Fio / Nano etc. +- Arduino Uno R4, but not yet tested, because of lack of a R4 board. **Sending does not work** on the `arduino:renesas_uno:unor4wifi`. - Teensy 1.0 / 1.0++ / 2.0 / 2++ / 3.0 / 3.1 / 3.2 / Teensy-LC - but [limited support](https://forum.pjrc.com/threads/65912-Enable-Continuous-Integration-with-arduino-cli-for-3-party-libraries); Credits: PaulStoffregen (Teensy Team) - Sanguino - ATmega8, 48, 88, 168, 328 @@ -684,15 +929,15 @@ ATtiny and Digispark boards are only tested with the recommended [ATTinyCore](ht - ATmega4809 (Nano every) - ATtiny3217 (Tiny Core 32 Dev Board) - ATtiny84, 85, 167 (Digispark + Digispark Pro) -- SAMD21 (Zero, MKR*, **but not SAMD51 and not DUE, the latter is SAM architecture**) +- SAMD (Zero, MKR*, **but not DUE, the latter is SAM architecture**) - ESP8266 -- ESP32 (ESP32 C3 since board package 2.0.2 from Espressif) +- ESP32 (ESP32-C3 since board package 2.0.2 from Espressif) - Sparkfun Pro Micro - Nano Every, Uno WiFi Rev2, nRF5 BBC MicroBit, Nano33_BLE - BluePill with STM32 - RP2040 based boards (Raspberry Pi Pico, Nano RP2040 Connect etc.) -For ESP8266/ESP32, [this library](https://github.com/crankyoldgit/IRremoteESP8266) supports an [impressive set of protocols and a lot of air conditioners](https://github.com/crankyoldgit/IRremoteESP8266/blob/master/SupportedProtocols.md) + We are open to suggestions for adding support to new boards, however we highly recommend you contact your supplier first and ask them to provide support from their side.
If you can provide **examples of using a periodic timer for interrupts** for the new board, and the board name for selection in the Arduino IDE, then you have way better chances to get your board supported by IRremote. @@ -701,46 +946,53 @@ If you can provide **examples of using a periodic timer for interrupts** for the # Timer and pin usage The **receiver sample interval of 50 µs is generated by a timer**. On many boards this must be a hardware timer. On some boards where a software timer is available, the software timer is used.
-Every pin can be used for receiving. +On **ESP8266** `timer1` is used for receive interrupts, which makes it incompatible to the Servo and other libraries.
+On **ESP32** `hw_timer_t` is used for receive interrupts. + +Every pin can be used for receiving.
+If software PWM is selected, which is default, every pin can also be used for sending. Sending with software PWM does not require a timer! The TinyReceiver example uses the **TinyReceiver** library, which can **only receive NEC codes, but does not require any timer** and runs even on a 1 MHz ATtiny85. -The code for the timer and the **timer selection** is located in [private/IRTimer.hpp](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/private/IRTimer.hpp). It can be adjusted here.
+The code for the timer and the **timer selection** is located in [private/IRTimer.hpp](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/private/IRTimer.hpp). The selected timer can be adjusted here. + **Be aware that the hardware timer used for receiving should not be used for analogWrite()!**.
-| Board/CPU | Receive
& PWM Timers| Hardware-PWM Pin | analogWrite()
pins occupied by timer | -|--------------------------------------------------------------------------|-------------------|---------------------|-----------------------| -| [ATtiny84](https://github.com/SpenceKonde/ATTinyCore) | **1** | **6** | -| [ATtiny85 > 4 MHz](https://github.com/SpenceKonde/ATTinyCore) | **0**, 1 | **0**, 4 | **0**, 1 & 4 | -| [ATtiny88 > 4 MHz](https://github.com/SpenceKonde/ATTinyCore) | **1** | **PB1 / 8** | **PB1 / 8 & PB2 / 9** | -| [ATtiny167 > 4 MHz](https://github.com/SpenceKonde/ATTinyCore) | **1** | **9**, 8 - 15 | **8 - 15** | -| [ATtiny1604](https://github.com/SpenceKonde/megaTinyCore) | **TCB0** | **PA05** | -| [ATtiny1614, ATtiny816](https://github.com/SpenceKonde/megaTinyCore) | **TCA0** | **PA3** | -| [ATtiny3217](https://github.com/SpenceKonde/megaTinyCore) | **TCA0**, TCD | % | -| [ATmega8](https://github.com/MCUdude/MiniCore) | **1** | **9** | +| Board/CPU | Receive
& send PWM Timer
Default timer is **bold** | Hardware-Send-PWM Pin | analogWrite()
pins occupied by timer | +|-|-|-|-| +| [ATtiny84](https://github.com/SpenceKonde/ATTinyCore/blob/v2.0.0-devThis-is-the-head-submit-PRs-against-this/avr/extras/ATtiny_x4.md) | **1** | **6** | | +| [ATtiny85 > 4 MHz](https://github.com/SpenceKonde/ATTinyCore/blob/v2.0.0-devThis-is-the-head-submit-PRs-against-this/avr/extras/ATtiny_x5.md) | **0**, 1 | **0**, 4 | **0**, 1 & 4 | +| [ATtiny88 > 4 MHz](https://github.com/SpenceKonde/ATTinyCore/blob/v2.0.0-devThis-is-the-head-submit-PRs-against-this/avr/extras/ATtiny_x8.md) | **1** | **PB1 / 8** | **PB1 / 8 & PB2 / 9** | +| [ATtiny167 > 4 MHz](https://github.com/SpenceKonde/ATTinyCore/blob/v2.0.0-devThis-is-the-head-submit-PRs-against-this/avr/extras/ATtiny_x7.md) | **1** | **9**, 8 - 15 | **8 - 15** | +| [ATtiny1604](https://github.com/SpenceKonde/megaTinyCore/blob/master/megaavr/extras/ATtiny_x04.md) | **TCB0** | **PA05** | +| [ATtiny1614, ATtiny816](https://github.com/SpenceKonde/megaTinyCore/blob/master/megaavr/extras/ATtiny_x14.md) | **TCA0** | **PA3** | +| [ATtiny3217](https://github.com/SpenceKonde/megaTinyCore/blob/master/megaavr/extras/ATtiny_x17.md) | **TCA0**, TCD | % | +| [ATmega8](https://github.com/MCUdude/MiniCore#supported-microcontrollers) | **1** | **9** | +| [ATmega1284](https://github.com/MCUdude/MightyCore#supported-microcontrollers) | 1, **2**, 3 | 13, 14, 6 | +| [ATmega164, ATmega324, ATmega644](https://github.com/MCUdude/MightyCore#supported-microcontrollers) | 1, **2** | 13, **14** | +| [ATmega8535 ATmega16, ATmega32](https://github.com/MCUdude/MightyCore#supported-microcontrollers) | **1** | **13** | +| [ATmega64, ATmega128, ATmega1281, ATmega2561](https://github.com/MCUdude/MegaCore#supported-microcontrollers) | **1** | **13** | +| [ATmega8515, ATmega162](https://github.com/MCUdude/MajorCore#pinout ) | **1** | **13** | | ATmega168, **ATmega328** | 1, **2** | 9, **3** | 9 & 10, **3 & 11** | -| [ATmega1284](https://github.com/MCUdude/MightyCore) | 1, **2**, 3 | 13, 14, 6 | -| [ATmega164, ATmega324, ATmega644](https://github.com/MCUdude/MightyCore) | 1, **2** | 13, **14** | -| [ATmega8535 ATmega16, ATmega32](https://github.com/MCUdude/MightyCore) | **1** | **13** | -| [ATmega64, ATmega128, ATmega1281, ATmega2561](https://github.com/MCUdude/MegaCore) | **1** | **13** | -| [ATmega8515, ATmega162](https://github.com/MCUdude/MajorCore) | **1** | **13** | -| ATmega1280, ATmega2560 | 1, **2**, 3, 4, 5 | 5, 6, **9**, 11, 46 | -| ATmega4809 | **TCB0** | **A4** | -| Leonardo (Atmega32u4) | 1, 3, **4_HS** | 5, **9**, 13 | -| Zero (SAMD) | **TC3** | \*, **9** | -| [ESP32](http://esp32.net/) | **Ledc chan. 0** | All pins | -| [Sparkfun Pro Micro](https://www.sparkfun.com/products/12640) | 1, **3** | **5**, 9 | +| ATmega1280, **ATmega2560** | 1, **2**, 3, 4, 5 | 5, 6, **9**, 11, 46 | 5, 6, **9**, 11, 46 | +| ATmega4809 | **TCB0** | **A4** | | +| Leonardo (Atmega32u4) | 1, 3, **4_HS** | 5, **9**, 13 | 5, **9**, 13 | +| Zero (SAMD) | **TC3** | \*, **9** | | +| [ESP8266](http://esp8266.net/) | **timer1** | % | | +| [ESP32](http://esp32.net/) | **hw_timer_t**
**Ledc channel 0** | All pins | | +| [Sparkfun Pro Micro](https://www.sparkfun.com/products/12640) | 1, **3** | **5**, 9 | | | [Teensy 1.0](https://www.pjrc.com/teensy/pinout.html) | **1** | **17** | 15, 18 | | [Teensy 2.0](https://www.pjrc.com/teensy/pinout.html) | 1, 3, **4_HS** | 9, **10**, 14 | 12 | | [Teensy++ 1.0 / 2.0](https://www.pjrc.com/teensy/pinout.html) | 1, **2**, 3 | **1**, 16, 25 | 0 | | [Teensy-LC](https://www.pjrc.com/teensy/pinout.html) | **TPM1** | **16** | 17 | -| [Teensy 3.0 - 3.6](https://www.pjrc.com/teensy/pinout.html) | **CMT** | **5** | +| [Teensy 3.0 - 3.6](https://www.pjrc.com/teensy/pinout.html) | **CMT** | **5** | | | [Teensy 4.0 - 4.1](https://www.pjrc.com/teensy/pinout.html) | **FlexPWM1.3** | **8** | 7, 25 | -| [BluePill / STM32F103C8T6](https://github.com/stm32duino/Arduino_Core_STM32) | **3** | % | **PA6 & PA7 & PB0 & PB1** | +| [BluePill / STM32F103C8T6](https://github.com/stm32duino/Arduino_Core_STM32) | **3** | % | **PA6 & PA7 & PB0 & PB1** | | [BluePill / STM32F103C8T6](https://stm32-base.org/boards/STM32F103C8T6-Blue-Pill) | **TIM4** | % | **PB6 & PB7 & PB8 & PB9** | -| [RP2040 / Pi Pico](https://github.com/earlephilhower/arduino-pico) | [default alarm pool](https://raspberrypi.github.io/pico-sdk-doxygen/group__repeating__timer.html) | All pins | No pin | +| [RP2040 / Pi Pico](https://github.com/earlephilhower/arduino-pico) | [default alarm pool](https://raspberrypi.github.io/pico-sdk-doxygen/group__repeating__timer.html) | All pins | No pin | | [RP2040 / Mbed based](https://github.com/arduino/ArduinoCore-mbed) | Mbed Ticker | All pins | No pin | +### No timer required for sending The **send PWM signal** is by default generated by software. **Therefore every pin can be used for sending**. The PWM pulse length is guaranteed to be constant by using `delayMicroseconds()`. Take care not to generate interrupts during sending with software generated PWM, otherwise you will get jitter in the generated PWM. @@ -754,8 +1006,11 @@ Since the Arduino `micros()` function has a resolution of 4 µs at 16 MHz, ## Incompatibilities to other libraries and Arduino commands like tone() and analogWrite() If you use a library which requires the same timer as IRremote, you have a problem, since **the timer resource cannot be shared simultaneously** by both libraries. +### Use NEC protocol and TinyReceiver +[TinyReceiver](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#tiny-nec-receiver-and-sender) does not require a timer, it relies on interrupts, thus avoiding any timer resource problems. + ### Change timer -The best approach is to change the timer used for IRremote, which can be accomplished by specifying the timer before `#include `.
+The best approach is to **change the timer** used for IRremote, which can be accomplished by specifying the timer before `#include `.
The timer specifications available for your board can be found in [private/IRTimer.hpp](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/private/IRTimer.hpp).
```c++ @@ -772,23 +1027,29 @@ The timer specifications available for your board can be found in [private/IRTim Here you see the Arduino Mega board and the available specifications are `IR_USE_AVR_TIMER[1,2,3,4,5]`.
You **just have to include a line** e.g. `#define IR_USE_AVR_TIMER3` before `#include ` to enable timer 3. -But be aware that the new timer in turn might be incompatible with other libraries or commands.
-For other boards/platforms you must look for the appropriate section guarded by e.g. `#elif defined(ESP32)`. +But be aware that the new timer in turn might be again incompatible with other libraries or Arduino functions.
+For non AVR boards/platforms you must look for the appropriate section guarded by e.g. `#elif defined(ESP32)`. ### Stop and start timer Another approach can be to share the timer **sequentially** if their functionality is used only for a short period of time like for the **Arduino tone() command**. -An example can be seen [here](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/21b5747a58e9d47c9e3f1beb056d58c875a92b47/examples/ReceiveDemo/ReceiveDemo.ino#L159-L169), where the timer settings for IR receive are restored after the tone has stopped. -For this we must call `IrReceiver.start()` or better `IrReceiver.start(microsecondsOfToneDuration)`.
-This only works since each call to` tone()` completely initializes the timer 2 used by the `tone()` command. +An example can be seen [here](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/ReceiveDemo/ReceiveDemo.ino#L284-L298), where the IR timer is restarted after the tone has stopped. + +```c++ +IrReceiver.stopTimer(); // Stop timer consistently before calling tone() or other functions using the timer resource. +tone(TONE_PIN, 2200, 8); +delay(8); +IrReceiver.restartTimer(); // Restart IR timer after timer resource is no longer blocked. +``` +This works on AVR boards like Uno because each call to` tone()` completely initializes the timer 2 used by the `tone()` command. ## Hardware-PWM signal generation for sending If you define `SEND_PWM_BY_TIMER`, the send PWM signal is forced to be generated by a hardware timer on most platforms.
By default, the same timer as for the receiver is used.
Since each hardware timer has its dedicated output pin(s), you must change timer or timer sub-specifications to change PWM output pin. See [private/IRTimer.hpp](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/private/IRTimer.hpp)
-**Exeptions** are currently [ESP32, ARDUINO_ARCH_RP2040, PARTICLE and ARDUINO_ARCH_MBED](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/39bdf8d7bf5b90dc221f8ae9fb3efed9f0a8a1db/examples/SimpleSender/PinDefinitionsAndMore.h#L273), where **PWM generation does not require a timer**. +**Exeptions** are currently [ESP32, ARDUINO_ARCH_RP2040, PARTICLE and ARDUINO_ARCH_MBED](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/SimpleSender/PinDefinitionsAndMore.h#L334), where **PWM generation does not require a timer**. ## Why do we use 30% duty cycle for sending -We do it according to the statement in the [Vishay datasheet](https://www.vishay.com/docs/80069/circuit.pdf): +We [do it](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/IRSend.hpp#L1192) according to the statement in the [Vishay datasheet](https://www.vishay.com/docs/80069/circuit.pdf): - Carrier duty cycle 50 %, peak current of emitter IF = 200 mA, the resulting transmission distance is 25 m. - Carrier duty cycle 10 %, peak current of emitter IF = 800 mA, the resulting transmission distance is 29 m. - Factor 1.16 The reason is, that it is not the pure energy of the fundamental which is responsible for the receiver to detect a signal. @@ -801,7 +1062,8 @@ The IR signal is sampled at a **50 µs interval**. For a constant 525 &micr And believe me, if you send a 525 µs signal, your receiver will output something between around 400 and 700 µs!
Therefore **we decode by default with a +/- 25% margin** using the formulas [here](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/IRremoteInt.h#L376-L399).
E.g. for the NEC protocol with its 560 µs unit length, we have TICKS_LOW = 8.358 and TICKS_HIGH = 15.0. This means, we accept any value between 8 ticks / 400 µs and 15 ticks / 750 µs (inclusive) as a mark or as a zero space. For a one space we have TICKS_LOW = 25.07 and TICKS_HIGH = 45.0.
-And since the receivers generated marks are longer or shorter than the spaces, we have introduced the [`MARK_EXCESS_MICROS` value]/https://github.com/Arduino-IRremote/Arduino-IRremote#protocolunknown) +And since the receivers generated marks are longer or shorter than the spaces, +we have introduced the [`MARK_EXCESS_MICROS`](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#compile-options--macros-for-this-library) macro to compensate for this receiver (and signal strength as well as ambient light dependent :disappointed: ) specific deviation.
Welcome to the world of **real world signal processing**. @@ -817,16 +1079,16 @@ Created with sigrok PulseView with IR_NEC decoder by DjordjeMandic.

# Quick comparison of 5 Arduino IR receiving libraries -[Here](https://github.com/crankyoldgit/IRremoteESP8266) you find an **ESP8266/ESP32** version of IRremote with an **[impressive list of supported protocols](https://github.com/crankyoldgit/IRremoteESP8266/blob/master/SupportedProtocols.md)**. - **This is a short comparison and may not be complete or correct.** -I created this comparison matrix for [myself](https://github.com/ArminJo) in order to choose a small IR lib for my project and to have a quick overview, when to choose which library.
-It is dated from **24.06.2022**. If you have complains about the data or request for extensions, please send a PM or open a discussion. +I created this comparison matrix for [myself](https://github.com/ArminJo) in order to choose a small IR library for my project and to have a quick overview, when to choose which library.
+It is dated from **24.06.2022** and updated 10/2023. If you have complains about the data or request for extensions, please send a PM or open a discussion. -| Subject | [IRMP](https://github.com/IRMP-org/IRMP) | [IRLremote](https://github.com/NicoHood/IRLremote) | [IRLib2](https://github.com/cyborg5/IRLib2)
**mostly unmaintained** | [IRremote](https://github.com/Arduino-IRremote/Arduino-IRremote) | [Minimal NEC](https://github.com/Arduino-IRremote/Arduino-IRremote/tree/master/examples/TinyReceiver) | [IRsmallDecoder](https://github.com/LuisMiCa/IRsmallDecoder) -|---------|------|-----------|--------|----------|----------|----------| -| Number of protocols | **50** | Nec + Panasonic + Hash \* | 12 + Hash \* | 17 + PulseDistance + Hash \* | NEC | NEC + RC5 + Sony + Samsung | +[Here](https://github.com/crankyoldgit/IRremoteESP8266) you find an **ESP8266/ESP32** version of IRremote with an **[impressive list of supported protocols](https://github.com/crankyoldgit/IRremoteESP8266/blob/master/SupportedProtocols.md)**. + +| Subject | [IRMP](https://github.com/IRMP-org/IRMP) | [IRLremote](https://github.com/NicoHood/IRLremote) | [IRLib2](https://github.com/cyborg5/IRLib2)
**mostly unmaintained** | [IRremote](https://github.com/Arduino-IRremote/Arduino-IRremote) | [TinyIR](https://github.com/Arduino-IRremote/Arduino-IRremote/tree/master/examples/TinyReceiver/TinyReceiver.ino) | [IRsmallDecoder](https://github.com/LuisMiCa/IRsmallDecoder) +|-|-|-|-|-|-|-| +| Number of protocols | **50** | Nec + Panasonic + Hash \* | 12 + Hash \* | 17 + PulseDistance + Hash \* | NEC + FAST | NEC + RC5 + Sony + Samsung | | Timing method receive | Timer2 or interrupt for pin 2 or 3 | **Interrupt** | Timer2 or interrupt for pin 2 or 3 | Timer2 | **Interrupt** | **Interrupt** | | Timing method send | PWM and timing with Timer2 interrupts | Timer2 interrupts | Timer2 and blocking wait | PWM with Timer2 and/or blocking wait with delay
Microseconds() | blocking wait with delay
Microseconds() | % | | Send pins| All | All | All ? | Timer dependent | All | % | @@ -838,30 +1100,35 @@ It is dated from **24.06.2022**. If you have complains about the data or request | FLASH usage (simple NEC example with 5 prints) | 1820
(4300 for 15 main / 8000 for all 40 protocols)
(+200 for callback)
(+80 for interrupt at pin 2+3)| 1270
(1400 for pin 2+3) | 4830 | 1770 | **900** | ?1100? | | RAM usage | 52
(73 / 100 for 15 (main) / 40 protocols) | 62 | 334 | 227 | **19** | 29 | | Supported platforms | **avr, megaavr, attiny, Digispark (Pro), esp8266, ESP32, STM32, SAMD 21, Apollo3
(plus arm and pic for non Arduino IDE)** | avr, esp8266 | avr, SAMD 21, SAMD 51 | avr, attiny, [esp8266](https://github.com/crankyoldgit/IRremoteESP8266), esp32, SAM, SAMD | **All platforms with attach
Interrupt()** | **All platforms with attach
Interrupt()** | -| Last library update | 6/2022 | 4/2018 | 3/2022 | 6/2022 | 6/2022 | 2/2022 | -| Remarks | Decodes 40 protocols concurrently.
39 Protocols to send.
Work in progress. | Only one protocol at a time. | Consists of 5 libraries. **Project containing bugs - 45 issues, no reaction for at least one year.** | Universal decoder and encoder.
Supports **Pronto** codes and sending of raw timing values. | Requires no timer. | Requires no timer. | +| Last library update | 5/2023 | 4/2018 | 11/2022 | 9/2023 | 5/2023 | 2/2022 | +| Remarks | Decodes 40 protocols concurrently.
39 Protocols to send.
Work in progress. | Only one protocol at a time. | Consists of 5 libraries. **Project containing bugs - 63 issues, 10 pull requests.* | Universal decoder and encoder.
Supports **Pronto** codes and sending of raw timing values. | Requires no timer. | Requires no timer. | \* The Hash protocol gives you a hash as code, which may be sufficient to distinguish your keys on the remote, but may not work with some protocols like Mitsubishi
+# [History](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/changelog.md) + # Useful links - [List of public IR code databases](http://www.harctoolbox.org/IR-resources.html) - [LIRC database](http://lirc-remotes.sourceforge.net/remotes-table.html) - [IRMP list of IR protocols](https://www.mikrocontroller.net/articles/IRMP_-_english#IR_Protocols) - [IRDB database for IR codes](https://github.com/probonopd/irdb/tree/master/codes) - [IRP definition files for IR protocols](https://github.com/probonopd/MakeHex/tree/master/protocols) +- [Good introduction to IR remotes by DroneBot Workshop](https://dronebotworkshop.com/ir-remotes/) - [IR Remote Control Theory and some protocols (upper right hamburger icon)](https://www.sbprojects.net/knowledge/ir/) - [Interpreting Decoded IR Signals (v2.45)](http://www.hifi-remote.com/johnsfine/DecodeIR.html) - ["Recording long Infrared Remote control signals with Arduino"](https://www.analysir.com/blog/2014/03/19/air-conditioners-problems-recording-long-infrared-remote-control-signals-arduino) - The original blog post of Ken Shirriff [A Multi-Protocol Infrared Remote Library for the Arduino](http://www.arcfn.com/2009/08/multi-protocol-infrared-remote-library.html) - [Vishay datasheet](https://www.vishay.com/docs/80069/circuit.pdf) +# [Contributors](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/Contributors.md) + # License Up to the version 2.7.0, the License is GPLv2. From the version 2.8.0, the license is the MIT license. # Copyright Initially coded 2009 Ken Shirriff http://www.righto.com
-Copyright (c) 2016-2017 Rafi Khan
-Copyright (c) 2020-2023 [Armin Joachimsmeyer](https://github.com/ArminJo) +Copyright (c) 2016-2017 Rafi Khan https://rafikhan.io
+Copyright (c) 2020-2024 [Armin Joachimsmeyer](https://github.com/ArminJo) diff --git a/changelog.md b/changelog.md index b03eceddd..0ab56fa17 100644 --- a/changelog.md +++ b/changelog.md @@ -2,6 +2,80 @@ The latest version may not be released! See also the commit log at github: https://github.com/Arduino-IRremote/Arduino-IRremote/commits/master +# 4.4.2 +- Support for SAMD51 timer3 if timer 5 is not available (Adafruit ItsyBitsy M4). +- attachInterrupt() on SAMD has a different semantic :-(. See: https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/. +- Fixed overflow handling. +- Improved repeat detection for DistanceWidthProtocol. +- Print of IR frame duration in printIRResultShort(); +- PulseDistanceWidthProtocolConstants now in PROGMEM, this saves 190 bytes RAM for unit test. +- Support for PROGMEM PulseDistanceWidthProtocol data. +- Support duplicated 8 bit address for sendSamsungLG(). + +# 4.4.1 +- Support for ESP core 3.x by akellai. +- restartTimer() now uses variable sMicrosAtLastStopTimer to keep track of uncounted ticks between stopTimer() and restartTimer(). +- Removed functions addTicksToInternalTickCounter() and addMicrosToInternalTickCounter(), which were added in 4.1.0. +- Version 2.2.0 of TinyIR with new TinyReceiverDecode() function to be used as drop in for IrReceiver.decode(). +- Support of RC6A. + +# 4.4.0 +- Using 8 bit raw timing buffer for all timings except frame gap (former rawbuf[0]). +- Renamed decodedIRData.initialGap to decodedIRData.initialGapTicks. +- sendNEC() and sendNEC2() now accepts 16 bit command to better map to NECext protocol found in IRDB databases. +- ir_DistanceWidthProtocol() now decodes up to 10 ms mark or spaces if RAM is bigger than 2 k. +- Improved sensitivity and decoding of PULSE_DISTANCE + PULSE_WIDTH protocols. +- Changed TOLERANCE_FOR_DECODERS_MARK_OR_SPACE_MATCHING to TOLERANCE_FOR_DECODERS_MARK_OR_SPACE_MATCHING_PERCENT. +- Improved examples AllProtocolsOnLCD, UnitTest and SimpleReceiver. +- New functions decodePulseDistanceWidthData() with 6 parameters and decodePulseDistanceWidthDataStrict() with 7 parameters. + +# 4.3.2 +- Added sendSonyMSB(unsigned long data, int nbits) as a clone of sendSony(unsigned long data, int nbits) to be more consistent. +- Added sendSamsungMSB(unsigned long data, int nbits) as a clone of sendSAMSUNG(unsigned long data, int nbits) to be more consistent. +- Added ESP32 core 3.x error message. + +# 4.3.1 + - Fixed overflow bug for rawlen > 254. + - Removed deprecated sendPulseDistance... functions with parameter aSendStopBit. + +# 4.3.0 +- Removed default value USE_DEFAULT_FEEDBACK_LED_PIN for last parameter of IRsend::begin(bool aEnableLEDFeedback, uint_fast8_t aFeedbackLEDPin). + Therefore IrSender.begin(DISABLE_LED_FEEDBACK) will not longer work! +- Added convenience function isIRReceiverAttachedForTinyReceiver(). +- Added Extended NEC Protocol macro to TinyIR by Buzzerb. +- Fixed sendSamsung() / sendSamsungLG() bug. +- Added functions stopTimer(), restartTimer() and restartTimerWithTicksToAdd(). +- Added rawlen and initialGap to IRData. +- Added ReceiveAndSendHobToHood example. +- Changed RECORD_GAP_MICROS default value from 5000 to 8000. + +# 4.2.1 +- Fix wrong type of tEnableLEDFeedback in IRSend.hpp and IRReceive.hpp. +- TinyReceiver 2.0 + - New TinyIRReceiverData which is filled with address, command and flags. + - Removed parameters address, command and flags from callback handleReceivedTinyIRData() and printTinyReceiverResultMinimal(). + - Callback function now only enabled if USE_CALLBACK_FOR_TINY_RECEIVER is activated. +- Fix changing IR_SEND_PIN dynamically for ESP32. +- Fix wrong type of tEnableLEDFeedback. +- Support for ESP32-C3. + +# 4.2.0 +- The old decode function is renamed to decode_old(decode_results *aResults). decode (decode_results *aResults) is only available in IRremote.h and prints a message. +- Added DECODE_ONKYO, to force 16 bit command and data decoding. +- Enable Bang&Olufsen 455 kHz if SEND_PWM_BY_TIMER is defined. +- Fixed bug: TinyReceiver throwing ISR not in IRAM on ESP8266. +- Usage of ATTinyCore pin numbering scheme e.g. PIN_PB2. +- Added ARDUINO_ARCH_NRF52 to support Seeed XIAO nRF52840 Sense. +- First untested support of Uno R4. +- Extraced version macros to IRVersion.h. + +## 4.1.2 +- Workaround for ESP32 RTOS delay() timing bug influencing the mark() function. + +## 4.1.1 +- SAMD51 use timer3 if timer5 not available. +- Disabled #define LOCAL_DEBUG in IRReceive.hpp, which was accidently enabled at 4.1.0. + ## 4.1.0 - Fixed bug in printing durations > 64535 in printIRResultRawFormatted(). - Narrowed constraints for RC5 RC6 number of bits. @@ -20,14 +94,14 @@ See also the commit log at github: https://github.com/Arduino-IRremote/Arduino-I - Added functions addTicksToInternalTickCounter() and addMicrosToInternalTickCounter(). ## 4.0.0 -- Added decoding of PulseDistanceWidth protocols and therfore changed function decodeDistance() to decodeDistanceWidth() and filename ir_DistanceProtocol.hpp to ir_DistanceWidthProtocol.hpp. +- Added decoding of PulseDistanceWidth protocols and therefore changed function decodeDistance() to decodeDistanceWidth() and filename ir_DistanceProtocol.hpp to ir_DistanceWidthProtocol.hpp. - Removed static function printIRSendUsage(), but kept class function printIRSendUsage(). - Changed type of decodedRawData and decodedRawDataArray which is now 64 bit for 32 bit platforms. - Added receiver callback functionality and registerReceiveCompleteCallback() function. - Introduced common structure PulseDistanceWidthProtocolConstants. - Where possible, changed all send and decode functions to use PulseDistanceWidthProtocolConstants. - Improved MSB/LSB handling -- New convenience fuctions bitreverse32Bit() and bitreverseOneByte(). +- New convenience functions bitreverse32Bit() and bitreverseOneByte(). - Improved Magiquest protocol. - Fix for #1028 - Prevent long delay caused by overflow when frame duration < repeat period - Thanks to Stephen Humphries! - Support for ATtiny816 - Thanks to elockman. @@ -239,7 +313,7 @@ See also the commit log at github: https://github.com/Arduino-IRremote/Arduino-I - Corrected keywords.txt. - BoseWave protocol added PR #690. - Formatting comply to the new stylesheet. -- Renamed "boarddefs.h" [ISSUE #375](https://github.com/Arduino-IRremote/Arduino-IRremote/issues/375). +- Renamed "boarddefs.h". - Renamed `SEND_PIN` to `IR_SEND_PIN`. - Renamed state macros. - Enabled `DUTY_CYCLE` for send signal. diff --git a/examples/AllProtocolsOnLCD/ADCUtils.h b/examples/AllProtocolsOnLCD/ADCUtils.h index 5aaaaf718..33c2bbfc1 100644 --- a/examples/AllProtocolsOnLCD/ADCUtils.h +++ b/examples/AllProtocolsOnLCD/ADCUtils.h @@ -29,6 +29,9 @@ #if defined(__AVR__) && defined(ADCSRA) && defined(ADATE) && (!defined(__AVR_ATmega4809__)) #define ADC_UTILS_ARE_AVAILABLE +// External Reference Current is 150 uA for 5 V and 100 uA for 3.5 V +#define READING_FOR_AREF 1024L // Datasheet 24.2: The minimum value represents GND and the maximum value represents the voltage on the AREF pin minus 1 LSB + // PRESCALE4 => 13 * 4 = 52 microseconds per ADC conversion at 1 MHz Clock => 19,2 kHz #define ADC_PRESCALE2 1 // 26 microseconds per ADC conversion at 1 MHz #define ADC_PRESCALE4 2 // 52 microseconds per ADC conversion at 1 MHz @@ -85,6 +88,7 @@ #define ADC_TEMPERATURE_CHANNEL_MUX 15 #define ADC_1_1_VOLT_CHANNEL_MUX 12 #define ADC_GND_CHANNEL_MUX 13 +#define ADC_CHANNEL_MUX_MASK 0x0F #elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) #define ADC_ISCR_CHANNEL_MUX 3 @@ -92,56 +96,106 @@ #define ADC_1_1_VOLT_CHANNEL_MUX 12 #define ADC_GND_CHANNEL_MUX 14 #define ADC_VCC_4TH_CHANNEL_MUX 13 +#define ADC_CHANNEL_MUX_MASK 0x1F #elif defined(__AVR_ATmega328P__) #define ADC_TEMPERATURE_CHANNEL_MUX 8 #define ADC_1_1_VOLT_CHANNEL_MUX 14 #define ADC_GND_CHANNEL_MUX 15 +#define ADC_CHANNEL_MUX_MASK 0x0F + +#elif defined(__AVR_ATmega644P__) +#define ADC_TEMPERATURE_CHANNEL_MUX // not existent +#define ADC_1_1_VOLT_CHANNEL_MUX 0x1E +#define ADC_GND_CHANNEL_MUX 0x1F +#define ADC_CHANNEL_MUX_MASK 0x0F #elif defined(__AVR_ATmega32U4__) #define ADC_TEMPERATURE_CHANNEL_MUX 0x27 #define ADC_1_1_VOLT_CHANNEL_MUX 0x1E #define ADC_GND_CHANNEL_MUX 0x1F +#define ADC_CHANNEL_MUX_MASK 0x3F #elif defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__) || defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) || defined(__AVR_ATmega644__) || defined(__AVR_ATmega644A__) || defined(__AVR_ATmega644P__) || defined(__AVR_ATmega644PA__) #define ADC_1_1_VOLT_CHANNEL_MUX 0x1E #define ADC_GND_CHANNEL_MUX 0x1F +#define ADC_CHANNEL_MUX_MASK 0x1F + #define INTERNAL INTERNAL1V1 #else #error "No temperature channel definitions specified for this AVR CPU" #endif -extern float sVCCVoltage; -extern uint16_t sVCCVoltageMillivolt; +/* + * Thresholds for OVER and UNDER voltage and detection of kind of power supply (USB or Li-ion) + * + * Default values are suitable for Li-ion batteries. + * We normally have voltage drop at the connectors, so the battery voltage is assumed slightly higher, than the Arduino VCC. + * But keep in mind that the ultrasonic distance module HC-SR04 may not work reliable below 3.7 volt. + */ +#if !defined(LI_ION_VCC_UNDERVOLTAGE_THRESHOLD_MILLIVOLT) +#define LI_ION_VCC_UNDERVOLTAGE_THRESHOLD_MILLIVOLT 3400 // Do not stress your battery and we require some power for standby +#endif +#if !defined(LI_ION_VCC_EMERGENCY_UNDERVOLTAGE_THRESHOLD_MILLIVOLT) +#define LI_ION_VCC_EMERGENCY_UNDERVOLTAGE_THRESHOLD_MILLIVOLT 3000 // Many Li-ions are specified down to 3.0 volt +#endif + +#if !defined(VCC_UNDERVOLTAGE_THRESHOLD_MILLIVOLT) +#define VCC_UNDERVOLTAGE_THRESHOLD_MILLIVOLT LI_ION_VCC_UNDERVOLTAGE_THRESHOLD_MILLIVOLT +#endif +#if !defined(VCC_EMERGENCY_UNDERVOLTAGE_THRESHOLD_MILLIVOLT) +#define VCC_EMERGENCY_UNDERVOLTAGE_THRESHOLD_MILLIVOLT LI_ION_VCC_EMERGENCY_UNDERVOLTAGE_THRESHOLD_MILLIVOLT +#endif +#if !defined(VCC_OVERVOLTAGE_THRESHOLD_MILLIVOLT) +#define VCC_OVERVOLTAGE_THRESHOLD_MILLIVOLT 5250 // + 5 % operation voltage +#endif +#if !defined(VCC_EMERGENCY_OVERVOLTAGE_THRESHOLD_MILLIVOLT) +#define VCC_EMERGENCY_OVERVOLTAGE_THRESHOLD_MILLIVOLT 5500 // +10 %. Max recommended operation voltage +#endif +#if !defined(VCC_CHECK_PERIOD_MILLIS) +#define VCC_CHECK_PERIOD_MILLIS 10000L // 10 seconds period of VCC checks +#endif +#if !defined(VCC_UNDERVOLTAGE_CHECKS_BEFORE_STOP) +#define VCC_UNDERVOLTAGE_CHECKS_BEFORE_STOP 6 // Shutdown after 6 times (60 seconds) VCC below VCC_UNDERVOLTAGE_THRESHOLD_MILLIVOLT or 1 time below VCC_EMERGENCY_UNDERVOLTAGE_THRESHOLD_MILLIVOLT +#endif + +#if !defined(VOLTAGE_USB_POWERED_LOWER_THRESHOLD_MILLIVOLT) +#define VOLTAGE_USB_POWERED_LOWER_THRESHOLD_MILLIVOLT 4300 // Assume USB powered above this voltage +#endif + +#if !defined(VOLTAGE_USB_POWERED_UPPER_THRESHOLD_MILLIVOLT) +#define VOLTAGE_USB_POWERED_UPPER_THRESHOLD_MILLIVOLT 4950 // Assume USB powered below this voltage, because of the loss in USB cable. If we have > 4950, we assume to be powered by VIN. +// In contrast to e.g. powered by VIN, which results in almost perfect 5 volt supply +#endif -extern long sLastVoltageCheckMillis; -extern uint8_t sVoltageTooLowCounter; - -uint16_t readADCChannel(uint8_t aChannelNumber); -uint16_t readADCChannelWithReference(uint8_t aChannelNumber, uint8_t aReference); -uint16_t waitAndReadADCChannelWithReference(uint8_t aChannelNumber, uint8_t aReference); -uint16_t waitAndReadADCChannelWithReferenceAndRestoreADMUXAndReference(uint8_t aChannelNumber, uint8_t aReference); -uint16_t readADCChannelWithOversample(uint8_t aChannelNumber, uint8_t aOversampleExponent); -void setADCMultiplexerAndReferenceForNextConversion(uint8_t aChannelNumber, uint8_t aReference); -uint16_t readADCChannelWithReferenceOversample(uint8_t aChannelNumber, uint8_t aReference, uint8_t aOversampleExponent); -uint16_t readADCChannelWithReferenceOversampleFast(uint8_t aChannelNumber, uint8_t aReference, uint8_t aOversampleExponent); -uint16_t readADCChannelWithReferenceMultiSamples(uint8_t aChannelNumber, uint8_t aReference, uint8_t aNumberOfSamples); -uint16_t readADCChannelWithReferenceMax(uint8_t aChannelNumber, uint8_t aReference, uint16_t aNumberOfSamples); -uint16_t readADCChannelWithReferenceMaxMicros(uint8_t aChannelNumber, uint8_t aReference, uint16_t aMicrosecondsToAquire); -uint16_t readUntil4ConsecutiveValuesAreEqual(uint8_t aChannelNumber, uint8_t aDelay, uint8_t aAllowedDifference, - uint8_t aMaxRetries); - -uint8_t checkAndWaitForReferenceAndChannelToSwitch(uint8_t aChannelNumber, uint8_t aReference); +extern long sLastVCCCheckMillis; +extern uint8_t sVCCTooLowCounter; + +uint16_t readADCChannel(uint8_t aADCChannelNumber); +uint16_t readADCChannelWithReference(uint8_t aADCChannelNumber, uint8_t aReference); +uint16_t waitAndReadADCChannelWithReference(uint8_t aADCChannelNumber, uint8_t aReference); +uint16_t waitAndReadADCChannelWithReferenceAndRestoreADMUXAndReference(uint8_t aADCChannelNumber, uint8_t aReference); +uint16_t readADCChannelWithOversample(uint8_t aADCChannelNumber, uint8_t aOversampleExponent); +void setADCChannelAndReferenceForNextConversion(uint8_t aADCChannelNumber, uint8_t aReference); +uint16_t readADCChannelWithReferenceOversampleFast(uint8_t aADCChannelNumber, uint8_t aReference, uint8_t aOversampleExponent); +uint32_t readADCChannelMultiSamples(uint8_t aPrescale, uint16_t aNumberOfSamples); +uint16_t readADCChannelMultiSamplesWithReference(uint8_t aADCChannelNumber, uint8_t aReference, uint8_t aNumberOfSamples); +uint32_t readADCChannelMultiSamplesWithReferenceAndPrescaler(uint8_t aADCChannelNumber, uint8_t aReference, uint8_t aPrescale, + uint16_t aNumberOfSamples); +uint16_t readADCChannelWithReferenceMax(uint8_t aADCChannelNumber, uint8_t aReference, uint16_t aNumberOfSamples); +uint16_t readADCChannelWithReferenceMaxMicros(uint8_t aADCChannelNumber, uint8_t aReference, uint16_t aMicrosecondsToAquire); +uint16_t readUntil4ConsecutiveValuesAreEqual(uint8_t aADCChannelNumber, uint8_t aReference, uint8_t aDelay, + uint8_t aAllowedDifference, uint8_t aMaxRetries); + +uint8_t checkAndWaitForReferenceAndChannelToSwitch(uint8_t aADCChannelNumber, uint8_t aReference); /* * readVCC*() functions store the result in sVCCVoltageMillivolt or sVCCVoltage */ float getVCCVoltageSimple(void); void readVCCVoltageSimple(void); -uint16_t getVCCVoltageMillivoltSimple(void); void readVCCVoltageMillivoltSimple(void); -float getVCCVoltage(void); void readVCCVoltage(void); uint16_t getVCCVoltageMillivolt(void); void readVCCVoltageMillivolt(void); @@ -152,12 +206,32 @@ void readAndPrintVCCVoltageMillivolt(Print *aSerial); uint16_t getVoltageMillivolt(uint16_t aVCCVoltageMillivolt, uint8_t aADCChannelForVoltageMeasurement); uint16_t getVoltageMillivolt(uint8_t aADCChannelForVoltageMeasurement); uint16_t getVoltageMillivoltWith_1_1VoltReference(uint8_t aADCChannelForVoltageMeasurement); -float getTemperatureSimple(void); -float getTemperature(void); - -bool isVCCTooLowMultipleTimes(); -void resetVCCTooLowMultipleTimes(); -bool isVoltageTooLow(); +float getCPUTemperatureSimple(void); +float getCPUTemperature(void); +float getTemperature(void) __attribute__ ((deprecated ("Renamed to getCPUTemperature()"))); // deprecated + +bool isVCCUSBPowered(); +bool isVCCUSBPowered(Print *aSerial); +bool isVCCUndervoltageMultipleTimes(); +void resetCounterForVCCUndervoltageMultipleTimes(); +bool isVCCUndervoltage(); +bool isVCCEmergencyUndervoltage(); +bool isVCCOvervoltage(); +bool isVCCOvervoltageSimple(); // Version using readVCCVoltageMillivoltSimple() +bool isVCCTooHighSimple(); // Version not using readVCCVoltageMillivoltSimple() #endif // defined(__AVR__) ... + +/* + * Variables and functions defined as dummies to allow for seamless compiling on non AVR platforms + */ +extern float sVCCVoltage; +extern uint16_t sVCCVoltageMillivolt; + +uint16_t readADCChannelWithReferenceOversample(uint8_t aADCChannelNumber, uint8_t aReference, uint8_t aOversampleExponent); + +uint16_t getVCCVoltageMillivoltSimple(void); +float getVCCVoltage(void); +float getCPUTemperature(void); + #endif // _ADC_UTILS_H diff --git a/examples/AllProtocolsOnLCD/ADCUtils.hpp b/examples/AllProtocolsOnLCD/ADCUtils.hpp index 079d177da..8d0e5e799 100644 --- a/examples/AllProtocolsOnLCD/ADCUtils.hpp +++ b/examples/AllProtocolsOnLCD/ADCUtils.hpp @@ -3,7 +3,7 @@ * * ADC utility functions. Conversion time is defined as 0.104 milliseconds for 16 MHz Arduinos in ADCUtils.h. * - * Copyright (C) 2016-2022 Armin Joachimsmeyer + * Copyright (C) 2016-2023 Armin Joachimsmeyer * Email: armin.joachimsmeyer@gmail.com * * This file is part of Arduino-Utils https://github.com/ArminJo/Arduino-Utils. @@ -26,9 +26,9 @@ #define _ADC_UTILS_HPP #include "ADCUtils.h" -#if defined(ADC_UTILS_ARE_AVAILABLE) +#if defined(ADC_UTILS_ARE_AVAILABLE) // set in ADCUtils.h, if supported architecture was detected -#if !defined(STR_HELPER) +#if !defined(STR) #define STR_HELPER(x) #x #define STR(x) STR_HELPER(x) #endif @@ -54,6 +54,16 @@ union WordUnionForADCUtils { uint8_t *BytePointer; }; +/* + * Enable this to see information on each call. + * Since there should be no library which uses Serial, it should only be enabled for development purposes. + */ +#if defined(DEBUG) +#define LOCAL_DEBUG +#else +//#define LOCAL_DEBUG // This enables debug output only for this file +#endif + /* * Persistent storage for VCC value */ @@ -61,15 +71,15 @@ float sVCCVoltage; uint16_t sVCCVoltageMillivolt; // for isVCCTooLowMultipleTimes() -long sLastVoltageCheckMillis; -uint8_t sVoltageTooLowCounter = 0; +long sLastVCCCheckMillis; +uint8_t sVCCTooLowCounter = 0; /* * Conversion time is defined as 0.104 milliseconds by ADC_PRESCALE in ADCUtils.h. */ -uint16_t readADCChannel(uint8_t aChannelNumber) { +uint16_t readADCChannel(uint8_t aADCChannelNumber) { WordUnionForADCUtils tUValue; - ADMUX = aChannelNumber | (DEFAULT << SHIFT_VALUE_FOR_REFERENCE); + ADMUX = aADCChannelNumber | (DEFAULT << SHIFT_VALUE_FOR_REFERENCE); // ADCSRB = 0; // Only active if ADATE is set to 1. // ADSC-StartConversion ADIF-Reset Interrupt Flag - NOT free running mode @@ -88,9 +98,9 @@ uint16_t readADCChannel(uint8_t aChannelNumber) { /* * Conversion time is defined as 0.104 milliseconds by ADC_PRESCALE in ADCUtils.h. */ -uint16_t readADCChannelWithReference(uint8_t aChannelNumber, uint8_t aReference) { +uint16_t readADCChannelWithReference(uint8_t aADCChannelNumber, uint8_t aReference) { WordUnionForADCUtils tUValue; - ADMUX = aChannelNumber | (aReference << SHIFT_VALUE_FOR_REFERENCE); + ADMUX = aADCChannelNumber | (aReference << SHIFT_VALUE_FOR_REFERENCE); // ADCSRB = 0; // Only active if ADATE is set to 1. // ADSC-StartConversion ADIF-Reset Interrupt Flag - NOT free running mode @@ -109,18 +119,18 @@ uint16_t readADCChannelWithReference(uint8_t aChannelNumber, uint8_t aReference) * Conversion time is defined as 0.104 milliseconds by ADC_PRESCALE in ADCUtils.h. * Does NOT restore ADMUX after reading */ -uint16_t waitAndReadADCChannelWithReference(uint8_t aChannelNumber, uint8_t aReference) { - checkAndWaitForReferenceAndChannelToSwitch(aChannelNumber, aReference); - return readADCChannelWithReference(aChannelNumber, aReference); +uint16_t waitAndReadADCChannelWithReference(uint8_t aADCChannelNumber, uint8_t aReference) { + checkAndWaitForReferenceAndChannelToSwitch(aADCChannelNumber, aReference); + return readADCChannelWithReference(aADCChannelNumber, aReference); } /* * Conversion time is defined as 0.104 milliseconds by ADC_PRESCALE in ADCUtils.h. * Restores ADMUX after reading */ -uint16_t waitAndReadADCChannelWithReferenceAndRestoreADMUXAndReference(uint8_t aChannelNumber, uint8_t aReference) { - uint8_t tOldADMUX = checkAndWaitForReferenceAndChannelToSwitch(aChannelNumber, aReference); - uint16_t tResult = readADCChannelWithReference(aChannelNumber, aReference); +uint16_t waitAndReadADCChannelWithReferenceAndRestoreADMUXAndReference(uint8_t aADCChannelNumber, uint8_t aReference) { + uint8_t tOldADMUX = checkAndWaitForReferenceAndChannelToSwitch(aADCChannelNumber, aReference); + uint16_t tResult = readADCChannelWithReference(aADCChannelNumber, aReference); checkAndWaitForReferenceAndChannelToSwitch(tOldADMUX & MASK_FOR_ADC_CHANNELS, tOldADMUX >> SHIFT_VALUE_FOR_REFERENCE); return tResult; } @@ -128,15 +138,15 @@ uint16_t waitAndReadADCChannelWithReferenceAndRestoreADMUXAndReference(uint8_t a /* * To prepare reference and ADMUX for next measurement */ -void setADCMultiplexerAndReferenceForNextConversion(uint8_t aChannelNumber, uint8_t aReference) { - ADMUX = aChannelNumber | (aReference << SHIFT_VALUE_FOR_REFERENCE); +void setADCChannelAndReferenceForNextConversion(uint8_t aADCChannelNumber, uint8_t aReference) { + ADMUX = aADCChannelNumber | (aReference << SHIFT_VALUE_FOR_REFERENCE); } /* * @return original ADMUX register content for optional later restoring values * All experimental values are acquired by using the ADCSwitchingTest example from this library */ -uint8_t checkAndWaitForReferenceAndChannelToSwitch(uint8_t aChannelNumber, uint8_t aReference) { +uint8_t checkAndWaitForReferenceAndChannelToSwitch(uint8_t aADCChannelNumber, uint8_t aReference) { uint8_t tOldADMUX = ADMUX; /* * Must wait >= 7 us if reference has to be switched from 1.1 volt/INTERNAL to VCC/DEFAULT (seen on oscilloscope) @@ -146,18 +156,21 @@ uint8_t checkAndWaitForReferenceAndChannelToSwitch(uint8_t aChannelNumber, uint8 * Must wait >= 200 us if channel has to be switched to 1.1 volt internal channel if S&H was at 5 Volt */ uint8_t tNewReference = (aReference << SHIFT_VALUE_FOR_REFERENCE); - ADMUX = aChannelNumber | tNewReference; + ADMUX = aADCChannelNumber | tNewReference; #if defined(INTERNAL2V56) if ((tOldADMUX & MASK_FOR_ADC_REFERENCE) != tNewReference && (aReference == INTERNAL || aReference == INTERNAL2V56)) { #else if ((tOldADMUX & MASK_FOR_ADC_REFERENCE) != tNewReference && aReference == INTERNAL) { +#endif +#if defined(LOCAL_DEBUG) + Serial.println(F("Switch from DEFAULT to INTERNAL")); #endif /* * Switch reference from DEFAULT to INTERNAL */ - delayMicroseconds(8000); // experimental value is >= 7600 us for Nano board and 6200 for UNO board - } else if ((tOldADMUX & 0x0F) != aChannelNumber) { - if (aChannelNumber == ADC_1_1_VOLT_CHANNEL_MUX) { + delayMicroseconds(8000); // experimental value is >= 7600 us for Nano board and 6200 for Uno board + } else if ((tOldADMUX & ADC_CHANNEL_MUX_MASK) != aADCChannelNumber) { + if (aADCChannelNumber == ADC_1_1_VOLT_CHANNEL_MUX) { /* * Internal 1.1 Volt channel requires <= 200 us for Nano board */ @@ -176,16 +189,16 @@ uint8_t checkAndWaitForReferenceAndChannelToSwitch(uint8_t aChannelNumber, uint8 * Oversample and multiple samples only makes sense if you expect a noisy input signal * It does NOT increase the precision of the measurement, since the ADC has insignificant noise */ -uint16_t readADCChannelWithOversample(uint8_t aChannelNumber, uint8_t aOversampleExponent) { - return readADCChannelWithReferenceOversample(aChannelNumber, DEFAULT, aOversampleExponent); +uint16_t readADCChannelWithOversample(uint8_t aADCChannelNumber, uint8_t aOversampleExponent) { + return readADCChannelWithReferenceOversample(aADCChannelNumber, DEFAULT, aOversampleExponent); } /* * Conversion time is defined as 0.104 milliseconds by ADC_PRESCALE in ADCUtils.h. */ -uint16_t readADCChannelWithReferenceOversample(uint8_t aChannelNumber, uint8_t aReference, uint8_t aOversampleExponent) { +uint16_t readADCChannelWithReferenceOversample(uint8_t aADCChannelNumber, uint8_t aReference, uint8_t aOversampleExponent) { uint16_t tSumValue = 0; - ADMUX = aChannelNumber | (aReference << SHIFT_VALUE_FOR_REFERENCE); + ADMUX = aADCChannelNumber | (aReference << SHIFT_VALUE_FOR_REFERENCE); ADCSRB = 0; // Free running mode. Only active if ADATE is set to 1. // ADSC-StartConversion ADATE-AutoTriggerEnable ADIF-Reset Interrupt Flag @@ -212,9 +225,9 @@ uint16_t readADCChannelWithReferenceOversample(uint8_t aChannelNumber, uint8_t a /* * Use ADC_PRESCALE32 which gives 26 us conversion time and good linearity for 16 MHz Arduino */ -uint16_t readADCChannelWithReferenceOversampleFast(uint8_t aChannelNumber, uint8_t aReference, uint8_t aOversampleExponent) { +uint16_t readADCChannelWithReferenceOversampleFast(uint8_t aADCChannelNumber, uint8_t aReference, uint8_t aOversampleExponent) { uint16_t tSumValue = 0; - ADMUX = aChannelNumber | (aReference << SHIFT_VALUE_FOR_REFERENCE); + ADMUX = aADCChannelNumber | (aReference << SHIFT_VALUE_FOR_REFERENCE); ADCSRB = 0; // Free running mode. Only active if ADATE is set to 1. // ADSC-StartConversion ADATE-AutoTriggerEnable ADIF-Reset Interrupt Flag @@ -239,11 +252,12 @@ uint16_t readADCChannelWithReferenceOversampleFast(uint8_t aChannelNumber, uint8 /* * Returns sum of all sample values - * Conversion time is defined as 0.104 milliseconds for 16 MHz Arduino by ADC_PRESCALE in ADCUtils.h. + * Conversion time is defined as 0.104 milliseconds for 16 MHz Arduino by ADC_PRESCALE (=ADC_PRESCALE128) in ADCUtils.h. + * @ param aNumberOfSamples If > 64 an overflow may occur. */ -uint16_t readADCChannelWithReferenceMultiSamples(uint8_t aChannelNumber, uint8_t aReference, uint8_t aNumberOfSamples) { +uint16_t readADCChannelMultiSamplesWithReference(uint8_t aADCChannelNumber, uint8_t aReference, uint8_t aNumberOfSamples) { uint16_t tSumValue = 0; - ADMUX = aChannelNumber | (aReference << SHIFT_VALUE_FOR_REFERENCE); + ADMUX = aADCChannelNumber | (aReference << SHIFT_VALUE_FOR_REFERENCE); ADCSRB = 0; // Free running mode. Only active if ADATE is set to 1. // ADSC-StartConversion ADATE-AutoTriggerEnable ADIF-Reset Interrupt Flag @@ -265,14 +279,73 @@ uint16_t readADCChannelWithReferenceMultiSamples(uint8_t aChannelNumber, uint8_t return tSumValue; } +/* + * Returns sum of all sample values + * Conversion time is defined as 0.104 milliseconds for 16 MHz Arduino for ADC_PRESCALE128 in ADCUtils.h. + * @ param aPrescale can be one of ADC_PRESCALE2, ADC_PRESCALE4, 8, 16, 32, 64, 128. + * ADC_PRESCALE32 is recommended for excellent linearity and fast readout of 26 microseconds + * @ param aNumberOfSamples If > 16k an overflow may occur. + */ +uint32_t readADCChannelMultiSamplesWithReferenceAndPrescaler(uint8_t aADCChannelNumber, uint8_t aReference, uint8_t aPrescale, + uint16_t aNumberOfSamples) { + uint32_t tSumValue = 0; + ADMUX = aADCChannelNumber | (aReference << SHIFT_VALUE_FOR_REFERENCE); + + ADCSRB = 0; // Free running mode. Only active if ADATE is set to 1. + // ADSC-StartConversion ADATE-AutoTriggerEnable ADIF-Reset Interrupt Flag + ADCSRA = (_BV(ADEN) | _BV(ADSC) | _BV(ADATE) | _BV(ADIF) | aPrescale); + + for (uint16_t i = 0; i < aNumberOfSamples; i++) { + /* + * wait for free running conversion to finish. + * Do not wait for ADSC here, since ADSC is only low for 1 ADC Clock cycle on free running conversion. + */ + loop_until_bit_is_set(ADCSRA, ADIF); + + ADCSRA |= _BV(ADIF); // clear bit to enable recognizing next conversion has finished + // Add value + tSumValue += ADCL | (ADCH << 8); // using WordUnionForADCUtils does not save space here + // tSumValue += (ADCH << 8) | ADCL; // this does NOT work! + } + ADCSRA &= ~_BV(ADATE); // Disable auto-triggering (free running mode) + return tSumValue; +} + +/* + * Returns sum of all sample values + * Assumes, that channel and reference are still set to the right values + * @ param aNumberOfSamples If > 16k an overflow may occur. + */ +uint32_t readADCChannelMultiSamples(uint8_t aPrescale, uint16_t aNumberOfSamples) { + uint32_t tSumValue = 0; + + ADCSRB = 0; // Free running mode. Only active if ADATE is set to 1. + // ADSC-StartConversion ADATE-AutoTriggerEnable ADIF-Reset Interrupt Flag + ADCSRA = (_BV(ADEN) | _BV(ADSC) | _BV(ADATE) | _BV(ADIF) | aPrescale); + + for (uint16_t i = 0; i < aNumberOfSamples; i++) { + /* + * wait for free running conversion to finish. + * Do not wait for ADSC here, since ADSC is only low for 1 ADC Clock cycle on free running conversion. + */ + loop_until_bit_is_set(ADCSRA, ADIF); + + ADCSRA |= _BV(ADIF); // clear bit to enable recognizing next conversion has finished + // Add value + tSumValue += ADCL | (ADCH << 8); // using WordUnionForADCUtils does not save space here + // tSumValue += (ADCH << 8) | ADCL; // this does NOT work! + } + ADCSRA &= ~_BV(ADATE); // Disable auto-triggering (free running mode) + return tSumValue; +} /* * use ADC_PRESCALE32 which gives 26 us conversion time and good linearity - * @return the maximum of aNumberOfSamples measurements. + * @return the maximum value of aNumberOfSamples samples. */ -uint16_t readADCChannelWithReferenceMax(uint8_t aChannelNumber, uint8_t aReference, uint16_t aNumberOfSamples) { +uint16_t readADCChannelWithReferenceMax(uint8_t aADCChannelNumber, uint8_t aReference, uint16_t aNumberOfSamples) { uint16_t tADCValue = 0; uint16_t tMaximum = 0; - ADMUX = aChannelNumber | (aReference << SHIFT_VALUE_FOR_REFERENCE); + ADMUX = aADCChannelNumber | (aReference << SHIFT_VALUE_FOR_REFERENCE); ADCSRB = 0; // Free running mode. Only active if ADATE is set to 1. // ADSC-StartConversion ADATE-AutoTriggerEnable ADIF-Reset Interrupt Flag @@ -298,33 +371,41 @@ uint16_t readADCChannelWithReferenceMax(uint8_t aChannelNumber, uint8_t aReferen /* * use ADC_PRESCALE32 which gives 26 us conversion time and good linearity + * @return the maximum value during aMicrosecondsToAquire measurement. */ -uint16_t readADCChannelWithReferenceMaxMicros(uint8_t aChannelNumber, uint8_t aReference, uint16_t aMicrosecondsToAquire) { +uint16_t readADCChannelWithReferenceMaxMicros(uint8_t aADCChannelNumber, uint8_t aReference, uint16_t aMicrosecondsToAquire) { uint16_t tNumberOfSamples = aMicrosecondsToAquire / 26; - return readADCChannelWithReferenceMax(aChannelNumber, aReference, tNumberOfSamples); + return readADCChannelWithReferenceMax(aADCChannelNumber, aReference, tNumberOfSamples); } /* * aMaxRetries = 255 -> try forever * @return (tMax + tMin) / 2 */ -uint16_t readUntil4ConsecutiveValuesAreEqual(uint8_t aChannelNumber, uint8_t aDelay, uint8_t aAllowedDifference, - uint8_t aMaxRetries) { - int tValues[4]; +uint16_t readUntil4ConsecutiveValuesAreEqual(uint8_t aADCChannelNumber, uint8_t aReference, uint8_t aDelay, + uint8_t aAllowedDifference, uint8_t aMaxRetries) { + int tValues[4]; // last value is in tValues[3] int tMin; int tMax; - tValues[0] = readADCChannel(aChannelNumber); + /* + * Initialize first 4 values before checking + */ + tValues[0] = readADCChannelWithReference(aADCChannelNumber, aReference); for (int i = 1; i < 4; ++i) { - delay(aDelay); // Only 3 delays! - tValues[i] = readADCChannel(aChannelNumber); + if (aDelay != 0) { + delay(aDelay); // Minimum is only 3 delays! + } + tValues[i] = readADCChannelWithReference(aADCChannelNumber, aReference); } do { - // find min and max - tMin = 1024; + /* + * Get min and max of the last 4 values + */ + tMin = READING_FOR_AREF; tMax = 0; - for (int i = 0; i < 4; ++i) { + for (uint_fast8_t i = 0; i < 4; ++i) { if (tValues[i] < tMin) { tMin = tValues[i]; } @@ -338,22 +419,44 @@ uint16_t readUntil4ConsecutiveValuesAreEqual(uint8_t aChannelNumber, uint8_t aDe if ((tMax - tMin) <= aAllowedDifference) { break; } else { + /* + * Get next value + */ // Serial.print("Difference="); // Serial.println(tMax - tMin); - - // move values + // Move values to front for (int i = 0; i < 3; ++i) { tValues[i] = tValues[i + 1]; } - // and wait - delay(aDelay); - tValues[3] = readADCChannel(aChannelNumber); + // and wait before getting next value + if (aDelay != 0) { + delay(aDelay); + } + tValues[3] = readADCChannelWithReference(aADCChannelNumber, aReference); } if (aMaxRetries != 255) { aMaxRetries--; } } while (aMaxRetries > 0); +#if defined(LOCAL_DEBUG) + if(aMaxRetries == 0) { + Serial.print(F("No 4 equal values for difference ")); + Serial.print(aAllowedDifference); + Serial.print(F(" found ")); + Serial.print(tValues[0]); + Serial.print(' '); + Serial.print(tValues[1]); + Serial.print(' '); + Serial.print(tValues[2]); + Serial.print(' '); + Serial.println(tValues[3]); + } else { + Serial.print(aMaxRetries); + Serial.println(F(" retries left")); + } +#endif + return (tMax + tMin) / 2; } @@ -361,11 +464,15 @@ uint16_t readUntil4ConsecutiveValuesAreEqual(uint8_t aChannelNumber, uint8_t aDe * !!! Function without handling of switched reference and channel.!!! * Use it ONLY if you only call getVCCVoltageSimple() or getVCCVoltageMillivoltSimple() in your program. * !!! Resolution is only 20 millivolt !!! + * Raw reading of 1.1 V is 225 at 5 V. + * Raw reading of 1.1 V is 221 at 5.1 V. + * Raw reading of 1.1 V is 214 at 5.25 V (+5 %). + * Raw reading of 1.1 V is 204 at 5.5 V (+10 %). */ float getVCCVoltageSimple(void) { // use AVCC with (optional) external capacitor at AREF pin as reference - float tVCC = readADCChannelWithReferenceMultiSamples(ADC_1_1_VOLT_CHANNEL_MUX, DEFAULT, 4); - return ((1023 * 1.1 * 4) / tVCC); + float tVCC = readADCChannelMultiSamplesWithReference(ADC_1_1_VOLT_CHANNEL_MUX, DEFAULT, 4); + return ((READING_FOR_AREF * 1.1 * 4) / tVCC); } /* @@ -375,20 +482,20 @@ float getVCCVoltageSimple(void) { */ uint16_t getVCCVoltageMillivoltSimple(void) { // use AVCC with external capacitor at AREF pin as reference - uint16_t tVCC = readADCChannelWithReferenceMultiSamples(ADC_1_1_VOLT_CHANNEL_MUX, DEFAULT, 4); - return ((1023L * ADC_INTERNAL_REFERENCE_MILLIVOLT * 4) / tVCC); + uint16_t tVCC = readADCChannelMultiSamplesWithReference(ADC_1_1_VOLT_CHANNEL_MUX, DEFAULT, 4); + return ((READING_FOR_AREF * ADC_INTERNAL_REFERENCE_MILLIVOLT * 4) / tVCC); } /* * Gets the hypothetical 14 bit reading of VCC using 1.1 volt reference - * Similar to getVCCVoltageMillivolt() * 1023 / 1100 + * Similar to getVCCVoltageMillivolt() * 1024 / 1100 */ uint16_t getVCCVoltageReadingFor1_1VoltReference(void) { - uint16_t tVCC = waitAndReadADCChannelWithReference(ADC_1_1_VOLT_CHANNEL_MUX, DEFAULT); // 225 for 1.1 V at 5 V VCC + uint16_t tVCC = waitAndReadADCChannelWithReference(ADC_1_1_VOLT_CHANNEL_MUX, DEFAULT); /* * Do not switch back ADMUX to enable checkAndWaitForReferenceAndChannelToSwitch() to work correctly for the next measurement */ - return ((1023L * 1023L) / tVCC); + return ((READING_FOR_AREF * READING_FOR_AREF) / tVCC); } /* @@ -402,15 +509,22 @@ float getVCCVoltage(void) { * Read value of 1.1 volt internal channel using VCC (DEFAULT) as reference. * Handles reference and channel switching by introducing the appropriate delays. * !!! Resolution is only 20 millivolt !!! + * Raw reading of 1.1 V is 225 at 5 V. + * Raw reading of 1.1 V is 221 at 5.1 V. + * Raw reading of 1.1 V is 214 at 5.25 V (+5 %). + * Raw reading of 1.1 V is 204 at 5.5 V (+10 %). */ uint16_t getVCCVoltageMillivolt(void) { uint16_t tVCC = waitAndReadADCChannelWithReference(ADC_1_1_VOLT_CHANNEL_MUX, DEFAULT); /* * Do not switch back ADMUX to enable checkAndWaitForReferenceAndChannelToSwitch() to work correctly for the next measurement */ - return ((1023L * ADC_INTERNAL_REFERENCE_MILLIVOLT) / tVCC); + return ((READING_FOR_AREF * ADC_INTERNAL_REFERENCE_MILLIVOLT) / tVCC); } +/* + * Does not set sVCCVoltageMillivolt + */ uint16_t printVCCVoltageMillivolt(Print *aSerial) { aSerial->print(F("VCC=")); uint16_t tVCCVoltageMillivolt = getVCCVoltageMillivolt(); @@ -432,8 +546,8 @@ void readAndPrintVCCVoltageMillivolt(Print *aSerial) { */ void readVCCVoltageSimple(void) { // use AVCC with (optional) external capacitor at AREF pin as reference - float tVCC = readADCChannelWithReferenceMultiSamples(ADC_1_1_VOLT_CHANNEL_MUX, DEFAULT, 4); - sVCCVoltage = (1023 * 1.1 * 4) / tVCC; + float tVCC = readADCChannelMultiSamplesWithReference(ADC_1_1_VOLT_CHANNEL_MUX, DEFAULT, 4); + sVCCVoltage = (READING_FOR_AREF * (((float) ADC_INTERNAL_REFERENCE_MILLIVOLT) / 1000) * 4) / tVCC; } /* @@ -443,8 +557,8 @@ void readVCCVoltageSimple(void) { */ void readVCCVoltageMillivoltSimple(void) { // use AVCC with external capacitor at AREF pin as reference - uint16_t tVCCVoltageMillivoltRaw = readADCChannelWithReferenceMultiSamples(ADC_1_1_VOLT_CHANNEL_MUX, DEFAULT, 4); - sVCCVoltageMillivolt = (1023L * ADC_INTERNAL_REFERENCE_MILLIVOLT * 4) / tVCCVoltageMillivoltRaw; + uint16_t tVCCVoltageMillivoltRaw = readADCChannelMultiSamplesWithReference(ADC_1_1_VOLT_CHANNEL_MUX, DEFAULT, 4); + sVCCVoltageMillivolt = (READING_FOR_AREF * ADC_INTERNAL_REFERENCE_MILLIVOLT * 4) / tVCCVoltageMillivoltRaw; } /* @@ -465,7 +579,7 @@ void readVCCVoltageMillivolt(void) { /* * Do not switch back ADMUX to enable checkAndWaitForReferenceAndChannelToSwitch() to work correctly for the next measurement */ - sVCCVoltageMillivolt = (1023L * ADC_INTERNAL_REFERENCE_MILLIVOLT) / tVCCVoltageMillivoltRaw; + sVCCVoltageMillivolt = (READING_FOR_AREF * ADC_INTERNAL_REFERENCE_MILLIVOLT) / tVCCVoltageMillivoltRaw; } /* @@ -474,7 +588,7 @@ void readVCCVoltageMillivolt(void) { */ uint16_t getVoltageMillivolt(uint16_t aVCCVoltageMillivolt, uint8_t aADCChannelForVoltageMeasurement) { uint16_t tInputVoltageRaw = waitAndReadADCChannelWithReference(aADCChannelForVoltageMeasurement, DEFAULT); - return (aVCCVoltageMillivolt * (uint32_t) tInputVoltageRaw) / 1023; + return (aVCCVoltageMillivolt * (uint32_t) tInputVoltageRaw) / READING_FOR_AREF; } /* @@ -483,42 +597,54 @@ uint16_t getVoltageMillivolt(uint16_t aVCCVoltageMillivolt, uint8_t aADCChannelF */ uint16_t getVoltageMillivolt(uint8_t aADCChannelForVoltageMeasurement) { uint16_t tInputVoltageRaw = waitAndReadADCChannelWithReference(aADCChannelForVoltageMeasurement, DEFAULT); - return (getVCCVoltageMillivolt() * (uint32_t) tInputVoltageRaw) / 1023; + return (getVCCVoltageMillivolt() * (uint32_t) tInputVoltageRaw) / READING_FOR_AREF; } uint16_t getVoltageMillivoltWith_1_1VoltReference(uint8_t aADCChannelForVoltageMeasurement) { uint16_t tInputVoltageRaw = waitAndReadADCChannelWithReference(aADCChannelForVoltageMeasurement, INTERNAL); - return (ADC_INTERNAL_REFERENCE_MILLIVOLT * (uint32_t) tInputVoltageRaw) / 1023; + return (ADC_INTERNAL_REFERENCE_MILLIVOLT * (uint32_t) tInputVoltageRaw) / READING_FOR_AREF; } /* - * Default values are suitable for Li-ion batteries. - * We normally have voltage drop at the connectors, so the battery voltage is assumed slightly higher, than the Arduino VCC. - * But keep in mind that the ultrasonic distance module HC-SR04 may not work reliable below 3.7 volt. + * Return true if sVCCVoltageMillivolt is > 4.3 V and < 4.95 V + * This does not really work for the UNO board, because it has no series Diode in the USB VCC + * and therefore a very low voltage drop. */ -#if !defined(VCC_STOP_THRESHOLD_MILLIVOLT) -#define VCC_STOP_THRESHOLD_MILLIVOLT 3400 // Do not stress your battery and we require some power for standby -#endif -#if !defined(VCC_EMERGENCY_STOP_MILLIVOLT) -#define VCC_EMERGENCY_STOP_MILLIVOLT 3000 // Many Li-ions are specified down to 3.0 volt -#endif -#if !defined(VCC_CHECK_PERIOD_MILLIS) -#define VCC_CHECK_PERIOD_MILLIS 10000 // Period of VCC checks -#endif -#if !defined(VCC_CHECKS_TOO_LOW_BEFORE_STOP) -#define VCC_CHECKS_TOO_LOW_BEFORE_STOP 6 // Shutdown after 6 times (60 seconds) VCC below VCC_STOP_THRESHOLD_MILLIVOLT or 1 time below VCC_EMERGENCY_STOP_MILLIVOLT -#endif +bool isVCCUSBPowered() { + readVCCVoltageMillivolt(); + return (VOLTAGE_USB_POWERED_LOWER_THRESHOLD_MILLIVOLT < sVCCVoltageMillivolt + && sVCCVoltageMillivolt < VOLTAGE_USB_POWERED_UPPER_THRESHOLD_MILLIVOLT); +} /* - * @ return true only once, when VCC_CHECKS_TOO_LOW_BEFORE_STOP (6) times voltage too low -> shutdown + * Return true if sVCCVoltageMillivolt is > 4.3 V and < 4.95 V */ -bool isVCCTooLowMultipleTimes() { +bool isVCCUSBPowered(Print *aSerial) { + readVCCVoltageMillivolt(); + aSerial->print(F("USB powered is ")); + bool tReturnValue; + if (VOLTAGE_USB_POWERED_LOWER_THRESHOLD_MILLIVOLT + < sVCCVoltageMillivolt&& sVCCVoltageMillivolt < VOLTAGE_USB_POWERED_UPPER_THRESHOLD_MILLIVOLT) { + tReturnValue = true; + aSerial->print(F("true ")); + } else { + tReturnValue = false; + aSerial->print(F("false ")); + } + printVCCVoltageMillivolt(aSerial); + return tReturnValue; +} + +/* + * @ return true only once, when VCC_UNDERVOLTAGE_CHECKS_BEFORE_STOP (6) times voltage too low -> shutdown + */ +bool isVCCUndervoltageMultipleTimes() { /* * Check VCC every VCC_CHECK_PERIOD_MILLIS (10) seconds */ - if (millis() - sLastVoltageCheckMillis >= VCC_CHECK_PERIOD_MILLIS) { - sLastVoltageCheckMillis = millis(); + if (millis() - sLastVCCCheckMillis >= VCC_CHECK_PERIOD_MILLIS) { + sLastVCCCheckMillis = millis(); # if defined(INFO) readAndPrintVCCVoltageMillivolt(&Serial); @@ -526,33 +652,35 @@ bool isVCCTooLowMultipleTimes() { readVCCVoltageMillivolt(); # endif - if (sVoltageTooLowCounter < VCC_CHECKS_TOO_LOW_BEFORE_STOP) { + if (sVCCTooLowCounter < VCC_UNDERVOLTAGE_CHECKS_BEFORE_STOP) { /* * Do not check again if shutdown has happened */ - if (sVCCVoltageMillivolt > VCC_STOP_THRESHOLD_MILLIVOLT) { - sVoltageTooLowCounter = 0; // reset counter + if (sVCCVoltageMillivolt > VCC_UNDERVOLTAGE_THRESHOLD_MILLIVOLT) { + sVCCTooLowCounter = 0; // reset counter } else { /* - * Voltage too low, wait VCC_CHECKS_TOO_LOW_BEFORE_STOP (6) times and then shut down. + * Voltage too low, wait VCC_UNDERVOLTAGE_CHECKS_BEFORE_STOP (6) times and then shut down. */ - if (sVCCVoltageMillivolt < VCC_EMERGENCY_STOP_MILLIVOLT) { + if (sVCCVoltageMillivolt < VCC_EMERGENCY_UNDERVOLTAGE_THRESHOLD_MILLIVOLT) { // emergency shutdown - sVoltageTooLowCounter = VCC_CHECKS_TOO_LOW_BEFORE_STOP; + sVCCTooLowCounter = VCC_UNDERVOLTAGE_CHECKS_BEFORE_STOP; # if defined(INFO) - Serial.println(F("Voltage < " STR(VCC_EMERGENCY_STOP_MILLIVOLT) " mV detected -> emergency shutdown")); + Serial.println( + F( + "Voltage < " STR(VCC_EMERGENCY_UNDERVOLTAGE_THRESHOLD_MILLIVOLT) " mV detected -> emergency shutdown")); # endif } else { - sVoltageTooLowCounter++; + sVCCTooLowCounter++; # if defined(INFO) - Serial.print(F("Voltage < " STR(VCC_STOP_THRESHOLD_MILLIVOLT) " mV detected: ")); - Serial.print(VCC_CHECKS_TOO_LOW_BEFORE_STOP - sVoltageTooLowCounter); + Serial.print(F("Voltage < " STR(VCC_UNDERVOLTAGE_THRESHOLD_MILLIVOLT) " mV detected: ")); + Serial.print(VCC_UNDERVOLTAGE_CHECKS_BEFORE_STOP - sVCCTooLowCounter); Serial.println(F(" tries left")); # endif } - if (sVoltageTooLowCounter == VCC_CHECKS_TOO_LOW_BEFORE_STOP) { + if (sVCCTooLowCounter == VCC_UNDERVOLTAGE_CHECKS_BEFORE_STOP) { /* - * 6 times voltage too low -> shutdown + * 6 times voltage too low -> return signal for shutdown etc. */ return true; } @@ -562,47 +690,131 @@ bool isVCCTooLowMultipleTimes() { return false; } -void resetVCCTooLowMultipleTimes(){ - sVoltageTooLowCounter = 0; +/* + * Return true if VCC_EMERGENCY_UNDERVOLTAGE_THRESHOLD_MILLIVOLT (3 V) reached + */ +bool isVCCUndervoltage() { + readVCCVoltageMillivolt(); + return (sVCCVoltageMillivolt < VCC_UNDERVOLTAGE_THRESHOLD_MILLIVOLT); +} + +/* + * Return true if VCC_EMERGENCY_UNDERVOLTAGE_THRESHOLD_MILLIVOLT (3 V) reached + */ +bool isVCCEmergencyUndervoltage() { + readVCCVoltageMillivolt(); + return (sVCCVoltageMillivolt < VCC_EMERGENCY_UNDERVOLTAGE_THRESHOLD_MILLIVOLT); +} + +void resetCounterForVCCUndervoltageMultipleTimes() { + sVCCTooLowCounter = 0; } -bool isVoltageTooLow(){ - return (sVoltageTooLowCounter >= VCC_CHECKS_TOO_LOW_BEFORE_STOP); +/* + * Recommended VCC is 1.8 V to 5.5 V, absolute maximum VCC is 6.0 V. + * Check for 5.25 V, because such overvoltage is quite unlikely to happen during regular operation. + * Raw reading of 1.1 V is 225 at 5 V. + * Raw reading of 1.1 V is 221 at 5.1 V. + * Raw reading of 1.1 V is 214 at 5.25 V (+5 %). + * Raw reading of 1.1 V is 204 at 5.5 V (+10 %). + * Raw reading of 1.1 V is 1126000 / VCC_MILLIVOLT + * @return true if 5 % overvoltage reached + */ +bool isVCCOvervoltage() { + readVCCVoltageMillivolt(); + return (sVCCVoltageMillivolt > VCC_OVERVOLTAGE_THRESHOLD_MILLIVOLT); +} +bool isVCCOvervoltageSimple() { + readVCCVoltageMillivoltSimple(); + return (sVCCVoltageMillivolt > VCC_OVERVOLTAGE_THRESHOLD_MILLIVOLT); +} + +// Version not using readVCCVoltageMillivoltSimple() +bool isVCCTooHighSimple() { + ADMUX = ADC_1_1_VOLT_CHANNEL_MUX | (DEFAULT << SHIFT_VALUE_FOR_REFERENCE); +// ADCSRB = 0; // Only active if ADATE is set to 1. +// ADSC-StartConversion ADIF-Reset Interrupt Flag - NOT free running mode + ADCSRA = (_BV(ADEN) | _BV(ADSC) | _BV(ADIF) | ADC_PRESCALE128); // 128 -> 104 microseconds per ADC conversion at 16 MHz --- Arduino default +// wait for single conversion to finish + loop_until_bit_is_clear(ADCSRA, ADSC); + +// Get value + uint16_t tRawValue = ADCL | (ADCH << 8); + + return tRawValue < 1126000 / VCC_OVERVOLTAGE_THRESHOLD_MILLIVOLT; } /* + * Temperature sensor is enabled by selecting the appropriate channel. + * Different formula for 328P and 328PB! * !!! Function without handling of switched reference and channel.!!! - * Use it ONLY if you only use INTERNAL reference (call getTemperatureSimple()) in your program. + * Use it ONLY if you only use INTERNAL reference (e.g. only call getTemperatureSimple()) in your program. */ -float getTemperatureSimple(void) { +float getCPUTemperatureSimple(void) { #if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__) return 0.0; #else -// use internal 1.1 volt as reference - float tTemp = (readADCChannelWithReferenceMultiSamples(ADC_TEMPERATURE_CHANNEL_MUX, INTERNAL, 2) - 317); - return (tTemp * (4 / 1.22)); + // use internal 1.1 volt as reference. 4 times oversample. Assume the signal has noise, but never verified :-( + uint16_t tTemperatureRaw = readADCChannelWithReferenceOversample(ADC_TEMPERATURE_CHANNEL_MUX, INTERNAL, 2); +#if defined(LOCAL_DEBUG) + Serial.print(F("TempRaw=")); + Serial.println(tTemperatureRaw); +#endif + +#if defined(__AVR_ATmega328PB__) + tTemperatureRaw -= 245; + return (float)tTemperatureRaw; +#elif defined(__AVR_ATtiny85__) + tTemperatureRaw -= 273; // 273 and 1.1666 are values from the datasheet + return (float)tTemperatureRaw / 1.1666; +#else + tTemperatureRaw -= 317; + return (float) tTemperatureRaw / 1.22; +#endif #endif } /* - * Handles reference and channel switching by introducing the appropriate delays. + * Handles usage of 1.1 V reference and channel switching by introducing the appropriate delays. */ float getTemperature(void) { + return getCPUTemperature(); +} +float getCPUTemperature(void) { #if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__) return 0.0; #else // use internal 1.1 volt as reference checkAndWaitForReferenceAndChannelToSwitch(ADC_TEMPERATURE_CHANNEL_MUX, INTERNAL); - // assume the signal has noise, but never verified :-( - float tTemp = (readADCChannelWithReferenceOversample(ADC_TEMPERATURE_CHANNEL_MUX, INTERNAL, 1) - 317); - return (tTemp / 1.22); + return getCPUTemperatureSimple(); #endif } -#elif defined(ARDUINO_ARCH_APOLLO3) // defined(ADC_UTILS_ARE_AVAILABLE) - void ADCUtilsDummyToAvoidBFDAssertions(){ - ; - } +#else // defined(ADC_UTILS_ARE_AVAILABLE) +// Dummy definition of functions defined in ADCUtils to compile examples for non AVR platforms without errors +/* + * Persistent storage for VCC value + */ +float sVCCVoltage; +uint16_t sVCCVoltageMillivolt; + +uint16_t getVCCVoltageMillivoltSimple(void){ + return 3300; +} + +uint16_t readADCChannelWithReferenceOversample(uint8_t aChannelNumber __attribute__((unused)), + uint8_t aReference __attribute__((unused)), uint8_t aOversampleExponent __attribute__((unused))) { + return 0; +} +float getCPUTemperature() { + return 20.0; +} +float getVCCVoltage() { + return 3.3; +} #endif // defined(ADC_UTILS_ARE_AVAILABLE) +#if defined(LOCAL_DEBUG) +#undef LOCAL_DEBUG +#endif #endif // _ADC_UTILS_HPP diff --git a/examples/AllProtocolsOnLCD/AllProtocolsOnLCD.ino b/examples/AllProtocolsOnLCD/AllProtocolsOnLCD.ino index b3dec2ff3..36c5648bb 100644 --- a/examples/AllProtocolsOnLCD/AllProtocolsOnLCD.ino +++ b/examples/AllProtocolsOnLCD/AllProtocolsOnLCD.ino @@ -9,7 +9,7 @@ ************************************************************************************ * MIT License * - * Copyright (c) 2022-2023 Armin Joachimsmeyer + * Copyright (c) 2022-2024 Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -36,12 +36,17 @@ #include "PinDefinitionsAndMore.h" // Define macros for input and output pin etc. #if !defined(RAW_BUFFER_LENGTH) -# if RAMEND <= 0x4FF || RAMSIZE < 0x4FF -#define RAW_BUFFER_LENGTH 180 // 750 (600 if we have only 2k RAM) is the value for air condition remotes. Default is 112 if DECODE_MAGIQUEST is enabled, otherwise 100. -# elif RAMEND <= 0x8FF || RAMSIZE < 0x8FF -#define RAW_BUFFER_LENGTH 600 // 750 (600 if we have only 2k RAM) is the value for air condition remotes. Default is 112 if DECODE_MAGIQUEST is enabled, otherwise 100. +// For air condition remotes it may require up to 750. Default is 200. +# if (defined(RAMEND) && RAMEND <= 0x4FF) || (defined(RAMSIZE) && RAMSIZE < 0x4FF) +#define RAW_BUFFER_LENGTH 360 # else -#define RAW_BUFFER_LENGTH 750 // 750 (600 if we have only 2k RAM) is the value for air condition remotes. Default is 112 if DECODE_MAGIQUEST is enabled, otherwise 100. +#define RAW_BUFFER_LENGTH 750 +# endif + +# if (defined(RAMEND) && RAMEND <= 0x8FF) || (defined(RAMSIZE) && RAMSIZE < 0x8FF) +#define DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE 200 // The decoder accepts mark or space durations up to 200 * 50 (MICROS_PER_TICK) = 10 milliseconds +# else +#define DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE 400 // The decoder accepts mark or space durations up to 400 * 50 (MICROS_PER_TICK) = 20 milliseconds # endif #endif @@ -59,7 +64,7 @@ // to compensate for the signal forming of different IR receiver modules. See also IRremote.hpp line 142. #define MARK_EXCESS_MICROS 20 // Adapt it to your IR receiver module. 20 is recommended for the cheap VS1838 modules. -//#define RECORD_GAP_MICROS 12000 // Default is 5000. Activate it for some LG air conditioner protocols. +//#define RECORD_GAP_MICROS 12000 // Default is 8000. Activate it for some LG air conditioner protocols. //#define DEBUG // Activate this for lots of lovely debug output from the decoders. //#define DECODE_NEC // Includes Apple and Onkyo @@ -74,29 +79,39 @@ */ //#define USE_NO_LCD //#define USE_SERIAL_LCD +// Definitions for the 1602 LCD +#define LCD_COLUMNS 16 +#define LCD_ROWS 2 + #if defined(USE_SERIAL_LCD) #include "LiquidCrystal_I2C.h" // Use an up to date library version, which has the init method +LiquidCrystal_I2C myLCD(0x27, LCD_COLUMNS, LCD_ROWS); // set the LCD address to 0x27 for a 16 chars and 2 line display #elif !defined(USE_NO_LCD) -#include "LiquidCrystal.h" #define USE_PARALLEL_LCD +#include "LiquidCrystal.h" +//LiquidCrystal myLCD(4, 5, 6, 7, 8, 9); +LiquidCrystal myLCD(7, 8, 3, 4, 5, 6); #endif #if defined(USE_PARALLEL_LCD) #define DEBUG_BUTTON_PIN 11 // If low, print timing for each received data set -#define AUXILIARY_DEBUG_BUTTON_PIN 12 // Is set to low to enable using of a simple connector for enabling debug #undef TONE_PIN #define TONE_PIN 9 // Pin 4 is used by LCD #else -#define DEBUG_BUTTON_PIN 6 +#define DEBUG_BUTTON_PIN 6 +#endif +#if defined(__AVR_ATmega328P__) +#define AUXILIARY_DEBUG_BUTTON_PIN 12 // Is set to low to enable using of a simple connector for enabling debug with pin 11 #endif +#define MILLIS_BETWEEN_ATTENTION_BEEP 60000 // 60 sec +uint32_t sMillisOfLastReceivedIRFrame = 0; + #if defined(USE_SERIAL_LCD) || defined(USE_PARALLEL_LCD) #define USE_LCD -// definitions for a 1602 LCD -#define LCD_COLUMNS 16 -#define LCD_ROWS 2 # if defined(__AVR__) && defined(ADCSRA) && defined(ADATE) -// For cyclically display of VCC +// For cyclically display of VCC and isVCCUSBPowered() +#define VOLTAGE_USB_POWERED_LOWER_THRESHOLD_MILLIVOLT 4250 #include "ADCUtils.hpp" #define MILLIS_BETWEEN_VOLTAGE_PRINT 5000 #define LCD_VOLTAGE_START_INDEX 11 @@ -105,21 +120,12 @@ bool ProtocolStringOverwritesVoltage = false; # endif #define LCD_IR_COMMAND_START_INDEX 9 -#endif // defined(USE_SERIAL_LCD) || defined(USE_PARALLEL_LCD) - -#if defined(USE_SERIAL_LCD) -LiquidCrystal_I2C myLCD(0x27, LCD_COLUMNS, LCD_ROWS); // set the LCD address to 0x27 for a 16 chars and 2 line display -#endif -#if defined(USE_PARALLEL_LCD) -//LiquidCrystal myLCD(4, 5, 6, 7, 8, 9); -LiquidCrystal myLCD(7, 8, 3, 4, 5, 6); -#endif - +void printsVCCVoltageMillivoltOnLCD(); void printIRResultOnLCD(); size_t printByteHexOnLCD(uint16_t aHexByteValue); void printSpacesOnLCD(uint_fast8_t aNumberOfSpacesToPrint); -uint16_t sVCCMillivolt; +#endif // defined(USE_SERIAL_LCD) || defined(USE_PARALLEL_LCD) void setup() { #if FLASHEND >= 0x3FFF // For 16k flash or more, like ATtiny1604. Code does not fit in program memory of ATtiny85 etc. @@ -131,7 +137,9 @@ void setup() { #endif Serial.begin(115200); -#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/|| defined(SERIALUSB_PID) || defined(ARDUINO_attiny3217) + +#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/ \ + || defined(SERIALUSB_PID) || defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_attiny3217) delay(4000); // To be able to connect Serial monitor after reset or power up and before first print out. Do not wait for an attached Serial Monitor! #endif // Just to know which program is running on my Arduino @@ -165,28 +173,31 @@ void setup() { # else Serial.print(DEBUG_BUTTON_PIN); # endif - Serial.print(F(" to ground or to pin ")); + Serial.print(F(" to ground")); +# if defined(AUXILIARY_DEBUG_BUTTON_PIN) + Serial.print(F(" or to pin ")); Serial.print(AUXILIARY_DEBUG_BUTTON_PIN); +#endif Serial.println(F(", raw data is always printed")); - // infos for receive + // Info for receive Serial.print(RECORD_GAP_MICROS); Serial.println(F(" us is the (minimum) gap, after which the start of a new IR packet is assumed")); Serial.print(MARK_EXCESS_MICROS); Serial.println(F(" us are subtracted from all marks and added to all spaces for decoding")); #endif -#if defined(USE_LCD) && defined(__AVR__) && defined(ADCSRA) && defined(ADATE) - getVCCVoltageMillivoltSimple(); // to initialize ADC mux and reference +#if defined(USE_LCD) && defined(ADC_UTILS_ARE_AVAILABLE) + readVCCVoltageMillivolt(); #endif #if defined(USE_SERIAL_LCD) myLCD.init(); myLCD.clear(); - myLCD.backlight(); + myLCD.backlight(); // Switch backlight LED on #endif #if defined(USE_PARALLEL_LCD) - myLCD.begin(LCD_COLUMNS, LCD_ROWS); + myLCD.begin(LCD_COLUMNS, LCD_ROWS); // This also clears display #endif #if defined(USE_LCD) @@ -197,7 +208,7 @@ void setup() { #endif #if defined(USE_LCD) && defined(ADC_UTILS_ARE_AVAILABLE) - sVCCMillivolt = getVCCVoltageMillivoltSimple(); + readVCCVoltageMillivolt(); #endif } @@ -227,17 +238,18 @@ void loop() { } else { // play tone auto tStartMillis = millis(); - IrReceiver.stop(); +// IrReceiver.stopTimer(); // Not really required for Uno, but we then should use restartTimer(aMicrosecondsToAddToGapCounter) tone(TONE_PIN, 2200); if ((IrReceiver.decodedIRData.protocol == UNKNOWN || digitalRead(DEBUG_BUTTON_PIN) == LOW) #if defined(USE_LCD) && defined(ADC_UTILS_ARE_AVAILABLE) - && sVCCMillivolt > 4222 + || isVCCUSBPowered() #endif - ) { - // Print more info, but only if we are connected to USB, i.e. VCC is > 4222 mV, because this may take to long to detect some fast repeats + ) { + // Print more info, but only if we are connected to USB, i.e. VCC is > 4300 mV, because this may take to long to detect some fast repeats IrReceiver.printIRSendUsage(&Serial); - IrReceiver.printIRResultRawFormatted(&Serial, false); // print ticks, this is faster :-) +// IrReceiver.printIRResultRawFormatted(&Serial, false); // print ticks, this is faster :-) + IrReceiver.printIRResultRawFormatted(&Serial); // print us, this is better to compare :-) } // Guarantee at least 5 millis for tone. decode starts 5 millis (RECORD_GAP_MICROS) after end of frame @@ -245,9 +257,7 @@ void loop() { while ((millis() - tStartMillis) < 5) ; noTone(TONE_PIN); - - // Restore IR timer. millis() - tStartMillis to compensate for stop of receiver. This enables a correct gap measurement. - IrReceiver.startWithTicksToAdd((millis() - tStartMillis) * (MICROS_IN_ONE_MILLI / MICROS_PER_TICK)); + IrReceiver.restartTimer(5000); // Restart IR timer. #if defined(USE_LCD) printIRResultOnLCD(); @@ -261,6 +271,25 @@ void loop() { IrReceiver.resume(); } // if (IrReceiver.decode()) + /* + * Check if generating attention beep every minute, after the current measurement was finished + */ + if ((millis() - sMillisOfLastReceivedIRFrame) >= MILLIS_BETWEEN_ATTENTION_BEEP +#if defined(USE_LCD) && defined(ADC_UTILS_ARE_AVAILABLE) + && !isVCCUSBPowered() +#endif + ) { + sMillisOfLastReceivedIRFrame = millis(); +#if defined(USE_LCD) && defined(ADC_UTILS_ARE_AVAILABLE) + printsVCCVoltageMillivoltOnLCD(); +#endif +// IrReceiver.stopTimer(); // Not really required for Uno, but we then should use restartTimer(aMicrosecondsToAddToGapCounter) + tone(TONE_PIN, 2200); + delay(50); + noTone(TONE_PIN); + IrReceiver.restartTimer(50000); + } + #if defined(USE_LCD) && defined(ADC_UTILS_ARE_AVAILABLE) //Periodically print VCC if (!ProtocolStringOverwritesVoltage && millis() - sMillisOfLastVoltagePrint > MILLIS_BETWEEN_VOLTAGE_PRINT) { @@ -268,18 +297,25 @@ void loop() { * Periodically print VCC */ sMillisOfLastVoltagePrint = millis(); - sVCCMillivolt = getVCCVoltageMillivoltSimple(); - char tVoltageString[5]; - dtostrf(sVCCMillivolt / 1000.0, 4, 2, tVoltageString); - myLCD.setCursor(LCD_VOLTAGE_START_INDEX - 1, 0); - myLCD.print(' '); - myLCD.print(tVoltageString); - myLCD.print('V'); + readVCCVoltageMillivolt(); + printsVCCVoltageMillivoltOnLCD(); } #endif } +#if defined(USE_LCD) +void printsVCCVoltageMillivoltOnLCD() { +# if defined(ADC_UTILS_ARE_AVAILABLE) + char tVoltageString[5]; + dtostrf(sVCCVoltageMillivolt / 1000.0, 4, 2, tVoltageString); + myLCD.setCursor(LCD_VOLTAGE_START_INDEX - 1, 0); + myLCD.print(' '); + myLCD.print(tVoltageString); + myLCD.print('V'); +# endif +} + /* * LCD output for 1602 LCDs * 40 - 55 Milliseconds per initial output @@ -289,7 +325,6 @@ void loop() { * */ void printIRResultOnLCD() { -#if defined(USE_LCD) static uint16_t sLastProtocolIndex = 4711; static uint16_t sLastProtocolAddress = 4711; static uint16_t sLastCommand = 0; @@ -325,27 +360,35 @@ void printIRResultOnLCD() { if (IrReceiver.decodedIRData.protocol == UNKNOWN) { /* - * Print number of bits received and microseconds of signal + * Print number of bits received and hash code or microseconds of signal */ myLCD.setCursor(0, 1); uint8_t tNumberOfBits = (IrReceiver.decodedIRData.rawDataPtr->rawlen + 1) / 2; - if (tNumberOfBits < 10) { - myLCD.print(' '); // padding space - } - myLCD.print(tNumberOfBits); + uint_fast8_t tPrintedStringLength = myLCD.print(tNumberOfBits); myLCD.print(F(" bit ")); - uint_fast8_t tDurationStringLength = myLCD.print(IrReceiver.getTotalDurationOfRawData()); - myLCD.print(F(" \xE4s")); // \xE4 is micro symbol - printSpacesOnLCD(7 - tDurationStringLength); + + if (IrReceiver.decodedIRData.decodedRawData != 0) { + if (tNumberOfBits < 10) { + myLCD.print('0'); + tPrintedStringLength++; + } + myLCD.print('x'); + tPrintedStringLength += myLCD.print(IrReceiver.decodedIRData.decodedRawData, HEX) + 1; + } else { + tPrintedStringLength += myLCD.print(IrReceiver.getTotalDurationOfRawData()); + myLCD.print(F(" \xE4s")); // \xE4 is micro symbol + } + printSpacesOnLCD(11 - tPrintedStringLength); sLastProtocolAddress = 4711; sLastCommand = 44711; } else { /* - * Print only if address has changed + * Protocol is know here + * Print address only if it has changed */ - if (sLastProtocolAddress != IrReceiver.decodedIRData.address) { - sLastProtocolAddress = IrReceiver.decodedIRData.address; + if (sLastProtocolAddress != IrReceiver.decodedIRData.address || IrReceiver.decodedIRData.protocol == PULSE_DISTANCE + || IrReceiver.decodedIRData.protocol == PULSE_WIDTH) { myLCD.setCursor(0, 1); /* @@ -353,13 +396,21 @@ void printIRResultOnLCD() { */ # if defined(DECODE_DISTANCE_WIDTH) if (IrReceiver.decodedIRData.protocol == PULSE_DISTANCE || IrReceiver.decodedIRData.protocol == PULSE_WIDTH) { + sLastProtocolAddress = 4711; // To enforce next print of address myLCD.print(F("[0]=0x")); uint_fast8_t tAddressStringLength = myLCD.print(IrReceiver.decodedIRData.decodedRawDataArray[0], HEX); printSpacesOnLCD(LCD_COLUMNS - tAddressStringLength); - sLastCommand = 0; // to trigger restoration of "C=" string - return; // no command here + sLastCommand = 0; // to trigger restoration of "C=" string, if another protocol is received + /* + * No command here! + */ + return; + } else { # endif + sLastProtocolAddress = IrReceiver.decodedIRData.address; +// Serial.print(F("Print address 0x")); +// Serial.println(IrReceiver.decodedIRData.address, HEX); myLCD.print(F("A=")); uint_fast8_t tAddressStringLength = printByteHexOnLCD(IrReceiver.decodedIRData.address); printSpacesOnLCD((LCD_IR_COMMAND_START_INDEX - 2) - tAddressStringLength); @@ -392,6 +443,10 @@ void printIRResultOnLCD() { /* * Command data */ +// Serial.print(F("Print command 0x")); +// Serial.print(tCommand, HEX); +// Serial.print(F(" at ")); +// Serial.println(sLastCommandPrintPosition); myLCD.setCursor(sLastCommandPrintPosition, 1); printByteHexOnLCD(tCommand); @@ -405,10 +460,8 @@ void printIRResultOnLCD() { myLCD.print(' '); } } // IrReceiver.decodedIRData.protocol == UNKNOWN -#endif // defined(USE_LCD) } -#if defined(USE_LCD) size_t printByteHexOnLCD(uint16_t aHexByteValue) { myLCD.print(F("0x")); size_t tPrintSize = 2; @@ -424,4 +477,4 @@ void printSpacesOnLCD(uint_fast8_t aNumberOfSpacesToPrint) { myLCD.print(' '); } } -#endif +#endif // defined(USE_LCD) diff --git a/examples/AllProtocolsOnLCD/LiquidCrystal_I2C.cpp b/examples/AllProtocolsOnLCD/LiquidCrystal_I2C.cpp index dab3dc969..7ac4cead0 100644 --- a/examples/AllProtocolsOnLCD/LiquidCrystal_I2C.cpp +++ b/examples/AllProtocolsOnLCD/LiquidCrystal_I2C.cpp @@ -1,19 +1,30 @@ +// LiquidCrystal_I2C.hpp // Based on the work by DFRobot +/* + * Extensions made by AJ 2023 + * Removed Arduino 0.x support + * Added SoftI2CMaste support, which drastically reduces program size. + * Added OLED stuff + * Added createChar() with PROGMEM input + * Added fast timing + */ +#ifndef _LIQUID_CRYSTAL_I2C_HPP +#define _LIQUID_CRYSTAL_I2C_HPP + +#include "Arduino.h" + +#if defined(__AVR__) && !defined(USE_SOFT_I2C_MASTER) && __has_include("SoftI2CMasterConfig.h") +#define USE_SOFT_I2C_MASTER // must be before #include "LiquidCrystal_I2C.h" +#endif #include "LiquidCrystal_I2C.h" #include -#include "Arduino.h" - inline size_t LiquidCrystal_I2C::write(uint8_t value) { send(value, Rs); return 1; } -#if !defined(USE_SOFT_I2C_MASTER) && __has_include("SoftI2CMasterConfig.h") -#define USE_SOFT_I2C_MASTER -#endif - #if defined(USE_SOFT_I2C_MASTER) //#define USE_SOFT_I2C_MASTER_H_AS_PLAIN_INCLUDE #include "SoftI2CMasterConfig.h" // Include configuration for sources @@ -23,6 +34,18 @@ inline size_t LiquidCrystal_I2C::write(uint8_t value) { #include "SoftWire.h" #endif +#if defined(__AVR__) +/* + * The datasheet says: a command need > 37us to settle. Enable pulse must be > 450ns. + * Use no delay for enable pulse after each command, + * because the overhead of this library seems to be using the 37 us and 450 ns. + * At least it works perfectly for all my LCD's connected to Uno, Nano etc. + * and it saves a lot of time in realtime applications using LCD as display, + * like https://github.com/ArminJo/Arduino-DTSU666H_PowerMeter + */ +#define USE_FAST_TIMING +#endif + // When the display powers up, it is configured as follows: // // 1. Display clear @@ -131,7 +154,11 @@ void LiquidCrystal_I2C::begin(uint8_t cols __attribute__((unused)), uint8_t line /********** high level commands, for the user! */ void LiquidCrystal_I2C::clear() { command(LCD_CLEARDISPLAY); // clear display, set cursor position to zero +#if defined(USE_FAST_TIMING) + delayMicroseconds(1500); // this command takes a long time! // AJ 20.9.23 1200 is too short for my 2004 LCD's, 1400 is OK +#else delayMicroseconds(2000); // this command takes a long time! +#endif if (_oled) setCursor(0, 0); } @@ -274,10 +301,13 @@ void LiquidCrystal_I2C::expanderWrite(uint8_t _data) { void LiquidCrystal_I2C::pulseEnable(uint8_t _data) { expanderWrite(_data | En); // En high - delayMicroseconds(1); // enable pulse must be >450ns - +#if !defined(USE_FAST_TIMING) + delayMicroseconds(1); // enable pulse must be > 450ns // AJ 20.9.23 not required for my LCD's +#endif expanderWrite(_data & ~En); // En low - delayMicroseconds(50); // commands need > 37us to settle +#if !defined(USE_FAST_TIMING) + delayMicroseconds(50); // commands need > 37us to settle // AJ 20.9.23 not required for my LCD's +#endif } // Alias functions @@ -342,3 +372,4 @@ void LiquidCrystal_I2C::setContrast(uint8_t new_val) { } #pragma GCC diagnostic pop +#endif // _LIQUID_CRYSTAL_I2C_HPP diff --git a/examples/AllProtocolsOnLCD/PinDefinitionsAndMore.h b/examples/AllProtocolsOnLCD/PinDefinitionsAndMore.h index cb2b3b86d..b13414f56 100644 --- a/examples/AllProtocolsOnLCD/PinDefinitionsAndMore.h +++ b/examples/AllProtocolsOnLCD/PinDefinitionsAndMore.h @@ -4,7 +4,7 @@ * Contains pin definitions for IRremote examples for various platforms * as well as definitions for feedback LED and tone() and includes * - * Copyright (C) 2021-2022 Armin Joachimsmeyer + * Copyright (C) 2021-2023 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. @@ -32,81 +32,97 @@ * DEFAULT/AVR 2 3 4 Arduino * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore - * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark pro - * ATtiny3217 18|PA1 19|PA2 20|PA3 MegaTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore * ATtiny1604 2 3|PA5 % * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore - * SAMD21 3 4 5 + * MKR* 1 3 4 + * SAMD 2 3 4 * ESP8266 14|D5 12|D6 % - * ESP32 15 4 27 - * BluePill PA6 PA7 PA3 + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 * APOLLO3 11 12 5 * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 */ //#define _IR_MEASURE_TIMING // For debugging purposes. #if defined(__AVR__) -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board -#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore -#define IR_RECEIVE_PIN 0 -#define IR_SEND_PIN 4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. -#define TONE_PIN 3 -#define _IR_TIMING_TEST_PIN 3 +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 # elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board #include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" // For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. # if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core #define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 //#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards #define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 #define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 #define _IR_TIMING_TEST_PIN 10 // PA4 # else -#define IR_RECEIVE_PIN 3 // PA3 - on Digispark board labeled as pin 9 -#define IR_SEND_PIN 2 // PA2 - on Digispark board labeled as pin 8 -#define TONE_PIN 7 // PA7 - on Digispark board labeled as pin 5 +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 # endif -# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board -#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory -// Pin 6 is TX pin 7 is RX -#define IR_RECEIVE_PIN 3 // INT1 -#define IR_SEND_PIN 4 -#define TONE_PIN 9 -#define _IR_TIMING_TEST_PIN 8 - -# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // Tiny Core Dev board -#define IR_RECEIVE_PIN 18 -#define IR_SEND_PIN 19 -#define TONE_PIN 20 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output -#define LED_BUILTIN 2 // PA6 - -# elif defined(__AVR_ATtiny816__) // Tiny Core Micro -#define IR_RECEIVE_PIN 14 // PA1 -#define IR_SEND_PIN 16 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output -#define LED_BUILTIN 4 // PB5 - -# elif defined(__AVR_ATtiny1614__) -#define IR_RECEIVE_PIN 8 // PA1 -#define IR_SEND_PIN 10 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 - -# elif defined(__AVR_ATtiny1604__) -#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. -#define IR_SEND_PIN 3 -#define APPLICATION_PIN 5 +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 #define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it +#define TONE_PIN 42 // Dummy for examples using it # elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ || defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ @@ -139,6 +155,15 @@ # endif # endif // defined(__AVR_ATtiny25__)... +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + #elif defined(ESP8266) #define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW #define IR_RECEIVE_PIN 14 // D5 @@ -148,21 +173,32 @@ #define tone(...) void() // tone() inhibits receive timer #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it - -#elif defined(CONFIG_IDF_TARGET_ESP32C3) -#define IR_INPUT_PIN 8 -#define IR_SEND_PIN 9 -#define TONE_PIN 10 // ADC2_0 -#define APPLICATION_PIN 11 +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 #elif defined(ESP32) #include // tone() is included in ESP32 core since 2.0.2 -#if !defined(ESP_ARDUINO_VERSION_VAL) -#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) 12345678 -#endif +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif #if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) #define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. void tone(uint8_t aPinNumber, unsigned int aFrequency){ @@ -205,7 +241,8 @@ void noTone(uint8_t aPinNumber){ #define IR_SEND_PIN 12 #define TONE_PIN 5 -#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect #define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico #define IR_SEND_PIN 4 // GPIO16 #define TONE_PIN 5 @@ -252,14 +289,18 @@ void noTone(uint8_t aPinNumber){ #define _IR_TIMING_TEST_PIN 7 #elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else #define IR_RECEIVE_PIN 2 +# endif #define IR_SEND_PIN 3 #define TONE_PIN 4 #define APPLICATION_PIN 5 #define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. #define _IR_TIMING_TEST_PIN 7 -#if !defined(ARDUINO_SAMD_ADAFRUIT) +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) // On the Zero and others we switch explicitly to SerialUSB #define Serial SerialUSB #endif @@ -299,19 +340,13 @@ void noTone(uint8_t aPinNumber){ #define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation #else # if defined(SEND_PWM_BY_TIMER) -#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warning in IRTimer.hpp +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp # endif #endif #if !defined (FLASHEND) #define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined #endif -#if !defined (RAMEND) -#define RAMEND 0xFFFF // Dummy value for platforms where RAMEND is not defined -#endif -#if !defined (RAMSIZE) -#define RAMSIZE 0xFFFF // Dummy value for platforms where RAMSIZE is not defined -#endif /* * Helper macro for getting a macro definition as string diff --git a/examples/ControlRelay/ControlRelay.ino b/examples/ControlRelay/ControlRelay.ino index 1460872f4..0ea2e73aa 100644 --- a/examples/ControlRelay/ControlRelay.ino +++ b/examples/ControlRelay/ControlRelay.ino @@ -35,7 +35,7 @@ #include "PinDefinitionsAndMore.h" // Define macros for input and output pin etc. -#if FLASHEND <= 0x1FFF || (RAMEND <= 0x4FF || RAMSIZE < 0x4FF) // For 8k flash or 512 bytes RAM or less, like ATtiny85, ATtiny167 +#if FLASHEND <= 0x1FFF || (defined(RAMEND) && RAMEND <= 0x4FF) || (defined(RAMSIZE) && RAMSIZE < 0x4FF) // For 8k flash or 512 bytes RAM or less, like ATtiny85, ATtiny167 #define EXCLUDE_UNIVERSAL_PROTOCOLS // Saves up to 1000 bytes program memory. #define EXCLUDE_EXOTIC_PROTOCOLS #endif @@ -53,7 +53,9 @@ void setup() { pinMode(RELAY_PIN, OUTPUT); Serial.begin(115200); -#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/|| defined(SERIALUSB_PID) || defined(ARDUINO_attiny3217) + +#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/ \ + || defined(SERIALUSB_PID) || defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_attiny3217) delay(4000); // To be able to connect Serial monitor after reset or power up and before first print out. Do not wait for an attached Serial Monitor! #endif // Just to know which program is running on my Arduino diff --git a/examples/ControlRelay/PinDefinitionsAndMore.h b/examples/ControlRelay/PinDefinitionsAndMore.h index cb2b3b86d..b13414f56 100644 --- a/examples/ControlRelay/PinDefinitionsAndMore.h +++ b/examples/ControlRelay/PinDefinitionsAndMore.h @@ -4,7 +4,7 @@ * Contains pin definitions for IRremote examples for various platforms * as well as definitions for feedback LED and tone() and includes * - * Copyright (C) 2021-2022 Armin Joachimsmeyer + * Copyright (C) 2021-2023 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. @@ -32,81 +32,97 @@ * DEFAULT/AVR 2 3 4 Arduino * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore - * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark pro - * ATtiny3217 18|PA1 19|PA2 20|PA3 MegaTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore * ATtiny1604 2 3|PA5 % * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore - * SAMD21 3 4 5 + * MKR* 1 3 4 + * SAMD 2 3 4 * ESP8266 14|D5 12|D6 % - * ESP32 15 4 27 - * BluePill PA6 PA7 PA3 + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 * APOLLO3 11 12 5 * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 */ //#define _IR_MEASURE_TIMING // For debugging purposes. #if defined(__AVR__) -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board -#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore -#define IR_RECEIVE_PIN 0 -#define IR_SEND_PIN 4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. -#define TONE_PIN 3 -#define _IR_TIMING_TEST_PIN 3 +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 # elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board #include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" // For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. # if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core #define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 //#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards #define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 #define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 #define _IR_TIMING_TEST_PIN 10 // PA4 # else -#define IR_RECEIVE_PIN 3 // PA3 - on Digispark board labeled as pin 9 -#define IR_SEND_PIN 2 // PA2 - on Digispark board labeled as pin 8 -#define TONE_PIN 7 // PA7 - on Digispark board labeled as pin 5 +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 # endif -# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board -#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory -// Pin 6 is TX pin 7 is RX -#define IR_RECEIVE_PIN 3 // INT1 -#define IR_SEND_PIN 4 -#define TONE_PIN 9 -#define _IR_TIMING_TEST_PIN 8 - -# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // Tiny Core Dev board -#define IR_RECEIVE_PIN 18 -#define IR_SEND_PIN 19 -#define TONE_PIN 20 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output -#define LED_BUILTIN 2 // PA6 - -# elif defined(__AVR_ATtiny816__) // Tiny Core Micro -#define IR_RECEIVE_PIN 14 // PA1 -#define IR_SEND_PIN 16 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output -#define LED_BUILTIN 4 // PB5 - -# elif defined(__AVR_ATtiny1614__) -#define IR_RECEIVE_PIN 8 // PA1 -#define IR_SEND_PIN 10 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 - -# elif defined(__AVR_ATtiny1604__) -#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. -#define IR_SEND_PIN 3 -#define APPLICATION_PIN 5 +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 #define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it +#define TONE_PIN 42 // Dummy for examples using it # elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ || defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ @@ -139,6 +155,15 @@ # endif # endif // defined(__AVR_ATtiny25__)... +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + #elif defined(ESP8266) #define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW #define IR_RECEIVE_PIN 14 // D5 @@ -148,21 +173,32 @@ #define tone(...) void() // tone() inhibits receive timer #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it - -#elif defined(CONFIG_IDF_TARGET_ESP32C3) -#define IR_INPUT_PIN 8 -#define IR_SEND_PIN 9 -#define TONE_PIN 10 // ADC2_0 -#define APPLICATION_PIN 11 +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 #elif defined(ESP32) #include // tone() is included in ESP32 core since 2.0.2 -#if !defined(ESP_ARDUINO_VERSION_VAL) -#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) 12345678 -#endif +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif #if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) #define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. void tone(uint8_t aPinNumber, unsigned int aFrequency){ @@ -205,7 +241,8 @@ void noTone(uint8_t aPinNumber){ #define IR_SEND_PIN 12 #define TONE_PIN 5 -#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect #define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico #define IR_SEND_PIN 4 // GPIO16 #define TONE_PIN 5 @@ -252,14 +289,18 @@ void noTone(uint8_t aPinNumber){ #define _IR_TIMING_TEST_PIN 7 #elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else #define IR_RECEIVE_PIN 2 +# endif #define IR_SEND_PIN 3 #define TONE_PIN 4 #define APPLICATION_PIN 5 #define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. #define _IR_TIMING_TEST_PIN 7 -#if !defined(ARDUINO_SAMD_ADAFRUIT) +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) // On the Zero and others we switch explicitly to SerialUSB #define Serial SerialUSB #endif @@ -299,19 +340,13 @@ void noTone(uint8_t aPinNumber){ #define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation #else # if defined(SEND_PWM_BY_TIMER) -#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warning in IRTimer.hpp +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp # endif #endif #if !defined (FLASHEND) #define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined #endif -#if !defined (RAMEND) -#define RAMEND 0xFFFF // Dummy value for platforms where RAMEND is not defined -#endif -#if !defined (RAMSIZE) -#define RAMSIZE 0xFFFF // Dummy value for platforms where RAMSIZE is not defined -#endif /* * Helper macro for getting a macro definition as string diff --git a/examples/IRDispatcherDemo/IRCommandDispatcher.h b/examples/IRDispatcherDemo/IRCommandDispatcher.h index e3f46127b..83a98b27c 100644 --- a/examples/IRDispatcherDemo/IRCommandDispatcher.h +++ b/examples/IRDispatcherDemo/IRCommandDispatcher.h @@ -5,14 +5,14 @@ * * To run this example you need to install the "IRremote" or "IRMP" library under "Tools -> Manage Libraries..." or "Ctrl+Shift+I" * - * Copyright (C) 2019-2021 Armin Joachimsmeyer + * Copyright (C) 2019-2024 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of ServoEasing https://github.com/ArminJo/ServoEasing. * This file is part of IRMP https://github.com/IRMP-org/IRMP. * This file is part of Arduino-IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. * - * ServoEasing is free software: you can redistribute it and/or modify + * IRCommandDispatcher is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. @@ -38,6 +38,22 @@ #define IR_COMMAND_FLAG_REPEATABLE 0x01 // repeat accepted #define IR_COMMAND_FLAG_NON_BLOCKING 0x02 // Non blocking (short) command that can be processed any time and may interrupt other IR commands - used for stop, set direction etc. #define IR_COMMAND_FLAG_REPEATABLE_NON_BLOCKING (IR_COMMAND_FLAG_REPEATABLE | IR_COMMAND_FLAG_NON_BLOCKING) +#define IR_COMMAND_FLAG_BEEP 0x04 // Do a single short beep before executing command. May not be useful for short or repeating commands. +#define IR_COMMAND_FLAG_BLOCKING_BEEP (IR_COMMAND_FLAG_BLOCKING | IR_COMMAND_FLAG_BEEP) + + +#if !defined(IS_STOP_REQUESTED) +#define IS_STOP_REQUESTED IRDispatcher.requestToStopReceived +#endif +#if !defined(RETURN_IF_STOP) +#define RETURN_IF_STOP if (IRDispatcher.requestToStopReceived) return +#endif +#if !defined(BREAK_IF_STOP) +#define BREAK_IF_STOP if (IRDispatcher.requestToStopReceived) break +#endif +#if !defined(DELAY_AND_RETURN_IF_STOP) +#define DELAY_AND_RETURN_IF_STOP(aDurationMillis) if (IRDispatcher.delayAndCheckForStop(aDurationMillis)) return +#endif // Basic mapping structure struct IRToCommandMappingStruct { @@ -72,13 +88,10 @@ struct IRDataForCommandDispatcherStruct { #define COMMAND_EMPTY 0xFF // code no command #endif -#define RETURN_IF_STOP if (IRDispatcher.requestToStopReceived) return -#define BREAK_IF_STOP if (IRDispatcher.requestToStopReceived) break -#define DELAY_AND_RETURN_IF_STOP(aDurationMillis) if (IRDispatcher.delayAndCheckForStop(aDurationMillis)) return - class IRCommandDispatcher { public: void init(); + void printIRInfo(Print *aSerial); bool checkAndRunNonBlockingCommands(); bool checkAndRunSuspendedBlockingCommands(); @@ -107,7 +120,8 @@ class IRCommandDispatcher { bool justCalledBlockingCommand = false; // Flag that a blocking command was received and called - is set before call of command /* * Flag for running blocking commands to terminate. To check, you can use "if (IRDispatcher.requestToStopReceived) return;" (available as macro RETURN_IF_STOP). - * Is reset by next IR command received. Can be reset by main loop, if command has stopped. + * It is set if a blocking IR command received, which cannot be executed directly. Can be reset by main loop, if command has stopped. + * It is reset before executing a blocking command. */ volatile bool requestToStopReceived; /* diff --git a/examples/IRDispatcherDemo/IRCommandDispatcher.hpp b/examples/IRDispatcherDemo/IRCommandDispatcher.hpp index 06d3510ba..a8006400e 100644 --- a/examples/IRDispatcherDemo/IRCommandDispatcher.hpp +++ b/examples/IRDispatcherDemo/IRCommandDispatcher.hpp @@ -11,14 +11,14 @@ * A blocking command is stored and sets a stop flag for an already running blocking function to terminate. * The blocking command can in turn be executed by main loop by calling IRDispatcher.checkAndRunSuspendedBlockingCommands(). * - * Copyright (C) 2019-2022 Armin Joachimsmeyer + * Copyright (C) 2019-2024 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of ServoEasing https://github.com/ArminJo/ServoEasing. * This file is part of IRMP https://github.com/IRMP-org/IRMP. * This file is part of Arduino-IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. * - * ServoEasing is free software: you can redistribute it and/or modify + * IRCommandDispatcher is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. @@ -31,6 +31,14 @@ * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ + +/* + * Program behavior is modified by the following macros + * USE_TINY_IR_RECEIVER + * USE_IRMP_LIBRARY + * IR_COMMAND_HAS_MORE_THAN_8_BIT + */ + #ifndef _IR_COMMAND_DISPATCHER_HPP #define _IR_COMMAND_DISPATCHER_HPP @@ -38,6 +46,10 @@ #include "IRCommandDispatcher.h" +#if !defined(STR_HELPER) +#define STR_HELPER(x) #x +#define STR(x) STR_HELPER(x) +#endif /* * Enable this to see information on each call. * Since there should be no library which uses Serial, it should only be enabled for development purposes. @@ -47,7 +59,7 @@ #else //#define LOCAL_INFO // This enables info output only for this file #endif -#if defined(DEBUG) && !defined(LOCAL_DEBUG) +#if defined(DEBUG) #define LOCAL_DEBUG // Propagate debug level #define LOCAL_INFO @@ -57,9 +69,6 @@ IRCommandDispatcher IRDispatcher; -#if defined(USE_TINY_IR_RECEIVER) -#include "TinyIRReceiver.hpp" // included in "IRremote" library - #if defined(LOCAL_INFO) #define CD_INFO_PRINT(...) Serial.print(__VA_ARGS__); #define CD_INFO_PRINTLN(...) Serial.println(__VA_ARGS__); @@ -68,33 +77,43 @@ IRCommandDispatcher IRDispatcher; #define CD_INFO_PRINTLN(...) void(); #endif +#if defined(USE_TINY_IR_RECEIVER) +#define USE_CALLBACK_FOR_TINY_RECEIVER // Call the user provided function "void handleReceivedTinyIRData()" each time a frame or repeat is received. +#include "TinyIRReceiver.hpp" // included in "IRremote" library + void IRCommandDispatcher::init() { initPCIInterruptForTinyReceiver(); } /* - * This is the TinyReceiver callback function which is called if a complete command was received + * @return true, if IR Receiver is attached + */ +void IRCommandDispatcher::printIRInfo(Print *aSerial) { + aSerial->println(); + // For available IR commands see IRCommandMapping.h https://github.com/ArminJo/PWMMotorControl/blob/master/examples/SmartCarFollower/IRCommandMapping.h + aSerial->print(F("Listening to IR remote of type ")); + aSerial->print(IR_REMOTE_NAME); + aSerial->println(F(" at pin " STR(IR_RECEIVE_PIN))); +} + +/* + * This is the TinyReceiver callback function, which is called if a complete command was received * It checks for right address and then call the dispatcher */ -#if defined(ESP8266) || defined(ESP32) +# if defined(ESP8266) || defined(ESP32) IRAM_ATTR -#endif -void handleReceivedTinyIRData(uint8_t aAddress, uint8_t aCommand, uint8_t aFlags) { - IRDispatcher.IRReceivedData.address = aAddress; - IRDispatcher.IRReceivedData.command = aCommand; - IRDispatcher.IRReceivedData.isRepeat = aFlags & IRDATA_FLAGS_IS_REPEAT; +# endif +void handleReceivedTinyIRData() { + IRDispatcher.IRReceivedData.address = TinyIRReceiverData.Address; + IRDispatcher.IRReceivedData.command = TinyIRReceiverData.Command; + IRDispatcher.IRReceivedData.isRepeat = TinyIRReceiverData.Flags & IRDATA_FLAGS_IS_REPEAT; IRDispatcher.IRReceivedData.MillisOfLastCode = millis(); - CD_INFO_PRINT(F("A=0x")); - CD_INFO_PRINT(aAddress, HEX); - CD_INFO_PRINT(F(" C=0x")); - CD_INFO_PRINT(aCommand, HEX); - if (IRDispatcher.IRReceivedData.isRepeat) { - CD_INFO_PRINT(F("R")); - } - CD_INFO_PRINTLN(); +# if defined(LOCAL_INFO) + printTinyReceiverResultMinimal(&Serial); +# endif - if (aAddress == IR_ADDRESS) { // IR_ADDRESS is defined in *IRCommandMapping.h + if (TinyIRReceiverData.Address == IR_ADDRESS) { // IR_ADDRESS is defined in *IRCommandMapping.h IRDispatcher.IRReceivedData.isAvailable = true; if(!IRDispatcher.doNotUseDispatcher) { /* @@ -120,7 +139,7 @@ void IRCommandDispatcher::init() { } /* - * This is the callback function which is called if a complete command was received + * This is the callback function, which is called if a complete command was received */ #if defined(ESP8266) || defined(ESP32) IRAM_ATTR @@ -157,11 +176,11 @@ void handleReceivedIRData() { #endif // elif defined(USE_IRMP_LIBRARY) /* - * The main dispatcher function - * Sets flags justCalledRegularIRCommand, executingBlockingCommand - * @param aCallBlockingCommandImmediately Run blocking command directly, otherwise set request to stop to true - * and store command for main loop to execute by checkAndRunSuspendedBlockingCommands(). - * Should be false if called by ISR. + * The main dispatcher function called by IR-ISR, main loop and checkAndRunSuspendedBlockingCommands() + * Non blocking commands are executed directly, blocking commands are executed if enabled by parameter and no other command is just running. + * Otherwise request to stop (requestToStopReceived) is set and command is stored for main loop to be later execute by checkAndRunSuspendedBlockingCommands(). + * Sets flags justCalledRegularIRCommand, executingBlockingCommand, requestToStopReceived + * @param aCallBlockingCommandImmediately Run blocking command directly, if no other command is just running. Should be false if called by ISR in order not to block ISR. */ void IRCommandDispatcher::checkAndCallCommand(bool aCallBlockingCommandImmediately) { if (IRReceivedData.command == COMMAND_EMPTY) { @@ -204,21 +223,31 @@ void IRCommandDispatcher::checkAndCallCommand(bool aCallBlockingCommandImmediate } /* - * lets start a new turn + * Execute commands */ - requestToStopReceived = false; - bool tIsNonBlockingCommand = (IRMapping[i].Flags & IR_COMMAND_FLAG_NON_BLOCKING); if (tIsNonBlockingCommand) { // short command here, just call CD_INFO_PRINT(F("Run non blocking command: ")); - CD_INFO_PRINTLN (tCommandName); + CD_INFO_PRINTLN(tCommandName); +#if defined(BUZZER_PIN) && defined(USE_TINY_IR_RECEIVER) + /* + * Do (non blocking) buzzer feedback before command is executed + */ + if(IRMapping[i].Flags & IR_COMMAND_FLAG_BEEP) { + tone(BUZZER_PIN, 2200, 50); + } +#endif IRMapping[i].CommandToCall(); } else { + /* + * Blocking command here + */ if (aCallBlockingCommandImmediately && currentBlockingCommandCalled == COMMAND_EMPTY) { /* - * here we are called from main loop to execute a command + * Here no blocking command was running and we are called from main loop */ + requestToStopReceived = false; // Do not stop the command executed now justCalledBlockingCommand = true; currentBlockingCommandCalled = IRReceivedData.command; // set lock for recursive calls lastBlockingCommandCalled = IRReceivedData.command; // set history, can be evaluated by main loop @@ -226,7 +255,16 @@ void IRCommandDispatcher::checkAndCallCommand(bool aCallBlockingCommandImmediate * This call is blocking!!! */ CD_INFO_PRINT(F("Run blocking command: ")); - CD_INFO_PRINTLN (tCommandName); + CD_INFO_PRINTLN(tCommandName); + +#if defined(BUZZER_PIN) && defined(USE_TINY_IR_RECEIVER) + /* + * Do (non blocking) buzzer feedback before command is executed + */ + if(IRMapping[i].Flags & IR_COMMAND_FLAG_BEEP) { + tone(BUZZER_PIN, 2200, 50); + } +#endif IRMapping[i].CommandToCall(); #if defined(TRACE) @@ -235,12 +273,14 @@ void IRCommandDispatcher::checkAndCallCommand(bool aCallBlockingCommandImmediate currentBlockingCommandCalled = COMMAND_EMPTY; } else { /* - * Do not run command directly, but set request to stop to true and store command for main loop to execute + * Called by ISR or another command still running. + * Do not run command directly, but set request to stop to true and store command + * for main loop to execute by checkAndRunSuspendedBlockingCommands() */ BlockingCommandToRunNext = IRReceivedData.command; requestToStopReceived = true; // to stop running command CD_INFO_PRINT(F("Requested stop and stored blocking command ")); - CD_INFO_PRINT (tCommandName); + CD_INFO_PRINT(tCommandName); CD_INFO_PRINTLN(F(" as next command to run.")); } } @@ -260,25 +300,29 @@ bool IRCommandDispatcher::checkAndRunSuspendedBlockingCommands() { */ if (BlockingCommandToRunNext != COMMAND_EMPTY) { - CD_INFO_PRINT(F("Take stored command = 0x")); + CD_INFO_PRINT(F("Run stored command=0x")); CD_INFO_PRINTLN(BlockingCommandToRunNext, HEX); IRReceivedData.command = BlockingCommandToRunNext; BlockingCommandToRunNext = COMMAND_EMPTY; IRReceivedData.isRepeat = false; + requestToStopReceived = false; // Do not stop the command executed now checkAndCallCommand(true); return true; } return false; } +/* + * Not used internally + */ #if defined(IR_COMMAND_HAS_MORE_THAN_8_BIT) void IRCommandDispatcher::setNextBlockingCommand(uint16_t aBlockingCommandToRunNext) #else void IRCommandDispatcher::setNextBlockingCommand(uint8_t aBlockingCommandToRunNext) #endif { - CD_INFO_PRINT(F("Set next command to 0x")); + CD_INFO_PRINT(F("Set next command to run to 0x")); CD_INFO_PRINTLN(aBlockingCommandToRunNext, HEX); BlockingCommandToRunNext = aBlockingCommandToRunNext; requestToStopReceived = true; @@ -300,7 +344,6 @@ bool IRCommandDispatcher::delayAndCheckForStop(uint16_t aDelayMillis) { } void IRCommandDispatcher::printIRCommandString(Print *aSerial) { - aSerial->print(F("IRCommand=")); for (uint_fast8_t i = 0; i < sizeof(IRMapping) / sizeof(struct IRToCommandMappingStruct); ++i) { if (IRReceivedData.command == IRMapping[i].IRCode) { aSerial->println(reinterpret_cast(IRMapping[i].CommandString)); diff --git a/examples/IRDispatcherDemo/IRDispatcherDemo.ino b/examples/IRDispatcherDemo/IRDispatcherDemo.ino index 8a66d4fc8..6df3321ab 100644 --- a/examples/IRDispatcherDemo/IRDispatcherDemo.ino +++ b/examples/IRDispatcherDemo/IRDispatcherDemo.ino @@ -49,37 +49,11 @@ #if defined(USE_TINY_IR_RECEIVER) //#define NO_LED_FEEDBACK_CODE // Activate this if you want to suppress LED feedback or if you do not have a LED. This saves 14 bytes code and 2 clock cycles per interrupt. -/* - * Set sensible receive pin for different CPU's - */ -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) || defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) -#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" -# if defined(ARDUINO_AVR_DIGISPARKPRO) -#define IR_INPUT_PIN 9 // PA3 - on Digispark board labeled as pin 9 -# else -#define IR_INPUT_PIN 0 // PCINT0 -# endif -# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) -#define IR_INPUT_PIN 10 -# elif (defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)) -#define IR_INPUT_PIN 21 // INT0 -# elif defined(ESP8266) -#define IR_INPUT_PIN 14 // D5 -# elif defined(ESP32) -#define IR_INPUT_PIN 15 -# elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) -#define IR_INPUT_PIN 3 // GPIO15 Use pin 3 since pin 2|GPIO25 is connected to LED on Pi pico -# elif defined(ARDUINO_ARCH_RP2040) // Pi Pico with arduino-pico core https://github.com/earlephilhower/arduino-pico -#define IR_INPUT_PIN 15 // to be compatible with the Arduino Nano RP2040 Connect (pin3) -# else -#define IR_INPUT_PIN 2 // INT0 -# endif - #elif defined(USE_IRMP_LIBRARY) /* * IRMP version */ -#define IR_INPUT_PIN 2 +#define IR_RECEIVE_PIN 2 #define IRMP_USE_COMPLETE_CALLBACK 1 // Enable callback functionality. It is required if IRMP library is used. #if defined(ALTERNATIVE_IR_FEEDBACK_LED_PIN) #define FEEDBACK_LED_PIN ALTERNATIVE_IR_FEEDBACK_LED_PIN @@ -135,7 +109,9 @@ void doTone2200(); void setup() { pinMode(LED_BUILTIN, OUTPUT); Serial.begin(115200); -#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/|| defined(SERIALUSB_PID) || defined(ARDUINO_attiny3217) + +#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/ \ + || defined(SERIALUSB_PID) || defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_attiny3217) delay(4000); // To be able to connect Serial monitor after reset or power up and before first print out. Do not wait for an attached Serial Monitor! #endif #if defined(ESP8266) @@ -159,7 +135,7 @@ void setup() { IRDispatcher.init(); // This just calls irmp_init() #if defined(USE_TINY_IR_RECEIVER) - Serial.println(F("Ready to receive NEC IR signals at pin " STR(IR_INPUT_PIN))); + Serial.println(F("Ready to receive NEC IR signals at pin " STR(IR_RECEIVE_PIN))); #else irmp_register_complete_callback_function(&handleReceivedIRData); // fixed function in IRCommandDispatcher.hpp @@ -189,8 +165,7 @@ void loop() { DELAY_AND_RETURN_IF_STOP(sBlinkDelay); } - if (millis() - IRDispatcher.IRReceivedData.MillisOfLastCode > 120000) - { + if (millis() - IRDispatcher.IRReceivedData.MillisOfLastCode > 120000) { //Short beep as remainder, if we did not receive any command in the last 2 minutes IRDispatcher.IRReceivedData.MillisOfLastCode += 120000; doTone1800(); @@ -199,7 +174,7 @@ void loop() { // delay(10); } -void doPrintMenu(){ +void doPrintMenu() { Serial.println(); Serial.println(F("Press 1 for tone 1800 Hz")); Serial.println(F("Press 2 for tone 2200 Hz")); @@ -257,7 +232,6 @@ void doLedBlink20times() { } } - void doTone1800() { #if defined(USE_IRMP_LIBRARY) && !defined(IRMP_ENABLE_PIN_CHANGE_INTERRUPT) irmp_tone(TONE_PIN, 1800, 200); diff --git a/examples/IRDispatcherDemo/PinDefinitionsAndMore.h b/examples/IRDispatcherDemo/PinDefinitionsAndMore.h index cb2b3b86d..b13414f56 100644 --- a/examples/IRDispatcherDemo/PinDefinitionsAndMore.h +++ b/examples/IRDispatcherDemo/PinDefinitionsAndMore.h @@ -4,7 +4,7 @@ * Contains pin definitions for IRremote examples for various platforms * as well as definitions for feedback LED and tone() and includes * - * Copyright (C) 2021-2022 Armin Joachimsmeyer + * Copyright (C) 2021-2023 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. @@ -32,81 +32,97 @@ * DEFAULT/AVR 2 3 4 Arduino * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore - * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark pro - * ATtiny3217 18|PA1 19|PA2 20|PA3 MegaTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore * ATtiny1604 2 3|PA5 % * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore - * SAMD21 3 4 5 + * MKR* 1 3 4 + * SAMD 2 3 4 * ESP8266 14|D5 12|D6 % - * ESP32 15 4 27 - * BluePill PA6 PA7 PA3 + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 * APOLLO3 11 12 5 * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 */ //#define _IR_MEASURE_TIMING // For debugging purposes. #if defined(__AVR__) -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board -#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore -#define IR_RECEIVE_PIN 0 -#define IR_SEND_PIN 4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. -#define TONE_PIN 3 -#define _IR_TIMING_TEST_PIN 3 +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 # elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board #include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" // For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. # if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core #define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 //#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards #define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 #define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 #define _IR_TIMING_TEST_PIN 10 // PA4 # else -#define IR_RECEIVE_PIN 3 // PA3 - on Digispark board labeled as pin 9 -#define IR_SEND_PIN 2 // PA2 - on Digispark board labeled as pin 8 -#define TONE_PIN 7 // PA7 - on Digispark board labeled as pin 5 +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 # endif -# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board -#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory -// Pin 6 is TX pin 7 is RX -#define IR_RECEIVE_PIN 3 // INT1 -#define IR_SEND_PIN 4 -#define TONE_PIN 9 -#define _IR_TIMING_TEST_PIN 8 - -# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // Tiny Core Dev board -#define IR_RECEIVE_PIN 18 -#define IR_SEND_PIN 19 -#define TONE_PIN 20 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output -#define LED_BUILTIN 2 // PA6 - -# elif defined(__AVR_ATtiny816__) // Tiny Core Micro -#define IR_RECEIVE_PIN 14 // PA1 -#define IR_SEND_PIN 16 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output -#define LED_BUILTIN 4 // PB5 - -# elif defined(__AVR_ATtiny1614__) -#define IR_RECEIVE_PIN 8 // PA1 -#define IR_SEND_PIN 10 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 - -# elif defined(__AVR_ATtiny1604__) -#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. -#define IR_SEND_PIN 3 -#define APPLICATION_PIN 5 +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 #define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it +#define TONE_PIN 42 // Dummy for examples using it # elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ || defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ @@ -139,6 +155,15 @@ # endif # endif // defined(__AVR_ATtiny25__)... +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + #elif defined(ESP8266) #define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW #define IR_RECEIVE_PIN 14 // D5 @@ -148,21 +173,32 @@ #define tone(...) void() // tone() inhibits receive timer #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it - -#elif defined(CONFIG_IDF_TARGET_ESP32C3) -#define IR_INPUT_PIN 8 -#define IR_SEND_PIN 9 -#define TONE_PIN 10 // ADC2_0 -#define APPLICATION_PIN 11 +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 #elif defined(ESP32) #include // tone() is included in ESP32 core since 2.0.2 -#if !defined(ESP_ARDUINO_VERSION_VAL) -#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) 12345678 -#endif +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif #if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) #define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. void tone(uint8_t aPinNumber, unsigned int aFrequency){ @@ -205,7 +241,8 @@ void noTone(uint8_t aPinNumber){ #define IR_SEND_PIN 12 #define TONE_PIN 5 -#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect #define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico #define IR_SEND_PIN 4 // GPIO16 #define TONE_PIN 5 @@ -252,14 +289,18 @@ void noTone(uint8_t aPinNumber){ #define _IR_TIMING_TEST_PIN 7 #elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else #define IR_RECEIVE_PIN 2 +# endif #define IR_SEND_PIN 3 #define TONE_PIN 4 #define APPLICATION_PIN 5 #define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. #define _IR_TIMING_TEST_PIN 7 -#if !defined(ARDUINO_SAMD_ADAFRUIT) +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) // On the Zero and others we switch explicitly to SerialUSB #define Serial SerialUSB #endif @@ -299,19 +340,13 @@ void noTone(uint8_t aPinNumber){ #define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation #else # if defined(SEND_PWM_BY_TIMER) -#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warning in IRTimer.hpp +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp # endif #endif #if !defined (FLASHEND) #define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined #endif -#if !defined (RAMEND) -#define RAMEND 0xFFFF // Dummy value for platforms where RAMEND is not defined -#endif -#if !defined (RAMSIZE) -#define RAMSIZE 0xFFFF // Dummy value for platforms where RAMSIZE is not defined -#endif /* * Helper macro for getting a macro definition as string diff --git a/examples/IRremoteExtensionTest/IRremoteExtensionClass.cpp b/examples/IRremoteExtensionTest/IRremoteExtensionClass.cpp index 328db5b8d..ef95f8fe0 100644 --- a/examples/IRremoteExtensionTest/IRremoteExtensionClass.cpp +++ b/examples/IRremoteExtensionTest/IRremoteExtensionClass.cpp @@ -8,7 +8,7 @@ ************************************************************************************ * MIT License * - * Copyright (c) 2021 Armin Joachimsmeyer + * Copyright (c) 2021-2024 Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -31,11 +31,32 @@ */ #include +/* + * !!! The value of RAW_BUFFER_LENGTH (and some other macros) must be the same in all compile units !!! + * Otherwise you may get warnings like "type 'struct IRData' itself violates the C++ One Definition Rule" + */ +#if !defined(RAW_BUFFER_LENGTH) +// For air condition remotes it may require up to 750. Default is 200. +# if (defined(RAMEND) && RAMEND <= 0x4FF) || (defined(RAMSIZE) && RAMSIZE < 0x4FF) +#define RAW_BUFFER_LENGTH 360 +# elif (defined(RAMEND) && RAMEND <= 0x8FF) || (defined(RAMSIZE) && RAMSIZE < 0x8FF) +#define RAW_BUFFER_LENGTH 750 +# endif +#endif + #include "IRremoteExtensionClass.h" IRExtensionClass::IRExtensionClass(IRrecv *aIrReceiver) { MyIrReceiver = aIrReceiver; } +bool IRExtensionClass::decode() { + return MyIrReceiver->decode(); +} + +bool IRExtensionClass::printIRResultShort(Print *aSerial, bool aCheckForRecordGapsMicros) { + return MyIrReceiver->printIRResultShort(aSerial, aCheckForRecordGapsMicros); +} + void IRExtensionClass::resume() { Serial.println(F("Call resume()")); MyIrReceiver->resume(); diff --git a/examples/IRremoteExtensionTest/IRremoteExtensionClass.h b/examples/IRremoteExtensionTest/IRremoteExtensionClass.h index 5c50fd5e4..73e8c5f69 100644 --- a/examples/IRremoteExtensionTest/IRremoteExtensionClass.h +++ b/examples/IRremoteExtensionTest/IRremoteExtensionClass.h @@ -8,7 +8,7 @@ ************************************************************************************ * MIT License * - * Copyright (c) 2021 Armin Joachimsmeyer + * Copyright (c) 2021-2024 Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -39,6 +39,8 @@ class IRExtensionClass public: IRrecv * MyIrReceiver; IRExtensionClass(IRrecv * aIrReceiver); + bool decode(); + bool printIRResultShort(Print *aSerial, bool aCheckForRecordGapsMicros = true); void resume(); }; diff --git a/examples/IRremoteExtensionTest/IRremoteExtensionTest.ino b/examples/IRremoteExtensionTest/IRremoteExtensionTest.ino index 65b42c03c..50bea009f 100644 --- a/examples/IRremoteExtensionTest/IRremoteExtensionTest.ino +++ b/examples/IRremoteExtensionTest/IRremoteExtensionTest.ino @@ -33,12 +33,11 @@ #include "PinDefinitionsAndMore.h" // Define macros for input and output pin etc. #if !defined(RAW_BUFFER_LENGTH) -# if RAMEND <= 0x4FF || RAMSIZE < 0x4FF -#define RAW_BUFFER_LENGTH 180 // 750 (600 if we have only 2k RAM) is the value for air condition remotes. Default is 112 if DECODE_MAGIQUEST is enabled, otherwise 100. -# elif RAMEND <= 0x8FF || RAMSIZE < 0x8FF -#define RAW_BUFFER_LENGTH 500 // 750 (600 if we have only 2k RAM) is the value for air condition remotes. Default is 112 if DECODE_MAGIQUEST is enabled, otherwise 100. +// For air condition remotes it may require up to 750. Default is 200. +# if (defined(RAMEND) && RAMEND <= 0x4FF) || (defined(RAMSIZE) && RAMSIZE < 0x4FF) +#define RAW_BUFFER_LENGTH 360 # else -#define RAW_BUFFER_LENGTH 750 // 750 (600 if we have only 2k RAM) is the value for air condition remotes. Default is 112 if DECODE_MAGIQUEST is enabled, otherwise 100. +#define RAW_BUFFER_LENGTH 750 # endif #endif @@ -53,8 +52,15 @@ IRExtensionClass IRExtension(&IrReceiver); void setup() { Serial.begin(115200); -#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/|| defined(SERIALUSB_PID) || defined(ARDUINO_attiny3217) - delay(4000); // To be able to connect Serial monitor after reset or power up and before first print out. Do not wait for an attached Serial Monitor! + +#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/ \ + || defined(SERIALUSB_PID) || defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_attiny3217) + // Wait until Serial Monitor is attached. + // Required for boards using USB code for Serial like Leonardo. + // Is void for USB Serial implementations using external chips e.g. a CH340. + while (!Serial) + ; + // !!! Program will not proceed if no Serial Monitor is attached !!! #endif // Just to know which program is running on my Arduino Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE)); @@ -62,7 +68,6 @@ void setup() { // Start the receiver and if not 3. parameter specified, take LED_BUILTIN pin from the internal boards definition as default feedback LED IrReceiver.begin(IR_RECEIVE_PIN, ENABLE_LED_FEEDBACK); - Serial.print(F("Ready to receive IR signals of protocols: ")); printActiveIRProtocols(&Serial); Serial.println(F("at pin " STR(IR_RECEIVE_PIN))); @@ -70,8 +75,8 @@ void setup() { } void loop() { - if (IrReceiver.decode()) { - IrReceiver.printIRResultShort(&Serial); + if (IRExtension.decode()) { + IRExtension.printIRResultShort(&Serial); IrReceiver.printIRSendUsage(&Serial); IRExtension.resume(); // Use the extended function provided by IRExtension class } diff --git a/examples/IRremoteExtensionTest/PinDefinitionsAndMore.h b/examples/IRremoteExtensionTest/PinDefinitionsAndMore.h index cb2b3b86d..b13414f56 100644 --- a/examples/IRremoteExtensionTest/PinDefinitionsAndMore.h +++ b/examples/IRremoteExtensionTest/PinDefinitionsAndMore.h @@ -4,7 +4,7 @@ * Contains pin definitions for IRremote examples for various platforms * as well as definitions for feedback LED and tone() and includes * - * Copyright (C) 2021-2022 Armin Joachimsmeyer + * Copyright (C) 2021-2023 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. @@ -32,81 +32,97 @@ * DEFAULT/AVR 2 3 4 Arduino * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore - * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark pro - * ATtiny3217 18|PA1 19|PA2 20|PA3 MegaTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore * ATtiny1604 2 3|PA5 % * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore - * SAMD21 3 4 5 + * MKR* 1 3 4 + * SAMD 2 3 4 * ESP8266 14|D5 12|D6 % - * ESP32 15 4 27 - * BluePill PA6 PA7 PA3 + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 * APOLLO3 11 12 5 * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 */ //#define _IR_MEASURE_TIMING // For debugging purposes. #if defined(__AVR__) -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board -#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore -#define IR_RECEIVE_PIN 0 -#define IR_SEND_PIN 4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. -#define TONE_PIN 3 -#define _IR_TIMING_TEST_PIN 3 +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 # elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board #include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" // For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. # if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core #define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 //#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards #define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 #define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 #define _IR_TIMING_TEST_PIN 10 // PA4 # else -#define IR_RECEIVE_PIN 3 // PA3 - on Digispark board labeled as pin 9 -#define IR_SEND_PIN 2 // PA2 - on Digispark board labeled as pin 8 -#define TONE_PIN 7 // PA7 - on Digispark board labeled as pin 5 +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 # endif -# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board -#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory -// Pin 6 is TX pin 7 is RX -#define IR_RECEIVE_PIN 3 // INT1 -#define IR_SEND_PIN 4 -#define TONE_PIN 9 -#define _IR_TIMING_TEST_PIN 8 - -# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // Tiny Core Dev board -#define IR_RECEIVE_PIN 18 -#define IR_SEND_PIN 19 -#define TONE_PIN 20 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output -#define LED_BUILTIN 2 // PA6 - -# elif defined(__AVR_ATtiny816__) // Tiny Core Micro -#define IR_RECEIVE_PIN 14 // PA1 -#define IR_SEND_PIN 16 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output -#define LED_BUILTIN 4 // PB5 - -# elif defined(__AVR_ATtiny1614__) -#define IR_RECEIVE_PIN 8 // PA1 -#define IR_SEND_PIN 10 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 - -# elif defined(__AVR_ATtiny1604__) -#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. -#define IR_SEND_PIN 3 -#define APPLICATION_PIN 5 +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 #define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it +#define TONE_PIN 42 // Dummy for examples using it # elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ || defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ @@ -139,6 +155,15 @@ # endif # endif // defined(__AVR_ATtiny25__)... +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + #elif defined(ESP8266) #define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW #define IR_RECEIVE_PIN 14 // D5 @@ -148,21 +173,32 @@ #define tone(...) void() // tone() inhibits receive timer #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it - -#elif defined(CONFIG_IDF_TARGET_ESP32C3) -#define IR_INPUT_PIN 8 -#define IR_SEND_PIN 9 -#define TONE_PIN 10 // ADC2_0 -#define APPLICATION_PIN 11 +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 #elif defined(ESP32) #include // tone() is included in ESP32 core since 2.0.2 -#if !defined(ESP_ARDUINO_VERSION_VAL) -#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) 12345678 -#endif +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif #if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) #define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. void tone(uint8_t aPinNumber, unsigned int aFrequency){ @@ -205,7 +241,8 @@ void noTone(uint8_t aPinNumber){ #define IR_SEND_PIN 12 #define TONE_PIN 5 -#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect #define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico #define IR_SEND_PIN 4 // GPIO16 #define TONE_PIN 5 @@ -252,14 +289,18 @@ void noTone(uint8_t aPinNumber){ #define _IR_TIMING_TEST_PIN 7 #elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else #define IR_RECEIVE_PIN 2 +# endif #define IR_SEND_PIN 3 #define TONE_PIN 4 #define APPLICATION_PIN 5 #define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. #define _IR_TIMING_TEST_PIN 7 -#if !defined(ARDUINO_SAMD_ADAFRUIT) +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) // On the Zero and others we switch explicitly to SerialUSB #define Serial SerialUSB #endif @@ -299,19 +340,13 @@ void noTone(uint8_t aPinNumber){ #define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation #else # if defined(SEND_PWM_BY_TIMER) -#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warning in IRTimer.hpp +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp # endif #endif #if !defined (FLASHEND) #define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined #endif -#if !defined (RAMEND) -#define RAMEND 0xFFFF // Dummy value for platforms where RAMEND is not defined -#endif -#if !defined (RAMSIZE) -#define RAMSIZE 0xFFFF // Dummy value for platforms where RAMSIZE is not defined -#endif /* * Helper macro for getting a macro definition as string diff --git a/examples/IRremoteInfo/IRremoteInfo.ino b/examples/IRremoteInfo/IRremoteInfo.ino index 22ae75fbb..25d0f09d9 100644 --- a/examples/IRremoteInfo/IRremoteInfo.ino +++ b/examples/IRremoteInfo/IRremoteInfo.ino @@ -34,9 +34,17 @@ void dumpFooter(); void setup() { Serial.begin(115200); -#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/|| defined(SERIALUSB_PID) || defined(ARDUINO_attiny3217) - delay(4000); // To be able to connect Serial monitor after reset or power up and before first print out. Do not wait for an attached Serial Monitor! + +#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/ \ + || defined(SERIALUSB_PID) || defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_attiny3217) + // Wait until Serial Monitor is attached. + // Required for boards using USB code for Serial like Leonardo. + // Is void for USB Serial implementations using external chips e.g. a CH340. + while (!Serial) + ; + // !!! Program will not proceed if no Serial Monitor is attached !!! #endif + // Just to know which program is running on my Arduino Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE)); @@ -193,7 +201,7 @@ void dumpPulseParams() { ; Serial.println(F(" uSecs")); Serial.print(F("Measurement tolerance: ")); - Serial.print(TOLERANCE_FOR_DECODERS_MARK_OR_SPACE_MATCHING); + Serial.print(TOLERANCE_FOR_DECODERS_MARK_OR_SPACE_MATCHING_PERCENT); Serial.println(F("%")); } diff --git a/examples/MicroGirs/MicroGirs.ino b/examples/MicroGirs/MicroGirs.ino index a840bf240..ca2a9b18a 100644 --- a/examples/MicroGirs/MicroGirs.ino +++ b/examples/MicroGirs/MicroGirs.ino @@ -67,12 +67,11 @@ #include "PinDefinitionsAndMore.h" // Define macros for input and output pin etc. #if !defined(RAW_BUFFER_LENGTH) -# if RAMEND <= 0x4FF || RAMSIZE < 0x4FF -#define RAW_BUFFER_LENGTH 180 // 750 (600 if we have only 2k RAM) is the value for air condition remotes. Default is 112 if DECODE_MAGIQUEST is enabled, otherwise 100. -# elif RAMEND <= 0x8FF || RAMSIZE < 0x8FF -#define RAW_BUFFER_LENGTH 500 // 750 (600 if we have only 2k RAM) is the value for air condition remotes. Default is 112 if DECODE_MAGIQUEST is enabled, otherwise 100. +// For air condition remotes it may require up to 750. Default is 200. +# if (defined(RAMEND) && RAMEND <= 0x4FF) || (defined(RAMSIZE) && RAMSIZE < 0x4FF) +#define RAW_BUFFER_LENGTH 360 # else -#define RAW_BUFFER_LENGTH 750 // 750 (600 if we have only 2k RAM) is the value for air condition remotes. Default is 112 if DECODE_MAGIQUEST is enabled, otherwise 100. +#define RAW_BUFFER_LENGTH 750 # endif #endif @@ -190,8 +189,7 @@ String Tokenizer::getRest() { } String Tokenizer::getLine() { - if (index == invalidIndex) - return String(""); + if (index == invalidIndex) return String(""); int i = payload.indexOf('\n', index); String s = (i > 0) ? payload.substring(index, i) : payload.substring(index); @@ -200,16 +198,13 @@ String Tokenizer::getLine() { } String Tokenizer::getToken() { - if (index < 0) - return String(""); + if (index < 0) return String(""); int i = payload.indexOf(' ', index); String s = (i > 0) ? payload.substring(index, i) : payload.substring(index); index = (i > 0) ? i : invalidIndex; - if (index != invalidIndex) - if (index != invalidIndex) - while (payload.charAt(index) == ' ') - index++; + if (index != invalidIndex) if (index != invalidIndex) while (payload.charAt(index) == ' ') + index++; return s; } @@ -253,13 +248,10 @@ static inline unsigned hz2khz(frequency_t hz) { */ static void sendRaw(const microseconds_t intro[], unsigned lengthIntro, const microseconds_t repeat[], unsigned lengthRepeat, const microseconds_t ending[], unsigned lengthEnding, frequency_t frequency, unsigned times) { - if (lengthIntro > 0U) - IrSender.sendRaw(intro, lengthIntro, hz2khz(frequency)); - if (lengthRepeat > 0U) - for (unsigned i = 0U; i < times - (lengthIntro > 0U); i++) - IrSender.sendRaw(repeat, lengthRepeat, hz2khz(frequency)); - if (lengthEnding > 0U) - IrSender.sendRaw(ending, lengthEnding, hz2khz(frequency)); + if (lengthIntro > 0U) IrSender.sendRaw(intro, lengthIntro, hz2khz(frequency)); + if (lengthRepeat > 0U) for (unsigned i = 0U; i < times - (lengthIntro > 0U); i++) + IrSender.sendRaw(repeat, lengthRepeat, hz2khz(frequency)); + if (lengthEnding > 0U) IrSender.sendRaw(ending, lengthEnding, hz2khz(frequency)); } #endif // TRANSMIT @@ -300,8 +292,6 @@ static void receive(Stream &stream) { */ void setup() { Serial.begin(BAUDRATE); - while (!Serial) - ; // wait for serial port to connect. Serial.println(F(PROGNAME " " VERSION)); // Just to know which program is running on my Arduino @@ -317,7 +307,7 @@ void setup() { #endif #if defined(IR_SEND_PIN) - IrSender.begin(); // Start with IR_SEND_PIN as send pin and enable feedback LED at default feedback LED pin + IrSender.begin(); // Start with IR_SEND_PIN -which is defined in PinDefinitionsAndMore.h- as send pin and enable feedback LED at default feedback LED pin #else IrSender.begin(3, ENABLE_LED_FEEDBACK, USE_DEFAULT_FEEDBACK_LED_PIN); // Specify send pin and enable feedback LED at default feedback LED pin #endif diff --git a/examples/MicroGirs/PinDefinitionsAndMore.h b/examples/MicroGirs/PinDefinitionsAndMore.h index cb2b3b86d..b13414f56 100644 --- a/examples/MicroGirs/PinDefinitionsAndMore.h +++ b/examples/MicroGirs/PinDefinitionsAndMore.h @@ -4,7 +4,7 @@ * Contains pin definitions for IRremote examples for various platforms * as well as definitions for feedback LED and tone() and includes * - * Copyright (C) 2021-2022 Armin Joachimsmeyer + * Copyright (C) 2021-2023 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. @@ -32,81 +32,97 @@ * DEFAULT/AVR 2 3 4 Arduino * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore - * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark pro - * ATtiny3217 18|PA1 19|PA2 20|PA3 MegaTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore * ATtiny1604 2 3|PA5 % * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore - * SAMD21 3 4 5 + * MKR* 1 3 4 + * SAMD 2 3 4 * ESP8266 14|D5 12|D6 % - * ESP32 15 4 27 - * BluePill PA6 PA7 PA3 + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 * APOLLO3 11 12 5 * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 */ //#define _IR_MEASURE_TIMING // For debugging purposes. #if defined(__AVR__) -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board -#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore -#define IR_RECEIVE_PIN 0 -#define IR_SEND_PIN 4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. -#define TONE_PIN 3 -#define _IR_TIMING_TEST_PIN 3 +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 # elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board #include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" // For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. # if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core #define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 //#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards #define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 #define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 #define _IR_TIMING_TEST_PIN 10 // PA4 # else -#define IR_RECEIVE_PIN 3 // PA3 - on Digispark board labeled as pin 9 -#define IR_SEND_PIN 2 // PA2 - on Digispark board labeled as pin 8 -#define TONE_PIN 7 // PA7 - on Digispark board labeled as pin 5 +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 # endif -# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board -#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory -// Pin 6 is TX pin 7 is RX -#define IR_RECEIVE_PIN 3 // INT1 -#define IR_SEND_PIN 4 -#define TONE_PIN 9 -#define _IR_TIMING_TEST_PIN 8 - -# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // Tiny Core Dev board -#define IR_RECEIVE_PIN 18 -#define IR_SEND_PIN 19 -#define TONE_PIN 20 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output -#define LED_BUILTIN 2 // PA6 - -# elif defined(__AVR_ATtiny816__) // Tiny Core Micro -#define IR_RECEIVE_PIN 14 // PA1 -#define IR_SEND_PIN 16 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output -#define LED_BUILTIN 4 // PB5 - -# elif defined(__AVR_ATtiny1614__) -#define IR_RECEIVE_PIN 8 // PA1 -#define IR_SEND_PIN 10 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 - -# elif defined(__AVR_ATtiny1604__) -#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. -#define IR_SEND_PIN 3 -#define APPLICATION_PIN 5 +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 #define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it +#define TONE_PIN 42 // Dummy for examples using it # elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ || defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ @@ -139,6 +155,15 @@ # endif # endif // defined(__AVR_ATtiny25__)... +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + #elif defined(ESP8266) #define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW #define IR_RECEIVE_PIN 14 // D5 @@ -148,21 +173,32 @@ #define tone(...) void() // tone() inhibits receive timer #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it - -#elif defined(CONFIG_IDF_TARGET_ESP32C3) -#define IR_INPUT_PIN 8 -#define IR_SEND_PIN 9 -#define TONE_PIN 10 // ADC2_0 -#define APPLICATION_PIN 11 +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 #elif defined(ESP32) #include // tone() is included in ESP32 core since 2.0.2 -#if !defined(ESP_ARDUINO_VERSION_VAL) -#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) 12345678 -#endif +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif #if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) #define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. void tone(uint8_t aPinNumber, unsigned int aFrequency){ @@ -205,7 +241,8 @@ void noTone(uint8_t aPinNumber){ #define IR_SEND_PIN 12 #define TONE_PIN 5 -#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect #define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico #define IR_SEND_PIN 4 // GPIO16 #define TONE_PIN 5 @@ -252,14 +289,18 @@ void noTone(uint8_t aPinNumber){ #define _IR_TIMING_TEST_PIN 7 #elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else #define IR_RECEIVE_PIN 2 +# endif #define IR_SEND_PIN 3 #define TONE_PIN 4 #define APPLICATION_PIN 5 #define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. #define _IR_TIMING_TEST_PIN 7 -#if !defined(ARDUINO_SAMD_ADAFRUIT) +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) // On the Zero and others we switch explicitly to SerialUSB #define Serial SerialUSB #endif @@ -299,19 +340,13 @@ void noTone(uint8_t aPinNumber){ #define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation #else # if defined(SEND_PWM_BY_TIMER) -#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warning in IRTimer.hpp +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp # endif #endif #if !defined (FLASHEND) #define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined #endif -#if !defined (RAMEND) -#define RAMEND 0xFFFF // Dummy value for platforms where RAMEND is not defined -#endif -#if !defined (RAMSIZE) -#define RAMSIZE 0xFFFF // Dummy value for platforms where RAMSIZE is not defined -#endif /* * Helper macro for getting a macro definition as string diff --git a/examples/MultipleSendPins/MultipleSendPins.ino b/examples/MultipleSendPins/MultipleSendPins.ino new file mode 100644 index 000000000..33566bcbc --- /dev/null +++ b/examples/MultipleSendPins/MultipleSendPins.ino @@ -0,0 +1,94 @@ +/* + * MultipleSendPins.cpp + * + * Demonstrates sending IR codes toggling between 2 different send pins. + * Based on SimpleSender. + * + * Copyright (C) 2025 Armin Joachimsmeyer + * armin.joachimsmeyer@gmail.com + * + * This file is part of Arduino-IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. + * + * MIT License + */ +#include + +#if !defined(ARDUINO_ESP32C3_DEV) // This is due to a bug in RISC-V compiler, which requires unused function sections :-(. +#define DISABLE_CODE_FOR_RECEIVER // Disables static receiver code like receive timer ISR handler and static IRReceiver and irparams data. Saves 450 bytes program memory and 269 bytes RAM if receiving functions are not required. +#endif +//#define USE_NO_SEND_PWM // Use no carrier PWM, just simulate an active low receiver signal. Overrides SEND_PWM_BY_TIMER definition + +#include // include the library + +void setup() { + pinMode(LED_BUILTIN, OUTPUT); + + Serial.begin(115200); + + // Just to know which program is running on my Arduino + Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE)); + Serial.print(F("Send IR signals alternating at pin 3 and 4")); + + /* + * The IR library setup. That's all! + */ + IrSender.begin(3); // Start with pin3 as send pin and enable feedback LED at default feedback LED pin + disableLEDFeedback(); // Disable feedback LED at default feedback LED pin +} + +/* + * Set up the data to be sent. + * For most protocols, the data is build up with a constant 8 (or 16 byte) address + * and a variable 8 bit command. + * There are exceptions like Sony and Denon, which have 5 bit address. + */ +uint8_t sCommand = 0x34; +uint8_t sRepeats = 0; + +void loop() { + /* + * Print current send values + */ + Serial.println(); + Serial.print(F("Send now: address=0x00, command=0x")); + Serial.print(sCommand, HEX); + Serial.print(F(", repeats=")); + Serial.print(sRepeats); + Serial.println(); + + Serial.println(F("Send standard NEC with 8 bit address")); + Serial.flush(); + + // Receiver output for the first loop must be: Protocol=NEC Address=0x102 Command=0x34 Raw-Data=0xCB340102 (32 bits) + IrSender.sendNEC(0x00, sCommand, sRepeats); + + /* + * If you want to send a raw HEX value directly like e.g. 0xCB340102 you must use sendNECRaw() + */ +// Serial.println(F("Send 32 bit LSB 0xCB340102 with NECRaw()")); +// IrSender.sendNECRaw(0xCB340102, sRepeats); + /* + * If you want to send an "old" MSB HEX value used by IRremote versions before 3.0 like e.g. 0x40802CD3 you must use sendNECMSB() + */ +// Serial.println(F("Send old 32 bit MSB 0x40802CD3 with sendNECMSB()")); +// IrSender.sendNECMSB(0x40802CD3, 32, sRepeats); + /* + * Increment send values + */ + sCommand += 0x11; + sRepeats++; + // clip repeats at 4 + if (sRepeats > 4) { + sRepeats = 4; + } + + /* + * Toggle between send pin 3 and 4 + */ + if (IrSender.sendPin == 3) { + IrSender.setSendPin(4); + } else { + IrSender.setSendPin(3); + } + delay(1000); // delay must be greater than 5 ms (RECORD_GAP_MICROS), otherwise the receiver sees it as one long signal +} diff --git a/examples/ReceiveAndSend/PinDefinitionsAndMore.h b/examples/ReceiveAndSend/PinDefinitionsAndMore.h index cb2b3b86d..b13414f56 100644 --- a/examples/ReceiveAndSend/PinDefinitionsAndMore.h +++ b/examples/ReceiveAndSend/PinDefinitionsAndMore.h @@ -4,7 +4,7 @@ * Contains pin definitions for IRremote examples for various platforms * as well as definitions for feedback LED and tone() and includes * - * Copyright (C) 2021-2022 Armin Joachimsmeyer + * Copyright (C) 2021-2023 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. @@ -32,81 +32,97 @@ * DEFAULT/AVR 2 3 4 Arduino * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore - * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark pro - * ATtiny3217 18|PA1 19|PA2 20|PA3 MegaTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore * ATtiny1604 2 3|PA5 % * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore - * SAMD21 3 4 5 + * MKR* 1 3 4 + * SAMD 2 3 4 * ESP8266 14|D5 12|D6 % - * ESP32 15 4 27 - * BluePill PA6 PA7 PA3 + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 * APOLLO3 11 12 5 * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 */ //#define _IR_MEASURE_TIMING // For debugging purposes. #if defined(__AVR__) -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board -#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore -#define IR_RECEIVE_PIN 0 -#define IR_SEND_PIN 4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. -#define TONE_PIN 3 -#define _IR_TIMING_TEST_PIN 3 +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 # elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board #include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" // For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. # if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core #define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 //#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards #define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 #define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 #define _IR_TIMING_TEST_PIN 10 // PA4 # else -#define IR_RECEIVE_PIN 3 // PA3 - on Digispark board labeled as pin 9 -#define IR_SEND_PIN 2 // PA2 - on Digispark board labeled as pin 8 -#define TONE_PIN 7 // PA7 - on Digispark board labeled as pin 5 +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 # endif -# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board -#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory -// Pin 6 is TX pin 7 is RX -#define IR_RECEIVE_PIN 3 // INT1 -#define IR_SEND_PIN 4 -#define TONE_PIN 9 -#define _IR_TIMING_TEST_PIN 8 - -# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // Tiny Core Dev board -#define IR_RECEIVE_PIN 18 -#define IR_SEND_PIN 19 -#define TONE_PIN 20 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output -#define LED_BUILTIN 2 // PA6 - -# elif defined(__AVR_ATtiny816__) // Tiny Core Micro -#define IR_RECEIVE_PIN 14 // PA1 -#define IR_SEND_PIN 16 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output -#define LED_BUILTIN 4 // PB5 - -# elif defined(__AVR_ATtiny1614__) -#define IR_RECEIVE_PIN 8 // PA1 -#define IR_SEND_PIN 10 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 - -# elif defined(__AVR_ATtiny1604__) -#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. -#define IR_SEND_PIN 3 -#define APPLICATION_PIN 5 +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 #define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it +#define TONE_PIN 42 // Dummy for examples using it # elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ || defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ @@ -139,6 +155,15 @@ # endif # endif // defined(__AVR_ATtiny25__)... +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + #elif defined(ESP8266) #define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW #define IR_RECEIVE_PIN 14 // D5 @@ -148,21 +173,32 @@ #define tone(...) void() // tone() inhibits receive timer #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it - -#elif defined(CONFIG_IDF_TARGET_ESP32C3) -#define IR_INPUT_PIN 8 -#define IR_SEND_PIN 9 -#define TONE_PIN 10 // ADC2_0 -#define APPLICATION_PIN 11 +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 #elif defined(ESP32) #include // tone() is included in ESP32 core since 2.0.2 -#if !defined(ESP_ARDUINO_VERSION_VAL) -#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) 12345678 -#endif +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif #if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) #define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. void tone(uint8_t aPinNumber, unsigned int aFrequency){ @@ -205,7 +241,8 @@ void noTone(uint8_t aPinNumber){ #define IR_SEND_PIN 12 #define TONE_PIN 5 -#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect #define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico #define IR_SEND_PIN 4 // GPIO16 #define TONE_PIN 5 @@ -252,14 +289,18 @@ void noTone(uint8_t aPinNumber){ #define _IR_TIMING_TEST_PIN 7 #elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else #define IR_RECEIVE_PIN 2 +# endif #define IR_SEND_PIN 3 #define TONE_PIN 4 #define APPLICATION_PIN 5 #define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. #define _IR_TIMING_TEST_PIN 7 -#if !defined(ARDUINO_SAMD_ADAFRUIT) +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) // On the Zero and others we switch explicitly to SerialUSB #define Serial SerialUSB #endif @@ -299,19 +340,13 @@ void noTone(uint8_t aPinNumber){ #define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation #else # if defined(SEND_PWM_BY_TIMER) -#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warning in IRTimer.hpp +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp # endif #endif #if !defined (FLASHEND) #define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined #endif -#if !defined (RAMEND) -#define RAMEND 0xFFFF // Dummy value for platforms where RAMEND is not defined -#endif -#if !defined (RAMSIZE) -#define RAMSIZE 0xFFFF // Dummy value for platforms where RAMSIZE is not defined -#endif /* * Helper macro for getting a macro definition as string diff --git a/examples/ReceiveAndSend/ReceiveAndSend.ino b/examples/ReceiveAndSend/ReceiveAndSend.ino index fdd4eaf36..591579d85 100644 --- a/examples/ReceiveAndSend/ReceiveAndSend.ino +++ b/examples/ReceiveAndSend/ReceiveAndSend.ino @@ -14,6 +14,7 @@ * A button must be connected between the input SEND_BUTTON_PIN and ground. * A visible LED can be connected to STATUS_PIN to provide status. * + * See also https://dronebotworkshop.com/ir-remotes/#ReceiveAndSend_Code * * Initially coded 2009 Ken Shirriff http://www.righto.com * @@ -22,7 +23,7 @@ ************************************************************************************ * MIT License * - * Copyright (c) 2009-2023 Ken Shirriff, Armin Joachimsmeyer + * Copyright (c) 2009-2025 Ken Shirriff, Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -57,7 +58,7 @@ //#define DECODE_KASEIKYO //#define DECODE_PANASONIC // alias for DECODE_KASEIKYO //#define DECODE_LG -#define DECODE_NEC // Includes Apple and Onkyo +//#define DECODE_NEC // Includes Apple and Onkyo //#define DECODE_SAMSUNG //#define DECODE_SONY //#define DECODE_RC5 @@ -69,20 +70,18 @@ //#define DECODE_WHYNTER //#define DECODE_FAST // + #if !defined(RAW_BUFFER_LENGTH) -# if RAMEND <= 0x4FF || RAMSIZE < 0x4FF -#define RAW_BUFFER_LENGTH 120 -# elif RAMEND <= 0xAFF || RAMSIZE < 0xAFF // 0xAFF for LEONARDO -#define RAW_BUFFER_LENGTH 400 // 600 is too much here, because we have additional uint8_t rawCode[RAW_BUFFER_LENGTH]; -# else -#define RAW_BUFFER_LENGTH 750 +// For air condition remotes it may require up to 750. Default is 200. +# if !((defined(RAMEND) && RAMEND <= 0x4FF) || (defined(RAMSIZE) && RAMSIZE < 0x4FF)) +#define RAW_BUFFER_LENGTH 700 // we require 2 buffer of this size for this example # endif #endif //#define EXCLUDE_UNIVERSAL_PROTOCOLS // Saves up to 1000 bytes program memory. -//#define EXCLUDE_EXOTIC_PROTOCOLS // saves around 650 bytes program memory if all other protocols are active +#define EXCLUDE_EXOTIC_PROTOCOLS // saves around 650 bytes program memory if all other protocols are active //#define NO_LED_FEEDBACK_CODE // saves 92 bytes program memory -//#define RECORD_GAP_MICROS 12000 // Default is 5000. Activate it for some LG air conditioner protocols +//#define RECORD_GAP_MICROS 12000 // Default is 8000. Activate it for some LG air conditioner protocols //#define SEND_PWM_BY_TIMER // Disable carrier PWM generation in software and use (restricted) hardware PWM. //#define USE_NO_SEND_PWM // Use no carrier PWM, just simulate an active low receiver signal. Overrides SEND_PWM_BY_TIMER definition @@ -115,7 +114,9 @@ void setup() { pinMode(SEND_BUTTON_PIN, INPUT_PULLUP); Serial.begin(115200); -#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/|| defined(SERIALUSB_PID) || defined(ARDUINO_attiny3217) + +#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/ \ + || defined(SERIALUSB_PID) || defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_attiny3217) delay(4000); // To be able to connect Serial monitor after reset or power up and before first print out. Do not wait for an attached Serial Monitor! #endif // Just to know which program is running on my Arduino @@ -127,9 +128,10 @@ void setup() { printActiveIRProtocols(&Serial); Serial.println(F("at pin " STR(IR_RECEIVE_PIN))); - IrSender.begin(); // Start with IR_SEND_PIN as send pin and enable feedback LED at default feedback LED pin - Serial.print(F("Ready to send IR signals at pin " STR(IR_SEND_PIN) " on press of button at pin ")); - Serial.println(SEND_BUTTON_PIN); + IrSender.begin(); // Start with IR_SEND_PIN -which is defined in PinDefinitionsAndMore.h- as send pin and enable feedback LED at default feedback LED pin + Serial.print(F("Ready to send IR signal (with repeats) at pin " STR(IR_SEND_PIN) " as long as button at pin ")); + Serial.print(SEND_BUTTON_PIN); + Serial.println(F(" is pressed.")); } void loop() { @@ -166,6 +168,7 @@ void loop() { // Restart receiver Serial.println(F("Button released -> start receiving")); IrReceiver.start(); + delay(100); // Button debouncing } else if (IrReceiver.decode()) { /* @@ -176,7 +179,6 @@ void loop() { } sSendButtonWasActive = tSendButtonIsActive; - delay(100); } // Stores the code for later playback in sStoredIRData @@ -199,21 +201,31 @@ void storeCode() { Serial.println(F("Ignore parity error")); return; } + if (IrReceiver.decodedIRData.flags & IRDATA_FLAGS_WAS_OVERFLOW) { + Serial.println(F("Overflow occurred, raw data did not fit into " STR(RAW_BUFFER_LENGTH) " byte raw buffer")); + return; + } /* * Copy decoded data */ sStoredIRData.receivedIRData = IrReceiver.decodedIRData; - if (sStoredIRData.receivedIRData.protocol == UNKNOWN) { - Serial.print(F("Received unknown code and store ")); - Serial.print(IrReceiver.decodedIRData.rawDataPtr->rawlen - 1); - Serial.println(F(" timing entries as raw ")); - IrReceiver.printIRResultRawFormatted(&Serial, true); // Output the results in RAW format + auto tProtocol = sStoredIRData.receivedIRData.protocol; + if (tProtocol == UNKNOWN || tProtocol == PULSE_WIDTH || tProtocol == PULSE_DISTANCE) { + // TODO: support PULSE_WIDTH and PULSE_DISTANCE with IrSender.write sStoredIRData.rawCodeLength = IrReceiver.decodedIRData.rawDataPtr->rawlen - 1; /* * Store the current raw data in a dedicated array for later usage */ IrReceiver.compensateAndStoreIRResultInArray(sStoredIRData.rawCode); + /* + * Print info + */ + Serial.print(F("Received unknown code and store ")); + Serial.print(IrReceiver.decodedIRData.rawDataPtr->rawlen - 1); + Serial.println(F(" timing entries as raw in buffer of size " STR(RAW_BUFFER_LENGTH))); + IrReceiver.printIRResultRawFormatted(&Serial, true); // Output the results in RAW format + } else { IrReceiver.printIRResultShort(&Serial); IrReceiver.printIRSendUsage(&Serial); @@ -223,7 +235,8 @@ void storeCode() { } void sendCode(storedIRDataStruct *aIRDataToSend) { - if (aIRDataToSend->receivedIRData.protocol == UNKNOWN /* i.e. raw */) { + auto tProtocol = aIRDataToSend->receivedIRData.protocol; + if (tProtocol == UNKNOWN || tProtocol == PULSE_WIDTH || tProtocol == PULSE_DISTANCE /* i.e. raw */) { // Assume 38 KHz IrSender.sendRaw(aIRDataToSend->rawCode, aIRDataToSend->rawCodeLength, 38); @@ -231,12 +244,11 @@ void sendCode(storedIRDataStruct *aIRDataToSend) { Serial.print(aIRDataToSend->rawCodeLength); Serial.println(F(" marks or spaces")); } else { - /* * Use the write function, which does the switch for different protocols */ IrSender.write(&aIRDataToSend->receivedIRData); - printIRResultShort(&Serial, &aIRDataToSend->receivedIRData, false); + printIRResultShort(&Serial, &aIRDataToSend->receivedIRData); } } diff --git a/examples/ReceiveAndSendDistanceWidth/PinDefinitionsAndMore.h b/examples/ReceiveAndSendDistanceWidth/PinDefinitionsAndMore.h index cb2b3b86d..b13414f56 100644 --- a/examples/ReceiveAndSendDistanceWidth/PinDefinitionsAndMore.h +++ b/examples/ReceiveAndSendDistanceWidth/PinDefinitionsAndMore.h @@ -4,7 +4,7 @@ * Contains pin definitions for IRremote examples for various platforms * as well as definitions for feedback LED and tone() and includes * - * Copyright (C) 2021-2022 Armin Joachimsmeyer + * Copyright (C) 2021-2023 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. @@ -32,81 +32,97 @@ * DEFAULT/AVR 2 3 4 Arduino * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore - * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark pro - * ATtiny3217 18|PA1 19|PA2 20|PA3 MegaTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore * ATtiny1604 2 3|PA5 % * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore - * SAMD21 3 4 5 + * MKR* 1 3 4 + * SAMD 2 3 4 * ESP8266 14|D5 12|D6 % - * ESP32 15 4 27 - * BluePill PA6 PA7 PA3 + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 * APOLLO3 11 12 5 * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 */ //#define _IR_MEASURE_TIMING // For debugging purposes. #if defined(__AVR__) -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board -#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore -#define IR_RECEIVE_PIN 0 -#define IR_SEND_PIN 4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. -#define TONE_PIN 3 -#define _IR_TIMING_TEST_PIN 3 +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 # elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board #include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" // For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. # if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core #define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 //#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards #define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 #define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 #define _IR_TIMING_TEST_PIN 10 // PA4 # else -#define IR_RECEIVE_PIN 3 // PA3 - on Digispark board labeled as pin 9 -#define IR_SEND_PIN 2 // PA2 - on Digispark board labeled as pin 8 -#define TONE_PIN 7 // PA7 - on Digispark board labeled as pin 5 +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 # endif -# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board -#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory -// Pin 6 is TX pin 7 is RX -#define IR_RECEIVE_PIN 3 // INT1 -#define IR_SEND_PIN 4 -#define TONE_PIN 9 -#define _IR_TIMING_TEST_PIN 8 - -# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // Tiny Core Dev board -#define IR_RECEIVE_PIN 18 -#define IR_SEND_PIN 19 -#define TONE_PIN 20 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output -#define LED_BUILTIN 2 // PA6 - -# elif defined(__AVR_ATtiny816__) // Tiny Core Micro -#define IR_RECEIVE_PIN 14 // PA1 -#define IR_SEND_PIN 16 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output -#define LED_BUILTIN 4 // PB5 - -# elif defined(__AVR_ATtiny1614__) -#define IR_RECEIVE_PIN 8 // PA1 -#define IR_SEND_PIN 10 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 - -# elif defined(__AVR_ATtiny1604__) -#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. -#define IR_SEND_PIN 3 -#define APPLICATION_PIN 5 +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 #define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it +#define TONE_PIN 42 // Dummy for examples using it # elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ || defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ @@ -139,6 +155,15 @@ # endif # endif // defined(__AVR_ATtiny25__)... +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + #elif defined(ESP8266) #define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW #define IR_RECEIVE_PIN 14 // D5 @@ -148,21 +173,32 @@ #define tone(...) void() // tone() inhibits receive timer #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it - -#elif defined(CONFIG_IDF_TARGET_ESP32C3) -#define IR_INPUT_PIN 8 -#define IR_SEND_PIN 9 -#define TONE_PIN 10 // ADC2_0 -#define APPLICATION_PIN 11 +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 #elif defined(ESP32) #include // tone() is included in ESP32 core since 2.0.2 -#if !defined(ESP_ARDUINO_VERSION_VAL) -#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) 12345678 -#endif +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif #if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) #define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. void tone(uint8_t aPinNumber, unsigned int aFrequency){ @@ -205,7 +241,8 @@ void noTone(uint8_t aPinNumber){ #define IR_SEND_PIN 12 #define TONE_PIN 5 -#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect #define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico #define IR_SEND_PIN 4 // GPIO16 #define TONE_PIN 5 @@ -252,14 +289,18 @@ void noTone(uint8_t aPinNumber){ #define _IR_TIMING_TEST_PIN 7 #elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else #define IR_RECEIVE_PIN 2 +# endif #define IR_SEND_PIN 3 #define TONE_PIN 4 #define APPLICATION_PIN 5 #define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. #define _IR_TIMING_TEST_PIN 7 -#if !defined(ARDUINO_SAMD_ADAFRUIT) +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) // On the Zero and others we switch explicitly to SerialUSB #define Serial SerialUSB #endif @@ -299,19 +340,13 @@ void noTone(uint8_t aPinNumber){ #define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation #else # if defined(SEND_PWM_BY_TIMER) -#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warning in IRTimer.hpp +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp # endif #endif #if !defined (FLASHEND) #define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined #endif -#if !defined (RAMEND) -#define RAMEND 0xFFFF // Dummy value for platforms where RAMEND is not defined -#endif -#if !defined (RAMSIZE) -#define RAMSIZE 0xFFFF // Dummy value for platforms where RAMSIZE is not defined -#endif /* * Helper macro for getting a macro definition as string diff --git a/examples/ReceiveAndSendDistanceWidth/ReceiveAndSendDistanceWidth.ino b/examples/ReceiveAndSendDistanceWidth/ReceiveAndSendDistanceWidth.ino index 5c2e73556..a932e91ac 100644 --- a/examples/ReceiveAndSendDistanceWidth/ReceiveAndSendDistanceWidth.ino +++ b/examples/ReceiveAndSendDistanceWidth/ReceiveAndSendDistanceWidth.ino @@ -16,6 +16,7 @@ * A button must be connected between the input SEND_BUTTON_PIN and ground. * A visible LED can be connected to STATUS_PIN to provide status. * + * See also https://dronebotworkshop.com/ir-remotes/#ReceiveAndSendDistanceWidth_Code * * This file is part of Arduino-IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. * @@ -56,17 +57,16 @@ #define DECODE_DISTANCE_WIDTH // Universal decoder for pulse distance width protocols // #if !defined(RAW_BUFFER_LENGTH) -# if RAMEND <= 0x4FF || RAMSIZE < 0x4FF -#define RAW_BUFFER_LENGTH 120 -# elif RAMEND <= 0xAFF || RAMSIZE < 0xAFF // 0xAFF for LEONARDO -#define RAW_BUFFER_LENGTH 400 // 600 is too much here, because we have additional uint8_t rawCode[RAW_BUFFER_LENGTH]; -# else +// For air condition remotes it may require up to 750. Default is 200. +# if (defined(RAMEND) && RAMEND <= 0x4FF) || (defined(RAMSIZE) && RAMSIZE < 0x4FF) +#define RAW_BUFFER_LENGTH 360 +# elif (defined(RAMEND) && RAMEND <= 0x8FF) || (defined(RAMSIZE) && RAMSIZE < 0x8FF) #define RAW_BUFFER_LENGTH 750 # endif #endif //#define NO_LED_FEEDBACK_CODE // saves 92 bytes program memory -//#define RECORD_GAP_MICROS 12000 // Default is 5000. Activate it for some LG air conditioner protocols +//#define RECORD_GAP_MICROS 12000 // Default is 8000. Activate it for some LG air conditioner protocols //#define SEND_PWM_BY_TIMER // Disable carrier PWM generation in software and use (restricted) hardware PWM. //#define USE_NO_SEND_PWM // Use no carrier PWM, just simulate an active low receiver signal. Overrides SEND_PWM_BY_TIMER definition @@ -79,8 +79,8 @@ #define DELAY_BETWEEN_REPEATS_MILLIS 70 // Storage for the recorded code, pre-filled with NEC data -IRRawDataType sDecodedRawDataArray[RAW_DATA_ARRAY_SIZE] = { 0x7B34ED12 }; // address 0x12 command 0x34 -DistanceWidthTimingInfoStruct sDistanceWidthTimingInfo = { 9000, 4500, 560, 1690, 560, 560 }; // NEC timing +IRRawDataType sDecodedRawDataArray[DECODED_RAW_DATA_ARRAY_SIZE] = { 0x7B34ED12 }; // Initialize with NEC address 0x12 and command 0x34 +DistanceWidthTimingInfoStruct sDistanceWidthTimingInfo = { 9000, 4500, 560, 1690, 560, 560 }; // Initialize with NEC timing uint8_t sNumberOfBits = 32; bool sSendButtonWasActive; @@ -89,7 +89,9 @@ void setup() { pinMode(SEND_BUTTON_PIN, INPUT_PULLUP); Serial.begin(115200); -#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/|| defined(SERIALUSB_PID) || defined(ARDUINO_attiny3217) + +#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/ \ + || defined(SERIALUSB_PID) || defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_attiny3217) delay(4000); // To be able to connect Serial monitor after reset or power up and before first print out. Do not wait for an attached Serial Monitor! #endif // Just to know which program is running on my Arduino @@ -99,7 +101,7 @@ void setup() { IrReceiver.begin(IR_RECEIVE_PIN, ENABLE_LED_FEEDBACK); Serial.println(F("Ready to receive pulse distance/width coded IR signals at pin " STR(IR_RECEIVE_PIN))); - IrSender.begin(); // Start with IR_SEND_PIN as send pin and enable feedback LED at default feedback LED pin + IrSender.begin(); // Start with IR_SEND_PIN -which is defined in PinDefinitionsAndMore.h- as send pin and enable feedback LED at default feedback LED pin Serial.print(F("Ready to send IR signals at pin " STR(IR_SEND_PIN) " on press of button at pin ")); Serial.println(SEND_BUTTON_PIN); } diff --git a/examples/ReceiveAndSendHob2Hood/PinDefinitionsAndMore.h b/examples/ReceiveAndSendHob2Hood/PinDefinitionsAndMore.h new file mode 100644 index 000000000..b13414f56 --- /dev/null +++ b/examples/ReceiveAndSendHob2Hood/PinDefinitionsAndMore.h @@ -0,0 +1,357 @@ +/* + * PinDefinitionsAndMore.h + * + * Contains pin definitions for IRremote examples for various platforms + * as well as definitions for feedback LED and tone() and includes + * + * Copyright (C) 2021-2023 Armin Joachimsmeyer + * armin.joachimsmeyer@gmail.com + * + * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. + * + * Arduino-IRremote is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + * See the GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + * + */ + +/* + * Pin mapping table for different platforms + * + * Platform IR input IR output Tone Core/Pin schema + * -------------------------------------------------------------- + * DEFAULT/AVR 2 3 4 Arduino + * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore + * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore + * ATtiny1604 2 3|PA5 % + * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore + * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore + * MKR* 1 3 4 + * SAMD 2 3 4 + * ESP8266 14|D5 12|D6 % + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 + * APOLLO3 11 12 5 + * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 + */ +//#define _IR_MEASURE_TIMING // For debugging purposes. + +#if defined(__AVR__) +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 + +# elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" +// For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. +# if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core +#define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 +//#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 +#define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 +#define _IR_TIMING_TEST_PIN 10 // PA4 +# else +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 +# endif + +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 + +#define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() +#define noTone(a) void() +#define TONE_PIN 42 // Dummy for examples using it + +# elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ +|| defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ +|| defined(__AVR_ATmega324P__) || defined(__AVR_ATmega324A__) \ +|| defined(__AVR_ATmega324PA__) || defined(__AVR_ATmega164A__) \ +|| defined(__AVR_ATmega164P__) || defined(__AVR_ATmega32__) \ +|| defined(__AVR_ATmega16__) || defined(__AVR_ATmega8535__) \ +|| defined(__AVR_ATmega64__) || defined(__AVR_ATmega128__) \ +|| defined(__AVR_ATmega1281__) || defined(__AVR_ATmega2561__) \ +|| defined(__AVR_ATmega8515__) || defined(__AVR_ATmega162__) +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 13 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +# else // Default as for ATmega328 like on Uno, Nano, Leonardo, Teensy 2.0 etc. +#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +# if defined(ARDUINO_AVR_PROMICRO) // Sparkfun Pro Micro is __AVR_ATmega32U4__ but has different external circuit +// We have no built in LED at pin 13 -> reuse RX LED +#undef LED_BUILTIN +#define LED_BUILTIN LED_BUILTIN_RX +# endif +# endif // defined(__AVR_ATtiny25__)... + +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +#elif defined(ESP8266) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW +#define IR_RECEIVE_PIN 14 // D5 +#define IR_SEND_PIN 12 // D6 - D4/pin 2 is internal LED +#define _IR_TIMING_TEST_PIN 2 // D4 +#define APPLICATION_PIN 13 // D7 + +#define tone(...) void() // tone() inhibits receive timer +#define noTone(a) void() +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 + +#elif defined(ESP32) +#include + +// tone() is included in ESP32 core since 2.0.2 +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif +#if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) +#define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. +void tone(uint8_t aPinNumber, unsigned int aFrequency){ + ledcAttachPin(aPinNumber, TONE_LEDC_CHANNEL); + ledcWriteTone(TONE_LEDC_CHANNEL, aFrequency); +} +void tone(uint8_t aPinNumber, unsigned int aFrequency, unsigned long aDuration){ + ledcAttachPin(aPinNumber, TONE_LEDC_CHANNEL); + ledcWriteTone(TONE_LEDC_CHANNEL, aFrequency); + delay(aDuration); + ledcWriteTone(TONE_LEDC_CHANNEL, 0); +} +void noTone(uint8_t aPinNumber){ + ledcWriteTone(TONE_LEDC_CHANNEL, 0); +} +#endif // ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) + +#define IR_RECEIVE_PIN 15 // D15 +#define IR_SEND_PIN 4 // D4 +#define TONE_PIN 27 // D27 25 & 26 are DAC0 and 1 +#define APPLICATION_PIN 16 // RX2 pin + +#elif defined(ARDUINO_ARCH_STM32) || defined(ARDUINO_ARCH_STM32F1) // BluePill +// Timer 3 blocks PA6, PA7, PB0, PB1 for use by Servo or tone() +#define IR_RECEIVE_PIN PA6 +#define IR_RECEIVE_PIN_STRING "PA6" +#define IR_SEND_PIN PA7 +#define IR_SEND_PIN_STRING "PA7" +#define TONE_PIN PA3 +#define _IR_TIMING_TEST_PIN PA5 +#define APPLICATION_PIN PA2 +#define APPLICATION_PIN_STRING "PA2" +# if defined(ARDUINO_GENERIC_STM32F103C) || defined(ARDUINO_BLUEPILL_F103C8) +// BluePill LED is active low +#define FEEDBACK_LED_IS_ACTIVE_LOW +# endif + +#elif defined(ARDUINO_ARCH_APOLLO3) // Sparkfun Apollo boards +#define IR_RECEIVE_PIN 11 +#define IR_SEND_PIN 12 +#define TONE_PIN 5 + +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect +#define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico +#define IR_SEND_PIN 4 // GPIO16 +#define TONE_PIN 5 +#define APPLICATION_PIN 6 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 7 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 8 + +#elif defined(ARDUINO_ARCH_RP2040) // Arduino Nano Connect, Pi Pico with arduino-pico core https://github.com/earlephilhower/arduino-pico +#define IR_RECEIVE_PIN 15 // GPIO15 to be compatible with the Arduino Nano RP2040 Connect (pin3) +#define IR_SEND_PIN 16 // GPIO16 +#define TONE_PIN 17 +#define APPLICATION_PIN 18 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 19 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 20 + +// If you program the Nano RP2040 Connect with this core, then you must redefine LED_BUILTIN +// and use the external reset with 1 kOhm to ground to enter UF2 mode +#undef LED_BUILTIN +#define LED_BUILTIN 6 + +#elif defined(PARTICLE) // !!!UNTESTED!!! +#define IR_RECEIVE_PIN A4 +#define IR_SEND_PIN A5 // Particle supports multiple pins + +#define LED_BUILTIN D7 + +/* + * 4 times the same (default) layout for easy adaption in the future + */ +#elif defined(TEENSYDUINO) // Teensy 2.0 is handled at default for ATmega328 like on Uno, Nano, Leonardo etc. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +#elif defined(ARDUINO_ARCH_MBED) // Arduino Nano 33 BLE +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +#elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else +#define IR_RECEIVE_PIN 2 +# endif +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) +// On the Zero and others we switch explicitly to SerialUSB +#define Serial SerialUSB +#endif + +// Definitions for the Chinese SAMD21 M0-Mini clone, which has no led connected to D13/PA17. +// Attention!!! D2 and D4 are swapped on these boards!!! +// If you connect the LED, it is on pin 24/PB11. In this case activate the next two lines. +//#undef LED_BUILTIN +//#define LED_BUILTIN 24 // PB11 +// As an alternative you can choose pin 25, it is the RX-LED pin (PB03), but active low.In this case activate the next 3 lines. +//#undef LED_BUILTIN +//#define LED_BUILTIN 25 // PB03 +//#define FEEDBACK_LED_IS_ACTIVE_LOW // The RX LED on the M0-Mini is active LOW + +#elif defined (NRF51) // BBC micro:bit +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define APPLICATION_PIN 1 +#define _IR_TIMING_TEST_PIN 4 + +#define tone(...) void() // no tone() available +#define noTone(a) void() +#define TONE_PIN 42 // Dummy for examples using it + +#else +#warning Board / CPU is not detected using pre-processor symbols -> using default values, which may not fit. Please extend PinDefinitionsAndMore.h. +// Default valued for unidentified boards +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 +#endif // defined(ESP8266) + +#if defined(ESP32) || defined(ARDUINO_ARCH_RP2040) || defined(PARTICLE) || defined(ARDUINO_ARCH_MBED) +#define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation +#else +# if defined(SEND_PWM_BY_TIMER) +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp +# endif +#endif + +#if !defined (FLASHEND) +#define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined +#endif + +/* + * Helper macro for getting a macro definition as string + */ +#if !defined(STR_HELPER) +#define STR_HELPER(x) #x +#define STR(x) STR_HELPER(x) +#endif diff --git a/examples/ReceiveAndSendHob2Hood/ReceiveAndSendHob2Hood.ino b/examples/ReceiveAndSendHob2Hood/ReceiveAndSendHob2Hood.ino new file mode 100644 index 000000000..f9b3a2b09 --- /dev/null +++ b/examples/ReceiveAndSendHob2Hood/ReceiveAndSendHob2Hood.ino @@ -0,0 +1,145 @@ +/* + * ReceiveAndSendHob2Hood.cpp + * + * Demonstrates receiving and sending of IR codes for AEG / Elektrolux Hob2Hood protocol + * + * This file is part of Arduino-IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. + * + ************************************************************************************ + * MIT License + * + * Copyright (c) 2024 Armin Joachimsmeyer + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is furnished + * to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, + * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A + * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF + * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE + * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * + ************************************************************************************ + */ + +#include + +#define DECODE_HASH // Only decoder, which works for Hob2Hood. protocol is UNKNOWN and only raw data is set. + +//#define NO_LED_FEEDBACK_CODE // saves 92 bytes program memory +//#define SEND_PWM_BY_TIMER // Disable carrier PWM generation in software and use (restricted) hardware PWM. + +#include "PinDefinitionsAndMore.h" // Define macros for input and output pin etc. +#include + +// IR commands from AEG hob2hood device +#define NUMBER_OF_HOB_TO_HOOD_COMMANDS 7 +#define HOB_TO_HOOD_HASH_CODE_FAN_1 0xE3C01BE2 +#define HOB_TO_HOOD_HASH_CODE_FAN_2 0xD051C301 +#define HOB_TO_HOOD_HASH_CODE_FAN_3 0xC22FFFD7 +#define HOB_TO_HOOD_HASH_CODE_FAN_4 0xB9121B29 +#define HOB_TO_HOOD_HASH_CODE_FAN_OFF 0x55303A3 +#define HOB_TO_HOOD_HASH_CODE_LIGHT_ON 0xE208293C +#define HOB_TO_HOOD_HASH_CODE_LIGHT_OFF 0x24ACF947 + +// based on https://pastebin.com/N6kG7Wu5 +#define HOB_TO_HOOD_UNIT_MICROS 725 +#define H2H_1 HOB_TO_HOOD_UNIT_MICROS +#define H2H_2 (HOB_TO_HOOD_UNIT_MICROS*2) // 1450 +#define H2H_3 (HOB_TO_HOOD_UNIT_MICROS*3) // 2175 +#define H2H_4 (HOB_TO_HOOD_UNIT_MICROS*4) // 2900 +#define H2H_5 (HOB_TO_HOOD_UNIT_MICROS*5) // 3625 + +// First entry is the length of the raw command +const uint16_t Fan1[] PROGMEM { 15, H2H_2, H2H_2, H2H_1, H2H_2, H2H_3, H2H_2, H2H_1, H2H_2, H2H_1, H2H_1, H2H_1, H2H_2, H2H_1, +H2H_3, H2H_1 }; +const uint16_t Fan2[] PROGMEM { 9, H2H_2, H2H_2, H2H_1, H2H_4, H2H_1, H2H_3, H2H_5, H2H_3, H2H_3 }; +const uint16_t Fan3[] PROGMEM { 9, H2H_1, H2H_3, H2H_4, H2H_4, H2H_3, H2H_1, H2H_1, H2H_3, H2H_3 }; +const uint16_t Fan4[] PROGMEM { 13, H2H_2, H2H_3, H2H_2, H2H_1, H2H_2, H2H_3, H2H_2, H2H_2, H2H_1, H2H_3, H2H_1, H2H_1, H2H_2 }; +const uint16_t FanOff[] PROGMEM { 15, H2H_1, H2H_2, H2H_1, H2H_2, H2H_3, H2H_2, H2H_1, H2H_2, H2H_2, H2H_3, H2H_1, H2H_2, H2H_1, +H2H_1, H2H_1 }; +const uint16_t LightOn[] PROGMEM { 17, H2H_1, H2H_2, H2H_1, H2H_1, H2H_2, H2H_1, H2H_1, H2H_2, H2H_1, H2H_1, H2H_2, H2H_4, H2H_1, +H2H_1, H2H_1, H2H_1, H2H_2 }; +const uint16_t LightOff[] PROGMEM { 17, H2H_1, H2H_2, H2H_1, H2H_1, H2H_1, H2H_1, H2H_1, H2H_3, H2H_1, H2H_1, H2H_1, H2H_2, H2H_1, +H2H_2, H2H_1, H2H_1, H2H_1 }; +const uint16_t *const Hob2HoodSendCommands[NUMBER_OF_HOB_TO_HOOD_COMMANDS] = { Fan1, Fan2, Fan3, Fan4, FanOff, LightOn, LightOff }; // Constant array in RAM + +void setup() { + Serial.begin(115200); + +#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/ \ + || defined(SERIALUSB_PID) || defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_attiny3217) + delay(4000); // To be able to connect Serial monitor after reset or power up and before first print out. Do not wait for an attached Serial Monitor! +#endif + // Just to know which program is running on my Arduino + Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE)); + + // Start the receiver and if not 3. parameter specified, take LED_BUILTIN pin from the internal boards definition as default feedback LED + IrReceiver.begin(IR_RECEIVE_PIN, ENABLE_LED_FEEDBACK); + + Serial.print(F("Ready to receive Hob2Hood IR signals at pin " STR(IR_RECEIVE_PIN))); + IrSender.begin(); // Start with IR_SEND_PIN -which is defined in PinDefinitionsAndMore.h- as send pin and enable feedback LED at default feedback LED pin + Serial.println(F("Send Hob2Hood IR signals at pin " STR(IR_SEND_PIN))); +} + +/* + * Receive and send Hob2Hood protocol + */ +void loop() { + static long sLastMillisOfSend = 0; + static uint8_t sSendCommandIndex = 0; + + if (IrReceiver.decode()) { + IrReceiver.resume(); // Early enable receiving of the next IR frame + IrReceiver.printIRResultShort(&Serial); + + /* + * Finally, check the received data and perform actions according to the received command + */ + switch (IrReceiver.decodedIRData.decodedRawData) { + case HOB_TO_HOOD_HASH_CODE_FAN_OFF: + Serial.print(F("FAN off")); + break; + case HOB_TO_HOOD_HASH_CODE_FAN_1: + Serial.print(F("FAN 1")); + break; + case HOB_TO_HOOD_HASH_CODE_FAN_2: + Serial.print(F("FAN 2")); + break; + default: + Serial.print(F("unknown Hob2Hood IR command")); + break; + } + } + + /* + * Send next command every 5 seconds + */ + if (millis() - sLastMillisOfSend > 2000) { + sLastMillisOfSend = millis(); + +#if defined(__AVR__) + uint16_t tLengthOfRawCommand = pgm_read_word(Hob2HoodSendCommands[sSendCommandIndex]); // length is the 1. word in array +#else + uint16_t tLengthOfRawCommand = *Hob2HoodSendCommands[sSendCommandIndex]; // length is the 1. word in array +#endif + const uint16_t *tAddressOfRawCommandSequence = Hob2HoodSendCommands[sSendCommandIndex] + 1; // Raw sequence starts at the 2. word of array + Serial.print(F("Send Hob2Hood command index=")); + Serial.println(sSendCommandIndex); + IrSender.sendRaw_P(tAddressOfRawCommandSequence, tLengthOfRawCommand, 38); + + // Prepare for next command + sSendCommandIndex++; + if (sSendCommandIndex >= NUMBER_OF_HOB_TO_HOOD_COMMANDS) { + sSendCommandIndex = 0; + } + } +} diff --git a/examples/ReceiveDemo/PinDefinitionsAndMore.h b/examples/ReceiveDemo/PinDefinitionsAndMore.h index cb2b3b86d..b13414f56 100644 --- a/examples/ReceiveDemo/PinDefinitionsAndMore.h +++ b/examples/ReceiveDemo/PinDefinitionsAndMore.h @@ -4,7 +4,7 @@ * Contains pin definitions for IRremote examples for various platforms * as well as definitions for feedback LED and tone() and includes * - * Copyright (C) 2021-2022 Armin Joachimsmeyer + * Copyright (C) 2021-2023 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. @@ -32,81 +32,97 @@ * DEFAULT/AVR 2 3 4 Arduino * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore - * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark pro - * ATtiny3217 18|PA1 19|PA2 20|PA3 MegaTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore * ATtiny1604 2 3|PA5 % * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore - * SAMD21 3 4 5 + * MKR* 1 3 4 + * SAMD 2 3 4 * ESP8266 14|D5 12|D6 % - * ESP32 15 4 27 - * BluePill PA6 PA7 PA3 + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 * APOLLO3 11 12 5 * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 */ //#define _IR_MEASURE_TIMING // For debugging purposes. #if defined(__AVR__) -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board -#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore -#define IR_RECEIVE_PIN 0 -#define IR_SEND_PIN 4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. -#define TONE_PIN 3 -#define _IR_TIMING_TEST_PIN 3 +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 # elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board #include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" // For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. # if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core #define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 //#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards #define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 #define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 #define _IR_TIMING_TEST_PIN 10 // PA4 # else -#define IR_RECEIVE_PIN 3 // PA3 - on Digispark board labeled as pin 9 -#define IR_SEND_PIN 2 // PA2 - on Digispark board labeled as pin 8 -#define TONE_PIN 7 // PA7 - on Digispark board labeled as pin 5 +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 # endif -# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board -#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory -// Pin 6 is TX pin 7 is RX -#define IR_RECEIVE_PIN 3 // INT1 -#define IR_SEND_PIN 4 -#define TONE_PIN 9 -#define _IR_TIMING_TEST_PIN 8 - -# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // Tiny Core Dev board -#define IR_RECEIVE_PIN 18 -#define IR_SEND_PIN 19 -#define TONE_PIN 20 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output -#define LED_BUILTIN 2 // PA6 - -# elif defined(__AVR_ATtiny816__) // Tiny Core Micro -#define IR_RECEIVE_PIN 14 // PA1 -#define IR_SEND_PIN 16 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output -#define LED_BUILTIN 4 // PB5 - -# elif defined(__AVR_ATtiny1614__) -#define IR_RECEIVE_PIN 8 // PA1 -#define IR_SEND_PIN 10 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 - -# elif defined(__AVR_ATtiny1604__) -#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. -#define IR_SEND_PIN 3 -#define APPLICATION_PIN 5 +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 #define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it +#define TONE_PIN 42 // Dummy for examples using it # elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ || defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ @@ -139,6 +155,15 @@ # endif # endif // defined(__AVR_ATtiny25__)... +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + #elif defined(ESP8266) #define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW #define IR_RECEIVE_PIN 14 // D5 @@ -148,21 +173,32 @@ #define tone(...) void() // tone() inhibits receive timer #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it - -#elif defined(CONFIG_IDF_TARGET_ESP32C3) -#define IR_INPUT_PIN 8 -#define IR_SEND_PIN 9 -#define TONE_PIN 10 // ADC2_0 -#define APPLICATION_PIN 11 +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 #elif defined(ESP32) #include // tone() is included in ESP32 core since 2.0.2 -#if !defined(ESP_ARDUINO_VERSION_VAL) -#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) 12345678 -#endif +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif #if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) #define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. void tone(uint8_t aPinNumber, unsigned int aFrequency){ @@ -205,7 +241,8 @@ void noTone(uint8_t aPinNumber){ #define IR_SEND_PIN 12 #define TONE_PIN 5 -#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect #define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico #define IR_SEND_PIN 4 // GPIO16 #define TONE_PIN 5 @@ -252,14 +289,18 @@ void noTone(uint8_t aPinNumber){ #define _IR_TIMING_TEST_PIN 7 #elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else #define IR_RECEIVE_PIN 2 +# endif #define IR_SEND_PIN 3 #define TONE_PIN 4 #define APPLICATION_PIN 5 #define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. #define _IR_TIMING_TEST_PIN 7 -#if !defined(ARDUINO_SAMD_ADAFRUIT) +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) // On the Zero and others we switch explicitly to SerialUSB #define Serial SerialUSB #endif @@ -299,19 +340,13 @@ void noTone(uint8_t aPinNumber){ #define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation #else # if defined(SEND_PWM_BY_TIMER) -#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warning in IRTimer.hpp +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp # endif #endif #if !defined (FLASHEND) #define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined #endif -#if !defined (RAMEND) -#define RAMEND 0xFFFF // Dummy value for platforms where RAMEND is not defined -#endif -#if !defined (RAMSIZE) -#define RAMSIZE 0xFFFF // Dummy value for platforms where RAMSIZE is not defined -#endif /* * Helper macro for getting a macro definition as string diff --git a/examples/ReceiveDemo/ReceiveDemo.ino b/examples/ReceiveDemo/ReceiveDemo.ino index 0f9279a4b..e7aa1eb7b 100644 --- a/examples/ReceiveDemo/ReceiveDemo.ino +++ b/examples/ReceiveDemo/ReceiveDemo.ino @@ -2,14 +2,15 @@ * ReceiveDemo.cpp * * Demonstrates receiving IR codes with the IRremote library and the use of the Arduino tone() function with this library. - * If debug button is pressed (pin connected to ground) a long output is generated. + * Long press of one IR button (receiving of multiple repeats for one command) is detected. + * If debug button is pressed (pin connected to ground) a long output is generated, which may disturb detecting of repeats. * * This file is part of Arduino-IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. * ************************************************************************************ * MIT License * - * Copyright (c) 2020-2022 Armin Joachimsmeyer + * Copyright (c) 2020-2025 Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -42,42 +43,67 @@ * If no protocol is defined, all protocols (except Bang&Olufsen) are active. * This must be done before the #include */ -// 3 protocol specification examples +//#define DECODE_DENON // Includes Sharp +//#define DECODE_JVC +//#define DECODE_KASEIKYO +//#define DECODE_PANASONIC // alias for DECODE_KASEIKYO //#define DECODE_LG -//#define DECODE_NEC +//#define DECODE_ONKYO // Decodes only Onkyo and not NEC or Apple +//#define DECODE_NEC // Includes Apple and Onkyo +//#define DECODE_SAMSUNG +//#define DECODE_SONY +//#define DECODE_RC5 +//#define DECODE_RC6 +//#define DECODE_BOSEWAVE +//#define DECODE_LEGO_PF +//#define DECODE_MAGIQUEST +//#define DECODE_WHYNTER +//#define DECODE_FAST //#define DECODE_DISTANCE_WIDTH // Universal decoder for pulse distance width protocols +//#define DECODE_HASH // special decoder for all protocols +//#define DECODE_BEO // This protocol must always be enabled manually, i.e. it is NOT enabled if no protocol is defined. It prevents decoding of SONY! #if FLASHEND >= 0x3FFF // For 16k flash or more, like ATtiny1604. Code does not fit in program memory of ATtiny85 etc. // !!! Enabling B&O disables detection of Sony, because the repeat gap for SONY is smaller than the B&O frame gap :-( !!! //#define DECODE_BEO // Bang & Olufsen protocol always must be enabled explicitly. It has an IR transmit frequency of 455 kHz! It prevents decoding of SONY! -#endif -#if defined(DECODE_BEO) -#define RECORD_GAP_MICROS 16000 // always get the complete frame in the receive buffer, but this prevents decoding of SONY! +#else +// for 8k flash +//#define DECODE_DENON // Includes Sharp +#define DECODE_JVC +#define DECODE_KASEIKYO +#define DECODE_PANASONIC // alias for DECODE_KASEIKYO +#define DECODE_LG +#define DECODE_NEC // Includes Apple and Onkyo +#define DECODE_SAMSUNG +//#define DECODE_SONY +//#define DECODE_RC5 +//#define DECODE_RC6 +#define DECODE_DISTANCE_WIDTH // Universal decoder for pulse distance width protocols +#define DECODE_HASH // special decoder for all protocols + +#define EXCLUDE_EXOTIC_PROTOCOLS #endif // etc. see IRremote.hpp // #if !defined(RAW_BUFFER_LENGTH) -# if RAMEND <= 0x4FF || RAMSIZE < 0x4FF -#define RAW_BUFFER_LENGTH 130 // 750 (600 if we have only 2k RAM) is the value for air condition remotes. Default is 112 if DECODE_MAGIQUEST is enabled, otherwise 100. -#define EXCLUDE_EXOTIC_PROTOCOLS // saves around 650 bytes program memory if all other protocols are active -#define EXCLUDE_UNIVERSAL_PROTOCOLS // Saves up to 1000 bytes program memory. -# elif RAMEND <= 0x8FF || RAMSIZE < 0x8FF -#define RAW_BUFFER_LENGTH 600 // 750 (600 if we have only 2k RAM) is the value for air condition remotes. Default is 112 if DECODE_MAGIQUEST is enabled, otherwise 100. -# else -#define RAW_BUFFER_LENGTH 750 // 750 (600 if we have only 2k RAM) is the value for air condition remotes. Default is 112 if DECODE_MAGIQUEST is enabled, otherwise 100. +// For air condition remotes it may require up to 750. Default is 200. +# if !((defined(RAMEND) && RAMEND <= 0x4FF) || (defined(RAMSIZE) && RAMSIZE < 0x4FF)) +#define RAW_BUFFER_LENGTH 750 # endif #endif //#define NO_LED_FEEDBACK_CODE // saves 92 bytes program memory //#define EXCLUDE_UNIVERSAL_PROTOCOLS // Saves up to 1000 bytes program memory. //#define EXCLUDE_EXOTIC_PROTOCOLS // saves around 650 bytes program memory if all other protocols are active - +//#define IR_REMOTE_DISABLE_RECEIVE_COMPLETE_CALLBACK // saves 32 bytes program memory // MARK_EXCESS_MICROS is subtracted from all marks and added to all spaces before decoding, // to compensate for the signal forming of different IR receiver modules. See also IRremote.hpp line 142. //#define MARK_EXCESS_MICROS 20 // Adapt it to your IR receiver module. 40 is taken for the cheap VS1838 module her, since we have high intensity. - -//#define RECORD_GAP_MICROS 12000 // Default is 5000. Activate it for some LG air conditioner protocols +#if defined(DECODE_BEO) +#define RECORD_GAP_MICROS 16000 // always get the complete frame in the receive buffer, but this prevents decoding of SONY! +#endif +//#define RECORD_GAP_MICROS 12000 // Default is 8000. Activate it for some LG air conditioner protocols //#define DEBUG // Activate this for lots of lovely debug output from the decoders. @@ -88,16 +114,30 @@ #else #define DEBUG_BUTTON_PIN 6 #endif +#if defined(ESP32) +# if !digitalPinIsValid(DEBUG_BUTTON_PIN) +#undef DEBUG_BUTTON_PIN // DEBUG_BUTTON_PIN number is not valid, so delete definition to disable further usage +# endif +#endif + +void generateTone(); +void handleOverflow(); +bool detectLongPress(uint16_t aLongPressDurationMillis); void setup() { #if FLASHEND >= 0x3FFF // For 16k flash or more, like ATtiny1604. Code does not fit in program memory of ATtiny85 etc. +# if defined(DEBUG_BUTTON_PIN) pinMode(DEBUG_BUTTON_PIN, INPUT_PULLUP); +# endif #endif - Serial.begin(115200); -#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/|| defined(SERIALUSB_PID) || defined(ARDUINO_attiny3217) + Serial.begin(9600); + +#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/ \ + || defined(SERIALUSB_PID) || defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_attiny3217) || (defined(ESP32) && defined(ARDUINO_USB_MODE)) delay(4000); // To be able to connect Serial monitor after reset or power up and before first print out. Do not wait for an attached Serial Monitor! #endif + // Just to know which program is running on my Arduino Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE)); @@ -116,23 +156,32 @@ void setup() { Serial.println(F("at pin " STR(IR_RECEIVE_PIN))); #endif +#if defined(LED_BUILTIN) && !defined(NO_LED_FEEDBACK_CODE) +# if defined(FEEDBACK_LED_IS_ACTIVE_LOW) + Serial.print(F("Active low ")); +# endif + Serial.print(F("FeedbackLED at pin ")); + Serial.println(LED_BUILTIN); // Works also for ESP32: static const uint8_t LED_BUILTIN = 8; #define LED_BUILTIN LED_BUILTIN +#endif + #if FLASHEND >= 0x3FFF // For 16k flash or more, like ATtiny1604. Code does not fit in program memory of ATtiny85 etc. Serial.println(); +# if defined(DEBUG_BUTTON_PIN) Serial.print(F("If you connect debug pin ")); -# if defined(APPLICATION_PIN_STRING) +# if defined(APPLICATION_PIN_STRING) Serial.print(APPLICATION_PIN_STRING); -# else +# else Serial.print(DEBUG_BUTTON_PIN); +# endif + Serial.println(F(" to ground, raw data is always printed and tone is disabled")); # endif - Serial.println(F(" to ground, raw data is always printed")); // infos for receive Serial.print(RECORD_GAP_MICROS); Serial.println(F(" us is the (minimum) gap, after which the start of a new IR packet is assumed")); Serial.print(MARK_EXCESS_MICROS); Serial.println(F(" us are subtracted from all marks and added to all spaces for decoding")); -#endif - +#endif // FLASHEND >= 0x3FFF } void loop() { @@ -143,112 +192,96 @@ void loop() { * E.g. command is in IrReceiver.decodedIRData.command * address is in command is in IrReceiver.decodedIRData.address * and up to 32 bit raw data in IrReceiver.decodedIRData.decodedRawData - * - * At 115200 baud, printing takes 40 ms for NEC protocol and 10 ms for NEC repeat */ if (IrReceiver.decode()) { Serial.println(); -#if FLASHEND >= 0x3FFF // For 16k flash or more, like ATtiny1604 +#if FLASHEND < 0x3FFF // For less than 16k flash, only print a minimal summary of received data + IrReceiver.printIRResultMinimal(&Serial); +#else + + /* + * + */ if (IrReceiver.decodedIRData.flags & IRDATA_FLAGS_WAS_OVERFLOW) { - Serial.println(F("Overflow detected")); - Serial.println(F("Try to increase the \"RAW_BUFFER_LENGTH\" value of " STR(RAW_BUFFER_LENGTH) " in " __FILE__)); - // see also https://github.com/Arduino-IRremote/Arduino-IRremote#compile-options--macros-for-this-library -# if !defined(ESP8266) && !defined(NRF5) + handleOverflow(); + } else { /* - * do double beep + * No overflow here. + * Stop receiver, generate a single beep, print short info and send usage and start receiver again */ -# if !defined(ESP32) - IrReceiver.stop(); // ESP32 uses another timer for tone() -# endif - tone(TONE_PIN, 1100, 10); - delay(50); - tone(TONE_PIN, 1100, 10); - delay(50); -# if !defined(ESP32) - IrReceiver.start(100000); // to compensate for 100 ms stop of receiver. This enables a correct gap measurement. -# endif -# endif - - } else { - auto tStartMillis = millis(); -# if !defined(ESP32) - IrReceiver.stop(); // ESP32 uses another timer for tone() -# endif - tone(TONE_PIN, 2200); - - // No overflow, print a short summary of received data -# if defined(LOCAL_DEBUG) - IrReceiver.printIRResultShort(&Serial, true); -# else - IrReceiver.printIRResultShort(&Serial, true, digitalRead(DEBUG_BUTTON_PIN) == LOW); -# endif - // Guarantee at least 5 millis for tone. decode starts 5 millis (RECORD_GAP_MICROS) after end of frame - // so here we are 10 millis after end of frame. Sony20 has only a 12 ms repeat gap. - while ((millis() - tStartMillis) < 5) - ; - noTone(TONE_PIN); - -# if !defined(ESP32) - // Restore IR timer. millis() - tStartMillis to compensate for stop of receiver. This enables a correct gap measurement. - IrReceiver.startWithTicksToAdd((millis() - tStartMillis) * (MICROS_IN_ONE_MILLI / MICROS_PER_TICK)); -# endif + if ((IrReceiver.decodedIRData.protocol != SONY) && (IrReceiver.decodedIRData.protocol != PULSE_WIDTH) + && (IrReceiver.decodedIRData.protocol != PULSE_DISTANCE) && (IrReceiver.decodedIRData.protocol != UNKNOWN) +#if defined(DEBUG_BUTTON_PIN) + && digitalRead(DEBUG_BUTTON_PIN) != LOW +#endif + ) { + /* + * For SONY the tone prevents the detection of a repeat after the 15 ms SONY gap. + * In debug mode and for unknown protocols, we need the time for extended output. + * Skipping tone will get exact gap time between transmissions and not running into repeat frames while wait for tone to end. + * This in turn enables the next CheckForRecordGapsMicros() call a chance to eventually propose a change of the current RECORD_GAP_MICROS value. + */ + generateTone(); + } - IrReceiver.printIRSendUsage(&Serial); -# if defined(LOCAL_DEBUG) - IrReceiver.printIRResultRawFormatted(&Serial, true); -# else - if (IrReceiver.decodedIRData.protocol == UNKNOWN || digitalRead(DEBUG_BUTTON_PIN) == LOW) { - // We have an unknown protocol, print more info + /* + * Print info + */ + if (IrReceiver.decodedIRData.protocol == UNKNOWN +#if defined(DEBUG_BUTTON_PIN) + || digitalRead(DEBUG_BUTTON_PIN) == LOW) +#endif + { + // We have debug enabled or an unknown protocol, print extended info if (IrReceiver.decodedIRData.protocol == UNKNOWN) { Serial.println(F("Received noise or an unknown (or not yet enabled) protocol")); } IrReceiver.printIRResultRawFormatted(&Serial, true); } -# endif - } + if (IrReceiver.decodedIRData.protocol == UNKNOWN) { + auto tDecodedRawData = IrReceiver.decodedIRData.decodedRawData; // uint32_t on 8 and 16 bit CPUs and uint64_t on 32 and 64 bit CPUs + Serial.print(F("Raw data received are 0x")); + Serial.println(tDecodedRawData); - // tone on esp8266 works once, then it disables the successful IrReceiver.start() / timerConfigForReceive(). -# if !defined(ESP8266) && !defined(NRF5) && !defined(LOCAL_DEBUG) - if ((IrReceiver.decodedIRData.protocol != SONY) && (IrReceiver.decodedIRData.protocol != PULSE_WIDTH) - && (IrReceiver.decodedIRData.protocol != PULSE_DISTANCE) && (IrReceiver.decodedIRData.protocol != UNKNOWN) - && digitalRead(DEBUG_BUTTON_PIN) != LOW) { - /* - * If no debug mode or a valid protocol was received, play tone, wait and restore IR timer. - * For SONY the tone prevents the detection of a repeat - * Otherwise do not play a tone to get exact gap time between transmissions and not running into repeat frames while wait for tone to end. - * This will give the next CheckForRecordGapsMicros() call a chance to eventually propose a change of the current RECORD_GAP_MICROS value. - */ -# if !defined(ESP32) - IrReceiver.stop(); // ESP32 uses another timer for tone() -# endif - tone(TONE_PIN, 2200, 8); -# if !defined(ESP32) - delay(8); - IrReceiver.start(8000); // Restore IR timer. 8000 to compensate for 8 ms stop of receiver. This enables a correct gap measurement. -# endif + } else { + /* + * The info output for a successful receive + */ + IrReceiver.printIRResultShort(&Serial); + IrReceiver.printIRSendUsage(&Serial); + } } -# endif -#else // #if FLASHEND >= 0x3FFF - // Print a minimal summary of received data - IrReceiver.printIRResultMinimal(&Serial); #endif // #if FLASHEND >= 0x3FFF /* - * !!!Important!!! Enable receiving of the next value, - * since receiving has stopped after the end of the current received data packet. + * !!!Important!!! Enable receiving of the next value, because receiving + * has stopped after the end of the current received data packet. + * Do it here, to preserve raw data for printing with printIRResultRawFormatted() */ IrReceiver.resume(); /* * Finally check the received data and perform actions according to the received address and commands */ - if (IrReceiver.decodedIRData.address == 0) { - if (IrReceiver.decodedIRData.command == 0x10) { - // do something - } else if (IrReceiver.decodedIRData.command == 0x11) { - // do something else + + if (IrReceiver.decodedIRData.flags & IRDATA_FLAGS_IS_REPEAT) { + Serial.println(F("Repeat received. Here you can repeat the same action as before.")); + } else { + if (IrReceiver.decodedIRData.address == 0) { + if (IrReceiver.decodedIRData.command == 0x10) { + // do something + } else if (IrReceiver.decodedIRData.command == 0x11) { + // do something else + } } } + + // Check if repeats of the IR command was sent for more than 1000 ms + if (detectLongPress(1000)) { + Serial.print(F("Command 0x")); + Serial.print(IrReceiver.decodedIRData.command, HEX); + Serial.println(F(" was repeated for more than 2 seconds")); + } } // if (IrReceiver.decode()) /* @@ -260,3 +293,69 @@ void loop() { */ } + +#if FLASHEND >= 0x3FFF // No tone() available when using ATTinyCore +/* + * Stop receiver, generate a single beep and start receiver again + */ +void generateTone() { +# if !defined(ESP8266) && !defined(NRF5) // tone on esp8266 works only once, then it disables IrReceiver.restartTimer() / timerConfigForReceive(). +# if defined(ESP32) // ESP32 uses another timer for tone(), maybe other platforms (not tested yet) too. + tone(TONE_PIN, 2200, 8); +# else + IrReceiver.stopTimer(); // Stop timer consistently before calling tone() or other functions using the timer resource. + tone(TONE_PIN, 2200, 8); + delay(8); + IrReceiver.restartTimer(); // Restart IR timer after timer resource is no longer blocked. +# endif +# endif +} +#endif // FLASHEND >= 0x3FFF + +void handleOverflow() { + Serial.println(F("Overflow detected")); + Serial.println(F("Try to increase the \"RAW_BUFFER_LENGTH\" value of " STR(RAW_BUFFER_LENGTH) " in " __FILE__)); + // see also https://github.com/Arduino-IRremote/Arduino-IRremote#compile-options--macros-for-this-library + +#if !defined(ESP8266) && !defined(NRF5) && FLASHEND >= 0x3FFF // tone on esp8266 works once, then it disables IrReceiver.restartTimer() / timerConfigForReceive(). + /* + * Stop timer, generate a double beep and start timer again + */ +# if defined(ESP32) // ESP32 uses another timer for tone() + tone(TONE_PIN, 1100, 10); + delay(50); + tone(TONE_PIN, 1100, 10); +# else + IrReceiver.stopTimer(); + tone(TONE_PIN, 1100, 10); + delay(50); + tone(TONE_PIN, 1100, 10); + delay(50); + IrReceiver.restartTimer(); +# endif +#endif +} + +unsigned long sMillisOfFirstReceive; +bool sLongPressJustDetected; +/** + * True once we received the consecutive repeats for more than aLongPressDurationMillis milliseconds. + * The first frame, which is no repeat, is NOT counted for the duration! + * @return true once after the repeated IR command was received for longer than aLongPressDurationMillis milliseconds, false otherwise. + */ +bool detectLongPress(uint16_t aLongPressDurationMillis) { + if (!sLongPressJustDetected && (IrReceiver.decodedIRData.flags & IRDATA_FLAGS_IS_REPEAT)) { + /* + * Here the repeat flag is set (which implies, that command is the same as the previous one) + */ + if (millis() - aLongPressDurationMillis > sMillisOfFirstReceive) { + sLongPressJustDetected = true; // Long press here + } + } else { + // No repeat here + sMillisOfFirstReceive = millis(); + sLongPressJustDetected = false; + } + return sLongPressJustDetected; // No long press here +} + diff --git a/examples/ReceiveDump/PinDefinitionsAndMore.h b/examples/ReceiveDump/PinDefinitionsAndMore.h index cb2b3b86d..b13414f56 100644 --- a/examples/ReceiveDump/PinDefinitionsAndMore.h +++ b/examples/ReceiveDump/PinDefinitionsAndMore.h @@ -4,7 +4,7 @@ * Contains pin definitions for IRremote examples for various platforms * as well as definitions for feedback LED and tone() and includes * - * Copyright (C) 2021-2022 Armin Joachimsmeyer + * Copyright (C) 2021-2023 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. @@ -32,81 +32,97 @@ * DEFAULT/AVR 2 3 4 Arduino * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore - * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark pro - * ATtiny3217 18|PA1 19|PA2 20|PA3 MegaTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore * ATtiny1604 2 3|PA5 % * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore - * SAMD21 3 4 5 + * MKR* 1 3 4 + * SAMD 2 3 4 * ESP8266 14|D5 12|D6 % - * ESP32 15 4 27 - * BluePill PA6 PA7 PA3 + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 * APOLLO3 11 12 5 * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 */ //#define _IR_MEASURE_TIMING // For debugging purposes. #if defined(__AVR__) -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board -#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore -#define IR_RECEIVE_PIN 0 -#define IR_SEND_PIN 4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. -#define TONE_PIN 3 -#define _IR_TIMING_TEST_PIN 3 +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 # elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board #include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" // For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. # if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core #define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 //#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards #define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 #define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 #define _IR_TIMING_TEST_PIN 10 // PA4 # else -#define IR_RECEIVE_PIN 3 // PA3 - on Digispark board labeled as pin 9 -#define IR_SEND_PIN 2 // PA2 - on Digispark board labeled as pin 8 -#define TONE_PIN 7 // PA7 - on Digispark board labeled as pin 5 +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 # endif -# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board -#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory -// Pin 6 is TX pin 7 is RX -#define IR_RECEIVE_PIN 3 // INT1 -#define IR_SEND_PIN 4 -#define TONE_PIN 9 -#define _IR_TIMING_TEST_PIN 8 - -# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // Tiny Core Dev board -#define IR_RECEIVE_PIN 18 -#define IR_SEND_PIN 19 -#define TONE_PIN 20 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output -#define LED_BUILTIN 2 // PA6 - -# elif defined(__AVR_ATtiny816__) // Tiny Core Micro -#define IR_RECEIVE_PIN 14 // PA1 -#define IR_SEND_PIN 16 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output -#define LED_BUILTIN 4 // PB5 - -# elif defined(__AVR_ATtiny1614__) -#define IR_RECEIVE_PIN 8 // PA1 -#define IR_SEND_PIN 10 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 - -# elif defined(__AVR_ATtiny1604__) -#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. -#define IR_SEND_PIN 3 -#define APPLICATION_PIN 5 +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 #define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it +#define TONE_PIN 42 // Dummy for examples using it # elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ || defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ @@ -139,6 +155,15 @@ # endif # endif // defined(__AVR_ATtiny25__)... +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + #elif defined(ESP8266) #define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW #define IR_RECEIVE_PIN 14 // D5 @@ -148,21 +173,32 @@ #define tone(...) void() // tone() inhibits receive timer #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it - -#elif defined(CONFIG_IDF_TARGET_ESP32C3) -#define IR_INPUT_PIN 8 -#define IR_SEND_PIN 9 -#define TONE_PIN 10 // ADC2_0 -#define APPLICATION_PIN 11 +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 #elif defined(ESP32) #include // tone() is included in ESP32 core since 2.0.2 -#if !defined(ESP_ARDUINO_VERSION_VAL) -#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) 12345678 -#endif +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif #if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) #define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. void tone(uint8_t aPinNumber, unsigned int aFrequency){ @@ -205,7 +241,8 @@ void noTone(uint8_t aPinNumber){ #define IR_SEND_PIN 12 #define TONE_PIN 5 -#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect #define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico #define IR_SEND_PIN 4 // GPIO16 #define TONE_PIN 5 @@ -252,14 +289,18 @@ void noTone(uint8_t aPinNumber){ #define _IR_TIMING_TEST_PIN 7 #elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else #define IR_RECEIVE_PIN 2 +# endif #define IR_SEND_PIN 3 #define TONE_PIN 4 #define APPLICATION_PIN 5 #define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. #define _IR_TIMING_TEST_PIN 7 -#if !defined(ARDUINO_SAMD_ADAFRUIT) +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) // On the Zero and others we switch explicitly to SerialUSB #define Serial SerialUSB #endif @@ -299,19 +340,13 @@ void noTone(uint8_t aPinNumber){ #define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation #else # if defined(SEND_PWM_BY_TIMER) -#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warning in IRTimer.hpp +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp # endif #endif #if !defined (FLASHEND) #define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined #endif -#if !defined (RAMEND) -#define RAMEND 0xFFFF // Dummy value for platforms where RAMEND is not defined -#endif -#if !defined (RAMSIZE) -#define RAMSIZE 0xFFFF // Dummy value for platforms where RAMSIZE is not defined -#endif /* * Helper macro for getting a macro definition as string diff --git a/examples/ReceiveDump/ReceiveDump.ino b/examples/ReceiveDump/ReceiveDump.ino index 0f3297788..b01010626 100644 --- a/examples/ReceiveDump/ReceiveDump.ino +++ b/examples/ReceiveDump/ReceiveDump.ino @@ -10,7 +10,7 @@ ************************************************************************************ * MIT License * - * Copyright (c) 2020-2022 Armin Joachimsmeyer + * Copyright (c) 2020-2024 Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -36,12 +36,9 @@ #include "PinDefinitionsAndMore.h" // Define macros for input and output pin etc. #if !defined(RAW_BUFFER_LENGTH) -# if RAMEND <= 0x4FF || RAMSIZE < 0x4FF -#define RAW_BUFFER_LENGTH 180 // 750 (600 if we have only 2k RAM) is the value for air condition remotes. Default is 112 if DECODE_MAGIQUEST is enabled, otherwise 100. -# elif RAMEND <= 0x8FF || RAMSIZE < 0x8FF -#define RAW_BUFFER_LENGTH 600 // 750 (600 if we have only 2k RAM) is the value for air condition remotes. Default is 112 if DECODE_MAGIQUEST is enabled, otherwise 100. -# else -#define RAW_BUFFER_LENGTH 750 // 750 (600 if we have only 2k RAM) is the value for air condition remotes. Default is 112 if DECODE_MAGIQUEST is enabled, otherwise 100. +// For air condition remotes it may require up to 750. Default is 200. +# if !((defined(RAMEND) && RAMEND <= 0x4FF) || (defined(RAMSIZE) && RAMSIZE < 0x4FF)) +#define RAW_BUFFER_LENGTH 730 // this allows usage of 16 bit raw buffer, for RECORD_GAP_MICROS > 20000 # endif #endif @@ -56,7 +53,7 @@ */ #define MARK_EXCESS_MICROS 20 // Adapt it to your IR receiver module. 20 is recommended for the cheap VS1838 modules. -//#define RECORD_GAP_MICROS 12000 // Default is 5000. Activate it for some LG air conditioner protocols +//#define RECORD_GAP_MICROS 12000 // Default is 8000. Activate it for some LG air conditioner protocols //#define DEBUG // Activate this for lots of lovely debug output from the decoders. #include @@ -68,9 +65,17 @@ void setup() { pinMode(LED_BUILTIN, OUTPUT); Serial.begin(115200); // Status message will be sent to PC at 9600 baud -#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/|| defined(SERIALUSB_PID) || defined(ARDUINO_attiny3217) - delay(4000); // To be able to connect Serial monitor after reset or power up and before first print out. Do not wait for an attached Serial Monitor! + +#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/ \ + || defined(SERIALUSB_PID) || defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_attiny3217) + // Wait until Serial Monitor is attached. + // Required for boards using USB code for Serial like Leonardo. + // Is void for USB Serial implementations using external chips e.g. a CH340. + while (!Serial) + ; + // !!! Program will not proceed if no Serial Monitor is attached !!! #endif + // Just to know which program is running on my Arduino Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE)); @@ -86,8 +91,13 @@ void setup() { Serial.println(F(" us is the (minimum) gap, after which the start of a new IR packet is assumed")); Serial.print(MARK_EXCESS_MICROS); Serial.println(); - Serial.println(F("Because of the verbose output (>200 ms at 115200), repeats are probably not dumped correctly!")); + Serial.println(F("Because of the verbose output (>200 ms at 115200 baud), repeats are not dumped correctly!")); + Serial.println(); + Serial.println( + F( + "If you receive protocol NEC, Samsung or LG, run also ReceiveDemo to check if your actual protocol is eventually NEC2 or SamsungLG, which is determined by the repeats")); Serial.println(); + } //+============================================================================= @@ -122,6 +132,7 @@ void loop() { Serial.println(MARK_EXCESS_MICROS); IrReceiver.compensateAndPrintIRResultAsCArray(&Serial, true); // Output the results as uint16_t source code array of micros IrReceiver.printIRResultAsCVariables(&Serial); // Output address and data as source code variables + Serial.println(); // blank line between entries IrReceiver.compensateAndPrintIRResultAsPronto(&Serial); @@ -129,7 +140,7 @@ void loop() { * Example for using the compensateAndStorePronto() function. * Creating this String requires 2210 bytes program memory and 10 bytes RAM for the String class. * The String object itself requires additional 440 bytes RAM from the heap. - * This values are for an Arduino UNO. + * This values are for an Arduino Uno. */ // Serial.println(); // blank line between entries // String ProntoHEX = F("Pronto HEX contains: "); // Assign string to ProtoHex string object @@ -144,6 +155,6 @@ void loop() { // Serial.println(); // blank line between entries // } } - IrReceiver.resume(); // Prepare for the next value + IrReceiver.resume(); // Prepare for the next IR frame } } diff --git a/examples/ReceiveOneAndSendMultiple/PinDefinitionsAndMore.h b/examples/ReceiveOneAndSendMultiple/PinDefinitionsAndMore.h index cb2b3b86d..b13414f56 100644 --- a/examples/ReceiveOneAndSendMultiple/PinDefinitionsAndMore.h +++ b/examples/ReceiveOneAndSendMultiple/PinDefinitionsAndMore.h @@ -4,7 +4,7 @@ * Contains pin definitions for IRremote examples for various platforms * as well as definitions for feedback LED and tone() and includes * - * Copyright (C) 2021-2022 Armin Joachimsmeyer + * Copyright (C) 2021-2023 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. @@ -32,81 +32,97 @@ * DEFAULT/AVR 2 3 4 Arduino * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore - * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark pro - * ATtiny3217 18|PA1 19|PA2 20|PA3 MegaTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore * ATtiny1604 2 3|PA5 % * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore - * SAMD21 3 4 5 + * MKR* 1 3 4 + * SAMD 2 3 4 * ESP8266 14|D5 12|D6 % - * ESP32 15 4 27 - * BluePill PA6 PA7 PA3 + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 * APOLLO3 11 12 5 * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 */ //#define _IR_MEASURE_TIMING // For debugging purposes. #if defined(__AVR__) -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board -#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore -#define IR_RECEIVE_PIN 0 -#define IR_SEND_PIN 4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. -#define TONE_PIN 3 -#define _IR_TIMING_TEST_PIN 3 +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 # elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board #include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" // For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. # if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core #define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 //#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards #define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 #define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 #define _IR_TIMING_TEST_PIN 10 // PA4 # else -#define IR_RECEIVE_PIN 3 // PA3 - on Digispark board labeled as pin 9 -#define IR_SEND_PIN 2 // PA2 - on Digispark board labeled as pin 8 -#define TONE_PIN 7 // PA7 - on Digispark board labeled as pin 5 +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 # endif -# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board -#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory -// Pin 6 is TX pin 7 is RX -#define IR_RECEIVE_PIN 3 // INT1 -#define IR_SEND_PIN 4 -#define TONE_PIN 9 -#define _IR_TIMING_TEST_PIN 8 - -# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // Tiny Core Dev board -#define IR_RECEIVE_PIN 18 -#define IR_SEND_PIN 19 -#define TONE_PIN 20 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output -#define LED_BUILTIN 2 // PA6 - -# elif defined(__AVR_ATtiny816__) // Tiny Core Micro -#define IR_RECEIVE_PIN 14 // PA1 -#define IR_SEND_PIN 16 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output -#define LED_BUILTIN 4 // PB5 - -# elif defined(__AVR_ATtiny1614__) -#define IR_RECEIVE_PIN 8 // PA1 -#define IR_SEND_PIN 10 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 - -# elif defined(__AVR_ATtiny1604__) -#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. -#define IR_SEND_PIN 3 -#define APPLICATION_PIN 5 +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 #define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it +#define TONE_PIN 42 // Dummy for examples using it # elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ || defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ @@ -139,6 +155,15 @@ # endif # endif // defined(__AVR_ATtiny25__)... +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + #elif defined(ESP8266) #define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW #define IR_RECEIVE_PIN 14 // D5 @@ -148,21 +173,32 @@ #define tone(...) void() // tone() inhibits receive timer #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it - -#elif defined(CONFIG_IDF_TARGET_ESP32C3) -#define IR_INPUT_PIN 8 -#define IR_SEND_PIN 9 -#define TONE_PIN 10 // ADC2_0 -#define APPLICATION_PIN 11 +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 #elif defined(ESP32) #include // tone() is included in ESP32 core since 2.0.2 -#if !defined(ESP_ARDUINO_VERSION_VAL) -#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) 12345678 -#endif +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif #if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) #define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. void tone(uint8_t aPinNumber, unsigned int aFrequency){ @@ -205,7 +241,8 @@ void noTone(uint8_t aPinNumber){ #define IR_SEND_PIN 12 #define TONE_PIN 5 -#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect #define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico #define IR_SEND_PIN 4 // GPIO16 #define TONE_PIN 5 @@ -252,14 +289,18 @@ void noTone(uint8_t aPinNumber){ #define _IR_TIMING_TEST_PIN 7 #elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else #define IR_RECEIVE_PIN 2 +# endif #define IR_SEND_PIN 3 #define TONE_PIN 4 #define APPLICATION_PIN 5 #define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. #define _IR_TIMING_TEST_PIN 7 -#if !defined(ARDUINO_SAMD_ADAFRUIT) +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) // On the Zero and others we switch explicitly to SerialUSB #define Serial SerialUSB #endif @@ -299,19 +340,13 @@ void noTone(uint8_t aPinNumber){ #define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation #else # if defined(SEND_PWM_BY_TIMER) -#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warning in IRTimer.hpp +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp # endif #endif #if !defined (FLASHEND) #define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined #endif -#if !defined (RAMEND) -#define RAMEND 0xFFFF // Dummy value for platforms where RAMEND is not defined -#endif -#if !defined (RAMSIZE) -#define RAMSIZE 0xFFFF // Dummy value for platforms where RAMSIZE is not defined -#endif /* * Helper macro for getting a macro definition as string diff --git a/examples/ReceiveOneAndSendMultiple/ReceiveOneAndSendMultiple.ino b/examples/ReceiveOneAndSendMultiple/ReceiveOneAndSendMultiple.ino index 34baa144e..e11a0875e 100644 --- a/examples/ReceiveOneAndSendMultiple/ReceiveOneAndSendMultiple.ino +++ b/examples/ReceiveOneAndSendMultiple/ReceiveOneAndSendMultiple.ino @@ -13,7 +13,7 @@ ************************************************************************************ * MIT License * - * Copyright (c) 2020-2022 Armin Joachimsmeyer + * Copyright (c) 2020-2024 Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -44,7 +44,7 @@ // USB- 3.6V Z-Diode IR Output (4) PB4 3| |6 PB1 (1) Feedback LED // GND 4| |5 PB0 (0) IR Input // +----+ -/* SAUMSUMG REMOTE CODES (Model: BN59-01180A) +/* SAUMSUMG REMOTE CODES (Model: BN59-01180A) - Address is 0x07 * Power Button - 0x2 * Power Off - 0x98 * 1 - 0x4 @@ -92,7 +92,7 @@ // select only Samsung protocol for sending and receiving #define DECODE_SAMSUNG -#define ADDRESS_OF_SAMSUNG_REMOTE 0x0707 // The value you see as address in printIRResultShort() +#define ADDRESS_OF_SAMSUNG_REMOTE 0x07 // The value you see as address in printIRResultShort() #include "PinDefinitionsAndMore.h" // Define macros for input and output pin etc. #include @@ -104,7 +104,9 @@ void setup() { pinMode(LED_BUILTIN, OUTPUT); Serial.begin(115200); -#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/|| defined(SERIALUSB_PID) || defined(ARDUINO_attiny3217) + +#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/ \ + || defined(SERIALUSB_PID) || defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_attiny3217) delay(4000); // To be able to connect Serial monitor after reset or power up and before first print out. Do not wait for an attached Serial Monitor! #endif // Just to know which program is running on my Arduino @@ -123,7 +125,7 @@ void setup() { printActiveIRProtocols(&Serial); Serial.println(F("at pin " STR(IR_RECEIVE_PIN))); - IrSender.begin(); // Start with IR_SEND_PIN as send pin and enable feedback LED at default feedback LED pin + IrSender.begin(); // Start with IR_SEND_PIN -which is defined in PinDefinitionsAndMore.h- as send pin and enable feedback LED at default feedback LED pin Serial.println(F("Ready to send IR signals at pin " STR(IR_SEND_PIN))); } @@ -189,9 +191,9 @@ void sendSamsungSmartHubMacro(bool aDoSelect) { tWaitTimeAfterBoot = INITIAL_WAIT_TIME_SMARTHUB_READY_MILLIS; } -# if !defined(ESP32) - IrReceiver.stop(); // ESP32 uses another timer for tone() -# endif +#if !defined(ESP32) // ESP32 uses another timer for tone(), so the receiver must not be stopped and restarted for it + IrReceiver.stopTimer(); +#endif if (millis() < tWaitTimeAfterBoot) { // division by 1000 and printing requires much (8%) program memory Serial.print(F("It is ")); @@ -217,9 +219,9 @@ void sendSamsungSmartHubMacro(bool aDoSelect) { tone(TONE_PIN, 2200, 200); delay(200); -# if !defined(ESP32) - IrReceiver.start(200000); // to compensate for 200 ms stop of receiver. This enables a correct gap measurement. -# endif +#if !defined(ESP32) + IrReceiver.restartTimer(); // Restart IR timer. +#endif Serial.println(F("Wait for \"not supported\" to disappear")); delay(2000); diff --git a/examples/ReceiverTimingAnalysis/ReceiverTimingAnalysis.ino b/examples/ReceiverTimingAnalysis/ReceiverTimingAnalysis.ino index 1ee2bf92b..ab732bcd0 100644 --- a/examples/ReceiverTimingAnalysis/ReceiverTimingAnalysis.ino +++ b/examples/ReceiverTimingAnalysis/ReceiverTimingAnalysis.ino @@ -33,8 +33,8 @@ #include -#define IR_INPUT_PIN 2 -//#define IR_INPUT_PIN 3 +#define IR_RECEIVE_PIN 2 +//#define IR_RECEIVE_PIN 3 /* * Helper macro for getting a macro definition as string @@ -42,39 +42,50 @@ #define STR_HELPER(x) #x #define STR(x) STR_HELPER(x) +#if !(defined(EICRA) && defined(EIFR) && defined(EIMSK)) void measureTimingISR(void); +#endif -void setup() -{ +void setup() { pinMode(LED_BUILTIN, OUTPUT); + Serial.begin(115200); -#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/|| defined(SERIALUSB_PID) || defined(ARDUINO_attiny3217) - delay(4000); // To be able to connect Serial monitor after reset or power up and before first print out. Do not wait for an attached Serial Monitor! +#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/ \ + || defined(SERIALUSB_PID) || defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_attiny3217) + // Wait until Serial Monitor is attached. + // Required for boards using USB code for Serial like Leonardo. + // Is void for USB Serial implementations using external chips e.g. a CH340. + while (!Serial) + ; + // !!! Program will not proceed if no Serial Monitor is attached !!! #endif // Just to know which program is running on my Arduino Serial.println(F("START " __FILE__ " from " __DATE__)); #if defined(EICRA) && defined(EIFR) && defined(EIMSK) -# if (IR_INPUT_PIN == 2) +# if (IR_RECEIVE_PIN == 2) EICRA |= _BV(ISC00); // interrupt on any logical change EIFR |= _BV(INTF0); // clear interrupt bit EIMSK |= _BV(INT0); // enable interrupt on next change -# elif (IR_INPUT_PIN == 3) +# elif (IR_RECEIVE_PIN == 3) EICRA |= _BV(ISC10); // enable interrupt on pin3 on both edges for ATmega328 EIFR |= _BV(INTF1); // clear interrupt bit EIMSK |= _BV(INT1); // enable interrupt on next change # endif #else - attachInterrupt(digitalPinToInterrupt(IR_INPUT_PIN), measureTimingISR, CHANGE); +# if defined(ARDUINO_ARCH_SAMD) // see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ paragraph: Syntax + attachInterrupt(IR_RECEIVE_PIN, measureTimingISR, CHANGE); +# else + attachInterrupt(digitalPinToInterrupt(IR_RECEIVE_PIN), measureTimingISR, CHANGE); +# endif #endif - Serial.println(F("Ready to analyze NEC IR signal at pin " STR(IR_INPUT_PIN))); + Serial.println(F("Ready to analyze NEC IR signal at pin " STR(IR_RECEIVE_PIN))); Serial.println(); } uint8_t ISREdgeCounter = 0; volatile uint32_t LastMicros; -struct timingStruct -{ +struct timingStruct { uint16_t minimum; uint8_t indexOfMinimum; uint16_t maximum; @@ -93,23 +104,19 @@ struct timingStruct LongSpace; /* * Compute minimum, maximum and average */ -void processTmingValue(struct timingStruct *aTimingStruct, uint16_t aValue) -{ - if (aTimingStruct->SampleCount == 0) - { +void processTmingValue(struct timingStruct *aTimingStruct, uint16_t aValue) { + if (aTimingStruct->SampleCount == 0) { // initialize values aTimingStruct->minimum = UINT16_MAX; aTimingStruct->maximum = 0; aTimingStruct->SumForAverage = 0; } - if (aTimingStruct->minimum > aValue) - { + if (aTimingStruct->minimum > aValue) { aTimingStruct->minimum = aValue; aTimingStruct->indexOfMinimum = aTimingStruct->SampleCount; } - if (aTimingStruct->maximum < aValue) - { + if (aTimingStruct->maximum < aValue) { aTimingStruct->maximum = aValue; aTimingStruct->indexOfMaximum = aTimingStruct->SampleCount; } @@ -120,8 +127,7 @@ void processTmingValue(struct timingStruct *aTimingStruct, uint16_t aValue) } -void printTimingValues(struct timingStruct *aTimingStruct, const char *aCaption) -{ +void printTimingValues(struct timingStruct *aTimingStruct, const char *aCaption) { // if (aTimingStruct->LastPrintedCount != aTimingStruct->SampleCount) // { // aTimingStruct->LastPrintedCount = aTimingStruct->SampleCount; @@ -145,10 +151,8 @@ void printTimingValues(struct timingStruct *aTimingStruct, const char *aCaption) // } } -void loop() -{ - if (Mark.SampleCount >= 32) - { +void loop() { + if (Mark.SampleCount >= 32) { /* * This check enables statistics for longer protocols like Kaseikyo/Panasonics */ @@ -161,8 +165,7 @@ void loop() #endif uint32_t tMicrosDelta = micros() - tLastMicros; - if (tMicrosDelta > 10000) - { + if (tMicrosDelta > 10000) { // NEC signal ended just now Serial.println(); printTimingValues(&Mark, "Mark "); @@ -197,9 +200,9 @@ void loop() void IRAM_ATTR measureTimingISR() #else # if defined(EICRA) && defined(EIFR) && defined(EIMSK) -# if (IR_INPUT_PIN == 2) +# if (IR_RECEIVE_PIN == 2) ISR(INT0_vect) -# elif (IR_INPUT_PIN == 3) +# elif (IR_RECEIVE_PIN == 3) ISR(INT1_vect) # endif # else @@ -213,44 +216,34 @@ void measureTimingISR() /* * read level and give feedback */ - uint8_t tInputLevel = digitalRead(IR_INPUT_PIN); + uint8_t tInputLevel = digitalRead(IR_RECEIVE_PIN); digitalWrite(LED_BUILTIN, !tInputLevel); - if (tMicrosDelta > 10000) - { + if (tMicrosDelta > 10000) { // gap > 10 ms detected, reset counter to first detected edge and initialize timing structures ISREdgeCounter = 1; LongSpace.SampleCount = 0; ShortSpace.SampleCount = 0; Mark.SampleCount = 0; - } - else - { + } else { ISREdgeCounter++; } /* * Skip header mark and space and first bit mark and space */ - if (ISREdgeCounter > 4) - { - if (tInputLevel != LOW) - { + if (ISREdgeCounter > 4) { + if (tInputLevel != LOW) { // Mark ended processTmingValue(&Mark, tMicrosDelta); // Serial.print('M'); - } - else - { + } else { // Space ended - if (tMicrosDelta > 1000) - { + if (tMicrosDelta > 1000) { // long space - logical 1 processTmingValue(&LongSpace, tMicrosDelta); Serial.print('1'); - } - else - { + } else { // short space - logical 0 processTmingValue(&ShortSpace, tMicrosDelta); Serial.print('0'); diff --git a/examples/SendAndReceive/PinDefinitionsAndMore.h b/examples/SendAndReceive/PinDefinitionsAndMore.h index cb2b3b86d..b13414f56 100644 --- a/examples/SendAndReceive/PinDefinitionsAndMore.h +++ b/examples/SendAndReceive/PinDefinitionsAndMore.h @@ -4,7 +4,7 @@ * Contains pin definitions for IRremote examples for various platforms * as well as definitions for feedback LED and tone() and includes * - * Copyright (C) 2021-2022 Armin Joachimsmeyer + * Copyright (C) 2021-2023 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. @@ -32,81 +32,97 @@ * DEFAULT/AVR 2 3 4 Arduino * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore - * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark pro - * ATtiny3217 18|PA1 19|PA2 20|PA3 MegaTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore * ATtiny1604 2 3|PA5 % * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore - * SAMD21 3 4 5 + * MKR* 1 3 4 + * SAMD 2 3 4 * ESP8266 14|D5 12|D6 % - * ESP32 15 4 27 - * BluePill PA6 PA7 PA3 + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 * APOLLO3 11 12 5 * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 */ //#define _IR_MEASURE_TIMING // For debugging purposes. #if defined(__AVR__) -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board -#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore -#define IR_RECEIVE_PIN 0 -#define IR_SEND_PIN 4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. -#define TONE_PIN 3 -#define _IR_TIMING_TEST_PIN 3 +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 # elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board #include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" // For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. # if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core #define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 //#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards #define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 #define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 #define _IR_TIMING_TEST_PIN 10 // PA4 # else -#define IR_RECEIVE_PIN 3 // PA3 - on Digispark board labeled as pin 9 -#define IR_SEND_PIN 2 // PA2 - on Digispark board labeled as pin 8 -#define TONE_PIN 7 // PA7 - on Digispark board labeled as pin 5 +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 # endif -# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board -#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory -// Pin 6 is TX pin 7 is RX -#define IR_RECEIVE_PIN 3 // INT1 -#define IR_SEND_PIN 4 -#define TONE_PIN 9 -#define _IR_TIMING_TEST_PIN 8 - -# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // Tiny Core Dev board -#define IR_RECEIVE_PIN 18 -#define IR_SEND_PIN 19 -#define TONE_PIN 20 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output -#define LED_BUILTIN 2 // PA6 - -# elif defined(__AVR_ATtiny816__) // Tiny Core Micro -#define IR_RECEIVE_PIN 14 // PA1 -#define IR_SEND_PIN 16 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output -#define LED_BUILTIN 4 // PB5 - -# elif defined(__AVR_ATtiny1614__) -#define IR_RECEIVE_PIN 8 // PA1 -#define IR_SEND_PIN 10 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 - -# elif defined(__AVR_ATtiny1604__) -#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. -#define IR_SEND_PIN 3 -#define APPLICATION_PIN 5 +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 #define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it +#define TONE_PIN 42 // Dummy for examples using it # elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ || defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ @@ -139,6 +155,15 @@ # endif # endif // defined(__AVR_ATtiny25__)... +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + #elif defined(ESP8266) #define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW #define IR_RECEIVE_PIN 14 // D5 @@ -148,21 +173,32 @@ #define tone(...) void() // tone() inhibits receive timer #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it - -#elif defined(CONFIG_IDF_TARGET_ESP32C3) -#define IR_INPUT_PIN 8 -#define IR_SEND_PIN 9 -#define TONE_PIN 10 // ADC2_0 -#define APPLICATION_PIN 11 +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 #elif defined(ESP32) #include // tone() is included in ESP32 core since 2.0.2 -#if !defined(ESP_ARDUINO_VERSION_VAL) -#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) 12345678 -#endif +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif #if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) #define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. void tone(uint8_t aPinNumber, unsigned int aFrequency){ @@ -205,7 +241,8 @@ void noTone(uint8_t aPinNumber){ #define IR_SEND_PIN 12 #define TONE_PIN 5 -#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect #define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico #define IR_SEND_PIN 4 // GPIO16 #define TONE_PIN 5 @@ -252,14 +289,18 @@ void noTone(uint8_t aPinNumber){ #define _IR_TIMING_TEST_PIN 7 #elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else #define IR_RECEIVE_PIN 2 +# endif #define IR_SEND_PIN 3 #define TONE_PIN 4 #define APPLICATION_PIN 5 #define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. #define _IR_TIMING_TEST_PIN 7 -#if !defined(ARDUINO_SAMD_ADAFRUIT) +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) // On the Zero and others we switch explicitly to SerialUSB #define Serial SerialUSB #endif @@ -299,19 +340,13 @@ void noTone(uint8_t aPinNumber){ #define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation #else # if defined(SEND_PWM_BY_TIMER) -#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warning in IRTimer.hpp +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp # endif #endif #if !defined (FLASHEND) #define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined #endif -#if !defined (RAMEND) -#define RAMEND 0xFFFF // Dummy value for platforms where RAMEND is not defined -#endif -#if !defined (RAMSIZE) -#define RAMSIZE 0xFFFF // Dummy value for platforms where RAMSIZE is not defined -#endif /* * Helper macro for getting a macro definition as string diff --git a/examples/SendAndReceive/SendAndReceive.ino b/examples/SendAndReceive/SendAndReceive.ino index 7303c1afc..9b80ab7ed 100644 --- a/examples/SendAndReceive/SendAndReceive.ino +++ b/examples/SendAndReceive/SendAndReceive.ino @@ -39,7 +39,7 @@ //#define EXCLUDE_UNIVERSAL_PROTOCOLS // Saves up to 1000 bytes program memory. //#define EXCLUDE_EXOTIC_PROTOCOLS // saves around 650 bytes program memory if all other protocols are active //#define NO_LED_FEEDBACK_CODE // saves 92 bytes program memory -//#define RECORD_GAP_MICROS 12000 // Default is 5000. Activate it for some LG air conditioner protocols +//#define RECORD_GAP_MICROS 12000 // Default is 8000. Activate it for some LG air conditioner protocols //#define SEND_PWM_BY_TIMER // Disable carrier PWM generation in software and use (restricted) hardware PWM. //#define USE_NO_SEND_PWM // Use no carrier PWM, just simulate an active low receiver signal. Overrides SEND_PWM_BY_TIMER definition @@ -53,7 +53,9 @@ void setup() { Serial.begin(115200); -#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/|| defined(SERIALUSB_PID) || defined(ARDUINO_attiny3217) + +#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/ \ + || defined(SERIALUSB_PID) || defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_attiny3217) delay(4000); // To be able to connect Serial monitor after reset or power up and before first print out. Do not wait for an attached Serial Monitor! #endif // Just to know which program is running on my Arduino @@ -65,7 +67,7 @@ void setup() { Serial.print(F("Ready to receive IR signals of protocols: ")); printActiveIRProtocols(&Serial); Serial.println(F("at pin " STR(IR_RECEIVE_PIN))); - IrSender.begin(); // Start with IR_SEND_PIN as send pin and enable feedback LED at default feedback LED pin + IrSender.begin(); // Start with IR_SEND_PIN -which is defined in PinDefinitionsAndMore.h- as send pin and enable feedback LED at default feedback LED pin Serial.println(F("Send IR signals at pin " STR(IR_SEND_PIN))); #if FLASHEND >= 0x3FFF // For 16k flash or more, like ATtiny1604 diff --git a/examples/SendBoseWaveDemo/PinDefinitionsAndMore.h b/examples/SendBoseWaveDemo/PinDefinitionsAndMore.h index cb2b3b86d..b13414f56 100644 --- a/examples/SendBoseWaveDemo/PinDefinitionsAndMore.h +++ b/examples/SendBoseWaveDemo/PinDefinitionsAndMore.h @@ -4,7 +4,7 @@ * Contains pin definitions for IRremote examples for various platforms * as well as definitions for feedback LED and tone() and includes * - * Copyright (C) 2021-2022 Armin Joachimsmeyer + * Copyright (C) 2021-2023 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. @@ -32,81 +32,97 @@ * DEFAULT/AVR 2 3 4 Arduino * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore - * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark pro - * ATtiny3217 18|PA1 19|PA2 20|PA3 MegaTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore * ATtiny1604 2 3|PA5 % * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore - * SAMD21 3 4 5 + * MKR* 1 3 4 + * SAMD 2 3 4 * ESP8266 14|D5 12|D6 % - * ESP32 15 4 27 - * BluePill PA6 PA7 PA3 + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 * APOLLO3 11 12 5 * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 */ //#define _IR_MEASURE_TIMING // For debugging purposes. #if defined(__AVR__) -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board -#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore -#define IR_RECEIVE_PIN 0 -#define IR_SEND_PIN 4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. -#define TONE_PIN 3 -#define _IR_TIMING_TEST_PIN 3 +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 # elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board #include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" // For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. # if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core #define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 //#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards #define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 #define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 #define _IR_TIMING_TEST_PIN 10 // PA4 # else -#define IR_RECEIVE_PIN 3 // PA3 - on Digispark board labeled as pin 9 -#define IR_SEND_PIN 2 // PA2 - on Digispark board labeled as pin 8 -#define TONE_PIN 7 // PA7 - on Digispark board labeled as pin 5 +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 # endif -# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board -#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory -// Pin 6 is TX pin 7 is RX -#define IR_RECEIVE_PIN 3 // INT1 -#define IR_SEND_PIN 4 -#define TONE_PIN 9 -#define _IR_TIMING_TEST_PIN 8 - -# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // Tiny Core Dev board -#define IR_RECEIVE_PIN 18 -#define IR_SEND_PIN 19 -#define TONE_PIN 20 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output -#define LED_BUILTIN 2 // PA6 - -# elif defined(__AVR_ATtiny816__) // Tiny Core Micro -#define IR_RECEIVE_PIN 14 // PA1 -#define IR_SEND_PIN 16 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output -#define LED_BUILTIN 4 // PB5 - -# elif defined(__AVR_ATtiny1614__) -#define IR_RECEIVE_PIN 8 // PA1 -#define IR_SEND_PIN 10 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 - -# elif defined(__AVR_ATtiny1604__) -#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. -#define IR_SEND_PIN 3 -#define APPLICATION_PIN 5 +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 #define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it +#define TONE_PIN 42 // Dummy for examples using it # elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ || defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ @@ -139,6 +155,15 @@ # endif # endif // defined(__AVR_ATtiny25__)... +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + #elif defined(ESP8266) #define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW #define IR_RECEIVE_PIN 14 // D5 @@ -148,21 +173,32 @@ #define tone(...) void() // tone() inhibits receive timer #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it - -#elif defined(CONFIG_IDF_TARGET_ESP32C3) -#define IR_INPUT_PIN 8 -#define IR_SEND_PIN 9 -#define TONE_PIN 10 // ADC2_0 -#define APPLICATION_PIN 11 +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 #elif defined(ESP32) #include // tone() is included in ESP32 core since 2.0.2 -#if !defined(ESP_ARDUINO_VERSION_VAL) -#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) 12345678 -#endif +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif #if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) #define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. void tone(uint8_t aPinNumber, unsigned int aFrequency){ @@ -205,7 +241,8 @@ void noTone(uint8_t aPinNumber){ #define IR_SEND_PIN 12 #define TONE_PIN 5 -#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect #define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico #define IR_SEND_PIN 4 // GPIO16 #define TONE_PIN 5 @@ -252,14 +289,18 @@ void noTone(uint8_t aPinNumber){ #define _IR_TIMING_TEST_PIN 7 #elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else #define IR_RECEIVE_PIN 2 +# endif #define IR_SEND_PIN 3 #define TONE_PIN 4 #define APPLICATION_PIN 5 #define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. #define _IR_TIMING_TEST_PIN 7 -#if !defined(ARDUINO_SAMD_ADAFRUIT) +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) // On the Zero and others we switch explicitly to SerialUSB #define Serial SerialUSB #endif @@ -299,19 +340,13 @@ void noTone(uint8_t aPinNumber){ #define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation #else # if defined(SEND_PWM_BY_TIMER) -#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warning in IRTimer.hpp +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp # endif #endif #if !defined (FLASHEND) #define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined #endif -#if !defined (RAMEND) -#define RAMEND 0xFFFF // Dummy value for platforms where RAMEND is not defined -#endif -#if !defined (RAMSIZE) -#define RAMSIZE 0xFFFF // Dummy value for platforms where RAMSIZE is not defined -#endif /* * Helper macro for getting a macro definition as string diff --git a/examples/SendBoseWaveDemo/SendBoseWaveDemo.ino b/examples/SendBoseWaveDemo/SendBoseWaveDemo.ino index 054c083c1..5046b96cf 100644 --- a/examples/SendBoseWaveDemo/SendBoseWaveDemo.ino +++ b/examples/SendBoseWaveDemo/SendBoseWaveDemo.ino @@ -33,7 +33,9 @@ */ #include -#define DISABLE_CODE_FOR_RECEIVER // Disables restarting receiver after each send. Saves 450 bytes program memory and 269 bytes RAM if receiving functions are not used. +#if !defined(ARDUINO_ESP32C3_DEV) // This is due to a bug in RISC-V compiler, which requires unused function sections :-(. +#define DISABLE_CODE_FOR_RECEIVER // Disables static receiver code like receive timer ISR handler and static IRReceiver and irparams data. Saves 450 bytes program memory and 269 bytes RAM if receiving functions are not required. +#endif #include "PinDefinitionsAndMore.h" // Define macros for input and output pin etc. #include @@ -96,6 +98,10 @@ //#define BOSE_CMD_ALARM_ON_OFF 0x22 //#define BOSE_CMD_ALARM_WAKE_TO 0x70 //#define BOSE_CMD_ALARM_TIME 0x23 +// Different last 3 codes for Wave Sound Touch IV +//#define BOSE_CMD_ALARM_1 0x22 +//#define BOSE_CMD_ALARM_2 0x62 +//#define BOSE_CMD_ALARM_SETUP 0xA2 bool sPrintMenu; void printMenu(); @@ -104,18 +110,24 @@ void setup() { pinMode(LED_BUILTIN, OUTPUT); Serial.begin(115200); -#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/|| defined(SERIALUSB_PID) || defined(ARDUINO_attiny3217) + +#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/ \ + || defined(SERIALUSB_PID) || defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_attiny3217) delay(4000); // To be able to connect Serial monitor after reset or power up and before first print out. Do not wait for an attached Serial Monitor! #endif // Just to know which program is running on my Arduino Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE)); #if defined(IR_SEND_PIN) - IrSender.begin(); // Start with IR_SEND_PIN as send pin and enable feedback LED at default feedback LED pin + IrSender.begin(); // Start with IR_SEND_PIN -which is defined in PinDefinitionsAndMore.h- as send pin and enable feedback LED at default feedback LED pin Serial.println(F("Send IR signals at pin " STR(IR_SEND_PIN))); #else - IrSender.begin(3, ENABLE_LED_FEEDBACK, USE_DEFAULT_FEEDBACK_LED_PIN); // Specify send pin and enable feedback LED at default feedback LED pin - Serial.println(F("Send IR signals at pin 3")); + uint8_t tSendPin = 3; + IrSender.begin(tSendPin, ENABLE_LED_FEEDBACK, USE_DEFAULT_FEEDBACK_LED_PIN); // Specify send pin and enable feedback LED at default feedback LED pin + // You can change send pin later with IrSender.setSendPin(); + + Serial.print(F("Send IR signals at pin ")); + Serial.println(tSendPin); #endif sPrintMenu = true; diff --git a/examples/SendDemo/PinDefinitionsAndMore.h b/examples/SendDemo/PinDefinitionsAndMore.h index cb2b3b86d..b13414f56 100644 --- a/examples/SendDemo/PinDefinitionsAndMore.h +++ b/examples/SendDemo/PinDefinitionsAndMore.h @@ -4,7 +4,7 @@ * Contains pin definitions for IRremote examples for various platforms * as well as definitions for feedback LED and tone() and includes * - * Copyright (C) 2021-2022 Armin Joachimsmeyer + * Copyright (C) 2021-2023 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. @@ -32,81 +32,97 @@ * DEFAULT/AVR 2 3 4 Arduino * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore - * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark pro - * ATtiny3217 18|PA1 19|PA2 20|PA3 MegaTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore * ATtiny1604 2 3|PA5 % * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore - * SAMD21 3 4 5 + * MKR* 1 3 4 + * SAMD 2 3 4 * ESP8266 14|D5 12|D6 % - * ESP32 15 4 27 - * BluePill PA6 PA7 PA3 + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 * APOLLO3 11 12 5 * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 */ //#define _IR_MEASURE_TIMING // For debugging purposes. #if defined(__AVR__) -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board -#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore -#define IR_RECEIVE_PIN 0 -#define IR_SEND_PIN 4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. -#define TONE_PIN 3 -#define _IR_TIMING_TEST_PIN 3 +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 # elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board #include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" // For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. # if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core #define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 //#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards #define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 #define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 #define _IR_TIMING_TEST_PIN 10 // PA4 # else -#define IR_RECEIVE_PIN 3 // PA3 - on Digispark board labeled as pin 9 -#define IR_SEND_PIN 2 // PA2 - on Digispark board labeled as pin 8 -#define TONE_PIN 7 // PA7 - on Digispark board labeled as pin 5 +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 # endif -# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board -#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory -// Pin 6 is TX pin 7 is RX -#define IR_RECEIVE_PIN 3 // INT1 -#define IR_SEND_PIN 4 -#define TONE_PIN 9 -#define _IR_TIMING_TEST_PIN 8 - -# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // Tiny Core Dev board -#define IR_RECEIVE_PIN 18 -#define IR_SEND_PIN 19 -#define TONE_PIN 20 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output -#define LED_BUILTIN 2 // PA6 - -# elif defined(__AVR_ATtiny816__) // Tiny Core Micro -#define IR_RECEIVE_PIN 14 // PA1 -#define IR_SEND_PIN 16 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output -#define LED_BUILTIN 4 // PB5 - -# elif defined(__AVR_ATtiny1614__) -#define IR_RECEIVE_PIN 8 // PA1 -#define IR_SEND_PIN 10 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 - -# elif defined(__AVR_ATtiny1604__) -#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. -#define IR_SEND_PIN 3 -#define APPLICATION_PIN 5 +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 #define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it +#define TONE_PIN 42 // Dummy for examples using it # elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ || defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ @@ -139,6 +155,15 @@ # endif # endif // defined(__AVR_ATtiny25__)... +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + #elif defined(ESP8266) #define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW #define IR_RECEIVE_PIN 14 // D5 @@ -148,21 +173,32 @@ #define tone(...) void() // tone() inhibits receive timer #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it - -#elif defined(CONFIG_IDF_TARGET_ESP32C3) -#define IR_INPUT_PIN 8 -#define IR_SEND_PIN 9 -#define TONE_PIN 10 // ADC2_0 -#define APPLICATION_PIN 11 +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 #elif defined(ESP32) #include // tone() is included in ESP32 core since 2.0.2 -#if !defined(ESP_ARDUINO_VERSION_VAL) -#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) 12345678 -#endif +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif #if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) #define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. void tone(uint8_t aPinNumber, unsigned int aFrequency){ @@ -205,7 +241,8 @@ void noTone(uint8_t aPinNumber){ #define IR_SEND_PIN 12 #define TONE_PIN 5 -#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect #define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico #define IR_SEND_PIN 4 // GPIO16 #define TONE_PIN 5 @@ -252,14 +289,18 @@ void noTone(uint8_t aPinNumber){ #define _IR_TIMING_TEST_PIN 7 #elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else #define IR_RECEIVE_PIN 2 +# endif #define IR_SEND_PIN 3 #define TONE_PIN 4 #define APPLICATION_PIN 5 #define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. #define _IR_TIMING_TEST_PIN 7 -#if !defined(ARDUINO_SAMD_ADAFRUIT) +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) // On the Zero and others we switch explicitly to SerialUSB #define Serial SerialUSB #endif @@ -299,19 +340,13 @@ void noTone(uint8_t aPinNumber){ #define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation #else # if defined(SEND_PWM_BY_TIMER) -#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warning in IRTimer.hpp +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp # endif #endif #if !defined (FLASHEND) #define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined #endif -#if !defined (RAMEND) -#define RAMEND 0xFFFF // Dummy value for platforms where RAMEND is not defined -#endif -#if !defined (RAMSIZE) -#define RAMSIZE 0xFFFF // Dummy value for platforms where RAMSIZE is not defined -#endif /* * Helper macro for getting a macro definition as string diff --git a/examples/SendDemo/SendDemo.ino b/examples/SendDemo/SendDemo.ino index 97e7fa29a..c918aa3a1 100644 --- a/examples/SendDemo/SendDemo.ino +++ b/examples/SendDemo/SendDemo.ino @@ -8,7 +8,7 @@ ************************************************************************************ * MIT License * - * Copyright (c) 2020-2023 Armin Joachimsmeyer + * Copyright (c) 2020-2025 Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -34,38 +34,54 @@ #include "PinDefinitionsAndMore.h" // Define macros for input and output pin etc. -#define DISABLE_CODE_FOR_RECEIVER // Disables restarting receiver after each send. Saves 450 bytes program memory and 269 bytes RAM if receiving functions are not used. - +#if !defined(ARDUINO_ESP32C3_DEV) // This is due to a bug in RISC-V compiler, which requires unused function sections :-(. +#define DISABLE_CODE_FOR_RECEIVER // Disables static receiver code like receive timer ISR handler and static IRReceiver and irparams data. Saves 450 bytes program memory and 269 bytes RAM if receiving functions are not required. +#endif //#define EXCLUDE_EXOTIC_PROTOCOLS // Saves around 240 bytes program memory if IrSender.write is used //#define SEND_PWM_BY_TIMER // Disable carrier PWM generation in software and use (restricted) hardware PWM. //#define USE_NO_SEND_PWM // Use no carrier PWM, just simulate an active low receiver signal. Overrides SEND_PWM_BY_TIMER definition -//#define NO_LED_FEEDBACK_CODE // Saves 566 bytes program memory -//#define USE_OPEN_DRAIN_OUTPUT_FOR_SEND_PIN // Use or simulate open drain output mode at send pin. Attention, active state of open drain is LOW, so connect the send LED between positive supply and send pin! - +//#define USE_ACTIVE_HIGH_OUTPUT_FOR_SEND_PIN // Simulate an active high receiver signal instead of an active low signal. +//#define USE_OPEN_DRAIN_OUTPUT_FOR_SEND_PIN // Use or simulate open drain output mode at send pin. Attention, active state of open drain is LOW, so connect the send LED between positive supply and send pin! +#if FLASHEND <= 0x1FFF // For 8k flash or less like ATtiny85 +#define NO_LED_FEEDBACK_CODE // Saves 344 bytes program memory +#endif +//#undef IR_SEND_PIN // enable this, if you need to set send pin programmatically using uint8_t tSendPin below #include #define DELAY_AFTER_SEND 2000 #define DELAY_AFTER_LOOP 5000 +#if __INT_WIDTH__ < 32 + IRRawDataType const tRawDataPGM[] PROGMEM = { 0xB02002, 0xA010 }; // LSB of tRawData[0] is sent first +#endif + void setup() { Serial.begin(115200); -#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/|| defined(SERIALUSB_PID) || defined(ARDUINO_attiny3217) +#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/ \ + || defined(SERIALUSB_PID) || defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_attiny3217) delay(4000); // To be able to connect Serial monitor after reset or power up and before first print out. Do not wait for an attached Serial Monitor! #endif + // Just to know which program is running on my Arduino Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE)); #if defined(IR_SEND_PIN) - IrSender.begin(); // Start with IR_SEND_PIN as send pin and enable feedback LED at default feedback LED pin + IrSender.begin(); // Start with IR_SEND_PIN -which is defined in PinDefinitionsAndMore.h- as send pin and enable feedback LED at default feedback LED pin +// disableLEDFeedback(); // Disable feedback LED at default feedback LED pin # if defined(IR_SEND_PIN_STRING) Serial.println(F("Send IR signals at pin " IR_SEND_PIN_STRING)); # else Serial.println(F("Send IR signals at pin " STR(IR_SEND_PIN))); # endif #else - IrSender.begin(3, ENABLE_LED_FEEDBACK, USE_DEFAULT_FEEDBACK_LED_PIN); // Specify send pin and enable feedback LED at default feedback LED pin - Serial.println(F("Send IR signals at pin 3")); + // Here the macro IR_SEND_PIN is not defined or undefined above with #undef IR_SEND_PIN + uint8_t tSendPin = 3; + IrSender.begin(tSendPin, ENABLE_LED_FEEDBACK, USE_DEFAULT_FEEDBACK_LED_PIN); // Specify send pin and enable feedback LED at default feedback LED pin + // You can change send pin later with IrSender.setSendPin(); + + Serial.print(F("Send IR signals at pin ")); + Serial.println(tSendPin); #endif #if !defined(SEND_PWM_BY_TIMER) @@ -81,6 +97,15 @@ void setup() { Serial.print(IrSender.periodTimeMicros); Serial.println(F(" us")); #endif + +#if defined(LED_BUILTIN) && !defined(NO_LED_FEEDBACK_CODE) +# if defined(FEEDBACK_LED_IS_ACTIVE_LOW) + Serial.print(F("Active low ")); +# endif + Serial.print(F("FeedbackLED at pin ")); + Serial.println(LED_BUILTIN); // Works also for ESP32: static const uint8_t LED_BUILTIN = 8; #define LED_BUILTIN LED_BUILTIN +#endif + } /* @@ -125,7 +150,7 @@ void loop() { delay(DELAY_AFTER_SEND); if (sRepeats == 0) { -#if FLASHEND >= 0x3FFF && (RAMEND >= 0x4FF || RAMSIZE >= 0x4FF) // For 16k flash or more, like ATtiny1604. Code does not fit in program memory of ATtiny85 etc. +#if FLASHEND >= 0x3FFF && ((!defined(RAMEND) && !defined(RAMSIZE)) || (defined(RAMEND) && RAMEND > 0x6FF) || (defined(RAMSIZE) && RAMSIZE > 0x6FF)) // For 16k flash or more, like ATtiny1604. Code does not fit in program memory of ATtiny85 etc. /* * Send constant values only once in this demo */ @@ -165,6 +190,7 @@ void loop() { /* * With Send sendNECMSB() you can send your old 32 bit codes. * To convert one into the other, you must reverse the byte positions and then reverse all positions of each byte. + * Use bitreverse32Bit(). * Example: * 0xCB340102 byte reverse -> 0x020134CB bit reverse-> 40802CD3 */ @@ -172,74 +198,87 @@ void loop() { Serial.flush(); IrSender.sendNECMSB(0x40802CD3, 32, false); delay(DELAY_AFTER_SEND); -#endif Serial.println(F("Send Panasonic 0xB, 0x10 as 48 bit PulseDistance using ProtocolConstants")); Serial.flush(); -#if __INT_WIDTH__ < 32 - IRRawDataType tRawData[] = { 0xB02002, 0xA010 }; // LSB of tRawData[0] is sent first - IrSender.sendPulseDistanceWidthFromArray(&KaseikyoProtocolConstants, &tRawData[0], 48, NO_REPEATS); // Panasonic is a Kaseikyo variant -#else - IrSender.sendPulseDistanceWidth(&KaseikyoProtocolConstants, 0xA010B02002, 48, NO_REPEATS); // Panasonic is a Kaseikyo variant -#endif +# if __INT_WIDTH__ < 32 + IrSender.sendPulseDistanceWidthFromPGMArray_P(&KaseikyoProtocolConstants, &tRawDataPGM[0], 48, NO_REPEATS); // Panasonic is a Kaseikyo variant +# else + IrSender.sendPulseDistanceWidth_P(&KaseikyoProtocolConstants, 0xA010B02002, 48, NO_REPEATS); // Panasonic is a Kaseikyo variant +# endif delay(DELAY_AFTER_SEND); /* - * Send 2 Panasonic 48 bit codes as generic Pulse Distance data, once with LSB and once with MSB first + * Send 2 Panasonic 48 bit codes as Pulse Distance data, once with LSB and once with MSB first */ - Serial.println(F("Send Panasonic 0xB, 0x10 as generic 48 bit PulseDistance")); + Serial.println(F("Send Panasonic 0xB, 0x10 as 48 bit PulseDistance")); Serial.println(F(" LSB first")); Serial.flush(); -#if __INT_WIDTH__ < 32 - IrSender.sendPulseDistanceWidthFromArray(38, 3450, 1700, 450, 1250, 450, 400, &tRawData[0], 48, +# if __INT_WIDTH__ < 32 + IrSender.sendPulseDistanceWidthFromPGMArray(38, 3450, 1700, 450, 1250, 450, 400, &tRawDataPGM[0], 48, PROTOCOL_IS_LSB_FIRST, 0, NO_REPEATS); -#else - IrSender.sendPulseDistanceWidth(38, 3450, 1700, 450, 1250, 450, 400, 0xA010B02002, 48, PROTOCOL_IS_LSB_FIRST, - 0, NO_REPEATS); -#endif +# else + IrSender.sendPulseDistanceWidth(38, 3450, 1700, 450, 1250, 450, 400, 0xA010B02002, 48, PROTOCOL_IS_LSB_FIRST, 0, + NO_REPEATS); +# endif delay(DELAY_AFTER_SEND); // The same with MSB first. Use bit reversed raw data of LSB first part Serial.println(F(" MSB first")); -#if __INT_WIDTH__ < 32 + IRRawDataType tRawData[4]; +# if __INT_WIDTH__ < 32 tRawData[0] = 0x40040D00; // MSB of tRawData[0] is sent first tRawData[1] = 0x805; IrSender.sendPulseDistanceWidthFromArray(38, 3450, 1700, 450, 1250, 450, 400, &tRawData[0], 48, PROTOCOL_IS_MSB_FIRST, 0, NO_REPEATS); -#else - IrSender.sendPulseDistanceWidth(38, 3450, 1700, 450, 1250, 450, 400, 0x40040D000805, 48, PROTOCOL_IS_MSB_FIRST, - 0, NO_REPEATS); -#endif +# else + IrSender.sendPulseDistanceWidth(38, 3450, 1700, 450, 1250, 450, 400, 0x40040D000805, 48, PROTOCOL_IS_MSB_FIRST, 0, + NO_REPEATS); +# endif delay(DELAY_AFTER_SEND); - Serial.println(F("Send generic 72 bit PulseDistance 0x5A AFEDCBA9 87654321 LSB first")); + Serial.println(F("Send 72 bit PulseDistance 0x5A AFEDCBA9 87654321 LSB first")); Serial.flush(); -# if __INT_WIDTH__ < 32 +# if __INT_WIDTH__ < 32 tRawData[0] = 0x87654321; // LSB of tRawData[0] is sent first tRawData[1] = 0xAFEDCBA9; tRawData[2] = 0x5A; IrSender.sendPulseDistanceWidthFromArray(38, 8900, 4450, 550, 1700, 550, 600, &tRawData[0], 72, PROTOCOL_IS_LSB_FIRST, 0, NO_REPEATS); -# else - IRRawDataType tRawData[] = { 0xAFEDCBA987654321, 0x5A }; // LSB of tRawData[0] is sent first - IrSender.sendPulseDistanceWidthFromArray(38, 8900, 4450, 550, 1700, 550, 600, &tRawData[0], 72, PROTOCOL_IS_LSB_FIRST, 0, NO_REPEATS); -# endif +# else + tRawData[0] = 0xAFEDCBA987654321; + tRawData[1] = 0x5A; // LSB of tRawData[0] is sent first + IrSender.sendPulseDistanceWidthFromArray(38, 8900, 4450, 550, 1700, 550, 600, &tRawData[0], 72, PROTOCOL_IS_LSB_FIRST, 0, + NO_REPEATS); +# endif delay(DELAY_AFTER_SEND); - Serial.println(F("Send generic 52 bit PulseDistanceWidth 0xDCBA9 87654321 LSB first")); + Serial.println(F("Send 52 bit PulseDistanceWidth 0xDCBA9 87654321 LSB first")); Serial.flush(); // Real PulseDistanceWidth (constant bit length) does not require a stop bit -#if __INT_WIDTH__ < 32 +# if __INT_WIDTH__ < 32 IrSender.sendPulseDistanceWidthFromArray(38, 300, 600, 600, 300, 300, 600, &tRawData[0], 52, PROTOCOL_IS_LSB_FIRST, 0, 0); -#else - IrSender.sendPulseDistanceWidth(38, 300, 600, 600, 300, 300, 600, 0xDCBA987654321, 52, PROTOCOL_IS_LSB_FIRST, - 0, 0); -#endif +# else + IrSender.sendPulseDistanceWidth(38, 300, 600, 600, 300, 300, 600, 0xDCBA987654321, 52, PROTOCOL_IS_LSB_FIRST, 0, 0); +# endif delay(DELAY_AFTER_SEND); - Serial.println(F("Send generic 32 bit PulseWidth 0x87654321 LSB first")); + Serial.println(F("Send ASCII 7 bit PulseDistanceWidth LSB first")); + Serial.flush(); + // Real PulseDistanceWidth (constant bit length) does theoretically not require a stop bit, but we know the stop bit from serial transmission + IrSender.sendPulseDistanceWidth(38, 6000, 500, 500, 1500, 1500, 500, sCommand, 7, PROTOCOL_IS_LSB_FIRST, 0, 0); + delay(DELAY_AFTER_SEND); + + Serial.println(F("Send Sony12 as PulseWidth LSB first")); + Serial.flush(); + uint32_t tData = (uint32_t) sAddress << 7 | (sCommand & 0x7F); + IrSender.sendPulseDistanceWidth(38, 2400, 600, 1200, 600, 600, 600, tData, SIRCS_12_PROTOCOL, PROTOCOL_IS_LSB_FIRST, 0, 0); + delay(DELAY_AFTER_SEND); +#endif // FLASHEND >= 0x3FFF ... + + Serial.println(F("Send 32 bit PulseWidth 0x87654321 LSB first")); Serial.flush(); // Real PulseDistanceWidth (constant bit length) does not require a stop bit IrSender.sendPulseDistanceWidth(38, 1000, 500, 600, 300, 300, 300, 0x87654321, 32, PROTOCOL_IS_LSB_FIRST, 0, 0); @@ -326,7 +365,24 @@ void loop() { IrSender.sendRC6(sAddress, sCommand, sRepeats, true); delay(DELAY_AFTER_SEND); -#if FLASHEND >= 0x3FFF && (RAMEND >= 0x4FF || RAMSIZE >= 0x4FF) // For 16k flash or more, like ATtiny1604. Code does not fit in program memory of ATtiny85 etc. + Serial.println(F("Send RC6A with 14 bit 0x2711 as extra")); + Serial.flush(); + IrSender.sendRC6A(sAddress & 0xFF, sCommand, sRepeats, 0x2711, true); + delay(DELAY_AFTER_SEND); + +#if FLASHEND >= 0x3FFF && ((!defined(RAMEND) && !defined(RAMSIZE)) || (defined(RAMEND) && RAMEND > 0x4FF) || (defined(RAMSIZE) && RAMSIZE > 0x4FF)) // For 16k flash or more, like ATtiny1604. Code does not fit in program memory of ATtiny85 etc. + + Serial.println(F("Send MagiQuest")); + Serial.flush(); + IrSender.sendMagiQuest(0x6BCD0000 | (uint32_t) sAddress, s16BitCommand); // we have 31 bit address + delay(DELAY_AFTER_SEND); + + // Bang&Olufsen must be sent with 455 kHz +// Serial.println(F("Send Bang&Olufsen")); +// Serial.flush(); +// IrSender.sendBangOlufsen(sAddress, sCommand, sRepeats); +// delay(DELAY_AFTER_SEND); + /* * Next example how to use the IrSender.write function */ @@ -336,21 +392,17 @@ void loop() { IRSendData.command = sCommand; IRSendData.flags = IRDATA_FLAGS_EMPTY; - IRSendData.protocol = SAMSUNG; - Serial.print(F("Send ")); - Serial.println(getProtocolString(IRSendData.protocol)); + Serial.println(F("Send next protocols with IrSender.write")); Serial.flush(); - IrSender.write(&IRSendData, sRepeats); - delay(DELAY_AFTER_SEND); - IRSendData.protocol = JVC; // switch protocol + IRSendData.protocol = JVC;// switch protocol Serial.print(F("Send ")); Serial.println(getProtocolString(IRSendData.protocol)); Serial.flush(); IrSender.write(&IRSendData, sRepeats); delay(DELAY_AFTER_SEND); - IRSendData.command = s16BitCommand; // LG support more than 8 bit command + IRSendData.command = s16BitCommand;// LG support more than 8 bit command IRSendData.protocol = SAMSUNG; Serial.print(F("Send ")); @@ -366,17 +418,6 @@ void loop() { IrSender.write(&IRSendData, sRepeats); delay(DELAY_AFTER_SEND); - Serial.println(F("Send MagiQuest")); - Serial.flush(); - IrSender.sendMagiQuest(0x6BCD0000 | (uint32_t) sAddress, s16BitCommand); // we have 31 bit address - delay(DELAY_AFTER_SEND); - - // Bang&Olufsen must be sent with 455 kHz -// Serial.println(F("Send Bang&Olufsen")); -// Serial.flush(); -// IrSender.sendBangOlufsen(sAddress, sCommand, sRepeats); -// delay(DELAY_AFTER_SEND); - IRSendData.protocol = BOSEWAVE; Serial.println(F("Send Bosewave with no address and 8 command bits")); Serial.flush(); diff --git a/examples/SendLGAirConditionerDemo/PinDefinitionsAndMore.h b/examples/SendLGAirConditionerDemo/PinDefinitionsAndMore.h index cb2b3b86d..b13414f56 100644 --- a/examples/SendLGAirConditionerDemo/PinDefinitionsAndMore.h +++ b/examples/SendLGAirConditionerDemo/PinDefinitionsAndMore.h @@ -4,7 +4,7 @@ * Contains pin definitions for IRremote examples for various platforms * as well as definitions for feedback LED and tone() and includes * - * Copyright (C) 2021-2022 Armin Joachimsmeyer + * Copyright (C) 2021-2023 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. @@ -32,81 +32,97 @@ * DEFAULT/AVR 2 3 4 Arduino * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore - * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark pro - * ATtiny3217 18|PA1 19|PA2 20|PA3 MegaTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore * ATtiny1604 2 3|PA5 % * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore - * SAMD21 3 4 5 + * MKR* 1 3 4 + * SAMD 2 3 4 * ESP8266 14|D5 12|D6 % - * ESP32 15 4 27 - * BluePill PA6 PA7 PA3 + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 * APOLLO3 11 12 5 * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 */ //#define _IR_MEASURE_TIMING // For debugging purposes. #if defined(__AVR__) -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board -#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore -#define IR_RECEIVE_PIN 0 -#define IR_SEND_PIN 4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. -#define TONE_PIN 3 -#define _IR_TIMING_TEST_PIN 3 +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 # elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board #include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" // For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. # if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core #define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 //#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards #define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 #define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 #define _IR_TIMING_TEST_PIN 10 // PA4 # else -#define IR_RECEIVE_PIN 3 // PA3 - on Digispark board labeled as pin 9 -#define IR_SEND_PIN 2 // PA2 - on Digispark board labeled as pin 8 -#define TONE_PIN 7 // PA7 - on Digispark board labeled as pin 5 +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 # endif -# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board -#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory -// Pin 6 is TX pin 7 is RX -#define IR_RECEIVE_PIN 3 // INT1 -#define IR_SEND_PIN 4 -#define TONE_PIN 9 -#define _IR_TIMING_TEST_PIN 8 - -# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // Tiny Core Dev board -#define IR_RECEIVE_PIN 18 -#define IR_SEND_PIN 19 -#define TONE_PIN 20 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output -#define LED_BUILTIN 2 // PA6 - -# elif defined(__AVR_ATtiny816__) // Tiny Core Micro -#define IR_RECEIVE_PIN 14 // PA1 -#define IR_SEND_PIN 16 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output -#define LED_BUILTIN 4 // PB5 - -# elif defined(__AVR_ATtiny1614__) -#define IR_RECEIVE_PIN 8 // PA1 -#define IR_SEND_PIN 10 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 - -# elif defined(__AVR_ATtiny1604__) -#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. -#define IR_SEND_PIN 3 -#define APPLICATION_PIN 5 +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 #define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it +#define TONE_PIN 42 // Dummy for examples using it # elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ || defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ @@ -139,6 +155,15 @@ # endif # endif // defined(__AVR_ATtiny25__)... +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + #elif defined(ESP8266) #define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW #define IR_RECEIVE_PIN 14 // D5 @@ -148,21 +173,32 @@ #define tone(...) void() // tone() inhibits receive timer #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it - -#elif defined(CONFIG_IDF_TARGET_ESP32C3) -#define IR_INPUT_PIN 8 -#define IR_SEND_PIN 9 -#define TONE_PIN 10 // ADC2_0 -#define APPLICATION_PIN 11 +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 #elif defined(ESP32) #include // tone() is included in ESP32 core since 2.0.2 -#if !defined(ESP_ARDUINO_VERSION_VAL) -#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) 12345678 -#endif +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif #if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) #define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. void tone(uint8_t aPinNumber, unsigned int aFrequency){ @@ -205,7 +241,8 @@ void noTone(uint8_t aPinNumber){ #define IR_SEND_PIN 12 #define TONE_PIN 5 -#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect #define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico #define IR_SEND_PIN 4 // GPIO16 #define TONE_PIN 5 @@ -252,14 +289,18 @@ void noTone(uint8_t aPinNumber){ #define _IR_TIMING_TEST_PIN 7 #elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else #define IR_RECEIVE_PIN 2 +# endif #define IR_SEND_PIN 3 #define TONE_PIN 4 #define APPLICATION_PIN 5 #define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. #define _IR_TIMING_TEST_PIN 7 -#if !defined(ARDUINO_SAMD_ADAFRUIT) +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) // On the Zero and others we switch explicitly to SerialUSB #define Serial SerialUSB #endif @@ -299,19 +340,13 @@ void noTone(uint8_t aPinNumber){ #define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation #else # if defined(SEND_PWM_BY_TIMER) -#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warning in IRTimer.hpp +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp # endif #endif #if !defined (FLASHEND) #define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined #endif -#if !defined (RAMEND) -#define RAMEND 0xFFFF // Dummy value for platforms where RAMEND is not defined -#endif -#if !defined (RAMSIZE) -#define RAMSIZE 0xFFFF // Dummy value for platforms where RAMSIZE is not defined -#endif /* * Helper macro for getting a macro definition as string diff --git a/examples/SendLGAirConditionerDemo/SendLGAirConditionerDemo.ino b/examples/SendLGAirConditionerDemo/SendLGAirConditionerDemo.ino index 9697745e1..a92e45e21 100644 --- a/examples/SendLGAirConditionerDemo/SendLGAirConditionerDemo.ino +++ b/examples/SendLGAirConditionerDemo/SendLGAirConditionerDemo.ino @@ -42,7 +42,9 @@ //#define USE_LG2_PROTOCOL // Try it if you do not have success with the default LG protocol #define NUMBER_OF_COMMANDS_BETWEEN_PRINT_OF_MENU 5 -#define DISABLE_CODE_FOR_RECEIVER // Disables restarting receiver after each send. Saves 450 bytes program memory and 269 bytes RAM if receiving functions are not used. +#if !defined(ARDUINO_ESP32C3_DEV) // This is due to a bug in RISC-V compiler, which requires unused function sections :-(. +#define DISABLE_CODE_FOR_RECEIVER // Disables static receiver code like receive timer ISR handler and static IRReceiver and irparams data. Saves 450 bytes program memory and 269 bytes RAM if receiving functions are not required. +#endif #define INFO // Deactivate this to save program memory and suppress info output from the LG-AC driver. //#define DEBUG // Activate this for more output from the LG-AC driver. @@ -65,9 +67,12 @@ void setup() { pinMode(LED_BUILTIN, OUTPUT); Serial.begin(115200); -#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/|| defined(SERIALUSB_PID) || defined(ARDUINO_attiny3217) -delay(4000); // To be able to connect Serial monitor after reset or power up and before first print out. Do not wait for an attached Serial Monitor! + +#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/ \ + || defined(SERIALUSB_PID) || defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_attiny3217) + delay(4000); // To be able to connect Serial monitor after reset or power up and before first print out. Do not wait for an attached Serial Monitor! #endif + // Just to know which program is running on my Arduino Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE)); Serial.println(F("Send IR signals at pin " STR(IR_SEND_PIN))); @@ -75,8 +80,7 @@ delay(4000); // To be able to connect Serial monitor after reset or power up and /* * The IR library setup. That's all! */ - IrSender.begin(); // Start with IR_SEND_PIN as send pin and enable feedback LED at default feedback LED pin - + IrSender.begin(); // Start with IR_SEND_PIN -which is defined in PinDefinitionsAndMore.h- as send pin and enable feedback LED at default feedback LED pin Serial.println(); MyLG_Aircondition.setType(LG_IS_WALL_TYPE); diff --git a/examples/SendProntoDemo/PinDefinitionsAndMore.h b/examples/SendProntoDemo/PinDefinitionsAndMore.h index cb2b3b86d..b13414f56 100644 --- a/examples/SendProntoDemo/PinDefinitionsAndMore.h +++ b/examples/SendProntoDemo/PinDefinitionsAndMore.h @@ -4,7 +4,7 @@ * Contains pin definitions for IRremote examples for various platforms * as well as definitions for feedback LED and tone() and includes * - * Copyright (C) 2021-2022 Armin Joachimsmeyer + * Copyright (C) 2021-2023 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. @@ -32,81 +32,97 @@ * DEFAULT/AVR 2 3 4 Arduino * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore - * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark pro - * ATtiny3217 18|PA1 19|PA2 20|PA3 MegaTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore * ATtiny1604 2 3|PA5 % * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore - * SAMD21 3 4 5 + * MKR* 1 3 4 + * SAMD 2 3 4 * ESP8266 14|D5 12|D6 % - * ESP32 15 4 27 - * BluePill PA6 PA7 PA3 + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 * APOLLO3 11 12 5 * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 */ //#define _IR_MEASURE_TIMING // For debugging purposes. #if defined(__AVR__) -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board -#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore -#define IR_RECEIVE_PIN 0 -#define IR_SEND_PIN 4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. -#define TONE_PIN 3 -#define _IR_TIMING_TEST_PIN 3 +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 # elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board #include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" // For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. # if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core #define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 //#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards #define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 #define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 #define _IR_TIMING_TEST_PIN 10 // PA4 # else -#define IR_RECEIVE_PIN 3 // PA3 - on Digispark board labeled as pin 9 -#define IR_SEND_PIN 2 // PA2 - on Digispark board labeled as pin 8 -#define TONE_PIN 7 // PA7 - on Digispark board labeled as pin 5 +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 # endif -# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board -#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory -// Pin 6 is TX pin 7 is RX -#define IR_RECEIVE_PIN 3 // INT1 -#define IR_SEND_PIN 4 -#define TONE_PIN 9 -#define _IR_TIMING_TEST_PIN 8 - -# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // Tiny Core Dev board -#define IR_RECEIVE_PIN 18 -#define IR_SEND_PIN 19 -#define TONE_PIN 20 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output -#define LED_BUILTIN 2 // PA6 - -# elif defined(__AVR_ATtiny816__) // Tiny Core Micro -#define IR_RECEIVE_PIN 14 // PA1 -#define IR_SEND_PIN 16 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output -#define LED_BUILTIN 4 // PB5 - -# elif defined(__AVR_ATtiny1614__) -#define IR_RECEIVE_PIN 8 // PA1 -#define IR_SEND_PIN 10 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 - -# elif defined(__AVR_ATtiny1604__) -#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. -#define IR_SEND_PIN 3 -#define APPLICATION_PIN 5 +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 #define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it +#define TONE_PIN 42 // Dummy for examples using it # elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ || defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ @@ -139,6 +155,15 @@ # endif # endif // defined(__AVR_ATtiny25__)... +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + #elif defined(ESP8266) #define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW #define IR_RECEIVE_PIN 14 // D5 @@ -148,21 +173,32 @@ #define tone(...) void() // tone() inhibits receive timer #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it - -#elif defined(CONFIG_IDF_TARGET_ESP32C3) -#define IR_INPUT_PIN 8 -#define IR_SEND_PIN 9 -#define TONE_PIN 10 // ADC2_0 -#define APPLICATION_PIN 11 +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 #elif defined(ESP32) #include // tone() is included in ESP32 core since 2.0.2 -#if !defined(ESP_ARDUINO_VERSION_VAL) -#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) 12345678 -#endif +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif #if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) #define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. void tone(uint8_t aPinNumber, unsigned int aFrequency){ @@ -205,7 +241,8 @@ void noTone(uint8_t aPinNumber){ #define IR_SEND_PIN 12 #define TONE_PIN 5 -#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect #define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico #define IR_SEND_PIN 4 // GPIO16 #define TONE_PIN 5 @@ -252,14 +289,18 @@ void noTone(uint8_t aPinNumber){ #define _IR_TIMING_TEST_PIN 7 #elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else #define IR_RECEIVE_PIN 2 +# endif #define IR_SEND_PIN 3 #define TONE_PIN 4 #define APPLICATION_PIN 5 #define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. #define _IR_TIMING_TEST_PIN 7 -#if !defined(ARDUINO_SAMD_ADAFRUIT) +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) // On the Zero and others we switch explicitly to SerialUSB #define Serial SerialUSB #endif @@ -299,19 +340,13 @@ void noTone(uint8_t aPinNumber){ #define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation #else # if defined(SEND_PWM_BY_TIMER) -#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warning in IRTimer.hpp +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp # endif #endif #if !defined (FLASHEND) #define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined #endif -#if !defined (RAMEND) -#define RAMEND 0xFFFF // Dummy value for platforms where RAMEND is not defined -#endif -#if !defined (RAMSIZE) -#define RAMSIZE 0xFFFF // Dummy value for platforms where RAMSIZE is not defined -#endif /* * Helper macro for getting a macro definition as string diff --git a/examples/SendProntoDemo/SendProntoDemo.ino b/examples/SendProntoDemo/SendProntoDemo.ino index ba92eff21..e935d00c1 100644 --- a/examples/SendProntoDemo/SendProntoDemo.ino +++ b/examples/SendProntoDemo/SendProntoDemo.ino @@ -32,7 +32,9 @@ */ #include -#define DISABLE_CODE_FOR_RECEIVER // Disables restarting receiver after each send. Saves 450 bytes program memory and 269 bytes RAM if receiving functions are not used. +#if !defined(ARDUINO_ESP32C3_DEV) // This is due to a bug in RISC-V compiler, which requires unused function sections :-(. +#define DISABLE_CODE_FOR_RECEIVER // Disables static receiver code like receive timer ISR handler and static IRReceiver and irparams data. Saves 450 bytes program memory and 269 bytes RAM if receiving functions are not required. +#endif #include "PinDefinitionsAndMore.h" // Define macros for input and output pin etc. #include @@ -57,14 +59,17 @@ IRsend irsend; void setup() { Serial.begin(115200); - while (!Serial) - ; + +#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/ \ + || defined(SERIALUSB_PID) || defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_attiny3217) + delay(4000); // To be able to connect Serial monitor after reset or power up and before first print out. Do not wait for an attached Serial Monitor! +#endif // Just to know which program is running on my Arduino Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE)); Serial.println(F("Send IR signals at pin " STR(IR_SEND_PIN))); - IrSender.begin(); // Start with IR_SEND_PIN as send pin and enable feedback LED at default feedback LED pin + IrSender.begin(); // Start with IR_SEND_PIN -which is defined in PinDefinitionsAndMore.h- as send pin and enable feedback LED at default feedback LED pin } void loop() { diff --git a/examples/SendRawDemo/PinDefinitionsAndMore.h b/examples/SendRawDemo/PinDefinitionsAndMore.h index cb2b3b86d..b13414f56 100644 --- a/examples/SendRawDemo/PinDefinitionsAndMore.h +++ b/examples/SendRawDemo/PinDefinitionsAndMore.h @@ -4,7 +4,7 @@ * Contains pin definitions for IRremote examples for various platforms * as well as definitions for feedback LED and tone() and includes * - * Copyright (C) 2021-2022 Armin Joachimsmeyer + * Copyright (C) 2021-2023 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. @@ -32,81 +32,97 @@ * DEFAULT/AVR 2 3 4 Arduino * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore - * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark pro - * ATtiny3217 18|PA1 19|PA2 20|PA3 MegaTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore * ATtiny1604 2 3|PA5 % * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore - * SAMD21 3 4 5 + * MKR* 1 3 4 + * SAMD 2 3 4 * ESP8266 14|D5 12|D6 % - * ESP32 15 4 27 - * BluePill PA6 PA7 PA3 + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 * APOLLO3 11 12 5 * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 */ //#define _IR_MEASURE_TIMING // For debugging purposes. #if defined(__AVR__) -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board -#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore -#define IR_RECEIVE_PIN 0 -#define IR_SEND_PIN 4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. -#define TONE_PIN 3 -#define _IR_TIMING_TEST_PIN 3 +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 # elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board #include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" // For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. # if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core #define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 //#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards #define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 #define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 #define _IR_TIMING_TEST_PIN 10 // PA4 # else -#define IR_RECEIVE_PIN 3 // PA3 - on Digispark board labeled as pin 9 -#define IR_SEND_PIN 2 // PA2 - on Digispark board labeled as pin 8 -#define TONE_PIN 7 // PA7 - on Digispark board labeled as pin 5 +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 # endif -# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board -#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory -// Pin 6 is TX pin 7 is RX -#define IR_RECEIVE_PIN 3 // INT1 -#define IR_SEND_PIN 4 -#define TONE_PIN 9 -#define _IR_TIMING_TEST_PIN 8 - -# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // Tiny Core Dev board -#define IR_RECEIVE_PIN 18 -#define IR_SEND_PIN 19 -#define TONE_PIN 20 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output -#define LED_BUILTIN 2 // PA6 - -# elif defined(__AVR_ATtiny816__) // Tiny Core Micro -#define IR_RECEIVE_PIN 14 // PA1 -#define IR_SEND_PIN 16 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output -#define LED_BUILTIN 4 // PB5 - -# elif defined(__AVR_ATtiny1614__) -#define IR_RECEIVE_PIN 8 // PA1 -#define IR_SEND_PIN 10 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 - -# elif defined(__AVR_ATtiny1604__) -#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. -#define IR_SEND_PIN 3 -#define APPLICATION_PIN 5 +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 #define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it +#define TONE_PIN 42 // Dummy for examples using it # elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ || defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ @@ -139,6 +155,15 @@ # endif # endif // defined(__AVR_ATtiny25__)... +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + #elif defined(ESP8266) #define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW #define IR_RECEIVE_PIN 14 // D5 @@ -148,21 +173,32 @@ #define tone(...) void() // tone() inhibits receive timer #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it - -#elif defined(CONFIG_IDF_TARGET_ESP32C3) -#define IR_INPUT_PIN 8 -#define IR_SEND_PIN 9 -#define TONE_PIN 10 // ADC2_0 -#define APPLICATION_PIN 11 +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 #elif defined(ESP32) #include // tone() is included in ESP32 core since 2.0.2 -#if !defined(ESP_ARDUINO_VERSION_VAL) -#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) 12345678 -#endif +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif #if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) #define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. void tone(uint8_t aPinNumber, unsigned int aFrequency){ @@ -205,7 +241,8 @@ void noTone(uint8_t aPinNumber){ #define IR_SEND_PIN 12 #define TONE_PIN 5 -#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect #define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico #define IR_SEND_PIN 4 // GPIO16 #define TONE_PIN 5 @@ -252,14 +289,18 @@ void noTone(uint8_t aPinNumber){ #define _IR_TIMING_TEST_PIN 7 #elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else #define IR_RECEIVE_PIN 2 +# endif #define IR_SEND_PIN 3 #define TONE_PIN 4 #define APPLICATION_PIN 5 #define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. #define _IR_TIMING_TEST_PIN 7 -#if !defined(ARDUINO_SAMD_ADAFRUIT) +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) // On the Zero and others we switch explicitly to SerialUSB #define Serial SerialUSB #endif @@ -299,19 +340,13 @@ void noTone(uint8_t aPinNumber){ #define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation #else # if defined(SEND_PWM_BY_TIMER) -#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warning in IRTimer.hpp +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp # endif #endif #if !defined (FLASHEND) #define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined #endif -#if !defined (RAMEND) -#define RAMEND 0xFFFF // Dummy value for platforms where RAMEND is not defined -#endif -#if !defined (RAMSIZE) -#define RAMSIZE 0xFFFF // Dummy value for platforms where RAMSIZE is not defined -#endif /* * Helper macro for getting a macro definition as string diff --git a/examples/SendRawDemo/SendRawDemo.ino b/examples/SendRawDemo/SendRawDemo.ino index 351148ada..5b03a6438 100644 --- a/examples/SendRawDemo/SendRawDemo.ino +++ b/examples/SendRawDemo/SendRawDemo.ino @@ -3,8 +3,7 @@ * * This example shows how to send a RAW signal using the IRremote library. * The example signal is actually a 32 bit NEC signal. - * Remote Control button: LGTV Power On/Off. - * Hex Value: 0x20DF10EF, 32 bits + * Protocol=NEC Address=0x4 Command=0x18 Raw-Data=0xE718FB04 32 bits LSB first * * If it is a supported protocol, it is more efficient to use the protocol send function * (here sendNEC) to send the signal. @@ -14,7 +13,7 @@ ************************************************************************************ * MIT License * - * Copyright (c) 2020-2022 Armin Joachimsmeyer + * Copyright (c) 2020-2024 Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -37,7 +36,9 @@ */ #include -#define DISABLE_CODE_FOR_RECEIVER // Disables restarting receiver after each send. Saves 450 bytes program memory and 269 bytes RAM if receiving functions are not used. +#if !defined(ARDUINO_ESP32C3_DEV) // This is due to a bug in RISC-V compiler, which requires unused function sections :-(. +#define DISABLE_CODE_FOR_RECEIVER // Disables static receiver code like receive timer ISR handler and static IRReceiver and irparams data. Saves 450 bytes program memory and 269 bytes RAM if receiving functions are not required. +#endif //#define SEND_PWM_BY_TIMER // Disable carrier PWM generation in software and use (restricted) hardware PWM. //#define USE_NO_SEND_PWM // Use no carrier PWM, just simulate an active low receiver signal. Overrides SEND_PWM_BY_TIMER definition @@ -51,20 +52,22 @@ void setup() { pinMode(LED_BUILTIN, OUTPUT); Serial.begin(115200); -#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/|| defined(SERIALUSB_PID) || defined(ARDUINO_attiny3217) + +#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/ \ + || defined(SERIALUSB_PID) || defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_attiny3217) delay(4000); // To be able to connect Serial monitor after reset or power up and before first print out. Do not wait for an attached Serial Monitor! #endif // Just to know which program is running on my Arduino Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE)); Serial.println(F("Send IR signals at pin " STR(IR_SEND_PIN))); - IrSender.begin(); // Start with IR_SEND_PIN as send pin and enable feedback LED at default feedback LED pin + IrSender.begin(); // Start with IR_SEND_PIN -which is defined in PinDefinitionsAndMore.h- as send pin and enable feedback LED at default feedback LED pin } /* - * NEC address=0xFB0C, command=0x18 + * NEC address=0x04 (0xFB04), command=0x18 (0xE718) * - * This is data in byte format. + * This is the raw data array in byte format. * The uint8_t/byte elements contain the number of ticks in 50 us. * The uint16_t format contains the (number of ticks * 50) if generated by IRremote, * so the uint16_t format has exact the same resolution but requires double space. @@ -72,49 +75,52 @@ void setup() { * e.g. use 560 (instead of 11 * 50) for NEC or use 432 for Panasonic. But in this cases, * you better use the timing generation functions e.g. sendNEC() directly. */ -const uint8_t rawDataP[] -#if defined(__AVR__) -PROGMEM -#endif -= { 180, 90 /*Start bit*/, 11, 11, 11, 11, 11, 34, 11, 34/*0011 0xC of 16 bit address LSB first*/, 11, 11, 11, 11, 11, 11, 11, +const uint8_t rawDataP[] PROGMEM += { 180, 90 /*Start bit*/, 11, 11, 11, 11, 11, 34, 11, 11/*0010 0x4 of 8 bit address LSB first*/, 11, 11, 11, 11, 11, 11, 11, 11/*0000*/, 11, 34, 11, 34, 11, 11, 11, 34/*1101 0xB*/, 11, 34, 11, 34, 11, 34, 11, 34/*1111*/, 11, 11, 11, 11, 11, 11, 11, 34/*0001 0x08 of command LSB first*/, 11, 34, 11, 11, 11, 11, 11, 11/*1000 0x01*/, 11, 34, 11, 34, 11, 34, 11, 11/*1110 Inverted 8 of command*/, 11, 11, 11, 34, 11, 34, 11, 34/*0111 inverted 1 of command*/, 11 /*stop bit*/}; +/* + * The same frame as above. Values are NOT multiple of 50, but are taken from the NEC timing definitions + */ +const uint16_t rawData[] = { 9000, 4500/*Start bit*/, 560, 560, 560, 560, 560, 1690, 560, + 560/*0010 0x4 of 8 bit address LSB first*/, 560, 560, 560, 560, 560, 560, 560, 560/*0000*/, 560, 1690, 560, 1690, 560, 560, + 560, 1690/*1101 0xB - inverted 0x04*/, 560, 1690, 560, 1690, 560, 1690, 560, 1690/*1111 - inverted 0*/, 560, 560, 560, 560, + 560, 560, 560, 1690/*0001 0x08 of command LSB first*/, 560, 1690, 560, 560, 560, 560, 560, 560/*1000 0x01*/, 560, 1690, 560, + 1690, 560, 1690, 560, 560/*1110 Inverted 8 of command*/, 560, 560, 560, 1690, 560, 1690, 560, + 1690/*1111 inverted 0 of command*/, 560 /*stop bit*/}; // Using exact NEC timing + void loop() { -#if !(defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__)) +#if FLASHEND > 0x1FFF // For more than 8k flash => not for ATtiny85 etc. /* * Send hand crafted data from RAM - * The values are NOT multiple of 50, but are taken from the NEC timing definitions */ - Serial.println(F("Send NEC 16 bit address=0xFB04 and command 0x08 with exact timing (16 bit array format)")); + Serial.println(F("Send NEC 8 bit address=0x04 (0xFB04) and command 0x18 (0xE718) with exact timing (16 bit array format)")); Serial.flush(); - - const uint16_t rawData[] = { 9000, 4500/*Start bit*/, 560, 560, 560, 560, 560, 1690, 560, - 560/*0010 0x4 of 16 bit address LSB first*/, 560, 560, 560, 560, 560, 560, 560, 560/*0000*/, 560, 1690, 560, 1690, 560, - 560, 560, 1690/*1101 0xB*/, 560, 1690, 560, 1690, 560, 1690, 560, 1690/*1111*/, 560, 560, 560, 560, 560, 560, 560, - 1690/*0001 0x08 of command LSB first*/, 560, 560, 560, 560, 560, 560, 560, 560/*0000 0x00*/, 560, 1690, 560, 1690, 560, - 1690, 560, 560/*1110 Inverted 8 of command*/, 560, 1690, 560, 1690, 560, 1690, 560, 1690/*1111 inverted 0 of command*/, - 560 /*stop bit*/}; // Using exact NEC timing IrSender.sendRaw(rawData, sizeof(rawData) / sizeof(rawData[0]), NEC_KHZ); // Note the approach used to automatically calculate the size of the array. - delay(1000); // delay must be greater than 5 ms (RECORD_GAP_MICROS), otherwise the receiver sees it as one long signal + delay(1000); // delay must be greater than 8 ms (RECORD_GAP_MICROS), otherwise the receiver sees it as one long signal + #endif /* * Send byte data direct from FLASH * Note the approach used to automatically calculate the size of the array. */ - Serial.println(F("Send NEC 16 bit address 0xFB0C and data 0x18 with (50 us) tick resolution timing (8 bit array format) ")); + Serial.println(F("Send NEC 8 bit address 0x04 and command 0x18 with (50 us) tick resolution timing (8 bit array format) ")); Serial.flush(); IrSender.sendRaw_P(rawDataP, sizeof(rawDataP) / sizeof(rawDataP[0]), NEC_KHZ); - delay(1000); // delay must be greater than 5 ms (RECORD_GAP_MICROS), otherwise the receiver sees it as one long signal + delay(1000); // delay must be greater than 8 ms (RECORD_GAP_MICROS), otherwise the receiver sees it as one long signal - Serial.println(F("Send NEC 16 bit address 0x0102, 8 bit data 0x34 with generated timing")); + /* + * Send the same frame using NEC encoder + */ + Serial.println(F("Send NEC 16 bit address 0x04, 8 bit command 0x18 with NEC encoder")); Serial.flush(); - IrSender.sendNEC(0x0102, 0x34, 0); + IrSender.sendNEC(0x04, 0x18, 0); delay(3000); } diff --git a/examples/SimpleReceiver/PinDefinitionsAndMore.h b/examples/SimpleReceiver/PinDefinitionsAndMore.h index cb2b3b86d..b13414f56 100644 --- a/examples/SimpleReceiver/PinDefinitionsAndMore.h +++ b/examples/SimpleReceiver/PinDefinitionsAndMore.h @@ -4,7 +4,7 @@ * Contains pin definitions for IRremote examples for various platforms * as well as definitions for feedback LED and tone() and includes * - * Copyright (C) 2021-2022 Armin Joachimsmeyer + * Copyright (C) 2021-2023 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. @@ -32,81 +32,97 @@ * DEFAULT/AVR 2 3 4 Arduino * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore - * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark pro - * ATtiny3217 18|PA1 19|PA2 20|PA3 MegaTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore * ATtiny1604 2 3|PA5 % * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore - * SAMD21 3 4 5 + * MKR* 1 3 4 + * SAMD 2 3 4 * ESP8266 14|D5 12|D6 % - * ESP32 15 4 27 - * BluePill PA6 PA7 PA3 + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 * APOLLO3 11 12 5 * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 */ //#define _IR_MEASURE_TIMING // For debugging purposes. #if defined(__AVR__) -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board -#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore -#define IR_RECEIVE_PIN 0 -#define IR_SEND_PIN 4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. -#define TONE_PIN 3 -#define _IR_TIMING_TEST_PIN 3 +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 # elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board #include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" // For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. # if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core #define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 //#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards #define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 #define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 #define _IR_TIMING_TEST_PIN 10 // PA4 # else -#define IR_RECEIVE_PIN 3 // PA3 - on Digispark board labeled as pin 9 -#define IR_SEND_PIN 2 // PA2 - on Digispark board labeled as pin 8 -#define TONE_PIN 7 // PA7 - on Digispark board labeled as pin 5 +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 # endif -# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board -#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory -// Pin 6 is TX pin 7 is RX -#define IR_RECEIVE_PIN 3 // INT1 -#define IR_SEND_PIN 4 -#define TONE_PIN 9 -#define _IR_TIMING_TEST_PIN 8 - -# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // Tiny Core Dev board -#define IR_RECEIVE_PIN 18 -#define IR_SEND_PIN 19 -#define TONE_PIN 20 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output -#define LED_BUILTIN 2 // PA6 - -# elif defined(__AVR_ATtiny816__) // Tiny Core Micro -#define IR_RECEIVE_PIN 14 // PA1 -#define IR_SEND_PIN 16 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output -#define LED_BUILTIN 4 // PB5 - -# elif defined(__AVR_ATtiny1614__) -#define IR_RECEIVE_PIN 8 // PA1 -#define IR_SEND_PIN 10 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 - -# elif defined(__AVR_ATtiny1604__) -#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. -#define IR_SEND_PIN 3 -#define APPLICATION_PIN 5 +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 #define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it +#define TONE_PIN 42 // Dummy for examples using it # elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ || defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ @@ -139,6 +155,15 @@ # endif # endif // defined(__AVR_ATtiny25__)... +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + #elif defined(ESP8266) #define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW #define IR_RECEIVE_PIN 14 // D5 @@ -148,21 +173,32 @@ #define tone(...) void() // tone() inhibits receive timer #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it - -#elif defined(CONFIG_IDF_TARGET_ESP32C3) -#define IR_INPUT_PIN 8 -#define IR_SEND_PIN 9 -#define TONE_PIN 10 // ADC2_0 -#define APPLICATION_PIN 11 +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 #elif defined(ESP32) #include // tone() is included in ESP32 core since 2.0.2 -#if !defined(ESP_ARDUINO_VERSION_VAL) -#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) 12345678 -#endif +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif #if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) #define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. void tone(uint8_t aPinNumber, unsigned int aFrequency){ @@ -205,7 +241,8 @@ void noTone(uint8_t aPinNumber){ #define IR_SEND_PIN 12 #define TONE_PIN 5 -#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect #define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico #define IR_SEND_PIN 4 // GPIO16 #define TONE_PIN 5 @@ -252,14 +289,18 @@ void noTone(uint8_t aPinNumber){ #define _IR_TIMING_TEST_PIN 7 #elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else #define IR_RECEIVE_PIN 2 +# endif #define IR_SEND_PIN 3 #define TONE_PIN 4 #define APPLICATION_PIN 5 #define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. #define _IR_TIMING_TEST_PIN 7 -#if !defined(ARDUINO_SAMD_ADAFRUIT) +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) // On the Zero and others we switch explicitly to SerialUSB #define Serial SerialUSB #endif @@ -299,19 +340,13 @@ void noTone(uint8_t aPinNumber){ #define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation #else # if defined(SEND_PWM_BY_TIMER) -#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warning in IRTimer.hpp +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp # endif #endif #if !defined (FLASHEND) #define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined #endif -#if !defined (RAMEND) -#define RAMEND 0xFFFF // Dummy value for platforms where RAMEND is not defined -#endif -#if !defined (RAMSIZE) -#define RAMSIZE 0xFFFF // Dummy value for platforms where RAMSIZE is not defined -#endif /* * Helper macro for getting a macro definition as string diff --git a/examples/SimpleReceiver/SimpleReceiver.ino b/examples/SimpleReceiver/SimpleReceiver.ino index eae266801..95eaee8c7 100644 --- a/examples/SimpleReceiver/SimpleReceiver.ino +++ b/examples/SimpleReceiver/SimpleReceiver.ino @@ -1,14 +1,15 @@ /* * SimpleReceiver.cpp * - * Demonstrates receiving NEC IR codes with IRremote + * Demonstrates receiving ONLY NEC protocol IR codes with IRremote + * If no protocol is defined, all protocols (except Bang&Olufsen) are active. * * This file is part of Arduino-IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. * ************************************************************************************ * MIT License * - * Copyright (c) 2020-2022 Armin Joachimsmeyer + * Copyright (c) 2020-2025 Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -30,6 +31,8 @@ ************************************************************************************ */ +#include + /* * Specify which protocol(s) should be used for decoding. * If no protocol is defined, all protocols (except Bang&Olufsen) are active. @@ -40,7 +43,7 @@ //#define DECODE_KASEIKYO //#define DECODE_PANASONIC // alias for DECODE_KASEIKYO //#define DECODE_LG -#define DECODE_NEC // Includes Apple and Onkyo +//#define DECODE_NEC // Includes Apple and Onkyo. To enable all protocols , just comment/disable this line. //#define DECODE_SAMSUNG //#define DECODE_SONY //#define DECODE_RC5 @@ -59,15 +62,17 @@ //#define DEBUG // Activate this for lots of lovely debug output from the decoders. -//#define RAW_BUFFER_LENGTH 180 // Default is 112 if DECODE_MAGIQUEST is enabled, otherwise 100. +//#define RAW_BUFFER_LENGTH 750 // For air condition remotes it may require up to 750. Default is 200. -#include - -#include "PinDefinitionsAndMore.h" // Define macros for input and output pin etc. -#include +/* + * This include defines the actual pin number for pins like IR_RECEIVE_PIN, IR_SEND_PIN for many different boards and architectures + */ +#include "PinDefinitionsAndMore.h" +#include // include the library void setup() { Serial.begin(115200); + // Just to know which program is running on my Arduino Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE)); @@ -91,30 +96,35 @@ void loop() { if (IrReceiver.decode()) { /* - * Print a short summary of received data + * Print a summary of received data */ - IrReceiver.printIRResultShort(&Serial); - IrReceiver.printIRSendUsage(&Serial); if (IrReceiver.decodedIRData.protocol == UNKNOWN) { Serial.println(F("Received noise or an unknown (or not yet enabled) protocol")); - // We have an unknown protocol here, print more info + // We have an unknown protocol here, print extended info IrReceiver.printIRResultRawFormatted(&Serial, true); + + IrReceiver.resume(); // Do it here, to preserve raw data for printing with printIRResultRawFormatted() + } else { + IrReceiver.resume(); // Early enable receiving of the next IR frame + + IrReceiver.printIRResultShort(&Serial); + IrReceiver.printIRSendUsage(&Serial); } Serial.println(); - /* - * !!!Important!!! Enable receiving of the next value, - * since receiving has stopped after the end of the current received data packet. - */ - IrReceiver.resume(); // Enable receiving of the next value - /* * Finally, check the received data and perform actions according to the received command */ - if (IrReceiver.decodedIRData.command == 0x10) { - // do something - } else if (IrReceiver.decodedIRData.command == 0x11) { - // do something else + if (IrReceiver.decodedIRData.flags & IRDATA_FLAGS_IS_REPEAT) { + Serial.println(F("Repeat received. Here you can repeat the same action as before.")); + } else { + if (IrReceiver.decodedIRData.command == 0x10) { + Serial.println(F("Received command 0x10.")); + // do something + } else if (IrReceiver.decodedIRData.command == 0x11) { + Serial.println(F("Received command 0x11.")); + // do something else + } } } } diff --git a/examples/SimpleReceiverForHashCodes/PinDefinitionsAndMore.h b/examples/SimpleReceiverForHashCodes/PinDefinitionsAndMore.h new file mode 100644 index 000000000..b13414f56 --- /dev/null +++ b/examples/SimpleReceiverForHashCodes/PinDefinitionsAndMore.h @@ -0,0 +1,357 @@ +/* + * PinDefinitionsAndMore.h + * + * Contains pin definitions for IRremote examples for various platforms + * as well as definitions for feedback LED and tone() and includes + * + * Copyright (C) 2021-2023 Armin Joachimsmeyer + * armin.joachimsmeyer@gmail.com + * + * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. + * + * Arduino-IRremote is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + * See the GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + * + */ + +/* + * Pin mapping table for different platforms + * + * Platform IR input IR output Tone Core/Pin schema + * -------------------------------------------------------------- + * DEFAULT/AVR 2 3 4 Arduino + * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore + * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore + * ATtiny1604 2 3|PA5 % + * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore + * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore + * MKR* 1 3 4 + * SAMD 2 3 4 + * ESP8266 14|D5 12|D6 % + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 + * APOLLO3 11 12 5 + * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 + */ +//#define _IR_MEASURE_TIMING // For debugging purposes. + +#if defined(__AVR__) +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 + +# elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" +// For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. +# if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core +#define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 +//#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 +#define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 +#define _IR_TIMING_TEST_PIN 10 // PA4 +# else +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 +# endif + +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 + +#define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() +#define noTone(a) void() +#define TONE_PIN 42 // Dummy for examples using it + +# elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ +|| defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ +|| defined(__AVR_ATmega324P__) || defined(__AVR_ATmega324A__) \ +|| defined(__AVR_ATmega324PA__) || defined(__AVR_ATmega164A__) \ +|| defined(__AVR_ATmega164P__) || defined(__AVR_ATmega32__) \ +|| defined(__AVR_ATmega16__) || defined(__AVR_ATmega8535__) \ +|| defined(__AVR_ATmega64__) || defined(__AVR_ATmega128__) \ +|| defined(__AVR_ATmega1281__) || defined(__AVR_ATmega2561__) \ +|| defined(__AVR_ATmega8515__) || defined(__AVR_ATmega162__) +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 13 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +# else // Default as for ATmega328 like on Uno, Nano, Leonardo, Teensy 2.0 etc. +#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +# if defined(ARDUINO_AVR_PROMICRO) // Sparkfun Pro Micro is __AVR_ATmega32U4__ but has different external circuit +// We have no built in LED at pin 13 -> reuse RX LED +#undef LED_BUILTIN +#define LED_BUILTIN LED_BUILTIN_RX +# endif +# endif // defined(__AVR_ATtiny25__)... + +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +#elif defined(ESP8266) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW +#define IR_RECEIVE_PIN 14 // D5 +#define IR_SEND_PIN 12 // D6 - D4/pin 2 is internal LED +#define _IR_TIMING_TEST_PIN 2 // D4 +#define APPLICATION_PIN 13 // D7 + +#define tone(...) void() // tone() inhibits receive timer +#define noTone(a) void() +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 + +#elif defined(ESP32) +#include + +// tone() is included in ESP32 core since 2.0.2 +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif +#if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) +#define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. +void tone(uint8_t aPinNumber, unsigned int aFrequency){ + ledcAttachPin(aPinNumber, TONE_LEDC_CHANNEL); + ledcWriteTone(TONE_LEDC_CHANNEL, aFrequency); +} +void tone(uint8_t aPinNumber, unsigned int aFrequency, unsigned long aDuration){ + ledcAttachPin(aPinNumber, TONE_LEDC_CHANNEL); + ledcWriteTone(TONE_LEDC_CHANNEL, aFrequency); + delay(aDuration); + ledcWriteTone(TONE_LEDC_CHANNEL, 0); +} +void noTone(uint8_t aPinNumber){ + ledcWriteTone(TONE_LEDC_CHANNEL, 0); +} +#endif // ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) + +#define IR_RECEIVE_PIN 15 // D15 +#define IR_SEND_PIN 4 // D4 +#define TONE_PIN 27 // D27 25 & 26 are DAC0 and 1 +#define APPLICATION_PIN 16 // RX2 pin + +#elif defined(ARDUINO_ARCH_STM32) || defined(ARDUINO_ARCH_STM32F1) // BluePill +// Timer 3 blocks PA6, PA7, PB0, PB1 for use by Servo or tone() +#define IR_RECEIVE_PIN PA6 +#define IR_RECEIVE_PIN_STRING "PA6" +#define IR_SEND_PIN PA7 +#define IR_SEND_PIN_STRING "PA7" +#define TONE_PIN PA3 +#define _IR_TIMING_TEST_PIN PA5 +#define APPLICATION_PIN PA2 +#define APPLICATION_PIN_STRING "PA2" +# if defined(ARDUINO_GENERIC_STM32F103C) || defined(ARDUINO_BLUEPILL_F103C8) +// BluePill LED is active low +#define FEEDBACK_LED_IS_ACTIVE_LOW +# endif + +#elif defined(ARDUINO_ARCH_APOLLO3) // Sparkfun Apollo boards +#define IR_RECEIVE_PIN 11 +#define IR_SEND_PIN 12 +#define TONE_PIN 5 + +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect +#define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico +#define IR_SEND_PIN 4 // GPIO16 +#define TONE_PIN 5 +#define APPLICATION_PIN 6 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 7 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 8 + +#elif defined(ARDUINO_ARCH_RP2040) // Arduino Nano Connect, Pi Pico with arduino-pico core https://github.com/earlephilhower/arduino-pico +#define IR_RECEIVE_PIN 15 // GPIO15 to be compatible with the Arduino Nano RP2040 Connect (pin3) +#define IR_SEND_PIN 16 // GPIO16 +#define TONE_PIN 17 +#define APPLICATION_PIN 18 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 19 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 20 + +// If you program the Nano RP2040 Connect with this core, then you must redefine LED_BUILTIN +// and use the external reset with 1 kOhm to ground to enter UF2 mode +#undef LED_BUILTIN +#define LED_BUILTIN 6 + +#elif defined(PARTICLE) // !!!UNTESTED!!! +#define IR_RECEIVE_PIN A4 +#define IR_SEND_PIN A5 // Particle supports multiple pins + +#define LED_BUILTIN D7 + +/* + * 4 times the same (default) layout for easy adaption in the future + */ +#elif defined(TEENSYDUINO) // Teensy 2.0 is handled at default for ATmega328 like on Uno, Nano, Leonardo etc. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +#elif defined(ARDUINO_ARCH_MBED) // Arduino Nano 33 BLE +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +#elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else +#define IR_RECEIVE_PIN 2 +# endif +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) +// On the Zero and others we switch explicitly to SerialUSB +#define Serial SerialUSB +#endif + +// Definitions for the Chinese SAMD21 M0-Mini clone, which has no led connected to D13/PA17. +// Attention!!! D2 and D4 are swapped on these boards!!! +// If you connect the LED, it is on pin 24/PB11. In this case activate the next two lines. +//#undef LED_BUILTIN +//#define LED_BUILTIN 24 // PB11 +// As an alternative you can choose pin 25, it is the RX-LED pin (PB03), but active low.In this case activate the next 3 lines. +//#undef LED_BUILTIN +//#define LED_BUILTIN 25 // PB03 +//#define FEEDBACK_LED_IS_ACTIVE_LOW // The RX LED on the M0-Mini is active LOW + +#elif defined (NRF51) // BBC micro:bit +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define APPLICATION_PIN 1 +#define _IR_TIMING_TEST_PIN 4 + +#define tone(...) void() // no tone() available +#define noTone(a) void() +#define TONE_PIN 42 // Dummy for examples using it + +#else +#warning Board / CPU is not detected using pre-processor symbols -> using default values, which may not fit. Please extend PinDefinitionsAndMore.h. +// Default valued for unidentified boards +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 +#endif // defined(ESP8266) + +#if defined(ESP32) || defined(ARDUINO_ARCH_RP2040) || defined(PARTICLE) || defined(ARDUINO_ARCH_MBED) +#define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation +#else +# if defined(SEND_PWM_BY_TIMER) +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp +# endif +#endif + +#if !defined (FLASHEND) +#define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined +#endif + +/* + * Helper macro for getting a macro definition as string + */ +#if !defined(STR_HELPER) +#define STR_HELPER(x) #x +#define STR(x) STR_HELPER(x) +#endif diff --git a/examples/SimpleReceiverForHashCodes/SimpleReceiverForHashCodes.ino b/examples/SimpleReceiverForHashCodes/SimpleReceiverForHashCodes.ino new file mode 100644 index 000000000..91819446b --- /dev/null +++ b/examples/SimpleReceiverForHashCodes/SimpleReceiverForHashCodes.ino @@ -0,0 +1,101 @@ +/* + * SimpleReceiverForHashCodes.cpp + * + * Demonstrates receiving hash codes of unknown protocols with IRremote + * + * This file is part of Arduino-IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. + * + ************************************************************************************ + * MIT License + * + * Copyright (c) 2024 Armin Joachimsmeyer + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is furnished + * to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, + * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A + * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF + * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE + * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * + ************************************************************************************ + */ + +#include + +#include "PinDefinitionsAndMore.h" // Define macros for input and output pin etc. + +/* + * Specify which protocol(s) should be used for decoding. + * This must be done before the #include + */ +#define DECODE_HASH // special decoder for all protocols +#if !defined(RAW_BUFFER_LENGTH) +# if !((defined(RAMEND) && RAMEND <= 0x4FF) || (defined(RAMSIZE) && RAMSIZE < 0x4FF)) +#define RAW_BUFFER_LENGTH 1000 // Especially useful for unknown and probably long protocols +# endif +#endif +//#define DEBUG // Activate this for lots of lovely debug output from the decoders. + +/* + * This include defines the actual pin number for pins like IR_RECEIVE_PIN, IR_SEND_PIN for many different boards and architectures + */ +#include "PinDefinitionsAndMore.h" +#include // include the library + +void setup() { + Serial.begin(115200); + + // Just to know which program is running on my Arduino + Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE)); + + // Start the receiver and if not 3. parameter specified, take LED_BUILTIN pin from the internal boards definition as default feedback LED + IrReceiver.begin(IR_RECEIVE_PIN, ENABLE_LED_FEEDBACK); + + Serial.println(F("Ready to receive unknown IR signals at pin " STR(IR_RECEIVE_PIN) " and decode it with hash decoder.")); +} + +void loop() { + /* + * Check if received data is available and if yes, try to decode it. + * Decoded hash result is in IrReceiver.decodedIRData.decodedRawData + */ + if (IrReceiver.available()) { + IrReceiver.initDecodedIRData(); // is required, if we do not call decode(); + IrReceiver.decodeHash(); + IrReceiver.resume(); // Early enable receiving of the next IR frame + /* + * Print a summary and then timing of received data + */ + IrReceiver.printIRResultShort(&Serial); + IrReceiver.printIRResultRawFormatted(&Serial, true); + + Serial.println(); + + /* + * Finally, check the received data and perform actions according to the received command + */ + auto tDecodedRawData = IrReceiver.decodedIRData.decodedRawData; // uint32_t on 8 and 16 bit CPUs and uint64_t on 32 and 64 bit CPUs + if (IrReceiver.decodedIRData.flags & IRDATA_FLAGS_IS_REPEAT) { + Serial.println(F("Repeat received. Here you can repeat the same action as before.")); + } else { + Serial.print(F("Raw data received are 0x")); + Serial.println(tDecodedRawData); + + if (IrReceiver.decodedIRData.command == 0x10) { + // do something + } else if (IrReceiver.decodedIRData.command == 0x11) { + // do something else + } + } + } +} diff --git a/examples/SimpleReceiverWithCallback/PinDefinitionsAndMore.h b/examples/SimpleReceiverWithCallback/PinDefinitionsAndMore.h index cb2b3b86d..b13414f56 100644 --- a/examples/SimpleReceiverWithCallback/PinDefinitionsAndMore.h +++ b/examples/SimpleReceiverWithCallback/PinDefinitionsAndMore.h @@ -4,7 +4,7 @@ * Contains pin definitions for IRremote examples for various platforms * as well as definitions for feedback LED and tone() and includes * - * Copyright (C) 2021-2022 Armin Joachimsmeyer + * Copyright (C) 2021-2023 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. @@ -32,81 +32,97 @@ * DEFAULT/AVR 2 3 4 Arduino * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore - * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark pro - * ATtiny3217 18|PA1 19|PA2 20|PA3 MegaTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore * ATtiny1604 2 3|PA5 % * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore - * SAMD21 3 4 5 + * MKR* 1 3 4 + * SAMD 2 3 4 * ESP8266 14|D5 12|D6 % - * ESP32 15 4 27 - * BluePill PA6 PA7 PA3 + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 * APOLLO3 11 12 5 * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 */ //#define _IR_MEASURE_TIMING // For debugging purposes. #if defined(__AVR__) -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board -#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore -#define IR_RECEIVE_PIN 0 -#define IR_SEND_PIN 4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. -#define TONE_PIN 3 -#define _IR_TIMING_TEST_PIN 3 +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 # elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board #include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" // For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. # if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core #define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 //#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards #define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 #define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 #define _IR_TIMING_TEST_PIN 10 // PA4 # else -#define IR_RECEIVE_PIN 3 // PA3 - on Digispark board labeled as pin 9 -#define IR_SEND_PIN 2 // PA2 - on Digispark board labeled as pin 8 -#define TONE_PIN 7 // PA7 - on Digispark board labeled as pin 5 +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 # endif -# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board -#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory -// Pin 6 is TX pin 7 is RX -#define IR_RECEIVE_PIN 3 // INT1 -#define IR_SEND_PIN 4 -#define TONE_PIN 9 -#define _IR_TIMING_TEST_PIN 8 - -# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // Tiny Core Dev board -#define IR_RECEIVE_PIN 18 -#define IR_SEND_PIN 19 -#define TONE_PIN 20 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output -#define LED_BUILTIN 2 // PA6 - -# elif defined(__AVR_ATtiny816__) // Tiny Core Micro -#define IR_RECEIVE_PIN 14 // PA1 -#define IR_SEND_PIN 16 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output -#define LED_BUILTIN 4 // PB5 - -# elif defined(__AVR_ATtiny1614__) -#define IR_RECEIVE_PIN 8 // PA1 -#define IR_SEND_PIN 10 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 - -# elif defined(__AVR_ATtiny1604__) -#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. -#define IR_SEND_PIN 3 -#define APPLICATION_PIN 5 +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 #define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it +#define TONE_PIN 42 // Dummy for examples using it # elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ || defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ @@ -139,6 +155,15 @@ # endif # endif // defined(__AVR_ATtiny25__)... +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + #elif defined(ESP8266) #define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW #define IR_RECEIVE_PIN 14 // D5 @@ -148,21 +173,32 @@ #define tone(...) void() // tone() inhibits receive timer #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it - -#elif defined(CONFIG_IDF_TARGET_ESP32C3) -#define IR_INPUT_PIN 8 -#define IR_SEND_PIN 9 -#define TONE_PIN 10 // ADC2_0 -#define APPLICATION_PIN 11 +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 #elif defined(ESP32) #include // tone() is included in ESP32 core since 2.0.2 -#if !defined(ESP_ARDUINO_VERSION_VAL) -#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) 12345678 -#endif +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif #if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) #define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. void tone(uint8_t aPinNumber, unsigned int aFrequency){ @@ -205,7 +241,8 @@ void noTone(uint8_t aPinNumber){ #define IR_SEND_PIN 12 #define TONE_PIN 5 -#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect #define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico #define IR_SEND_PIN 4 // GPIO16 #define TONE_PIN 5 @@ -252,14 +289,18 @@ void noTone(uint8_t aPinNumber){ #define _IR_TIMING_TEST_PIN 7 #elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else #define IR_RECEIVE_PIN 2 +# endif #define IR_SEND_PIN 3 #define TONE_PIN 4 #define APPLICATION_PIN 5 #define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. #define _IR_TIMING_TEST_PIN 7 -#if !defined(ARDUINO_SAMD_ADAFRUIT) +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) // On the Zero and others we switch explicitly to SerialUSB #define Serial SerialUSB #endif @@ -299,19 +340,13 @@ void noTone(uint8_t aPinNumber){ #define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation #else # if defined(SEND_PWM_BY_TIMER) -#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warning in IRTimer.hpp +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp # endif #endif #if !defined (FLASHEND) #define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined #endif -#if !defined (RAMEND) -#define RAMEND 0xFFFF // Dummy value for platforms where RAMEND is not defined -#endif -#if !defined (RAMSIZE) -#define RAMSIZE 0xFFFF // Dummy value for platforms where RAMSIZE is not defined -#endif /* * Helper macro for getting a macro definition as string diff --git a/examples/SimpleReceiverWithCallback/SimpleReceiverWithCallback.ino b/examples/SimpleReceiverWithCallback/SimpleReceiverWithCallback.ino index 3c1a3f40a..5489dbc81 100644 --- a/examples/SimpleReceiverWithCallback/SimpleReceiverWithCallback.ino +++ b/examples/SimpleReceiverWithCallback/SimpleReceiverWithCallback.ino @@ -59,7 +59,7 @@ //#define DEBUG // Activate this for lots of lovely debug output from the decoders. -//#define RAW_BUFFER_LENGTH 180 // Default is 112 if DECODE_MAGIQUEST is enabled, otherwise 100. +//#define RAW_BUFFER_LENGTH 750 // For air condition remotes it may require up to 750. Default is 200. #include @@ -77,6 +77,7 @@ void ReceiveCompleteCallbackHandler(); void setup() { Serial.begin(115200); + // Just to know which program is running on my Arduino Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE)); @@ -85,7 +86,7 @@ void setup() { IrReceiver.registerReceiveCompleteCallback(ReceiveCompleteCallbackHandler); Serial.print(F("Ready to receive IR signals of protocols: ")); - printActiveIRProtocols (&Serial); + printActiveIRProtocols(&Serial); Serial.println(F("at pin " STR(IR_RECEIVE_PIN))); } @@ -94,9 +95,7 @@ void loop() { * Print in loop (interrupts are enabled here) if received data is available. */ if (sIRDataJustReceived) { - // Print a short summary of received data - IrReceiver.printIRResultShort(&Serial); - IrReceiver.printIRSendUsage(&Serial); + // Print a summary of received data if (IrReceiver.decodedIRData.protocol == UNKNOWN) { Serial.println(F("Received noise or an unknown (or not yet enabled) protocol")); /* @@ -105,6 +104,9 @@ void loop() { * and the the first mark of the next (repeat) data was yet received */ IrReceiver.printIRResultRawFormatted(&Serial, true); // + } else { + IrReceiver.printIRResultShort(&Serial); + IrReceiver.printIRSendUsage(&Serial); } Serial.println(); } @@ -124,6 +126,10 @@ IRAM_ATTR # endif void ReceiveCompleteCallbackHandler() { IrReceiver.decode(); // fill IrReceiver.decodedIRData + /* + * Enable receiving of the next value. + */ + IrReceiver.resume(); /* * Check the received data and perform actions according to the received command @@ -146,13 +152,4 @@ void ReceiveCompleteCallbackHandler() { */ sIRDataJustReceived = true; - /* - * Enable receiving of the next value. - * !!!Attention!!! - * After receiving the first mark of the next (repeat) data, 3 variables required for printing are reset/overwritten. - * - IrReceiver.irparams.rawlen - * - IrReceiver.irparams.rawbuf[0] - * - IrReceiver.irparams.OverflowFlag) - */ - IrReceiver.resume(); } diff --git a/examples/SimpleSender/PinDefinitionsAndMore.h b/examples/SimpleSender/PinDefinitionsAndMore.h index cb2b3b86d..b13414f56 100644 --- a/examples/SimpleSender/PinDefinitionsAndMore.h +++ b/examples/SimpleSender/PinDefinitionsAndMore.h @@ -4,7 +4,7 @@ * Contains pin definitions for IRremote examples for various platforms * as well as definitions for feedback LED and tone() and includes * - * Copyright (C) 2021-2022 Armin Joachimsmeyer + * Copyright (C) 2021-2023 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. @@ -32,81 +32,97 @@ * DEFAULT/AVR 2 3 4 Arduino * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore - * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark pro - * ATtiny3217 18|PA1 19|PA2 20|PA3 MegaTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore * ATtiny1604 2 3|PA5 % * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore - * SAMD21 3 4 5 + * MKR* 1 3 4 + * SAMD 2 3 4 * ESP8266 14|D5 12|D6 % - * ESP32 15 4 27 - * BluePill PA6 PA7 PA3 + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 * APOLLO3 11 12 5 * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 */ //#define _IR_MEASURE_TIMING // For debugging purposes. #if defined(__AVR__) -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board -#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore -#define IR_RECEIVE_PIN 0 -#define IR_SEND_PIN 4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. -#define TONE_PIN 3 -#define _IR_TIMING_TEST_PIN 3 +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 # elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board #include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" // For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. # if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core #define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 //#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards #define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 #define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 #define _IR_TIMING_TEST_PIN 10 // PA4 # else -#define IR_RECEIVE_PIN 3 // PA3 - on Digispark board labeled as pin 9 -#define IR_SEND_PIN 2 // PA2 - on Digispark board labeled as pin 8 -#define TONE_PIN 7 // PA7 - on Digispark board labeled as pin 5 +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 # endif -# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board -#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory -// Pin 6 is TX pin 7 is RX -#define IR_RECEIVE_PIN 3 // INT1 -#define IR_SEND_PIN 4 -#define TONE_PIN 9 -#define _IR_TIMING_TEST_PIN 8 - -# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // Tiny Core Dev board -#define IR_RECEIVE_PIN 18 -#define IR_SEND_PIN 19 -#define TONE_PIN 20 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output -#define LED_BUILTIN 2 // PA6 - -# elif defined(__AVR_ATtiny816__) // Tiny Core Micro -#define IR_RECEIVE_PIN 14 // PA1 -#define IR_SEND_PIN 16 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output -#define LED_BUILTIN 4 // PB5 - -# elif defined(__AVR_ATtiny1614__) -#define IR_RECEIVE_PIN 8 // PA1 -#define IR_SEND_PIN 10 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 - -# elif defined(__AVR_ATtiny1604__) -#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. -#define IR_SEND_PIN 3 -#define APPLICATION_PIN 5 +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 #define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it +#define TONE_PIN 42 // Dummy for examples using it # elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ || defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ @@ -139,6 +155,15 @@ # endif # endif // defined(__AVR_ATtiny25__)... +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + #elif defined(ESP8266) #define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW #define IR_RECEIVE_PIN 14 // D5 @@ -148,21 +173,32 @@ #define tone(...) void() // tone() inhibits receive timer #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it - -#elif defined(CONFIG_IDF_TARGET_ESP32C3) -#define IR_INPUT_PIN 8 -#define IR_SEND_PIN 9 -#define TONE_PIN 10 // ADC2_0 -#define APPLICATION_PIN 11 +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 #elif defined(ESP32) #include // tone() is included in ESP32 core since 2.0.2 -#if !defined(ESP_ARDUINO_VERSION_VAL) -#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) 12345678 -#endif +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif #if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) #define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. void tone(uint8_t aPinNumber, unsigned int aFrequency){ @@ -205,7 +241,8 @@ void noTone(uint8_t aPinNumber){ #define IR_SEND_PIN 12 #define TONE_PIN 5 -#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect #define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico #define IR_SEND_PIN 4 // GPIO16 #define TONE_PIN 5 @@ -252,14 +289,18 @@ void noTone(uint8_t aPinNumber){ #define _IR_TIMING_TEST_PIN 7 #elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else #define IR_RECEIVE_PIN 2 +# endif #define IR_SEND_PIN 3 #define TONE_PIN 4 #define APPLICATION_PIN 5 #define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. #define _IR_TIMING_TEST_PIN 7 -#if !defined(ARDUINO_SAMD_ADAFRUIT) +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) // On the Zero and others we switch explicitly to SerialUSB #define Serial SerialUSB #endif @@ -299,19 +340,13 @@ void noTone(uint8_t aPinNumber){ #define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation #else # if defined(SEND_PWM_BY_TIMER) -#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warning in IRTimer.hpp +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp # endif #endif #if !defined (FLASHEND) #define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined #endif -#if !defined (RAMEND) -#define RAMEND 0xFFFF // Dummy value for platforms where RAMEND is not defined -#endif -#if !defined (RAMSIZE) -#define RAMSIZE 0xFFFF // Dummy value for platforms where RAMSIZE is not defined -#endif /* * Helper macro for getting a macro definition as string diff --git a/examples/SimpleSender/SimpleSender.ino b/examples/SimpleSender/SimpleSender.ino index fd2a02036..c6d97d62d 100644 --- a/examples/SimpleSender/SimpleSender.ino +++ b/examples/SimpleSender/SimpleSender.ino @@ -3,8 +3,9 @@ * * Demonstrates sending IR codes in standard format with address and command * An extended example for sending can be found as SendDemo. + * Sending IR codes using several pins for sending is implements in the MultipleSendPins example. * - * Copyright (C) 2020-2022 Armin Joachimsmeyer + * Copyright (C) 2020-2025 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of Arduino-IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. @@ -13,12 +14,17 @@ */ #include -#define DISABLE_CODE_FOR_RECEIVER // Disables restarting receiver after each send. Saves 450 bytes program memory and 269 bytes RAM if receiving functions are not used. +#if !defined(ARDUINO_ESP32C3_DEV) // This is due to a bug in RISC-V compiler, which requires unused function sections :-(. +#define DISABLE_CODE_FOR_RECEIVER // Disables static receiver code like receive timer ISR handler and static IRReceiver and irparams data. Saves 450 bytes program memory and 269 bytes RAM if receiving functions are not required. +#endif //#define SEND_PWM_BY_TIMER // Disable carrier PWM generation in software and use (restricted) hardware PWM. //#define USE_NO_SEND_PWM // Use no carrier PWM, just simulate an active low receiver signal. Overrides SEND_PWM_BY_TIMER definition -#include "PinDefinitionsAndMore.h" // Define macros for input and output pin etc. -#include +/* + * This include defines the actual pin number for pins like IR_RECEIVE_PIN, IR_SEND_PIN for many different boards and architectures + */ +#include "PinDefinitionsAndMore.h" +#include // include the library void setup() { pinMode(LED_BUILTIN, OUTPUT); @@ -33,8 +39,8 @@ void setup() { /* * The IR library setup. That's all! */ -// IrSender.begin(); // Start with IR_SEND_PIN as send pin and if NO_LED_FEEDBACK_CODE is NOT defined, enable feedback LED at default feedback LED pin - IrSender.begin(DISABLE_LED_FEEDBACK); // Start with IR_SEND_PIN as send pin and disable feedback LED at default feedback LED pin + IrSender.begin(); // Start with IR_SEND_PIN -which is defined in PinDefinitionsAndMore.h- as send pin and enable feedback LED at default feedback LED pin + disableLEDFeedback(); // Disable feedback LED at default feedback LED pin } /* @@ -63,6 +69,18 @@ void loop() { // Receiver output for the first loop must be: Protocol=NEC Address=0x102 Command=0x34 Raw-Data=0xCB340102 (32 bits) IrSender.sendNEC(0x00, sCommand, sRepeats); + /* + * If you want to send a raw HEX value directly like e.g. 0xCB340102 you must use sendNECRaw() + */ +// Serial.println(F("Send 32 bit LSB 0xCB340102 with NECRaw()")); +// IrSender.sendNECRaw(0xCB340102, sRepeats); + + /* + * If you want to send an "old" MSB HEX value used by IRremote versions before 3.0 like e.g. 0x40802CD3 you must use sendNECMSB() + */ +// Serial.println(F("Send old 32 bit MSB 0x40802CD3 with sendNECMSB()")); +// IrSender.sendNECMSB(0x40802CD3, 32, sRepeats); + /* * Increment send values */ diff --git a/examples/TinyReceiver/PinDefinitionsAndMore.h b/examples/TinyReceiver/PinDefinitionsAndMore.h new file mode 100644 index 000000000..b13414f56 --- /dev/null +++ b/examples/TinyReceiver/PinDefinitionsAndMore.h @@ -0,0 +1,357 @@ +/* + * PinDefinitionsAndMore.h + * + * Contains pin definitions for IRremote examples for various platforms + * as well as definitions for feedback LED and tone() and includes + * + * Copyright (C) 2021-2023 Armin Joachimsmeyer + * armin.joachimsmeyer@gmail.com + * + * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. + * + * Arduino-IRremote is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + * See the GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + * + */ + +/* + * Pin mapping table for different platforms + * + * Platform IR input IR output Tone Core/Pin schema + * -------------------------------------------------------------- + * DEFAULT/AVR 2 3 4 Arduino + * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore + * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore + * ATtiny1604 2 3|PA5 % + * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore + * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore + * MKR* 1 3 4 + * SAMD 2 3 4 + * ESP8266 14|D5 12|D6 % + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 + * APOLLO3 11 12 5 + * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 + */ +//#define _IR_MEASURE_TIMING // For debugging purposes. + +#if defined(__AVR__) +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 + +# elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" +// For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. +# if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core +#define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 +//#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 +#define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 +#define _IR_TIMING_TEST_PIN 10 // PA4 +# else +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 +# endif + +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 + +#define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() +#define noTone(a) void() +#define TONE_PIN 42 // Dummy for examples using it + +# elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ +|| defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ +|| defined(__AVR_ATmega324P__) || defined(__AVR_ATmega324A__) \ +|| defined(__AVR_ATmega324PA__) || defined(__AVR_ATmega164A__) \ +|| defined(__AVR_ATmega164P__) || defined(__AVR_ATmega32__) \ +|| defined(__AVR_ATmega16__) || defined(__AVR_ATmega8535__) \ +|| defined(__AVR_ATmega64__) || defined(__AVR_ATmega128__) \ +|| defined(__AVR_ATmega1281__) || defined(__AVR_ATmega2561__) \ +|| defined(__AVR_ATmega8515__) || defined(__AVR_ATmega162__) +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 13 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +# else // Default as for ATmega328 like on Uno, Nano, Leonardo, Teensy 2.0 etc. +#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +# if defined(ARDUINO_AVR_PROMICRO) // Sparkfun Pro Micro is __AVR_ATmega32U4__ but has different external circuit +// We have no built in LED at pin 13 -> reuse RX LED +#undef LED_BUILTIN +#define LED_BUILTIN LED_BUILTIN_RX +# endif +# endif // defined(__AVR_ATtiny25__)... + +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +#elif defined(ESP8266) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW +#define IR_RECEIVE_PIN 14 // D5 +#define IR_SEND_PIN 12 // D6 - D4/pin 2 is internal LED +#define _IR_TIMING_TEST_PIN 2 // D4 +#define APPLICATION_PIN 13 // D7 + +#define tone(...) void() // tone() inhibits receive timer +#define noTone(a) void() +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 + +#elif defined(ESP32) +#include + +// tone() is included in ESP32 core since 2.0.2 +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif +#if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) +#define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. +void tone(uint8_t aPinNumber, unsigned int aFrequency){ + ledcAttachPin(aPinNumber, TONE_LEDC_CHANNEL); + ledcWriteTone(TONE_LEDC_CHANNEL, aFrequency); +} +void tone(uint8_t aPinNumber, unsigned int aFrequency, unsigned long aDuration){ + ledcAttachPin(aPinNumber, TONE_LEDC_CHANNEL); + ledcWriteTone(TONE_LEDC_CHANNEL, aFrequency); + delay(aDuration); + ledcWriteTone(TONE_LEDC_CHANNEL, 0); +} +void noTone(uint8_t aPinNumber){ + ledcWriteTone(TONE_LEDC_CHANNEL, 0); +} +#endif // ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) + +#define IR_RECEIVE_PIN 15 // D15 +#define IR_SEND_PIN 4 // D4 +#define TONE_PIN 27 // D27 25 & 26 are DAC0 and 1 +#define APPLICATION_PIN 16 // RX2 pin + +#elif defined(ARDUINO_ARCH_STM32) || defined(ARDUINO_ARCH_STM32F1) // BluePill +// Timer 3 blocks PA6, PA7, PB0, PB1 for use by Servo or tone() +#define IR_RECEIVE_PIN PA6 +#define IR_RECEIVE_PIN_STRING "PA6" +#define IR_SEND_PIN PA7 +#define IR_SEND_PIN_STRING "PA7" +#define TONE_PIN PA3 +#define _IR_TIMING_TEST_PIN PA5 +#define APPLICATION_PIN PA2 +#define APPLICATION_PIN_STRING "PA2" +# if defined(ARDUINO_GENERIC_STM32F103C) || defined(ARDUINO_BLUEPILL_F103C8) +// BluePill LED is active low +#define FEEDBACK_LED_IS_ACTIVE_LOW +# endif + +#elif defined(ARDUINO_ARCH_APOLLO3) // Sparkfun Apollo boards +#define IR_RECEIVE_PIN 11 +#define IR_SEND_PIN 12 +#define TONE_PIN 5 + +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect +#define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico +#define IR_SEND_PIN 4 // GPIO16 +#define TONE_PIN 5 +#define APPLICATION_PIN 6 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 7 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 8 + +#elif defined(ARDUINO_ARCH_RP2040) // Arduino Nano Connect, Pi Pico with arduino-pico core https://github.com/earlephilhower/arduino-pico +#define IR_RECEIVE_PIN 15 // GPIO15 to be compatible with the Arduino Nano RP2040 Connect (pin3) +#define IR_SEND_PIN 16 // GPIO16 +#define TONE_PIN 17 +#define APPLICATION_PIN 18 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 19 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 20 + +// If you program the Nano RP2040 Connect with this core, then you must redefine LED_BUILTIN +// and use the external reset with 1 kOhm to ground to enter UF2 mode +#undef LED_BUILTIN +#define LED_BUILTIN 6 + +#elif defined(PARTICLE) // !!!UNTESTED!!! +#define IR_RECEIVE_PIN A4 +#define IR_SEND_PIN A5 // Particle supports multiple pins + +#define LED_BUILTIN D7 + +/* + * 4 times the same (default) layout for easy adaption in the future + */ +#elif defined(TEENSYDUINO) // Teensy 2.0 is handled at default for ATmega328 like on Uno, Nano, Leonardo etc. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +#elif defined(ARDUINO_ARCH_MBED) // Arduino Nano 33 BLE +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +#elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else +#define IR_RECEIVE_PIN 2 +# endif +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) +// On the Zero and others we switch explicitly to SerialUSB +#define Serial SerialUSB +#endif + +// Definitions for the Chinese SAMD21 M0-Mini clone, which has no led connected to D13/PA17. +// Attention!!! D2 and D4 are swapped on these boards!!! +// If you connect the LED, it is on pin 24/PB11. In this case activate the next two lines. +//#undef LED_BUILTIN +//#define LED_BUILTIN 24 // PB11 +// As an alternative you can choose pin 25, it is the RX-LED pin (PB03), but active low.In this case activate the next 3 lines. +//#undef LED_BUILTIN +//#define LED_BUILTIN 25 // PB03 +//#define FEEDBACK_LED_IS_ACTIVE_LOW // The RX LED on the M0-Mini is active LOW + +#elif defined (NRF51) // BBC micro:bit +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define APPLICATION_PIN 1 +#define _IR_TIMING_TEST_PIN 4 + +#define tone(...) void() // no tone() available +#define noTone(a) void() +#define TONE_PIN 42 // Dummy for examples using it + +#else +#warning Board / CPU is not detected using pre-processor symbols -> using default values, which may not fit. Please extend PinDefinitionsAndMore.h. +// Default valued for unidentified boards +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 +#endif // defined(ESP8266) + +#if defined(ESP32) || defined(ARDUINO_ARCH_RP2040) || defined(PARTICLE) || defined(ARDUINO_ARCH_MBED) +#define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation +#else +# if defined(SEND_PWM_BY_TIMER) +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp +# endif +#endif + +#if !defined (FLASHEND) +#define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined +#endif + +/* + * Helper macro for getting a macro definition as string + */ +#if !defined(STR_HELPER) +#define STR_HELPER(x) #x +#define STR(x) STR_HELPER(x) +#endif diff --git a/examples/TinyReceiver/TinyReceiver.ino b/examples/TinyReceiver/TinyReceiver.ino index df3e47a37..b31b4657f 100644 --- a/examples/TinyReceiver/TinyReceiver.ino +++ b/examples/TinyReceiver/TinyReceiver.ino @@ -26,7 +26,7 @@ ************************************************************************************ * MIT License * - * Copyright (c) 2022-2023 Armin Joachimsmeyer + * Copyright (c) 2022-2024 Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -50,49 +50,26 @@ #include -/* - * Set sensible receive pin for different CPU's - */ -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) || defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) -/* - * This program runs on 1 MHz CPU clock :-) and is requires only 1550 bytes program memory using ATTiny core - */ -#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut" - Saves up to 700 bytes program memory and 70 bytes RAM for ATtinyCore -# if defined(ARDUINO_AVR_DIGISPARKPRO) -#define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 -# else -#define IR_RECEIVE_PIN 0 // PCINT0 -# endif -#elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) -#define IR_RECEIVE_PIN 10 -#elif (defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)) -#define IR_RECEIVE_PIN 21 // INT0 -#elif defined(ESP8266) -#define IR_RECEIVE_PIN 14 // D5 -#elif defined(CONFIG_IDF_TARGET_ESP32C3) -#define IR_RECEIVE_PIN 8 -#elif defined(ESP32) -#define IR_RECEIVE_PIN 15 -#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) -#define IR_RECEIVE_PIN 3 // GPIO15 Use pin 3 since pin 2|GPIO25 is connected to LED on Pi pico -#elif defined(ARDUINO_ARCH_RP2040) // Pi Pico with arduino-pico core https://github.com/earlephilhower/arduino-pico -#define IR_RECEIVE_PIN 15 // to be compatible with the Arduino Nano RP2040 Connect (pin3) -#else -#define IR_RECEIVE_PIN 2 // INT0 -//#define NO_LED_FEEDBACK_CODE // Activate this if you want to suppress LED feedback or if you do not have a LED. This saves 14 bytes code and 2 clock cycles per interrupt. -#endif +#include "PinDefinitionsAndMore.h" // Set IR_RECEIVE_PIN for different CPU's //#define DEBUG // to see if attachInterrupt is used //#define TRACE // to see the state of the ISR state machine /* - * Second: include the code and compile it. + * Protocol selection */ //#define DISABLE_PARITY_CHECKS // Disable parity checks. Saves 48 bytes of program memory. +//#define USE_EXTENDED_NEC_PROTOCOL // Like NEC, but take the 16 bit address as one 16 bit value and not as 8 bit normal and 8 bit inverted value. //#define USE_ONKYO_PROTOCOL // Like NEC, but take the 16 bit address and command each as one 16 bit value and not as 8 bit normal and 8 bit inverted value. -//#define USE_FAST_PROTOCOL // Use FAST protocol (no address and 16 bit data, interpreted as 8 bit command and 8 bit inverted command) instead of NEC. -//#define ENABLE_NEC2_REPEATS // Instead of sending / receiving the NEC special repeat code, send / receive the original frame for repeat. -#include "TinyIRReceiver.hpp" +//#define USE_FAST_PROTOCOL // Use FAST protocol instead of NEC / ONKYO. +//#define ENABLE_NEC2_REPEATS // Instead of sending / receiving the NEC special repeat code, send / receive the original frame for repeat. +/* + * Set compile options to modify the generated code. + */ +//#define DISABLE_PARITY_CHECKS // Disable parity checks. Saves 48 bytes of program memory. +//#define USE_CALLBACK_FOR_TINY_RECEIVER // Call the user provided function "void handleReceivedTinyIRData()" each time a frame or repeat is received. + +#include "TinyIRReceiver.hpp" // include the code /* * Helper macro for getting a macro definition as string @@ -102,13 +79,19 @@ #define STR(x) STR_HELPER(x) #endif -volatile struct TinyIRReceiverCallbackDataStruct sCallbackData; - void setup() { Serial.begin(115200); -#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/|| defined(SERIALUSB_PID) || defined(ARDUINO_attiny3217) - delay(4000); // To be able to connect Serial monitor after reset or power up and before first print out. Do not wait for an attached Serial Monitor! + +#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/ \ + || defined(SERIALUSB_PID) || defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_attiny3217) + // Wait until Serial Monitor is attached. + // Required for boards using USB code for Serial like Leonardo. + // Is void for USB Serial implementations using external chips e.g. a CH340. + while (!Serial) + ; + // !!! Program will not proceed if no Serial Monitor is attached !!! #endif + // Just to know which program is running on my Arduino #if defined(ESP8266) || defined(ESP32) Serial.println(); @@ -127,64 +110,64 @@ void setup() { } void loop() { - if (sCallbackData.justWritten) { - sCallbackData.justWritten = false; -#if defined(USE_FAST_PROTOCOL) - Serial.print(F("Command=0x")); -#else + if (TinyReceiverDecode()) { + +#if !defined(USE_FAST_PROTOCOL) + // We have no address at FAST protocol Serial.print(F("Address=0x")); - Serial.print(sCallbackData.Address, HEX); - Serial.print(F(" Command=0x")); + Serial.print(TinyIRReceiverData.Address, HEX); + Serial.print(' '); #endif - Serial.print(sCallbackData.Command, HEX); - if (sCallbackData.Flags == IRDATA_FLAGS_IS_REPEAT) { + + Serial.print(F("Command=0x")); + Serial.print(TinyIRReceiverData.Command, HEX); + if (TinyIRReceiverData.Flags == IRDATA_FLAGS_IS_REPEAT) { Serial.print(F(" Repeat")); } - if (sCallbackData.Flags == IRDATA_FLAGS_PARITY_FAILED) { + if (TinyIRReceiverData.Flags == IRDATA_FLAGS_PARITY_FAILED) { Serial.print(F(" Parity failed")); + +#if !defined(USE_EXTENDED_NEC_PROTOCOL) && !defined(USE_ONKYO_PROTOCOL) + Serial.print(F(", try USE_EXTENDED_NEC_PROTOCOL or USE_ONKYO_PROTOCOL")); +#endif + } Serial.println(); } /* * Put your code here */ + + /* + * No resume() required :-) + */ } /* - * This is the function is called if a complete command was received + * Optional code, if you require a callback + */ +#if defined(USE_CALLBACK_FOR_TINY_RECEIVER) +/* + * This is the function, which is called if a complete frame was received * It runs in an ISR context with interrupts enabled, so functions like delay() etc. should work here */ -#if defined(ESP8266) || defined(ESP32) +# if defined(ESP8266) || defined(ESP32) IRAM_ATTR -#endif - -#if defined(USE_FAST_PROTOCOL) -void handleReceivedTinyIRData(uint8_t aCommand, uint8_t aFlags) -#elif defined(USE_ONKYO_PROTOCOL) -void handleReceivedTinyIRData(uint16_t aAddress, uint16_t aCommand, uint8_t aFlags) -#else -void handleReceivedTinyIRData(uint8_t aAddress, uint8_t aCommand, uint8_t aFlags) -#endif - { -#if defined(ARDUINO_ARCH_MBED) || defined(ESP32) - // Copy data for main loop, this is the recommended way for handling a callback :-) -# if !defined(USE_FAST_PROTOCOL) - sCallbackData.Address = aAddress; # endif - sCallbackData.Command = aCommand; - sCallbackData.Flags = aFlags; - sCallbackData.justWritten = true; -#else + +void handleReceivedTinyIRData() { +# if defined(ARDUINO_ARCH_MBED) || defined(ESP32) /* - * Printing is not allowed in ISR context for any kind of RTOS + * Printing is not allowed in ISR context for any kind of RTOS, so we use the slihjtly more complex, + * but recommended way for handling a callback :-). Copy data for main loop. * For Mbed we get a kernel panic and "Error Message: Semaphore: 0x0, Not allowed in ISR context" for Serial.print() * for ESP32 we get a "Guru Meditation Error: Core 1 panic'ed" (we also have an RTOS running!) */ - // Print only very short output, since we are in an interrupt context and do not want to miss the next interrupts of the repeats coming soon -# if defined(USE_FAST_PROTOCOL) - printTinyReceiverResultMinimal(&Serial, aCommand, aFlags); + // Do something useful here... # else - printTinyReceiverResultMinimal(&Serial, aAddress, aCommand, aFlags); + // As an example, print very short output, since we are in an interrupt context and do not want to miss the next interrupts of the repeats coming soon + printTinyReceiverResultMinimal(&Serial); # endif -#endif } +#endif + diff --git a/examples/TinySender/PinDefinitionsAndMore.h b/examples/TinySender/PinDefinitionsAndMore.h new file mode 100644 index 000000000..b13414f56 --- /dev/null +++ b/examples/TinySender/PinDefinitionsAndMore.h @@ -0,0 +1,357 @@ +/* + * PinDefinitionsAndMore.h + * + * Contains pin definitions for IRremote examples for various platforms + * as well as definitions for feedback LED and tone() and includes + * + * Copyright (C) 2021-2023 Armin Joachimsmeyer + * armin.joachimsmeyer@gmail.com + * + * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. + * + * Arduino-IRremote is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + * See the GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + * + */ + +/* + * Pin mapping table for different platforms + * + * Platform IR input IR output Tone Core/Pin schema + * -------------------------------------------------------------- + * DEFAULT/AVR 2 3 4 Arduino + * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore + * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore + * ATtiny1604 2 3|PA5 % + * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore + * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore + * MKR* 1 3 4 + * SAMD 2 3 4 + * ESP8266 14|D5 12|D6 % + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 + * APOLLO3 11 12 5 + * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 + */ +//#define _IR_MEASURE_TIMING // For debugging purposes. + +#if defined(__AVR__) +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 + +# elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" +// For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. +# if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core +#define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 +//#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 +#define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 +#define _IR_TIMING_TEST_PIN 10 // PA4 +# else +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 +# endif + +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 + +#define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() +#define noTone(a) void() +#define TONE_PIN 42 // Dummy for examples using it + +# elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ +|| defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ +|| defined(__AVR_ATmega324P__) || defined(__AVR_ATmega324A__) \ +|| defined(__AVR_ATmega324PA__) || defined(__AVR_ATmega164A__) \ +|| defined(__AVR_ATmega164P__) || defined(__AVR_ATmega32__) \ +|| defined(__AVR_ATmega16__) || defined(__AVR_ATmega8535__) \ +|| defined(__AVR_ATmega64__) || defined(__AVR_ATmega128__) \ +|| defined(__AVR_ATmega1281__) || defined(__AVR_ATmega2561__) \ +|| defined(__AVR_ATmega8515__) || defined(__AVR_ATmega162__) +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 13 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +# else // Default as for ATmega328 like on Uno, Nano, Leonardo, Teensy 2.0 etc. +#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +# if defined(ARDUINO_AVR_PROMICRO) // Sparkfun Pro Micro is __AVR_ATmega32U4__ but has different external circuit +// We have no built in LED at pin 13 -> reuse RX LED +#undef LED_BUILTIN +#define LED_BUILTIN LED_BUILTIN_RX +# endif +# endif // defined(__AVR_ATtiny25__)... + +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +#elif defined(ESP8266) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW +#define IR_RECEIVE_PIN 14 // D5 +#define IR_SEND_PIN 12 // D6 - D4/pin 2 is internal LED +#define _IR_TIMING_TEST_PIN 2 // D4 +#define APPLICATION_PIN 13 // D7 + +#define tone(...) void() // tone() inhibits receive timer +#define noTone(a) void() +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 + +#elif defined(ESP32) +#include + +// tone() is included in ESP32 core since 2.0.2 +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif +#if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) +#define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. +void tone(uint8_t aPinNumber, unsigned int aFrequency){ + ledcAttachPin(aPinNumber, TONE_LEDC_CHANNEL); + ledcWriteTone(TONE_LEDC_CHANNEL, aFrequency); +} +void tone(uint8_t aPinNumber, unsigned int aFrequency, unsigned long aDuration){ + ledcAttachPin(aPinNumber, TONE_LEDC_CHANNEL); + ledcWriteTone(TONE_LEDC_CHANNEL, aFrequency); + delay(aDuration); + ledcWriteTone(TONE_LEDC_CHANNEL, 0); +} +void noTone(uint8_t aPinNumber){ + ledcWriteTone(TONE_LEDC_CHANNEL, 0); +} +#endif // ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) + +#define IR_RECEIVE_PIN 15 // D15 +#define IR_SEND_PIN 4 // D4 +#define TONE_PIN 27 // D27 25 & 26 are DAC0 and 1 +#define APPLICATION_PIN 16 // RX2 pin + +#elif defined(ARDUINO_ARCH_STM32) || defined(ARDUINO_ARCH_STM32F1) // BluePill +// Timer 3 blocks PA6, PA7, PB0, PB1 for use by Servo or tone() +#define IR_RECEIVE_PIN PA6 +#define IR_RECEIVE_PIN_STRING "PA6" +#define IR_SEND_PIN PA7 +#define IR_SEND_PIN_STRING "PA7" +#define TONE_PIN PA3 +#define _IR_TIMING_TEST_PIN PA5 +#define APPLICATION_PIN PA2 +#define APPLICATION_PIN_STRING "PA2" +# if defined(ARDUINO_GENERIC_STM32F103C) || defined(ARDUINO_BLUEPILL_F103C8) +// BluePill LED is active low +#define FEEDBACK_LED_IS_ACTIVE_LOW +# endif + +#elif defined(ARDUINO_ARCH_APOLLO3) // Sparkfun Apollo boards +#define IR_RECEIVE_PIN 11 +#define IR_SEND_PIN 12 +#define TONE_PIN 5 + +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect +#define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico +#define IR_SEND_PIN 4 // GPIO16 +#define TONE_PIN 5 +#define APPLICATION_PIN 6 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 7 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 8 + +#elif defined(ARDUINO_ARCH_RP2040) // Arduino Nano Connect, Pi Pico with arduino-pico core https://github.com/earlephilhower/arduino-pico +#define IR_RECEIVE_PIN 15 // GPIO15 to be compatible with the Arduino Nano RP2040 Connect (pin3) +#define IR_SEND_PIN 16 // GPIO16 +#define TONE_PIN 17 +#define APPLICATION_PIN 18 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 19 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 20 + +// If you program the Nano RP2040 Connect with this core, then you must redefine LED_BUILTIN +// and use the external reset with 1 kOhm to ground to enter UF2 mode +#undef LED_BUILTIN +#define LED_BUILTIN 6 + +#elif defined(PARTICLE) // !!!UNTESTED!!! +#define IR_RECEIVE_PIN A4 +#define IR_SEND_PIN A5 // Particle supports multiple pins + +#define LED_BUILTIN D7 + +/* + * 4 times the same (default) layout for easy adaption in the future + */ +#elif defined(TEENSYDUINO) // Teensy 2.0 is handled at default for ATmega328 like on Uno, Nano, Leonardo etc. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +#elif defined(ARDUINO_ARCH_MBED) // Arduino Nano 33 BLE +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +#elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else +#define IR_RECEIVE_PIN 2 +# endif +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) +// On the Zero and others we switch explicitly to SerialUSB +#define Serial SerialUSB +#endif + +// Definitions for the Chinese SAMD21 M0-Mini clone, which has no led connected to D13/PA17. +// Attention!!! D2 and D4 are swapped on these boards!!! +// If you connect the LED, it is on pin 24/PB11. In this case activate the next two lines. +//#undef LED_BUILTIN +//#define LED_BUILTIN 24 // PB11 +// As an alternative you can choose pin 25, it is the RX-LED pin (PB03), but active low.In this case activate the next 3 lines. +//#undef LED_BUILTIN +//#define LED_BUILTIN 25 // PB03 +//#define FEEDBACK_LED_IS_ACTIVE_LOW // The RX LED on the M0-Mini is active LOW + +#elif defined (NRF51) // BBC micro:bit +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define APPLICATION_PIN 1 +#define _IR_TIMING_TEST_PIN 4 + +#define tone(...) void() // no tone() available +#define noTone(a) void() +#define TONE_PIN 42 // Dummy for examples using it + +#else +#warning Board / CPU is not detected using pre-processor symbols -> using default values, which may not fit. Please extend PinDefinitionsAndMore.h. +// Default valued for unidentified boards +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 +#endif // defined(ESP8266) + +#if defined(ESP32) || defined(ARDUINO_ARCH_RP2040) || defined(PARTICLE) || defined(ARDUINO_ARCH_MBED) +#define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation +#else +# if defined(SEND_PWM_BY_TIMER) +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp +# endif +#endif + +#if !defined (FLASHEND) +#define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined +#endif + +/* + * Helper macro for getting a macro definition as string + */ +#if !defined(STR_HELPER) +#define STR_HELPER(x) #x +#define STR(x) STR_HELPER(x) +#endif diff --git a/examples/TinySender/TinySender.ino b/examples/TinySender/TinySender.ino index 39ff3c4d7..4af49883b 100644 --- a/examples/TinySender/TinySender.ino +++ b/examples/TinySender/TinySender.ino @@ -1,10 +1,12 @@ /* * TinySender.cpp * - * Example for sending FAST or NEC protocol using TinyIR. + * Example for sending using TinyIR. By default sends simultaneously using all supported protocols + * To use a single protocol, simply delete or comment out all unneeded protocols in the main loop + * Program size is significantly reduced when using a single protocol + * For example, sending only 8 bit address and command NEC codes saves 780 bytes program memory and 26 bytes RAM compared to SimpleSender, + * which does the same, but uses the IRRemote library (and is therefore much more flexible). * - * NEC protocol codes are sent in standard format with 8bit address and 8 bit command as in SimpleSender example. - * Saves 780 bytes program memory and 26 bytes RAM compared to SimpleSender, which does the same, but uses the IRRemote library (and is therefore much more flexible). * * The FAST protocol is a proprietary modified JVC protocol without address, with parity and with a shorter header. * FAST Protocol characteristics: @@ -21,7 +23,7 @@ ************************************************************************************ * MIT License * - * Copyright (c) 2022-2023 Armin Joachimsmeyer + * Copyright (c) 2022-2024 Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -44,16 +46,10 @@ */ #include -//#define USE_FAST_PROTOCOL // Use FAST protocol. No address and 16 bit data, interpreted as 8 bit command and 8 bit inverted command -//#define DISABLE_PARITY_CHECKS // Disable parity checks. Saves 48 bytes of program memory. -//#define USE_ONKYO_PROTOCOL // Like NEC, but take the 16 bit address and command each as one 16 bit value and not as 8 bit normal and 8 bit inverted value. -//#define USE_FAST_PROTOCOL // Use FAST protocol (no address and 16 bit data, interpreted as 8 bit command and 8 bit inverted command) instead of NEC. -//#define ENABLE_NEC2_REPEATS // Instead of sending / receiving the NEC special repeat code, send / receive the original frame for repeat. +#include "PinDefinitionsAndMore.h" // Set IR_SEND_PIN for different CPU's #include "TinyIRSender.hpp" -#define IR_SEND_PIN 3 - void setup() { pinMode(LED_BUILTIN, OUTPUT); @@ -82,29 +78,47 @@ void loop() { */ Serial.println(); Serial.print(F("Send now:")); -#if defined(USE_FAST_PROTOCOL) Serial.print(F(" address=0x")); Serial.print(sAddress, HEX); -#endif Serial.print(F(" command=0x")); Serial.print(sCommand, HEX); Serial.print(F(" repeats=")); Serial.print(sRepeats); Serial.println(); -#if defined(USE_FAST_PROTOCOL) - Serial.println(F("Send FAST with 8 bit address")); + // Send with FAST + // No address and only 16 bits of data, interpreted as 8 bit command and 8 bit inverted command for parity checking + Serial.println(F("Send FAST with 8 bit command")); Serial.flush(); sendFAST(IR_SEND_PIN, sCommand, sRepeats); -#elif defined(USE_ONKYO_PROTOCOL) + + // Send with NEC + // NEC uses 8 bit address and 8 bit command each with 8 bit inverted parity checks + // However, sendNEC will accept 16 bit address and commands too (but remove the parity checks) + Serial.println(F("Send NEC with 8 bit address and command")); + Serial.flush(); + sendNEC(IR_SEND_PIN, sAddress, sCommand, sRepeats); + + // Send with Extended NEC + // Like NEC, but the address is forced 16 bits with no parity check + Serial.println(F("Send ExtendedNEC with 16 bit address and 8 bit command")); + Serial.flush(); + sendExtendedNEC(IR_SEND_PIN, sAddress, sCommand, sRepeats); + + // Send with ONKYO + // Like NEC, but both the address and command are forced 16 bits with no parity check Serial.println(F("Send ONKYO with 16 bit address and command")); Serial.flush(); sendONKYO(IR_SEND_PIN, sAddress, sCommand, sRepeats); -#else - Serial.println(F("Send NEC with 8 bit address")); + + // Send with NEC2 + // Instead of sending the NEC special repeat code, sends the full original frame for repeats + // Sending NEC2 is done by setting the optional bool NEC2Repeats argument to true (defaults to false) + // sendExtendedNEC and sendONKYO also support the NEC2Repeats argument for full frame repeats (not demonstrated here) + Serial.println(F("Send NEC2 with 8 bit address and command and original frame repeats")); Serial.flush(); - sendNEC(IR_SEND_PIN, sAddress, sCommand, sRepeats); -#endif + sendNEC(IR_SEND_PIN, sAddress, sCommand, sRepeats, true); + /* * Increment send values * Also increment address just for demonstration, which normally makes no sense diff --git a/examples/UnitTest/PinDefinitionsAndMore.h b/examples/UnitTest/PinDefinitionsAndMore.h index cb2b3b86d..b13414f56 100644 --- a/examples/UnitTest/PinDefinitionsAndMore.h +++ b/examples/UnitTest/PinDefinitionsAndMore.h @@ -4,7 +4,7 @@ * Contains pin definitions for IRremote examples for various platforms * as well as definitions for feedback LED and tone() and includes * - * Copyright (C) 2021-2022 Armin Joachimsmeyer + * Copyright (C) 2021-2023 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. @@ -32,81 +32,97 @@ * DEFAULT/AVR 2 3 4 Arduino * ATtinyX5 0|PB0 4|PB4 3|PB3 ATTinyCore * ATtiny167 3|PA3 2|PA2 7|PA7 ATTinyCore - * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark pro - * ATtiny3217 18|PA1 19|PA2 20|PA3 MegaTinyCore + * ATtiny167 9|PA3 8|PA2 5|PA7 Digispark original core + * ATtiny84 |PB2 |PA4 |PA3 ATTinyCore + * ATtiny88 3|PD3 4|PD4 9|PB1 ATTinyCore + * ATtiny3216 14|PA1 15|PA2 16|PA3 MegaTinyCore * ATtiny1604 2 3|PA5 % * ATtiny816 14|PA1 16|PA3 1|PA5 MegaTinyCore * ATtiny1614 8|PA1 10|PA3 1|PA5 MegaTinyCore - * SAMD21 3 4 5 + * MKR* 1 3 4 + * SAMD 2 3 4 * ESP8266 14|D5 12|D6 % - * ESP32 15 4 27 - * BluePill PA6 PA7 PA3 + * ESP32 15 4 27 + * ESP32-C3 2 3 4 + * BluePill PA6 PA7 PA3 * APOLLO3 11 12 5 * RP2040 3|GPIO15 4|GPIO16 5|GPIO17 */ //#define _IR_MEASURE_TIMING // For debugging purposes. #if defined(__AVR__) -#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board -#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore -#define IR_RECEIVE_PIN 0 -#define IR_SEND_PIN 4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. -#define TONE_PIN 3 -#define _IR_TIMING_TEST_PIN 3 +#if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) // Digispark board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // TX is at pin 2 - Available as Arduino library "ATtinySerialOut". Saves 700 bytes program memory and 70 bytes RAM for ATtinyCore. +#define IR_RECEIVE_PIN PIN_PB0 +#define IR_SEND_PIN PIN_PB4 // Pin 2 is serial output with ATtinySerialOut. Pin 1 is internal LED and Pin3 is USB+ with pullup on Digispark board. +#define TONE_PIN PIN_PB3 +#define _IR_TIMING_TEST_PIN PIN_PB3 # elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) // Digispark pro board #include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut" // For ATtiny167 Pins PB6 and PA3 are usable as interrupt source. # if defined(ARDUINO_AVR_DIGISPARKPRO) +// For use with Digispark original core #define IR_RECEIVE_PIN 9 // PA3 - on Digispark board labeled as pin 9 //#define IR_RECEIVE_PIN 14 // PB6 / INT0 is connected to USB+ on DigisparkPro boards #define IR_SEND_PIN 8 // PA2 - on Digispark board labeled as pin 8 #define TONE_PIN 5 // PA7 - on Digispark board labeled as pin 5 #define _IR_TIMING_TEST_PIN 10 // PA4 # else -#define IR_RECEIVE_PIN 3 // PA3 - on Digispark board labeled as pin 9 -#define IR_SEND_PIN 2 // PA2 - on Digispark board labeled as pin 8 -#define TONE_PIN 7 // PA7 - on Digispark board labeled as pin 5 +// For use with ATTinyCore +#define IR_RECEIVE_PIN PIN_PA3 // On Digispark board labeled as pin 9 - INT0 is connected to USB+ on DigisparkPro boards +#define IR_SEND_PIN PIN_PA2 // On Digispark board labeled as pin 8 +#define TONE_PIN PIN_PA7 // On Digispark board labeled as pin 5 # endif -# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board -#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory -// Pin 6 is TX pin 7 is RX -#define IR_RECEIVE_PIN 3 // INT1 -#define IR_SEND_PIN 4 -#define TONE_PIN 9 -#define _IR_TIMING_TEST_PIN 8 - -# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // Tiny Core Dev board -#define IR_RECEIVE_PIN 18 -#define IR_SEND_PIN 19 -#define TONE_PIN 20 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output -#define LED_BUILTIN 2 // PA6 - -# elif defined(__AVR_ATtiny816__) // Tiny Core Micro -#define IR_RECEIVE_PIN 14 // PA1 -#define IR_SEND_PIN 16 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 -#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output -#define LED_BUILTIN 4 // PB5 - -# elif defined(__AVR_ATtiny1614__) -#define IR_RECEIVE_PIN 8 // PA1 -#define IR_SEND_PIN 10 // PA3 -#define TONE_PIN 1 // PA5 -#define APPLICATION_PIN 0 // PA4 - -# elif defined(__AVR_ATtiny1604__) -#define IR_RECEIVE_PIN 2 // To be compatible with interrupt example, pin 2 is chosen here. -#define IR_SEND_PIN 3 -#define APPLICATION_PIN 5 +# elif defined(__AVR_ATtiny84__) // For use with ATTinyCore +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +#define IR_RECEIVE_PIN PIN_PB2 // INT0 +#define IR_SEND_PIN PIN_PA4 +#define TONE_PIN PIN_PA3 +#define _IR_TIMING_TEST_PIN PIN_PA5 + +# elif defined(__AVR_ATtiny88__) // MH-ET Tiny88 board. For use with ATTinyCore. +#include "ATtinySerialOut.hpp" // Available as Arduino library "ATtinySerialOut". Saves 128 bytes program memory. +// Pin 6 is TX, pin 7 is RX +#define IR_RECEIVE_PIN PIN_PD3 // 3 - INT1 +#define IR_SEND_PIN PIN_PD4 // 4 +#define TONE_PIN PIN_PB1 // 9 +#define _IR_TIMING_TEST_PIN PIN_PB0 // 8 + +# elif defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // For use with megaTinyCore +// Tiny Core Dev board +// https://www.tindie.com/products/xkimi/tiny-core-16-dev-board-attiny1616/ - Out of Stock +// https://www.tindie.com/products/xkimi/tiny-core-32-dev-board-attiny3217/ - Out of Stock +#define IR_RECEIVE_PIN PIN_PA1 // 14 use 18 instead of PIN_PA1 for TinyCore32 +#define IR_SEND_PIN PIN_PA2 // 15, 19 for TinyCore32 +#define TONE_PIN PIN_PA3 // 16, 20 for TinyCore32 +#define APPLICATION_PIN PIN_PC3 // 13, PIN_PA0 is RESET +#undef LED_BUILTIN // No LED available on the TinyCore 32 board, take the one on the programming board which is connected to the DAC output +#define LED_BUILTIN PIN_PA6 // use 2 instead of PIN_PA6 for TinyCore32 + +# elif defined(__AVR_ATtiny816__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 14 +#define IR_SEND_PIN PIN_PA1 // 16 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 +#undef LED_BUILTIN // No LED available, take the one which is connected to the DAC output +#define LED_BUILTIN PIN_PB5 // 4 + +# elif defined(__AVR_ATtiny1614__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA1 // 8 +#define IR_SEND_PIN PIN_PA3 // 10 +#define TONE_PIN PIN_PA5 // 1 +#define APPLICATION_PIN PIN_PA4 // 0 + +# elif defined(__AVR_ATtiny1604__) // For use with megaTinyCore +#define IR_RECEIVE_PIN PIN_PA6 // 2 - To be compatible with interrupt example, pin 2 is chosen here. +#define IR_SEND_PIN PIN_PA7 // 3 +#define APPLICATION_PIN PIN_PB2 // 5 #define tone(...) void() // Define as void, since TCB0_INT_vect is also used by tone() #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it +#define TONE_PIN 42 // Dummy for examples using it # elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \ || defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \ @@ -139,6 +155,15 @@ # endif # endif // defined(__AVR_ATtiny25__)... +#elif defined(ARDUINO_ARCH_RENESAS_UNO) // Uno R4 +// To be compatible with Uno R3. +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 5 +#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. +#define _IR_TIMING_TEST_PIN 7 + #elif defined(ESP8266) #define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D4) is active LOW #define IR_RECEIVE_PIN 14 // D5 @@ -148,21 +173,32 @@ #define tone(...) void() // tone() inhibits receive timer #define noTone(a) void() -#define TONE_PIN 42 // Dummy for examples using it - -#elif defined(CONFIG_IDF_TARGET_ESP32C3) -#define IR_INPUT_PIN 8 -#define IR_SEND_PIN 9 -#define TONE_PIN 10 // ADC2_0 -#define APPLICATION_PIN 11 +#define TONE_PIN 42 // Dummy for examples using it# + +#elif defined(ARDUINO_NOLOGO_ESP32C3_SUPER_MINI) +#define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board (D8) is active LOW +#define IR_RECEIVE_PIN 2 +#define IR_SEND_PIN 3 +#define TONE_PIN 4 +#define APPLICATION_PIN 10 + +#elif defined(CONFIG_IDF_TARGET_ESP32C3) || defined(ARDUINO_ESP32C3_DEV) +#define NO_LED_FEEDBACK_CODE // The WS2812 on pin 8 of AI-C3 board crashes if used as receive feedback LED, other I/O pins are working... +#define IR_RECEIVE_PIN 6 +#define IR_SEND_PIN 7 +#define TONE_PIN 9 +#define APPLICATION_PIN 10 #elif defined(ESP32) #include // tone() is included in ESP32 core since 2.0.2 -#if !defined(ESP_ARDUINO_VERSION_VAL) -#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) 12345678 -#endif +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif #if ESP_ARDUINO_VERSION <= ESP_ARDUINO_VERSION_VAL(2, 0, 2) #define TONE_LEDC_CHANNEL 1 // Using channel 1 makes tone() independent of receiving timer -> No need to stop receiving timer. void tone(uint8_t aPinNumber, unsigned int aFrequency){ @@ -205,7 +241,8 @@ void noTone(uint8_t aPinNumber){ #define IR_SEND_PIN 12 #define TONE_PIN 5 -#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE +#elif defined(ARDUINO_ARCH_MBED) && defined(ARDUINO_ARCH_MBED_NANO) // Arduino Nano 33 BLE and Arduino Nano Connect layout for MBED +// Must be before ARDUINO_ARCH_RP2040, since it is the layout for the MBED core of Arduino Nano Connect #define IR_RECEIVE_PIN 3 // GPIO15 Start with pin 3 since pin 2|GPIO25 is connected to LED on Pi pico #define IR_SEND_PIN 4 // GPIO16 #define TONE_PIN 5 @@ -252,14 +289,18 @@ void noTone(uint8_t aPinNumber){ #define _IR_TIMING_TEST_PIN 7 #elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM) +# if defined(USE_ARDUINO_MKR_PIN_LAYOUT) +#define IR_RECEIVE_PIN 1 // Pin 2 on MKR is not interrupt capable, see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ +# else #define IR_RECEIVE_PIN 2 +# endif #define IR_SEND_PIN 3 #define TONE_PIN 4 #define APPLICATION_PIN 5 #define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output. #define _IR_TIMING_TEST_PIN 7 -#if !defined(ARDUINO_SAMD_ADAFRUIT) +#if !defined(ARDUINO_SAMD_ADAFRUIT) && !defined(ARDUINO_SEEED_XIAO_M0) // On the Zero and others we switch explicitly to SerialUSB #define Serial SerialUSB #endif @@ -299,19 +340,13 @@ void noTone(uint8_t aPinNumber){ #define SEND_PWM_BY_TIMER // We do not have pin restrictions for this CPU's, so lets use the hardware PWM for send carrier signal generation #else # if defined(SEND_PWM_BY_TIMER) -#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warning in IRTimer.hpp +#undef IR_SEND_PIN // SendPin is determined by timer! This avoids warnings in IRremote.hpp and IRTimer.hpp # endif #endif #if !defined (FLASHEND) #define FLASHEND 0xFFFF // Dummy value for platforms where FLASHEND is not defined #endif -#if !defined (RAMEND) -#define RAMEND 0xFFFF // Dummy value for platforms where RAMEND is not defined -#endif -#if !defined (RAMSIZE) -#define RAMSIZE 0xFFFF // Dummy value for platforms where RAMSIZE is not defined -#endif /* * Helper macro for getting a macro definition as string diff --git a/examples/UnitTest/UnitTest.ino b/examples/UnitTest/UnitTest.ino index b9a88d11b..afdbf4bc7 100644 --- a/examples/UnitTest/UnitTest.ino +++ b/examples/UnitTest/UnitTest.ino @@ -9,7 +9,7 @@ ************************************************************************************ * MIT License * - * Copyright (c) 2020-2023 Armin Joachimsmeyer + * Copyright (c) 2020-2025 Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -36,12 +36,11 @@ #include "PinDefinitionsAndMore.h" // Define macros for input and output pin etc. #if !defined(RAW_BUFFER_LENGTH) -# if RAMEND <= 0x4FF || RAMSIZE < 0x4FF -//#define RAW_BUFFER_LENGTH 180 // 750 (600 if we have only 2k RAM) is the value for air condition remotes. Default is 112 if DECODE_MAGIQUEST is enabled, otherwise 100. -# elif RAMEND <= 0x8FF || RAMSIZE < 0x8FF -#define RAW_BUFFER_LENGTH 150 // 750 (600 if we have only 2k RAM) is the value for air condition remotes. Default is 112 if DECODE_MAGIQUEST is enabled, otherwise 100. -# else -#define RAW_BUFFER_LENGTH 200 // 750 (600 if we have only 2k RAM) is the value for air condition remotes. Default is 112 if DECODE_MAGIQUEST is enabled, otherwise 100. +// For air condition remotes it requires 600 (maximum for 2k RAM) to 750. Default is 112 if DECODE_MAGIQUEST is enabled, otherwise 100. +# if (defined(RAMEND) && RAMEND <= 0x4FF) || (defined(RAMSIZE) && RAMSIZE < 0x4FF) +#define RAW_BUFFER_LENGTH 360 +# elif (defined(RAMEND) && RAMEND <= 0x8FF) || (defined(RAMSIZE) && RAMSIZE < 0x8FF) +#define RAW_BUFFER_LENGTH 400 // 400 is OK with Pronto and 1000 is OK without Pronto. 1200 is too much here, because then variables are overwritten. # endif #endif @@ -49,12 +48,16 @@ //#define EXCLUDE_EXOTIC_PROTOCOLS // Saves around 240 bytes program memory if IrSender.write is used //#define SEND_PWM_BY_TIMER // Disable carrier PWM generation in software and use (restricted) hardware PWM. //#define USE_NO_SEND_PWM // Use no carrier PWM, just simulate an active low receiver signal. Overrides SEND_PWM_BY_TIMER definition +#if FLASHEND <= 0x7FFF // For 32k flash or less, like ATmega328 #define NO_LED_FEEDBACK_CODE // Saves 344 bytes program memory +#endif // MARK_EXCESS_MICROS is subtracted from all marks and added to all spaces before decoding, //#define USE_MSB_DECODING_FOR_DISTANCE_DECODER // to compensate for the signal forming of different IR receiver modules. See also IRremote.hpp line 142. //#define MARK_EXCESS_MICROS 20 // Adapt it to your IR receiver module. 40 is taken for the cheap VS1838 module her, since we have high intensity. +//#define RECORD_GAP_MICROS 12000 // Default is 8000. Activate it for some LG air conditioner protocols. + //#define TRACE // For internal usage //#define DEBUG // Activate this for lots of lovely debug output from the decoders. @@ -80,19 +83,21 @@ #define DECODE_LG #define DECODE_BEO // It prevents decoding of SONY (default repeats), which we are not using here. -//#define ENABLE_BEO_WITHOUT_FRAME_GAP // For successful unit testing we must see the warning at ir_BangOlufsen.hpp:88:2 +//#define ENABLE_BEO_WITHOUT_FRAME_GAP // !!!For successful unit testing we must see the warning at ir_BangOlufsen.hpp:100:2!!! #if defined(DECODE_BEO) -#define RECORD_GAP_MICROS 16000 // always get the complete frame in the receive buffer +#define RECORD_GAP_MICROS 16000 // Force to get the complete frame including the 3. space of 15 ms in the receive buffer #define BEO_KHZ 38 // We send and receive Bang&Olufsen with 38 kHz here (instead of 455 kHz). #endif #define DECODE_BOSEWAVE -//#define DECODE_LEGO_PF #define DECODE_MAGIQUEST -//#define DECODE_WHYNTER #define DECODE_FAST + +//#define DECODE_WHYNTER +//#define DECODE_LEGO_PF #endif +//#undef IR_SEND_PIN // enable this, if you need to set send pin programmatically using uint8_t tSendPin below #include #if defined(APPLICATION_PIN) @@ -114,12 +119,23 @@ volatile bool sDataJustReceived = false; void ReceiveCompleteCallbackHandler(); +#if __INT_WIDTH__ < 32 +IRRawDataType const tRawDataPGM[4] PROGMEM = { 0xB02002, 0xA010, 0x0, 0x0 }; // LSB of tRawData[0] is sent first +#endif + void setup() { pinMode(DEBUG_BUTTON_PIN, INPUT_PULLUP); Serial.begin(115200); -#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/|| defined(SERIALUSB_PID) || defined(ARDUINO_attiny3217) - delay(4000); // To be able to connect Serial monitor after reset or power up and before first print out. Do not wait for an attached Serial Monitor! + +#if defined(__AVR_ATmega32U4__) || defined(SERIAL_PORT_USBVIRTUAL) || defined(SERIAL_USB) /*stm32duino*/|| defined(USBCON) /*STM32_stm32*/ \ + || defined(SERIALUSB_PID) || defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_attiny3217) + // Wait until Serial Monitor is attached. + // Required for boards using USB code for Serial like Leonardo. + // Is void for USB Serial implementations using external chips e.g. a CH340. + while (!Serial) + ; + // !!! Program will not proceed if no Serial Monitor is attached !!! #endif // Just to know which program is running on my Arduino Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE)); @@ -136,16 +152,32 @@ void setup() { Serial.println(F("at pin " STR(IR_RECEIVE_PIN))); #endif +#if defined(LED_BUILTIN) && !defined(NO_LED_FEEDBACK_CODE) +# if defined(FEEDBACK_LED_IS_ACTIVE_LOW) + Serial.print(F("Active low ")); +# endif + Serial.print(F("FeedbackLED at pin ")); + Serial.println(LED_BUILTIN); // Works also for ESP32: static const uint8_t LED_BUILTIN = 8; #define LED_BUILTIN LED_BUILTIN +#endif + + Serial.println(F("Use ReceiveCompleteCallback")); + Serial.println(F("Receive buffer length is " STR(RAW_BUFFER_LENGTH))); + #if defined(IR_SEND_PIN) - IrSender.begin(); // Start with IR_SEND_PIN as send pin and enable feedback LED at default feedback LED pin + IrSender.begin(); // Start with IR_SEND_PIN -which is defined in PinDefinitionsAndMore.h- as send pin and enable feedback LED at default feedback LED pin # if defined(IR_SEND_PIN_STRING) - Serial.println(F("at pin " IR_SEND_PIN_STRING)); + Serial.println(F("Send IR signals at pin " IR_SEND_PIN_STRING)); # else Serial.println(F("Send IR signals at pin " STR(IR_SEND_PIN))); # endif #else - IrSender.begin(3, ENABLE_LED_FEEDBACK, USE_DEFAULT_FEEDBACK_LED_PIN); // Specify send pin and enable feedback LED at default feedback LED pin - Serial.println(F("Send IR signals at pin 3")); + // Here the macro IR_SEND_PIN is not defined or undefined above with #undef IR_SEND_PIN + uint8_t tSendPin = 3; + IrSender.begin(tSendPin, ENABLE_LED_FEEDBACK, USE_DEFAULT_FEEDBACK_LED_PIN);// Specify send pin and enable feedback LED at default feedback LED pin + // You can change send pin later with IrSender.setSendPin(); + + Serial.print(F("Send IR signals at pin ")); + Serial.println(tSendPin); #endif #if FLASHEND >= 0x3FFF // For 16k flash or more, like ATtiny1604 @@ -273,7 +305,7 @@ void checkReceivedArray(IRRawDataType *aRawDataArrayPointer, uint8_t aArraySize) /* * Test callback function - * Has the same functionality as available() + * Has the same functionality as a check with available() */ void ReceiveCompleteCallbackHandler() { sDataJustReceived = true; @@ -281,8 +313,15 @@ void ReceiveCompleteCallbackHandler() { void checkReceive(uint16_t aSentAddress, uint16_t aSentCommand) { // wait until signal has received + uint16_t tTimeoutCounter = 1000; // gives 10 seconds timeout while (!sDataJustReceived) { - }; + delay(10); + if (tTimeoutCounter == 0) { + Serial.println(F("Receive timeout happened")); + break; + } + tTimeoutCounter--; + } sDataJustReceived = false; if (IrReceiver.decode()) { @@ -305,6 +344,8 @@ void checkReceive(uint16_t aSentAddress, uint16_t aSentCommand) { IrReceiver.printIRResultRawFormatted(&Serial, true); } #endif + IrReceiver.resume(); // Early resume + if (IrReceiver.decodedIRData.protocol == UNKNOWN) { Serial.println(F("ERROR: Unknown protocol")); } else { @@ -328,9 +369,9 @@ void checkReceive(uint16_t aSentAddress, uint16_t aSentCommand) { } } - IrReceiver.resume(); } else { Serial.println(F("No data received")); + IrReceiver.resume(); } Serial.println(); } @@ -344,7 +385,7 @@ void checkReceive(uint16_t aSentAddress, uint16_t aSentCommand) { uint16_t sAddress = 0xFFF1; uint8_t sCommand = 0x76; uint16_t s16BitCommand = 0x9876; -#define sRepeats 0 // no unit test for repeats +uint8_t sRepeats = 0; void loop() { /* @@ -358,33 +399,53 @@ void loop() { Serial.println(); Serial.println(); - Serial.println(F("Send NEC with 8 bit address")); + Serial.print(F("Send NEC with 8 bit address")); + if (sRepeats > 0) { + Serial.print(F(" and complete NEC frames as repeats to force decoding as NEC2")); + } + Serial.println(); Serial.flush(); - IrSender.sendNEC(sAddress & 0xFF, sCommand, sRepeats); + IrSender.sendNEC(sAddress & 0xFF, sCommand, 0); checkReceive(sAddress & 0xFF, sCommand); + + /* + * Complete NEC frames as repeats to force decoding as NEC2 are tested here + */ + for (int8_t i = 0; i < sRepeats; i++) { + if (digitalRead(DEBUG_BUTTON_PIN) != LOW) { + // If debug is enabled, printing time (50 ms) is sufficient as delay + delayMicroseconds(NEC_REPEAT_DISTANCE - 20000); // 20000 is just a guess + } + IrSender.sendNEC(sAddress & 0xFF, sCommand, 0); + checkReceive(sAddress & 0xFF, sCommand); + } + delay(DELAY_AFTER_SEND); // delay must be greater than 5 ms (RECORD_GAP_MICROS), otherwise the receiver sees it as one long signal Serial.println(F("Send NEC with 16 bit address")); Serial.flush(); - IrSender.sendNEC(sAddress, sCommand, sRepeats); + IrSender.sendNEC(sAddress, sCommand, 0); checkReceive(sAddress, sCommand); delay(DELAY_AFTER_SEND); Serial.println(F("Send NEC2 with 16 bit address")); Serial.flush(); - IrSender.sendNEC2(sAddress, sCommand, sRepeats); + IrSender.sendNEC2(sAddress, sCommand, 0); checkReceive(sAddress, sCommand); delay(DELAY_AFTER_SEND); #if FLASHEND >= 0x3FFF // For 16k flash or more, like ATtiny1604. Code does not fit in program memory of ATtiny85 etc. if (sAddress == 0xFFF1) { -# if FLASHEND >= 0x7FFF // For 32k flash or more, like UNO. Code does not fit in program memory of ATtiny1604 etc. +# if FLASHEND >= 0x7FFF && ((!defined(RAMEND) && !defined(RAMSIZE)) || (defined(RAMEND) && RAMEND > 0x6FF) || (defined(RAMSIZE) && RAMSIZE > 0x6FF)) // For 32k flash or more, like Uno. Code does not fit in program memory of ATtiny1604 etc. + IRRawDataType tRawData[4]; + /* * Send constant values only once in this demo */ Serial.println(F("Send NEC Pronto data with 8 bit address 0x80 and command 0x45 and no repeats")); Serial.flush(); + // This is copied to stack/ram internally IrSender.sendPronto(F("0000 006D 0022 0000 015E 00AB " /* Pronto header + start bit */ "0017 0015 0017 0015 0017 0017 0015 0017 0017 0015 0017 0015 0017 0015 0017 003F " /* Lower address byte */ "0017 003F 0017 003E 0017 003F 0015 003F 0017 003E 0017 003F 0017 003E 0017 0015 " /* Upper address byte (inverted at 8 bit mode) */ @@ -412,13 +473,14 @@ void loop() { */ Serial.println(F("Send ONKYO with 16 bit address 0x0102 and 16 bit command 0x0304 with NECRaw(0x03040102)")); Serial.flush(); - IrSender.sendNECRaw(0x03040102, sRepeats); + IrSender.sendNECRaw(0x03040102, 0); checkReceive(0x0102, 0x304); delay(DELAY_AFTER_SEND); /* * With Send sendNECMSB() you can send your old 32 bit codes. * To convert one into the other, you must reverse the byte positions and then reverse all positions of each byte. + * Use bitreverse32Bit(). * Example: * 0xCB340102 byte reverse -> 0x020134CB bit reverse-> 40802CD3 */ @@ -427,134 +489,165 @@ void loop() { IrSender.sendNECMSB(0x40802CD3, 32, false); checkReceive(0x0102, 0x34); delay(DELAY_AFTER_SEND); -# endif -# if defined(DECODE_PANASONIC) || defined(DECODE_KASEIKYO) - Serial.println(F("Send Panasonic 0xB, 0x10 as 48 bit generic PulseDistance using ProtocolConstants")); +# if defined(DECODE_PANASONIC) || defined(DECODE_KASEIKYO) + Serial.println(F("Send Panasonic 0xB, 0x10 as 48 bit PulseDistance using ProtocolConstants")); Serial.flush(); -# if __INT_WIDTH__ < 32 - IRRawDataType tRawData[] = { 0xB02002, 0xA010, 0x0 }; // LSB of tRawData[0] is sent first - IrSender.sendPulseDistanceWidthFromArray(&KaseikyoProtocolConstants, &tRawData[0], 48, NO_REPEATS); // Panasonic is a Kaseikyo variant +# if __INT_WIDTH__ < 32 + IrSender.sendPulseDistanceWidthFromPGMArray_P(&KaseikyoProtocolConstants, &tRawDataPGM[0], 48, NO_REPEATS); // Panasonic is a Kaseikyo variant checkReceive(0x0B, 0x10); -# else - IrSender.sendPulseDistanceWidth(&KaseikyoProtocolConstants, 0xA010B02002, 48, NO_REPEATS); // Panasonic is a Kaseikyo variant +# else + IrSender.sendPulseDistanceWidth_P(&KaseikyoProtocolConstants, 0xA010B02002, 48, NO_REPEATS); // Panasonic is a Kaseikyo variant checkReceivedRawData(0xA010B02002); -# endif +# endif delay(DELAY_AFTER_SEND); /* - * Send 2 Panasonic 48 bit codes as generic Pulse Distance data, once with LSB and once with MSB first + * Send 2 Panasonic 48 bit codes as Pulse Distance data, once with LSB and once with MSB first */ - Serial.println(F("Send Panasonic 0xB, 0x10 as generic 48 bit PulseDistance")); - Serial.println(F(" LSB first")); + Serial.println(F("Send Panasonic 0xB, 0x10 as 48 bit PulseDistance")); + Serial.println(F("-LSB first")); Serial.flush(); -# if __INT_WIDTH__ < 32 - IrSender.sendPulseDistanceWidthFromArray(38, 3450, 1700, 450, 1250, 450, 400, &tRawData[0], 48, PROTOCOL_IS_LSB_FIRST, 0, - NO_REPEATS); +# if __INT_WIDTH__ < 32 + IrSender.sendPulseDistanceWidthFromPGMArray(38, 3450, 1700, 450, 1250, 450, 400, &tRawDataPGM[0], 48, PROTOCOL_IS_LSB_FIRST, + 0, NO_REPEATS); checkReceive(0x0B, 0x10); -# else - IrSender.sendPulseDistanceWidth(38, 3450, 1700, 450, 1250, 450, 400, 0xA010B02002, 48, PROTOCOL_IS_LSB_FIRST, - 0, NO_REPEATS); +# else + IrSender.sendPulseDistanceWidth(38, 3450, 1700, 450, 1250, 450, 400, 0xA010B02002, 48, PROTOCOL_IS_LSB_FIRST, 0, + NO_REPEATS); checkReceivedRawData(0xA010B02002); -# endif +# endif delay(DELAY_AFTER_SEND); // The same with MSB first. Use bit reversed raw data of LSB first part - Serial.println(F(" MSB first")); -# if __INT_WIDTH__ < 32 + Serial.println(F("-MSB first")); +# if __INT_WIDTH__ < 32 tRawData[0] = 0x40040D00; // MSB of tRawData[0] is sent first tRawData[1] = 0x805; IrSender.sendPulseDistanceWidthFromArray(38, 3450, 1700, 450, 1250, 450, 400, &tRawData[0], 48, PROTOCOL_IS_MSB_FIRST, 0, NO_REPEATS); checkReceive(0x0B, 0x10); -# else - IrSender.sendPulseDistanceWidth(38, 3450, 1700, 450, 1250, 450, 400, 0x40040D000805, 48, PROTOCOL_IS_MSB_FIRST, 0, NO_REPEATS); +# else + IrSender.sendPulseDistanceWidth(38, 3450, 1700, 450, 1250, 450, 400, 0x40040D000805, 48, PROTOCOL_IS_MSB_FIRST, 0, + NO_REPEATS); checkReceivedRawData(0x40040D000805); -# endif +# endif delay(DELAY_AFTER_SEND); -# endif // defined(DECODE_PANASONIC) || defined(DECODE_KASEIKYO) +# endif // defined(DECODE_PANASONIC) || defined(DECODE_KASEIKYO) -# if defined(DECODE_DISTANCE_WIDTH) -# if defined(USE_MSB_DECODING_FOR_DISTANCE_DECODER) - Serial.println(F("Send generic 52 bit PulseDistance 0x43D8613C and 0x3BC3B MSB first")); +# if defined(DECODE_DISTANCE_WIDTH) +# if defined(USE_MSB_DECODING_FOR_DISTANCE_DECODER) + Serial.println(F("Send 52 bit PulseDistance 0x43D8613C and 0x3BC3B MSB first")); Serial.flush(); -# if __INT_WIDTH__ < 32 +# if __INT_WIDTH__ < 32 tRawData[0] = 0x43D8613C; // MSB of tRawData[0] is sent first tRawData[1] = 0x3BC3B; IrSender.sendPulseDistanceWidthFromArray(38, 8900, 4450, 550, 1700, 550, 600, &tRawData[0], 52, PROTOCOL_IS_MSB_FIRST, 0, - NO_REPEATS); + NO_REPEATS); checkReceivedArray(tRawData, 2); -# else +# else IrSender.sendPulseDistanceWidth(38, 8900, 4450, 550, 1700, 550, 600, 0x43D8613CBC3B, 52, PROTOCOL_IS_MSB_FIRST, 0, NO_REPEATS); checkReceivedRawData(0x43D8613CBC3B); -# endif +# endif delay(DELAY_AFTER_SEND); - Serial.println(F("Send generic 52 bit PulseDistanceWidth 0x43D8613C and 0x3BC3B MSB first")); + Serial.println(F("Send 52 bit PulseDistanceWidth 0x43D8613C and 0x3BC3B MSB first")); Serial.flush(); // Real PulseDistanceWidth (constant bit length) does not require a stop bit -# if __INT_WIDTH__ < 32 +# if __INT_WIDTH__ < 32 IrSender.sendPulseDistanceWidthFromArray(38, 300, 600, 600, 300, 300, 600, &tRawData[0], 52, PROTOCOL_IS_MSB_FIRST, 0, 0); checkReceivedArray(tRawData, 2); -# else +# else IrSender.sendPulseDistanceWidth(38, 300, 600, 600, 300, 300, 600, 0x123456789ABC, 52, PROTOCOL_IS_MSB_FIRST, 0, 0); checkReceivedRawData(0x123456789ABC); -# endif +# endif delay(DELAY_AFTER_SEND); - Serial.println(F("Send generic 32 bit PulseWidth 0x43D8613C MSB first")); + Serial.println(F("Send 32 bit PulseWidth 0x43D8613C MSB first")); Serial.flush(); // Real PulseDistanceWidth (constant bit length) does not require a stop bit IrSender.sendPulseDistanceWidth(38, 1000, 500, 600, 300, 300, 300, 0x43D8613C, 32, PROTOCOL_IS_MSB_FIRST, 0, 0); checkReceivedRawData(0x43D8613C); delay(DELAY_AFTER_SEND); -# else // defined(USE_MSB_DECODING_FOR_DISTANCE_DECODER) - Serial.println(F("Send generic 72 bit PulseDistance 0x5A AFEDCBA9 87654321 LSB first")); +# else // defined(USE_MSB_DECODING_FOR_DISTANCE_DECODER) + Serial.println(F("Send 72 bit PulseDistance 0x5A AFEDCBA9 87654321 LSB first")); Serial.flush(); -# if __INT_WIDTH__ < 32 +# if __INT_WIDTH__ < 32 tRawData[0] = 0x87654321; // LSB of tRawData[0] is sent first tRawData[1] = 0xAFEDCBA9; tRawData[2] = 0x5A; IrSender.sendPulseDistanceWidthFromArray(38, 8900, 4450, 550, 1700, 550, 600, &tRawData[0], 72, PROTOCOL_IS_LSB_FIRST, 0, NO_REPEATS); checkReceivedArray(tRawData, 3); -# else - IRRawDataType tRawData[] = { 0xAFEDCBA987654321, 0x5A }; // LSB of tRawData[0] is sent first - IrSender.sendPulseDistanceWidthFromArray(38, 8900, 4450, 550, 1700, 550, 600, &tRawData[0], 72, PROTOCOL_IS_LSB_FIRST, 0, NO_REPEATS); +# else + tRawData[0] = 0xAFEDCBA987654321; + tRawData[1] = 0x5A; // LSB of tRawData[0] is sent first + IrSender.sendPulseDistanceWidthFromArray(38, 8900, 4450, 550, 1700, 550, 600, &tRawData[0], 72, PROTOCOL_IS_LSB_FIRST, 0, + NO_REPEATS); checkReceivedArray(tRawData, 2); -# endif +# endif delay(DELAY_AFTER_SEND); - Serial.println(F("Send generic 52 bit PulseDistanceWidth 0xDCBA9 87654321 LSB first")); + Serial.println(F("Send 52 bit PulseDistanceWidth 0xDCBA9 87654321 LSB first")); Serial.flush(); - // Real PulseDistanceWidth (constant bit length) does not require a stop bit -# if __INT_WIDTH__ < 32 + // Real PulseDistanceWidth (constant bit length) does theoretically not require a stop bit, but we know the stop bit from serial transmission +# if __INT_WIDTH__ < 32 tRawData[1] = 0xDCBA9; - IrSender.sendPulseDistanceWidthFromArray(38, 300, 600, 600, 300, 300, 600, &tRawData[0], 52, PROTOCOL_IS_LSB_FIRST, 0, 0); + IrSender.sendPulseDistanceWidthFromArray(38, 300, 600, 300, 600, 600, 300, &tRawData[0], 52, PROTOCOL_IS_LSB_FIRST, 0, 0); checkReceivedArray(tRawData, 2); -# else - IrSender.sendPulseDistanceWidth(38, 300, 600, 600, 300, 300, 600, 0xDCBA987654321, 52, PROTOCOL_IS_LSB_FIRST, 0, 0); +# else + IrSender.sendPulseDistanceWidth(38, 300, 600, 300, 600, 600, 300, 0xDCBA987654321, 52, PROTOCOL_IS_LSB_FIRST, 0, 0); checkReceivedRawData(0xDCBA987654321); -# endif +# endif delay(DELAY_AFTER_SEND); - Serial.println(F("Send generic 32 bit PulseWidth 0x87654321 LSB first")); + Serial.println(F("Send 52 bit PulseDistanceWidth 0xDCBA9 87654321 LSB first with inverse timing and data")); + Serial.flush(); +# if __INT_WIDTH__ < 32 + tRawData[2] = ~tRawData[0]; + tRawData[3] = ~tRawData[1]; + IrSender.sendPulseDistanceWidthFromArray(38, 300, 600, 600, 300, 300, 600, &tRawData[2], 52, PROTOCOL_IS_LSB_FIRST, 0, 0); + checkReceivedArray(tRawData, 2); +# else + IrSender.sendPulseDistanceWidth(38, 300, 600, 600, 300, 300, 600, ~0xDCBA987654321, 52, PROTOCOL_IS_LSB_FIRST, 0, 0); + checkReceivedRawData(0xDCBA987654321); +# endif + delay(DELAY_AFTER_SEND); + + Serial.println(F("Send 7 bit ASCII character with PulseDistanceWidth LSB first")); + Serial.flush(); + // Real PulseDistanceWidth (constant bit length) does theoretically not require a stop bit, but we know the stop bit from serial transmission + IrSender.sendPulseDistanceWidth(38, 6000, 500, 500, 1500, 1500, 500, sCommand, 7, PROTOCOL_IS_LSB_FIRST, 0, 0); + checkReceivedRawData(sCommand); + delay(DELAY_AFTER_SEND); + + Serial.println(F("Send Sony12 as PulseWidth LSB first")); + Serial.flush(); + uint32_t tData = (uint32_t) sAddress << 7 | (sCommand & 0x7F); + IrSender.sendPulseDistanceWidth(38, 2400, 600, 1200, 600, 600, 600, tData, SIRCS_12_PROTOCOL, PROTOCOL_IS_LSB_FIRST, 0, 0); + checkReceive(sAddress & 0x1F, sCommand & 0x7F); + delay(DELAY_AFTER_SEND); + + Serial.println(F("Send 32 bit PulseWidth 0x87654321 LSB first")); Serial.flush(); - // Real PulseDistanceWidth (constant bit length) does not require a stop bit IrSender.sendPulseDistanceWidth(38, 1000, 500, 600, 300, 300, 300, 0x87654321, 32, PROTOCOL_IS_LSB_FIRST, 0, 0); checkReceivedRawData(0x87654321); delay(DELAY_AFTER_SEND); -# endif // defined(USE_MSB_DECODING_FOR_DISTANCE_DECODER) -# endif // defined(DECODE_DISTANCE_WIDTH) + +# endif // defined(USE_MSB_DECODING_FOR_DISTANCE_DECODER) +# endif // defined(DECODE_DISTANCE_WIDTH) +# endif // if FLASHEND >= 0x7FFF ... # if defined(DECODE_MAGIQUEST) - Serial.println(F("Send MagiQuest 0x6BCDFF00, 0x176 as generic 55 bit PulseDistanceWidth MSB first")); + Serial.println(F("Send MagiQuest 0x6BCDFF00, 0x176 as 55 bit PulseDistanceWidth MSB first")); Serial.flush(); # if __INT_WIDTH__ < 32 - tRawData[0] = 0x01AF37FC; // We have 1 header (start) bit and 7 start bits and 31 address bits for MagiQuest, so 0x6BCDFF00 is shifted 2 left - tRawData[1] = 0x017619; // We send only 23 instead of 24 bite here! 19 is the checksum - IrSender.sendPulseDistanceWidthFromArray(38, 287, 864, 576, 576, 287, 864, &tRawData[0], 55, PROTOCOL_IS_MSB_FIRST, 0, 0); + IRRawDataType tRawData1[2]; + tRawData1[0] = 0x01AF37FC; // We have 1 header (start) bit and 7 start bits and 31 address bits for MagiQuest, so 0x6BCDFF00 is shifted 2 left + tRawData1[1] = 0x017619; // We send only 23 bits here! 0x19 is the checksum + IrSender.sendPulseDistanceWidthFromArray(38, 287, 864, 576, 576, 287, 864, &tRawData1[0], 55, + PROTOCOL_IS_MSB_FIRST | SUPPRESS_STOP_BIT, 0, 0); # else // 0xD79BFE00 is 0x6BCDFF00 is shifted 1 left IrSender.sendPulseDistanceWidth(38, 287, 864, 576, 576, 287, 864, 0xD79BFE017619, 55, PROTOCOL_IS_MSB_FIRST, 0, 0); @@ -578,32 +671,32 @@ void loop() { Serial.println(F("Send Onkyo (NEC with 16 bit command)")); Serial.flush(); - IrSender.sendOnkyo(sAddress, (sCommand + 1) << 8 | sCommand, sRepeats); + IrSender.sendOnkyo(sAddress, (sCommand + 1) << 8 | sCommand, 0); checkReceive(sAddress, (sCommand + 1) << 8 | sCommand); delay(DELAY_AFTER_SEND); Serial.println(F("Send Apple")); Serial.flush(); - IrSender.sendApple(sAddress & 0xFF, sCommand, sRepeats); + IrSender.sendApple(sAddress & 0xFF, sCommand, 0); checkReceive(sAddress & 0xFF, sCommand); delay(DELAY_AFTER_SEND); #if defined(DECODE_PANASONIC) || defined(DECODE_KASEIKYO) Serial.println(F("Send Panasonic")); Serial.flush(); - IrSender.sendPanasonic(sAddress & 0xFFF, sCommand, sRepeats); + IrSender.sendPanasonic(sAddress & 0xFFF, sCommand, 0); checkReceive(sAddress & 0xFFF, sCommand); delay(DELAY_AFTER_SEND); Serial.println(F("Send Kaseikyo with 0x4711 as Vendor ID")); Serial.flush(); - IrSender.sendKaseikyo(sAddress & 0xFFF, sCommand, sRepeats, 0x4711); + IrSender.sendKaseikyo(sAddress & 0xFFF, sCommand, 0, 0x4711); checkReceive(sAddress & 0xFFF, sCommand); delay(DELAY_AFTER_SEND); Serial.println(F("Send Kaseikyo_Denon variant")); Serial.flush(); - IrSender.sendKaseikyo_Denon(sAddress & 0xFFF, sCommand, sRepeats); + IrSender.sendKaseikyo_Denon(sAddress & 0xFFF, sCommand, 0); checkReceive(sAddress & 0xFFF, sCommand); delay(DELAY_AFTER_SEND); #endif @@ -611,13 +704,13 @@ void loop() { #if defined(DECODE_DENON) Serial.println(F("Send Denon")); Serial.flush(); - IrSender.sendDenon(sAddress & 0x1F, sCommand, sRepeats); + IrSender.sendDenon(sAddress & 0x1F, sCommand, 0); checkReceive(sAddress & 0x1F, sCommand); delay(DELAY_AFTER_SEND); Serial.println(F("Send Denon/Sharp variant")); Serial.flush(); - IrSender.sendSharp(sAddress & 0x1F, sCommand, sRepeats); + IrSender.sendSharp(sAddress & 0x1F, sCommand, 0); checkReceive(sAddress & 0x1F, sCommand); delay(DELAY_AFTER_SEND); #endif @@ -625,39 +718,39 @@ void loop() { #if defined(DECODE_SONY) Serial.println(F("Send Sony/SIRCS with 7 command and 5 address bits")); Serial.flush(); - IrSender.sendSony(sAddress & 0x1F, sCommand, sRepeats); + IrSender.sendSony(sAddress & 0x1F, sCommand, 0); // SIRCS_12_PROTOCOL is default checkReceive(sAddress & 0x1F, sCommand & 0x7F); delay(DELAY_AFTER_SEND); Serial.println(F("Send Sony/SIRCS with 7 command and 8 address bits")); Serial.flush(); - IrSender.sendSony(sAddress & 0xFF, sCommand, sRepeats, SIRCS_15_PROTOCOL); + IrSender.sendSony(sAddress & 0xFF, sCommand, 0, SIRCS_15_PROTOCOL); checkReceive(sAddress & 0xFF, sCommand & 0x7F); delay(DELAY_AFTER_SEND); Serial.println(F("Send Sony/SIRCS with 7 command and 13 address bits")); Serial.flush(); - IrSender.sendSony(sAddress & 0x1FFF, sCommand, sRepeats, SIRCS_20_PROTOCOL); + IrSender.sendSony(sAddress & 0x1FFF, sCommand, 0, SIRCS_20_PROTOCOL); checkReceive(sAddress & 0x1FFF, sCommand & 0x7F); delay(DELAY_AFTER_SEND); #endif #if defined(DECODE_SAMSUNG) - Serial.println(F("Send Samsung 8 bit command")); + Serial.println(F("Send Samsung 8 bit command and 8 bit address")); Serial.flush(); - IrSender.sendSamsung(sAddress, sCommand, sRepeats); - checkReceive(sAddress, sCommand); + IrSender.sendSamsung(sAddress & 0xFF, sCommand, 0); + checkReceive(sAddress & 0xFF, sCommand); delay(DELAY_AFTER_SEND); - Serial.println(F("Send Samsung 16 bit command")); + Serial.println(F("Send Samsung 16 bit command and address")); Serial.flush(); - IrSender.sendSamsung(sAddress, s16BitCommand, sRepeats); + IrSender.sendSamsung16BitAddressAndCommand(sAddress, s16BitCommand, 0); checkReceive(sAddress, s16BitCommand); delay(DELAY_AFTER_SEND); Serial.println(F("Send Samsung48 16 bit command")); Serial.flush(); - IrSender.sendSamsung48(sAddress, s16BitCommand, sRepeats); + IrSender.sendSamsung48(sAddress, s16BitCommand, 0); checkReceive(sAddress, s16BitCommand); delay(DELAY_AFTER_SEND); #endif @@ -665,26 +758,73 @@ void loop() { #if defined(DECODE_RC5) Serial.println(F("Send RC5")); Serial.flush(); - IrSender.sendRC5(sAddress & 0x1F, sCommand & 0x3F, sRepeats, true); // 5 address, 6 command bits + IrSender.sendRC5(sAddress & 0x1F, sCommand & 0x3F, 0, true); // 5 address, 6 command bits checkReceive(sAddress & 0x1F, sCommand & 0x3F); delay(DELAY_AFTER_SEND); Serial.println(F("Send RC5X with 7.th MSB of command set")); Serial.flush(); - IrSender.sendRC5(sAddress & 0x1F, (sCommand & 0x3F) + 0x40, sRepeats, true); // 5 address, 7 command bits + IrSender.sendRC5(sAddress & 0x1F, (sCommand & 0x3F) + 0x40, 0, true); // 5 address, 7 command bits checkReceive(sAddress & 0x1F, (sCommand & 0x3F) + 0x40); delay(DELAY_AFTER_SEND); #endif #if defined(DECODE_RC6) Serial.println(F("Send RC6")); - // RC6 check does not work stable without the flush Serial.flush(); - IrSender.sendRC6(sAddress & 0xFF, sCommand, sRepeats, true); + sLastSendToggleValue = sAddress & 0x01; // to modify toggling at each loop + + IrSender.sendRC6(sAddress & 0xFF, sCommand, 0, true); + checkReceive(sAddress & 0xFF, sCommand); + delay(DELAY_AFTER_SEND); + + Serial.println(F("Send RC6A with 14 bit 0x2711 as extra")); + Serial.flush(); + IrSender.sendRC6A(sAddress & 0xFF, sCommand, 0, 0x2711, true); checkReceive(sAddress & 0xFF, sCommand); delay(DELAY_AFTER_SEND); #endif +#if defined(DECODE_BEO) + Serial.println(F("Send Bang&Olufsen")); + Serial.flush(); + IrSender.sendBangOlufsen(sAddress & 0x0FF, sCommand, 0); +# if defined(ENABLE_BEO_WITHOUT_FRAME_GAP) + delay((RECORD_GAP_MICROS / 1000) + 1); + Serial.println(F("- ENABLE_BEO_WITHOUT_FRAME_GAP is enabled")); + Serial.println(F("- Now print raw data and try to decode the first 6 entries, which results in rawData 0x0")); + IrReceiver.printIRResultRawFormatted(&Serial, true); + uint8_t tOriginalRawlen = IrReceiver.decodedIRData.rawDataPtr->rawlen; + IrReceiver.decodedIRData.rawDataPtr->rawlen = 6; + /* + * decode first part / AGC part of frame + */ + IrReceiver.decode(); // sets IrReceiver.decodedIRData.rawlen to 6 + IrReceiver.printIRResultShort(&Serial); // -> Protocol=Bang&Olufsen Address=0x0 Command=0x0 Raw-Data=0x0 0 bits MSB first + + // Remove trailing 6 entries for second decode try + Serial.println(); + Serial.println( + F( + "- Remove trailing 6 entries, which is equivalent to define RECORD_GAP_MICROS < 15000, to enable successful B&O decode")); + IrReceiver.decodedIRData.rawlen = tOriginalRawlen - 6; + IrReceiver.decodedIRData.rawDataPtr->rawlen = tOriginalRawlen - 6; + for (uint_fast8_t i = 0; i < IrReceiver.decodedIRData.rawlen; ++i) { + IrReceiver.decodedIRData.rawDataPtr->rawbuf[i] = IrReceiver.decodedIRData.rawDataPtr->rawbuf[i + 6]; + } +# endif + checkReceive(sAddress & 0x0FF, sCommand); + delay(DELAY_AFTER_SEND); +#endif + +#if defined(DECODE_MAGIQUEST) + Serial.println(F("Send MagiQuest")); + Serial.flush(); + IrSender.sendMagiQuest(0x6BCD0000 | (uint32_t) sAddress, s16BitCommand); // we have 31 bit address + checkReceive(sAddress, s16BitCommand & 0x1FF); // we have 9 bit command + delay(DELAY_AFTER_SEND); +#endif + /* * Next example how to use the IrSender.write function */ @@ -694,12 +834,16 @@ void loop() { IRSendData.command = sCommand; IRSendData.flags = IRDATA_FLAGS_EMPTY; + Serial.println(F("Send next protocols with IrSender.write")); + Serial.println(); + Serial.flush(); + #if defined(DECODE_JVC) IRSendData.protocol = JVC; // switch protocol Serial.print(F("Send ")); Serial.println(getProtocolString(IRSendData.protocol)); Serial.flush(); - IrSender.write(&IRSendData, sRepeats); + IrSender.write(&IRSendData, 0); checkReceive(IRSendData.address & 0xFF, IRSendData.command); delay(DELAY_AFTER_SEND); #endif @@ -708,62 +852,21 @@ void loop() { IRSendData.command = s16BitCommand; // LG support more than 8 bit command #endif -#if defined(DECODE_SAMSUNG) - IRSendData.protocol = SAMSUNG; - Serial.print(F("Send ")); - Serial.println(getProtocolString(IRSendData.protocol)); - Serial.flush(); - IrSender.write(&IRSendData, sRepeats); - checkReceive(IRSendData.address, IRSendData.command); - delay(DELAY_AFTER_SEND); -#endif - #if defined(DECODE_LG) IRSendData.protocol = LG; Serial.print(F("Send ")); Serial.println(getProtocolString(IRSendData.protocol)); Serial.flush(); - IrSender.write(&IRSendData, sRepeats); + IrSender.write(&IRSendData, 0); checkReceive(IRSendData.address & 0xFF, IRSendData.command); delay(DELAY_AFTER_SEND); #endif -#if defined(DECODE_MAGIQUEST) - Serial.println(F("Send MagiQuest")); - Serial.flush(); - IrSender.sendMagiQuest(0x6BCD0000 | (uint32_t) sAddress, s16BitCommand); // we have 31 bit address - checkReceive(sAddress, s16BitCommand & 0x1FF); // we have 9 bit command - delay(DELAY_AFTER_SEND); -#endif - -#if defined(DECODE_BEO) - Serial.println(F("Send Bang&Olufsen")); - Serial.flush(); - IrSender.sendBangOlufsen(sAddress & 0x0FF, sCommand, sRepeats); -# if defined(ENABLE_BEO_WITHOUT_FRAME_GAP) - delay((RECORD_GAP_MICROS / 1000) + 1); - IrReceiver.printIRResultRawFormatted(&Serial, true); - uint8_t tOriginalRawlen = IrReceiver.decodedIRData.rawDataPtr->rawlen; - IrReceiver.decodedIRData.rawDataPtr->rawlen = 6; - // decode first part of frame - IrReceiver.decode(); - IrReceiver.printIRResultShort(&Serial); - - // Remove trailing 6 entries for next decode - IrReceiver.decodedIRData.rawDataPtr->rawlen = tOriginalRawlen - 6; - for (uint_fast8_t i = 0; i < IrReceiver.decodedIRData.rawDataPtr->rawlen; ++i) { - IrReceiver.decodedIRData.rawDataPtr->rawbuf[i] = IrReceiver.decodedIRData.rawDataPtr->rawbuf[i + 6]; - } -# endif - checkReceive(sAddress & 0x0FF, sCommand); - delay(DELAY_AFTER_SEND); -#endif - #if defined(DECODE_BOSEWAVE) IRSendData.protocol = BOSEWAVE; Serial.println(F("Send Bosewave with no address and 8 command bits")); Serial.flush(); - IrSender.write(&IRSendData, sRepeats); + IrSender.write(&IRSendData, 0); checkReceive(0, IRSendData.command & 0xFF); delay(DELAY_AFTER_SEND); #endif @@ -773,7 +876,7 @@ void loop() { Serial.print(F("Send ")); Serial.println(getProtocolString(IRSendData.protocol)); Serial.flush(); - IrSender.write(&IRSendData, sRepeats); + IrSender.write(&IRSendData, 0); checkReceive(0, IRSendData.command & 0xFF); delay(DELAY_AFTER_SEND); #endif @@ -789,10 +892,10 @@ void loop() { /* * Force buffer overflow */ - Serial.println(F("Force buffer overflow by sending 280 marks and spaces")); - for (unsigned int i = 0; i < 140; ++i) { - // 400 + 400 should be received as 8/8 and sometimes as 9/7 or 7/9 if compensation by MARK_EXCESS_MICROS is optimal. + Serial.println(F("Force buffer overflow by sending 450 marks and spaces")); + for (unsigned int i = 0; i < 225; ++i) { // 225 because we send 2 entries per loop // 210 + 540 = 750 should be received as 5/10 or 4/11 if compensation by MARK_EXCESS_MICROS is optimal. + // 400 + 400 should be received as 8/8 and sometimes as 9/7 or 7/9 if compensation by MARK_EXCESS_MICROS is optimal. IrSender.mark(210); // 8 pulses at 38 kHz IrSender.space(540); // to fill up to 750 us } @@ -806,7 +909,19 @@ void loop() { sAddress += 0x0101; sCommand += 0x11; s16BitCommand += 0x1111; + sRepeats++; + // clip repeats at 4 + if (sRepeats > 4) { + sRepeats = 4; + } + /* + * Test stop and start of 50 us receiver timer + */ + Serial.println(F("Stop receiver")); + IrReceiver.stop(); delay(DELAY_AFTER_LOOP); // additional delay at the end of each loop + Serial.println(F("Start receiver")); + IrReceiver.start(); // For ESP32 timerEnableReceiveInterrupt() is sufficient here, since timer is not reconfigured by another task } diff --git a/examples/UnitTest/UnitTest.log b/examples/UnitTest/UnitTest.log index da30c2188..4063d890c 100644 --- a/examples/UnitTest/UnitTest.log +++ b/examples/UnitTest/UnitTest.log @@ -1,6 +1,8 @@ -START ../src/UnitTest.cpp from Feb 22 2023 -Using library version 4.1.0 -Ready to receive IR signals of protocols: NEC/NEC2/Onkyo/Apple, Panasonic/Kaseikyo, Denon/Sharp, Sony, RC5, RC6, LG, JVC, Samsung, Bang & Olufsen, FAST, Bosewave , MagiQuest, Universal Pulse Distance Width, Hash at pin 2 +START ../src/UnitTest.cpp from Jun 22 2024 +Using library version 4.4.0 +Ready to receive IR signals of protocols: NEC/NEC2/Onkyo/Apple, Panasonic/Kaseikyo, Denon/Sharp, Sony, RC5, RC6, LG, JVC, Samsung, Bang & Olufsen, FAST, Bosewave, MagiQuest, Universal Pulse Distance Width, Hash at pin 2 +Use ReceiveCompleteCallback +Receive buffer length is 200 Send IR signals at pin 3 If you connect debug pin 5 to ground, raw data is always printed Send signal mark duration for 38kHz is 8 us, pulse narrowing correction is 3000 ns, total period is 26 us @@ -10,742 +12,886 @@ Send signal mark duration for 38kHz is 8 us, pulse narrowing correction is 3000 address=0xFFF1 command=0x76 Send NEC with 8 bit address -Protocol=NEC Address=0xF1 Command=0x76 Raw-Data=0x89760EF1 32 bits LSB first +Protocol=NEC Address=0xF1 Command=0x76 Raw-Data=0x89760EF1 32 bits LSB first Duration=67850 us Send with: IrSender.sendNEC(0xF1, 0x76, ); rawData[68]: - -1044300 - +8950,-4400 - + 600,-1650 + 600,- 500 + 600,- 550 + 600,- 500 - + 600,-1650 + 600,-1600 + 600,-1650 + 600,-1650 - + 550,- 550 + 600,-1650 + 600,-1650 + 550,-1650 - + 600,- 550 + 550,- 550 + 600,- 550 + 550,- 600 - + 550,- 550 + 550,-1650 + 600,-1650 + 600,- 500 - + 600,-1650 + 600,-1650 + 600,-1650 + 600,- 500 - + 600,-1650 + 550,- 600 + 550,- 550 + 600,-1800 - + 450,- 500 + 600,- 550 + 550,- 550 + 600,-1650 - + 550 -Sum: 67650 + -1049200 + +8950,-4350 + + 650,-1600 + 650,- 500 + 600,- 500 + 650,- 500 + + 600,-1600 + 650,-1600 + 650,-1600 + 650,-1600 + + 650,- 500 + 600,-1600 + 650,-1600 + 650,-1600 + + 600,- 500 + 650,- 500 + 600,- 500 + 650,- 500 + + 600,- 500 + 650,-1600 + 650,-1600 + 650,- 500 + + 600,-1600 + 650,-1600 + 650,-1600 + 650,- 500 + + 600,-1650 + 600,- 500 + 650,- 500 + 600,-1600 + + 650,- 500 + 650,- 500 + 600,- 500 + 650,-1600 + + 650 +Duration=67850 us Send NEC with 16 bit address -Protocol=NEC Address=0xFFF1 Command=0x76 Raw-Data=0x8976FFF1 32 bits LSB first +Protocol=NEC Address=0xFFF1 Command=0x76 Raw-Data=0x8976FFF1 32 bits LSB first Duration=73350 us Send with: IrSender.sendNEC(0xFFF1, 0x76, ); rawData[68]: - -1055100 - +8850,-4450 - + 600,-1650 + 600,- 500 + 600,- 550 + 600,- 500 - + 600,-1650 + 600,-1650 + 550,-1650 + 600,-1650 - + 600,-1650 + 550,-1650 + 600,-1650 + 600,-1650 - + 550,-1650 + 600,-1650 + 550,-1700 + 550,-1650 - + 550,- 600 + 550,-1650 + 600,-1650 + 600,- 550 - + 550,-1650 + 600,-1650 + 600,-1650 + 600,- 500 - + 600,-1650 + 600,- 550 + 550,- 550 + 600,-1650 - + 600,- 500 + 550,- 600 + 600,- 500 + 600,-1650 - + 550 -Sum: 73150 + -1060600 + +8950,-4400 + + 600,-1600 + 650,- 500 + 650,- 450 + 650,- 500 + + 600,-1600 + 650,-1600 + 650,-1600 + 650,-1600 + + 650,-1600 + 600,-1600 + 650,-1600 + 650,-1600 + + 600,-1600 + 650,-1600 + 650,-1600 + 650,-1600 + + 600,- 500 + 650,-1600 + 650,-1600 + 650,- 500 + + 600,-1600 + 650,-1600 + 650,-1600 + 650,- 500 + + 600,-1600 + 650,- 500 + 600,- 500 + 650,-1600 + + 650,- 500 + 600,- 500 + 650,- 500 + 600,-1600 + + 650 +Duration=73350 us Send NEC2 with 16 bit address -Protocol=NEC Address=0xFFF1 Command=0x76 Raw-Data=0x8976FFF1 32 bits LSB first +Protocol=NEC Address=0xFFF1 Command=0x76 Raw-Data=0x8976FFF1 32 bits LSB first Duration=73400 us Send with: IrSender.sendNEC(0xFFF1, 0x76, ); rawData[68]: - -1055500 + -1061100 +8950,-4400 - + 650,-1600 + 600,- 500 + 650,- 500 + 600,- 500 - + 650,-1600 + 650,-1600 + 650,-1600 + 600,-1600 - + 650,-1600 + 650,-1600 + 650,-1600 + 600,-1600 - + 650,-1600 + 650,-1600 + 650,-1600 + 650,-1600 - + 600,- 500 + 650,-1600 + 650,-1600 + 600,- 500 - + 650,-1600 + 650,-1600 + 650,-1600 + 650,- 450 - + 650,-1600 + 650,- 500 + 600,- 500 + 600,-1650 + + 650,-1600 + 650,- 500 + 600,- 500 + 650,- 500 + + 650,-1600 + 600,-1600 + 650,-1600 + 650,-1600 + + 650,-1600 + 600,-1650 + 600,-1600 + 650,-1600 + + 650,-1600 + 650,-1600 + 600,-1600 + 650,-1600 + + 600,- 500 + 650,-1600 + 650,-1600 + 650,- 500 + + 600,-1600 + 650,-1600 + 650,-1600 + 600,- 500 + + 650,-1600 + 650,- 500 + 600,- 500 + 650,-1600 + 650,- 500 + 600,- 500 + 650,- 500 + 600,-1600 + 650 -Sum: 73400 +Duration=73400 us -Send NEC Pronto data with 8 bit address 0x80 and command 0x45 and no repeats -Protocol=NEC Address=0x80 Command=0x45 Raw-Data=0xBA457F80 32 bits LSB first -Send with: IrSender.sendNEC(0x80, 0x45, ); -rawData[68]: - -1064450 - +9050,-4450 - + 550,- 550 + 600,- 550 + 600,- 600 + 550,- 600 - + 600,- 550 + 600,- 550 + 600,- 550 + 600,-1600 - + 650,-1600 + 600,-1600 + 600,-1650 + 550,-1600 - + 600,-1600 + 600,-1600 + 600,-1600 + 650,- 500 - + 650,-1550 + 600,- 550 + 600,-1600 + 600,- 550 - + 600,- 550 + 600,- 550 + 600,-1600 + 600,- 550 - + 650,- 500 + 650,-1550 + 600,- 550 + 600,-1600 - + 600,-1600 + 600,-1650 + 600,- 550 + 600,-1650 - + 550 -Sum: 67800 - -Send NEC sendRaw data with 8 bit address=0xFB04 and command 0x08 and exact timing (16 bit array format) -Protocol=NEC Address=0x4 Command=0x8 Raw-Data=0xF708FB04 32 bits LSB first -Send with: IrSender.sendNEC(0x4, 0x8, ); -rawData[68]: - -1061400 - +9000,-4400 - + 600,- 500 + 650,- 500 + 600,-1650 + 600,- 500 - + 650,- 500 + 600,- 550 + 600,- 500 + 600,- 550 - + 600,-1650 + 600,-1650 + 600,- 500 + 600,-1650 - + 600,-1650 + 600,-1650 + 600,-1650 + 600,-1650 - + 600,- 500 + 600,- 550 + 600,- 500 + 600,-1650 - + 600,- 500 + 600,- 550 + 600,- 500 + 600,- 550 - + 600,-1650 + 600,-1650 + 600,-1650 + 600,- 500 - + 600,-1650 + 600,-1650 + 600,-1650 + 550,-1650 - + 600 -Sum: 67900 - -Send ONKYO with 16 bit address 0x0102 and 16 bit command 0x0304 with NECRaw(0x03040102) -Protocol=Onkyo Address=0x102 Command=0x304 Raw-Data=0x3040102 32 bits LSB first -Send with: IrSender.sendOnkyo(0x102, 0x304, ); -rawData[68]: - -1059700 - +8900,-4400 - + 600,- 550 + 600,-1600 + 600,- 550 + 600,- 500 - + 600,- 550 + 600,- 500 + 600,- 550 + 600,- 500 - + 600,-1650 + 600,- 500 + 600,- 550 + 600,- 500 - + 600,- 550 + 600,- 500 + 600,- 550 + 600,- 550 - + 550,- 550 + 600,- 500 + 600,-1650 + 600,- 500 - + 600,- 550 + 600,- 500 + 650,- 500 + 600,- 500 - + 600,-1650 + 600,-1600 + 600,- 550 + 600,- 500 - + 650,- 500 + 600,- 550 + 550,- 550 + 600,- 500 - + 650 -Sum: 55450 - -Send ONKYO with 16 bit address 0x0102 and command 0x34 with old 32 bit format MSB first (0x40802CD3) -Protocol=NEC Address=0x102 Command=0x34 Raw-Data=0xCB340102 32 bits LSB first -Send with: IrSender.sendNEC(0x102, 0x34, ); -rawData[68]: - -1061500 - +8950,-4400 - + 600,- 500 + 550,-1700 + 600,- 500 + 650,- 500 - + 600,- 500 + 650,- 500 + 550,- 550 + 650,- 500 - + 600,-1650 + 600,- 500 + 600,- 550 + 600,- 500 - + 600,- 550 + 600,- 500 + 600,- 550 + 600,- 500 - + 600,- 550 + 600,- 500 + 600,-1650 + 600,- 500 - + 600,-1650 + 600,-1650 + 600,- 500 + 600,- 550 - + 600,-1600 + 550,-1700 + 600,- 550 + 600,-1600 - + 600,- 550 + 600,- 500 + 650,-1600 + 600,-1650 - + 550 -Sum: 61000 - -Send Panasonic 0xB, 0x10 as 48 bit generic PulseDistance using ProtocolConstants -Protocol=Panasonic Address=0xB Command=0x10 Raw-Data=0xA01000B0 48 bits LSB first +Send Panasonic 0xB, 0x10 as 48 bit PulseDistance using ProtocolConstants +Protocol=Panasonic Address=0xB Command=0x10 Raw-Data=0xA01000B0 48 bits LSB first Duration=54150 us Send with: IrSender.sendPanasonic(0xB, 0x10, ); rawData[100]: - -1059500 - +3450,-1700 - + 450,- 450 + 450,-1250 + 450,- 400 + 450,- 450 - + 450,- 400 + 450,- 400 + 450,- 450 + 400,- 450 - + 450,- 400 + 450,- 450 + 400,- 450 + 450,- 400 - + 450,- 450 + 400,-1300 + 450,- 400 + 450,- 450 - + 400,- 450 + 450,- 400 + 450,- 450 + 400,- 450 - + 450,-1300 + 400,-1300 + 450,- 400 + 450,-1300 - + 450,- 400 + 450,- 450 + 450,- 400 + 450,- 400 - + 450,- 450 + 400,- 450 + 450,- 400 + 450,- 450 - + 450,- 400 + 450,- 450 + 400,- 450 + 450,- 400 - + 450,-1300 + 400,- 450 + 450,- 450 + 400,- 450 - + 450,- 400 + 450,- 450 + 400,- 450 + 450,- 400 - + 450,- 450 + 400,-1300 + 450,- 400 + 450,-1300 + -1064750 + +3500,-1650 + + 500,- 350 + 500,-1250 + 450,- 400 + 500,- 350 + + 500,- 400 + 450,- 400 + 500,- 350 + 500,- 400 + + 450,- 400 + 500,- 350 + 500,- 400 + 450,- 400 + + 500,- 350 + 500,-1250 + 500,- 350 + 500,- 400 + + 450,- 400 + 500,- 350 + 500,- 400 + 450,- 400 + + 500,-1200 + 500,-1250 + 450,- 400 + 500,-1250 + + 450,- 400 + 500,- 350 + 500,- 400 + 450,- 400 + + 500,- 400 + 450,- 400 + 500,- 350 + 500,- 400 + + 500,- 400 + 450,- 400 + 500,- 350 + 500,- 350 + + 500,-1250 + 500,- 350 + 500,- 400 + 500,- 350 + + 500,- 400 + 450,- 400 + 500,- 350 + 500,- 400 + + 500,- 350 + 500,-1250 + 450,- 400 + 500,-1250 + 450 -Sum: 54100 +Duration=54150 us -Send Panasonic 0xB, 0x10 as generic 48 bit PulseDistance - LSB first -Protocol=Panasonic Address=0xB Command=0x10 Raw-Data=0xA01000B0 48 bits LSB first +Send Panasonic 0xB, 0x10 as 48 bit PulseDistance +-LSB first +Protocol=Panasonic Address=0xB Command=0x10 Raw-Data=0xA01000B0 48 bits LSB first Duration=53200 us Send with: IrSender.sendPanasonic(0xB, 0x10, ); rawData[100]: - -1076450 - +3450,-1700 - + 450,- 400 + 450,-1250 + 450,- 400 + 450,- 400 - + 450,- 400 + 400,- 450 + 400,- 450 + 450,- 400 - + 450,- 400 + 450,- 400 + 450,- 400 + 450,- 400 - + 450,- 400 + 450,-1250 + 450,- 400 + 450,- 400 - + 450,- 400 + 450,- 400 + 450,- 400 + 450,- 400 - + 450,-1250 + 450,-1250 + 450,- 400 + 450,-1250 - + 450,- 400 + 450,- 400 + 450,- 400 + 450,- 350 - + 500,- 400 + 400,- 450 + 450,- 350 + 500,- 400 - + 450,- 400 + 450,- 400 + 450,- 400 + 450,- 400 - + 450,-1250 + 450,- 400 + 450,- 400 + 450,- 400 - + 450,- 400 + 450,- 400 + 450,- 400 + 450,- 400 - + 450,- 400 + 450,-1200 + 500,- 400 + 450,-1300 - + 400 -Sum: 53200 + -1081400 + +3450,-1650 + + 550,- 300 + 500,-1200 + 500,- 350 + 500,- 350 + + 500,- 350 + 500,- 350 + 500,- 350 + 500,- 350 + + 500,- 350 + 500,- 350 + 550,- 300 + 500,- 350 + + 500,- 350 + 500,-1200 + 500,- 350 + 500,- 350 + + 500,- 350 + 500,- 350 + 500,- 350 + 500,- 350 + + 500,-1200 + 500,-1200 + 500,- 350 + 500,-1200 + + 500,- 350 + 500,- 350 + 500,- 350 + 500,- 350 + + 500,- 350 + 500,- 350 + 500,- 350 + 550,- 350 + + 500,- 350 + 500,- 350 + 500,- 350 + 500,- 300 + + 550,-1150 + 500,- 400 + 450,- 350 + 500,- 350 + + 500,- 350 + 500,- 350 + 500,- 350 + 500,- 350 + + 550,- 300 + 500,-1200 + 500,- 350 + 500,-1200 + + 500 +Duration=53200 us - MSB first -Protocol=Panasonic Address=0xB Command=0x10 Raw-Data=0xA01000B0 48 bits LSB first +-MSB first +Protocol=Panasonic Address=0xB Command=0x10 Raw-Data=0xA01000B0 48 bits LSB first Duration=53200 us Send with: IrSender.sendPanasonic(0xB, 0x10, ); rawData[100]: - -1070700 - +3400,-1700 - + 450,- 400 + 450,-1250 + 450,- 400 + 450,- 400 - + 450,- 400 + 450,- 400 + 450,- 400 + 450,- 400 - + 450,- 400 + 450,- 400 + 450,- 400 + 450,- 400 - + 450,- 400 + 450,-1250 + 450,- 400 + 450,- 400 - + 400,- 450 + 450,- 400 + 450,- 400 + 450,- 400 - + 450,-1250 + 400,-1300 + 450,- 400 + 450,-1300 - + 400,- 400 + 450,- 400 + 450,- 400 + 450,- 400 - + 450,- 400 + 450,- 400 + 450,- 400 + 450,- 400 - + 450,- 400 + 450,- 400 + 450,- 400 + 450,- 550 - + 250,-1300 + 450,- 450 + 400,- 400 + 450,- 400 - + 450,- 400 + 400,- 450 + 400,- 450 + 450,- 400 - + 450,- 400 + 450,-1250 + 450,- 400 + 450,-1250 - + 450 -Sum: 53150 + -1076300 + +3450,-1650 + + 500,- 350 + 550,-1150 + 500,- 400 + 500,- 300 + + 550,- 300 + 550,- 300 + 500,- 350 + 550,- 300 + + 500,- 350 + 500,- 350 + 500,- 350 + 500,- 350 + + 500,- 350 + 500,-1200 + 500,- 350 + 500,- 350 + + 500,- 350 + 500,- 350 + 500,- 350 + 500,- 350 + + 500,-1200 + 500,-1200 + 500,- 350 + 500,-1200 + + 500,- 350 + 500,- 350 + 500,- 350 + 500,- 350 + + 500,- 350 + 500,- 350 + 550,- 300 + 500,- 400 + + 500,- 350 + 500,- 350 + 500,- 350 + 500,- 300 + + 500,-1200 + 500,- 350 + 500,- 350 + 500,- 350 + + 500,- 350 + 500,- 350 + 500,- 350 + 500,- 350 + + 500,- 350 + 500,-1200 + 500,- 350 + 500,-1200 + + 500 +Duration=53200 us -Send generic 72 bit PulseDistance 0x5A AFEDCBA9 87654321 LSB first -Protocol=PulseDistance Raw-Data=0x5A 72 bits LSB first -Send with: +Send 72 bit PulseDistance 0x5A AFEDCBA9 87654321 LSB first +Protocol=PulseDistance Raw-Data=0x5A 72 bits LSB first Duration=138400 us +Send on a 8 bit platform with: uint32_t tRawData[]={0x87654321, 0xAFEDCBA9, 0x5A}; - IrSender.sendPulseDistanceWidthFromArray(38, 8850, 4400, 550, 1650, 550, 600, &tRawData[0], 72, PROTOCOL_IS_LSB_FIRST, , ); + IrSender.sendPulseDistanceWidthFromArray(38, 8900, 4400, 600, 1650, 600, 550, &tRawData[0], 72, PROTOCOL_IS_LSB_FIRST, , ); rawData[148]: - -1076300 - +8850,-4400 - + 600,-1650 + 550,- 600 + 550,- 600 + 550,- 600 - + 550,- 600 + 550,-1650 + 550,- 650 + 550,- 600 - + 550,-1700 + 550,-1650 + 600,- 600 + 550,- 600 - + 550,- 600 + 500,- 650 + 550,-1650 + 600,- 600 - + 550,-1650 + 600,- 600 + 550,-1650 + 550,- 650 - + 550,- 600 + 550,-1650 + 550,-1700 + 550,- 600 - + 550,-1700 + 550,-1700 + 550,-1650 + 550,- 650 - + 550,- 600 + 550,- 600 + 550,- 600 + 550,-1700 - + 550,-1700 + 550,- 600 + 550,- 600 + 550,-1650 - + 500,- 700 + 550,-1650 + 600,- 600 + 550,-1650 - + 600,-1650 + 600,-1650 + 550,- 650 + 550,-1650 - + 550,- 600 + 550,- 600 + 550,-1700 + 550,-1700 - + 550,-1650 + 600,- 600 + 550,-1650 + 600,-1650 - + 600,- 600 + 550,-1650 + 550,-1700 + 550,-1700 - + 550,-1700 + 550,-1700 + 550,-1700 + 550,-1650 - + 550,- 650 + 550,-1650 + 550,- 650 + 550,-1700 - + 550,- 600 + 550,-1650 + 600,- 550 + 600,-1650 - + 550,-1700 + 550,- 600 + 550,-1700 + 550,- 600 - + 550 -Sum: 138200 + -1081200 + +8900,-4400 + + 600,-1600 + 600,- 550 + 600,- 550 + 600,- 550 + + 600,- 550 + 600,-1650 + 600,- 550 + 600,- 550 + + 600,-1650 + 600,-1650 + 600,- 550 + 600,- 550 + + 600,- 550 + 600,- 550 + 600,-1650 + 600,- 550 + + 600,-1650 + 600,- 550 + 600,-1650 + 600,- 550 + + 600,- 550 + 600,-1650 + 600,-1650 + 600,- 550 + + 600,-1650 + 600,-1650 + 600,-1650 + 600,- 550 + + 600,- 550 + 600,- 550 + 600,- 550 + 600,-1650 + + 650,-1600 + 600,- 550 + 600,- 550 + 600,-1650 + + 600,- 550 + 600,-1650 + 600,- 550 + 600,-1650 + + 600,-1650 + 600,-1650 + 600,- 550 + 600,-1650 + + 600,- 550 + 600,- 550 + 600,-1650 + 600,-1650 + + 550,-1700 + 600,- 550 + 600,-1650 + 600,-1650 + + 600,- 550 + 600,-1650 + 600,-1650 + 600,-1650 + + 550,-1650 + 600,-1650 + 600,-1650 + 600,-1650 + + 600,- 550 + 600,-1650 + 600,- 550 + 600,-1700 + + 550,- 550 + 600,-1650 + 600,- 550 + 600,-1650 + + 600,-1650 + 600,- 550 + 600,-1650 + 600,- 550 + + 600 +Duration=138400 us -Send generic 52 bit PulseDistanceWidth 0xDCBA9 87654321 LSB first -Protocol=PulseWidth Raw-Data=0xDCBA9 52 bits LSB first -Send with: +Send 52 bit PulseDistanceWidth 0xDCBA9 87654321 LSB first +Protocol=PulseDistance Raw-Data=0xDCBA9 52 bits LSB first Duration=48250 us +Send on a 8 bit platform with: uint32_t tRawData[]={0x87654321, 0xDCBA9}; - IrSender.sendPulseDistanceWidthFromArray(38, 350, 600, 600, 300, 300, 600, &tRawData[0], 52, PROTOCOL_IS_LSB_FIRST, , ); -rawData[106]: - -1115100 - + 350,- 600 - + 650,- 250 + 350,- 550 + 350,- 550 + 300,- 600 - + 350,- 550 + 600,- 300 + 350,- 550 + 350,- 550 - + 600,- 300 + 600,- 300 + 350,- 550 + 350,- 550 - + 350,- 600 + 300,- 600 + 600,- 300 + 300,- 600 - + 600,- 300 + 300,- 600 + 600,- 300 + 300,- 600 - + 300,- 600 + 600,- 300 + 600,- 300 + 350,- 550 - + 600,- 300 + 600,- 300 + 600,- 300 + 300,- 600 - + 350,- 550 + 350,- 550 + 350,- 550 + 600,- 350 - + 600,- 300 + 300,- 600 + 300,- 600 + 600,- 300 - + 300,- 600 + 600,- 300 + 300,- 600 + 600,- 300 - + 600,- 300 + 600,- 300 + 300,- 600 + 600,- 300 - + 300,- 600 + 350,- 550 + 600,- 300 + 600,- 300 - + 600,- 300 + 300,- 600 + 600,- 300 + 600 -Sum: 47550 - -Send generic 32 bit PulseWidth 0x87654321 LSB first -Protocol=PulseWidth Raw-Data=0x87654321 32 bits LSB first -Send with: IrSender.sendPulseDistanceWidth(38, 950, 550, 600, 300, 300, 300, 0x87654321, 32, PROTOCOL_IS_LSB_FIRST, , ); + IrSender.sendPulseDistanceWidthFromArray(38, 350, 550, 350, 550, 650, 250, &tRawData[0], 52, PROTOCOL_IS_LSB_FIRST, , ); +rawData[108]: + -1118250 + + 350,- 550 + + 400,- 500 + 700,- 200 + 650,- 250 + 700,- 200 + + 650,- 250 + 400,- 550 + 650,- 250 + 650,- 250 + + 350,- 550 + 350,- 550 + 650,- 250 + 650,- 250 + + 650,- 250 + 650,- 200 + 400,- 550 + 650,- 200 + + 400,- 550 + 650,- 200 + 400,- 550 + 650,- 200 + + 700,- 200 + 400,- 550 + 350,- 550 + 650,- 250 + + 350,- 550 + 350,- 550 + 350,- 550 + 650,- 250 + + 650,- 250 + 650,- 250 + 650,- 250 + 350,- 550 + + 400,- 550 + 650,- 250 + 650,- 200 + 400,- 500 + + 700,- 200 + 400,- 550 + 650,- 250 + 350,- 550 + + 350,- 550 + 350,- 550 + 650,- 250 + 400,- 500 + + 700,- 250 + 650,- 250 + 350,- 550 + 350,- 550 + + 350,- 550 + 650,- 250 + 350,- 550 + 350,- 550 + + 400 +Duration=48250 us + +Send 52 bit PulseDistanceWidth 0xDCBA9 87654321 LSB first with inverse timing and data +Protocol=PulseDistance Raw-Data=0xDCBA9 52 bits LSB first Duration=48500 us +Send on a 8 bit platform with: + uint32_t tRawData[]={0x87654321, 0xDCBA9}; + IrSender.sendPulseDistanceWidthFromArray(38, 350, 550, 350, 550, 650, 250, &tRawData[0], 52, PROTOCOL_IS_LSB_FIRST, , ); +rawData[108]: + -1097950 + + 350,- 550 + + 400,- 500 + 650,- 250 + 650,- 250 + 650,- 250 + + 650,- 250 + 400,- 500 + 700,- 200 + 700,- 250 + + 350,- 550 + 350,- 550 + 650,- 250 + 650,- 250 + + 650,- 250 + 650,- 250 + 350,- 550 + 650,- 250 + + 350,- 550 + 650,- 250 + 350,- 550 + 650,- 250 + + 650,- 250 + 400,- 550 + 350,- 500 + 650,- 250 + + 400,- 500 + 400,- 500 + 400,- 550 + 650,- 250 + + 650,- 200 + 700,- 200 + 650,- 250 + 400,- 550 + + 400,- 500 + 650,- 250 + 650,- 250 + 400,- 550 + + 600,- 250 + 400,- 500 + 650,- 250 + 400,- 550 + + 350,- 550 + 350,- 550 + 650,- 250 + 350,- 550 + + 650,- 250 + 650,- 250 + 350,- 550 + 350,- 550 + + 350,- 550 + 650,- 250 + 350,- 550 + 400,- 500 + + 650 +Duration=48500 us + +Send 7 bit ASCII character with PulseDistanceWidth LSB first +Protocol=PulseDistance Raw-Data=0x76 7 bits LSB first Duration=20950 us +Send on a 8 bit platform with: IrSender.sendPulseDistanceWidth(38, 6000, 450, 550, 1450, 1550, 450, 0x76, 7, PROTOCOL_IS_LSB_FIRST, , ); +rawData[18]: + -1095750 + +6000,- 450 + +1550,- 450 + 550,-1400 + 550,-1450 +1550,- 450 + + 550,-1450 + 550,-1450 + 550,-1450 + 550 +Duration=20950 us + +Send Sony12 as PulseWidth LSB first +Protocol=Sony Address=0x11 Command=0x76 Raw-Data=0x8F6 12 bits LSB first Duration=21050 us +Send with: IrSender.sendSony(0x11, 0x76, 2, 12); +rawData[26]: + -1038650 + +2500,- 500 + + 700,- 500 +1250,- 550 +1250,- 550 + 650,- 550 + +1250,- 550 +1250,- 550 +1250,- 550 +1250,- 550 + + 650,- 550 + 650,- 550 + 650,- 550 +1250 +Duration=21050 us + +Send 32 bit PulseWidth 0x87654321 LSB first +Protocol=PulseWidth Raw-Data=0x87654321 32 bits LSB first Duration=24650 us +Send on a 8 bit platform with: IrSender.sendPulseDistanceWidth(38, 1100, 450, 650, 250, 350, 250, 0x87654321, 32, PROTOCOL_IS_LSB_FIRST, , ); rawData[66]: - -1088600 - + 950,- 550 - + 600,- 300 + 300,- 300 + 350,- 250 + 350,- 250 - + 350,- 300 + 600,- 300 + 300,- 300 + 300,- 300 - + 650,- 250 + 650,- 250 + 300,- 300 + 350,- 250 - + 350,- 300 + 300,- 300 + 600,- 300 + 300,- 300 - + 600,- 300 + 350,- 250 + 600,- 300 + 350,- 250 - + 350,- 300 + 600,- 300 + 600,- 300 + 300,- 300 - + 600,- 300 + 600,- 300 + 600,- 300 + 300,- 300 - + 300,- 300 + 300,- 300 + 350,- 250 + 650 -Sum: 24500 - -Send MagiQuest 0x6BCDFF00, 0x176 as generic 55 bit PulseDistanceWidth MSB first + -1038250 + +1100,- 450 + + 600,- 300 + 350,- 250 + 350,- 250 + 400,- 200 + + 400,- 250 + 600,- 300 + 350,- 250 + 350,- 250 + + 650,- 250 + 650,- 250 + 400,- 250 + 350,- 250 + + 350,- 250 + 400,- 200 + 650,- 250 + 400,- 250 + + 650,- 250 + 350,- 250 + 650,- 250 + 350,- 250 + + 350,- 250 + 650,- 250 + 700,- 200 + 400,- 250 + + 650,- 200 + 700,- 200 + 700,- 200 + 400,- 250 + + 350,- 250 + 350,- 250 + 400,- 200 + 700 +Duration=24650 us + +Send MagiQuest 0x6BCDFF00, 0x176 as 55 bit PulseDistanceWidth MSB first Duration=63850 us Protocol=MagiQuest Address=0xFF00 Command=0x176 Raw-Data=0x6BCDFF00 56 bits MSB first Send with: IrSender.sendMagiQuest(0x6BCDFF00, 0x176, ); -rawData[112]: - -1089000 - + 350,- 800 + 350,- 800 + 350,- 800 + 300,- 850 - + 300,- 850 + 300,- 850 + 300,- 850 + 350,- 800 +rawData[112]: + -1065600 + + 350,- 800 + 350,- 800 + 350,- 800 + 350,- 800 + + 350,- 800 + 350,- 800 + 350,- 800 + 350,- 800 + 600,- 550 + 600,- 550 + 350,- 800 + 600,- 550 - + 300,- 850 + 600,- 550 + 600,- 550 + 600,- 550 - + 600,- 550 + 350,- 800 + 300,- 850 + 550,- 600 - + 600,- 550 + 300,- 850 + 600,- 550 + 600,- 550 - + 600,- 550 + 600,- 600 + 550,- 550 + 600,- 550 + + 350,- 800 + 600,- 550 + 600,- 550 + 600,- 550 + + 600,- 550 + 350,- 800 + 350,- 800 + 600,- 550 + + 600,- 550 + 350,- 800 + 600,- 550 + 600,- 550 + + 600,- 550 + 600,- 550 + 600,- 550 + 600,- 550 + 600,- 550 + 600,- 550 + 600,- 550 + 300,- 850 - + 300,- 850 + 350,- 800 + 300,- 850 + 300,- 850 - + 300,- 850 + 300,- 850 + 300,- 850 + 600,- 550 - + 300,- 850 + 600,- 550 + 600,- 550 + 600,- 550 - + 350,- 800 + 600,- 550 + 600,- 550 + 350,- 800 - + 300,- 850 + 300,- 850 + 300,- 850 + 600,- 600 - + 550,- 600 + 250,- 900 + 250,- 850 + 600 -Sum: 63850 + + 350,- 850 + 300,- 850 + 300,- 800 + 350,- 800 + + 350,- 800 + 350,- 800 + 350,- 800 + 600,- 550 + + 350,- 800 + 650,- 500 + 600,- 600 + 550,- 550 + + 300,- 850 + 600,- 550 + 600,- 550 + 350,- 800 + + 300,- 850 + 350,- 800 + 350,- 800 + 600,- 550 + + 600,- 550 + 350,- 800 + 350,- 800 + 600 +Duration=63850 us Send Onkyo (NEC with 16 bit command) -Protocol=Onkyo Address=0xFFF1 Command=0x7776 Raw-Data=0x7776FFF1 32 bits LSB first +Protocol=Onkyo Address=0xFFF1 Command=0x7776 Raw-Data=0x7776FFF1 32 bits LSB first Duration=76750 us Send with: IrSender.sendOnkyo(0xFFF1, 0x7776, ); rawData[68]: - -1070700 - +8900,-4550 - + 500,-1600 + 650,- 500 + 600,- 500 + 600,- 550 - + 600,-1600 + 600,-1650 + 600,-1650 + 550,-1650 - + 600,-1650 + 600,-1650 + 550,-1650 + 600,-1650 - + 600,-1650 + 550,-1650 + 600,-1650 + 550,-1700 - + 550,- 550 + 600,-1650 + 550,-1650 + 600,- 550 - + 600,-1650 + 550,-1650 + 600,-1650 + 600,- 500 - + 600,-1650 + 600,-1650 + 600,-1600 + 600,- 550 - + 600,-1650 + 550,-1650 + 600,-1650 + 550,- 550 + -1115300 + +8950,-4400 + + 650,-1600 + 650,- 500 + 600,- 500 + 650,- 500 + + 600,-1600 + 650,-1600 + 650,-1600 + 650,-1600 + + 650,-1600 + 600,-1650 + 600,-1600 + 650,-1600 + + 650,-1600 + 650,-1600 + 600,-1650 + 600,-1600 + + 650,- 500 + 600,-1600 + 650,-1600 + 650,- 500 + + 600,-1600 + 650,-1600 + 650,-1600 + 650,- 500 + + 600,-1600 + 650,-1600 + 650,-1600 + 600,- 550 + + 600,-1600 + 650,-1600 + 650,-1600 + 650,- 500 + 600 -Sum: 76500 +Duration=76750 us Send Apple -Protocol=Apple Address=0xF1 Command=0x76 Raw-Data=0xF17687EE 32 bits LSB first +Protocol=Apple Address=0xF1 Command=0x76 Raw-Data=0xF17687EE 32 bits LSB first Duration=72250 us Send with: IrSender.sendApple(0xF1, 0x76, ); rawData[68]: - -1054650 + -1060250 +8950,-4400 - + 600,- 550 + 550,-1650 + 650,-1600 + 600,-1600 - + 600,- 550 + 600,-1650 + 550,-1650 + 600,-1650 - + 600,-1650 + 600,-1650 + 550,-1650 + 600,- 550 - + 550,- 550 + 600,- 550 + 600,- 500 + 600,-1650 - + 600,- 550 + 550,-1650 + 600,-1650 + 600,- 500 - + 550,-1700 + 600,-1650 + 550,-1650 + 600,- 550 - + 550,-1650 + 600,- 550 + 600,- 550 + 550,- 550 - + 600,-1650 + 550,-1650 + 600,-1650 + 600,-1650 - + 550 -Sum: 72100 + + 600,- 500 + 650,-1600 + 650,-1600 + 650,-1600 + + 650,- 500 + 600,-1600 + 650,-1600 + 650,-1600 + + 600,-1650 + 600,-1600 + 650,-1600 + 600,- 500 + + 650,- 500 + 600,- 500 + 650,- 500 + 650,-1600 + + 600,- 500 + 650,-1600 + 650,-1600 + 600,- 500 + + 650,-1600 + 650,-1600 + 650,-1600 + 600,- 500 + + 650,-1600 + 650,- 500 + 600,- 500 + 650,- 500 + + 600,-1600 + 650,-1600 + 650,-1600 + 650,-1600 + + 600 +Duration=72250 us Send Panasonic -Protocol=Panasonic Address=0xFF1 Command=0x76 Raw-Data=0x9976FF10 48 bits LSB first +Protocol=Panasonic Address=0xFF1 Command=0x76 Raw-Data=0x9976FF10 48 bits LSB first Duration=64450 us Send with: IrSender.sendPanasonic(0xFF1, 0x76, ); rawData[100]: - -1054300 - +3450,-1700 - + 450,- 450 + 400,-1300 + 450,- 400 + 450,- 450 - + 450,- 400 + 450,- 450 + 400,- 450 + 450,- 400 - + 450,- 450 + 450,- 400 + 450,- 400 + 450,- 450 - + 450,- 400 + 450,-1300 + 400,- 450 + 450,- 400 - + 450,- 450 + 400,- 450 + 450,- 400 + 450,- 450 - + 450,-1250 + 450,- 400 + 450,- 450 + 450,- 400 - + 450,-1300 + 400,-1300 + 450,-1300 + 400,-1300 - + 450,-1300 + 400,-1300 + 450,-1300 + 400,-1300 - + 450,- 450 + 450,-1250 + 500,-1250 + 450,- 400 - + 450,-1300 + 400,-1300 + 450,-1300 + 400,- 450 - + 450,-1250 + 450,- 450 + 450,- 400 + 450,-1300 - + 400,-1300 + 450,- 400 + 450,- 450 + 450,-1250 - + 450 -Sum: 64400 + -1059900 + +3500,-1650 + + 500,- 400 + 500,-1200 + 500,- 400 + 450,- 400 + + 500,- 350 + 500,- 400 + 500,- 350 + 500,- 350 + + 500,- 400 + 500,- 350 + 500,- 400 + 450,- 400 + + 500,- 350 + 500,-1250 + 450,- 400 + 500,- 350 + + 500,- 400 + 500,- 350 + 500,- 350 + 500,- 400 + + 500,-1200 + 500,- 400 + 450,- 400 + 500,- 350 + + 500,-1250 + 450,-1250 + 500,-1250 + 500,-1200 + + 500,-1200 + 500,-1250 + 500,-1200 + 500,-1250 + + 500,- 400 + 450,-1250 + 500,-1250 + 450,- 400 + + 500,-1250 + 450,-1250 + 500,-1250 + 450,- 400 + + 500,-1200 + 500,- 400 + 450,- 400 + 500,-1250 + + 450,-1250 + 500,- 350 + 500,- 400 + 450,-1250 + + 500 +Duration=64450 us Send Kaseikyo with 0x4711 as Vendor ID -Protocol=Kaseikyo Address=0xFF1 Command=0x76 Extra=0x4711 Raw-Data=0x9A76FF13 48 bits LSB first +Protocol=Kaseikyo Address=0xFF1 Command=0x76 Extra=0x4711 Raw-Data=0x9A76FF13 48 bits LSB first Duration=69550 us Send with: IrSender.sendKaseikyo(0xFF1, 0x76, , 0x4711); rawData[100]: - -1074550 - +3400,-1750 - + 450,-1250 + 450,- 450 + 450,- 400 + 450,- 450 - + 400,-1300 + 450,- 400 + 450,- 450 + 450,- 400 - + 450,-1300 + 400,-1300 + 450,-1300 + 400,- 450 - + 450,- 400 + 450,- 450 + 450,-1250 + 450,- 450 - + 400,-1300 + 450,-1300 + 400,- 450 + 450,- 400 - + 450,-1300 + 450,- 400 + 450,- 450 + 400,- 450 - + 450,-1250 + 400,-1350 + 450,-1300 + 400,-1350 - + 400,-1300 + 400,-1300 + 450,-1300 + 450,-1250 - + 450,- 450 + 400,-1300 + 450,-1300 + 400,- 450 - + 450,-1250 + 450,-1300 + 400,-1300 + 450,- 400 - + 450,- 450 + 450,-1250 + 450,- 400 + 450,-1300 - + 450,-1250 + 450,- 400 + 450,- 450 + 450,-1250 - + 450 -Sum: 69500 + -1080100 + +3450,-1700 + + 500,-1200 + 500,- 400 + 450,- 400 + 500,- 350 + + 500,-1250 + 450,- 400 + 500,- 350 + 500,- 400 + + 450,-1250 + 500,-1250 + 450,-1250 + 500,- 400 + + 450,- 400 + 500,- 350 + 500,-1250 + 500,- 350 + + 500,-1250 + 450,-1250 + 500,- 400 + 450,- 400 + + 500,-1200 + 500,- 400 + 450,- 400 + 500,- 350 + + 500,-1250 + 450,-1250 + 500,-1250 + 450,-1250 + + 500,-1250 + 450,-1250 + 500,-1250 + 450,-1300 + + 450,- 400 + 500,-1200 + 500,-1250 + 450,- 400 + + 500,-1250 + 450,-1250 + 500,-1250 + 450,- 400 + + 500,- 350 + 500,-1250 + 500,- 350 + 500,-1250 + + 450,-1250 + 500,- 400 + 450,- 400 + 500,-1200 + + 500 +Duration=69550 us Send Kaseikyo_Denon variant -Protocol=Kaseikyo_Denon Address=0xFF1 Command=0x76 Raw-Data=0x9976FF10 48 bits LSB first +Protocol=Kaseikyo_Denon Address=0xFF1 Command=0x76 Raw-Data=0x9976FF10 48 bits LSB first Duration=67900 us Send with: IrSender.sendKaseikyo_Denon(0xFF1, 0x76, ); rawData[100]: - -1067700 - +3400,-1750 - + 450,- 400 + 450,- 450 + 450,-1250 + 450,- 400 - + 450,-1300 + 450,- 400 + 450,-1300 + 400,- 450 - + 450,- 400 + 450,-1300 + 450,- 400 + 450,- 400 - + 450,-1300 + 450,-1250 + 450,- 400 + 450,- 450 - + 400,- 450 + 450,- 400 + 450,- 450 + 400,- 450 - + 450,-1250 + 450,- 450 + 450,- 400 + 450,- 400 - + 450,-1300 + 450,-1250 + 450,-1300 + 400,-1300 - + 450,-1300 + 400,-1300 + 450,-1250 + 450,-1300 - + 450,- 400 + 450,-1300 + 400,-1300 + 450,- 400 - + 450,-1300 + 400,-1300 + 450,-1300 + 400,- 450 - + 450,-1250 + 450,- 450 + 400,- 450 + 450,-1300 - + 400,-1300 + 450,- 400 + 450,- 450 + 450,-1250 - + 450 -Sum: 67700 + -1080850 + +3500,-1650 + + 500,- 400 + 500,- 350 + 500,-1250 + 450,- 400 + + 500,-1250 + 450,- 400 + 500,-1200 + 500,- 400 + + 500,- 350 + 500,-1200 + 500,- 400 + 450,- 400 + + 500,-1200 + 500,-1250 + 450,- 400 + 500,- 350 + + 500,- 400 + 450,- 400 + 500,- 350 + 500,- 400 + + 500,-1200 + 500,- 400 + 450,- 400 + 500,- 350 + + 500,-1250 + 500,-1200 + 500,-1250 + 500,-1250 + + 450,-1250 + 500,-1250 + 500,-1200 + 500,-1250 + + 500,- 350 + 500,-1250 + 500,-1250 + 450,- 400 + + 500,-1200 + 500,-1250 + 500,-1200 + 500,- 350 + + 500,-1250 + 500,- 350 + 500,- 350 + 500,-1250 + + 500,-1250 + 450,- 400 + 500,- 350 + 500,-1250 + + 500 +Duration=67900 us Send Denon -Protocol=Denon Address=0x11 Command=0x76 Raw-Data=0xED1 15 bits LSB first +Protocol=Denon Address=0x11 Command=0x76 Raw-Data=0xED1 15 bits LSB first Duration=23150 us Send with: IrSender.sendDenon(0x11, 0x76, ); rawData[32]: - -1073050 - + 250,-1850 + 250,- 750 + 250,- 800 + 250,- 800 - + 250,-1800 + 250,- 800 + 250,-1800 + 250,-1850 - + 250,- 750 + 300,-1800 + 250,-1800 + 300,-1800 - + 250,- 750 + 300,- 750 + 300,- 750 + 250 -Sum: 23050 + -1078600 + + 300,-1750 + 300,- 750 + 300,- 750 + 300,- 750 + + 300,-1750 + 350,- 700 + 350,-1700 + 350,-1750 + + 300,- 750 + 300,-1750 + 350,-1700 + 350,-1750 + + 300,- 750 + 300,- 750 + 300,- 700 + 350 +Duration=23150 us Send Denon/Sharp variant -Protocol=Sharp Address=0x11 Command=0x76 Raw-Data=0x4ED1 15 bits LSB first -Send with: IrSender.sendSharp(0x11, 0x76, ); +Protocol=Denon Address=0x11 Command=0x76 Raw-Data=0x2ED1 15 bits LSB first Duration=24200 us +Send with: IrSender.sendDenon(0x11, 0x76, ); rawData[32]: - -1018750 - + 300,-1750 + 300,- 750 + 250,- 800 + 250,- 800 - + 250,-1800 + 250,- 800 + 250,-1800 + 300,-1800 - + 250,- 800 + 250,-1800 + 300,-1750 + 300,-1800 - + 250,- 800 + 250,- 750 + 300,-1800 + 250 -Sum: 24100 + -1020800 + + 300,-1750 + 350,- 700 + 350,- 700 + 300,- 750 + + 300,-1750 + 350,- 700 + 350,-1700 + 350,-1750 + + 350,- 700 + 300,-1750 + 350,-1750 + 300,-1750 + + 350,- 700 + 350,-1700 + 350,- 700 + 350 +Duration=24200 us Send Sony/SIRCS with 7 command and 5 address bits -Protocol=Sony Address=0x11 Command=0x76 Raw-Data=0x8F6 12 bits LSB first +Protocol=Sony Address=0x11 Command=0x76 Raw-Data=0x8F6 12 bits LSB first Duration=21050 us Send with: IrSender.sendSony(0x11, 0x76, 2, 12); rawData[26]: - -1020950 - +2400,- 650 - + 550,- 600 +1200,- 550 +1250,- 550 + 650,- 550 - +1250,- 550 +1250,- 600 +1200,- 550 +1200,- 600 - + 650,- 550 + 650,- 550 + 650,- 550 +1200 -Sum: 20950 + -1023000 + +2450,- 550 + + 700,- 500 +1300,- 500 +1250,- 550 + 650,- 550 + +1250,- 550 +1250,- 550 +1250,- 550 +1250,- 550 + + 700,- 500 + 600,- 600 + 650,- 550 +1250 +Duration=21050 us Send Sony/SIRCS with 7 command and 8 address bits -Protocol=Sony Address=0xF1 Command=0x76 Raw-Data=0x78F6 15 bits LSB first +Protocol=Sony Address=0xF1 Command=0x76 Raw-Data=0x78F6 15 bits LSB first Duration=26450 us Send with: IrSender.sendSony(0xF1, 0x76, 2, 15); rawData[32]: - -1032550 - +2400,- 600 - + 600,- 600 +1200,- 600 +1200,- 550 + 650,- 550 - +1200,- 600 +1200,- 650 +1200,- 550 +1200,- 600 - + 650,- 550 + 650,- 550 + 650,- 550 +1200,- 600 - +1200,- 600 +1250,- 600 +1200 -Sum: 26400 + -1038750 + +2450,- 550 + + 700,- 500 +1250,- 550 +1250,- 550 + 650,- 550 + +1250,- 550 +1250,- 550 +1250,- 550 +1250,- 550 + + 650,- 550 + 650,- 550 + 650,- 550 +1250,- 550 + +1250,- 550 +1250,- 550 +1250 +Duration=26450 us + +Send Sony/SIRCS with 7 command and 5 address bits +Protocol=Sony Address=0x11 Command=0x76 Raw-Data=0x8F6 12 bits LSB first Duration=21050 us +Send with: IrSender.sendSony(0x11, 0x76, 2, 12); +rawData[26]: + -1020900 + +2450,- 550 + + 650,- 550 +1250,- 550 +1250,- 550 + 650,- 550 + +1250,- 550 +1250,- 550 +1250,- 550 +1250,- 550 + + 650,- 550 + 650,- 550 + 650,- 550 +1250 +Duration=21050 us + +Send Sony/SIRCS with 7 command and 8 address bits +Protocol=Sony Address=0xF1 Command=0x76 Raw-Data=0x78F6 15 bits LSB first Duration=26450 us +Send with: IrSender.sendSony(0xF1, 0x76, 2, 15); +rawData[32]: + -1036650 + +2450,- 550 + + 650,- 550 +1250,- 550 +1250,- 550 + 650,- 550 + +1250,- 550 +1250,- 550 +1250,- 550 +1250,- 550 + + 650,- 550 + 650,- 550 + 650,- 550 +1250,- 550 + +1250,- 550 +1250,- 550 +1250 +Duration=26450 us Send Sony/SIRCS with 7 command and 13 address bits -Protocol=Sony Address=0x1FF1 Command=0x76 Raw-Data=0xFF8F6 20 bits LSB first +Protocol=Sony Address=0x1FF1 Command=0x76 Raw-Data=0xFF8F6 20 bits LSB first Duration=35400 us Send with: IrSender.sendSony(0x1FF1, 0x76, 2, 20); -rawData[42]: - -1036350 - +2300,- 650 - + 600,- 600 +1200,- 550 +1250,- 550 + 650,- 600 - +1200,- 550 +1250,- 550 +1200,- 600 +1250,- 600 - + 600,- 600 + 600,- 600 + 600,- 550 +1200,- 600 - +1250,- 550 +1250,- 550 +1250,- 550 +1250,- 600 - +1200,- 550 +1200,- 600 +1250,- 600 +1200 -Sum: 35350 - -Send Samsung 8 bit command -Protocol=Samsung Address=0xFFF1 Command=0x76 Raw-Data=0x8976FFF1 32 bits LSB first -Send with: IrSender.sendSamsung(0xFFF1, 0x76, ); -rawData[68]: - -1039650 - +4400,-4450 - + 550,-1700 + 550,- 550 + 600,- 550 + 550,- 550 - + 600,-1650 + 550,-1650 + 600,-1650 + 550,-1650 - + 600,-1650 + 600,-1650 + 600,-1650 + 550,-1650 - + 600,-1650 + 600,-1650 + 550,-1650 + 600,-1650 - + 600,- 550 + 550,-1650 + 600,-1650 + 600,- 550 - + 550,-1650 + 600,-1650 + 550,-1700 + 550,- 550 - + 600,-1650 + 550,- 550 + 600,- 550 + 600,-1600 - + 600,- 550 + 600,- 550 + 550,- 550 + 600,-1650 - + 600 -Sum: 68750 - -Send Samsung 16 bit command -Protocol=Samsung Address=0xFFF1 Command=0x9876 Raw-Data=0x9876FFF1 32 bits LSB first +rawData[42]: + -1040400 + +2400,- 550 + + 650,- 550 +1250,- 550 +1250,- 550 + 650,- 550 + +1250,- 550 +1250,- 550 +1250,- 550 +1250,- 550 + + 650,- 550 + 600,- 600 + 650,- 550 +1250,- 550 + +1250,- 550 +1250,- 550 +1250,- 550 +1250,- 550 + +1250,- 550 +1250,- 550 +1250,- 550 +1250 +Duration=35400 us + +Send Samsung 16 bit command and address +Protocol=Samsung Address=0xFFF1 Command=0x9876 Raw-Data=0x9876FFF1 32 bits LSB first Duration=69000 us Send with: IrSender.sendSamsung(0xFFF1, 0x9876, ); rawData[68]: - -1056350 - +4400,-4400 - + 600,-1650 + 550,- 550 + 600,- 550 + 550,- 550 - + 600,-1650 + 550,-1650 + 600,-1650 + 600,-1600 - + 600,-1650 + 600,-1650 + 600,-1650 + 550,-1650 - + 600,-1650 + 600,-1650 + 550,-1650 + 600,-1650 - + 600,- 500 + 550,-1700 + 600,-1650 + 550,- 550 - + 600,-1650 + 550,-1650 + 600,-1650 + 600,- 550 - + 550,- 550 + 600,- 550 + 550,- 550 + 600,-1650 - + 550,-1650 + 600,- 550 + 600,- 550 + 550,-1650 - + 600 -Sum: 68650 + -1057350 + +4550,-4350 + + 650,-1600 + 650,- 500 + 600,- 500 + 650,- 500 + + 600,-1600 + 650,-1600 + 650,-1600 + 650,-1600 + + 600,-1650 + 600,-1600 + 650,-1600 + 650,-1600 + + 600,-1600 + 650,-1600 + 650,-1600 + 650,-1600 + + 600,- 500 + 650,-1600 + 650,-1600 + 650,- 500 + + 600,-1600 + 650,-1600 + 650,-1600 + 600,- 500 + + 650,- 500 + 650,- 450 + 650,- 500 + 650,-1600 + + 650,-1600 + 600,- 500 + 650,- 500 + 650,-1600 + + 650 +Duration=69000 us Send Samsung48 16 bit command -Protocol=Samsung48 Address=0xFFF1 Command=0x9876 Raw-Data=0x6798 48 bits LSB first +Protocol=Samsung48 Address=0xFFF1 Command=0x9876 Raw-Data=0x6798 48 bits LSB first Duration=95900 us Send with: IrSender.sendSamsung48(0xFFF1, 0x9876, ); rawData[100]: - -1056750 - +4450,-4450 - + 600,-1650 + 600,- 500 + 600,- 550 + 550,- 550 - + 600,-1650 + 600,-1650 + 550,-1650 + 600,-1650 - + 600,-1650 + 550,-1650 + 600,-1650 + 600,-1650 - + 550,-1650 + 550,-1700 + 550,-1700 + 550,-1650 - + 600,- 550 + 550,-1700 + 550,-1650 + 600,- 550 - + 550,-1650 + 600,-1650 + 600,-1650 + 600,- 500 - + 600,-1650 + 600,- 500 + 600,- 550 + 600,-1650 - + 550,- 550 + 600,- 550 + 550,- 550 + 550,-1700 - + 600,- 550 + 600,- 500 + 600,- 550 + 600,-1650 - + 550,-1650 + 600,- 550 + 550,- 550 + 600,-1650 - + 600,-1650 + 550,-1650 + 600,-1650 + 600,- 550 - + 550,- 550 + 600,-1650 + 550,-1650 + 600,- 550 - + 550 -Sum: 95650 + -1039600 + +4550,-4400 + + 600,-1600 + 650,- 500 + 650,- 450 + 650,- 500 + + 600,-1650 + 600,-1600 + 650,-1600 + 650,-1600 + + 600,-1600 + 650,-1600 + 650,-1600 + 650,-1600 + + 650,-1600 + 600,-1600 + 650,-1600 + 650,-1600 + + 650,- 500 + 600,-1600 + 650,-1600 + 650,- 500 + + 600,-1600 + 650,-1600 + 650,-1600 + 650,- 500 + + 600,-1600 + 650,- 500 + 650,- 500 + 600,-1600 + + 600,- 550 + 600,- 500 + 650,- 500 + 600,-1650 + + 650,- 500 + 600,- 500 + 650,- 500 + 600,-1600 + + 650,-1600 + 650,- 500 + 600,- 500 + 650,-1600 + + 650,-1600 + 600,-1650 + 600,-1600 + 650,- 500 + + 600,- 500 + 650,-1600 + 650,-1600 + 650,- 450 + + 650 +Duration=95900 us Send RC5 -Protocol=RC5 Address=0x11 Command=0x36 Raw-Data=0x1476 13 bits MSB first +Protocol=RC5 Address=0x11 Command=0x36 Raw-Data=0x1476 13 bits MSB first Duration=23200 us Send with: IrSender.sendRC5(0x11, 0x36, ); rawData[20]: - -1073300 - + 900,- 900 - +1750,-1800 +1750,- 900 + 900,- 850 + 900,-1750 - + 900,- 900 + 900,- 850 +1800,-1800 + 900,- 850 - +1800 -Sum: 23100 + -1078850 + + 950,- 850 + +1850,-1700 +1800,- 850 + 950,- 850 + 950,-1700 + + 950,- 850 + 950,- 800 +1850,-1700 + 950,- 850 + +1850 +Duration=23200 us Send RC5X with 7.th MSB of command set -Protocol=RC5 Address=0x11 Command=0x76 Toggle=1 Raw-Data=0xC76 13 bits MSB first +Protocol=RC5 Address=0x11 Command=0x76 Toggle=1 Raw-Data=0xC76 13 bits MSB first Duration=23150 us Send with: IrSender.sendRC5(0x11, 0x76, ); rawData[20]: - -1031250 - +1800,-1750 - + 850,- 900 +1800,- 850 + 900,- 900 + 900,-1750 - + 900,- 900 + 850,- 900 +1750,-1800 + 900,- 850 - +1800 -Sum: 23050 + -1037700 + +1850,-1700 + + 950,- 850 +1800,- 850 + 950,- 800 + 950,-1750 + + 950,- 800 + 950,- 850 +1800,-1750 + 950,- 800 + +1850 +Duration=23150 us Send RC6 -Protocol=RC6 Address=0xF1 Command=0x76 Raw-Data=0xF176 20 bits MSB first +Protocol=RC6 Address=0xF1 Command=0x76 Raw-Data=0xF176 20 bits MSB first Duration=23300 us Send with: IrSender.sendRC6(0xF1, 0x76, ); rawData[36]: - -1028550 - +2650,- 900 - + 450,- 900 + 450,- 450 + 450,- 450 + 450,- 850 - +1350,- 450 + 450,- 450 + 450,- 450 + 450,- 900 - + 450,- 450 + 450,- 450 + 900,- 900 + 900,- 450 - + 450,- 450 + 450,- 900 + 850,- 450 + 450,- 900 - + 450 -Sum: 23250 + -1035050 + +2700,- 800 + + 500,- 850 + 500,- 400 + 500,- 400 + 500,- 850 + +1400,- 350 + 500,- 400 + 500,- 400 + 500,- 850 + + 500,- 400 + 500,- 400 + 950,- 850 + 950,- 400 + + 500,- 400 + 500,- 850 + 950,- 400 + 500,- 850 + + 500 +Duration=23300 us + +Send RC6A with 14 bit 0x2711 as extra +Protocol=RC6A Address=0xF1 Command=0x76 Extra=0x2711 Toggle=1 Raw-Data=0xA711F176 35 bits MSB first Duration=36800 us +Send with: IrSender.sendRC6A(0xF1, 0x76, , 0x2711); +rawData[58]: + -1045150 + +2700,- 800 + + 500,- 400 + 500,- 450 + 450,- 900 +1350,-1300 + + 950,- 850 + 500,- 400 + 900,- 400 + 500,- 450 + + 450,- 850 + 500,- 400 + 500,- 400 + 950,- 850 + + 500,- 400 + 500,- 400 +1000,- 400 + 450,- 400 + + 500,- 450 + 500,- 400 + 450,- 850 + 500,- 400 + + 500,- 400 +1000,- 800 +1000,- 400 + 450,- 450 + + 450,- 850 + 950,- 400 + 500,- 850 + 500 +Duration=36800 us + +Send Bang&Olufsen +- ENABLE_BEO_WITHOUT_FRAME_GAP is enabled +- Now print raw data and try to decode the first 6 entries, which results in rawData 0x0 +rawData[36]: + -1033000 + + 250,-2850 + + 250,-2850 + 250,-15250 + 250,-2850 + 250,-9050 + + 250,-6000 + 200,-5950 + 250,-6000 + 200,-2900 + + 250,-5950 + 200,-6000 + 200,-9050 + 250,-2900 + + 250,-9000 + 250,-6000 + 250,-5950 + 250,-2850 + + 250 +Duration=105700 us +Protocol=Bang&Olufsen Address=0x0 Command=0x0 Raw-Data=0x0 0 bits MSB first + +- Remove trailing 6 entries, which is equivalent to define RECORD_GAP_MICROS < 15000, to enable successful B&O decode +Protocol=Bang&Olufsen Address=0xF1 Command=0x76 Raw-Data=0xF176 16 bits MSB first Duration=115000 us +Send with: IrSender.sendBang&Olufsen(0xF1, 0x76, ); +rawData[38]: + -15250 + + 250,-2850 + + 250,-9050 + 250,-6000 + 200,-5950 + 250,-6000 + + 200,-2900 + 250,-5950 + 200,-6000 + 200,-9050 + + 250,-2900 + 250,-9000 + 250,-6000 + 250,-5950 + + 250,-2850 + 250,-9100 + 200,-5950 + 250,-2900 + + 200,-12150 + 250 +Duration=115000 us + +Send MagiQuest +Protocol=MagiQuest Address=0xFFF1 Command=0x76 Raw-Data=0x6BCDFFF1 56 bits MSB first Duration=63900 us +Send with: IrSender.sendMagiQuest(0x6BCDFFF1, 0x76, ); +rawData[112]: + -1089250 + + 350,- 800 + 350,- 800 + 350,- 800 + 350,- 800 + + 350,- 800 + 350,- 800 + 350,- 800 + 350,- 850 + + 600,- 550 + 600,- 550 + 350,- 800 + 600,- 550 + + 350,- 750 + 650,- 500 + 650,- 500 + 650,- 500 + + 650,- 500 + 300,- 850 + 350,- 800 + 650,- 500 + + 650,- 500 + 350,- 800 + 650,- 500 + 650,- 500 + + 650,- 500 + 650,- 500 + 650,- 500 + 650,- 500 + + 650,- 500 + 650,- 500 + 650,- 500 + 650,- 500 + + 650,- 500 + 650,- 500 + 650,- 500 + 350,- 800 + + 350,- 800 + 350,- 800 + 650,- 550 + 300,- 800 + + 350,- 800 + 650,- 500 + 650,- 500 + 650,- 500 + + 350,- 800 + 650,- 500 + 650,- 500 + 350,- 850 + + 350,- 750 + 350,- 800 + 650,- 500 + 650,- 500 + + 350,- 800 + 650,- 500 + 650,- 500 + 650 +Duration=63900 us + +Send next protocols with IrSender.write Send JVC -Protocol=JVC Address=0xF1 Command=0x76 Raw-Data=0x76F1 16 bits LSB first +Protocol=JVC Address=0xF1 Command=0x76 Raw-Data=0x76F1 16 bits LSB first Duration=40400 us Send with: IrSender.sendJVC(0xF1, 0x76, ); rawData[36]: - -1037050 - +8400,-4150 - + 500,-1600 + 550,- 500 + 500,- 550 + 550,- 500 - + 550,-1550 + 550,-1550 + 500,-1600 + 550,-1550 - + 550,- 500 + 550,-1550 + 550,-1550 + 500,- 550 - + 550,-1550 + 550,-1550 + 550,-1550 + 550,- 500 - + 550 -Sum: 40400 - -Send Samsung -Protocol=Samsung Address=0xFFF1 Command=0x9876 Raw-Data=0x9876FFF1 32 bits LSB first -Send with: IrSender.sendSamsung(0xFFF1, 0x9876, ); -rawData[68]: - -1036350 - +4450,-4400 - + 550,-1700 + 600,- 550 + 550,- 550 + 600,- 550 - + 550,-1650 + 600,-1650 + 600,-1650 + 550,-1650 - + 550,-1700 + 600,-1650 + 550,-1650 + 600,-1650 - + 600,-1650 + 550,-1650 + 600,-1650 + 600,-1650 - + 550,- 550 + 600,-1650 + 550,-1700 + 550,- 550 - + 600,-1650 + 600,-1650 + 550,-1650 + 600,- 550 - + 550,- 550 + 600,- 550 + 550,- 550 + 600,-1650 - + 550,-1650 + 600,- 550 + 600,- 500 + 600,-1700 - + 550 -Sum: 68750 + -1087300 + +8400,-4100 + + 600,-1500 + 600,- 450 + 600,- 450 + 600,- 450 + + 600,-1500 + 600,-1500 + 600,-1500 + 600,-1500 + + 600,- 450 + 600,-1500 + 600,-1500 + 600,- 450 + + 600,-1500 + 600,-1500 + 600,-1500 + 600,- 450 + + 600 +Duration=40400 us Send LG -Protocol=LG Address=0xF1 Command=0x9876 Raw-Data=0xF19876E 28 bits MSB first +Protocol=LG Address=0xF1 Command=0x9876 Raw-Data=0xF19876E 28 bits MSB first Duration=59450 us Send with: IrSender.sendLG(0xF1, 0x9876, ); rawData[60]: - -1054900 + -1041500 +9000,-4150 - + 450,-1600 + 500,-1550 + 500,-1550 + 500,-1600 - + 500,- 550 + 500,- 550 + 500,- 550 + 500,-1550 - + 500,-1600 + 500,- 550 + 500,- 550 + 450,-1600 - + 500,-1600 + 500,- 550 + 500,- 550 + 500,- 550 - + 500,- 550 + 500,-1550 + 500,-1550 + 550,-1550 - + 500,- 550 + 500,-1550 + 500,-1600 + 500,- 550 - + 500,-1550 + 500,-1550 + 500,-1600 + 500,- 550 - + 500 -Sum: 59350 - -Send MagiQuest -Protocol=MagiQuest Address=0xFFF1 Command=0x76 Raw-Data=0x6BCDFFF1 56 bits MSB first -Send with: IrSender.sendMagiQuest(0x6BCDFFF1, 0x76, ); -rawData[112]: - -1049950 - + 250,- 850 + 250,- 900 + 250,- 900 + 250,- 900 - + 250,- 900 + 300,- 850 + 250,- 900 + 250,- 900 - + 600,- 550 + 600,- 550 + 300,- 850 + 550,- 600 - + 250,- 900 + 550,- 600 + 550,- 600 + 550,- 600 - + 550,- 600 + 300,- 850 + 250,- 900 + 550,- 600 - + 550,- 600 + 300,- 850 + 550,- 600 + 550,- 600 - + 550,- 600 + 550,- 600 + 550,- 600 + 550,- 600 - + 550,- 600 + 550,- 600 + 550,- 600 + 550,- 600 - + 550,- 600 + 550,- 600 + 600,- 550 + 300,- 900 - + 250,- 900 + 250,- 900 + 550,- 550 + 300,- 850 - + 250,- 900 + 550,- 600 + 550,- 600 + 550,- 600 - + 300,- 850 + 550,- 600 + 550,- 600 + 250,- 900 - + 300,- 850 + 300,- 850 + 600,- 550 + 550,- 600 - + 300,- 850 + 550,- 600 + 550,- 600 + 550 -Sum: 63750 - -Send Bang&Olufsen -Protocol=Bang&Olufsen Address=0xF1 Command=0x76 Raw-Data=0xF176 16 bits MSB first -Send with: IrSender.sendBang&Olufsen(0xF1, 0x76, ); -rawData[44]: - -1078450 - + 150,-2850 - + 200,-2900 + 200,-15300 + 200,-2900 + 200,-9100 - + 250,-5950 + 250,-5950 + 250,-5950 + 200,-2900 - + 200,-6000 + 200,-6000 + 200,-9100 + 200,-2900 - + 200,-9100 + 250,-5950 + 250,-5950 + 250,-2850 - + 200,-9100 + 250,-5950 + 250,-2850 + 200,-12200 - + 200 -Sum: 136500 + + 500,-1550 + 550,-1500 + 550,-1550 + 550,-1500 + + 550,- 500 + 550,- 500 + 550,- 500 + 550,-1550 + + 550,-1500 + 550,- 500 + 550,- 500 + 550,-1550 + + 550,-1500 + 550,- 500 + 550,- 500 + 550,- 500 + + 550,- 500 + 600,-1500 + 550,-1500 + 550,-1550 + + 550,- 500 + 550,-1500 + 550,-1550 + 550,- 500 + + 550,-1500 + 550,-1550 + 500,-1550 + 550,- 500 + + 550 +Duration=59450 us Send Bosewave with no address and 8 command bits -Protocol=BoseWave Address=0x0 Command=0x76 Raw-Data=0x8976 16 bits LSB first +Protocol=BoseWave Address=0x0 Command=0x76 Raw-Data=0x8976 16 bits LSB first Duration=26800 us Send with: IrSender.sendBoseWave(0x0, 0x76, ); rawData[36]: - -1044750 + -1058350 +1050,-1450 - + 550,- 450 + 550,-1400 + 550,-1450 + 550,- 450 - + 500,-1450 + 550,-1450 + 500,-1450 + 550,- 450 - + 550,-1400 + 550,- 450 + 550,- 450 + 550,-1450 - + 500,- 500 + 500,- 450 + 550,- 450 + 550,-1450 - + 500 -Sum: 26750 + + 550,- 400 + 600,-1400 + 550,-1400 + 600,- 400 + + 600,-1400 + 550,-1400 + 600,-1400 + 600,- 400 + + 550,-1400 + 600,- 400 + 600,- 400 + 600,-1400 + + 550,- 400 + 600,- 400 + 600,- 400 + 600,-1400 + + 550 +Duration=26800 us Send FAST -Protocol=FAST Address=0x0 Command=0x76 Raw-Data=0x8976 16 bits LSB first +Protocol=FAST Address=0x0 Command=0x76 Raw-Data=0x8976 16 bits LSB first Duration=28900 us Send with: IrSender.sendFAST(0x0, 0x76, ); rawData[36]: - -1036750 - +2100,-1050 - + 550,- 500 + 550,-1550 + 550,-1550 + 550,- 500 + -1042350 + +2150,-1000 + + 550,- 500 + 600,-1500 + 550,-1550 + 550,- 500 + 550,-1550 + 550,-1550 + 550,-1550 + 550,- 500 - + 550,-1550 + 550,- 500 + 550,- 500 + 550,-1550 - + 550,- 500 + 550,- 500 + 550,- 500 + 550,-1550 + + 550,-1550 + 550,- 500 + 550,- 500 + 600,-1500 + + 550,- 500 + 550,- 500 + 600,- 450 + 550,-1550 + 550 -Sum: 28900 +Duration=28900 us -Force buffer overflow by sending 280 marks and spaces +Force buffer overflow by sending 450 marks and spaces Overflow -Try to increase the "RAW_BUFFER_LENGTH" value of 150 in ../src/UnitTest.cpp -rawData[150]: - -1040000 - + 250,- 500 - + 200,- 600 + 200,- 550 + 200,- 500 + 200,- 550 - + 200,- 550 + 250,- 500 + 250,- 550 + 200,- 550 - + 250,- 500 + 200,- 550 + 200,- 550 + 200,- 550 - + 200,- 550 + 200,- 550 + 200,- 550 + 200,-1300 - + 200,- 550 + 200,- 550 + 200,- 550 + 200,- 550 - + 200,- 550 + 200,- 550 + 200,- 550 + 200,- 550 - + 200,- 550 + 200,- 550 + 250,- 500 + 200,- 550 - + 200,- 550 + 200,- 550 + 200,- 550 + 200,- 550 - + 200,- 550 + 200,- 550 + 200,- 550 + 200,- 550 - + 200,- 550 + 200,- 550 + 200,- 500 + 250,- 550 - + 200,- 550 + 200,- 550 + 200,- 550 + 200,- 550 - + 200,- 500 + 250,- 550 + 200,- 550 + 200,- 550 - + 200,- 550 + 200,- 550 + 200,- 550 + 200,- 550 - + 200,- 550 + 200,- 550 + 200,- 550 + 200,- 550 - + 200,- 550 + 200,- 550 + 200,- 550 + 200,- 550 - + 200,- 550 + 250,- 500 + 200,- 550 + 200,- 550 - + 200,- 550 + 200,- 500 + 250,- 550 + 200,- 500 - + 250,- 550 + 200,- 550 + 250,- 500 + 200,- 550 - + 200,- 550 + 200 -Sum: 56500 +Try to increase the "RAW_BUFFER_LENGTH" value of 400 in ../src/UnitTest.cpp +rawData[400]: + -1041550 + + 300,- 500 + + 250,- 500 + 250,- 550 + 200,- 500 + 250,- 550 + + 200,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 550 + 200,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250,- 500 + 250,- 500 + + 250,- 500 + 250,- 500 + 250 +Duration=149550 us ERROR: Unknown protocol +Stop receiver +Start receiver address=0xF2 command=0x87 -Send NEC with 8 bit address -Protocol=NEC Address=0xF2 Command=0x87 Raw-Data=0x78870DF2 32 bits LSB first +Send NEC with 8 bit address and complete NEC frames as repeats to force decoding as NEC2 +Protocol=NEC Address=0xF2 Command=0x87 Raw-Data=0x78870DF2 32 bits LSB first Duration=67850 us Send with: IrSender.sendNEC(0xF2, 0x87, ); rawData[68]: - -3276750 - +8850,-4500 - + 550,- 500 + 600,-1650 + 600,- 500 + 600,- 550 + -1028850 + +8900,-4400 + + 650,- 500 + 650,-1600 + 600,- 500 + 600,- 550 + + 600,-1650 + 600,-1600 + 650,-1600 + 650,-1600 + + 650,-1600 + 650,- 450 + 650,-1600 + 650,-1600 + + 650,- 500 + 600,- 500 + 650,- 500 + 600,- 500 + + 650,-1600 + 650,-1600 + 650,-1600 + 650,- 450 + + 650,- 500 + 600,- 500 + 650,- 500 + 600,-1600 + + 650,- 500 + 650,- 500 + 600,- 500 + 650,-1600 + + 650,-1600 + 650,-1600 + 600,-1650 + 600,- 500 + + 650 +Duration=67850 us + +Protocol=NEC2 Address=0xF2 Command=0x87 Repeat gap=67950us Raw-Data=0x78870DF2 32 bits LSB first Duration=67900 us +Send with: IrSender.sendNEC2(0xF2, 0x87, ); +rawData[68]: + -67950 + +8950,-4400 + + 600,- 550 + 600,-1650 + 600,- 500 + 600,- 550 + 600,-1600 + 600,-1650 + 600,-1650 + 600,-1650 - + 600,-1600 + 600,- 550 + 600,-1650 + 550,-1650 - + 600,- 550 + 550,- 550 + 600,- 550 + 550,- 550 - + 600,-1650 + 600,-1600 + 600,-1650 + 600,- 550 - + 550,- 550 + 600,- 550 + 550,- 550 + 600,-1650 - + 600,- 500 + 550,- 600 + 550,- 550 + 600,-1650 - + 550,-1700 + 550,-1650 + 600,-1650 + 600,- 500 - + 600 -Sum: 67600 + + 600,-1650 + 600,- 550 + 600,-1600 + 600,-1650 + + 600,- 550 + 600,- 500 + 600,- 550 + 600,- 500 + + 600,-1650 + 600,-1650 + 600,-1650 + 600,- 500 + + 600,- 550 + 600,- 500 + 600,- 550 + 600,-1650 + + 600,- 500 + 600,- 550 + 600,- 500 + 600,-1650 + + 600,-1650 + 650,-1600 + 650,-1600 + 600,- 500 + + 650 +Duration=67900 us Send NEC with 16 bit address -Protocol=NEC Address=0xF2 Command=0x87 Raw-Data=0x78870DF2 32 bits LSB first +Protocol=NEC Address=0xF2 Command=0x87 Raw-Data=0x78870DF2 32 bits LSB first Duration=67800 us Send with: IrSender.sendNEC(0xF2, 0x87, ); rawData[68]: - -998700 - +8900,-4400 - + 600,- 500 + 600,-1650 + 600,- 550 + 600,- 500 - + 600,-1650 + 600,-1600 + 600,-1650 + 600,-1650 - + 600,-1600 + 650,- 500 + 600,-1650 + 600,-1600 - + 600,- 550 + 600,- 500 + 600,- 550 + 600,- 500 - + 600,-1650 + 600,-1650 + 600,-1600 + 650,- 500 - + 600,- 500 + 600,- 550 + 600,- 500 + 600,-1650 - + 600,- 500 + 650,- 500 + 600,- 500 + 650,-1600 - + 600,-1650 + 600,-1650 + 600,-1600 + 650,- 500 - + 600 -Sum: 67650 + -1062200 + +8950,-4400 + + 600,- 500 + 650,-1600 + 650,- 450 + 650,- 500 + + 650,-1600 + 600,-1600 + 650,-1600 + 650,-1600 + + 650,-1600 + 600,- 500 + 650,-1600 + 650,-1600 + + 650,- 500 + 600,- 500 + 650,- 500 + 600,- 500 + + 650,-1600 + 650,-1600 + 600,-1650 + 600,- 500 + + 650,- 450 + 650,- 500 + 650,- 500 + 600,-1600 + + 650,- 500 + 600,- 500 + 650,- 500 + 600,-1600 + + 650,-1600 + 650,-1600 + 600,-1650 + 600,- 500 + + 650 +Duration=67800 us Send NEC2 with 16 bit address -Protocol=NEC Address=0xF2 Command=0x87 Raw-Data=0x78870DF2 32 bits LSB first +Protocol=NEC Address=0xF2 Command=0x87 Raw-Data=0x78870DF2 32 bits LSB first Duration=67850 us Send with: IrSender.sendNEC(0xF2, 0x87, ); rawData[68]: - -1055100 + -1060650 +8950,-4400 - + 600,- 500 + 650,-1600 + 650,- 500 + 600,- 500 - + 650,-1600 + 650,-1600 + 650,-1600 + 600,-1600 - + 650,-1600 + 650,- 500 + 650,-1600 + 600,-1600 - + 650,- 500 + 600,- 500 + 650,- 500 + 600,- 500 - + 650,-1600 + 600,-1650 + 600,-1650 + 600,- 500 - + 650,- 500 + 600,- 500 + 650,- 500 + 600,-1650 - + 600,- 500 + 600,- 550 + 600,- 500 + 600,-1650 - + 600,-1650 + 600,-1650 + 600,-1650 + 600,- 500 - + 600 -Sum: 67800 + + 650,- 500 + 600,-1650 + 600,- 500 + 650,- 500 + + 600,-1600 + 650,-1600 + 650,-1600 + 650,-1600 + + 600,-1650 + 600,- 500 + 650,-1600 + 600,-1600 + + 650,- 500 + 650,- 500 + 600,- 500 + 650,- 500 + + 600,-1600 + 650,-1600 + 650,-1600 + 650,- 500 + + 600,- 500 + 650,- 500 + 600,- 500 + 650,-1600 + + 650,- 500 + 600,- 500 + 650,- 500 + 600,-1600 + + 650,-1600 + 650,-1600 + 650,-1600 + 600,- 500 + + 650 +Duration=67850 us Send Onkyo (NEC with 16 bit command) -Protocol=Onkyo Address=0xF2 Command=0x8887 Raw-Data=0x888700F2 32 bits LSB first +Protocol=Onkyo Address=0xF2 Command=0x8887 Raw-Data=0x888700F2 32 bits LSB first Duration=62250 us Send with: IrSender.sendOnkyo(0xF2, 0x8887, ); rawData[68]: - -1053400 - +8850,-4400 - + 600,- 550 + 600,-1650 + 600,- 500 + 600,- 550 - + 600,-1600 + 600,-1650 + 600,-1650 + 550,-1650 - + 600,- 550 + 550,- 550 + 650,- 500 + 550,- 550 - + 600,- 550 + 600,- 500 + 600,- 550 + 550,- 550 - + 600,-1650 + 550,-1650 + 600,-1650 + 600,- 550 - + 550,- 550 + 600,- 550 + 550,- 550 + 600,-1650 - + 600,- 500 + 600,- 550 + 550,- 550 + 600,-1650 - + 600,- 500 + 600,- 550 + 600,- 500 + 600,-1650 + -1061250 + +8950,-4400 + + 650,- 500 + 600,-1600 + 650,- 500 + 650,- 500 + + 600,-1600 + 650,-1600 + 600,-1650 + 600,-1600 + + 650,- 500 + 600,- 500 + 650,- 500 + 600,- 500 + + 650,- 500 + 600,- 500 + 650,- 500 + 600,- 500 + + 650,-1600 + 650,-1600 + 650,-1600 + 650,- 450 + + 650,- 500 + 600,- 500 + 650,- 500 + 650,-1600 + + 600,- 500 + 650,- 500 + 650,- 450 + 650,-1600 + + 650,- 500 + 650,- 450 + 650,- 500 + 650,-1600 + 600 -Sum: 62050 +Duration=62250 us Send Apple -Protocol=Apple Address=0xF2 Command=0x87 Raw-Data=0xF28787EE 32 bits LSB first +Protocol=Apple Address=0xF2 Command=0x87 Raw-Data=0xF28787EE 32 bits LSB first Duration=71150 us Send with: IrSender.sendApple(0xF2, 0x87, ); rawData[68]: - -1054100 - +8900,-4450 - + 550,- 550 + 600,-1650 + 600,-1650 + 600,-1650 - + 550,- 550 + 600,-1650 + 550,-1650 + 600,-1650 - + 600,-1650 + 600,-1650 + 550,-1650 + 600,- 550 - + 600,- 500 + 600,- 600 + 550,- 500 + 600,-1650 - + 600,-1650 + 550,-1650 + 600,-1650 + 600,- 500 - + 600,- 550 + 600,- 500 + 600,- 550 + 600,-1650 - + 550,- 550 + 600,-1650 + 550,- 550 + 600,- 550 - + 550,-1650 + 600,-1650 + 600,-1650 + 550,-1650 - + 600 -Sum: 71000 + -1059700 + +8950,-4400 + + 600,- 500 + 650,-1600 + 650,-1600 + 650,-1550 + + 650,- 500 + 650,-1600 + 650,-1600 + 600,-1600 + + 650,-1600 + 650,-1600 + 600,-1600 + 650,- 500 + + 600,- 500 + 650,- 500 + 600,- 500 + 650,-1600 + + 650,-1600 + 650,-1600 + 600,-1600 + 650,- 500 + + 650,- 500 + 600,- 500 + 650,- 500 + 600,-1650 + + 600,- 500 + 650,-1600 + 650,- 500 + 600,- 500 + + 650,-1600 + 650,-1600 + 600,-1600 + 650,-1600 + + 650 +Duration=71150 us + +Send Panasonic +Protocol=Panasonic Address=0xF2 Command=0x87 Raw-Data=0xA8870F20 48 bits LSB first Duration=59250 us +Send with: IrSender.sendPanasonic(0xF2, 0x87, ); +rawData[100]: + -1059850 + +3500,-1650 + + 500,- 350 + 500,-1250 + 500,- 350 + 500,- 400 + + 450,- 400 + 500,- 350 + 500,- 400 + 450,- 400 + + 500,- 350 + 500,- 400 + 450,- 400 + 500,- 350 + + 500,- 400 + 500,-1200 + 500,- 400 + 450,- 400 + + 500,- 350 + 500,- 400 + 450,- 400 + 500,- 350 + + 500,- 400 + 500,-1200 + 500,- 400 + 450,- 400 + + 500,-1200 + 500,-1250 + 450,-1250 + 500,-1250 + + 450,- 400 + 500,- 350 + 500,- 400 + 450,- 400 + + 500,-1250 + 450,-1250 + 500,-1250 + 450,- 400 + + 500,- 350 + 500,- 400 + 500,- 350 + 500,-1250 + + 450,- 400 + 500,- 350 + 500,- 400 + 450,-1250 + + 500,- 350 + 500,-1250 + 500,- 350 + 500,-1200 + + 500 +Duration=59250 us + +Send Kaseikyo with 0x4711 as Vendor ID +Protocol=Kaseikyo Address=0xF2 Command=0x87 Extra=0x4711 Raw-Data=0xAB870F23 48 bits LSB first Duration=66200 us +Send with: IrSender.sendKaseikyo(0xF2, 0x87, , 0x4711); +rawData[100]: + -1079850 + +3450,-1700 + + 500,-1200 + 500,- 400 + 450,- 400 + 500,- 400 + + 450,-1250 + 500,- 350 + 500,- 400 + 500,- 350 + + 500,-1250 + 450,-1250 + 500,-1250 + 450,- 400 + + 500,- 350 + 500,- 400 + 450,-1250 + 500,- 350 + + 500,-1250 + 500,-1250 + 450,- 400 + 500,- 350 + + 500,- 400 + 450,-1250 + 500,- 400 + 450,- 400 + + 500,-1200 + 500,-1250 + 450,-1250 + 500,-1250 + + 450,- 400 + 500,- 350 + 500,- 400 + 500,- 400 + + 450,-1250 + 500,-1250 + 450,-1250 + 500,- 400 + + 450,- 400 + 500,- 350 + 500,- 400 + 450,-1250 + + 500,-1250 + 450,-1250 + 500,- 400 + 450,-1250 + + 500,- 400 + 450,-1250 + 500,- 350 + 500,-1250 + + 500 +Duration=66200 us + +Send Kaseikyo_Denon variant +Protocol=Kaseikyo_Denon Address=0xF2 Command=0x87 Raw-Data=0xA8870F20 48 bits LSB first Duration=62750 us +Send with: IrSender.sendKaseikyo_Denon(0xF2, 0x87, ); +rawData[100]: + -1080600 + +3500,-1650 + + 500,- 350 + 500,- 400 + 500,-1200 + 500,- 400 + + 450,-1250 + 500,- 350 + 500,-1250 + 500,- 350 + + 500,- 400 + 500,-1200 + 500,- 400 + 450,- 400 + + 500,-1250 + 450,-1250 + 500,- 350 + 500,- 400 + + 500,- 350 + 500,- 350 + 500,- 400 + 500,- 350 + + 500,- 400 + 450,-1250 + 500,- 350 + 500,- 400 + + 450,-1250 + 500,-1250 + 450,-1250 + 500,-1250 + + 450,- 400 + 500,- 350 + 500,- 400 + 500,- 400 + + 450,-1250 + 500,-1250 + 450,-1250 + 500,- 400 + + 450,- 400 + 500,- 350 + 500,- 400 + 450,-1250 + + 500,- 400 + 450,- 400 + 500,- 350 + 500,-1250 + + 450,- 400 + 500,-1250 + 450,- 400 + 500,-1200 + + 500 +Duration=62750 us + +Send Denon +Protocol=Denon Address=0x12 Command=0x87 Raw-Data=0x10F2 15 bits LSB first Duration=22150 us +Send with: IrSender.sendDenon(0x12, 0x87, ); +rawData[32]: + -1078350 + + 350,- 700 + 300,-1750 + 350,- 700 + 350,- 700 + + 350,-1700 + 350,-1750 + 300,-1750 + 350,-1750 + + 300,- 750 + 300,- 700 + 350,- 700 + 350,- 700 + + 300,-1750 + 350,- 700 + 350,- 700 + 350 +Duration=22150 us + +Send Denon/Sharp variant +Protocol=Denon Address=0x12 Command=0x87 Raw-Data=0x30F2 15 bits LSB first Duration=23200 us +Send with: IrSender.sendDenon(0x12, 0x87, ); +rawData[32]: + -1020850 + + 350,- 700 + 350,-1750 + 300,- 700 + 350,- 700 + + 350,-1750 + 300,-1750 + 350,-1700 + 350,-1750 + + 300,- 750 + 300,- 750 + 300,- 700 + 350,- 700 + + 350,-1750 + 300,-1750 + 350,- 700 + 350 +Duration=23200 us + +Send Sony/SIRCS with 7 command and 5 address bits +Protocol=Sony Address=0x12 Command=0x7 Raw-Data=0x907 12 bits LSB first Duration=19850 us +Send with: IrSender.sendSony(0x12, 0x7, 2, 12); +rawData[26]: + -1022950 + +2450,- 550 + +1250,- 550 +1250,- 550 +1250,- 550 + 650,- 550 + + 650,- 550 + 650,- 550 + 650,- 550 + 650,- 550 + +1250,- 550 + 650,- 550 + 650,- 550 +1250 +Duration=19850 us + + diff --git a/examples/UnitTest/UnitTest_64bit.log b/examples/UnitTest/UnitTest_64bit.log index e69f1c73b..7def9abbc 100644 --- a/examples/UnitTest/UnitTest_64bit.log +++ b/examples/UnitTest/UnitTest_64bit.log @@ -12,7 +12,7 @@ address=0xFFF1 command=0x76 Send NEC with 8 bit address Protocol=NEC Address=0xF1 Command=0x76 Raw-Data=0x89760EF1 32 bits LSB first Send with: IrSender.sendNEC(0xF1, 0x76, ); -rawData[68]: +rawData[68]: -1050650 +9050,-4450 + 650,-1600 + 700,- 450 + 650,- 500 + 650,- 450 @@ -29,7 +29,7 @@ Sum: 68500 Send NEC with 16 bit address Protocol=NEC Address=0xFFF1 Command=0x76 Raw-Data=0x8976FFF1 32 bits LSB first Send with: IrSender.sendNEC(0xFFF1, 0x76, ); -rawData[68]: +rawData[68]: -1060200 +9050,-4400 + 650,-1600 + 650,- 500 + 650,- 450 + 700,- 450 @@ -46,7 +46,7 @@ Sum: 74050 Send NEC2 with 16 bit address Protocol=NEC Address=0xFFF1 Command=0x76 Raw-Data=0x8976FFF1 32 bits LSB first Send with: IrSender.sendNEC(0xFFF1, 0x76, ); -rawData[68]: +rawData[68]: -1060450 +9050,-4450 + 650,-1600 + 650,- 500 + 650,- 450 + 650,- 500 @@ -63,7 +63,7 @@ Sum: 74150 Send NEC Pronto data with 8 bit address 0x80 and command 0x45 and no repeats Protocol=NEC Address=0x80 Command=0x45 Raw-Data=0xBA457F80 32 bits LSB first Send with: IrSender.sendNEC(0x80, 0x45, ); -rawData[68]: +rawData[68]: -1065600 +9200,-4400 + 700,- 450 + 700,- 450 + 700,- 500 + 650,- 500 @@ -80,7 +80,7 @@ Sum: 68800 Send NEC sendRaw data with 8 bit address=0xFB04 and command 0x08 and exact timing (16 bit array format) Protocol=NEC Address=0x4 Command=0x8 Raw-Data=0xF708FB04 32 bits LSB first Send with: IrSender.sendNEC(0x4, 0x8, ); -rawData[68]: +rawData[68]: -1066550 +9150,-4400 + 650,- 500 + 650,- 450 + 700,-1600 + 650,- 450 @@ -97,7 +97,7 @@ Sum: 68700 Send ONKYO with 16 bit address 0x0102 and 16 bit command 0x0304 with NECRaw(0x03040102) Protocol=Onkyo Address=0x102 Command=0x304 Raw-Data=0x3040102 32 bits LSB first Send with: IrSender.sendOnkyo(0x102, 0x304, ); -rawData[68]: +rawData[68]: -1064800 +9050,-4450 + 650,- 450 + 650,-1600 + 700,- 450 + 650,- 500 @@ -114,7 +114,7 @@ Sum: 56050 Send ONKYO with 16 bit address 0x0102 and command 0x34 with old 32 bit format MSB first (0x40802CD3) Protocol=NEC Address=0x102 Command=0x34 Raw-Data=0xCB340102 32 bits LSB first Send with: IrSender.sendNEC(0x102, 0x34, ); -rawData[68]: +rawData[68]: -1066900 +9050,-4400 + 650,- 500 + 650,-1600 + 650,- 500 + 650,- 450 @@ -131,7 +131,7 @@ Sum: 61700 Send Panasonic 0xB, 0x10 as 48 bit generic PulseDistance using ProtocolConstants Protocol=Panasonic Address=0x10B Command=0xA0 Raw-Data=0xA010B02002 48 bits LSB first Send with: IrSender.sendPanasonic(0x10B, 0xA0, ); -rawData[100]: +rawData[100]: -1064700 +3550,-1650 + 550,- 350 + 500,-1250 + 500,- 400 + 500,- 350 @@ -153,7 +153,7 @@ Send Panasonic 0xB, 0x10 as generic 48 bit PulseDistance LSB first Protocol=Panasonic Address=0x10B Command=0xA0 Raw-Data=0xA010B02002 48 bits LSB first Send with: IrSender.sendPanasonic(0x10B, 0xA0, ); -rawData[100]: +rawData[100]: -1082450 +3550,-1600 + 550,- 350 + 550,-1150 + 550,- 300 + 600,- 300 @@ -174,7 +174,7 @@ Sum: 54200 MSB first Protocol=Panasonic Address=0xB Command=0x10 Raw-Data=0xA01000B02002 48 bits LSB first Send with: IrSender.sendPanasonic(0xB, 0x10, ); -rawData[100]: +rawData[100]: -1076300 +3550,-1600 + 550,- 350 + 550,-1150 + 550,- 300 + 600,- 300 @@ -197,7 +197,7 @@ Protocol=PulseDistance Raw-Data=0x5A 72 bits LSB first Send with: uint64_t tRawData[]={0xAFEDCBA987654321, 0x5A}; IrSender.sendPulseDistanceWidthFromArray(38, 9000, 4350, 650, 1600, 650, 500, &tRawData[0], 72, PROTOCOL_IS_LSB_FIRST, , ); -rawData[148]: +rawData[148]: -1082050 +9000,-4350 + 700,-1600 + 650,- 500 + 700,- 500 + 650,- 500 @@ -224,7 +224,7 @@ Sum: 140550 Send generic 52 bit PulseDistanceWidth 0xDCBA9 87654321 LSB first Protocol=PulseWidth Raw-Data=0xDCBA987654321 52 bits LSB first Send with: IrSender.sendPulseDistanceWidth(38, 400, 550, 750, 150, 400, 500, 0xDCBA987654321, 52, PROTOCOL_IS_LSB_FIRST, , ); -rawData[106]: +rawData[106]: -1120100 + 400,- 550 + 700,- 150 + 450,- 500 + 400,- 550 + 400,- 500 @@ -245,7 +245,7 @@ Sum: 48450 Send generic 32 bit PulseWidth 0x87654321 LSB first Protocol=PulseWidth Raw-Data=0x87654321 32 bits LSB first Send with: IrSender.sendPulseDistanceWidth(38, 1100, 400, 750, 200, 450, 200, 0x87654321, 32, PROTOCOL_IS_LSB_FIRST, , ); -rawData[66]: +rawData[66]: -1090450 +1100,- 400 + 700,- 150 + 450,- 200 + 450,- 150 + 450,- 200 @@ -261,7 +261,7 @@ Sum: 24900 Send MagiQuest 0x6BCDFF00, 0x176 as generic 55 bit PulseDistanceWidth MSB first Protocol=MagiQuest Address=0xFF00 Command=0x176 Raw-Data=0x6BCDFF00 56 bits MSB first Send with: IrSender.sendMagiQuest(0x6BCDFF00, 0x176, ); -rawData[112]: +rawData[112]: -1070250 + 400,- 800 + 400,- 750 + 450,- 800 + 400,- 750 + 400,- 800 + 400,- 750 + 400,- 800 + 400,- 750 @@ -282,7 +282,7 @@ Sum: 65350 Send Onkyo (NEC with 16 bit command) Protocol=Onkyo Address=0xFFF1 Command=0x7776 Raw-Data=0x7776FFF1 32 bits LSB first Send with: IrSender.sendOnkyo(0xFFF1, 0x7776, ); -rawData[68]: +rawData[68]: -1086400 +9050,-4400 + 700,-1600 + 650,- 450 + 700,- 450 + 650,- 500 @@ -299,7 +299,7 @@ Sum: 77500 Send Apple Protocol=Apple Address=0xF1 Command=0x76 Raw-Data=0xF17687EE 32 bits LSB first Send with: IrSender.sendApple(0xF1, 0x76, ); -rawData[68]: +rawData[68]: -1059500 +9050,-4400 + 700,- 500 + 650,-1600 + 700,-1600 + 650,-1600 @@ -316,7 +316,7 @@ Sum: 73000 Send Panasonic Protocol=Panasonic Address=0xFF1 Command=0x76 Raw-Data=0x9976FF102002 48 bits LSB first Send with: IrSender.sendPanasonic(0xFF1, 0x76, ); -rawData[100]: +rawData[100]: -1059200 +3500,-1700 + 500,- 350 + 500,-1250 + 500,- 400 + 500,- 350 @@ -337,7 +337,7 @@ Sum: 65200 Send Kaseikyo with 0x4711 as Vendor ID Protocol=Kaseikyo Address=0xFF1 Command=0x76 Extra=0x4711 Raw-Data=0x9A76FF134711 48 bits LSB first Send with: IrSender.sendKaseikyo(0xFF1, 0x76, , 0x4711); -rawData[100]: +rawData[100]: -1079950 +3550,-1650 + 500,-1250 + 500,- 400 + 500,- 350 + 500,- 400 @@ -358,7 +358,7 @@ Sum: 70500 Send Kaseikyo_Denon variant Protocol=Kaseikyo_Denon Address=0xFF1 Command=0x76 Raw-Data=0x9976FF103254 48 bits LSB first Send with: IrSender.sendKaseikyo_Denon(0xFF1, 0x76, ); -rawData[100]: +rawData[100]: -1080650 +3550,-1650 + 550,- 350 + 500,- 350 + 550,-1200 + 550,- 350 @@ -379,7 +379,7 @@ Sum: 68750 Send Denon Protocol=Denon Address=0x11 Command=0x76 Raw-Data=0xED1 15 bits LSB first Send with: IrSender.sendDenon(0x11, 0x76, ); -rawData[32]: +rawData[32]: -1078400 + 350,-1750 + 350,- 700 + 350,- 700 + 350,- 700 + 350,-1750 + 350,- 700 + 300,-1800 + 350,-1750 @@ -390,7 +390,7 @@ Sum: 23450 Send Denon/Sharp variant Protocol=Sharp Address=0x11 Command=0x76 Raw-Data=0x4ED1 15 bits LSB first Send with: IrSender.sendSharp(0x11, 0x76, ); -rawData[32]: +rawData[32]: -1023500 + 350,-1750 + 350,- 700 + 350,- 700 + 350,- 700 + 350,-1750 + 350,- 700 + 350,-1750 + 350,-1750 @@ -401,7 +401,7 @@ Sum: 24500 Send Sony/SIRCS with 7 command and 5 address bits Protocol=Sony Address=0x11 Command=0x76 Raw-Data=0x8F6 12 bits LSB first Send with: IrSender.sendSony(0x11, 0x76, 2, 12); -rawData[26]: +rawData[26]: -1025750 +2500,- 500 + 700,- 500 +1300,- 650 +1250,- 550 + 700,- 500 @@ -412,7 +412,7 @@ Sum: 21300 Send Sony/SIRCS with 7 command and 8 address bits Protocol=Sony Address=0xF1 Command=0x76 Raw-Data=0x78F6 15 bits LSB first Send with: IrSender.sendSony(0xF1, 0x76, 2, 15); -rawData[32]: +rawData[32]: -1037600 +2500,- 550 + 650,- 550 +1300,- 500 +1300,- 500 + 700,- 500 @@ -424,7 +424,7 @@ Sum: 26700 Send Sony/SIRCS with 7 command and 13 address bits Protocol=Sony Address=0x1FF1 Command=0x76 Raw-Data=0xFF8F6 20 bits LSB first Send with: IrSender.sendSony(0x1FF1, 0x76, 2, 20); -rawData[42]: +rawData[42]: -1041100 +2500,- 500 + 700,- 550 +1300,- 500 +1300,- 500 + 700,- 550 @@ -437,7 +437,7 @@ Sum: 35750 Send Samsung 8 bit command Protocol=Samsung Address=0xFFF1 Command=0x76 Raw-Data=0x8976FFF1 32 bits LSB first Send with: IrSender.sendSamsung(0xFFF1, 0x76, ); -rawData[68]: +rawData[68]: -1044850 +4550,-4400 + 700,-1600 + 650,- 450 + 700,- 450 + 650,- 500 @@ -454,7 +454,7 @@ Sum: 69600 Send Samsung 16 bit command Protocol=Samsung Address=0xFFF1 Command=0x9876 Raw-Data=0x9876FFF1 32 bits LSB first Send with: IrSender.sendSamsung(0xFFF1, 0x9876, ); -rawData[68]: +rawData[68]: -1061000 +4600,-4400 + 650,-1600 + 700,- 450 + 650,- 500 + 650,- 450 @@ -471,7 +471,7 @@ Sum: 69650 Send Samsung48 16 bit command Protocol=Samsung48 Address=0xFFF1 Command=0x9876 Raw-Data=0xFFFFFFFF8976FFF1 48 bits LSB first Send with: IrSender.sendSamsung48(0xFFF1, 0x9876, ); -rawData[100]: +rawData[100]: -1066350 +4550,-4400 + 650,-1650 + 600,- 500 + 700,- 450 + 650,- 500 @@ -492,7 +492,7 @@ Sum: 96750 Send RC5 Protocol=RC5 Address=0x11 Command=0x36 Raw-Data=0x1476 13 bits MSB first Send with: IrSender.sendRC5(0x11, 0x36, ); -rawData[20]: +rawData[20]: -1079150 +1000,- 800 +1900,-1650 +1900,- 800 +1000,- 800 +1000,-1700 @@ -503,7 +503,7 @@ Sum: 23400 Send RC5X with 7.th MSB of command set Protocol=RC5 Address=0x11 Command=0x76 Toggle=1 Raw-Data=0xC76 13 bits MSB first Send with: IrSender.sendRC5(0x11, 0x76, ); -rawData[20]: +rawData[20]: -1035450 +1900,-1700 +1000,- 800 +1900,- 750 +1000,- 800 +1000,-1700 @@ -514,7 +514,7 @@ Sum: 23400 Send RC6 Protocol=RC6 Address=0xF1 Command=0x76 Raw-Data=0xF176 20 bits MSB first Send with: IrSender.sendRC6(0xF1, 0x76, ); -rawData[36]: +rawData[36]: -1032650 +2750,- 800 + 550,- 800 + 550,- 350 + 550,- 350 + 550,- 800 @@ -524,10 +524,75 @@ rawData[36]: + 550 Sum: 23450 +Send RC6A with 14 bit 0x2711 as extra +Protocol=RC6A Address=0xF1 Command=0x76 Extra=0x2711 Toggle=1 Raw-Data=0xA711F176 35 bits MSB first +Send with: IrSender.sendRC6A(0xF1, 0x76, , 0x2711); +rawData[58]: + -1032900 + +2650,- 900 + + 450,- 450 + 450,- 450 + 450,- 850 +1400,-1300 + + 950,- 850 + 500,- 400 + 950,- 400 + 500,- 450 + + 450,- 850 + 500,- 400 + 500,- 400 + 950,- 850 + + 500,- 400 + 500,- 400 + 950,- 450 + 450,- 450 + + 450,- 450 + 450,- 400 + 500,- 850 + 500,- 400 + + 500,- 400 + 950,- 850 + 950,- 400 + 500,- 400 + + 500,- 850 + 950,- 450 + 450,- 850 + 500 +Sum: 36850 + +Send Bang&Olufsen +- ENABLE_BEO_WITHOUT_FRAME_GAP is enabled +- Now print raw data and try to decode the first 6 entries, which results in rawData 0x0! +rawData[36]: + -1032400 + + 300,-2850 + + 250,-2850 + 250,-15200 + 300,-2850 + 250,-9000 + + 300,-5950 + 250,-5950 + 250,-5900 + 300,-2850 + + 250,-5950 + 250,-9050 + 250,-2850 + 250,-9000 + + 300,-2850 + 250,-5950 + 250,-5950 + 250,-5950 + + 250 +Sum: 105700 +Protocol=Bang&Olufsen Address=0x0 Command=0x0 Raw-Data=0x0 0 bits MSB first + +- Remove trailing 6 entries, which is equivalent to define RECORD_GAP_MICROS < 15000, to enable successful B&O decode +Protocol=Bang&Olufsen Address=0xF2 Command=0x87 Raw-Data=0xF287 16 bits MSB first +Send with: IrSender.sendBang&Olufsen(0xF2, 0x87, ); +rawData[38]: + -15200 + + 300,-2850 + + 250,-9000 + 300,-5950 + 250,-5950 + 250,-5900 + + 300,-2850 + 250,-5950 + 250,-9050 + 250,-2850 + + 250,-9000 + 300,-2850 + 250,-5950 + 250,-5950 + + 250,-5950 + 250,-9050 + 250,-5900 + 300,-5950 + + 250,-12100 + 300 +Sum: 118100 + +Send MagiQuest +Protocol=MagiQuest Address=0xF2 Command=0x187 Raw-Data=0x6BCD00F2 56 bits MSB first +Send with: IrSender.sendMagiQuest(0x6BCD00F2, 0x187, ); +rawData[112]: + -1088750 + + 350,- 800 + 350,- 800 + 350,- 800 + 350,- 800 + + 350,- 800 + 350,- 800 + 350,- 800 + 350,- 850 + + 600,- 550 + 600,- 550 + 350,- 750 + 650,- 550 + + 300,- 850 + 600,- 550 + 600,- 550 + 600,- 550 + + 600,- 550 + 350,- 800 + 350,- 750 + 650,- 500 + + 650,- 500 + 350,- 800 + 650,- 500 + 350,- 800 + + 350,- 800 + 350,- 800 + 350,- 800 + 350,- 800 + + 350,- 800 + 350,- 800 + 350,- 800 + 650,- 500 + + 650,- 500 + 650,- 500 + 650,- 500 + 350,- 800 + + 350,- 800 + 650,- 500 + 350,- 850 + 600,- 550 + + 600,- 550 + 350,- 800 + 300,- 800 + 350,- 800 + + 350,- 800 + 650,- 500 + 650,- 500 + 650,- 550 + + 350,- 800 + 300,- 800 + 650,- 500 + 350,- 800 + + 350,- 800 + 350,- 800 + 650,- 500 + 350 +Sum: 63600 + +Send next protocols with IrSender.write + Send JVC Protocol=JVC Address=0xF1 Command=0x76 Raw-Data=0x76F1 16 bits LSB first Send with: IrSender.sendJVC(0xF1, 0x76, ); -rawData[36]: +rawData[36]: -1040750 +8500,-4150 + 650,-1500 + 650,- 400 + 650,- 450 + 600,- 450 @@ -537,27 +602,10 @@ rawData[36]: + 650 Sum: 41050 -Send Samsung -Protocol=Samsung Address=0xFFF1 Command=0x9876 Raw-Data=0x9876FFF1 32 bits LSB first -Send with: IrSender.sendSamsung(0xFFF1, 0x9876, ); -rawData[68]: - -1040900 - +4600,-4400 - + 650,-1600 + 700,- 450 + 650,- 500 + 650,- 450 - + 700,-1600 + 650,-1600 + 650,-1600 + 650,-1600 - + 650,-1650 + 650,-1600 + 650,-1600 + 650,-1600 - + 650,-1600 + 700,-1600 + 650,-1600 + 650,-1600 - + 650,- 500 + 650,-1600 + 650,-1600 + 700,- 450 - + 650,-1600 + 650,-1600 + 700,-1600 + 650,- 450 - + 700,- 450 + 650,- 500 + 650,- 450 + 650,-1600 - + 700,-1600 + 650,- 500 + 650,- 450 + 650,-1600 - + 700 -Sum: 69650 - Send LG Protocol=LG Address=0xF1 Command=0x9876 Raw-Data=0xF19876E 28 bits MSB first Send with: IrSender.sendLG(0xF1, 0x9876, ); -rawData[60]: +rawData[60]: -1059650 +9100,-4100 + 650,-1500 + 600,-1500 + 600,-1500 + 600,-1500 @@ -570,45 +618,10 @@ rawData[60]: + 600 Sum: 60450 -Send MagiQuest -Protocol=MagiQuest Address=0xFFF1 Command=0x76 Raw-Data=0x6BCDFFF1 56 bits MSB first -Send with: IrSender.sendMagiQuest(0x6BCDFFF1, 0x76, ); -rawData[112]: - -1054600 - + 400,- 750 + 400,- 800 + 400,- 750 + 400,- 750 - + 400,- 800 + 400,- 750 + 400,- 800 + 400,- 750 - + 700,- 500 + 650,- 500 + 400,- 800 + 650,- 500 - + 400,- 750 + 700,- 500 + 700,- 450 + 700,- 500 - + 650,- 500 + 400,- 800 + 400,- 750 + 700,- 500 - + 650,- 500 + 400,- 800 + 650,- 500 + 700,- 450 - + 700,- 500 + 650,- 500 + 700,- 500 + 650,- 500 - + 700,- 450 + 700,- 500 + 700,- 450 + 700,- 500 - + 650,- 500 + 700,- 450 + 700,- 500 + 400,- 750 - + 400,- 800 + 400,- 750 + 700,- 500 + 400,- 800 - + 400,- 750 + 700,- 450 + 700,- 500 + 650,- 500 - + 400,- 800 + 650,- 500 + 700,- 450 + 400,- 800 - + 400,- 750 + 400,- 800 + 650,- 500 + 700,- 500 - + 350,- 800 + 700,- 450 + 700,- 500 + 650 -Sum: 65100 - -Send Bang&Olufsen -Protocol=Bang&Olufsen Address=0xF1 Command=0x76 Raw-Data=0xF176 16 bits MSB first -Send with: IrSender.sendBang&Olufsen(0xF1, 0x76, ); -rawData[44]: - -1084600 - + 300,-2850 - + 250,-2900 + 250,-15400 + 300,-2850 + 300,-9100 - + 250,-6050 + 250,-6000 + 250,-6000 + 300,-2850 - + 300,-6000 + 250,-6000 + 300,-9100 + 300,-2850 - + 300,-9100 + 300,-6000 + 250,-6000 + 300,-2850 - + 300,-9100 + 250,-6000 + 300,-2900 + 250,-12250 - + 300 -Sum: 138300 - Send Bosewave with no address and 8 command bits Protocol=BoseWave Address=0x0 Command=0x76 Raw-Data=0x8976 16 bits LSB first Send with: IrSender.sendBoseWave(0x0, 0x76, ); -rawData[36]: +rawData[36]: -1050250 +1100,-1400 + 600,- 400 + 600,-1400 + 600,-1400 + 600,- 400 @@ -621,7 +634,7 @@ Sum: 27150 Send FAST Protocol=FAST Address=0x0 Command=0x76 Raw-Data=0x8976 16 bits LSB first Send with: IrSender.sendFAST(0x0, 0x76, ); -rawData[36]: +rawData[36]: -1041350 +2200,-1000 + 650,- 400 + 650,-1500 + 650,-1500 + 600,- 450 @@ -634,7 +647,7 @@ Sum: 29450 Force buffer overflow by sending 280 marks and spaces Overflow Try to increase the "RAW_BUFFER_LENGTH" value of 200 in UnitTest.cpp -rawData[200]: +rawData[200]: -1039850 + 300,- 450 + 300,- 450 + 350,- 450 + 300,- 450 + 350,- 450 @@ -668,27 +681,43 @@ ERROR: Unknown protocol address=0xF2 command=0x87 -Send NEC with 8 bit address +Send NEC with 8 bit address and complete NEC frames as repeats to force decoding as NEC2 Protocol=NEC Address=0xF2 Command=0x87 Raw-Data=0x78870DF2 32 bits LSB first Send with: IrSender.sendNEC(0xF2, 0x87, ); -rawData[68]: +rawData[68]: -3276750 - +9050,-4400 - + 650,- 500 + 650,-1600 + 650,- 500 + 650,- 450 - + 650,-1600 + 700,-1600 + 650,-1600 + 650,-1600 - + 650,-1600 + 650,- 500 + 650,-1600 + 700,-1550 - + 650,- 500 + 650,- 500 + 600,- 500 + 700,- 450 - + 650,-1600 + 650,-1600 + 700,-1600 + 650,- 450 - + 700,- 450 + 650,- 500 + 650,- 450 + 700,-1550 - + 700,- 450 + 650,- 500 + 650,- 500 + 650,-1600 - + 650,-1650 + 650,-1600 + 650,-1600 + 650,- 500 - + 650 -Sum: 68450 + +8900,-4450 + + 600,- 500 + 650,-1600 + 600,- 550 + 600,- 500 + + 650,-1600 + 600,-1650 + 600,-1650 + 600,-1650 + + 600,-1600 + 600,- 550 + 600,-1600 + 650,-1600 + + 600,- 550 + 600,- 500 + 600,- 550 + 600,- 500 + + 600,-1650 + 600,-1650 + 600,-1650 + 600,- 550 + + 600,- 500 + 600,- 550 + 600,- 550 + 600,-1600 + + 600,- 550 + 600,- 500 + 650,- 500 + 600,-1650 + + 600,-1650 + 600,-1600 + 600,-1650 + 600,- 550 + + 600 +Sum: 67850 + +Protocol=NEC2 Address=0xF2 Command=0x87 Repeat gap=65900us Raw-Data=0x78870DF2 32 bits LSB first +Send with: IrSender.sendNEC2(0xF2, 0x87, ); +rawData[68]: + -65900 + +8900,-4450 + + 600,- 500 + 600,-1650 + 600,- 500 + 600,- 550 + + 600,-1650 + 600,-1600 + 600,-1650 + 600,-1650 + + 600,-1650 + 600,- 500 + 600,-1650 + 600,-1650 + + 600,- 500 + 600,- 550 + 600,- 550 + 600,- 500 + + 600,-1650 + 600,-1650 + 600,-1600 + 600,- 550 + + 600,- 550 + 600,- 500 + 600,- 550 + 600,-1650 + + 600,- 500 + 600,- 550 + 600,- 500 + 650,-1600 + + 600,-1650 + 600,-1600 + 650,-1600 + 600,- 550 + + 600 +Sum: 67800 Send NEC with 16 bit address Protocol=NEC Address=0xF2 Command=0x87 Raw-Data=0x78870DF2 32 bits LSB first Send with: IrSender.sendNEC(0xF2, 0x87, ); -rawData[68]: +rawData[68]: -1060000 +9100,-4400 + 650,- 450 + 700,-1600 + 650,- 450 + 700,- 450 @@ -705,7 +734,7 @@ Sum: 68450 Send NEC2 with 16 bit address Protocol=NEC Address=0xF2 Command=0x87 Raw-Data=0x78870DF2 32 bits LSB first Send with: IrSender.sendNEC(0xF2, 0x87, ); -rawData[68]: +rawData[68]: -1060100 +9050,-4400 + 700,- 450 + 650,-1600 + 650,- 500 + 650,- 450 @@ -722,7 +751,7 @@ Sum: 68450 Send Onkyo (NEC with 16 bit command) Protocol=Onkyo Address=0xF2 Command=0x8887 Raw-Data=0x888700F2 32 bits LSB first Send with: IrSender.sendOnkyo(0xF2, 0x8887, ); -rawData[68]: +rawData[68]: -1060700 +9100,-4400 + 650,- 450 + 700,-1600 + 650,- 450 + 700,- 450 @@ -739,7 +768,7 @@ Sum: 62800 Send Apple Protocol=Apple Address=0xF2 Command=0x87 Raw-Data=0xF28787EE 32 bits LSB first Send with: IrSender.sendApple(0xF2, 0x87, ); -rawData[68]: +rawData[68]: -1059150 +9050,-4400 + 650,- 500 + 650,-1600 + 650,-1600 + 700,-1600 @@ -756,7 +785,7 @@ Sum: 71800 Send Panasonic Protocol=Panasonic Address=0xF2 Command=0x87 Raw-Data=0xA8870F202002 48 bits LSB first Send with: IrSender.sendPanasonic(0xF2, 0x87, ); -rawData[100]: +rawData[100]: -1069050 +3550,-1650 + 500,- 400 + 500,-1250 + 500,- 350 + 500,- 400 @@ -777,7 +806,7 @@ Sum: 60000 Send Kaseikyo with 0x4711 as Vendor ID Protocol=Kaseikyo Address=0xF2 Command=0x87 Extra=0x4711 Raw-Data=0xAB870F234711 48 bits LSB first Send with: IrSender.sendKaseikyo(0xF2, 0x87, , 0x4711); -rawData[100]: +rawData[100]: -1079750 +3550,-1650 + 550,-1200 + 550,- 350 + 500,- 350 + 550,- 350 diff --git a/keywords.txt b/keywords.txt index 935f913e1..adfe84678 100644 --- a/keywords.txt +++ b/keywords.txt @@ -16,35 +16,40 @@ decodedIRData KEYWORD1 ####################################### # Methods and Functions (KEYWORD2) ####################################### - -setFeedbackLED KEYWORD2 -enableLEDFeedback KEYWORD2 -enableLEDFeedbackForSend KEYWORD2 -disableLEDFeedback KEYWORD2 -disableLEDFeedbackForSend KEYWORD2 -printIRResultShort KEYWORD2 +# IRReceive +available KEYWORD2 begin KEYWORD2 +decode KEYWORD2 +disableIRIn KEYWORD2 +enableIRIn KEYWORD2 +isIdle KEYWORD2 +printActiveIRProtocols KEYWORD2 +printIRResultMinimal KEYWORD2 +printIRResultRawFormatted KEYWORD2 +printIRResultShort KEYWORD2 +printIRSendUsage KEYWORD2 +registerReceiveCompleteCallback KEYWORD2 +restartAfterSend KEYWORD2 +restartTimer KEYWORD2 +restartTimerWithTicksToAdd KEYWORD2 +resume KEYWORD2 +setReceivePin KEYWORD2 start KEYWORD2 -available KEYWORD2 read KEYWORD2 stop KEYWORD2 end KEYWORD2 -enableLEDFeedback KEYWORD2 -decode KEYWORD2 -resume KEYWORD2 -enableIRIn KEYWORD2 -disableIRIn KEYWORD2 -sendNEC KEYWORD2 + +# IRSend setSendPin KEYWORD2 write KEYWORD2 -enableIROut KEYWORD2 -IRLedOff KEYWORD2 sendRaw KEYWORD2 sendJVC KEYWORD2 sendLG KEYWORD2 -sendLGRepeat KEYWORD2 +sendLG2 KEYWORD2 +sendLG2Repeat KEYWORD2 sendLGRaw KEYWORD2 sendNEC KEYWORD2 +sendNEC2 KEYWORD2 sendNECRepeat KEYWORD2 sendNECRaw KEYWORD2 sendOnkyo KEYWORD2 @@ -67,18 +72,41 @@ sendMagiQuest KEYWORD2 sendPronto KEYWORD2 sendMagiQuest KEYWORD2 sendFAST KEYWORD2 + +# IRFeedbackLED +disableLEDFeedback KEYWORD2 +disableLEDFeedbackForSend KEYWORD2 +enableLEDFeedback KEYWORD2 +enableLEDFeedbackForSend KEYWORD2 +setFeedbackLED KEYWORD2 +setLEDFeedback KEYWORD2 + +# TinyIRReceiver +disablePCIInterruptForTinyReceiver KEYWORD2 +enablePCIInterruptForTinyReceiver KEYWORD2 +initPCIInterruptForTinyReceiver KEYWORD2 +isIRReceiverAttachedForTinyReceiver KEYWORD2 +printTinyReceiverResultMinimal KEYWORD2 +TinyReceiverDecode KEYWORD2 +# TinyIRSender +sendExtendedNEC KEYWORD2 +sendFAST KEYWORD2 + ####################################### # Constants (LITERAL1) ####################################### +UNKNOWN LITERAL1 PULSE_DISTANCE LITERAL1 PULSE_WIDTH LITERAL1 +APPLE LITERAL1 DENON LITERAL1 -DISH LITERAL1 JVC LITERAL1 LG LITERAL1 LG2 LITERAL1 NEC LITERAL1 +NEC2 LITERAL1 +ONKYO LITERAL1 PANASONIC LITERAL1 KASEIKYO LITERAL1 KASEIKYO_JVC LITERAL1 @@ -87,18 +115,26 @@ KASEIKYO_SHARP LITERAL1 KASEIKYO_MITSUBISHI LITERAL1 RC5 LITERAL1 RC6 LITERAL1 +RC6A LITERAL1 SAMSUNG LITERAL1 +SAMSUNGLG LITERAL1 +SAMSUNG48 LITERAL1 SHARP LITERAL1 SONY LITERAL1 -ONKYO LITERAL1 -APPLE LITERAL1 BANG_OLUFSEN LITERAL1 BOSEWAVE LITERAL1 LEGO_PF LITERAL1 MAGIQUEST LITERAL1 WHYNTER LITERAL1 FAST LITERAL1 -UNKNOWN LITERAL1 + +FEEDBACK_LED_IS_ACTIVE_LOW LITERAL1 + +RAW_BUFFER_LENGTH LITERAL1 +EXCLUDE_UNIVERSAL_PROTOCOLS LITERAL1 +EXCLUDE_EXOTIC_PROTOCOLS LITERAL1 +SEND_PWM_BY_TIMER LITERAL1 +USE_NO_SEND_PWM LITERAL1 IR_RECEIVE_PIN LITERAL1 IR_SEND_PIN LITERAL1 -FEEDBACK_LED_IS_ACTIVE_LOW LITERAL1 +USE_CALLBACK_FOR_TINY_RECEIVER LITERAL1 diff --git a/library.json b/library.json index 9f7327e35..c0666baa1 100644 --- a/library.json +++ b/library.json @@ -1,15 +1,14 @@ { "name": "IRremote", - "keywords": "communication, infrared, ir, remote", + "version": "4.4.2", "description": "Send and receive infrared signals with multiple protocols", + "keywords": "communication, infrared, ir, remote", + "homepage": "https://github.com/Arduino-IRremote/Arduino-IRremote", "repository": { "type": "git", - "url": "https://github.com/z3t0/Arduino-IRremote.git" + "url": "https://github.com/Arduino-IRremote/Arduino-IRremote.git" }, - "version": "4.1.0", - "frameworks": "arduino", - "platforms": ["atmelavr", "atmelmegaavr", "atmelsam", "espressif8266", "espressif32", "ststm32"], "authors" : [ { @@ -26,5 +25,10 @@ "email":"ken.shirriff@gmail.com" } ], - "headers": "IRRemote.hpp" + "license": "MIT", + "frameworks": "arduino", + "platforms": ["atmelavr", "atmelmegaavr", "atmelsam", "espressif8266", "espressif32", "ststm32"], + "headers": "IRRemote.hpp", + "examples": "examples/*/*.ino", + "export": {"exclude": [".github", "pictures"]} } diff --git a/library.properties b/library.properties index 866b538c8..40e043e2a 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ name=IRremote -version=4.1.0 +version=4.4.2 author=shirriff, z3t0, ArminJo maintainer=Armin Joachimsmeyer sentence=Send and receive infrared signals with multiple protocols -paragraph=Currently included protocols: Denon / Sharp, JVC, LG / LG2, NEC / Onkyo / Apple, Panasonic / Kaseikyo, RC5, RC6, Samsung, Sony, (Pronto), BangOlufsen, BoseWave, Lego, Whynter, FAST, MagiQuest.

New: Added FAST Protocol. Changed some function signatures. Improved handling of PULSE_DISTANCE + PULSE_WIDTH protocols.
Release notes
+paragraph=Currently included protocols: Denon / Sharp, JVC, LG / LG2, NEC / Onkyo / Apple, Panasonic / Kaseikyo, RC5, RC6, Samsung, Sony, (Pronto), BangOlufsen, BoseWave, Lego, Whynter, FAST, MagiQuest, Universal Pulse Distance and Pulse Width. category=Communication url=https://github.com/Arduino-IRremote/Arduino-IRremote -architectures=avr,megaavr,samd,esp8266,esp32,stm32,STM32F1,mbed,mbed_nano,rp2040,mbed_rp2040 +architectures=avr,megaavr,samd,esp8266,esp32,stm32,STM32F1,mbed,mbed_nano,rp2040,mbed_rp2040,renesas_uno includes=IRremote.hpp diff --git a/pictures/BoseWaveSoundTouch_IV.jpg b/pictures/BoseWaveSoundTouch_IV.jpg new file mode 100644 index 000000000..17d535d90 Binary files /dev/null and b/pictures/BoseWaveSoundTouch_IV.jpg differ diff --git a/pictures/IRReceiverPinout.jpg b/pictures/IRReceiverPinout.jpg new file mode 100644 index 000000000..5e232d157 Binary files /dev/null and b/pictures/IRReceiverPinout.jpg differ diff --git a/pictures/IR_RobotCar.jpg b/pictures/IR_RobotCar.jpg new file mode 100644 index 000000000..6258d0136 Binary files /dev/null and b/pictures/IR_RobotCar.jpg differ diff --git a/pictures/IR_UnitTest_delay.bmp b/pictures/IR_UnitTest_delay.bmp new file mode 100644 index 000000000..00e17dd49 Binary files /dev/null and b/pictures/IR_UnitTest_delay.bmp differ diff --git a/src/IRFeedbackLED.hpp b/src/IRFeedbackLED.hpp index 97611b083..0db0c02f8 100644 --- a/src/IRFeedbackLED.hpp +++ b/src/IRFeedbackLED.hpp @@ -47,7 +47,7 @@ struct FeedbackLEDControlStruct { struct FeedbackLEDControlStruct FeedbackLEDControl; ///< The feedback LED control instance /** - * Enable blinking of feedback LED (LED_BUILTIN is taken as default) on IR sending and receiving + * Enables blinking of feedback LED (LED_BUILTIN is taken as default) on IR sending and receiving * Cannot disable it here!!! Use disableLEDFeedbackForReceive() or disableLEDFeedbackForSend() * @param aFeedbackLEDPin If aFeedbackLEDPin == 0, then take board specific FEEDBACK_LED_ON() and FEEDBACK_LED_ON() and FEEDBACK_LED_OFF() functions * If FeedbackLEDPin == 0 and no LED_BUILTIN defined, disable LED feedback @@ -108,33 +108,35 @@ IRAM_ATTR void setFeedbackLED(bool aSwitchLedOn) { if (aSwitchLedOn) { if (FeedbackLEDControl.FeedbackLEDPin != USE_DEFAULT_FEEDBACK_LED_PIN) { + // Turn user defined pin LED on #if defined(FEEDBACK_LED_IS_ACTIVE_LOW) - digitalWriteFast(FeedbackLEDControl.FeedbackLEDPin, LOW); // Turn user defined pin LED on + if (__builtin_constant_p(FeedbackLEDControl.FeedbackLEDPin) ) { digitalWriteFast(FeedbackLEDControl.FeedbackLEDPin, LOW);} else { digitalWrite(FeedbackLEDControl.FeedbackLEDPin, LOW);} #else - digitalWriteFast(FeedbackLEDControl.FeedbackLEDPin, HIGH); // Turn user defined pin LED on + if (__builtin_constant_p(FeedbackLEDControl.FeedbackLEDPin) ) { digitalWriteFast(FeedbackLEDControl.FeedbackLEDPin, HIGH);} else { digitalWrite(FeedbackLEDControl.FeedbackLEDPin, HIGH);} #endif #if defined(LED_BUILTIN) // use fast macros here - } else { + } else { # if defined(FEEDBACK_LED_IS_ACTIVE_LOW) - digitalWriteFast(LED_BUILTIN, LOW); // For AVR, this generates a single cbi command + digitalWriteFast(LED_BUILTIN, LOW); // For AVR, this generates a single cbi command # else - digitalWriteFast(LED_BUILTIN, HIGH); // For AVR, this generates a single sbi command + digitalWriteFast(LED_BUILTIN, HIGH); // For AVR, this generates a single sbi command # endif #endif } } else { if (FeedbackLEDControl.FeedbackLEDPin != USE_DEFAULT_FEEDBACK_LED_PIN) { + // Turn user defined pin LED off #if defined(FEEDBACK_LED_IS_ACTIVE_LOW) - digitalWriteFast(FeedbackLEDControl.FeedbackLEDPin, HIGH); // Turn user defined pin LED off + if (__builtin_constant_p(FeedbackLEDControl.FeedbackLEDPin) ) { digitalWriteFast(FeedbackLEDControl.FeedbackLEDPin, HIGH);} else { digitalWrite(FeedbackLEDControl.FeedbackLEDPin, HIGH);} #else - digitalWriteFast(FeedbackLEDControl.FeedbackLEDPin, LOW); // Turn user defined pin LED off + if (__builtin_constant_p(FeedbackLEDControl.FeedbackLEDPin) ) { digitalWriteFast(FeedbackLEDControl.FeedbackLEDPin, LOW);} else { digitalWrite(FeedbackLEDControl.FeedbackLEDPin, LOW);} #endif #if defined(LED_BUILTIN) - } else { + } else { # if defined(FEEDBACK_LED_IS_ACTIVE_LOW) - digitalWriteFast(LED_BUILTIN, HIGH); // For AVR, this generates a single sbi command + digitalWriteFast(LED_BUILTIN, HIGH); // For AVR, this generates a single sbi command # else - digitalWriteFast(LED_BUILTIN, LOW); // For AVR, this generates a single cbi command + digitalWriteFast(LED_BUILTIN, LOW); // For AVR, this generates a single cbi command # endif #endif } diff --git a/src/IRProtocol.h b/src/IRProtocol.h index 9483fa5e4..2d7654767 100644 --- a/src/IRProtocol.h +++ b/src/IRProtocol.h @@ -8,7 +8,7 @@ ************************************************************************************ * MIT License * - * Copyright (c) 2020-2023 Armin Joachimsmeyer + * Copyright (c) 2020-2024 Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -47,7 +47,7 @@ typedef enum { LG, LG2, NEC, - NEC2, /* NEC with full frame as repeat */ + NEC2, /* 10 NEC with full frame as repeat */ ONKYO, PANASONIC, KASEIKYO, @@ -57,9 +57,10 @@ typedef enum { KASEIKYO_MITSUBISHI, RC5, RC6, - SAMSUNG, + RC6A, /*31 bit + 3 fixed 0b110 mode bits*/ + SAMSUNG, /* 20*/ + SAMSUNGLG, SAMSUNG48, - SAMSUNG_LG, SHARP, SONY, /* Now the exotic protocols */ @@ -67,10 +68,10 @@ typedef enum { BOSEWAVE, LEGO_PF, MAGIQUEST, - WHYNTER, + WHYNTER, /* 30 */ FAST } decode_type_t; - +extern const char *const ProtocolNames[]; // The array of name strings for the decode_type_t enum #define SIRCS_12_PROTOCOL 12 #define SIRCS_15_PROTOCOL 15 @@ -92,14 +93,15 @@ struct DistanceWidthTimingInfoStruct { #define IRDATA_FLAGS_IS_REPEAT 0x01 ///< The gap between the preceding frame is as smaller than the maximum gap expected for a repeat. !!!We do not check for changed command or address, because it is almost not possible to press 2 different buttons on the remote within around 100 ms!!! #define IRDATA_FLAGS_IS_AUTO_REPEAT 0x02 ///< The current repeat frame is a repeat, that is always sent after a regular frame and cannot be avoided. Only specified for protocols DENON, and LEGO. #define IRDATA_FLAGS_PARITY_FAILED 0x04 ///< The current (autorepeat) frame violated parity check. -#define IRDATA_FLAGS_TOGGLE_BIT 0x08 ///< Is set if RC5 or RC6 toggle bit is set -#define IRDATA_TOGGLE_BIT_MASK 0x08 ///< deprecated -is set if RC5 or RC6 toggle bit is set -#define IRDATA_FLAGS_EXTRA_INFO 0x10 ///< There is extra info not contained in address and data (e.g. Kaseikyo unknown vendor ID, or in decodedRawDataArray) -#define IRDATA_FLAGS_WAS_OVERFLOW 0x40 ///< irparams.rawlen is set to 0 in this case to avoid endless OverflowFlag -#define IRDATA_FLAGS_IS_MSB_FIRST 0x80 ///< Value is mainly determined by the (known) protocol +#define IRDATA_FLAGS_TOGGLE_BIT 0x08 ///< Is set if RC5 or RC6 toggle bit is set. +#define IRDATA_TOGGLE_BIT_MASK 0x08 ///< deprecated -is set if RC5 or RC6 toggle bit is set. +#define IRDATA_FLAGS_EXTRA_INFO 0x10 ///< There is extra info not contained in address and data (e.g. Kaseikyo unknown vendor ID, or in decodedRawDataArray). +#define IRDATA_FLAGS_IS_PROTOCOL_WITH_DIFFERENT_REPEAT 0x20 ///< Here we have a repeat of type NEC2 or SamsungLG +#define IRDATA_FLAGS_WAS_OVERFLOW 0x40 ///< irparams.rawlen is set to 0 in this case to avoid endless OverflowFlag. +#define IRDATA_FLAGS_IS_MSB_FIRST 0x80 ///< Value is mainly determined by the (known) protocol. #define IRDATA_FLAGS_IS_LSB_FIRST 0x00 -#define RAW_DATA_ARRAY_SIZE ((((RAW_BUFFER_LENGTH - 2) - 1) / (2 * BITS_IN_RAW_DATA_TYPE)) + 1) // The -2 is for initial gap + stop bit mark, 128 mark + spaces for 64 bit. +#define DECODED_RAW_DATA_ARRAY_SIZE ((((RAW_BUFFER_LENGTH - 2) - 1) / (2 * BITS_IN_RAW_DATA_TYPE)) + 1) // The -2 is for initial gap + stop bit mark, 128 mark + spaces for 64 bit. /** * Data structure for the user application, available as decodedIRData. * Filled by decoders and read by print functions or user application. @@ -113,13 +115,25 @@ struct IRData { #if defined(DECODE_DISTANCE_WIDTH) // This replaces the address, command, extra and decodedRawData in case of protocol == PULSE_DISTANCE or -rather seldom- protocol == PULSE_WIDTH. DistanceWidthTimingInfoStruct DistanceWidthTimingInfo; // 12 bytes - IRRawDataType decodedRawDataArray[RAW_DATA_ARRAY_SIZE]; ///< 32/64 bit decoded raw data, to be used for send function. + IRRawDataType decodedRawDataArray[DECODED_RAW_DATA_ARRAY_SIZE]; ///< 32/64 bit decoded raw data, to be used for send function. #endif uint16_t numberOfBits; ///< Number of bits received for data (address + command + parity) - to determine protocol length if different length are possible. - uint8_t flags; ///< See IRDATA_FLAGS_* definitions above + uint8_t flags; ///< IRDATA_FLAGS_IS_REPEAT, IRDATA_FLAGS_WAS_OVERFLOW etc. See IRDATA_FLAGS_* definitions above + + /* + * These 2 variables allow to call resume() directly after decode. + * After resume(), decodedIRData.rawDataPtr->initialGapTicks and decodedIRData.rawDataPtr->rawlen are + * the first variables, which are overwritten by the next received frame. + * since 4.3.0. + */ + IRRawlenType rawlen; ///< counter of entries in rawbuf of last received frame. + uint16_t initialGapTicks; ///< contains the initial gap (pre 4.4: the value in rawbuf[0]) of the last received frame. + irparams_struct *rawDataPtr; ///< Pointer of the raw timing data to be decoded. Mainly the OverflowFlag and the data buffer filled by receiving ISR. }; +extern uint8_t sLastSendToggleValue; // Currently used by RC5 + RC6 + struct PulseDistanceWidthProtocolConstants { decode_type_t ProtocolIndex; uint_fast8_t FrequencyKHz; @@ -132,12 +146,9 @@ struct PulseDistanceWidthProtocolConstants { /* * Definitions for member PulseDistanceWidthProtocolConstants.Flags */ -#define SUPPRESS_STOP_BIT_FOR_THIS_DATA 0x20 -#define PROTOCOL_IS_MSB_FIRST IRDATA_FLAGS_IS_MSB_FIRST -#define PROTOCOL_IS_LSB_FIRST IRDATA_FLAGS_IS_LSB_FIRST -// 2 definitions for deprecated parameter bool aSendStopBit -#define SEND_STOP_BIT true -#define SEND_NO_STOP_BIT false +#define SUPPRESS_STOP_BIT 0x20 // Stop bit is otherwise sent for all pulse distance protocols, i.e. aOneSpaceMicros != aZeroSpaceMicros. +#define PROTOCOL_IS_MSB_FIRST IRDATA_FLAGS_IS_MSB_FIRST +#define PROTOCOL_IS_LSB_FIRST IRDATA_FLAGS_IS_LSB_FIRST /* * Carrier frequencies for various protocols @@ -160,7 +171,8 @@ const __FlashStringHelper* getProtocolString(decode_type_t aProtocol); #else const char* getProtocolString(decode_type_t aProtocol); #endif -void printIRResultShort(Print *aSerial, IRData *aIRDataPtr, bool aPrintGap); // A static function to be able to print send or copied received data. +void printIRResultShort(Print *aSerial, IRData *aIRDataPtr, bool aPrintRepeatGap) __attribute__ ((deprecated ("Remove last parameter, it is not supported any more."))); +void printIRResultShort(Print *aSerial, IRData *aIRDataPtr); // A static function to be able to print send or copied received data. /* * Convenience functions to convert MSB to LSB values diff --git a/src/IRProtocol.hpp b/src/IRProtocol.hpp index 093d2a8f4..bed8fa7a6 100644 --- a/src/IRProtocol.hpp +++ b/src/IRProtocol.hpp @@ -33,17 +33,12 @@ #ifndef _IR_PROTOCOL_HPP #define _IR_PROTOCOL_HPP -#if defined(DEBUG) && !defined(LOCAL_DEBUG) +#if defined(DEBUG) #define LOCAL_DEBUG #else //#define LOCAL_DEBUG // This enables debug output only for this file #endif -/* - * Check for additional characteristics of timing like length of mark for a constant mark protocol, - * where space length determines the bit value. Requires up to 194 additional bytes of program memory. - */ -//#define DECODE_STRICT_CHECKS /** \addtogroup Receiving Receiving IR data for multiple protocols * @{ */ @@ -67,9 +62,10 @@ const char string_Kaseikyo_JVC[] PROGMEM = "Kaseikyo_JVC"; const char string_Kaseikyo_Mitsubishi[] PROGMEM = "Kaseikyo_Mitsubishi"; const char string_RC5[] PROGMEM = "RC5"; const char string_RC6[] PROGMEM = "RC6"; +const char string_RC6A[] PROGMEM = "RC6A"; const char string_Samsung[] PROGMEM = "Samsung"; -const char string_Samsung48[] PROGMEM = "Samsung48"; const char string_SamsungLG[] PROGMEM = "SamsungLG"; +const char string_Samsung48[] PROGMEM = "Samsung48"; const char string_Sharp[] PROGMEM = "Sharp"; const char string_Sony[] PROGMEM = "Sony"; const char string_BangOlufsen[] PROGMEM = "Bang&Olufsen"; @@ -85,8 +81,8 @@ const char string_FAST[] PROGMEM = "FAST"; const char *const ProtocolNames[] PROGMEM = { string_Unknown, string_PulseWidth, string_PulseDistance, string_Apple, string_Denon, string_JVC, string_LG, string_LG2, string_NEC, string_NEC2, string_Onkyo, string_Panasonic, string_Kaseikyo, string_Kaseikyo_Denon, string_Kaseikyo_Sharp, - string_Kaseikyo_JVC, string_Kaseikyo_Mitsubishi, string_RC5, string_RC6, string_Samsung, string_Samsung48, string_SamsungLG, - string_Sharp, string_Sony + string_Kaseikyo_JVC, string_Kaseikyo_Mitsubishi, string_RC5, string_RC6, string_RC6A, string_Samsung, string_SamsungLG, + string_Samsung48, string_Sharp, string_Sony #if !defined(EXCLUDE_EXOTIC_PROTOCOLS) , string_BangOlufsen, string_BoseWave, string_Lego, string_MagiQuest, string_Whynter, string_FAST #endif @@ -154,6 +150,10 @@ namespace PrintULL { # endif #endif +/** @} + * \addtogroup Print Print functions + * @{ + */ /** * Function to print decoded result and flags in one line. * A static function to be able to print data to send or copied received data. @@ -165,6 +165,10 @@ namespace PrintULL { * */ void printIRResultShort(Print *aSerial, IRData *aIRDataPtr, bool aPrintRepeatGap) { + (void) aPrintRepeatGap; + printIRResultShort(aSerial, aIRDataPtr); +} +void printIRResultShort(Print *aSerial, IRData *aIRDataPtr) { if (aIRDataPtr->flags & IRDATA_FLAGS_WAS_OVERFLOW) { aSerial->println(F("Overflow")); return; @@ -183,7 +187,7 @@ void printIRResultShort(Print *aSerial, IRData *aIRDataPtr, bool aPrintRepeatGap #endif #if !defined(DISABLE_CODE_FOR_RECEIVER) aSerial->print(' '); - aSerial->print((aIRDataPtr->rawDataPtr->rawlen + 1) / 2, DEC); + aSerial->print((aIRDataPtr->rawlen + 1) / 2, DEC); aSerial->println(F(" bits (incl. gap and start) received")); #endif } else { @@ -214,22 +218,6 @@ void printIRResultShort(Print *aSerial, IRData *aIRDataPtr, bool aPrintRepeatGap #if defined(DECODE_DISTANCE_WIDTH) } #endif - if (aIRDataPtr->flags & (IRDATA_FLAGS_IS_AUTO_REPEAT | IRDATA_FLAGS_IS_REPEAT)) { - aSerial->print(' '); - if (aIRDataPtr->flags & IRDATA_FLAGS_IS_AUTO_REPEAT) { - aSerial->print(F("Auto-")); - } - aSerial->print(F("Repeat")); -#if !defined(DISABLE_CODE_FOR_RECEIVER) - if (aPrintRepeatGap) { - aSerial->print(F(" gap=")); - aSerial->print((uint32_t) aIRDataPtr->rawDataPtr->rawbuf[0] * MICROS_PER_TICK); - aSerial->print(F("us")); - } -#else - (void)aPrintRepeatGap; -#endif - } /* * Print raw data @@ -249,17 +237,44 @@ void printIRResultShort(Print *aSerial, IRData *aIRDataPtr, bool aPrintRepeatGap aSerial->print(F(" bits")); if (aIRDataPtr->flags & IRDATA_FLAGS_IS_MSB_FIRST) { - aSerial->println(F(" MSB first")); + aSerial->print(F(" MSB first")); } else { - aSerial->println(F(" LSB first")); + aSerial->print(F(" LSB first")); } + } - } else { - aSerial->println(); + /* + * Print gap and duration, in order to be able to compute the repeat period of the protocol by adding the next gap time + */ + if (aIRDataPtr->flags & (IRDATA_FLAGS_IS_AUTO_REPEAT | IRDATA_FLAGS_IS_REPEAT)) { + aSerial->print(' '); + if (aIRDataPtr->flags & IRDATA_FLAGS_IS_AUTO_REPEAT) { + aSerial->print(F("Auto-")); + } + aSerial->print(F("Repeat")); + } +#if !defined(DISABLE_CODE_FOR_RECEIVER) + aSerial->print(F(" Gap=")); + aSerial->print((uint32_t) aIRDataPtr->initialGapTicks * MICROS_PER_TICK); + aSerial->print(F("us")); + + uint16_t tSumOfDurationTicks = 0; + for (IRRawlenType i = 1; i < aIRDataPtr->rawlen; i++) { + tSumOfDurationTicks += aIRDataPtr->rawDataPtr->rawbuf[i]; } + aSerial->print(F(" Duration=")); + aSerial->print((uint32_t) tSumOfDurationTicks * MICROS_PER_TICK, DEC); + aSerial->println(F("us")); +#else + aSerial->println(); +#endif } } +/** @} + * \addtogroup Utils Utility functions + * @{ + */ /********************************************************************************************************************** * Function to bit reverse OLD MSB values of e.g. NEC. **********************************************************************************************************************/ diff --git a/src/IRReceive.hpp b/src/IRReceive.hpp index dd9da6b3f..1c6ab4fb5 100644 --- a/src/IRReceive.hpp +++ b/src/IRReceive.hpp @@ -33,8 +33,8 @@ #ifndef _IR_RECEIVE_HPP #define _IR_RECEIVE_HPP -#if defined(DEBUG) && !defined(LOCAL_DEBUG) -#define LOCAL_DEBUG +#if defined(DEBUG) +//#define LOCAL_DEBUG // #else //#define LOCAL_DEBUG // This enables debug output only for this file #endif @@ -50,11 +50,6 @@ //#define _IR_MEASURE_TIMING // for ISR //#define _IR_TIMING_TEST_PIN 7 // "pinModeFast(_IR_TIMING_TEST_PIN, OUTPUT);" is executed at start() // -/* - * Check for additional characteristics of timing like length of mark for a constant mark protocol, - * where space length determines the bit value. Requires up to 194 additional bytes of program memory. - */ -//#define DECODE_STRICT_CHECKS /** \addtogroup Receiving Receiving IR data for multiple protocols * @{ */ @@ -67,6 +62,7 @@ IRrecv IrReceiver; * The control structure instance */ struct irparams_struct irparams; // the irparams instance +unsigned long sMicrosAtLastStopTimer = 0; // Used to adjust TickCounterForISR with uncounted ticks between stopTimer() and restartTimer() /** * Instantiate the IRrecv class. Multiple instantiation is not supported. @@ -75,7 +71,7 @@ struct irparams_struct irparams; // the irparams instance IRrecv::IRrecv() { decodedIRData.rawDataPtr = &irparams; // for decodePulseDistanceData() etc. setReceivePin(0); -#if !defined(NO_LED_FEEDBACK_CODE) +#if !defined(NO_LED_RECEIVE_FEEDBACK_CODE) setLEDFeedback(0, DO_NOT_ENABLE_LED_FEEDBACK); #endif } @@ -83,7 +79,7 @@ IRrecv::IRrecv() { IRrecv::IRrecv(uint_fast8_t aReceivePin) { decodedIRData.rawDataPtr = &irparams; // for decodePulseDistanceData() etc. setReceivePin(aReceivePin); -#if !defined(NO_LED_FEEDBACK_CODE) +#if !defined(NO_LED_RECEIVE_FEEDBACK_CODE) setLEDFeedback(0, DO_NOT_ENABLE_LED_FEEDBACK); #endif } @@ -96,7 +92,7 @@ IRrecv::IRrecv(uint_fast8_t aReceivePin) { IRrecv::IRrecv(uint_fast8_t aReceivePin, uint_fast8_t aFeedbackLEDPin) { decodedIRData.rawDataPtr = &irparams; // for decodePulseDistanceData() etc. setReceivePin(aReceivePin); -#if !defined(NO_LED_FEEDBACK_CODE) +#if !defined(NO_LED_RECEIVE_FEEDBACK_CODE) setLEDFeedback(aFeedbackLEDPin, DO_NOT_ENABLE_LED_FEEDBACK); #else (void) aFeedbackLEDPin; @@ -122,9 +118,11 @@ IRrecv::IRrecv(uint_fast8_t aReceivePin, uint_fast8_t aFeedbackLEDPin) { * **********************************************************************************************************************/ #if defined(ESP8266) || defined(ESP32) +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wvolatile" IRAM_ATTR #endif -void IRReceiveTimerInterruptHandler(){ +void IRReceiveTimerInterruptHandler() { #if defined(_IR_MEASURE_TIMING) && defined(_IR_TIMING_TEST_PIN) digitalWriteFast(_IR_TIMING_TEST_PIN, HIGH); // 2 clock cycles #endif @@ -169,14 +167,18 @@ void IRReceiveTimerInterruptHandler(){ * Initialize all state machine variables */ irparams.OverflowFlag = false; - irparams.rawbuf[0] = irparams.TickCounterForISR; + // irparams.rawbuf[0] = irparams.TickCounterForISR; + // Usage of initialGapTicks enables usage of 8 bit buffer instead of 16 bit since 4.4, + // because the big gap value is not stored in this buffer any more + irparams.initialGapTicks = irparams.TickCounterForISR; irparams.rawlen = 1; irparams.StateForISR = IR_REC_STATE_MARK; } // otherwise stay in idle state - irparams.TickCounterForISR = 0;// reset counter in both cases + irparams.TickCounterForISR = 0; // reset counter in both cases } - } else if (irparams.StateForISR == IR_REC_STATE_MARK) { // Timing mark + } else if (irparams.StateForISR == IR_REC_STATE_MARK) { + // Timing mark here, rawlen is even if (tIRInputLevel != INPUT_MARK) { /* * Mark ended here. Record mark time in rawbuf array @@ -186,52 +188,56 @@ void IRReceiveTimerInterruptHandler(){ #endif irparams.rawbuf[irparams.rawlen++] = irparams.TickCounterForISR; // record mark irparams.StateForISR = IR_REC_STATE_SPACE; - irparams.TickCounterForISR = 0;// This resets the tick counter also at end of frame :-) + irparams.TickCounterForISR = 0; // This resets the tick counter also at end of frame :-) } - } else if (irparams.StateForISR == IR_REC_STATE_SPACE) { // Timing space - if (tIRInputLevel == INPUT_MARK) { - /* - * Space ended here. Check for overflow and record space time in rawbuf array - */ + } else if (irparams.StateForISR == IR_REC_STATE_SPACE) { + /* + * In space receiving here, rawlen is odd + * Check for timeout or overflow + */ + if (irparams.TickCounterForISR > RECORD_GAP_TICKS || irparams.rawlen >= RAW_BUFFER_LENGTH - 1) { if (irparams.rawlen >= RAW_BUFFER_LENGTH) { // Flag up a read OverflowFlag; Stop the state machine irparams.OverflowFlag = true; - irparams.StateForISR = IR_REC_STATE_STOP; -#if !IR_REMOTE_DISABLE_RECEIVE_COMPLETE_CALLBACK - /* - * Call callback if registered (not NULL) - */ - if (irparams.ReceiveCompleteCallbackFunction != NULL) { - irparams.ReceiveCompleteCallbackFunction(); - } -#endif - } else { -#if defined(_IR_MEASURE_TIMING) && defined(_IR_TIMING_TEST_PIN) -// digitalWriteFast(_IR_TIMING_TEST_PIN, HIGH); // 2 clock cycles -#endif - irparams.rawbuf[irparams.rawlen++] = irparams.TickCounterForISR; // record space - irparams.StateForISR = IR_REC_STATE_MARK; } - irparams.TickCounterForISR = 0; - - } else if (irparams.TickCounterForISR > RECORD_GAP_TICKS) { /* - * Maximum space duration reached here. + * Overflow or maximum space duration reached here. * Current code is ready for processing! * We received a long space, which indicates gap between codes. * Switch to IR_REC_STATE_STOP * Don't reset TickCounterForISR; keep counting width of next leading space */ - irparams.StateForISR = IR_REC_STATE_STOP; -#if !IR_REMOTE_DISABLE_RECEIVE_COMPLETE_CALLBACK /* - * Call callback if registered (not NULL) + * These 2 variables allow to call resume() directly after decode. + * After resume(), decodedIRData.rawDataPtr->initialGapTicks and decodedIRData.rawDataPtr->rawlen are + * the first variables, which are overwritten by the next received frame. + * since 4.3.0. + * For backward compatibility, there are the same 2 statements in decode() if IrReceiver is not used. */ - if (irparams.ReceiveCompleteCallbackFunction != NULL) { + IrReceiver.decodedIRData.initialGapTicks = irparams.initialGapTicks; + IrReceiver.decodedIRData.rawlen = irparams.rawlen; + + irparams.StateForISR = IR_REC_STATE_STOP; // This signals the decode(), that a complete frame was received +#if !defined(IR_REMOTE_DISABLE_RECEIVE_COMPLETE_CALLBACK) + /* + * Call callback if registered (not nullptr) + */ + if (irparams.ReceiveCompleteCallbackFunction != nullptr) { irparams.ReceiveCompleteCallbackFunction(); } #endif + } else if (tIRInputLevel == INPUT_MARK) { + /* + * Space ended here. + */ + +#if defined(_IR_MEASURE_TIMING) && defined(_IR_TIMING_TEST_PIN) +// digitalWriteFast(_IR_TIMING_TEST_PIN, HIGH); // 2 clock cycles +#endif + irparams.rawbuf[irparams.rawlen++] = irparams.TickCounterForISR; // record space + irparams.StateForISR = IR_REC_STATE_MARK; + irparams.TickCounterForISR = 0; } } else if (irparams.StateForISR == IR_REC_STATE_STOP) { /* @@ -247,8 +253,8 @@ void IRReceiveTimerInterruptHandler(){ } } -#if !defined(NO_LED_FEEDBACK_CODE) - if (FeedbackLEDControl.LedFeedbackEnabled == LED_FEEDBACK_ENABLED_FOR_RECEIVE) { +#if !defined(NO_LED_RECEIVE_FEEDBACK_CODE) + if (FeedbackLEDControl.LedFeedbackEnabled & LED_FEEDBACK_ENABLED_FOR_RECEIVE) { setFeedbackLED(tIRInputLevel == INPUT_MARK); } #endif @@ -277,6 +283,7 @@ ISR() /********************************************************************************************************************** * Stream like API **********************************************************************************************************************/ + /** * Initializes the receive and feedback pin * @param aReceivePin The Arduino pin number, where a demodulating IR receiver is connected. @@ -286,8 +293,8 @@ ISR() void IRrecv::begin(uint_fast8_t aReceivePin, bool aEnableLEDFeedback, uint_fast8_t aFeedbackLEDPin) { setReceivePin(aReceivePin); -#if !defined(NO_LED_FEEDBACK_CODE) - bool tEnableLEDFeedback = DO_NOT_ENABLE_LED_FEEDBACK; +#if !defined(NO_LED_RECEIVE_FEEDBACK_CODE) + uint_fast8_t tEnableLEDFeedback = DO_NOT_ENABLE_LED_FEEDBACK; if (aEnableLEDFeedback) { tEnableLEDFeedback = LED_FEEDBACK_ENABLED_FOR_RECEIVE; } @@ -309,19 +316,45 @@ void IRrecv::begin(uint_fast8_t aReceivePin, bool aEnableLEDFeedback, uint_fast8 void IRrecv::setReceivePin(uint_fast8_t aReceivePinNumber) { irparams.IRReceivePin = aReceivePinNumber; #if defined(__AVR__) - irparams.IRReceivePinMask = digitalPinToBitMask(aReceivePinNumber); - irparams.IRReceivePinPortInputRegister = portInputRegister(digitalPinToPort(aReceivePinNumber)); +# if defined(__digitalPinToBit) + if (__builtin_constant_p(aReceivePinNumber)) { + irparams.IRReceivePinMask = 1UL << (__digitalPinToBit(aReceivePinNumber)); + } else { + irparams.IRReceivePinMask = digitalPinToBitMask(aReceivePinNumber); // requires 10 bytes PGM, even if not referenced (?because it is assembler code?) + } +# else + irparams.IRReceivePinMask = digitalPinToBitMask(aReceivePinNumber); // requires 10 bytes PGM, even if not referenced (?because it is assembler code?) +# endif +# if defined(__digitalPinToPINReg) + /* + * This code is 54 bytes smaller, if aReceivePinNumber is a constant :-), but 38 byte longer if it is not constant (,which is not likely). + */ + if (__builtin_constant_p(aReceivePinNumber)) { + irparams.IRReceivePinPortInputRegister = __digitalPinToPINReg(aReceivePinNumber); + } else { + irparams.IRReceivePinPortInputRegister = portInputRegister(digitalPinToPort(aReceivePinNumber)); // requires 44 bytes PGM, even if not referenced + } +# else + irparams.IRReceivePinPortInputRegister = portInputRegister(digitalPinToPort(aReceivePinNumber)); // requires 44 bytes PGM, even if not referenced +# endif #endif - // Set pin mode once. pinModeFast makes no difference here :-( - pinMode(aReceivePinNumber, INPUT); // Seems to be at least required by ESP32 + // Seems to be at least required by ESP32 + // Set pin mode once. pinModeFast makes no difference if used, but saves 224 if not referenced :-( + if (__builtin_constant_p(aReceivePinNumber)) { + pinModeFast(aReceivePinNumber, INPUT); + } else { + pinModeFast(aReceivePinNumber, INPUT); + } } +#if !defined(IR_REMOTE_DISABLE_RECEIVE_COMPLETE_CALLBACK) /** - * Sets the function to call if a protocol message has arrived + * Sets the function to call if a complete protocol frame has arrived */ void IRrecv::registerReceiveCompleteCallback(void (*aReceiveCompleteCallbackFunction)(void)) { irparams.ReceiveCompleteCallbackFunction = aReceiveCompleteCallbackFunction; } +#endif /** * Start the receiving process. @@ -342,6 +375,23 @@ void IRrecv::start() { pinModeFast(_IR_TIMING_TEST_PIN, OUTPUT); #endif } + +/* + * Restarts timer interrupts, adjusts TickCounterForISR for correct gap value after stopTimer(). Does not call resume()! + */ +void IRrecv::restartTimer() { + // Setup for cyclic 50 us interrupt + timerConfigForReceive(); // no interrupts enabled here! + // Timer interrupt is enabled after state machine reset + if (sMicrosAtLastStopTimer != 0) { + irparams.TickCounterForISR += (micros() - sMicrosAtLastStopTimer) / MICROS_PER_TICK; // adjust TickCounterForISR for correct gap value, which is used for repeat detection + sMicrosAtLastStopTimer = 0; + } + timerEnableReceiveInterrupt(); // Enables the receive sample timer interrupt which consumes a small amount of CPU every 50 us. +#ifdef _IR_MEASURE_TIMING + pinModeFast(_IR_TIMING_TEST_PIN, OUTPUT); +#endif +} /** * Alias for start(). */ @@ -350,26 +400,39 @@ void IRrecv::enableIRIn() { } /** - * Configures the timer and the state machine for IR reception. + * Configures the timer and the state machine for IR reception. Does not call resume()! + * We assume, that timer interrupts are disabled here, otherwise it makes no sense to use this functions. + * Therefore we do not need to guard the change of the volatile TickCounterForISR here :-). * The tick counter value is already at 100 when decode() gets true, because of the 5000 us minimal gap defined in RECORD_GAP_MICROS. + * If TickCounterForISR is not adjusted with the value of the microseconds, the timer was stopped, + * it can happen, that a new IR frame is recognized as a repeat, because the value of RECORD_GAP_MICROS + * was not reached by TickCounterForISR counter before receiving the new IR frame. * @param aMicrosecondsToAddToGapCounter To compensate for the amount of microseconds the timer was stopped / disabled. */ -void IRrecv::start(uint32_t aMicrosecondsToAddToGapCounter) { +void IRrecv::restartTimer(uint32_t aMicrosecondsToAddToGapCounter) { irparams.TickCounterForISR += aMicrosecondsToAddToGapCounter / MICROS_PER_TICK; - start(); + timerConfigForReceive(); // no interrupts enabled here! + timerEnableReceiveInterrupt(); // Enables the receive sample timer interrupt which consumes a small amount of CPU every 50 us. +#ifdef _IR_MEASURE_TIMING + pinModeFast(_IR_TIMING_TEST_PIN, OUTPUT); +#endif } -void IRrecv::startWithTicksToAdd(uint16_t aTicksToAddToGapCounter) { +/** + * Configures the timer and the state machine for IR reception. Does not call resume()! + * @param aTicksToAddToGapCounter To compensate for the amount of ticks the timer was stopped / disabled. + */ +void IRrecv::restartTimerWithTicksToAdd(uint16_t aTicksToAddToGapCounter) { irparams.TickCounterForISR += aTicksToAddToGapCounter; - start(); -} - -void IRrecv::addTicksToInternalTickCounter(uint16_t aTicksToAddToInternalTickCounter) { - irparams.TickCounterForISR += aTicksToAddToInternalTickCounter; + timerConfigForReceive(); // no interrupts enabled here! + timerEnableReceiveInterrupt(); // Enables the receive sample timer interrupt which consumes a small amount of CPU every 50 us. +#ifdef _IR_MEASURE_TIMING + pinModeFast(_IR_TIMING_TEST_PIN, OUTPUT); +#endif } +#if defined(ESP8266) || defined(ESP32) +#pragma GCC diagnostic push +#endif -void IRrecv::addMicrosToInternalTickCounter(uint16_t aMicrosecondsToAddToInternalTickCounter) { - irparams.TickCounterForISR += aMicrosecondsToAddToInternalTickCounter / MICROS_PER_TICK; -} /** * Restarts receiver after send. Is a NOP if sending does not require a timer. */ @@ -385,6 +448,14 @@ void IRrecv::restartAfterSend() { void IRrecv::stop() { timerDisableReceiveInterrupt(); } + +/* + * Stores microseconds of stop, to adjust TickCounterForISR in restartTimer() + */ +void IRrecv::stopTimer() { + timerDisableReceiveInterrupt(); + sMicrosAtLastStopTimer = micros(); +} /** * Alias for stop(). */ @@ -407,10 +478,11 @@ bool IRrecv::isIdle() { } /** - * Restart the ISR (Interrupt Service Routine) state machine, to enable receiving of the next IR frame + * Restart the ISR (Interrupt Service Routine) state machine, to enable receiving of the next IR frame. + * Internal counting of gap timing is independent of StateForISR and therefore independent of call time of resume(). */ void IRrecv::resume() { - // check allows to call resume at arbitrary places or more than once + // This check allows to call resume at arbitrary places or more than once if (irparams.StateForISR == IR_REC_STATE_STOP) { irparams.StateForISR = IR_REC_STATE_IDLE; } @@ -433,7 +505,7 @@ void IRrecv::initDecodedIRData() { } else { decodedIRData.flags = IRDATA_FLAGS_EMPTY; // save last protocol, command and address for repeat handling (where they are compared or copied back :-)) - lastDecodedProtocol = decodedIRData.protocol; // repeat patterns can be equal between protocols (e.g. NEC and LG), so we must keep the original one + lastDecodedProtocol = decodedIRData.protocol; // repeat patterns can be equal between protocols (e.g. NEC, Samsung and LG), so we must keep the original one lastDecodedCommand = decodedIRData.command; lastDecodedAddress = decodedIRData.address; @@ -453,16 +525,16 @@ bool IRrecv::available() { } /** - * If IR receiver data is available, returns pointer to IrReceiver.decodedIRData, else NULL. + * Returns pointer to IrReceiver.decodedIRData if IR receiver data is available, else nullptr. */ IRData* IRrecv::read() { if (irparams.StateForISR != IR_REC_STATE_STOP) { - return NULL; + return nullptr; } if (decode()) { return &decodedIRData; } else { - return NULL; + return nullptr; } } @@ -477,6 +549,14 @@ bool IRrecv::decode() { return false; } + /* + * Support for old examples, which do not use the default IrReceiver instance + */ + if (this != &IrReceiver) { + decodedIRData.initialGapTicks = irparams.initialGapTicks; + decodedIRData.rawlen = irparams.rawlen; + } + initDecodedIRData(); // sets IRDATA_FLAGS_WAS_OVERFLOW if (decodedIRData.flags & IRDATA_FLAGS_WAS_OVERFLOW) { @@ -487,8 +567,8 @@ bool IRrecv::decode() { return true; } -#if defined(DECODE_NEC) - IR_TRACE_PRINTLN(F("Attempting NEC decode")); +#if defined(DECODE_NEC) || defined(DECODE_ONKYO) + IR_TRACE_PRINTLN(F("Attempting NEC/Onkyo decode")); if (decodeNEC()) { return true; } @@ -628,33 +708,91 @@ bool IRrecv::decode() { * Common decode functions **********************************************************************************************************************/ /** - * Decode pulse distance width protocols. + * Decode pulse distance width protocols. We only check the mark or space length of a 1, otherwise we always assume a 0! * * We can have the following protocol timings - * Pulse distance: Pulses/marks are constant, pause/spaces have different length, like NEC. - * Pulse width: Pulses/marks have different length, pause/spaces are constant, like Sony. - * Pulse distance width: Pulses/marks and pause/spaces have different length, often the bit length is constant, like MagiQuest. - * Pulse distance width can be decoded like pulse width decoder, if this decoder does not check the length of pause/spaces. + * PULSE_DISTANCE: Pause/spaces have different length and determine the bit value, longer space is 1. Pulses/marks can be constant, like NEC. + * PULSE_WIDTH: Pulses/marks have different length and determine the bit value, longer mark is 1. Pause/spaces can be constant, like Sony. + * PULSE_DISTANCE_WIDTH: Pulses/marks and pause/spaces have different length, often the bit length is constant, like MagiQuest. Can be decoded by PULSE_DISTANCE decoder. * * Input is IrReceiver.decodedIRData.rawDataPtr->rawbuf[] * Output is IrReceiver.decodedIRData.decodedRawData * - * Assume pulse distance if aOneMarkMicros == aZeroMarkMicros + * Assume PULSE_DISTANCE if aOneMarkMicros == aZeroMarkMicros * * @param aNumberOfBits Number of bits to decode from decodedIRData.rawDataPtr->rawbuf[] array. * @param aStartOffset Offset in decodedIRData.rawDataPtr->rawbuf[] to start decoding. Must point to a mark. - * @param aOneMarkMicros Taken as constant BitMarkMicros for pulse distance. - * @param aZeroMarkMicros Not required if DECODE_STRICT_CHECKS is not defined. - * @param aOneSpaceMicros Taken as (constant) BitSpaceMicros for pulse width. - * @param aZeroSpaceMicros Not required if DECODE_STRICT_CHECKS is not defined. + * @param aOneMarkMicros Checked if PULSE_WIDTH + * @param aZeroMarkMicros Required for deciding if we have PULSE_DISTANCE. + * @param aOneSpaceMicros Checked if PULSE_DISTANCE. * @param aMSBfirst If true send Most Significant Bit first, else send Least Significant Bit (lowest bit) first. * @return true If decoding was successful */ -bool IRrecv::decodePulseDistanceWidthData(uint_fast8_t aNumberOfBits, uint_fast8_t aStartOffset, uint16_t aOneMarkMicros, - uint16_t aZeroMarkMicros, uint16_t aOneSpaceMicros, uint16_t aZeroSpaceMicros, bool aMSBfirst) { +bool IRrecv::decodePulseDistanceWidthData(uint_fast8_t aNumberOfBits, IRRawlenType aStartOffset, uint16_t aOneMarkMicros, + uint16_t aOneSpaceMicros, uint16_t aZeroMarkMicros, bool aMSBfirst) { auto *tRawBufPointer = &decodedIRData.rawDataPtr->rawbuf[aStartOffset]; + bool isPulseDistanceProtocol = (aOneMarkMicros == aZeroMarkMicros); // If true, we check aOneSpaceMicros -> pulse distance protocol + + IRRawDataType tDecodedData = 0; // For MSB first tDecodedData is shifted left each loop + IRRawDataType tMask = 1UL; // Mask is only used for LSB first + + for (uint_fast8_t i = aNumberOfBits; i > 0; i--) { + // get one mark and space pair + unsigned int tMarkTicks; + unsigned int tSpaceTicks; + bool tBitValue; + + if (isPulseDistanceProtocol) { + /* + * PULSE_DISTANCE -including PULSE_DISTANCE_WIDTH- here. + * !!!We only check variable length space indicating a 1 or 0!!! + */ + tRawBufPointer++; + tSpaceTicks = *tRawBufPointer++; // maybe buffer overflow for last bit, but we do not evaluate this value :-) + tBitValue = matchSpace(tSpaceTicks, aOneSpaceMicros); // Check for variable length space indicating a 1 or 0 + + } else { + /* + * PULSE_WIDTH here. + * !!!We only check variable length mark indicating a 1 or 0!!! + */ + tMarkTicks = *tRawBufPointer++; + tBitValue = matchMark(tMarkTicks, aOneMarkMicros); // Check for variable length mark indicating a 1 or 0 + tRawBufPointer++; + } + + if (aMSBfirst) { + tDecodedData <<= 1; + } + + if (tBitValue) { + // It's a 1 -> set the bit + if (aMSBfirst) { + tDecodedData |= 1; + } else { + tDecodedData |= tMask; + } + IR_TRACE_PRINTLN(F("=> 1")); + } else { + // do not set the bit + IR_TRACE_PRINTLN(F("=> 0")); + } + tMask <<= 1; + } + decodedIRData.decodedRawData = tDecodedData; + return true; +} + +/* + * Old deprecated version with 7 parameters and unused aZeroSpaceMicros parameter + */ +bool IRrecv::decodePulseDistanceWidthData(uint_fast8_t aNumberOfBits, IRRawlenType aStartOffset, uint16_t aOneMarkMicros, + uint16_t aZeroMarkMicros, uint16_t aOneSpaceMicros, uint16_t aZeroSpaceMicros, bool aMSBfirst) { + + (void) aZeroSpaceMicros; + auto *tRawBufPointer = &decodedIRData.rawDataPtr->rawbuf[aStartOffset]; bool isPulseDistanceProtocol = (aOneMarkMicros == aZeroMarkMicros); // If true, we have a constant mark -> pulse distance protocol IRRawDataType tDecodedData = 0; // For MSB first tDecodedData is shifted left each loop @@ -664,23 +802,84 @@ bool IRrecv::decodePulseDistanceWidthData(uint_fast8_t aNumberOfBits, uint_fast8 // get one mark and space pair unsigned int tMarkTicks; unsigned int tSpaceTicks; + bool tBitValue; if (isPulseDistanceProtocol) { /* * Pulse distance here, it is not required to check constant mark duration (aOneMarkMicros) and zero space duration. */ -#if defined DECODE_STRICT_CHECKS - tMarkTicks = *tRawBufPointer++; -#else + (void) aZeroSpaceMicros; tRawBufPointer++; -#endif tSpaceTicks = *tRawBufPointer++; // maybe buffer overflow for last bit, but we do not evaluate this value :-) + tBitValue = matchSpace(tSpaceTicks, aOneSpaceMicros); // Check for variable length space indicating a 1 or 0 + } else { + /* + * Pulse width here, it is not required to check (constant) space duration and zero mark duration. + */ + tMarkTicks = *tRawBufPointer++; + tBitValue = matchMark(tMarkTicks, aOneMarkMicros); // Check for variable length mark indicating a 1 or 0 + tRawBufPointer++; + } + + if (aMSBfirst) { + tDecodedData <<= 1; + } + + if (tBitValue) { + // It's a 1 -> set the bit + if (aMSBfirst) { + tDecodedData |= 1; + } else { + tDecodedData |= tMask; + } + IR_TRACE_PRINTLN(F("=> 1")); + } else { + // do not set the bit + IR_TRACE_PRINTLN(F("=> 0")); + } + tMask <<= 1; + } + decodedIRData.decodedRawData = tDecodedData; + return true; +} + +/* + * Check for additional required characteristics of timing like length of mark for a constant mark protocol, + * where space length determines the bit value. Requires up to 194 additional bytes of program memory. + * Only sensible for development or very exotic requirements. + * @param aZeroMarkMicros For strict checks + * @param aZeroSpaceMicros For strict checks + * + * Not used yet + */ +bool IRrecv::decodePulseDistanceWidthDataStrict(uint_fast8_t aNumberOfBits, IRRawlenType aStartOffset, uint16_t aOneMarkMicros, + uint16_t aZeroMarkMicros, uint16_t aOneSpaceMicros, uint16_t aZeroSpaceMicros, bool aMSBfirst) { + + auto *tRawBufPointer = &decodedIRData.rawDataPtr->rawbuf[aStartOffset]; + + bool isPulseDistanceProtocol = (aOneMarkMicros == aZeroMarkMicros); // If true, we have a constant mark -> pulse distance protocol + + IRRawDataType tDecodedData = 0; // For MSB first tDecodedData is shifted left each loop + IRRawDataType tMask = 1UL; // Mask is only used for LSB first + + for (uint_fast8_t i = aNumberOfBits; i > 0; i--) { + // get one mark and space pair + unsigned int tMarkTicks; + unsigned int tSpaceTicks; + bool tBitValue; + + if (isPulseDistanceProtocol) { + /* + * PULSE_DISTANCE here, it is not required to check constant mark duration (aOneMarkMicros) and zero space duration. + */ + tMarkTicks = *tRawBufPointer++; + tSpaceTicks = *tRawBufPointer++; // maybe buffer overflow for last bit, but we do not evaluate this value :-) + tBitValue = matchSpace(tSpaceTicks, aOneSpaceMicros); // Check for variable length space indicating a 1 or 0 -#if defined DECODE_STRICT_CHECKS // Check for constant length mark if (!matchMark(tMarkTicks, aOneMarkMicros)) { -# if defined(LOCAL_DEBUG) +#if defined(LOCAL_DEBUG) Serial.print(F("Mark=")); Serial.print(tMarkTicks * MICROS_PER_TICK); Serial.print(F(" is not ")); @@ -688,39 +887,25 @@ bool IRrecv::decodePulseDistanceWidthData(uint_fast8_t aNumberOfBits, uint_fast8 Serial.print(F(". Index=")); Serial.print(aNumberOfBits - i); Serial.print(' '); -# endif +#endif return false; } -#endif } else { /* - * Pulse width here, it is not required to check (constant) space duration and zero mark duration. + * PULSE_DISTANCE -including PULSE_DISTANCE_WIDTH- here. + * !!!We only check variable length mark indicating a 1 or 0!!! + * It is not required to check space duration and zero mark duration. */ tMarkTicks = *tRawBufPointer++; -#if defined DECODE_STRICT_CHECKS + tBitValue = matchMark(tMarkTicks, aOneMarkMicros); // Check for variable length mark indicating a 1 or 0 tSpaceTicks = *tRawBufPointer++; // maybe buffer overflow for last bit, but we do not evaluate this value :-) -#else - (void) aZeroMarkMicros; - (void) aZeroSpaceMicros; - tRawBufPointer++; -#endif } if (aMSBfirst) { tDecodedData <<= 1; } -#pragma GCC diagnostic push -#pragma GCC diagnostic ignored "-Wmaybe-uninitialized" - bool tBitValue; - if (isPulseDistanceProtocol) { - // Check for variable length space indicating a 1 or 0 - tBitValue = matchSpace(tSpaceTicks, aOneSpaceMicros); // tSpaceTicks is initialized here, even if some compiler are complaining! - } else { - // Check for variable length mark indicating a 1 or 0 - tBitValue = matchMark(tMarkTicks, aOneMarkMicros); // tMarkTicks is initialized here, even if some compiler are complaining! - } -#pragma GCC diagnostic pop + if (tBitValue) { // It's a 1 -> set the bit if (aMSBfirst) { @@ -728,15 +913,15 @@ bool IRrecv::decodePulseDistanceWidthData(uint_fast8_t aNumberOfBits, uint_fast8 } else { tDecodedData |= tMask; } - IR_TRACE_PRINTLN('1'); + IR_TRACE_PRINTLN(F("=> 1")); } else { -#if defined DECODE_STRICT_CHECKS /* - * Additionally check length of length parameter which determine a zero + * Additionally check length of tSpaceTicks parameter for PULSE_DISTANCE or tMarkTicks for PULSE_WIDTH + * which determine a zero */ if (isPulseDistanceProtocol) { if (!matchSpace(tSpaceTicks, aZeroSpaceMicros)) { -# if defined(LOCAL_DEBUG) +#if defined(LOCAL_DEBUG) Serial.print(F("Space=")); Serial.print(tSpaceTicks * MICROS_PER_TICK); Serial.print(F(" is not ")); @@ -746,12 +931,12 @@ bool IRrecv::decodePulseDistanceWidthData(uint_fast8_t aNumberOfBits, uint_fast8 Serial.print(F(". Index=")); Serial.print(aNumberOfBits - i); Serial.print(' '); -# endif +#endif return false; } } else { if (!matchMark(tMarkTicks, aZeroMarkMicros)) { -# if defined(LOCAL_DEBUG) +#if defined(LOCAL_DEBUG) Serial.print(F("Mark=")); Serial.print(tMarkTicks * MICROS_PER_TICK); Serial.print(F(" is not ")); @@ -761,21 +946,19 @@ bool IRrecv::decodePulseDistanceWidthData(uint_fast8_t aNumberOfBits, uint_fast8 Serial.print(F(". Index=")); Serial.print(aNumberOfBits - i); Serial.print(' '); -# endif +#endif return false; } } -#endif // do not set the bit - IR_TRACE_PRINTLN('0'); + IR_TRACE_PRINTLN(F("=> 0")); } -#if defined DECODE_STRICT_CHECKS // If we have no stop bit, assume that last space, which is not recorded, is correct, since we can not check it if (aZeroSpaceMicros == aOneSpaceMicros && tRawBufPointer < &decodedIRData.rawDataPtr->rawbuf[decodedIRData.rawDataPtr->rawlen]) { // Check for constant length space (of pulse width protocol) here if (!matchSpace(tSpaceTicks, aOneSpaceMicros)) { -# if defined(LOCAL_DEBUG) +#if defined(LOCAL_DEBUG) Serial.print(F("Space=")); Serial.print(tSpaceTicks * MICROS_PER_TICK); Serial.print(F(" is not ")); @@ -783,11 +966,10 @@ bool IRrecv::decodePulseDistanceWidthData(uint_fast8_t aNumberOfBits, uint_fast8 Serial.print(F(". Index=")); Serial.print(aNumberOfBits - i); Serial.print(' '); -# endif +#endif return false; } } -#endif tMask <<= 1; } decodedIRData.decodedRawData = tDecodedData; @@ -799,19 +981,28 @@ bool IRrecv::decodePulseDistanceWidthData(uint_fast8_t aNumberOfBits, uint_fast8 * @return true if decoding was successful */ bool IRrecv::decodePulseDistanceWidthData(PulseDistanceWidthProtocolConstants *aProtocolConstants, uint_fast8_t aNumberOfBits, - uint_fast8_t aStartOffset) { + IRRawlenType aStartOffset) { return decodePulseDistanceWidthData(aNumberOfBits, aStartOffset, aProtocolConstants->DistanceWidthTimingInfo.OneMarkMicros, - aProtocolConstants->DistanceWidthTimingInfo.ZeroMarkMicros, aProtocolConstants->DistanceWidthTimingInfo.OneSpaceMicros, - aProtocolConstants->DistanceWidthTimingInfo.ZeroSpaceMicros, aProtocolConstants->Flags); + aProtocolConstants->DistanceWidthTimingInfo.OneSpaceMicros, aProtocolConstants->DistanceWidthTimingInfo.ZeroMarkMicros, + aProtocolConstants->Flags); +} + +bool IRrecv::decodePulseDistanceWidthData_P(PulseDistanceWidthProtocolConstants const *aProtocolConstantsPGM, + uint_fast8_t aNumberOfBits, IRRawlenType aStartOffset) { + PulseDistanceWidthProtocolConstants tTemporaryPulseDistanceWidthProtocolConstants; + memcpy_P(&tTemporaryPulseDistanceWidthProtocolConstants, aProtocolConstantsPGM, + sizeof(tTemporaryPulseDistanceWidthProtocolConstants)); + + return decodePulseDistanceWidthData(&tTemporaryPulseDistanceWidthProtocolConstants, aNumberOfBits, aStartOffset); } /* * Static variables for the getBiphaselevel function */ -uint_fast8_t sBiphaseDecodeRawbuffOffset; // Index into raw timing array +uint_fast8_t sBiphaseDecodeRawbuffOffset; // Index into raw timing array uint16_t sBiphaseCurrentTimingIntervals; // 1, 2 or 3. Number of aBiphaseTimeUnit intervals of the current rawbuf[sBiphaseDecodeRawbuffOffset] timing. -uint_fast8_t sBiphaseUsedTimingIntervals; // Number of already used intervals of sCurrentTimingIntervals. +uint_fast8_t sBiphaseUsedTimingIntervals; // Number of already used intervals of sCurrentTimingIntervals. uint16_t sBiphaseTimeUnit; void IRrecv::initBiphaselevel(uint_fast8_t aRCDecodeRawbuffOffset, uint16_t aBiphaseTimeUnit) { @@ -839,7 +1030,7 @@ void IRrecv::initBiphaselevel(uint_fast8_t aRCDecodeRawbuffOffset, uint16_t aBip uint_fast8_t IRrecv::getBiphaselevel() { uint_fast8_t tLevelOfCurrentInterval; // 0 (SPACE) or 1 (MARK) - if (sBiphaseDecodeRawbuffOffset >= decodedIRData.rawDataPtr->rawlen) { + if (sBiphaseDecodeRawbuffOffset >= decodedIRData.rawlen) { return SPACE; // After end of recorded buffer, assume space. } @@ -878,10 +1069,12 @@ uint_fast8_t IRrecv::getBiphaselevel() { return tLevelOfCurrentInterval; } -#if defined(DECODE_HASH) /********************************************************************************************************************** * Internal Hash decode function **********************************************************************************************************************/ +#define FNV_PRIME_32 16777619 ///< used for decodeHash() +#define FNV_BASIS_32 2166136261 ///< used for decodeHash() + /** * Compare two (tick) values for Hash decoder * Use a tolerance of 20% to enable e.g. 500 and 600 (NEC timing) to be equal @@ -897,21 +1090,17 @@ uint_fast8_t IRrecv::compare(uint16_t oldval, uint16_t newval) { return 1; } -#define FNV_PRIME_32 16777619 ///< used for decodeHash() -#define FNV_BASIS_32 2166136261 ///< used for decodeHash() - /** - * decodeHash - decode an arbitrary IR code. + * Decodes an arbitrary IR code to a 32-bit value. * Instead of decoding using a standard encoding scheme * (e.g. Sony, NEC, RC5), the code is hashed to a 32-bit value. * - * The algorithm: look at the sequence of MARK signals, and see if each one - * is shorter (0), the same length (1), or longer (2) than the previous. - * Do the same with the SPACE signals. Hash the resulting sequence of 0's, - * 1's, and 2's to a 32-bit value. This will give a unique value for each - * different code (probably), for most code systems. + * The algorithm looks at the sequence of MARK and SPACE signals, and see if each one + * is shorter (0), the same length (1), or longer (2) than the previous MARK or SPACE. + * It hash the resulting sequence of 0's, 1's, and 2's to a 32-bit value. + * This will give a unique value for each different code (probably), for most code systems. * - * Use FNV hash algorithm: http://isthe.com/chongo/tech/comp/fnv/#FNV-param + * Uses FNV hash algorithm: http://isthe.com/chongo/tech/comp/fnv/#FNV-param * Converts the raw code values into a 32-bit hash code. * Hopefully this code is unique for each button. * This isn't a "real" decoding, just an arbitrary value. @@ -922,15 +1111,15 @@ bool IRrecv::decodeHash() { unsigned long hash = FNV_BASIS_32; // the result is the same no matter if we use a long or unsigned long variable // Require at least 6 samples to prevent triggering on noise - if (decodedIRData.rawDataPtr->rawlen < 6) { + if (decodedIRData.rawlen < 6) { + IR_DEBUG_PRINT(F("HASH: ")); + IR_DEBUG_PRINT(F("Data length=")); + IR_DEBUG_PRINT(decodedIRData.rawlen); + IR_DEBUG_PRINTLN(F(" is less than 6")); return false; } -#if RAW_BUFFER_LENGTH <= 254 // saves around 75 bytes program memory and speeds up ISR - uint_fast8_t i; -#else - unsigned int i; -#endif - for (i = 1; (i + 2) < decodedIRData.rawDataPtr->rawlen; i++) { + for (IRRawlenType i = 1; (i + 2) < decodedIRData.rawlen; i++) { + // Compare mark with mark and space with space uint_fast8_t value = compare(decodedIRData.rawDataPtr->rawbuf[i], decodedIRData.rawDataPtr->rawbuf[i + 2]); // Add value into the hash hash = (hash * FNV_PRIME_32) ^ value; @@ -964,7 +1153,6 @@ bool IRrecv::decodeHashOld(decode_results *aResults) { return true; } -#endif // DECODE_HASH /********************************************************************************************************************** * Match functions @@ -992,15 +1180,35 @@ bool IRrecv::checkHeader(PulseDistanceWidthProtocolConstants *aProtocolConstants return true; } +bool IRrecv::checkHeader_P(PulseDistanceWidthProtocolConstants const *aProtocolConstantsPGM) { +// Check header "mark" and "space" + if (!matchMark(decodedIRData.rawDataPtr->rawbuf[1], pgm_read_word(&aProtocolConstantsPGM->DistanceWidthTimingInfo.HeaderMarkMicros))) { +#if defined(LOCAL_TRACE) + Serial.print(::getProtocolString(aProtocolConstantsPGM->ProtocolIndex)); + Serial.println(F(": Header mark length is wrong")); +#endif + return false; + } + if (!matchSpace(decodedIRData.rawDataPtr->rawbuf[2], pgm_read_word(&aProtocolConstantsPGM->DistanceWidthTimingInfo.HeaderSpaceMicros))) { +#if defined(LOCAL_TRACE) + Serial.print(::getProtocolString(aProtocolConstantsPGM->ProtocolIndex)); + Serial.println(F(": Header space length is wrong")); +#endif + return false; + } + return true; +} + /* - * Do not check for same address and command, because it is almost not possible to press 2 different buttons on the remote within around 100 ms. + * Does not check for same address and command, because it is almost not possible to press 2 different buttons on the remote within around 100 ms. * And if really required, it can be enabled here, or done manually in user program. * And we have still no RC6 toggle bit check for detecting a second press on the same button. */ void IRrecv::checkForRepeatSpaceTicksAndSetFlag(uint16_t aMaximumRepeatSpaceTicks) { - if (decodedIRData.rawDataPtr->rawbuf[0] < aMaximumRepeatSpaceTicks -#if defined(ENABLE_FULL_REPEAT_CHECK) - && decodedIRData.address == lastDecodedAddress && decodedIRData.command == lastDecodedCommand /* requires around 85 bytes program space */ + if (decodedIRData.initialGapTicks < aMaximumRepeatSpaceTicks +#if defined(ENABLE_COMPLETE_REPEAT_CHECK) +// Check also for same command and address values to detect a repeat. Not sensible for standard protocols, because it is almost not possible to press 2 different buttons on the remote within around 100 ms + && decodedIRData.address == lastDecodedAddress && decodedIRData.command == lastDecodedCommand /* requires around 44 bytes program space */ #endif ) { decodedIRData.flags |= IRDATA_FLAGS_IS_REPEAT; @@ -1009,6 +1217,7 @@ void IRrecv::checkForRepeatSpaceTicksAndSetFlag(uint16_t aMaximumRepeatSpaceTick /** * Match function without compensating for marks exceeded or spaces shortened by demodulator hardware + * @return true, if values match * Currently not used */ bool matchTicks(uint16_t aMeasuredTicks, uint16_t aMatchValueMicros) { @@ -1037,6 +1246,7 @@ bool MATCH(uint16_t measured_ticks, uint16_t desired_us) { /** * Compensate for marks exceeded by demodulator hardware + * @return true, if values match */ bool matchMark(uint16_t aMeasuredTicks, uint16_t aMatchValueMicros) { #if defined(LOCAL_TRACE) @@ -1070,6 +1280,7 @@ bool MATCH_MARK(uint16_t measured_ticks, uint16_t desired_us) { /** * Compensate for spaces shortened by demodulator hardware + * @return true, if values match */ bool matchSpace(uint16_t aMeasuredTicks, uint16_t aMatchValueMicros) { #if defined(LOCAL_TRACE) @@ -1108,8 +1319,8 @@ int getMarkExcessMicros() { return MARK_EXCESS_MICROS; } -/* - * Check if protocol is not detected and detected space between two transmissions +/** + * Checks if protocol is not detected and detected space between two transmissions * is smaller than known value for protocols (Sony with around 24 ms) * @return true, if CheckForRecordGapsMicros() has printed a message, i.e. gap < 15ms (RECORD_GAP_MICROS_WARNING_THRESHOLD) */ @@ -1119,10 +1330,10 @@ bool IRrecv::checkForRecordGapsMicros(Print *aSerial) { * is smaller than known value for protocols (Sony with around 24 ms) */ if (decodedIRData.protocol <= PULSE_DISTANCE - && decodedIRData.rawDataPtr->rawbuf[0] < (RECORD_GAP_MICROS_WARNING_THRESHOLD / MICROS_PER_TICK)) { + && decodedIRData.initialGapTicks < (RECORD_GAP_MICROS_WARNING_THRESHOLD / MICROS_PER_TICK)) { aSerial->println(); aSerial->print(F("Space of ")); - aSerial->print(decodedIRData.rawDataPtr->rawbuf[0] * MICROS_PER_TICK); + aSerial->print(decodedIRData.initialGapTicks * MICROS_PER_TICK); aSerial->print(F(" us between two detected transmission is smaller than the minimal gap of ")); aSerial->print(RECORD_GAP_MICROS_WARNING_THRESHOLD); aSerial->println(F(" us known for implemented protocols like NEC, Sony, RC% etc..")); @@ -1142,8 +1353,14 @@ void IRrecv::printActiveIRProtocols(Print *aSerial) { // call no class function with same name ::printActiveIRProtocols(aSerial); } +/* + * Prints a list of enabled protocols for this application. + * @param aSerial pointer to serial used for printing. Use "&Serial". + */ void printActiveIRProtocols(Print *aSerial) { -#if defined(DECODE_NEC) +#if defined(DECODE_ONKYO) + aSerial->print(F("Onkyo, ")); +#elif defined(DECODE_NEC) aSerial->print(F("NEC/NEC2/Onkyo/Apple, ")); #endif #if defined(DECODE_PANASONIC) || defined(DECODE_KASEIKYO) @@ -1186,7 +1403,7 @@ void printActiveIRProtocols(Print *aSerial) { aSerial->print(F("Lego Power Functions, ")); #endif #if defined(DECODE_BOSEWAVE) - aSerial->print(F("Bosewave , ")); + aSerial->print(F("Bosewave, ")); #endif #if defined(DECODE_MAGIQUEST) aSerial->print(F("MagiQuest, ")); @@ -1207,14 +1424,13 @@ void printActiveIRProtocols(Print *aSerial) { * Ends with println(). * * @param aSerial The Print object on which to write, for Arduino you can use &Serial. - * @param aPrintRepeatGap If true also print the gap before repeats. * @param aCheckForRecordGapsMicros If true, call CheckForRecordGapsMicros() which may do a long printout, * which in turn may block the proper detection of repeats.* * @return true, if CheckForRecordGapsMicros() has printed a message, i.e. gap < 15ms (RECORD_GAP_MICROS_WARNING_THRESHOLD). */ -bool IRrecv::printIRResultShort(Print *aSerial, bool aPrintRepeatGap, bool aCheckForRecordGapsMicros) { +bool IRrecv::printIRResultShort(Print *aSerial, bool aCheckForRecordGapsMicros) { // call no class function with same name - ::printIRResultShort(aSerial, &decodedIRData, aPrintRepeatGap); + ::printIRResultShort(aSerial, &decodedIRData); if (aCheckForRecordGapsMicros && decodedIRData.protocol != UNKNOWN) { return checkForRecordGapsMicros(aSerial); } @@ -1235,9 +1451,55 @@ void IRrecv::printDistanceWidthTimingInfo(Print *aSerial, DistanceWidthTimingInf aSerial->print(aDistanceWidthTimingInfo->ZeroSpaceMicros); } +/* + * Get maximum of mark ticks in rawDataPtr. + * Skip leading start and trailing stop bit. + */ +uint8_t IRrecv::getMaximumMarkTicksFromRawData() { + uint8_t tMaximumTick = 0; + for (IRRawlenType i = 3; i < decodedIRData.rawlen - 2; i += 2) { // Skip leading start and trailing stop bit. + auto tTick = decodedIRData.rawDataPtr->rawbuf[i]; + if (tMaximumTick < tTick) { + tMaximumTick = tTick; + } + } + return tMaximumTick; +} +uint8_t IRrecv::getMaximumSpaceTicksFromRawData() { + uint8_t tMaximumTick = 0; + for (IRRawlenType i = 4; i < decodedIRData.rawlen - 2; i += 2) { // Skip leading start and trailing stop bit. + auto tTick = decodedIRData.rawDataPtr->rawbuf[i]; + if (tMaximumTick < tTick) { + tMaximumTick = tTick; + } + } + return tMaximumTick; +} + +/* + * The optimizing compiler internally generates this function, if getMaximumMarkTicksFromRawData() and getMaximumSpaceTicksFromRawData() is used. + */ +uint8_t IRrecv::getMaximumTicksFromRawData(bool aSearchSpaceInsteadOfMark) { + uint8_t tMaximumTick = 0; + IRRawlenType i; + if (aSearchSpaceInsteadOfMark) { + i = 4; + } else { + i = 3; + } + for (; i < decodedIRData.rawlen - 2; i += 2) { // Skip leading start and trailing stop bit. + auto tTick = decodedIRData.rawDataPtr->rawbuf[i]; + if (tMaximumTick < tTick) { + tMaximumTick = tTick; + } + } + return tMaximumTick; +} + uint32_t IRrecv::getTotalDurationOfRawData() { uint16_t tSumOfDurationTicks = 0; - for (uint_fast8_t i = 1; i < decodedIRData.rawDataPtr->rawlen; i++) { + + for (IRRawlenType i = 1; i < decodedIRData.rawlen; i++) { tSumOfDurationTicks += decodedIRData.rawDataPtr->rawbuf[i]; } return tSumOfDurationTicks * (uint32_t) MICROS_PER_TICK; @@ -1245,23 +1507,27 @@ uint32_t IRrecv::getTotalDurationOfRawData() { /** * Function to print values and flags of IrReceiver.decodedIRData in one line. + * do not print for repeats except IRDATA_FLAGS_IS_PROTOCOL_WITH_DIFFERENT_REPEAT. * Ends with println(). + * !!!Attention: The result differs on a 8 bit or 32 bit platform!!! * * @param aSerial The Print object on which to write, for Arduino you can use &Serial. */ void IRrecv::printIRSendUsage(Print *aSerial) { if (decodedIRData.protocol != UNKNOWN - && (decodedIRData.flags & (IRDATA_FLAGS_IS_AUTO_REPEAT | IRDATA_FLAGS_IS_REPEAT)) == 0x00) { + && ((decodedIRData.flags & (IRDATA_FLAGS_IS_AUTO_REPEAT | IRDATA_FLAGS_IS_REPEAT)) == 0x00 + || (decodedIRData.flags & IRDATA_FLAGS_IS_PROTOCOL_WITH_DIFFERENT_REPEAT))) { #if defined(DECODE_DISTANCE_WIDTH) - aSerial->print(F("Send with:")); uint_fast8_t tNumberOfArrayData = 0; if (decodedIRData.protocol == PULSE_DISTANCE || decodedIRData.protocol == PULSE_WIDTH) { # if __INT_WIDTH__ < 32 + aSerial->print(F("Send on a 8 bit platform with: ")); tNumberOfArrayData = ((decodedIRData.numberOfBits - 1) / 32) + 1; if(tNumberOfArrayData > 1) { aSerial->println(); aSerial->print(F(" uint32_t tRawData[]={0x")); # else + aSerial->print(F("Send on a 32 bit platform with: ")); tNumberOfArrayData = ((decodedIRData.numberOfBits - 1) / 64) + 1; if(tNumberOfArrayData > 1) { aSerial->println(); @@ -1278,10 +1544,13 @@ void IRrecv::printIRSendUsage(Print *aSerial) { } } aSerial->println(F("};")); - aSerial->print(F(" ")); + aSerial->print(F(" ")); } + } else { + aSerial->print(F("Send with: ")); } - aSerial->print(F(" IrSender.send")); + aSerial->print(F("IrSender.send")); + #else aSerial->print(F("Send with: IrSender.send")); #endif @@ -1322,11 +1591,11 @@ void IRrecv::printIRSendUsage(Print *aSerial) { /* * Pulse distance or pulse width here */ - aSerial->print("PulseDistanceWidth"); + aSerial->print(F("PulseDistanceWidth")); if(tNumberOfArrayData > 1) { - aSerial->print("FromArray(38, "); + aSerial->print(F("FromArray(38, ")); } else { - aSerial->print("(38, "); + aSerial->print(F("(38, ")); } printDistanceWidthTimingInfo(aSerial, &decodedIRData.DistanceWidthTimingInfo); @@ -1352,8 +1621,8 @@ void IRrecv::printIRSendUsage(Print *aSerial) { aSerial->print(F("SB_FIRST, , ")); } #endif -#if defined(DECODE_PANASONIC) || defined(DECODE_KASEIKYO) - if ((decodedIRData.flags & IRDATA_FLAGS_EXTRA_INFO) && decodedIRData.protocol == KASEIKYO) { +#if defined(DECODE_PANASONIC) || defined(DECODE_KASEIKYO) || defined(DECODE_RC6) + if ((decodedIRData.flags & IRDATA_FLAGS_EXTRA_INFO) && (decodedIRData.protocol == KASEIKYO || decodedIRData.protocol == RC6A)) { aSerial->print(F(", 0x")); aSerial->print(decodedIRData.extra, HEX); } @@ -1382,7 +1651,7 @@ void IRrecv::printIRResultMinimal(Print *aSerial) { # endif #endif aSerial->print(' '); - aSerial->print((decodedIRData.rawDataPtr->rawlen + 1) / 2, DEC); + aSerial->print((decodedIRData.rawlen + 1) / 2, DEC); aSerial->println(F(" bits received")); } else { /* @@ -1407,6 +1676,25 @@ void IRrecv::printIRResultMinimal(Print *aSerial) { } } +/* + * Not used yet + */ +void IRrecv::printIRDuration(Print *aSerial, bool aOutputMicrosecondsInsteadOfTicks) { + uint16_t tSumOfDurationTicks = 0; + for (IRRawlenType i = 1; i < decodedIRData.rawlen; i++) { + tSumOfDurationTicks += decodedIRData.rawDataPtr->rawbuf[i]; + } + aSerial->print(F("Duration=")); + if (aOutputMicrosecondsInsteadOfTicks) { + aSerial->print((uint32_t) tSumOfDurationTicks * MICROS_PER_TICK, DEC); + aSerial->println(F("us")); + + } else { + aSerial->print(tSumOfDurationTicks, DEC); + aSerial->println(F(" ticks")); + } +} + /** * Dump out the timings in IrReceiver.decodedIRData.rawDataPtr->rawbuf[] array 8 values per line. * @@ -1415,10 +1703,9 @@ void IRrecv::printIRResultMinimal(Print *aSerial) { */ void IRrecv::printIRResultRawFormatted(Print *aSerial, bool aOutputMicrosecondsInsteadOfTicks) { - uint8_t tRawlen = decodedIRData.rawDataPtr->rawlen; // Get it once here in order to print quite consistent data, even if ISR is running // Print Raw data aSerial->print(F("rawData[")); - aSerial->print(tRawlen, DEC); + aSerial->print(decodedIRData.rawlen, DEC); aSerial->println(F("]: ")); /* @@ -1426,15 +1713,10 @@ void IRrecv::printIRResultRawFormatted(Print *aSerial, bool aOutputMicrosecondsI */ aSerial->print(F(" -")); if (aOutputMicrosecondsInsteadOfTicks) { - aSerial->println((uint32_t) decodedIRData.rawDataPtr->rawbuf[0] * MICROS_PER_TICK, DEC); + aSerial->println((uint32_t) decodedIRData.initialGapTicks * MICROS_PER_TICK, DEC); } else { - aSerial->println(decodedIRData.rawDataPtr->rawbuf[0], DEC); + aSerial->println(decodedIRData.initialGapTicks, DEC); } -#if RAW_BUFFER_LENGTH <= 254 // saves around 75 bytes program memory and speeds up ISR - uint_fast8_t i; -#else - unsigned int i; -#endif // Newline is printed every 8. value, if tCounterForNewline % 8 == 0 uint_fast8_t tCounterForNewline = 6; // first newline is after the 2 values of the start bit @@ -1455,7 +1737,7 @@ void IRrecv::printIRResultRawFormatted(Print *aSerial, bool aOutputMicrosecondsI uint32_t tDuration; uint16_t tSumOfDurationTicks = 0; - for (i = 1; i < tRawlen; i++) { + for (IRRawlenType i = 1; i < decodedIRData.rawlen; i++) { auto tCurrentTicks = decodedIRData.rawDataPtr->rawbuf[i]; if (aOutputMicrosecondsInsteadOfTicks) { tDuration = tCurrentTicks * MICROS_PER_TICK; @@ -1482,7 +1764,7 @@ void IRrecv::printIRResultRawFormatted(Print *aSerial, bool aOutputMicrosecondsI } aSerial->print(tDuration, DEC); - if ((i & 1) && (i + 1) < tRawlen) { + if ((i & 1) && (i + 1) < decodedIRData.rawlen) { aSerial->print(','); //',' not required for last one } @@ -1493,12 +1775,17 @@ void IRrecv::printIRResultRawFormatted(Print *aSerial, bool aOutputMicrosecondsI } aSerial->println(); - aSerial->print("Sum: "); + aSerial->print(F("Duration=")); if (aOutputMicrosecondsInsteadOfTicks) { - aSerial->println((uint32_t) tSumOfDurationTicks * MICROS_PER_TICK, DEC); + aSerial->print((uint32_t) tSumOfDurationTicks * MICROS_PER_TICK, DEC); + aSerial->println(F("us")); + } else { - aSerial->println(tSumOfDurationTicks, DEC); + aSerial->print(tSumOfDurationTicks, DEC); + aSerial->println(F(" ticks")); } + aSerial->println(); + } /** @@ -1520,16 +1807,11 @@ void IRrecv::compensateAndPrintIRResultAsCArray(Print *aSerial, bool aOutputMicr aSerial->print(F("uint8_t rawTicks[")); // variable type, array name } - aSerial->print(decodedIRData.rawDataPtr->rawlen - 1, DEC); // array size + aSerial->print(decodedIRData.rawlen - 1, DEC); // array size aSerial->print(F("] = {")); // Start declaration // Dump data -#if RAW_BUFFER_LENGTH <= 254 // saves around 75 bytes program memory and speeds up ISR - uint_fast8_t i; -#else - unsigned int i; -#endif - for (i = 1; i < decodedIRData.rawDataPtr->rawlen; i++) { + for (IRRawlenType i = 1; i < decodedIRData.rawlen; i++) { uint32_t tDuration = decodedIRData.rawDataPtr->rawbuf[i] * MICROS_PER_TICK; if (i & 1) { @@ -1549,10 +1831,8 @@ void IRrecv::compensateAndPrintIRResultAsCArray(Print *aSerial, bool aOutputMicr tTicks = (tTicks > UINT8_MAX) ? UINT8_MAX : tTicks; aSerial->print(tTicks); } - if (i + 1 < decodedIRData.rawDataPtr->rawlen) - aSerial->print(','); // ',' not required on last one - if (!(i & 1)) - aSerial->print(' '); + if (i + 1 < decodedIRData.rawlen) aSerial->print(','); // ',' not required on last one + if (!(i & 1)) aSerial->print(' '); } // End declaration @@ -1563,7 +1843,7 @@ void IRrecv::compensateAndPrintIRResultAsCArray(Print *aSerial, bool aOutputMicr printIRResultShort(aSerial); // Newline - aSerial->println(""); + aSerial->println(); } /** @@ -1578,12 +1858,8 @@ void IRrecv::compensateAndPrintIRResultAsCArray(Print *aSerial, bool aOutputMicr void IRrecv::compensateAndStoreIRResultInArray(uint8_t *aArrayPtr) { // Store data, skip leading space# -#if RAW_BUFFER_LENGTH <= 254 // saves around 75 bytes program memory and speeds up ISR - uint_fast8_t i; -#else - unsigned int i; -#endif - for (i = 1; i < decodedIRData.rawDataPtr->rawlen; i++) { + IRRawlenType i; + for (i = 1; i < decodedIRData.rawlen; i++) { uint32_t tDuration = decodedIRData.rawDataPtr->rawbuf[i] * MICROS_PER_TICK; if (i & 1) { // Mark @@ -1654,23 +1930,17 @@ const char* IRrecv::getProtocolString() { * aResults->bits * aResults->decode_type **********************************************************************************************************************/ -bool IRrecv::decode(decode_results *aResults) { - static bool sDeprecationMessageSent = false; +bool IRrecv::decode_old(decode_results *aResults) { if (irparams.StateForISR != IR_REC_STATE_STOP) { return false; } - if (!sDeprecationMessageSent) { -#if !(defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) || defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__)) -// Serial.println( -// "The function decode(&results)) is deprecated and may not work as expected! Just use decode() without a parameter and IrReceiver.decodedIRData. ."); -#endif - sDeprecationMessageSent = true; - } - // copy for usage by legacy programs - aResults->rawbuf = irparams.rawbuf; + aResults->rawbuf[0] = irparams.initialGapTicks; + for (int i = 1; i < RAW_BUFFER_LENGTH; ++i) { + aResults->rawbuf[i] = irparams.rawbuf[i]; // copy 8 bit array into a 16 bit array + } aResults->rawlen = irparams.rawlen; if (irparams.OverflowFlag) { // Copy overflow flag to decodedIRData.flags diff --git a/src/IRSend.hpp b/src/IRSend.hpp index e063f7e55..f6c158df8 100644 --- a/src/IRSend.hpp +++ b/src/IRSend.hpp @@ -32,7 +32,7 @@ #ifndef _IR_SEND_HPP #define _IR_SEND_HPP -#if defined(DEBUG) && !defined(LOCAL_DEBUG) +#if defined(DEBUG) #define LOCAL_DEBUG #else //#define LOCAL_DEBUG // This enables debug output only for this file @@ -69,7 +69,7 @@ IRsend::IRsend() { // @suppress("Class members should be properly initialized") sendPin = 0; #endif -#if !defined(NO_LED_FEEDBACK_CODE) +#if !defined(NO_LED_SEND_FEEDBACK_CODE) setLEDFeedback(0, DO_NOT_ENABLE_LED_FEEDBACK); #endif } @@ -80,7 +80,7 @@ IRsend::IRsend() { // @suppress("Class members should be properly initialized") * Simple start with defaults - LED feedback enabled! Used if IR_SEND_PIN is defined. Saves program memory. */ void IRsend::begin(){ -# if !defined(NO_LED_FEEDBACK_CODE) +# if !defined(NO_LED_SEND_FEEDBACK_CODE) setLEDFeedback(USE_DEFAULT_FEEDBACK_LED_PIN, LED_FEEDBACK_ENABLED_FOR_SEND); # endif #if defined(_IR_MEASURE_TIMING) && defined(_IR_TIMING_TEST_PIN) @@ -94,8 +94,8 @@ void IRsend::begin(){ * @param aFeedbackLEDPin If 0 / USE_DEFAULT_FEEDBACK_LED_PIN, then take board specific FEEDBACK_LED_ON() and FEEDBACK_LED_OFF() functions */ void IRsend::begin(bool aEnableLEDFeedback, uint_fast8_t aFeedbackLEDPin) { -#if !defined(NO_LED_FEEDBACK_CODE) - bool tEnableLEDFeedback = DO_NOT_ENABLE_LED_FEEDBACK; +#if !defined(NO_LED_SEND_FEEDBACK_CODE) + uint_fast8_t tEnableLEDFeedback = DO_NOT_ENABLE_LED_FEEDBACK; if(aEnableLEDFeedback) { tEnableLEDFeedback = LED_FEEDBACK_ENABLED_FOR_SEND; } @@ -109,7 +109,7 @@ void IRsend::begin(bool aEnableLEDFeedback, uint_fast8_t aFeedbackLEDPin) { #else // defined(IR_SEND_PIN) IRsend::IRsend(uint_fast8_t aSendPin) { // @suppress("Class members should be properly initialized") sendPin = aSendPin; -# if !defined(NO_LED_FEEDBACK_CODE) +# if !defined(NO_LED_SEND_FEEDBACK_CODE) setLEDFeedback(0, DO_NOT_ENABLE_LED_FEEDBACK); # endif } @@ -120,7 +120,7 @@ IRsend::IRsend(uint_fast8_t aSendPin) { // @suppress("Class members should be pr */ void IRsend::begin(uint_fast8_t aSendPin) { sendPin = aSendPin; -# if !defined(NO_LED_FEEDBACK_CODE) +# if !defined(NO_LED_SEND_FEEDBACK_CODE) setLEDFeedback(USE_DEFAULT_FEEDBACK_LED_PIN, LED_FEEDBACK_ENABLED_FOR_SEND); # endif } @@ -142,8 +142,8 @@ void IRsend::begin(uint_fast8_t aSendPin, bool aEnableLEDFeedback, uint_fast8_t sendPin = aSendPin; #endif -#if !defined(NO_LED_FEEDBACK_CODE) - bool tEnableLEDFeedback = DO_NOT_ENABLE_LED_FEEDBACK; +#if !defined(NO_LED_SEND_FEEDBACK_CODE) + uint_fast8_t tEnableLEDFeedback = DO_NOT_ENABLE_LED_FEEDBACK; if (aEnableLEDFeedback) { tEnableLEDFeedback = LED_FEEDBACK_ENABLED_FOR_SEND; } @@ -220,7 +220,7 @@ size_t IRsend::write(IRData *aIRSendData, int_fast8_t aNumberOfRepeats) { } else if (tProtocol == SAMSUNG48) { sendSamsung48(tAddress, tCommand, aNumberOfRepeats); - } else if (tProtocol == SAMSUNG_LG) { + } else if (tProtocol == SAMSUNGLG) { sendSamsungLG(tAddress, tCommand, aNumberOfRepeats); } else if (tProtocol == SONY) { @@ -341,7 +341,7 @@ size_t IRsend::write(decode_type_t aProtocol, uint16_t aAddress, uint16_t aComma } else if (aProtocol == SAMSUNG48) { sendSamsung48(aAddress, aCommand, aNumberOfRepeats); - } else if (aProtocol == SAMSUNG_LG) { + } else if (aProtocol == SAMSUNGLG) { sendSamsungLG(aAddress, aCommand, aNumberOfRepeats); } else if (aProtocol == SONY) { @@ -408,7 +408,7 @@ size_t IRsend::write(decode_type_t aProtocol, uint16_t aAddress, uint16_t aComma } /** - * Function using an 16 byte microsecond timing array for every purpose. + * Sends a 16 byte microsecond timing array. * Raw data starts with a Mark. No leading space as in received timing data! */ void IRsend::sendRaw(const uint16_t aBufferWithMicroseconds[], uint_fast16_t aLengthOfBuffer, uint_fast8_t aIRFrequencyKilohertz) { @@ -429,7 +429,7 @@ void IRsend::sendRaw(const uint16_t aBufferWithMicroseconds[], uint_fast16_t aLe } /** - * Function using an 8 byte tick timing array to save program memory + * Sends an 8 byte tick timing array to save program memory. * Raw data starts with a Mark. No leading space as in received timing data! */ void IRsend::sendRaw(const uint8_t aBufferWithTicks[], uint_fast16_t aLengthOfBuffer, uint_fast8_t aIRFrequencyKilohertz) { @@ -466,15 +466,24 @@ void IRsend::sendRaw_P(const uint16_t aBufferWithMicroseconds[], uint_fast16_t a if (i & 1) { // Odd space(duration); +# if defined(LOCAL_DEBUG) + Serial.print(F("S=")); +# endif } else { mark(duration); +# if defined(LOCAL_DEBUG) + Serial.print(F("M=")); +# endif } +# if defined(LOCAL_DEBUG) + Serial.println(duration); +# endif } #endif } /** - * New function using an 8 byte tick timing array in FLASH to save program memory + * New function using an 8 byte tick (50 us) timing array in FLASH to save program memory * Raw data starts with a Mark. No leading space as in received timing data! */ void IRsend::sendRaw_P(const uint8_t aBufferWithTicks[], uint_fast16_t aLengthOfBuffer, uint_fast8_t aIRFrequencyKilohertz) { @@ -484,16 +493,26 @@ void IRsend::sendRaw_P(const uint8_t aBufferWithTicks[], uint_fast16_t aLengthOf // Set IR carrier frequency enableIROut(aIRFrequencyKilohertz); + uint_fast16_t duration; for (uint_fast16_t i = 0; i < aLengthOfBuffer; i++) { - uint_fast16_t duration = pgm_read_byte(&aBufferWithTicks[i]) * (uint_fast16_t) MICROS_PER_TICK; + duration = pgm_read_byte(&aBufferWithTicks[i]) * (uint_fast16_t) MICROS_PER_TICK; if (i & 1) { // Odd space(duration); +# if defined(LOCAL_DEBUG) + Serial.print(F("S=")); +# endif } else { mark(duration); +# if defined(LOCAL_DEBUG) + Serial.print(F("M=")); +# endif } } IRLedOff(); // Always end with the LED off +# if defined(LOCAL_DEBUG) + Serial.println(duration); +# endif #endif } @@ -502,21 +521,8 @@ void IRsend::sendRaw_P(const uint8_t aBufferWithTicks[], uint_fast16_t aLengthOf * For LSB First the LSB of array[0] is sent first then all bits until MSB of array[0]. Next is LSB of array[1] and so on. * The output always ends with a space * Stop bit is always sent + * @param aFlags Evaluated flags are PROTOCOL_IS_MSB_FIRST and SUPPRESS_STOP_BIT. Stop bit is otherwise sent for all pulse distance protocols. */ -void IRsend::sendPulseDistanceWidthFromArray(uint_fast8_t aFrequencyKHz, uint16_t aHeaderMarkMicros, uint16_t aHeaderSpaceMicros, - uint16_t aOneMarkMicros, uint16_t aOneSpaceMicros, uint16_t aZeroMarkMicros, uint16_t aZeroSpaceMicros, - IRRawDataType *aDecodedRawDataArray, uint16_t aNumberOfBits, bool aMSBFirst, bool aSendStopBit, - uint16_t aRepeatPeriodMillis, int_fast8_t aNumberOfRepeats) { - uint8_t tFlags = 0; - if (aMSBFirst) { - tFlags = PROTOCOL_IS_MSB_FIRST; - } - (void) aSendStopBit; - - sendPulseDistanceWidthFromArray(aFrequencyKHz, aHeaderMarkMicros, aHeaderSpaceMicros, aOneMarkMicros, aOneSpaceMicros, - aZeroMarkMicros, aZeroSpaceMicros, aDecodedRawDataArray, aNumberOfBits, tFlags, aRepeatPeriodMillis, aNumberOfRepeats); -} - void IRsend::sendPulseDistanceWidthFromArray(uint_fast8_t aFrequencyKHz, DistanceWidthTimingInfoStruct *aDistanceWidthTimingInfo, IRRawDataType *aDecodedRawDataArray, uint16_t aNumberOfBits, uint8_t aFlags, uint16_t aRepeatPeriodMillis, int_fast8_t aNumberOfRepeats) { @@ -526,7 +532,6 @@ void IRsend::sendPulseDistanceWidthFromArray(uint_fast8_t aFrequencyKHz, Distanc aDistanceWidthTimingInfo->ZeroSpaceMicros, aDecodedRawDataArray, aNumberOfBits, aFlags, aRepeatPeriodMillis, aNumberOfRepeats); } - void IRsend::sendPulseDistanceWidthFromArray(uint_fast8_t aFrequencyKHz, uint16_t aHeaderMarkMicros, uint16_t aHeaderSpaceMicros, uint16_t aOneMarkMicros, uint16_t aOneSpaceMicros, uint16_t aZeroMarkMicros, uint16_t aZeroSpaceMicros, IRRawDataType *aDecodedRawDataArray, uint16_t aNumberOfBits, uint8_t aFlags, uint16_t aRepeatPeriodMillis, @@ -570,7 +575,7 @@ void IRsend::sendPulseDistanceWidthFromArray(uint_fast8_t aFrequencyKHz, uint16_ } else { // intermediate data tNumberOfBitsForOneSend = BITS_IN_RAW_DATA_TYPE; - tFlags = aFlags | SUPPRESS_STOP_BIT_FOR_THIS_DATA; // No stop bit for leading data + tFlags = aFlags | SUPPRESS_STOP_BIT; // No stop bit for leading data } sendPulseDistanceWidthData(aOneMarkMicros, aOneSpaceMicros, aZeroMarkMicros, aZeroSpaceMicros, aDecodedRawDataArray[i], @@ -592,11 +597,95 @@ void IRsend::sendPulseDistanceWidthFromArray(uint_fast8_t aFrequencyKHz, uint16_ } } +void IRsend::sendPulseDistanceWidthFromPGMArray(uint_fast8_t aFrequencyKHz, uint16_t aHeaderMarkMicros, uint16_t aHeaderSpaceMicros, + uint16_t aOneMarkMicros, uint16_t aOneSpaceMicros, uint16_t aZeroMarkMicros, uint16_t aZeroSpaceMicros, + IRRawDataType const *aDecodedRawDataPGMArray, uint16_t aNumberOfBits, uint8_t aFlags, uint16_t aRepeatPeriodMillis, + int_fast8_t aNumberOfRepeats) { + + // Set IR carrier frequency + enableIROut(aFrequencyKHz); + + uint_fast8_t tNumberOfCommands = aNumberOfRepeats + 1; + uint_fast8_t tNumberOf32Or64BitChunks = ((aNumberOfBits - 1) / BITS_IN_RAW_DATA_TYPE) + 1; + +#if defined(LOCAL_DEBUG) + // fist data + Serial.print(F("Data[0]=0x")); + Serial.print(aDecodedRawDataPGMArray[0], HEX); + if (tNumberOf32Or64BitChunks > 1) { + Serial.print(F(" Data[1]=0x")); + Serial.print(aDecodedRawDataPGMArray[1], HEX); + } + Serial.print(F(" #=")); + Serial.println(aNumberOfBits); + Serial.flush(); +#endif + + while (tNumberOfCommands > 0) { + unsigned long tStartOfFrameMillis = millis(); + + // Header + mark(aHeaderMarkMicros); + space(aHeaderSpaceMicros); + + for (uint_fast8_t i = 0; i < tNumberOf32Or64BitChunks; ++i) { + uint8_t tNumberOfBitsForOneSend; + + // Manage stop bit + uint8_t tFlags; + if (i == (tNumberOf32Or64BitChunks - 1)) { + // End of data + tNumberOfBitsForOneSend = aNumberOfBits; + tFlags = aFlags; + } else { + // intermediate data + tNumberOfBitsForOneSend = BITS_IN_RAW_DATA_TYPE; + tFlags = aFlags | SUPPRESS_STOP_BIT; // No stop bit for leading data + } + + IRRawDataType tDecodedRawData; +#if (__INT_WIDTH__ < 32) + tDecodedRawData = pgm_read_dword(&aDecodedRawDataPGMArray[i]); // pgm_read_dword reads 32 bit on AVR +#else + tDecodedRawData = aDecodedRawDataPGMArray[i]; // assume non Harvard architecture here +#endif + sendPulseDistanceWidthData(aOneMarkMicros, aOneSpaceMicros, aZeroMarkMicros, aZeroSpaceMicros, tDecodedRawData, + tNumberOfBitsForOneSend, tFlags); + aNumberOfBits -= BITS_IN_RAW_DATA_TYPE; + } + + tNumberOfCommands--; + // skip last delay! + if (tNumberOfCommands > 0) { + /* + * Check and fallback for wrong RepeatPeriodMillis parameter. I.e the repeat period must be greater than each frame duration. + */ + auto tFrameDurationMillis = millis() - tStartOfFrameMillis; + if (aRepeatPeriodMillis > tFrameDurationMillis) { + delay(aRepeatPeriodMillis - tFrameDurationMillis); + } + } + } +} + +void IRsend::sendPulseDistanceWidthFromArray_P(uint_fast8_t aFrequencyKHz, + DistanceWidthTimingInfoStruct const *aDistanceWidthTimingInfoPGM, IRRawDataType *aDecodedRawDataArray, + uint16_t aNumberOfBits, uint8_t aFlags, uint16_t aRepeatPeriodMillis, int_fast8_t aNumberOfRepeats) { + + DistanceWidthTimingInfoStruct tTemporaryDistanceWidthTimingInfo; + memcpy_P(&tTemporaryDistanceWidthTimingInfo, aDistanceWidthTimingInfoPGM, sizeof(tTemporaryDistanceWidthTimingInfo)); + sendPulseDistanceWidthFromArray(aFrequencyKHz, &tTemporaryDistanceWidthTimingInfo, aDecodedRawDataArray, aNumberOfBits, aFlags, + aRepeatPeriodMillis, aNumberOfRepeats); +} + /** * Sends PulseDistance data from array using PulseDistanceWidthProtocolConstants * For LSB First the LSB of array[0] is sent first then all bits until MSB of array[0]. Next is LSB of array[1] and so on. * The output always ends with a space * Stop bit is always sent + * @param aNumberOfBits Number of bits from aDecodedRawDataArray to be actually sent. + * @param aNumberOfRepeats If < 0 and a aProtocolConstants->SpecialSendRepeatFunction() is specified + * then it is called without leading and trailing space. */ void IRsend::sendPulseDistanceWidthFromArray(PulseDistanceWidthProtocolConstants *aProtocolConstants, IRRawDataType *aDecodedRawDataArray, uint16_t aNumberOfBits, int_fast8_t aNumberOfRepeats) { @@ -647,7 +736,7 @@ void IRsend::sendPulseDistanceWidthFromArray(PulseDistanceWidthProtocolConstants } else { // intermediate data tNumberOfBitsForOneSend = BITS_IN_RAW_DATA_TYPE; - tFlags = tOriginalFlags | SUPPRESS_STOP_BIT_FOR_THIS_DATA; // No stop bit for leading data + tFlags = tOriginalFlags | SUPPRESS_STOP_BIT; // No stop bit for leading data } sendPulseDistanceWidthData(aProtocolConstants->DistanceWidthTimingInfo.OneMarkMicros, @@ -672,8 +761,106 @@ void IRsend::sendPulseDistanceWidthFromArray(PulseDistanceWidthProtocolConstants } } +void IRsend::sendPulseDistanceWidthFromArray_P(PulseDistanceWidthProtocolConstants const *aProtocolConstantsPGM, + IRRawDataType *aDecodedRawDataArray, uint16_t aNumberOfBits, int_fast8_t aNumberOfRepeats) { + + PulseDistanceWidthProtocolConstants tTemporaryPulseDistanceWidthProtocolConstants; + memcpy_P(&tTemporaryPulseDistanceWidthProtocolConstants, aProtocolConstantsPGM, + sizeof(tTemporaryPulseDistanceWidthProtocolConstants)); + sendPulseDistanceWidthFromArray(&tTemporaryPulseDistanceWidthProtocolConstants, aDecodedRawDataArray, aNumberOfBits, + aNumberOfRepeats); +} +void IRsend::sendPulseDistanceWidthFromPGMArray_P(PulseDistanceWidthProtocolConstants const *aProtocolConstantsPGM, + IRRawDataType const *aDecodedRawDataPGMArray, uint16_t aNumberOfBits, int_fast8_t aNumberOfRepeats) { + + PulseDistanceWidthProtocolConstants tTemporaryPulseDistanceWidthProtocolConstants; + memcpy_P(&tTemporaryPulseDistanceWidthProtocolConstants, aProtocolConstantsPGM, + sizeof(tTemporaryPulseDistanceWidthProtocolConstants)); + sendPulseDistanceWidthFromPGMArray(&tTemporaryPulseDistanceWidthProtocolConstants, aDecodedRawDataPGMArray, aNumberOfBits, + aNumberOfRepeats); +} + +void IRsend::sendPulseDistanceWidthFromPGMArray(PulseDistanceWidthProtocolConstants *aProtocolConstants, + IRRawDataType const *aDecodedRawDataPGMArray, uint16_t aNumberOfBits, int_fast8_t aNumberOfRepeats) { + +// Calling sendPulseDistanceWidthFromArray() costs 68 bytes program memory compared to the implementation below +// sendPulseDistanceWidthFromArray(aProtocolConstants->FrequencyKHz, aProtocolConstants->DistanceWidthTimingInfo.HeaderMarkMicros, +// aProtocolConstants->DistanceWidthTimingInfo.HeaderSpaceMicros, +// aProtocolConstants->DistanceWidthTimingInfo.OneMarkMicros, aProtocolConstants->DistanceWidthTimingInfo.OneSpaceMicros, +// aProtocolConstants->DistanceWidthTimingInfo.ZeroMarkMicros, aProtocolConstants->DistanceWidthTimingInfo.ZeroSpaceMicros, +// aDecodedRawDataArray, aNumberOfBits, aProtocolConstants->Flags, aProtocolConstants->RepeatPeriodMillis, +// aNumberOfRepeats); + // Set IR carrier frequency + enableIROut(aProtocolConstants->FrequencyKHz); + + uint_fast8_t tNumberOf32Or64BitChunks = ((aNumberOfBits - 1) / BITS_IN_RAW_DATA_TYPE) + 1; + +#if defined(LOCAL_DEBUG) + // fist data + Serial.print(F("Data[0]=0x")); + Serial.print(aDecodedRawDataPGMArray[0], HEX); + if (tNumberOf32Or64BitChunks > 1) { + Serial.print(F(" Data[1]=0x")); + Serial.print(aDecodedRawDataPGMArray[1], HEX); + } + Serial.print(F(" #=")); + Serial.println(aNumberOfBits); + Serial.flush(); +#endif + + uint_fast8_t tNumberOfCommands = aNumberOfRepeats + 1; + while (tNumberOfCommands > 0) { + auto tStartOfFrameMillis = millis(); + auto tNumberOfBits = aNumberOfBits; // refresh value for repeats + + // Header + mark(aProtocolConstants->DistanceWidthTimingInfo.HeaderMarkMicros); + space(aProtocolConstants->DistanceWidthTimingInfo.HeaderSpaceMicros); + uint8_t tOriginalFlags = aProtocolConstants->Flags; + + for (uint_fast8_t i = 0; i < tNumberOf32Or64BitChunks; ++i) { + uint8_t tNumberOfBitsForOneSend; + + uint8_t tFlags; + if (i == (tNumberOf32Or64BitChunks - 1)) { + // End of data + tNumberOfBitsForOneSend = tNumberOfBits; + tFlags = tOriginalFlags; + } else { + // intermediate data + tNumberOfBitsForOneSend = BITS_IN_RAW_DATA_TYPE; + tFlags = tOriginalFlags | SUPPRESS_STOP_BIT; // No stop bit for leading data + } + + IRRawDataType tDecodedRawData; +#if (__INT_WIDTH__ < 32) + tDecodedRawData = pgm_read_dword(&aDecodedRawDataPGMArray[i]); // pgm_read_dword reads 32 bit on AVR +#else + tDecodedRawData = aDecodedRawDataPGMArray[i]; // assume non Harvard architecture here +#endif + sendPulseDistanceWidthData(aProtocolConstants->DistanceWidthTimingInfo.OneMarkMicros, + aProtocolConstants->DistanceWidthTimingInfo.OneSpaceMicros, + aProtocolConstants->DistanceWidthTimingInfo.ZeroMarkMicros, + aProtocolConstants->DistanceWidthTimingInfo.ZeroSpaceMicros, tDecodedRawData, tNumberOfBitsForOneSend, tFlags); + tNumberOfBits -= BITS_IN_RAW_DATA_TYPE; + } + + tNumberOfCommands--; + // skip last delay! + if (tNumberOfCommands > 0) { + /* + * Check and fallback for wrong RepeatPeriodMillis parameter. I.e the repeat period must be greater than each frame duration. + */ + auto tFrameDurationMillis = millis() - tStartOfFrameMillis; + if (aProtocolConstants->RepeatPeriodMillis > tFrameDurationMillis) { + delay(aProtocolConstants->RepeatPeriodMillis - tFrameDurationMillis); + } + } + } +} + /** - * Sends PulseDistance frames and repeats and enables receiver again + * Sends PulseDistance frames and repeats * @param aProtocolConstants The constants to use for sending this protocol. * @param aData uint32 or uint64 holding the bits to be sent. * @param aNumberOfBits Number of bits from aData to be actually sent. @@ -683,12 +870,24 @@ void IRsend::sendPulseDistanceWidthFromArray(PulseDistanceWidthProtocolConstants void IRsend::sendPulseDistanceWidth(PulseDistanceWidthProtocolConstants *aProtocolConstants, IRRawDataType aData, uint_fast8_t aNumberOfBits, int_fast8_t aNumberOfRepeats) { +#if defined(LOCAL_DEBUG) + Serial.print(F("Data=0x")); + Serial.print(aData, HEX); + Serial.print(F(" #=")); + Serial.println(aNumberOfBits); + Serial.flush(); +#endif + if (aNumberOfRepeats < 0) { - if (aProtocolConstants->SpecialSendRepeatFunction != NULL) { + if (aProtocolConstants->SpecialSendRepeatFunction != nullptr) { + /* + * Send only a special repeat and return + */ aProtocolConstants->SpecialSendRepeatFunction(); return; } else { - aNumberOfRepeats = 0; // send a plain frame as repeat + // Send only one plain frame (as repeat) + aNumberOfRepeats = 0; } } @@ -699,8 +898,8 @@ void IRsend::sendPulseDistanceWidth(PulseDistanceWidthProtocolConstants *aProtoc while (tNumberOfCommands > 0) { unsigned long tStartOfFrameMillis = millis(); - if (tNumberOfCommands < ((uint_fast8_t) aNumberOfRepeats + 1) && aProtocolConstants->SpecialSendRepeatFunction != NULL) { - // send special repeat + if (tNumberOfCommands < ((uint_fast8_t) aNumberOfRepeats + 1) && aProtocolConstants->SpecialSendRepeatFunction != nullptr) { + // send special repeat, if specified and we are not in the first loop aProtocolConstants->SpecialSendRepeatFunction(); } else { /* @@ -714,46 +913,41 @@ void IRsend::sendPulseDistanceWidth(PulseDistanceWidthProtocolConstants *aProtoc tNumberOfCommands--; // skip last delay! if (tNumberOfCommands > 0) { + auto tCurrentFrameDurationMillis = millis() - tStartOfFrameMillis; /* * Check and fallback for wrong RepeatPeriodMillis parameter. I.e the repeat period must be greater than each frame duration. */ - auto tFrameDurationMillis = millis() - tStartOfFrameMillis; - if (aProtocolConstants->RepeatPeriodMillis > tFrameDurationMillis) { - delay(aProtocolConstants->RepeatPeriodMillis - tFrameDurationMillis); + if (aProtocolConstants->RepeatPeriodMillis > tCurrentFrameDurationMillis) { + delay(aProtocolConstants->RepeatPeriodMillis - tCurrentFrameDurationMillis); } } } } +void IRsend::sendPulseDistanceWidth_P(PulseDistanceWidthProtocolConstants const *aProtocolConstantsPGM, IRRawDataType aData, + uint_fast8_t aNumberOfBits, int_fast8_t aNumberOfRepeats) { + PulseDistanceWidthProtocolConstants tTemporaryPulseDistanceWidthProtocolConstants; + memcpy_P(&tTemporaryPulseDistanceWidthProtocolConstants, aProtocolConstantsPGM, + sizeof(tTemporaryPulseDistanceWidthProtocolConstants)); + sendPulseDistanceWidth(&tTemporaryPulseDistanceWidthProtocolConstants, aData, aNumberOfBits, aNumberOfRepeats); +} /** * Sends PulseDistance frames and repeats. * @param aFrequencyKHz, aHeaderMarkMicros, aHeaderSpaceMicros, aOneMarkMicros, aOneSpaceMicros, aZeroMarkMicros, aZeroSpaceMicros, aFlags, aRepeatPeriodMillis Values to use for sending this protocol, also contained in the PulseDistanceWidthProtocolConstants of this protocol. * @param aData uint32 or uint64 holding the bits to be sent. * @param aNumberOfBits Number of bits from aData to be actually sent. + * @param aFlags Evaluated flags are PROTOCOL_IS_MSB_FIRST and SUPPRESS_STOP_BIT. Stop bit is otherwise sent for all pulse distance protocols. * @param aNumberOfRepeats If < 0 and a aProtocolConstants->SpecialSendRepeatFunction() is specified * then it is called without leading and trailing space. - * @param aSpecialSendRepeatFunction If NULL, the first frame is repeated completely, otherwise this function is used for sending the repeat frame. + * @param aSpecialSendRepeatFunction If nullptr, the first frame is repeated completely, otherwise this function is used for sending the repeat frame. */ -void IRsend::sendPulseDistanceWidth(uint_fast8_t aFrequencyKHz, uint16_t aHeaderMarkMicros, uint16_t aHeaderSpaceMicros, - uint16_t aOneMarkMicros, uint16_t aOneSpaceMicros, uint16_t aZeroMarkMicros, uint16_t aZeroSpaceMicros, IRRawDataType aData, - uint_fast8_t aNumberOfBits, bool aMSBFirst, bool aSendStopBit, uint16_t aRepeatPeriodMillis, int_fast8_t aNumberOfRepeats, - void (*aSpecialSendRepeatFunction)()) { - uint8_t tFlags = 0; - if (aMSBFirst) { - tFlags = PROTOCOL_IS_MSB_FIRST; - } - (void) aSendStopBit; - sendPulseDistanceWidth(aFrequencyKHz, aHeaderMarkMicros, aHeaderSpaceMicros, aOneMarkMicros, aOneSpaceMicros, aZeroMarkMicros, - aZeroSpaceMicros, aData, aNumberOfBits, tFlags, aRepeatPeriodMillis, aNumberOfRepeats, aSpecialSendRepeatFunction); - -} void IRsend::sendPulseDistanceWidth(uint_fast8_t aFrequencyKHz, uint16_t aHeaderMarkMicros, uint16_t aHeaderSpaceMicros, uint16_t aOneMarkMicros, uint16_t aOneSpaceMicros, uint16_t aZeroMarkMicros, uint16_t aZeroSpaceMicros, IRRawDataType aData, uint_fast8_t aNumberOfBits, uint8_t aFlags, uint16_t aRepeatPeriodMillis, int_fast8_t aNumberOfRepeats, void (*aSpecialSendRepeatFunction)()) { if (aNumberOfRepeats < 0) { - if (aSpecialSendRepeatFunction != NULL) { + if (aSpecialSendRepeatFunction != nullptr) { aSpecialSendRepeatFunction(); return; } else { @@ -768,7 +962,7 @@ void IRsend::sendPulseDistanceWidth(uint_fast8_t aFrequencyKHz, uint16_t aHeader while (tNumberOfCommands > 0) { unsigned long tStartOfFrameMillis = millis(); - if (tNumberOfCommands < ((uint_fast8_t) aNumberOfRepeats + 1) && aSpecialSendRepeatFunction != NULL) { + if (tNumberOfCommands < ((uint_fast8_t) aNumberOfRepeats + 1) && aSpecialSendRepeatFunction != nullptr) { // send special repeat aSpecialSendRepeatFunction(); } else { @@ -794,9 +988,12 @@ void IRsend::sendPulseDistanceWidth(uint_fast8_t aFrequencyKHz, uint16_t aHeader } /** - * Sends PulseDistance data + * Sends PulseDistance from data contained in parameter using ProtocolConstants structure for timing etc. * The output always ends with a space * Each additional call costs 16 bytes program memory + * @param aProtocolConstants The constants to use for sending this protocol. + * @param aData uint32 or uint64 holding the bits to be sent. + * @param aNumberOfBits Number of bits from aData to be actually sent. */ void IRsend::sendPulseDistanceWidthData(PulseDistanceWidthProtocolConstants *aProtocolConstants, IRRawDataType aData, uint_fast8_t aNumberOfBits) { @@ -806,27 +1003,31 @@ void IRsend::sendPulseDistanceWidthData(PulseDistanceWidthProtocolConstants *aPr aProtocolConstants->DistanceWidthTimingInfo.ZeroSpaceMicros, aData, aNumberOfBits, aProtocolConstants->Flags); } +void IRsend::sendPulseDistanceWidthData_P(PulseDistanceWidthProtocolConstants const *aProtocolConstantsPGM, IRRawDataType aData, + uint_fast8_t aNumberOfBits) { + + PulseDistanceWidthProtocolConstants tTemporaryPulseDistanceWidthProtocolConstants; + memcpy_P(&tTemporaryPulseDistanceWidthProtocolConstants, aProtocolConstantsPGM, + sizeof(tTemporaryPulseDistanceWidthProtocolConstants)); + sendPulseDistanceWidthData(&tTemporaryPulseDistanceWidthProtocolConstants, aData, aNumberOfBits); +} + /** - * Sends PulseDistance data + * Sends PulseDistance data with timing parameters and flag parameters. * The output always ends with a space + * @param aOneMarkMicros Timing for sending this protocol. + * @param aData uint32 or uint64 holding the bits to be sent. + * @param aNumberOfBits Number of bits from aData to be actually sent. + * @param aFlags Evaluated flags are PROTOCOL_IS_MSB_FIRST and SUPPRESS_STOP_BIT. Stop bit is otherwise sent for all pulse distance protocols. */ -void IRsend::sendPulseDistanceWidthData(uint16_t aOneMarkMicros, uint16_t aOneSpaceMicros, uint16_t aZeroMarkMicros, - uint16_t aZeroSpaceMicros, IRRawDataType aData, uint_fast8_t aNumberOfBits, bool aMSBFirst, bool aSendStopBit) { - uint8_t tFlags = 0; - if (aMSBFirst) { - tFlags = PROTOCOL_IS_MSB_FIRST; - } - (void) aSendStopBit; - sendPulseDistanceWidthData(aOneMarkMicros, aOneSpaceMicros, aZeroMarkMicros, aZeroSpaceMicros, aData, aNumberOfBits, tFlags); -} void IRsend::sendPulseDistanceWidthData(uint16_t aOneMarkMicros, uint16_t aOneSpaceMicros, uint16_t aZeroMarkMicros, uint16_t aZeroSpaceMicros, IRRawDataType aData, uint_fast8_t aNumberOfBits, uint8_t aFlags) { #if defined(LOCAL_DEBUG) - // Even printing this short messages (at 115200) disturbs the send timing :-( -// Serial.print(aData, HEX); -// Serial.print('|'); -// Serial.println(aNumberOfBits); + Serial.print(aData, HEX); + Serial.print('|'); + Serial.println(aNumberOfBits); + Serial.flush(); #endif // For MSBFirst, send data from MSB to LSB until mask bit is shifted out @@ -852,15 +1053,16 @@ void IRsend::sendPulseDistanceWidthData(uint16_t aOneMarkMicros, uint16_t aOneSp } } /* - * Stop bit is sent for all pulse distance protocols i.e. aOneMarkMicros == aZeroMarkMicros. - * Therefore it is not sent for Sony and Magiquest :-) + * Stop bit is sent for all pulse distance protocols i.e. aOneSpaceMicros != aZeroSpaceMicros. + * Therefore it is not sent for Sony :-) + * For sending from an array, no intermediate stop bit must be sent for all but last data chunk. */ - if (!(aFlags & SUPPRESS_STOP_BIT_FOR_THIS_DATA) && aOneMarkMicros == aZeroMarkMicros) { + if ((!(aFlags & SUPPRESS_STOP_BIT)) && (abs(aOneSpaceMicros - aZeroSpaceMicros) > (aOneSpaceMicros / 4))) { // Send stop bit here #if defined(LOCAL_TRACE) Serial.print('S'); #endif - mark(aZeroMarkMicros); // Use aZeroMarkMicros for stop bits. This seems to be correct for all protocols :-) + mark(aOneMarkMicros); // Use aOneMarkMicros for stop bits. This seems to be correct for all protocols :-) } #if defined(LOCAL_TRACE) Serial.println(); @@ -874,6 +1076,8 @@ void IRsend::sendPulseDistanceWidthData(uint16_t aOneMarkMicros, uint16_t aOneSp * 1 -> space+mark * The output always ends with a space * can only send 31 bit data, since we put the start bit as 32th bit on front + * @param aData uint32 or uint64 holding the bits to be sent. + * @param aNumberOfBits Number of bits from aData to be actually sent. */ void IRsend::sendBiphaseData(uint16_t aBiphaseTimeUnit, uint32_t aData, uint_fast8_t aNumberOfBits) { @@ -917,7 +1121,7 @@ void IRsend::sendBiphaseData(uint16_t aBiphaseTimeUnit, uint32_t aData, uint_fas tLastBitValue = 0; } } - IR_TRACE_PRINTLN(F("")); + IR_TRACE_PRINTLN(); } /** @@ -925,11 +1129,20 @@ void IRsend::sendBiphaseData(uint16_t aBiphaseTimeUnit, uint32_t aData, uint_fas * The mark output is modulated at the PWM frequency if USE_NO_SEND_PWM is not defined. * The output is guaranteed to be OFF / inactive after after the call of the function. * This function may affect the state of feedback LED. + * Period time is 26 us for 38.46 kHz, 27 us for 37.04 kHz, 25 us for 40 kHz. + * On time is 8 us for 30% duty cycle + * + * The mark() function relies on the correct implementation of: + * delayMicroseconds() for pulse time, and micros() for pause time. + * The delayMicroseconds() of pulse time is guarded on AVR CPU's with noInterrupts() / interrupts(). + * At the start of pause time, interrupts are enabled once, the rest of the pause is also guarded on AVR CPU's with noInterrupts() / interrupts(). + * The maximum length of an interrupt during sending should not exceed 26 us - 8 us = 18 us, otherwise timing is disturbed. + * This disturbance is no problem, if the exceedance is small and does not happen too often. */ void IRsend::mark(uint16_t aMarkMicros) { #if defined(SEND_PWM_BY_TIMER) || defined(USE_NO_SEND_PWM) -# if !defined(NO_LED_FEEDBACK_CODE) +# if !defined(NO_LED_SEND_FEEDBACK_CODE) if (FeedbackLEDControl.LedFeedbackEnabled == LED_FEEDBACK_ENABLED_FOR_SEND) { setFeedbackLED(true); } @@ -942,7 +1155,7 @@ void IRsend::mark(uint16_t aMarkMicros) { */ enableSendPWMByTimer(); // Enable timer or ledcWrite() generated PWM output customDelayMicroseconds(aMarkMicros); - IRLedOff();// disables hardware PWM and manages feedback LED + IRLedOff(); // disables hardware PWM and manages feedback LED return; #elif defined(USE_NO_SEND_PWM) @@ -950,14 +1163,17 @@ void IRsend::mark(uint16_t aMarkMicros) { * Here we generate no carrier PWM, just simulate an active low receiver signal. */ # if defined(USE_OPEN_DRAIN_OUTPUT_FOR_SEND_PIN) && !defined(OUTPUT_OPEN_DRAIN) + // Here we have no hardware supported Open Drain outputs, so we must mimicking it pinModeFast(sendPin, OUTPUT); // active state for mimicking open drain +# elif defined(USE_ACTIVE_HIGH_OUTPUT_FOR_SEND_PIN) + digitalWriteFast(sendPin, HIGH); // Set output to active high. # else digitalWriteFast(sendPin, LOW); // Set output to active low. # endif customDelayMicroseconds(aMarkMicros); IRLedOff(); -# if !defined(NO_LED_FEEDBACK_CODE) +# if !defined(NO_LED_SEND_FEEDBACK_CODE) if (FeedbackLEDControl.LedFeedbackEnabled == LED_FEEDBACK_ENABLED_FOR_SEND) { setFeedbackLED(false); } @@ -971,7 +1187,7 @@ void IRsend::mark(uint16_t aMarkMicros) { unsigned long tStartMicros = micros(); unsigned long tNextPeriodEnding = tStartMicros; unsigned long tMicros; -# if !defined(NO_LED_FEEDBACK_CODE) +# if !defined(NO_LED_SEND_FEEDBACK_CODE) bool FeedbackLedIsActive = false; # endif @@ -990,9 +1206,14 @@ void IRsend::mark(uint16_t aMarkMicros) { # else // 3.5 us from FeedbackLed on to pin setting. 5.7 us from call of mark() to pin setting incl. setting of feedback pin. // 4.3 us from do{ to pin setting if sendPin is no constant - digitalWriteFast(sendPin, HIGH); + // check must be here because of MegaTinyCore and its badArg() check + if (__builtin_constant_p(sendPin)) { + digitalWriteFast(sendPin, HIGH); + } else { + digitalWrite(sendPin, HIGH); + } # endif - delayMicroseconds (periodOnTimeMicros); // this is normally implemented by a blocking wait + delayMicroseconds (periodOnTimeMicros); // On time is 8 us for 30% duty cycle. This is normally implemented by a blocking wait. /* * Output the PWM pause @@ -1005,7 +1226,11 @@ void IRsend::mark(uint16_t aMarkMicros) { # endif # else - digitalWriteFast(sendPin, LOW); + if (__builtin_constant_p(sendPin)) { + digitalWriteFast(sendPin, LOW); + } else { + digitalWrite(sendPin, LOW); + } # endif /* * Enable interrupts at start of the longer off period. Required at least to keep micros correct. @@ -1013,25 +1238,28 @@ void IRsend::mark(uint16_t aMarkMicros) { */ interrupts(); -# if !defined(NO_LED_FEEDBACK_CODE) +# if !defined(NO_LED_SEND_FEEDBACK_CODE) /* * Delayed call of setFeedbackLED() to get better startup timing, especially required for consecutive marks */ if (!FeedbackLedIsActive) { FeedbackLedIsActive = true; - if (FeedbackLEDControl.LedFeedbackEnabled == LED_FEEDBACK_ENABLED_FOR_SEND) { + if (FeedbackLEDControl.LedFeedbackEnabled & LED_FEEDBACK_ENABLED_FOR_SEND) { setFeedbackLED(true); } } # endif /* * PWM pause timing - * Measured delta between pause duration values are 13 us for a 16 MHz UNO (from 13 to 26) - * Minimal pause duration is 5.2 us with NO_LED_FEEDBACK_CODE enabled - * and 8.1 us with NO_LED_FEEDBACK_CODE disabled. + * Measured delta between pause duration values are 13 us for a 16 MHz Uno (from 13 to 26), if interrupts are disabled below + * Measured delta between pause duration values are 20 us for a 16 MHz Uno (from 7.8 to 28), if interrupts are not disabled below + * Minimal pause duration is 5.2 us with NO_LED_SEND_FEEDBACK_CODE enabled + * and 8.1 us with NO_LED_SEND_FEEDBACK_CODE disabled. */ tNextPeriodEnding += periodTimeMicros; - noInterrupts(); +#if defined(__AVR__) // micros() for STM sometimes give decreasing values if interrupts are disabled. See https://github.com/stm32duino/Arduino_Core_STM32/issues/1680 + noInterrupts(); // disable interrupts (especially the 20 us receive interrupts) only at start of the PWM pause. Otherwise it may extend the pause too much. +#endif do { #if defined(_IR_MEASURE_TIMING) && defined(_IR_TIMING_TEST_PIN) digitalWriteFast(_IR_TIMING_TEST_PIN, HIGH); // 2 clock cycles @@ -1040,23 +1268,23 @@ void IRsend::mark(uint16_t aMarkMicros) { * For AVR @16MHz we have only 4 us resolution. * The duration of the micros() call itself is 3 us. * It takes 0.9 us from signal going low here. - * The rest of the loop takes 1.2 us with NO_LED_FEEDBACK_CODE enabled - * and 3 us with NO_LED_FEEDBACK_CODE disabled. + * The rest of the loop takes 1.2 us with NO_LED_SEND_FEEDBACK_CODE enabled + * and 3 us with NO_LED_SEND_FEEDBACK_CODE disabled. */ - tMicros = micros(); // #if defined(_IR_MEASURE_TIMING) && defined(_IR_TIMING_TEST_PIN) digitalWriteFast(_IR_TIMING_TEST_PIN, LOW); // 2 clock cycles #endif /* * Exit the forever loop if aMarkMicros has reached */ - unsigned int tDeltaMicros = tMicros - tStartMicros; + tMicros = micros(); + uint16_t tDeltaMicros = tMicros - tStartMicros; #if defined(__AVR__) -// tDeltaMicros += (160 / CLOCKS_PER_MICRO); // adding this once increases program size ! -# if !defined(NO_LED_FEEDBACK_CODE) - if (tDeltaMicros >= aMarkMicros - (30 + (112 / CLOCKS_PER_MICRO))) { // 30 to be constant. Using periodTimeMicros increases program size too much. // reset feedback led in the last pause before end - if (FeedbackLEDControl.LedFeedbackEnabled == LED_FEEDBACK_ENABLED_FOR_SEND) { +// tDeltaMicros += (160 / CLOCKS_PER_MICRO); // adding this once increases program size, so do it below ! +# if !defined(NO_LED_SEND_FEEDBACK_CODE) + if (tDeltaMicros >= aMarkMicros - (30 + (112 / CLOCKS_PER_MICRO))) { // 30 to be constant. Using periodTimeMicros increases program size too much. + if (FeedbackLEDControl.LedFeedbackEnabled & LED_FEEDBACK_ENABLED_FOR_SEND) { setFeedbackLED(false); } } @@ -1065,13 +1293,15 @@ void IRsend::mark(uint16_t aMarkMicros) { if (tDeltaMicros >= aMarkMicros - (112 / CLOCKS_PER_MICRO)) { // To compensate for call duration - 112 is an empirical value #else if (tDeltaMicros >= aMarkMicros) { -# if !defined(NO_LED_FEEDBACK_CODE) +# if !defined(NO_LED_SEND_FEEDBACK_CODE) if (FeedbackLEDControl.LedFeedbackEnabled == LED_FEEDBACK_ENABLED_FOR_SEND) { setFeedbackLED(false); } # endif #endif +#if defined(__AVR__) interrupts(); +#endif return; } } while (tMicros < tNextPeriodEnding); @@ -1091,6 +1321,8 @@ void IRsend::IRLedOff() { # if defined(USE_OPEN_DRAIN_OUTPUT_FOR_SEND_PIN) && !defined(OUTPUT_OPEN_DRAIN) digitalWriteFast(sendPin, LOW); // prepare for all next active states. pinModeFast(sendPin, INPUT);// inactive state for open drain +# elif defined(USE_ACTIVE_HIGH_OUTPUT_FOR_SEND_PIN) + digitalWriteFast(sendPin, LOW); // Set output to inactive low. # else digitalWriteFast(sendPin, HIGH); // Set output to inactive high. # endif @@ -1106,8 +1338,8 @@ void IRsend::IRLedOff() { # endif #endif -#if !defined(NO_LED_FEEDBACK_CODE) - if (FeedbackLEDControl.LedFeedbackEnabled == LED_FEEDBACK_ENABLED_FOR_SEND) { +#if !defined(NO_LED_SEND_FEEDBACK_CODE) + if (FeedbackLEDControl.LedFeedbackEnabled & LED_FEEDBACK_ENABLED_FOR_SEND) { setFeedbackLED(false); } #endif @@ -1129,9 +1361,15 @@ void IRsend::customDelayMicroseconds(unsigned long aMicroseconds) { #if defined(ESP32) || defined(ESP8266) // from https://github.com/crankyoldgit/IRremoteESP8266/blob/00b27cc7ea2e7ac1e48e91740723c805a38728e0/src/IRsend.cpp#L123 // Invoke a delay(), where possible, to avoid triggering the WDT. - delay(aMicroseconds / 1000UL); // Delay for as many whole milliseconds as we can. - // Delay the remaining sub-millisecond. - delayMicroseconds(static_cast(aMicroseconds % 1000UL)); + // see https://github.com/Arduino-IRremote/Arduino-IRremote/issues/1114 for the reason of checking for > 16383) + // delayMicroseconds() is only accurate to 16383 us. Ref: https://www.arduino.cc/en/Reference/delayMicroseconds + if (aMicroseconds > 16383) { + delay(aMicroseconds / 1000UL); // Delay for as many whole milliseconds as we can. + // Delay the remaining sub-millisecond. + delayMicroseconds(static_cast(aMicroseconds % 1000UL)); + } else { + delayMicroseconds(aMicroseconds); + } #else # if defined(__AVR__) @@ -1149,19 +1387,19 @@ void IRsend::customDelayMicroseconds(unsigned long aMicroseconds) { * Enables IR output. The kHz value controls the modulation frequency in kilohertz. * IF PWM should be generated by a timer, it uses the platform specific timerConfigForSend() function, * otherwise it computes the delays used by the mark() function. - * If IR_SEND_PIN is defined, maximum PWM frequency for an AVR @16 MHz is 170 kHz (180 kHz if NO_LED_FEEDBACK_CODE is defined) + * If IR_SEND_PIN is defined, maximum PWM frequency for an AVR @16 MHz is 170 kHz (180 kHz if NO_LED_SEND_FEEDBACK_CODE is defined) */ void IRsend::enableIROut(uint_fast8_t aFrequencyKHz) { #if defined(SEND_PWM_BY_TIMER) - timerConfigForSend(aFrequencyKHz); // must set output pin mode and disable receive interrupt if required, e.g. uses the same resource + timerConfigForSend(aFrequencyKHz); // must set output pin mode and disable receive interrupt if required, e.g. uses the same resource #elif defined(USE_NO_SEND_PWM) - (void) aFrequencyKHz; + (void) aFrequencyKHz; #else periodTimeMicros = (1000U + (aFrequencyKHz / 2)) / aFrequencyKHz; // rounded value -> 26 for 38.46 kHz, 27 for 37.04 kHz, 25 for 40 kHz. # if defined(IR_SEND_PIN) - periodOnTimeMicros = (((periodTimeMicros * IR_SEND_DUTY_CYCLE_PERCENT) + 50) / 100U); // +50 for rounding -> 830/100 for 30% and 16 MHz + periodOnTimeMicros = (((periodTimeMicros * IR_SEND_DUTY_CYCLE_PERCENT) + 50) / 100U); // +50 for rounding -> 830/100 for 30% and 16 MHz # else // Heuristics! We require a nanosecond correction for "slow" digitalWrite() functions periodOnTimeMicros = (((periodTimeMicros * IR_SEND_DUTY_CYCLE_PERCENT) + 50 - (PULSE_CORRECTION_NANOS / 10)) / 100U); // +50 for rounding -> 530/100 for 30% and 16 MHz @@ -1170,9 +1408,9 @@ void IRsend::enableIROut(uint_fast8_t aFrequencyKHz) { #if defined(USE_OPEN_DRAIN_OUTPUT_FOR_SEND_PIN) && defined(OUTPUT_OPEN_DRAIN) // the mode INPUT for mimicking open drain is set at IRLedOff() # if defined(IR_SEND_PIN) - pinModeFast(IR_SEND_PIN, OUTPUT_OPEN_DRAIN); + pinModeFast(IR_SEND_PIN, OUTPUT_OPEN_DRAIN); # else - pinModeFast(sendPin, OUTPUT_OPEN_DRAIN); + pinModeFast(sendPin, OUTPUT_OPEN_DRAIN); # endif #else @@ -1180,14 +1418,34 @@ void IRsend::enableIROut(uint_fast8_t aFrequencyKHz) { // because ESP 2.0.2 ledcWrite does not work if pin mode is set, and RP2040 requires gpio_set_function(IR_SEND_PIN, GPIO_FUNC_PWM); # if defined(__AVR__) || !defined(SEND_PWM_BY_TIMER) # if defined(IR_SEND_PIN) - pinModeFast(IR_SEND_PIN, OUTPUT); + pinModeFast(IR_SEND_PIN, OUTPUT); # else - pinModeFast(sendPin, OUTPUT); + if (__builtin_constant_p(sendPin)) { + pinModeFast(sendPin, OUTPUT); + } else { + pinMode(sendPin, OUTPUT); + } # endif # endif #endif // defined(USE_OPEN_DRAIN_OUTPUT_FOR_SEND_PIN) } +#if defined(SEND_PWM_BY_TIMER) +// Used for Bang&Olufsen +void IRsend::enableHighFrequencyIROut(uint_fast16_t aFrequencyKHz) { + timerConfigForSend(aFrequencyKHz); // must set output pin mode and disable receive interrupt if required, e.g. uses the same resource + // For Non AVR platforms pin mode for SEND_PWM_BY_TIMER must be handled by the timerConfigForSend() function + // because ESP 2.0.2 ledcWrite does not work if pin mode is set, and RP2040 requires gpio_set_function(IR_SEND_PIN, GPIO_FUNC_PWM); +# if defined(__AVR__) +# if defined(IR_SEND_PIN) + pinModeFast(IR_SEND_PIN, OUTPUT); +# else + pinModeFast(sendPin, OUTPUT); +# endif +# endif +} +#endif + uint16_t IRsend::getPulseCorrectionNanos() { return PULSE_CORRECTION_NANOS; } diff --git a/src/IRVersion.h b/src/IRVersion.h new file mode 100644 index 000000000..acbafa22c --- /dev/null +++ b/src/IRVersion.h @@ -0,0 +1,51 @@ +/** + * @file IRversion.hpp + * + * This file is part of Arduino-IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. + * + ************************************************************************************ + * MIT License + * + * Copyright (c) 2015-2025 Ken Shirriff http://www.righto.com, Rafi Khan, Armin Joachimsmeyer + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is furnished + * to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, + * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A + * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF + * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE + * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * + ************************************************************************************ + * + * For Ken Shiriffs original blog entry, see http://www.righto.com/2009/08/multi-protocol-infrared-remote-library.html + * Initially influenced by: + * http://www.arduino.cc/cgi-bin/yabb2/YaBB.pl?num=1210243556 + * and http://zovirl.com/2008/11/12/building-a-universal-remote-with-an-arduino/ + */ + +#ifndef _IR_VERSION_HPP +#define _IR_VERSION_HPP + +#define VERSION_IRREMOTE "4.4.2" +#define VERSION_IRREMOTE_MAJOR 4 +#define VERSION_IRREMOTE_MINOR 4 +#define VERSION_IRREMOTE_PATCH 2 + +/* + * Macro to convert 3 version parts into an integer + * To be used in preprocessor comparisons, such as #if VERSION_IRREMOTE_HEX >= VERSION_HEX_VALUE(3, 7, 0) + */ +#define VERSION_HEX_VALUE(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +#define VERSION_IRREMOTE_HEX VERSION_HEX_VALUE(VERSION_IRREMOTE_MAJOR, VERSION_IRREMOTE_MINOR, VERSION_IRREMOTE_PATCH) + +#endif // _IR_VERSION_HPP diff --git a/src/IRremote.h b/src/IRremote.h index 70ad4a6a2..73cae0385 100644 --- a/src/IRremote.h +++ b/src/IRremote.h @@ -9,6 +9,50 @@ #include "IRremote.hpp" +#warning It seems, that you are using an old version 2.0 code / example. +#warning This version is no longer supported! +#warning Upgrade instructions can be found here: "https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#converting-your-2x-program-to-the-4x-version" +#warning Please use one of the new code examples from the library, available at "File > Examples > Examples from Custom Libraries / IRremote". +#warning Start with the SimpleReceiver or SimpleSender example. +#warning The examples are documented here: "https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#examples-for-this-library" +#warning Or just downgrade your library to version 2.6.0. + +/********************************************************************************************************************** + * The OLD and DEPRECATED decode function with parameter aResults, kept for backward compatibility to old 2.0 tutorials + * This function calls the old MSB first decoders and fills only the 3 variables: + * aResults->value + * aResults->bits + * aResults->decode_type + * It prints a message on the first call. + **********************************************************************************************************************/ +bool IRrecv::decode(decode_results *aResults) { + static bool sMessageWasSent = false; + if (!sMessageWasSent) { + Serial.println(F("**************************************************************************************************")); + Serial.println(F("Thank you for using the IRremote library!")); + Serial.println(F("It seems, that you are using an old version 2.0 code / example.")); + Serial.println(F("This version is no longer supported!")); + Serial.println(); + Serial.println(F("Upgrade instructions can be found here:")); + Serial.println(F(" https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#converting-your-2x-program-to-the-4x-version")); + Serial.println(); + Serial.println(F("Please use one of the new code examples from the library,")); + Serial.println(F(" available at \"File > Examples > Examples from Custom Libraries / IRremote\".")); + Serial.println(F("Start with the SimpleReceiver or SimpleSender example.")); + Serial.println(F("The examples are documented here:")); + Serial.println(F(" https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#examples-for-this-library")); + Serial.println(); + Serial.println(F("Or just downgrade your library to version 2.6.0.")); + Serial.println(); + Serial.println(F("Thanks")); + Serial.println(F("**************************************************************************************************")); + Serial.println(); + Serial.println(); + sMessageWasSent = true; + } + return decode_old(aResults); +} + #endif // IRremote_h #pragma once diff --git a/src/IRremote.hpp b/src/IRremote.hpp index 39a63fa00..fdeeb8350 100644 --- a/src/IRremote.hpp +++ b/src/IRremote.hpp @@ -13,7 +13,7 @@ ************************************************************************************ * MIT License * - * Copyright (c) 2015-2023 Ken Shirriff http://www.righto.com, Rafi Khan, Armin Joachimsmeyer + * Copyright (c) 2015-2025 Ken Shirriff http://www.righto.com, Rafi Khan, Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -56,6 +56,8 @@ * - RECORD_GAP_MICROS Minimum gap between IR transmissions, to detect the end of a protocol. * - FEEDBACK_LED_IS_ACTIVE_LOW Required on some boards (like my BluePill and my ESP8266 board), where the feedback LED is active low. * - NO_LED_FEEDBACK_CODE This completely disables the LED feedback code for send and receive. + * - NO_LED_RECEIVE_FEEDBACK_CODE This disables the LED feedback code for receive. + * - NO_LED_SEND_FEEDBACK_CODE This disables the LED feedback code for send. * - IR_INPUT_IS_ACTIVE_HIGH Enable it if you use a RF receiver, which has an active HIGH output signal. * - IR_SEND_DUTY_CYCLE_PERCENT Duty cycle of IR send signal. * - MICROS_PER_TICK Resolution of the raw input buffer data. Corresponds to 2 pulses of each 26.3 us at 38 kHz. @@ -65,17 +67,7 @@ #ifndef _IR_REMOTE_HPP #define _IR_REMOTE_HPP -#define VERSION_IRREMOTE "4.1.0" -#define VERSION_IRREMOTE_MAJOR 4 -#define VERSION_IRREMOTE_MINOR 1 -#define VERSION_IRREMOTE_PATCH 0 - -/* - * Macro to convert 3 version parts into an integer - * To be used in preprocessor comparisons, such as #if VERSION_IRREMOTE_HEX >= VERSION_HEX_VALUE(3, 7, 0) - */ -#define VERSION_HEX_VALUE(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) -#define VERSION_IRREMOTE_HEX VERSION_HEX_VALUE(VERSION_IRREMOTE_MAJOR, VERSION_IRREMOTE_MINOR, VERSION_IRREMOTE_PATCH) +#include "IRVersion.h" // activate it for all cores that does not use the -flto flag, if you get false error messages regarding begin() during compilation. //#define SUPPRESS_ERROR_MESSAGE_FOR_BEGIN @@ -96,7 +88,7 @@ #if !defined(NO_DECODER) // for sending raw only # if (!(defined(DECODE_DENON) || defined(DECODE_JVC) || defined(DECODE_KASEIKYO) \ -|| defined(DECODE_PANASONIC) || defined(DECODE_LG) || defined(DECODE_NEC) || defined(DECODE_SAMSUNG) \ +|| defined(DECODE_PANASONIC) || defined(DECODE_LG) || defined(DECODE_NEC) || defined(DECODE_ONKYO) || defined(DECODE_SAMSUNG) \ || defined(DECODE_SONY) || defined(DECODE_RC5) || defined(DECODE_RC6) \ || defined(DECODE_DISTANCE_WIDTH) || defined(DECODE_HASH) || defined(DECODE_BOSEWAVE) \ || defined(DECODE_LEGO_PF) || defined(DECODE_MAGIQUEST) || defined(DECODE_FAST) || defined(DECODE_WHYNTER))) @@ -117,7 +109,7 @@ # if !defined(EXCLUDE_EXOTIC_PROTOCOLS) // saves around 2000 bytes program memory #define DECODE_BOSEWAVE #define DECODE_LEGO_PF -#define DECODE_MAGIQUEST // It modifies the RAW_BUFFER_LENGTH from 100 to 112 +#define DECODE_MAGIQUEST #define DECODE_WHYNTER #define DECODE_FAST # endif @@ -167,19 +159,20 @@ * Keep in mind, that this is the delay between the end of the received command and the start of decoding. */ #if !defined(RECORD_GAP_MICROS) -// To change this value, you simply can add a line #define "RECORD_GAP_MICROS " in your ino file before the line "#include " -#define RECORD_GAP_MICROS 5000 // FREDRICH28AC / LG2 header space is 9700, NEC header space is 4500 +// To change this value, you simply can add a line #define "RECORD_GAP_MICROS " in your *.ino file before the line "#include " +// Maximum value for RECORD_GAP_MICROS, which fit into 8 bit buffer, using 50 us as tick, is 12750 +#define RECORD_GAP_MICROS 8000 // RECS80 (https://www.mikrocontroller.net/articles/IRMP#RECS80) 1 bit space is 7500µs , NEC header space is 4500 #endif /** * Threshold for warnings at printIRResult*() to report about changing the RECORD_GAP_MICROS value to a higher value. */ #if !defined(RECORD_GAP_MICROS_WARNING_THRESHOLD) -// To change this value, you simply can add a line #define "RECORD_GAP_MICROS_WARNING_THRESHOLD " in your ino file before the line "#include " +// To change this value, you simply can add a line #define "RECORD_GAP_MICROS_WARNING_THRESHOLD " in your *.ino file before the line "#include " #define RECORD_GAP_MICROS_WARNING_THRESHOLD 15000 #endif /** Minimum gap between IR transmissions, in MICROS_PER_TICK */ -#define RECORD_GAP_TICKS (RECORD_GAP_MICROS / MICROS_PER_TICK) // 100 +#define RECORD_GAP_TICKS (RECORD_GAP_MICROS / MICROS_PER_TICK) /* * Activate this line if your receiver has an external output driver transistor / "inverted" output @@ -202,7 +195,7 @@ #if (defined(ESP32) || defined(ARDUINO_ARCH_RP2040) || defined(PARTICLE)) || defined(ARDUINO_ARCH_MBED) # if !defined(SEND_PWM_BY_TIMER) #define SEND_PWM_BY_TIMER // the best and default method for ESP32 etc. -#warning INFO: For ESP32, RP2040, mbed and particle boards SEND_PWM_BY_TIMER is enabled by default. If this is not intended, deactivate the line in IRremote.hpp over this warning message in file IRremote.hpp. +#warning INFO: For ESP32, RP2040, mbed and particle boards SEND_PWM_BY_TIMER is enabled by default, since we have the resources and timing is more exact than the software generated one. If this is not intended, deactivate the line in IRremote.hpp over this warning message in file IRremote.hpp. # endif #else # if defined(SEND_PWM_BY_TIMER) @@ -263,12 +256,23 @@ #define MICROS_IN_ONE_SECOND 1000000L #define MICROS_IN_ONE_MILLI 1000L +#if defined(NO_LED_FEEDBACK_CODE) +# if !defined(NO_LED_RECEIVE_FEEDBACK_CODE) +#define NO_LED_RECEIVE_FEEDBACK_CODE +# endif +# if !defined(NO_LED_SEND_FEEDBACK_CODE) +#define NO_LED_SEND_FEEDBACK_CODE +# endif +#endif + #include "IRremoteInt.h" /* * We always use digitalWriteFast() and digitalReadFast() functions to have a consistent mapping for pins. * For most non AVR cpu's, it is just a mapping to digitalWrite() and digitalRead() functions. */ +#if !defined(MEGATINYCORE) // megaTinyCore has it own digitalWriteFast function set, except digitalToggleFast(). #include "digitalWriteFast.h" +#endif #if !defined(USE_IRREMOTE_HPP_AS_PLAIN_INCLUDE) #include "private/IRTimer.hpp" // defines IR_SEND_PIN for AVR and SEND_PWM_BY_TIMER @@ -281,6 +285,8 @@ #warning INFO: No definition for LED_BUILTIN found -> default LED feedback is disabled. # endif #include "IRFeedbackLED.hpp" +# else +void disableLEDFeedback() {}; // dummy function for examples # endif #include "LongUnion.h" // used in most decoders @@ -313,7 +319,7 @@ #include "ir_Others.hpp" #include "ir_Pronto.hpp" // pronto is an universal decoder and encoder # if defined(DECODE_DISTANCE_WIDTH) // universal decoder for pulse distance width protocols - requires up to 750 bytes additional program memory -#include +#include "ir_DistanceWidthProtocol.hpp" # endif #endif // #if !defined(USE_IRREMOTE_HPP_AS_PLAIN_INCLUDE) diff --git a/src/IRremoteInt.h b/src/IRremoteInt.h index 3b2cf4518..02023a8df 100644 --- a/src/IRremoteInt.h +++ b/src/IRremoteInt.h @@ -64,24 +64,61 @@ #define USE_DEFAULT_FEEDBACK_LED_PIN 0 /** - * The length of the buffer where the IR timing data is stored before decoding - * 100 is sufficient for most standard protocols, but air conditioners often send a longer protocol data stream + * The RAW_BUFFER_LENGTH determines the length of the byte buffer where the received IR timing data is stored before decoding. + * 100 is sufficient for standard protocols up to 48 bits, with 1 bit consisting of one mark and space plus 1 byte for initial gap, 2 bytes for header and 1 byte for stop bit. + * 48 bit protocols are PANASONIC, KASEIKYO, SAMSUNG48, RC6. + * 32 bit protocols like NEC, SAMSUNG, WHYNTER, SONY(20), LG(28) requires a buffer length of 68. + * 16 bit protocols like BOSEWAVE, DENON, FAST, JVC, LEGO_PF, RC5, SONY(12 or 15) requires a buffer length of 36. + * MAGIQUEST requires a buffer length of 112. + * Air conditioners often send a longer protocol data stream up to 750 bits. */ #if !defined(RAW_BUFFER_LENGTH) -# if defined(DECODE_MAGIQUEST) -#define RAW_BUFFER_LENGTH 112 // MagiQuest requires 112 bytes. -# else +# if (defined(RAMEND) && RAMEND <= 0x2FF) || (defined(RAMSIZE) && RAMSIZE < 0x2FF) +// for RAMsize <= 512 bytes #define RAW_BUFFER_LENGTH 100 ///< Length of raw duration buffer. Must be even. 100 supports up to 48 bit codings inclusive 1 start and 1 stop bit. -//#define RAW_BUFFER_LENGTH 750 // 750 (600 if we have only 2k RAM) is the value for air condition remotes. +# elif (defined(RAMEND) && RAMEND <= 0x8FF) || (defined(RAMSIZE) && RAMSIZE < 0x8FF) +// for RAMsize <= 2k +#define RAW_BUFFER_LENGTH 200 ///< Length of raw duration buffer. Must be even. 100 supports up to 48 bit codings inclusive 1 start and 1 stop bit. +# else +// For undefined or bigger RAMsize +#define RAW_BUFFER_LENGTH 750 // The value for air condition remotes. # endif #endif #if RAW_BUFFER_LENGTH % 2 == 1 #error RAW_BUFFER_LENGTH must be even, since the array consists of space / mark pairs. #endif -/**************************************************** +#if RAW_BUFFER_LENGTH <= 254 // saves around 75 bytes program memory and speeds up ISR +typedef uint_fast8_t IRRawlenType; +#else +typedef unsigned int IRRawlenType; +#endif + +/* + * Use 8 bit buffer for IR timing in 50 ticks units. + * It is save to use 8 bit if RECORD_GAP_TICKS < 256, since any value greater 255 is interpreted as frame gap of 12750 us. + * The default for frame gap is currently 8000! + * But if we assume that for most protocols the frame gap is way greater than the biggest mark or space duration, + * we can choose to use a 8 bit buffer even for frame gaps up to 200000 us. + * This enables the use of 8 bit buffer even for more some protocols like B&O or LG air conditioner etc. + */ +#if RECORD_GAP_TICKS <= 400 // Corresponds to RECORD_GAP_MICROS of 200000. A value of 255 is foolproof, but we assume, that the frame gap is way greater than the biggest mark or space duration. +typedef uint8_t IRRawbufType; // all timings up to the gap fit into 8 bit. +#else +typedef uint16_t IRRawbufType; // The gap does not fit into 8 bit ticks value. This must not be a reason to use 16 bit for buffer, but it is at least save. +#endif + +#if (__INT_WIDTH__ < 32) +typedef uint32_t IRRawDataType; +#define BITS_IN_RAW_DATA_TYPE 32 +#else +typedef uint64_t IRRawDataType; +#define BITS_IN_RAW_DATA_TYPE 64 +#endif + +/********************************************************** * Declarations for the receiver Interrupt Service Routine - ****************************************************/ + **********************************************************/ // ISR State-Machine : Receiver States #define IR_REC_STATE_IDLE 0 // Counting the gap time and waiting for the start bit to arrive #define IR_REC_STATE_MARK 1 // A mark was received and we are counting the duration of it. @@ -93,37 +130,31 @@ * Only StateForISR needs to be volatile. All the other fields are not written by ISR after data available and before start/resume. */ struct irparams_struct { - // The fields are ordered to reduce memory over caused by struct-padding + // The fields are ordered to reduce memory overflow caused by struct-padding volatile uint8_t StateForISR; ///< State Machine state uint_fast8_t IRReceivePin; ///< Pin connected to IR data from detector #if defined(__AVR__) volatile uint8_t *IRReceivePinPortInputRegister; uint8_t IRReceivePinMask; #endif - volatile uint_fast16_t TickCounterForISR; ///< Counts 50uS ticks. The value is copied into the rawbuf array on every transition. -#if !IR_REMOTE_DISABLE_RECEIVE_COMPLETE_CALLBACK + volatile uint_fast16_t TickCounterForISR; ///< Counts 50uS ticks. The value is copied into the rawbuf array on every transition. Counting is independent of state or resume(). +#if !defined(IR_REMOTE_DISABLE_RECEIVE_COMPLETE_CALLBACK) void (*ReceiveCompleteCallbackFunction)(void); ///< The function to call if a protocol message has arrived, i.e. StateForISR changed to IR_REC_STATE_STOP #endif bool OverflowFlag; ///< Raw buffer OverflowFlag occurred -#if RAW_BUFFER_LENGTH <= 254 // saves around 75 bytes program memory and speeds up ISR - uint_fast8_t rawlen; ///< counter of entries in rawbuf -#else - uint_fast16_t rawlen; ///< counter of entries in rawbuf -#endif - uint16_t rawbuf[RAW_BUFFER_LENGTH]; ///< raw data / tick counts per mark/space, first entry is the length of the gap between previous and current command + IRRawlenType rawlen; ///< counter of entries in rawbuf + uint16_t initialGapTicks; ///< Tick counts of the length of the gap between previous and current IR frame. Pre 4.4: rawbuf[0]. + IRRawbufType rawbuf[RAW_BUFFER_LENGTH]; ///< raw data / tick counts per mark/space. With 8 bit we can only store up to 12.7 ms. First entry is empty to be backwards compatible. }; -#if (__INT_WIDTH__ < 32) -typedef uint32_t IRRawDataType; -#define BITS_IN_RAW_DATA_TYPE 32 -#else -typedef uint64_t IRRawDataType; -#define BITS_IN_RAW_DATA_TYPE 64 -#endif +extern unsigned long sMicrosAtLastStopTimer; // Used to adjust TickCounterForISR with uncounted ticks between stopTimer() and restartTimer() + #include "IRProtocol.h" /* * Debug directives + * Outputs with IR_DEBUG_PRINT can only be activated by defining DEBUG! + * If LOCAL_DEBUG is defined in one file, all outputs with IR_DEBUG_PRINT are still suppressed. */ #if defined(DEBUG) || defined(TRACE) # define IR_DEBUG_PRINT(...) Serial.print(__VA_ARGS__) @@ -162,8 +193,8 @@ struct decode_results { uint16_t magnitude; // deprecated, moved to decodedIRData.extra ///< Used by MagiQuest [16-bits] bool isRepeat; // deprecated, moved to decodedIRData.flags ///< True if repeat of value is detected -// next 3 values are copies of irparams values - see IRremoteint.h - uint16_t *rawbuf; // deprecated, moved to decodedIRData.rawDataPtr->rawbuf ///< Raw intervals in 50uS ticks +// next 3 values are copies of irparams_struct values - see above + uint16_t *rawbuf; // deprecated, moved to decodedIRData.rawDataPtr->rawbuf ///< Raw intervals in 50uS ticks uint_fast8_t rawlen; // deprecated, moved to decodedIRData.rawDataPtr->rawlen ///< Number of records in rawbuf bool overflow; // deprecated, moved to decodedIRData.flags ///< true if IR raw code too long }; @@ -175,10 +206,17 @@ class IRrecv { public: IRrecv(); - IRrecv(uint_fast8_t aReceivePin); - IRrecv(uint_fast8_t aReceivePin, uint_fast8_t aFeedbackLEDPin); + IRrecv( + uint_fast8_t aReceivePin) + __attribute__ ((deprecated ("Please use the default IRrecv instance \"IrReceiver\" and IrReceiver.begin(), and not your own IRrecv instance."))); + IRrecv(uint_fast8_t aReceivePin, + uint_fast8_t aFeedbackLEDPin) + __attribute__ ((deprecated ("Please use the default IRrecv instance \"IrReceiver\" and IrReceiver.begin(), and not your own IRrecv instance.."))); void setReceivePin(uint_fast8_t aReceivePinNumber); +#if !defined(IR_REMOTE_DISABLE_RECEIVE_COMPLETE_CALLBACK) void registerReceiveCompleteCallback(void (*aReceiveCompleteCallbackFunction)(void)); +#endif + /* * Stream like API */ @@ -186,17 +224,16 @@ class IRrecv { USE_DEFAULT_FEEDBACK_LED_PIN); void start(); void enableIRIn(); // alias for start - void start(uint32_t aMicrosecondsToAddToGapCounter); - void startWithTicksToAdd(uint16_t aTicksToAddToGapCounter); + void restartTimer(); + void restartTimer(uint32_t aMicrosecondsToAddToGapCounter); + void restartTimerWithTicksToAdd(uint16_t aTicksToAddToGapCounter); void restartAfterSend(); - void addTicksToInternalTickCounter(uint16_t aTicksToAddToInternalTickCounter); - void addMicrosToInternalTickCounter(uint16_t aMicrosecondsToAddToInternalTickCounter); - bool available(); IRData* read(); // returns decoded data // write is a method of class IRsend below // size_t write(IRData *aIRSendData, int_fast8_t aNumberOfRepeats = NO_REPEATS); + void stopTimer(); void stop(); void disableIRIn(); // alias for stop void end(); // alias for stop @@ -213,14 +250,18 @@ class IRrecv { * Useful info and print functions */ void printIRResultMinimal(Print *aSerial); + void printIRDuration(Print *aSerial, bool aOutputMicrosecondsInsteadOfTicks); void printIRResultRawFormatted(Print *aSerial, bool aOutputMicrosecondsInsteadOfTicks = true); void printIRResultAsCVariables(Print *aSerial); + uint8_t getMaximumMarkTicksFromRawData(); + uint8_t getMaximumSpaceTicksFromRawData(); + uint8_t getMaximumTicksFromRawData(bool aSearchSpaceInsteadOfMark); uint32_t getTotalDurationOfRawData(); /* * Next 4 functions are also available as non member functions */ - bool printIRResultShort(Print *aSerial, bool aPrintRepeatGap = true, bool aCheckForRecordGapsMicros = true); + bool printIRResultShort(Print *aSerial, bool aCheckForRecordGapsMicros = true); void printDistanceWidthTimingInfo(Print *aSerial, DistanceWidthTimingInfoStruct *aDistanceWidthTimingInfo); void printIRSendUsage(Print *aSerial); #if defined(__AVR__) @@ -243,12 +284,22 @@ class IRrecv { * The main decoding functions used by the individual decoders */ bool decodePulseDistanceWidthData(PulseDistanceWidthProtocolConstants *aProtocolConstants, uint_fast8_t aNumberOfBits, - uint_fast8_t aStartOffset = 3); + IRRawlenType aStartOffset = 3); + + bool decodePulseDistanceWidthData_P(PulseDistanceWidthProtocolConstants const *aProtocolConstantsPGM, + uint_fast8_t aNumberOfBits, IRRawlenType aStartOffset = 3); + + bool decodePulseDistanceWidthData(uint_fast8_t aNumberOfBits, IRRawlenType aStartOffset, uint16_t aOneMarkMicros, + uint16_t aOneSpaceMicros, uint16_t aZeroMarkMicros, bool aMSBfirst); - bool decodePulseDistanceWidthData(uint_fast8_t aNumberOfBits, uint_fast8_t aStartOffset, uint16_t aOneMarkMicros, + bool decodePulseDistanceWidthData(uint_fast8_t aNumberOfBits, IRRawlenType aStartOffset, uint16_t aOneMarkMicros, + uint16_t aZeroMarkMicros, uint16_t aOneSpaceMicros, uint16_t aZeroSpaceMicros, bool aMSBfirst) + __attribute__ ((deprecated ("Please use decodePulseDistanceWidthData() with 6 parameters."))); + + bool decodePulseDistanceWidthDataStrict(uint_fast8_t aNumberOfBits, IRRawlenType aStartOffset, uint16_t aOneMarkMicros, uint16_t aZeroMarkMicros, uint16_t aOneSpaceMicros, uint16_t aZeroSpaceMicros, bool aMSBfirst); - bool decodeBiPhaseData(uint_fast8_t aNumberOfBits, uint_fast8_t aStartOffset, uint_fast8_t aStartClockCount, + bool decodeBiPhaseData(uint_fast8_t aNumberOfBits, IRRawlenType aStartOffset, uint_fast8_t aStartClockCount, uint_fast8_t aValueOfSpaceToMarkTransition, uint16_t aBiphaseTimeUnit); void initBiphaselevel(uint_fast8_t aRCDecodeRawbuffOffset, uint16_t aBiphaseTimeUnit); @@ -293,13 +344,15 @@ class IRrecv { bool decodeSAMSUNG(decode_results *aResults); bool decodeHashOld(decode_results *aResults); + bool decode_old(decode_results *aResults); + bool decode( decode_results *aResults) - __attribute__ ((deprecated ("Please use IrReceiver.decode() without a parameter and IrReceiver.decodedIRData. ."))); // deprecated + __attribute__ ((deprecated ("Please use IrReceiver.decode() without a parameter and IrReceiver.decodedIRData. ."))); // for backward compatibility. Now in IRFeedbackLED.hpp void blink13(uint8_t aEnableLEDFeedback) - __attribute__ ((deprecated ("Please use setLEDFeedback() or enableLEDFeedback() / disableLEDFeedback()."))); // deprecated + __attribute__ ((deprecated ("Please use setLEDFeedback() or enableLEDFeedback() / disableLEDFeedback()."))); /* * Internal functions @@ -307,15 +360,19 @@ class IRrecv { void initDecodedIRData(); uint_fast8_t compare(uint16_t oldval, uint16_t newval); bool checkHeader(PulseDistanceWidthProtocolConstants *aProtocolConstants); + bool checkHeader_P(PulseDistanceWidthProtocolConstants const *aProtocolConstantsPGM); void checkForRepeatSpaceTicksAndSetFlag(uint16_t aMaximumRepeatSpaceTicks); bool checkForRecordGapsMicros(Print *aSerial); - IRData decodedIRData; // New: decoded IR data for the application + IRData decodedIRData; // Decoded IR data for the application - // Last decoded IR data for repeat detection and parity for Denon autorepeat + // Last decoded IR data for repeat detection and to fill in JVC, LG, NEC repeat values. Parity for Denon autorepeat decode_type_t lastDecodedProtocol; - uint32_t lastDecodedAddress; - uint32_t lastDecodedCommand; + uint16_t lastDecodedAddress; + uint16_t lastDecodedCommand; +#if defined(DECODE_DISTANCE_WIDTH) + IRRawDataType lastDecodedRawData; +#endif uint8_t repeatCount; // Used e.g. for Denon decode for autorepeat decoding. }; @@ -364,23 +421,21 @@ void setBlinkPin(uint8_t aFeedbackLEDPin) __attribute__ ((deprecated ("Please us * First MARK is the one after the long gap * Pulse parameters in microseconds */ -#if !defined(TOLERANCE_FOR_DECODERS_MARK_OR_SPACE_MATCHING) -#define TOLERANCE_FOR_DECODERS_MARK_OR_SPACE_MATCHING 25 // Relative tolerance (in percent) for matchTicks(), matchMark() and matchSpace() functions used for protocol decoding. +#if !defined(TOLERANCE_FOR_DECODERS_MARK_OR_SPACE_MATCHING_PERCENT) +#define TOLERANCE_FOR_DECODERS_MARK_OR_SPACE_MATCHING_PERCENT 25 // Relative tolerance (in percent) for matchTicks(), matchMark() and matchSpace() functions used for protocol decoding. #endif +#define TICKS(us) ((us)/MICROS_PER_TICK) // (us)/50 +#if MICROS_PER_TICK == 50 && TOLERANCE_FOR_DECODERS_MARK_OR_SPACE_MATCHING_PERCENT == 25 // Defaults +#define TICKS_LOW(us) ((us)/67 ) // 67 = MICROS_PER_TICK / ((100-25)/100) = (MICROS_PER_TICK * 100) / (100-25) +#define TICKS_HIGH(us) (((us)/40) + 1) // 40 = MICROS_PER_TICK / ((100+25)/100) = (MICROS_PER_TICK * 100) / (100+25) +#else /** Lower tolerance for comparison of measured data */ //#define LTOL (1.0 - (TOLERANCE/100.)) -#define LTOL (100 - TOLERANCE_FOR_DECODERS_MARK_OR_SPACE_MATCHING) +#define LTOL (100 - TOLERANCE_FOR_DECODERS_MARK_OR_SPACE_MATCHING_PERCENT) /** Upper tolerance for comparison of measured data */ //#define UTOL (1.0 + (TOLERANCE/100.)) -#define UTOL (100 + TOLERANCE_FOR_DECODERS_MARK_OR_SPACE_MATCHING) - -//#define TICKS_LOW(us) ((int)(((us)*LTOL/MICROS_PER_TICK))) -//#define TICKS_HIGH(us) ((int)(((us)*UTOL/MICROS_PER_TICK + 1))) -#if MICROS_PER_TICK == 50 && TOLERANCE_FOR_DECODERS_MARK_OR_SPACE_MATCHING == 25 // Defaults -#define TICKS_LOW(us) ((us)/67 ) // (us) / ((MICROS_PER_TICK:50 / LTOL:75 ) * 100) -#define TICKS_HIGH(us) (((us)/40) + 1) // (us) / ((MICROS_PER_TICK:50 / UTOL:125) * 100) + 1 -#else +#define UTOL (100 + TOLERANCE_FOR_DECODERS_MARK_OR_SPACE_MATCHING_PERCENT) #define TICKS_LOW(us) ((uint16_t ) ((long) (us) * LTOL / (MICROS_PER_TICK * 100) )) #define TICKS_HIGH(us) ((uint16_t ) ((long) (us) * UTOL / (MICROS_PER_TICK * 100) + 1)) #endif @@ -413,15 +468,22 @@ class IRsend { IRsend(); /* - * IR_SEND_PIN is defined + * IR_SEND_PIN is defined or fixed by timer, value of IR_SEND_PIN is then "DeterminedByTimer" */ #if defined(IR_SEND_PIN) void begin(); - void begin(bool aEnableLEDFeedback, uint_fast8_t aFeedbackLEDPin = USE_DEFAULT_FEEDBACK_LED_PIN); + // The default parameter allowed to specify IrSender.begin(7); without errors, if IR_SEND_PIN was defined. But the semantics is not the one the user expect. + void begin(bool aEnableLEDFeedback, uint_fast8_t aFeedbackLEDPin); // 4.3.1 Removed default value USE_DEFAULT_FEEDBACK_LED_PIN for last parameter + // The next function is a dummy to avoid acceptance of pre 4.3 calls to begin(DISABLE_LED_FEEDBACK); + void begin(uint8_t aSendPin) +# if !defined (DOXYGEN) + __attribute__ ((deprecated ("ERROR: IR_SEND_PIN is still defined, therefore the function begin(aSendPin) is NOT available. You must disable '#define IR_SEND_PIN' to enable this function."))); +# endif + // The next function is a dummy to avoid acceptance of pre 4.0 calls to begin(IR_SEND_PIN, DISABLE_LED_FEEDBACK); void begin(uint_fast8_t aSendPin, bool aEnableLEDFeedback) # if !defined (DOXYGEN) - __attribute__ ((deprecated ("You must use begin(ENABLE_LED_FEEDBACK) or begin(DISABLE_LED_FEEDBACK) since version 4.0."))); + __attribute__ ((deprecated ("You must use begin() and enableLEDFeedback() or disableLEDFeedback() since version 4.3."))); # endif #else IRsend(uint_fast8_t aSendPin); @@ -435,40 +497,56 @@ class IRsend { size_t write(decode_type_t aProtocol, uint16_t aAddress, uint16_t aCommand, int_fast8_t aNumberOfRepeats = NO_REPEATS); void enableIROut(uint_fast8_t aFrequencyKHz); +#if defined(SEND_PWM_BY_TIMER) + void enableHighFrequencyIROut(uint_fast16_t aFrequencyKHz); // Used for Bang&Olufsen +#endif + /* + * Array functions + */ void sendPulseDistanceWidthFromArray(uint_fast8_t aFrequencyKHz, uint16_t aHeaderMarkMicros, uint16_t aHeaderSpaceMicros, uint16_t aOneMarkMicros, uint16_t aOneSpaceMicros, uint16_t aZeroMarkMicros, uint16_t aZeroSpaceMicros, IRRawDataType *aDecodedRawDataArray, uint16_t aNumberOfBits, uint8_t aFlags, uint16_t aRepeatPeriodMillis, int_fast8_t aNumberOfRepeats); - void sendPulseDistanceWidthFromArray(uint_fast8_t aFrequencyKHz, uint16_t aHeaderMarkMicros, uint16_t aHeaderSpaceMicros, + void sendPulseDistanceWidthFromPGMArray(uint_fast8_t aFrequencyKHz, uint16_t aHeaderMarkMicros, uint16_t aHeaderSpaceMicros, uint16_t aOneMarkMicros, uint16_t aOneSpaceMicros, uint16_t aZeroMarkMicros, uint16_t aZeroSpaceMicros, - IRRawDataType *aDecodedRawDataArray, uint16_t aNumberOfBits, bool aMSBFirst, bool aSendStopBit, - uint16_t aRepeatPeriodMillis, int_fast8_t aNumberOfRepeats) - __attribute__ ((deprecated ("Since version 4.1.0 parameter aSendStopBit is not longer required."))); + IRRawDataType const *aDecodedRawDataPGMArray, uint16_t aNumberOfBits, uint8_t aFlags, uint16_t aRepeatPeriodMillis, + int_fast8_t aNumberOfRepeats); void sendPulseDistanceWidthFromArray(PulseDistanceWidthProtocolConstants *aProtocolConstants, IRRawDataType *aDecodedRawDataArray, uint16_t aNumberOfBits, int_fast8_t aNumberOfRepeats); + void sendPulseDistanceWidthFromPGMArray(PulseDistanceWidthProtocolConstants *aProtocolConstants, + IRRawDataType const *aDecodedRawDataPGMArray, uint16_t aNumberOfBits, int_fast8_t aNumberOfRepeats); + void sendPulseDistanceWidthFromArray_P(PulseDistanceWidthProtocolConstants const *aProtocolConstantsPGM, + IRRawDataType *aDecodedRawDataArray, uint16_t aNumberOfBits, int_fast8_t aNumberOfRepeats); + void sendPulseDistanceWidthFromPGMArray_P(PulseDistanceWidthProtocolConstants const *aProtocolConstantsPGM, + IRRawDataType const *aDecodedRawDataPGMArray, uint16_t aNumberOfBits, int_fast8_t aNumberOfRepeats); + void sendPulseDistanceWidthFromArray(uint_fast8_t aFrequencyKHz, DistanceWidthTimingInfoStruct *aDistanceWidthTimingInfo, IRRawDataType *aDecodedRawDataArray, uint16_t aNumberOfBits, uint8_t aFlags, uint16_t aRepeatPeriodMillis, int_fast8_t aNumberOfRepeats); + void sendPulseDistanceWidthFromArray_P(uint_fast8_t aFrequencyKHz, + DistanceWidthTimingInfoStruct const *aDistanceWidthTimingInfoPGM, IRRawDataType *aDecodedRawDataArray, + uint16_t aNumberOfBits, uint8_t aFlags, uint16_t aRepeatPeriodMillis, int_fast8_t aNumberOfRepeats); void sendPulseDistanceWidth(PulseDistanceWidthProtocolConstants *aProtocolConstants, IRRawDataType aData, uint_fast8_t aNumberOfBits, int_fast8_t aNumberOfRepeats); + void sendPulseDistanceWidth_P(PulseDistanceWidthProtocolConstants const *aProtocolConstantsPGM, IRRawDataType aData, + uint_fast8_t aNumberOfBits, int_fast8_t aNumberOfRepeats); void sendPulseDistanceWidthData(PulseDistanceWidthProtocolConstants *aProtocolConstants, IRRawDataType aData, uint_fast8_t aNumberOfBits); + void sendPulseDistanceWidthData_P(PulseDistanceWidthProtocolConstants const *aProtocolConstantsPGM, IRRawDataType aData, + uint_fast8_t aNumberOfBits); void sendPulseDistanceWidth(uint_fast8_t aFrequencyKHz, uint16_t aHeaderMarkMicros, uint16_t aHeaderSpaceMicros, uint16_t aOneMarkMicros, uint16_t aOneSpaceMicros, uint16_t aZeroMarkMicros, uint16_t aZeroSpaceMicros, IRRawDataType aData, uint_fast8_t aNumberOfBits, uint8_t aFlags, uint16_t aRepeatPeriodMillis, - int_fast8_t aNumberOfRepeats, void (*aSpecialSendRepeatFunction)() = NULL); + int_fast8_t aNumberOfRepeats, void (*aSpecialSendRepeatFunction)() = nullptr); void sendPulseDistanceWidth(uint_fast8_t aFrequencyKHz, uint16_t aHeaderMarkMicros, uint16_t aHeaderSpaceMicros, uint16_t aOneMarkMicros, uint16_t aOneSpaceMicros, uint16_t aZeroMarkMicros, uint16_t aZeroSpaceMicros, IRRawDataType aData, uint_fast8_t aNumberOfBits, bool aMSBFirst, bool aSendStopBit, uint16_t aRepeatPeriodMillis, - int_fast8_t aNumberOfRepeats, void (*aSpecialSendRepeatFunction)() = NULL) + int_fast8_t aNumberOfRepeats, void (*aSpecialSendRepeatFunction)() = nullptr) __attribute__ ((deprecated ("Since version 4.1.0 parameter aSendStopBit is not longer required."))); void sendPulseDistanceWidthData(uint16_t aOneMarkMicros, uint16_t aOneSpaceMicros, uint16_t aZeroMarkMicros, uint16_t aZeroSpaceMicros, IRRawDataType aData, uint_fast8_t aNumberOfBits, uint8_t aFlags); - void sendPulseDistanceWidthData(uint16_t aOneMarkMicros, uint16_t aOneSpaceMicros, uint16_t aZeroMarkMicros, - uint16_t aZeroSpaceMicros, IRRawDataType aData, uint_fast8_t aNumberOfBits, bool aMSBFirst, bool aSendStopBit) - __attribute__ ((deprecated ("Since version 4.1.0 last parameter aSendStopBit is not longer required."))); void sendBiphaseData(uint16_t aBiphaseTimeUnit, uint32_t aData, uint_fast8_t aNumberOfBits); void mark(uint16_t aMarkMicros); @@ -494,7 +572,7 @@ class IRsend { void sendBangOlufsenRawDataLink(uint64_t aRawData, int_fast8_t aBits, bool aBackToBack = false, bool aUseDatalinkTiming = false); void sendBoseWave(uint8_t aCommand, int_fast8_t aNumberOfRepeats = NO_REPEATS); - void sendDenon(uint8_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats, bool aSendSharp = false); + void sendDenon(uint8_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats, uint8_t aSendSharpFrameMarker = 0); void sendDenonRaw(uint16_t aRawData, int_fast8_t aNumberOfRepeats = NO_REPEATS) #if !defined (DOXYGEN) __attribute__ ((deprecated ("Please use sendDenon(aAddress, aCommand, aNumberOfRepeats)."))); @@ -510,8 +588,8 @@ class IRsend { void sendNECRepeat(); uint32_t computeNECRawDataAndChecksum(uint16_t aAddress, uint16_t aCommand); - void sendNEC(uint16_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats); - void sendNEC2(uint16_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats); + void sendNEC(uint16_t aAddress, uint16_t aCommand, int_fast8_t aNumberOfRepeats); + void sendNEC2(uint16_t aAddress, uint16_t aCommand, int_fast8_t aNumberOfRepeats); void sendNECRaw(uint32_t aRawData, int_fast8_t aNumberOfRepeats = NO_REPEATS); // NEC variants void sendOnkyo(uint16_t aAddress, uint16_t aCommand, int_fast8_t aNumberOfRepeats); @@ -526,11 +604,16 @@ class IRsend { void sendRC5(uint8_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats, bool aEnableAutomaticToggle = true); void sendRC6(uint8_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats, bool aEnableAutomaticToggle = true); + void sendRC6A(uint8_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats, uint16_t aCustomer, + bool aEnableAutomaticToggle = true); void sendSamsungLGRepeat(); void sendSamsung(uint16_t aAddress, uint16_t aCommand, int_fast8_t aNumberOfRepeats); + void sendSamsung16BitAddressAnd8BitCommand(uint16_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats); + void sendSamsung16BitAddressAndCommand(uint16_t aAddress, uint16_t aCommand, int_fast8_t aNumberOfRepeats); void sendSamsung48(uint16_t aAddress, uint32_t aCommand, int_fast8_t aNumberOfRepeats); void sendSamsungLG(uint16_t aAddress, uint16_t aCommand, int_fast8_t aNumberOfRepeats); void sendSharp(uint8_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats); // redirected to sendDenon + void sendSharp2(uint8_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats); // redirected to sendDenon void sendSony(uint16_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats, uint8_t numberOfBits = 12); // SIRCS_12_PROTOCOL void sendLegoPowerFunctions(uint8_t aChannel, uint8_t tCommand, uint8_t aMode, bool aDoSend5Times = true); @@ -586,6 +669,8 @@ class IRsend { void sendSharp(uint16_t address, uint16_t command); void sendSAMSUNG(unsigned long data, int nbits); __attribute__ ((deprecated ("This old function sends MSB first! Please use sendSamsung()."))); + void sendSamsungMSB(unsigned long data, int nbits); + void sendSonyMSB(unsigned long data, int nbits); void sendSony(unsigned long data, int nbits) __attribute__ ((deprecated ("This old function sends MSB first! Please use sendSony(aAddress, aCommand, aNumberOfRepeats)."))); diff --git a/src/LongUnion.h b/src/LongUnion.h index 1946daab3..8f90f6135 100644 --- a/src/LongUnion.h +++ b/src/LongUnion.h @@ -30,6 +30,8 @@ /** * Union to specify parts / manifestations of a 16 bit Word without casts and shifts. * It also supports the compiler generating small code. + * Usage: WordUnion tWord; + * tWord.UByte.HighByte = 0x12; */ union WordUnion { struct { @@ -85,13 +87,14 @@ union LongUnion { struct { WordUnion LowWord; WordUnion HighWord; - } WordUnion; + } TwoWordUnions; uint8_t UBytes[4]; // seems to have the same code size as using struct UByte int8_t Bytes[4]; // Bytes[0] is LowByte uint16_t UWords[2]; int16_t Words[2]; uint32_t ULong; int32_t Long; + float Float; }; #endif // _LONG_UNION_H @@ -119,7 +122,7 @@ union LongLongUnion { WordUnion MidLowWord; WordUnion MidHighWord; WordUnion HighWord; - } WordUnion; + } FourWordUnions; struct { uint32_t LowLong; uint32_t HighLong; @@ -131,13 +134,19 @@ union LongLongUnion { struct { LongUnion LowLong; LongUnion HighLong; - } LongUnion; + } TwoLongUnions; uint8_t UBytes[8]; // seems to have the same code size as using struct UByte int8_t Bytes[8]; uint16_t UWords[4]; int16_t Words[4]; uint64_t ULongLong; int64_t LongLong; +#if __DBL_MANT_DIG__== 24 + float Floats[2]; // 32 bit double, as for AVR +#else + // 64 bit double + double Double; +#endif }; #endif // _LONG_LONG_UNION_H diff --git a/src/TinyIR.h b/src/TinyIR.h index f8cafefdd..8e29871e3 100644 --- a/src/TinyIR.h +++ b/src/TinyIR.h @@ -2,7 +2,7 @@ * TinyIR.h * * - * Copyright (C) 2021-2023 Armin Joachimsmeyer + * Copyright (C) 2021-2025 Armin Joachimsmeyer * armin.joachimsmeyer@gmail.com * * This file is part of IRMP https://github.com/IRMP-org/IRMP. @@ -34,8 +34,8 @@ * @{ */ -#define VERSION_TINYIR "1.2.0" -#define VERSION_TINYIR_MAJOR 1 +#define VERSION_TINYIR "2.2.0" +#define VERSION_TINYIR_MAJOR 2 #define VERSION_TINYIR_MINOR 2 #define VERSION_TINYIR_PATCH 0 // The change log is at the bottom of the file @@ -77,15 +77,15 @@ * - Repeats are sent as complete frames but in a 50 ms period / with a 21 ms distance. */ /* -Protocol=FAST Address=0x0 Command=0x76 Raw-Data=0x8976 16 bits LSB first + Protocol=FAST Address=0x0 Command=0x76 Raw-Data=0x8976 16 bits LSB first +2100,-1050 + 550,- 500 + 550,-1550 + 550,-1550 + 550,- 500 + 550,-1550 + 550,-1550 + 550,-1550 + 550,- 500 + 550,-1550 + 550,- 500 + 550,- 500 + 550,-1550 + 550,- 500 + 550,- 500 + 550,- 500 + 550,-1550 + 550 -Sum: 28900 -*/ + Sum: 28900 + */ #define FAST_KHZ 38 #define FAST_ADDRESS_BITS 0 // No address #define FAST_COMMAND_BITS 16 // Command and inverted command (parity) @@ -134,6 +134,8 @@ Sum: 28900 #define TINY_RECEIVER_ADDRESS_BITS NEC_ADDRESS_BITS // the address bits + parity # if defined(USE_ONKYO_PROTOCOL) #define TINY_RECEIVER_ADDRESS_HAS_8_BIT_PARITY false // 16 bit address without parity +# elif defined(USE_EXTENDED_NEC_PROTOCOL) +#define TINY_RECEIVER_ADDRESS_HAS_8_BIT_PARITY false // 16 bit address without parity # else #define TINY_RECEIVER_ADDRESS_HAS_8_BIT_PARITY true // 8 bit and 8 bit parity # endif @@ -158,36 +160,12 @@ Sum: 28900 #define TINY_RECEIVER_MAXIMUM_REPEAT_DISTANCE NEC_MAXIMUM_REPEAT_DISTANCE #endif +#if defined(USE_CALLBACK_FOR_TINY_RECEIVER) /* - * This function is called if a complete command was received and must be implemented in the file (user code) which includes this library. - * The parameter size is dependent of the code variant used in order to save program memory. - * We have 6 cases: 0, 8 bit or 16 bit address, each with 8 or 16 bit command + * This function is called, if a complete command was received and must be implemented in the file (user code) + * which includes this library if USE_CALLBACK_FOR_TINY_RECEIVER is activated. */ -#if (TINY_RECEIVER_ADDRESS_BITS > 0) -# if TINY_RECEIVER_ADDRESS_HAS_8_BIT_PARITY -// 8 bit address here -# if TINY_RECEIVER_COMMAND_HAS_8_BIT_PARITY -extern void handleReceivedTinyIRData(uint8_t aAddress, uint8_t aCommand, uint8_t aFlags); // Standard NEC callback -# else -extern void handleReceivedTinyIRData(uint8_t aAddress, uint16_t aCommand, uint8_t aFlags); // If SUPPORT_ONKYO_16_BIT_COMMAND is defined -# endif - -# else // TINY_RECEIVER_ADDRESS_HAS_8_BIT_PARITY -// 16 bit address here -# if TINY_RECEIVER_COMMAND_HAS_8_BIT_PARITY -extern void handleReceivedTinyIRData(uint16_t aAddress, uint8_t aCommand, uint8_t aFlags); -# else -extern void handleReceivedTinyIRData(uint16_t aAddress, uint16_t aCommand, uint8_t aFlags); -# endif -# endif - -#else -// FAST protocol - No address here -# if TINY_RECEIVER_COMMAND_HAS_8_BIT_PARITY -extern void handleReceivedTinyIRData(uint8_t aCommand, uint8_t aFlags); // Standard FAST callback -# else -extern void handleReceivedTinyIRData(uint16_t aCommand, uint8_t aFlags); // If "TINY_RECEIVER_COMMAND_HAS_8_BIT_PARITY false" is defined. 16 bit without parity. -# endif +extern void handleReceivedTinyIRData(); #endif #if !defined(MICROS_IN_ONE_SECOND) @@ -240,16 +218,15 @@ struct TinyIRReceiverStruct { /* * Definitions for member TinyIRReceiverCallbackDataStruct.Flags - * From IRremoteInt.h + * This is a copy of flags from IRremoteInt.h */ #define IRDATA_FLAGS_EMPTY 0x00 #define IRDATA_FLAGS_IS_REPEAT 0x01 -#define IRDATA_FLAGS_IS_AUTO_REPEAT 0x02 // not used here, overwritten with _IRDATA_FLAGS_IS_SHORT_REPEAT +#define IRDATA_FLAGS_IS_AUTO_REPEAT 0x02 // not used for TinyIR #define IRDATA_FLAGS_PARITY_FAILED 0x04 ///< the current (autorepeat) frame violated parity check /** - * Can be used by the callback to transfer received data to main loop for further processing. - * E.g. with volatile struct TinyIRReceiverCallbackDataStruct sCallbackData; + * Is filled before calling the user callback to transfer received data to main loop for further processing. */ struct TinyIRReceiverCallbackDataStruct { #if (TINY_RECEIVER_ADDRESS_BITS > 0) @@ -266,27 +243,51 @@ struct TinyIRReceiverCallbackDataStruct { uint8_t Command; #endif uint8_t Flags; // Bit coded flags. Can contain one of the bits: IRDATA_FLAGS_IS_REPEAT and IRDATA_FLAGS_PARITY_FAILED - bool justWritten; ///< Is set true if new data is available. Used by the main loop, to avoid multiple evaluations of the same IR frame. + bool justWritten; ///< Is set true if new data is available. Used by the main loop / TinyReceiverDecode(), to avoid multiple evaluations of the same IR frame. }; +extern volatile TinyIRReceiverCallbackDataStruct TinyIRReceiverData; +bool isIRReceiverAttachedForTinyReceiver(); bool initPCIInterruptForTinyReceiver(); bool enablePCIInterruptForTinyReceiver(); void disablePCIInterruptForTinyReceiver(); bool isTinyReceiverIdle(); -#if defined(USE_FAST_PROTOCOL) -void printTinyReceiverResultMinimal(Print *aSerial, uint16_t aCommand, uint8_t aFlags); -#else -void printTinyReceiverResultMinimal(Print *aSerial, uint8_t aAddress, uint8_t aCommand, uint8_t aFlags); -#endif +bool TinyReceiverDecode(); +void printTinyReceiverResultMinimal(Print *aSerial); void sendFAST(uint8_t aSendPin, uint16_t aCommand, uint_fast8_t aNumberOfRepeats = 0); void sendFast8BitAndParity(uint8_t aSendPin, uint8_t aCommand, uint_fast8_t aNumberOfRepeats = 0); -void sendONKYO(uint8_t aSendPin, uint16_t aAddress, uint16_t aCommand, uint_fast8_t aNumberOfRepeats = 0); // Send NEC with 16 bit command, even if aCommand < 0x100 +void sendONKYO(uint8_t aSendPin, uint16_t aAddress, uint16_t aCommand, uint_fast8_t aNumberOfRepeats = 0, bool aSendNEC2Repeats = false); // Send NEC with 16 bit command, even if aCommand < 0x100 void sendNECMinimal(uint8_t aSendPin, uint16_t aAddress, uint16_t aCommand, uint_fast8_t aNumberOfRepeats = 0) __attribute__ ((deprecated ("Renamed to sendNEC()."))); -void sendNEC(uint8_t aSendPin, uint16_t aAddress, uint16_t aCommand, uint_fast8_t aNumberOfRepeats = 0); +void sendNEC(uint8_t aSendPin, uint16_t aAddress, uint16_t aCommand, uint_fast8_t aNumberOfRepeats = 0, bool aSendNEC2Repeats = false); +void sendExtendedNEC(uint8_t aSendPin, uint16_t aAddress, uint16_t aCommand, uint_fast8_t aNumberOfRepeats = 0, bool aSendNEC2Repeats = false); + +#if defined(NO_LED_FEEDBACK_CODE) +# if !defined(NO_LED_RECEIVE_FEEDBACK_CODE) +#define NO_LED_RECEIVE_FEEDBACK_CODE +# endif +# if !defined(NO_LED_SEND_FEEDBACK_CODE) +#define NO_LED_SEND_FEEDBACK_CODE +# endif +#endif + +#if !defined(IR_FEEDBACK_LED_PIN) && defined(LED_BUILTIN) +#define IR_FEEDBACK_LED_PIN LED_BUILTIN +#endif /* + * Version 2.2.0 - 7/2024 + * - New TinyReceiverDecode() function to be used as drop in for IrReceiver.decode(). + * + * Version 2.1.0 - 2/2024 + * - New sendExtendedNEC() function and new parameter aSendNEC2Repeats. + * + * Version 2.0.0 - 10/2023 + * - New TinyIRReceiverData which is filled with address, command and flags. + * - Removed parameters address, command and flags from callback handleReceivedTinyIRData() and printTinyReceiverResultMinimal(). + * - Callback function now only enabled if USE_CALLBACK_FOR_TINY_RECEIVER is activated. + * * Version 1.2.0 - 01/2023 * - Added ONKYO protocol, NEC with 16 bit address and command, instead of 8 bit + 8 bit parity address and command. * - Renamed functions and macros. diff --git a/src/TinyIRReceiver.hpp b/src/TinyIRReceiver.hpp index ac6b07b43..af66d3c84 100644 --- a/src/TinyIRReceiver.hpp +++ b/src/TinyIRReceiver.hpp @@ -1,7 +1,7 @@ /* * TinyIRReceiver.hpp * - * Receives IR protocol data of NEC protocol using pin change interrupts. + * Receives IR data of NEC protocol using pin change interrupts. * NEC is the protocol of most cheap remote controls for Arduino. * * Parity check is done for address and data. @@ -28,7 +28,7 @@ ************************************************************************************ * MIT License * - * Copyright (c) 2022-2023 Armin Joachimsmeyer + * Copyright (c) 2022-2025 Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -56,11 +56,15 @@ * * - IR_RECEIVE_PIN The pin number for TinyIRReceiver IR input. * - IR_FEEDBACK_LED_PIN The pin number for TinyIRReceiver feedback LED. - * - NO_LED_FEEDBACK_CODE Disables the feedback LED function. Saves 14 bytes program memory. - * - DISABLE_PARITY_CHECKS Disable parity checks. Saves 48 bytes of program memory. + * - NO_LED_FEEDBACK_CODE Disables the feedback LED function for send and receive. Saves 14 bytes program memory. + * - NO_LED_RECEIVE_FEEDBACK_CODE Disables the LED feedback code for receive. + * - NO_LED_SEND_FEEDBACK_CODE Disables the LED feedback code for send. + * - DISABLE_PARITY_CHECKS Disable parity checks. Saves 48 bytes of program memory. + * - USE_EXTENDED_NEC_PROTOCOL Like NEC, but take the 16 bit address as one 16 bit value and not as 8 bit normal and 8 bit inverted value. * - USE_ONKYO_PROTOCOL Like NEC, but take the 16 bit address and command each as one 16 bit value and not as 8 bit normal and 8 bit inverted value. * - USE_FAST_PROTOCOL Use FAST protocol (no address and 16 bit data, interpreted as 8 bit command and 8 bit inverted command) instead of NEC. * - ENABLE_NEC2_REPEATS Instead of sending / receiving the NEC special repeat code, send / receive the original frame for repeat. + * - USE_CALLBACK_FOR_TINY_RECEIVER Call the user provided function "void handleReceivedTinyIRData()" each time a frame or repeat is received. */ #ifndef _TINY_IR_RECEIVER_HPP @@ -68,18 +72,19 @@ #include -#if defined(DEBUG) && !defined(LOCAL_DEBUG) -#define LOCAL_DEBUG -#else -//#define LOCAL_DEBUG // This enables debug output only for this file -#endif - +/* + * Protocol selection + */ //#define DISABLE_PARITY_CHECKS // Disable parity checks. Saves 48 bytes of program memory. +//#define USE_EXTENDED_NEC_PROTOCOL // Like NEC, but take the 16 bit address as one 16 bit value and not as 8 bit normal and 8 bit inverted value. //#define USE_ONKYO_PROTOCOL // Like NEC, but take the 16 bit address and command each as one 16 bit value and not as 8 bit normal and 8 bit inverted value. -//#define USE_FAST_PROTOCOL // Use FAST protocol instead of NEC. +//#define USE_FAST_PROTOCOL // Use FAST protocol instead of NEC / ONKYO. //#define ENABLE_NEC2_REPEATS // Instead of sending / receiving the NEC special repeat code, send / receive the original frame for repeat. -#include "TinyIR.h" // If not defined, it defines IR_RECEIVE_PIN, IR_FEEDBACK_LED_PIN and TINY_RECEIVER_USE_ARDUINO_ATTACH_INTERRUPT +//#define IR_RECEIVE_PIN 2 +//#define NO_LED_RECEIVE_FEEDBACK_CODE // Disables the LED feedback code for receive. +//#define IR_FEEDBACK_LED_PIN 12 // Use this, to disable use of LED_BUILTIN definition for IR_FEEDBACK_LED_PIN +#include "TinyIR.h" #include "digitalWriteFast.h" /** \addtogroup TinyReceiver Minimal receiver for NEC and FAST protocol @@ -87,10 +92,13 @@ */ #if defined(DEBUG) +#define LOCAL_DEBUG #define LOCAL_DEBUG_ATTACH_INTERRUPT #else -//#define LOCAL_DEBUG_ATTACH_INTERRUPT // to see if attachInterrupt() or static interrupt (by register tweaking) is used +//#define LOCAL_DEBUG // This enables debug output only for this file +//#define LOCAL_DEBUG_ATTACH_INTERRUPT // To see if attachInterrupt() or static interrupt (by register tweaking) is used and no other debug output #endif + #if defined(TRACE) #define LOCAL_TRACE_STATE_MACHINE #else @@ -100,6 +108,7 @@ //#define _IR_MEASURE_TIMING // Activate this if you want to enable internal hardware timing measurement. //#define _IR_TIMING_TEST_PIN 7 TinyIRReceiverStruct TinyIRReceiverControl; +volatile TinyIRReceiverCallbackDataStruct TinyIRReceiverData; /* * Set input pin and output pin definitions etc. @@ -108,22 +117,20 @@ TinyIRReceiverStruct TinyIRReceiverControl; #warning "IR_INPUT_PIN is deprecated, use IR_RECEIVE_PIN" #define IR_RECEIVE_PIN IR_INPUT_PIN #endif + #if !defined(IR_RECEIVE_PIN) -#if defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) +# if defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) #warning "IR_RECEIVE_PIN is not defined, so it is set to 10" #define IR_RECEIVE_PIN 10 -#elif defined(__AVR_ATtiny816__) +# elif defined(__AVR_ATtiny816__) #warning "IR_RECEIVE_PIN is not defined, so it is set to 14" #define IR_RECEIVE_PIN 14 -#else +# else #warning "IR_RECEIVE_PIN is not defined, so it is set to 2" #define IR_RECEIVE_PIN 2 -#endif +# endif #endif -#if !defined(IR_FEEDBACK_LED_PIN) && defined(LED_BUILTIN) -#define IR_FEEDBACK_LED_PIN LED_BUILTIN -#endif #if !( \ (defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__)) /* ATtinyX5 */ \ @@ -143,16 +150,17 @@ TinyIRReceiverStruct TinyIRReceiverControl; * Declaration of the callback function provided by the user application. * It is called every time a complete IR command or repeat was received. */ -extern void handleReceivedIRData(uint16_t aAddress, uint8_t aCommand, bool isRepetition); +extern void handleReceivedTinyIRData(); -#if defined(LOCAL_DEBUG) -uint32_t sMicrosOfGap; // The length of the gap before the start bit -#endif +uint32_t sMicrosOfGap; // The length of the gap before the start bit, used for trace /** * The ISR (Interrupt Service Routine) of TinyIRRreceiver. * It handles the NEC protocol decoding and calls the user callback function on complete. * 5 us + 3 us for push + pop for a 16MHz ATmega */ +#if defined(ESP8266) || defined(ESP32) +IRAM_ATTR +#endif void IRPinChangeInterruptHandler(void) { #if defined(_IR_MEASURE_TIMING) && defined(_IR_TIMING_TEST_PIN) digitalWriteFast(_IR_TIMING_TEST_PIN, HIGH); // 2 clock cycles @@ -163,8 +171,12 @@ void IRPinChangeInterruptHandler(void) { */ uint_fast8_t tIRLevel = digitalReadFast(IR_RECEIVE_PIN); -#if !defined(NO_LED_FEEDBACK_CODE) && defined(IR_FEEDBACK_LED_PIN) +#if !defined(NO_LED_RECEIVE_FEEDBACK_CODE) && defined(IR_FEEDBACK_LED_PIN) +# if defined(FEEDBACK_LED_IS_ACTIVE_LOW) + digitalWriteFast(IR_FEEDBACK_LED_PIN, tIRLevel); +# else digitalWriteFast(IR_FEEDBACK_LED_PIN, !tIRLevel); +# endif #endif /* @@ -200,7 +212,7 @@ void IRPinChangeInterruptHandler(void) { // We are at the beginning of the header mark, check timing at the next transition tState = IR_RECEIVER_STATE_WAITING_FOR_START_SPACE; TinyIRReceiverControl.Flags = IRDATA_FLAGS_EMPTY; // If we do it here, it saves 4 bytes -#if defined(LOCAL_TRACE) +#if defined(TRACE) // Do not use LOCAL_TRACE here since sMicrosOfGap is read in a cpp file at TRACE sMicrosOfGap = tMicrosOfMarkOrSpace32; #endif #if defined(ENABLE_NEC2_REPEATS) @@ -217,7 +229,7 @@ void IRPinChangeInterruptHandler(void) { if (tMicrosOfMarkOrSpace >= lowerValue25Percent(TINY_RECEIVER_HEADER_SPACE) && tMicrosOfMarkOrSpace <= upperValue25Percent(TINY_RECEIVER_HEADER_SPACE)) { /* - * We have a valid data header space here -> initialize data + * We had a valid data header space here -> initialize data */ TinyIRReceiverControl.IRRawDataBitCounter = 0; #if (TINY_RECEIVER_BITS > 16) @@ -314,9 +326,9 @@ void IRPinChangeInterruptHandler(void) { * Check address parity * Address is sent first and contained in the lower word */ - if (TinyIRReceiverControl.IRRawData.UBytes[0] != (uint8_t) (~TinyIRReceiverControl.IRRawData.UBytes[1])) { + if (TinyIRReceiverControl.IRRawData.UBytes[0] != (uint8_t)(~TinyIRReceiverControl.IRRawData.UBytes[1])) { #if defined(ENABLE_NEC2_REPEATS) - TinyIRReceiverControl.Flags |= IRDATA_FLAGS_PARITY_FAILED; // here we can have the repeat flag already set + TinyIRReceiverControl.Flags |= IRDATA_FLAGS_PARITY_FAILED; // here we can have the repeat flag already set #else TinyIRReceiverControl.Flags = IRDATA_FLAGS_PARITY_FAILED; // here we do not check anything, if we have a repeat #endif @@ -327,17 +339,17 @@ void IRPinChangeInterruptHandler(void) { * Check command parity */ #if (TINY_RECEIVER_ADDRESS_BITS > 0) - if (TinyIRReceiverControl.IRRawData.UBytes[2] != (uint8_t) (~TinyIRReceiverControl.IRRawData.UBytes[3])) { + if (TinyIRReceiverControl.IRRawData.UBytes[2] != (uint8_t)(~TinyIRReceiverControl.IRRawData.UBytes[3])) { #if defined(ENABLE_NEC2_REPEATS) - TinyIRReceiverControl.Flags |= IRDATA_FLAGS_PARITY_FAILED; + TinyIRReceiverControl.Flags |= IRDATA_FLAGS_PARITY_FAILED; #else TinyIRReceiverControl.Flags = IRDATA_FLAGS_PARITY_FAILED; #endif # if defined(LOCAL_DEBUG) - Serial.print(F("Parity check for command failed. Command=")); - Serial.print(TinyIRReceiverControl.IRRawData.UBytes[2], HEX); - Serial.print(F(" parity=")); - Serial.println(TinyIRReceiverControl.IRRawData.UBytes[3], HEX); + Serial.print(F("Parity check for command failed. Command=")); + Serial.print(TinyIRReceiverControl.IRRawData.UBytes[2], HEX); + Serial.print(F(" parity=")); + Serial.println(TinyIRReceiverControl.IRRawData.UBytes[3], HEX); # endif #else // No address, so command and parity are in the lowest bytes @@ -360,34 +372,37 @@ void IRPinChangeInterruptHandler(void) { #if !defined(ARDUINO_ARCH_MBED) && !defined(ESP32) // no Serial etc. in callback for ESP -> no interrupt required, WDT is running! interrupts(); // enable interrupts, so delay() etc. works in callback #endif - handleReceivedTinyIRData( + TinyIRReceiverData.justWritten = true; + TinyIRReceiverData.Flags = TinyIRReceiverControl.Flags; #if (TINY_RECEIVER_ADDRESS_BITS > 0) # if TINY_RECEIVER_ADDRESS_HAS_8_BIT_PARITY - // Here we have 8 bit address - TinyIRReceiverControl.IRRawData.UBytes[0], + // Here we have 8 bit address + TinyIRReceiverData.Address = TinyIRReceiverControl.IRRawData.UBytes[0]; # else - // Here we have 16 bit address - TinyIRReceiverControl.IRRawData.UWord.LowWord, + // Here we have 16 bit address + TinyIRReceiverData.Address = TinyIRReceiverControl.IRRawData.UWord.LowWord; # endif # if TINY_RECEIVER_COMMAND_HAS_8_BIT_PARITY - // Here we have 8 bit command - TinyIRReceiverControl.IRRawData.UBytes[2], + // Here we have 8 bit command + TinyIRReceiverData.Command = TinyIRReceiverControl.IRRawData.UBytes[2]; # else - // Here we have 16 bit command - TinyIRReceiverControl.IRRawData.UWord.HighWord, + // Here we have 16 bit command + TinyIRReceiverData.Command = TinyIRReceiverControl.IRRawData.UWord.HighWord; # endif -#else - // Here we have NO address +#else + // Here we have NO address # if TINY_RECEIVER_COMMAND_HAS_8_BIT_PARITY - // Here we have 8 bit command - TinyIRReceiverControl.IRRawData.UBytes[0], + // Here we have 8 bit command + TinyIRReceiverData.Command = TinyIRReceiverControl.IRRawData.UBytes[0]; # else - // Here we have 16 bit command - TinyIRReceiverControl.IRRawData.UWord, + // Here we have 16 bit command + TinyIRReceiverData.Command = TinyIRReceiverControl.IRRawData.UWord; # endif #endif - TinyIRReceiverControl.Flags); +#if defined(USE_CALLBACK_FOR_TINY_RECEIVER) + handleReceivedTinyIRData(); +#endif } else { // not finished yet @@ -413,6 +428,28 @@ bool isTinyReceiverIdle() { return (TinyIRReceiverControl.IRReceiverState == IR_RECEIVER_STATE_WAITING_FOR_START_MARK); } +/* + * Function to be used as drop in for IrReceiver.decode() + */ +bool TinyReceiverDecode() { + bool tJustWritten = TinyIRReceiverData.justWritten; + if (tJustWritten) { + TinyIRReceiverData.justWritten = false; + } + return tJustWritten; +} + +/* + * Checks if IR_RECEIVE_PIN is connected and high + * @return true, if IR Receiver is attached + */ +bool isIRReceiverAttachedForTinyReceiver() { + pinModeFast(IR_RECEIVE_PIN, OUTPUT); + digitalWriteFast(IR_RECEIVE_PIN, LOW); // discharge pin capacity + pinModeFast(IR_RECEIVE_PIN, INPUT); + return digitalRead(IR_RECEIVE_PIN); // use slow digitalRead here, since the pin capacity is not fully charged again if we use digitalReadFast. +} + /** * Sets IR_RECEIVE_PIN mode to INPUT, and if IR_FEEDBACK_LED_PIN is defined, sets feedback LED output mode. * Then call enablePCIInterruptForTinyReceiver() @@ -420,33 +457,30 @@ bool isTinyReceiverIdle() { bool initPCIInterruptForTinyReceiver() { pinModeFast(IR_RECEIVE_PIN, INPUT); -#if !defined(NO_LED_FEEDBACK_CODE) && defined(IR_FEEDBACK_LED_PIN) +#if !defined(NO_LED_RECEIVE_FEEDBACK_CODE) && defined(IR_FEEDBACK_LED_PIN) pinModeFast(IR_FEEDBACK_LED_PIN, OUTPUT); +# if defined(FEEDBACK_LED_IS_ACTIVE_LOW) + digitalWriteFast(IR_FEEDBACK_LED_PIN, HIGH); +# endif #endif return enablePCIInterruptForTinyReceiver(); } -#if defined(USE_FAST_PROTOCOL) -void printTinyReceiverResultMinimal(Print *aSerial, uint16_t aCommand, uint8_t aFlags) -#else -void printTinyReceiverResultMinimal(Print *aSerial, uint8_t aAddress, uint8_t aCommand, uint8_t aFlags) -#endif - { +void printTinyReceiverResultMinimal(Print *aSerial) { // Print only very short output, since we are in an interrupt context and do not want to miss the next interrupts of the repeats coming soon - // Print only very short output, since we are in an interrupt context and do not want to miss the next interrupts of the repeats coming soon #if defined(USE_FAST_PROTOCOL) aSerial->print(F("C=0x")); #else aSerial->print(F("A=0x")); - aSerial->print(aAddress, HEX); + aSerial->print(TinyIRReceiverData.Address, HEX); aSerial->print(F(" C=0x")); #endif - aSerial->print(aCommand, HEX); - if (aFlags == IRDATA_FLAGS_IS_REPEAT) { + aSerial->print(TinyIRReceiverData.Command, HEX); + if (TinyIRReceiverData.Flags == IRDATA_FLAGS_IS_REPEAT) { aSerial->print(F(" R")); } #if !defined(DISABLE_PARITY_CHECKS) - if (aFlags == IRDATA_FLAGS_PARITY_FAILED) { + if (TinyIRReceiverData.Flags == IRDATA_FLAGS_PARITY_FAILED) { aSerial->print(F(" P")); } #endif @@ -539,14 +573,19 @@ bool enablePCIInterruptForTinyReceiver() { #if defined(USE_ATTACH_INTERRUPT) || defined(USE_ATTACH_INTERRUPT_DIRECT) # if defined(USE_ATTACH_INTERRUPT) -#if defined(NOT_AN_INTERRUPT) +# if defined(NOT_AN_INTERRUPT) // check if IDE has defined the check of digitalPinToInterrupt if(digitalPinToInterrupt(IR_RECEIVE_PIN) == NOT_AN_INTERRUPT){ return false; } -#endif +# endif // costs 112 bytes program memory + 4 bytes RAM +# if defined(ARDUINO_ARCH_SAMD) // see https://www.arduino.cc/reference/tr/language/functions/external-interrupts/attachinterrupt/ paragraph: Syntax + attachInterrupt(IR_RECEIVE_PIN, IRPinChangeInterruptHandler, CHANGE); // no extra pin mapping here :-( +# else attachInterrupt(digitalPinToInterrupt(IR_RECEIVE_PIN), IRPinChangeInterruptHandler, CHANGE); +# endif # else + // USE_ATTACH_INTERRUPT_DIRECT here, only defined for ATtinies *16, see above // 2.2 us more than version configured with macros and not compatible attachInterrupt(IR_RECEIVE_PIN, IRPinChangeInterruptHandler, CHANGE); // no extra pin mapping here # endif @@ -554,11 +593,11 @@ bool enablePCIInterruptForTinyReceiver() { # if defined(LOCAL_DEBUG_ATTACH_INTERRUPT) Serial.println(F("Use attachInterrupt for pin=" STR(IR_RECEIVE_PIN))); # endif - #else # if defined(LOCAL_DEBUG_ATTACH_INTERRUPT) Serial.println(F("Use static interrupt for pin=" STR(IR_RECEIVE_PIN))); # endif + # if defined(USE_INT0) // interrupt on any logical change EICRA |= _BV(ISC00); diff --git a/src/TinyIRSender.hpp b/src/TinyIRSender.hpp index 0672383bb..be0d07ef7 100644 --- a/src/TinyIRSender.hpp +++ b/src/TinyIRSender.hpp @@ -19,7 +19,7 @@ ************************************************************************************ * MIT License * - * Copyright (c) 2022-2023 Armin Joachimsmeyer + * Copyright (c) 2022-2025 Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -48,11 +48,13 @@ //#define ENABLE_NEC2_REPEATS // Instead of sending / receiving the NEC special repeat code, send / receive the original frame for repeat. -#if defined(DEBUG) && !defined(LOCAL_DEBUG) +#if defined(DEBUG) #define LOCAL_DEBUG #else //#define LOCAL_DEBUG // This enables debug output only for this file #endif +//#define NO_LED_SEND_FEEDBACK_CODE // Disables the LED feedback code for receive. +//#define IR_FEEDBACK_LED_PIN 12 // Use this, to disable use of LED_BUILTIN definition for IR_FEEDBACK_LED_PIN #include "TinyIR.h" // Defines protocol timings #include "digitalWriteFast.h" @@ -60,6 +62,10 @@ * @{ */ +#if !defined(IR_SEND_PIN) +#warning "IR_SEND_PIN is not defined, so it is set to 3" +#define IR_SEND_PIN 3 +#endif /* * Generate 38 kHz IR signal by bit banging */ @@ -101,28 +107,35 @@ void sendMark(uint8_t aSendPin, unsigned int aMarkMicros) { } /* - * Send NEC with 16 bit command, even if aCommand < 0x100 + * Send NEC with 16 bit address and command, even if aCommand < 0x100 (I.E. ONKYO) * @param aAddress - The 16 bit address to send. * @param aCommand - The 16 bit command to send. * @param aNumberOfRepeats - Number of repeats send at a period of 110 ms. + * @param aSendNEC2Repeats - Instead of sending the NEC special repeat code, send the original frame for repeat. */ -void sendONKYO(uint8_t aSendPin, uint16_t aAddress, uint16_t aCommand, uint_fast8_t aNumberOfRepeats) { +void sendONKYO(uint8_t aSendPin, uint16_t aAddress, uint16_t aCommand, uint_fast8_t aNumberOfRepeats, bool aSendNEC2Repeats) { pinModeFast(aSendPin, OUTPUT); +#if !defined(NO_LED_SEND_FEEDBACK_CODE) && defined(IR_FEEDBACK_LED_PIN) + pinModeFast(IR_FEEDBACK_LED_PIN, OUTPUT); +# if defined(FEEDBACK_LED_IS_ACTIVE_LOW) + digitalWriteFast(IR_FEEDBACK_LED_PIN, LOW); +# else + digitalWriteFast(IR_FEEDBACK_LED_PIN, HIGH); +# endif +#endif + uint_fast8_t tNumberOfCommands = aNumberOfRepeats + 1; while (tNumberOfCommands > 0) { unsigned long tStartOfFrameMillis = millis(); sendMark(aSendPin, NEC_HEADER_MARK); -#if !defined(ENABLE_NEC2_REPEATS) - if (tNumberOfCommands < aNumberOfRepeats + 1) { + if ((!aSendNEC2Repeats) && (tNumberOfCommands < aNumberOfRepeats + 1)) { // send the NEC special repeat - delayMicroseconds(NEC_REPEAT_HEADER_SPACE); // - 2250 - } else -#endif - { + delayMicroseconds (NEC_REPEAT_HEADER_SPACE); // - 2250 + } else { // send header - delayMicroseconds(NEC_HEADER_SPACE); + delayMicroseconds (NEC_HEADER_SPACE); LongUnion tData; tData.UWord.LowWord = aAddress; tData.UWord.HighWord = aCommand; @@ -130,9 +143,9 @@ void sendONKYO(uint8_t aSendPin, uint16_t aAddress, uint16_t aCommand, uint_fast for (uint_fast8_t i = 0; i < NEC_BITS; ++i) { sendMark(aSendPin, NEC_BIT_MARK); // constant mark length if (tData.ULong & 1) { - delayMicroseconds(NEC_ONE_SPACE); + delayMicroseconds (NEC_ONE_SPACE); } else { - delayMicroseconds(NEC_ZERO_SPACE); + delayMicroseconds (NEC_ZERO_SPACE); } tData.ULong >>= 1; // shift command for next bit } @@ -151,34 +164,49 @@ void sendONKYO(uint8_t aSendPin, uint16_t aAddress, uint16_t aCommand, uint_fast } } } +#if !defined(NO_LED_SEND_FEEDBACK_CODE) && defined(IR_FEEDBACK_LED_PIN) + pinModeFast(IR_FEEDBACK_LED_PIN, OUTPUT); +# if defined(FEEDBACK_LED_IS_ACTIVE_LOW) + digitalWriteFast(IR_FEEDBACK_LED_PIN, HIGH); +# else + digitalWriteFast(IR_FEEDBACK_LED_PIN, LOW); +# endif +#endif } /* - * Send NEC with 8 or 16 bit address or data depending on the values of aAddress and aCommand. + * Send NEC with 8 or 16 bit address or command depending on the values of aAddress and aCommand. * @param aAddress - If aAddress < 0x100 send 8 bit address and 8 bit inverted address, else send 16 bit address. * @param aCommand - If aCommand < 0x100 send 8 bit command and 8 bit inverted command, else send 16 bit command. * @param aNumberOfRepeats - Number of repeats send at a period of 110 ms. + * @param aSendNEC2Repeats - Instead of sending the NEC special repeat code, send the original frame for repeat. */ void sendNECMinimal(uint8_t aSendPin, uint16_t aAddress, uint16_t aCommand, uint_fast8_t aNumberOfRepeats) { sendNEC(aSendPin, aAddress, aCommand, aNumberOfRepeats); // sendNECMinimal() is deprecated } -void sendNEC(uint8_t aSendPin, uint16_t aAddress, uint16_t aCommand, uint_fast8_t aNumberOfRepeats) { +void sendNEC(uint8_t aSendPin, uint16_t aAddress, uint16_t aCommand, uint_fast8_t aNumberOfRepeats, bool aSendNEC2Repeats) { pinModeFast(aSendPin, OUTPUT); +#if !defined(NO_LED_SEND_FEEDBACK_CODE) && defined(IR_FEEDBACK_LED_PIN) + pinModeFast(IR_FEEDBACK_LED_PIN, OUTPUT); +# if defined(FEEDBACK_LED_IS_ACTIVE_LOW) + digitalWriteFast(IR_FEEDBACK_LED_PIN, LOW); +# else + digitalWriteFast(IR_FEEDBACK_LED_PIN, HIGH); +# endif +#endif + uint_fast8_t tNumberOfCommands = aNumberOfRepeats + 1; while (tNumberOfCommands > 0) { unsigned long tStartOfFrameMillis = millis(); sendMark(aSendPin, NEC_HEADER_MARK); -#if !defined(ENABLE_NEC2_REPEATS) - if (tNumberOfCommands < aNumberOfRepeats + 1) { + if ((!aSendNEC2Repeats) && (tNumberOfCommands < aNumberOfRepeats + 1)) { // send the NEC special repeat - delayMicroseconds(NEC_REPEAT_HEADER_SPACE); // - 2250 - } else -#endif - { + delayMicroseconds (NEC_REPEAT_HEADER_SPACE); // - 2250 + } else { // send header - delayMicroseconds(NEC_HEADER_SPACE); + delayMicroseconds (NEC_HEADER_SPACE); LongUnion tData; /* * The compiler is intelligent and removes the code for "(aAddress > 0xFF)" if we are called with an uint8_t address :-). @@ -201,9 +229,9 @@ void sendNEC(uint8_t aSendPin, uint16_t aAddress, uint16_t aCommand, uint_fast8_ sendMark(aSendPin, NEC_BIT_MARK); // constant mark length if (tData.ULong & 1) { - delayMicroseconds(NEC_ONE_SPACE); + delayMicroseconds (NEC_ONE_SPACE); } else { - delayMicroseconds(NEC_ZERO_SPACE); + delayMicroseconds (NEC_ZERO_SPACE); } tData.ULong >>= 1; // shift command for next bit } @@ -222,6 +250,88 @@ void sendNEC(uint8_t aSendPin, uint16_t aAddress, uint16_t aCommand, uint_fast8_ } } } +#if !defined(NO_LED_SEND_FEEDBACK_CODE) && defined(IR_FEEDBACK_LED_PIN) + pinModeFast(IR_FEEDBACK_LED_PIN, OUTPUT); +# if defined(FEEDBACK_LED_IS_ACTIVE_LOW) + digitalWriteFast(IR_FEEDBACK_LED_PIN, HIGH); +# else + digitalWriteFast(IR_FEEDBACK_LED_PIN, LOW); +# endif +#endif +} + +/* + * Send Extended NEC with a forced 16 bit address and 8 or 16 bit command depending on the value of aCommand. + * @param aAddress - Send 16 bit address. + * @param aCommand - If aCommand < 0x100 send 8 bit command and 8 bit inverted command, else send 16 bit command. + * @param aNumberOfRepeats - Number of repeats send at a period of 110 ms. + * @param aSendNEC2Repeats - Instead of sending the NEC special repeat code, send the original frame for repeat. + */ +void sendExtendedNEC(uint8_t aSendPin, uint16_t aAddress, uint16_t aCommand, uint_fast8_t aNumberOfRepeats, bool aSendNEC2Repeats) { + pinModeFast(aSendPin, OUTPUT); + +#if !defined(NO_LED_SEND_FEEDBACK_CODE) && defined(IR_FEEDBACK_LED_PIN) + pinModeFast(IR_FEEDBACK_LED_PIN, OUTPUT); +# if defined(FEEDBACK_LED_IS_ACTIVE_LOW) + digitalWriteFast(IR_FEEDBACK_LED_PIN, LOW); +# else + digitalWriteFast(IR_FEEDBACK_LED_PIN, HIGH); +# endif +#endif + + uint_fast8_t tNumberOfCommands = aNumberOfRepeats + 1; + while (tNumberOfCommands > 0) { + unsigned long tStartOfFrameMillis = millis(); + + sendMark(aSendPin, NEC_HEADER_MARK); + if ((!aSendNEC2Repeats) && (tNumberOfCommands < aNumberOfRepeats + 1)) { + // send the NEC special repeat + delayMicroseconds (NEC_REPEAT_HEADER_SPACE); // - 2250 + } else { + // send header + delayMicroseconds (NEC_HEADER_SPACE); + LongUnion tData; + tData.UWord.LowWord = aAddress; + if (aCommand > 0xFF) { + tData.UWord.HighWord = aCommand; + } else { + tData.UByte.MidHighByte = aCommand; + tData.UByte.HighByte = ~aCommand; // LSB first + } + // Send data + for (uint_fast8_t i = 0; i < NEC_BITS; ++i) { + sendMark(aSendPin, NEC_BIT_MARK); // constant mark length + + if (tData.ULong & 1) { + delayMicroseconds (NEC_ONE_SPACE); + } else { + delayMicroseconds (NEC_ZERO_SPACE); + } + tData.ULong >>= 1; // shift command for next bit + } + } // send stop bit + sendMark(aSendPin, NEC_BIT_MARK); + + tNumberOfCommands--; + // skip last delay! + if (tNumberOfCommands > 0) { + /* + * Check and fallback for wrong RepeatPeriodMillis parameter. I.e the repeat period must be greater than each frame duration. + */ + auto tFrameDurationMillis = millis() - tStartOfFrameMillis; + if (NEC_REPEAT_PERIOD / 1000 > tFrameDurationMillis) { + delay(NEC_REPEAT_PERIOD / 1000 - tFrameDurationMillis); + } + } + } +#if !defined(NO_LED_SEND_FEEDBACK_CODE) && defined(IR_FEEDBACK_LED_PIN) + pinModeFast(IR_FEEDBACK_LED_PIN, OUTPUT); +# if defined(FEEDBACK_LED_IS_ACTIVE_LOW) + digitalWriteFast(IR_FEEDBACK_LED_PIN, HIGH); +# else + digitalWriteFast(IR_FEEDBACK_LED_PIN, LOW); +# endif +#endif } /* @@ -237,6 +347,15 @@ void sendFast8BitAndParity(uint8_t aSendPin, uint8_t aCommand, uint_fast8_t aNum void sendFAST(uint8_t aSendPin, uint16_t aCommand, uint_fast8_t aNumberOfRepeats) { pinModeFast(aSendPin, OUTPUT); +#if !defined(NO_LED_SEND_FEEDBACK_CODE) && defined(IR_FEEDBACK_LED_PIN) + pinModeFast(IR_FEEDBACK_LED_PIN, OUTPUT); +# if defined(FEEDBACK_LED_IS_ACTIVE_LOW) + digitalWriteFast(IR_FEEDBACK_LED_PIN, LOW); +# else + digitalWriteFast(IR_FEEDBACK_LED_PIN, HIGH); +# endif +#endif + uint_fast8_t tNumberOfCommands = aNumberOfRepeats + 1; while (tNumberOfCommands > 0) { unsigned long tStartOfFrameMillis = millis(); @@ -280,6 +399,14 @@ void sendFAST(uint8_t aSendPin, uint16_t aCommand, uint_fast8_t aNumberOfRepeats } } } +#if !defined(NO_LED_SEND_FEEDBACK_CODE) && defined(IR_FEEDBACK_LED_PIN) + pinModeFast(IR_FEEDBACK_LED_PIN, OUTPUT); +# if defined(FEEDBACK_LED_IS_ACTIVE_LOW) + digitalWriteFast(IR_FEEDBACK_LED_PIN, HIGH); +# else + digitalWriteFast(IR_FEEDBACK_LED_PIN, LOW); +# endif +#endif } /** @}*/ diff --git a/src/digitalWriteFast.h b/src/digitalWriteFast.h index 50d447c46..faeaa5afd 100644 --- a/src/digitalWriteFast.h +++ b/src/digitalWriteFast.h @@ -5,12 +5,22 @@ * by Watterott electronic (www.watterott.com) * based on https://code.google.com/p/digitalwritefast * + * The value of DigitalReadFast() is the content of the input register e.g. 0x04 for pin2 and NOT always 0 or 1. + * * License: BSD 3-Clause License (https://opensource.org/licenses/BSD-3-Clause) */ #ifndef __digitalWriteFast_h_ #define __digitalWriteFast_h_ 1 +//#define THROW_ERROR_IF_NOT_FAST // If activated, an error is thrown if pin is not a compile time constant +void NonConstantsUsedForPinModeFast( void ) __attribute__ (( error("Parameter for pinModeFast() function is not constant") )); +void NonConstantsUsedForDigitalWriteFast( void ) __attribute__ (( error("Parameter for digitalWriteFast() function is not constant") )); +void NonConstantsUsedForDigitalToggleFast( void ) __attribute__ (( error("Parameter for digitalToggleFast() function is not constant") )); +int NonConstantsUsedForDigitalReadFast( void ) __attribute__ (( error("Parameter for digitalReadFast() function is not constant") )); + +#if !defined(MEGATINYCORE) // megaTinyCore has it own digitalWriteFast function set, except digitalToggleFast(). + //#define SANGUINO_PINOUT // define for Sanguino pinout // general macros/defines @@ -27,6 +37,8 @@ # define BIT_WRITE(value, bit, bitvalue) (bitvalue ? BIT_SET(value, bit) : BIT_CLEAR(value, bit)) #endif +#include // declarations for the fallback to digitalWrite(), digitalRead() etc. + // --- Arduino Mega and ATmega128x/256x based boards --- #if (defined(ARDUINO_AVR_MEGA) || \ defined(ARDUINO_AVR_MEGA1280) || \ @@ -128,6 +140,13 @@ (((P) <= 7) ? &DDRB : (((P) >= 8 && (P) <= 15) ? &DDRD : (((P) >= 16 && (P) <= 23) ? &DDRC : &DDRA))) #define __digitalPinToPINReg(P) \ (((P) <= 7) ? &PINB : (((P) >= 8 && (P) <= 15) ? &PIND : (((P) >= 16 && (P) <= 23) ? &PINC : &PINA))) +# if defined(SANGUINO_PINOUT) +#define __digitalPinToBit(P) \ +(((P) <= 7) ? (P) : (((P) >= 8 && (P) <= 15) ? (P) - 8 : (((P) >= 16 && (P) <= 23) ? (P) - 16 : (7 - ((P) - 24))))) +# else //MightyCore Pinout +#define __digitalPinToBit(P) \ +(((P) <= 7) ? (P) : (((P) >= 8 && (P) <= 15) ? (P) - 8 : (((P) >= 16 && (P) <= 23) ? (P) - 16 : (P) - 24))) +# endif #else #define __digitalPinToPortReg(P) \ (((P) <= 7) ? &PORTB : (((P) >= 8 && (P) <= 15) ? &PORTD : &PORTC)) @@ -292,38 +311,37 @@ #define __digitalPinToPortReg(P) (((P) <= 7) ? &PORTA : &PORTB) #define __digitalPinToDDRReg(P) (((P) <= 7) ? &DDRA : &DDRB) #define __digitalPinToPINReg(P) (((P) <= 7) ? &PINA : &PINB) -# if defined(__AVR_ATtiny24__) || defined(__AVR_ATtiny44__) || defined(__AVR_ATtiny84__) || defined(__AVR_ATtiny441__) || defined(__AVR_ATtiny841__) +# endif +# if defined(__AVR_ATtiny24__) || defined(__AVR_ATtiny44__) || defined(__AVR_ATtiny84__) || defined(__AVR_ATtiny441__) || defined(__AVR_ATtiny841__) // https://github.com/SpenceKonde/ATTinyCore/blob/v2.0.0-devThis-is-the-head-submit-PRs-against-this/avr/variants/tinyx41_cw/pins_arduino.h#L334 // Clockwise layout #define __digitalPinToBit(P) (((P) <= 7) ? (P) : ((P) == 11 ? (3) : 10 - (P))) -# endif +# else #define __digitalPinToBit(P) (((P) <= 7) ? (P) : (P) - 8 ) # endif #endif - -void NonConstantsUsedForPinModeFast( void ) __attribute__ (( error("Parameter for pinModeFast() function is not constant") )); -void NonConstantsUsedForDigitalWriteFast( void ) __attribute__ (( error("Parameter for digitalWriteFast() function is not constant") )); -void NonConstantsUsedForDigitalToggleFast( void ) __attribute__ (( error("Parameter for digitalToggleFast() function is not constant") )); -int NonConstantsUsedForDigitalReadFast( void ) __attribute__ (( error("Parameter for digitalReadFast() function is not constant") )); - #if !defined(digitalWriteFast) # if (defined(__AVR__) || defined(ARDUINO_ARCH_AVR)) && defined(__digitalPinToPortReg) # if defined(THROW_ERROR_IF_NOT_FAST) #define digitalWriteFast(P, V) \ -if (__builtin_constant_p(P)) { \ - BIT_WRITE(*__digitalPinToPortReg(P), __digitalPinToBit(P), (V)); \ -} else { \ +do { \ + if (__builtin_constant_p(P)) { \ + BIT_WRITE(*__digitalPinToPortReg(P), __digitalPinToBit(P), (V)); \ + } else { \ NonConstantsUsedForDigitalWriteFast(); \ -} + } \ +} while (0) # else #define digitalWriteFast(P, V) \ -if (__builtin_constant_p(P)) { \ - BIT_WRITE(*__digitalPinToPortReg(P), __digitalPinToBit(P), (V)); \ -} else { \ - digitalWrite((P), (V)); \ -} +do { \ + if (__builtin_constant_p(P)) { \ + BIT_WRITE(*__digitalPinToPortReg(P), __digitalPinToBit(P), (V)); \ + } else { \ + digitalWrite((P), (V)); \ + } \ +} while (0) # endif // defined(THROW_ERROR_IF_NOT_FAST) # else #define digitalWriteFast digitalWrite @@ -334,28 +352,32 @@ if (__builtin_constant_p(P)) { \ # if (defined(__AVR__) || defined(ARDUINO_ARCH_AVR)) && defined(__digitalPinToPortReg) # if defined(THROW_ERROR_IF_NOT_FAST) #define pinModeFast(P, V) \ -if (__builtin_constant_p(P) && __builtin_constant_p(V)) { \ - if (V == INPUT_PULLUP) {\ - BIT_CLEAR(*__digitalPinToDDRReg(P), __digitalPinToBit(P)); \ - BIT_SET(*__digitalPinToPortReg(P), __digitalPinToBit(P)); \ +do { \ + if (__builtin_constant_p(P) && __builtin_constant_p(V)) { \ + if (V == INPUT_PULLUP) {\ + BIT_CLEAR(*__digitalPinToDDRReg(P), __digitalPinToBit(P)); \ + BIT_SET(*__digitalPinToPortReg(P), __digitalPinToBit(P)); \ + } else { \ + BIT_WRITE(*__digitalPinToDDRReg(P), __digitalPinToBit(P), (V)); \ + } \ } else { \ - BIT_WRITE(*__digitalPinToDDRReg(P), __digitalPinToBit(P), (V)); \ - } \ -} else { \ NonConstantsUsedForPinModeFast(); \ -} + } \ +} while (0) # else #define pinModeFast(P, V) \ -if (__builtin_constant_p(P) && __builtin_constant_p(V)) { \ - if (V == INPUT_PULLUP) {\ - BIT_CLEAR(*__digitalPinToDDRReg(P), __digitalPinToBit(P)); \ - BIT_SET(*__digitalPinToPortReg(P), __digitalPinToBit(P)); \ +do { \ + if (__builtin_constant_p(P) && __builtin_constant_p(V)) { \ + if (V == INPUT_PULLUP) {\ + BIT_CLEAR(*__digitalPinToDDRReg(P), __digitalPinToBit(P)); \ + BIT_SET(*__digitalPinToPortReg(P), __digitalPinToBit(P)); \ + } else { \ + BIT_WRITE(*__digitalPinToDDRReg(P), __digitalPinToBit(P), (V)); \ + } \ } else { \ - BIT_WRITE(*__digitalPinToDDRReg(P), __digitalPinToBit(P), (V)); \ + pinMode((P), (V)); \ } \ -} else { \ - pinMode((P), (V)); \ -} +} while (0) # endif // defined(THROW_ERROR_IF_NOT_FAST) # else #define pinModeFast pinMode @@ -367,17 +389,11 @@ if (__builtin_constant_p(P) && __builtin_constant_p(V)) { \ # if defined(THROW_ERROR_IF_NOT_FAST) #define digitalReadFast(P) ( (int) __digitalReadFast((P)) ) // since we have return values, it is easier to implement it by ?: -#define __digitalReadFast(P ) \ - (__builtin_constant_p(P) ) ? \ - (( BIT_READ(*__digitalPinToPINReg(P), __digitalPinToBit(P))) ? HIGH:LOW ) : \ - NonConstantsUsedForDigitalReadFast() +#define __digitalReadFast(P ) ( (__builtin_constant_p(P) ) ? (( BIT_READ(*__digitalPinToPINReg(P), __digitalPinToBit(P))) ? HIGH:LOW ) : NonConstantsUsedForDigitalReadFast() ) # else #define digitalReadFast(P) ( (int) __digitalReadFast((P)) ) // since we have return values, it is easier to implement it by ?: -#define __digitalReadFast(P ) \ - (__builtin_constant_p(P) ) ? \ - (( BIT_READ(*__digitalPinToPINReg(P), __digitalPinToBit(P))) ? HIGH:LOW ) : \ - digitalRead((P)) +#define __digitalReadFast(P ) ( (__builtin_constant_p(P) ) ? (( BIT_READ(*__digitalPinToPINReg(P), __digitalPinToBit(P))) ? HIGH:LOW ) : digitalRead((P)) ) # endif // defined(THROW_ERROR_IF_NOT_FAST) # else #define digitalReadFast digitalRead @@ -388,22 +404,27 @@ if (__builtin_constant_p(P) && __builtin_constant_p(V)) { \ # if (defined(__AVR__) || defined(ARDUINO_ARCH_AVR)) && defined(__digitalPinToPINReg) # if defined(THROW_ERROR_IF_NOT_FAST) #define digitalToggleFast(P) \ -if (__builtin_constant_p(P)) { \ - BIT_SET(*__digitalPinToPINReg(P), __digitalPinToBit(P)); \ -} else { \ +do { \ + if (__builtin_constant_p(P)) { \ + BIT_SET(*__digitalPinToPINReg(P), __digitalPinToBit(P)); \ + } else { \ NonConstantsUsedForDigitalToggleFast(); \ -} + } \ +} while (0) # else #define digitalToggleFast(P) \ -if (__builtin_constant_p(P)) { \ - BIT_SET(*__digitalPinToPINReg(P), __digitalPinToBit(P)); \ -} else { \ - digitalWrite(P, ! digitalRead(P)); \ -} +do { \ + if (__builtin_constant_p(P)) { \ + BIT_SET(*__digitalPinToPINReg(P), __digitalPinToBit(P)); \ + } else { \ + digitalWrite(P, ! digitalRead(P)); \ + } \ +} while (0) # endif // defined(THROW_ERROR_IF_NOT_FAST) # else #define digitalToggleFast(P) digitalWrite(P, ! digitalRead(P)) # endif #endif // !defined(digitalToggleFast) +#endif // !defined(MEGATINYCORE) #endif //__digitalWriteFast_h_ diff --git a/src/ir_BangOlufsen.hpp b/src/ir_BangOlufsen.hpp index cf42043e2..628a5792e 100644 --- a/src/ir_BangOlufsen.hpp +++ b/src/ir_BangOlufsen.hpp @@ -10,7 +10,7 @@ ************************************************************************************ * MIT License * - * Copyright (c) 2022 Daniel Wallner + * Copyright (c) 2022-2023 Daniel Wallner and Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -63,13 +63,15 @@ // It might be that this only happens over IR and not on the datalink protocol // You can choose to support this or not: -// Alt 1: Mode with gaps between frames -// Set RECORD_GAP_MICROS to at least 16000 to accommodate the unusually long 3. start space -// Can only receive single messages and back to back repeats will result in overflow +// Mode 1: Mode with gaps between frames +// Set RECORD_GAP_MICROS to at least 16000 to accept the unusually long 3. start space +// Can only receive single messages. Back to back repeats will result in overflow -// Alt 2: Break at start mode -// Define ENABLE_BEO_WITHOUT_FRAME_GAP and set RECORD_GAP_MICROS to 13000 to treat the 3. start space as a gap between messages -// The start of a transmission will result in a dummy decode with 0 bits data followed by the actual messages +// Mode 2: Break at start mode +// Define ENABLE_BEO_WITHOUT_FRAME_GAP and set RECORD_GAP_MICROS to less than 15000 +// to treat the 3. start space of 15.5 ms as a gap between messages, which makes decoding easier :-). +// The receiving of a transmission will then result in a dummy decode of the first 2 start bits with 0 bits data +// followed by a 15.5 ms gap and a data frame with one start bit (originally sent as 4. start bit). // If the receiver is not resumed within a ms or so, partial messages will be decoded // Debug printing in the wrong place is very likely to break reception // Make sure to check the number of bits to filter dummy and incomplete messages @@ -77,27 +79,29 @@ // !!! We assume that the real implementations never set the official first header bit to anything other than 0 !!! // !!! We therefore use 4 start bits instead of the specified 3 and in turn ignore the first header bit of the specification !!! -// IR messages are 16 bits long and datalink messages have different lengths +// IR messages are 16 bits long. Datalink messages have different lengths. // This implementation supports up to 40 bits total length split into 8 bit data/command and a header/address of variable length // Header data with more than 16 bits is stored in decodedIRData.extra // B&O is a pulse distance protocol, but it has 3 bit values 0, 1 and (equal/repeat) as well as a special start and trailing bit. +// // MSB first, 4 start bits + 8 to 16? bit address + 8 bit command + 1 special trailing bit + 1 stop bit. // Address can be longer than 8 bit. /* * Options for this decoder + * */ -//#define ENABLE_BEO_WITHOUT_FRAME_GAP // Requires additional 30 bytes program memory. +#define ENABLE_BEO_WITHOUT_FRAME_GAP // Requires additional 30 bytes program memory. Enabled by default, see https://github.com/Arduino-IRremote/Arduino-IRremote/discussions/1181 //#define SUPPORT_BEO_DATALINK_TIMING_FOR_DECODE // This also supports headers up to 32 bit. Requires additional 150 bytes program memory. #if defined(DECODE_BEO) # if defined(ENABLE_BEO_WITHOUT_FRAME_GAP) -# if RECORD_GAP_MICROS > 13000 -#warning If defined ENABLE_BEO_WITHOUT_FRAME_GAP, RECORD_GAP_MICROS must be set to 1300 by "#define RECORD_GAP_MICROS 13000" +# if RECORD_GAP_MICROS > 15000 +#warning If defined ENABLE_BEO_WITHOUT_FRAME_GAP, RECORD_GAP_MICROS must be set to <= 15000 by "#define RECORD_GAP_MICROS 12750" # endif # else # if RECORD_GAP_MICROS < 16000 -#error If not defined ENABLE_BEO_WITHOUT_FRAME_GAP, RECORD_GAP_MICROS must be set to a value >= 1600 by "#define RECORD_GAP_MICROS 16000" +#error If not defined ENABLE_BEO_WITHOUT_FRAME_GAP, RECORD_GAP_MICROS must be set to a value >= 16000 by "#define RECORD_GAP_MICROS 16000" # endif # endif #endif @@ -160,14 +164,18 @@ void IRsend::sendBangOlufsenDataLink(uint32_t aHeader, uint8_t aData, int_fast8_ * @param aBackToBack If true send data back to back, which cannot be decoded if ENABLE_BEO_WITHOUT_FRAME_GAP is NOT defined */ void IRsend::sendBangOlufsenRaw(uint32_t aRawData, int_fast8_t aBits, bool aBackToBack) { -#if defined(USE_NO_SEND_PWM) || BEO_KHZ == 38 // BEO_KHZ == 38 is for unit test which runs the B&O protocol with 38 kHz +#if defined(USE_NO_SEND_PWM) || defined(SEND_PWM_BY_TIMER) || BEO_KHZ == 38 // BEO_KHZ == 38 is for unit test which runs the B&O protocol with 38 kHz /* - * 455 kHz PWM is currently not supported, maximum is 180 kHz + * 455 kHz PWM is currently only supported with SEND_PWM_BY_TIMER defined, otherwise maximum is 180 kHz */ -#if !defined(USE_NO_SEND_PWM) - enableIROut (BEO_KHZ); -#endif +# if !defined(USE_NO_SEND_PWM) +# if defined(SEND_PWM_BY_TIMER) + enableHighFrequencyIROut (BEO_KHZ); +# elif (BEO_KHZ == 38) + enableIROut (BEO_KHZ); // currently only for unit test +# endif +# endif // AGC / Start - 3 bits + first constant 0 header bit described in the official documentation if (!aBackToBack) { @@ -284,9 +292,9 @@ static bool matchBeoLength(uint16_t aMeasuredTicks, uint16_t aMatchValueMicros) bool IRrecv::decodeBangOlufsen() { #if defined(ENABLE_BEO_WITHOUT_FRAME_GAP) - if (decodedIRData.rawDataPtr->rawlen != 6 && decodedIRData.rawDataPtr->rawlen < 36) { // 16 bits minimum + if (decodedIRData.rawlen != 6 && decodedIRData.rawlen < 36) { // 16 bits minimum #else - if (decodedIRData.rawDataPtr->rawlen < 44) { // 16 bits minimum + if (decodedIRData.rawlen < 44) { // 16 bits minimum #endif return false; } @@ -302,21 +310,21 @@ bool IRrecv::decodeBangOlufsen() { uint8_t tBitNumber = 0; BEO_TRACE_PRINT(F("Pre gap: ")); - BEO_TRACE_PRINT(decodedIRData.rawDataPtr->rawbuf[0] * 50); + BEO_TRACE_PRINT(decodedIRData.initialGapTicks * 50); BEO_TRACE_PRINT(F(" raw len: ")); - BEO_TRACE_PRINTLN(decodedIRData.rawDataPtr->rawlen); + BEO_TRACE_PRINTLN(decodedIRData.rawlen); #if defined(ENABLE_BEO_WITHOUT_FRAME_GAP) /* - * Check if we have the AGC part of the first frame in a row + * Check if we have the AGC part of the first frame, i.e. start bit 1 and 2. */ - if (decodedIRData.rawDataPtr->rawlen == 6) { + if (decodedIRData.rawlen == 6) { if ((matchMark(decodedIRData.rawDataPtr->rawbuf[3], BEO_IR_MARK) || matchMark(decodedIRData.rawDataPtr->rawbuf[3], BEO_DATALINK_MARK)) && (matchSpace(decodedIRData.rawDataPtr->rawbuf[4], BEO_PULSE_LENGTH_ZERO - BEO_IR_MARK) || matchSpace(decodedIRData.rawDataPtr->rawbuf[4], BEO_PULSE_LENGTH_ZERO - BEO_DATALINK_MARK))) { BEO_TRACE_PRINT(::getProtocolString(BANG_OLUFSEN)); - BEO_TRACE_PRINTLN(F("B&O: AGC only part detected")); + BEO_TRACE_PRINTLN(F("B&O: AGC only part (start bits 1 + 2 of 4) detected")); } else { return false; // no B&O protocol } @@ -324,18 +332,18 @@ bool IRrecv::decodeBangOlufsen() { /* * Check if leading gap is trailing bit of first frame */ - if (!matchSpace(decodedIRData.rawDataPtr->rawbuf[0], BEO_PULSE_LENGTH_START_BIT)) { + if (!matchSpace(decodedIRData.initialGapTicks, BEO_PULSE_LENGTH_START_BIT)) { BEO_TRACE_PRINT(::getProtocolString(BANG_OLUFSEN)); BEO_TRACE_PRINTLN(F(": Leading gap is wrong")); // Leading gap is trailing bit of first frame return false; // no B&O protocol } if (matchMark(decodedIRData.rawDataPtr->rawbuf[1], BEO_IR_MARK)) { -#if defined(SUPPORT_BEO_DATALINK_TIMING_FOR_DECODE) +# if defined(SUPPORT_BEO_DATALINK_TIMING_FOR_DECODE) protocolMarkLength = BEO_IR_MARK; } else if (matchMark(decodedIRData.rawDataPtr->rawbuf[1], BEO_DATALINK_MARK)) { protocolMarkLength = BEO_DATALINK_MARK; -#endif +# endif } else { BEO_TRACE_PRINT(::getProtocolString(BANG_OLUFSEN)); BEO_TRACE_PRINTLN(F(": mark length is wrong")); @@ -343,10 +351,10 @@ bool IRrecv::decodeBangOlufsen() { } // skip first zero header bit - for (uint8_t tRawBufferMarkIndex = 3; tRawBufferMarkIndex < decodedIRData.rawDataPtr->rawlen; tRawBufferMarkIndex += 2) { + for (uint8_t tRawBufferMarkIndex = 3; tRawBufferMarkIndex < decodedIRData.rawlen; tRawBufferMarkIndex += 2) { #else - for (uint8_t tRawBufferMarkIndex = 1; tRawBufferMarkIndex < decodedIRData.rawDataPtr->rawlen; tRawBufferMarkIndex += 2) { -#endif + for (uint8_t tRawBufferMarkIndex = 1; tRawBufferMarkIndex < decodedIRData.rawlen; tRawBufferMarkIndex += 2) { +#endif // defined(ENABLE_BEO_WITHOUT_FRAME_GAP) uint16_t markLength = decodedIRData.rawDataPtr->rawbuf[tRawBufferMarkIndex]; uint16_t spaceLength = decodedIRData.rawDataPtr->rawbuf[tRawBufferMarkIndex + 1]; @@ -375,11 +383,11 @@ bool IRrecv::decodeBangOlufsen() { } else { if (tPulseNumber == 3) { if (matchMark(markLength, BEO_IR_MARK)) { -#if defined(SUPPORT_BEO_DATALINK_TIMING_FOR_DECODE) +# if defined(SUPPORT_BEO_DATALINK_TIMING_FOR_DECODE) protocolMarkLength = BEO_IR_MARK; } else if (matchMark(markLength, BEO_DATALINK_MARK)) { protocolMarkLength = BEO_DATALINK_MARK; -#endif +# endif } else { BEO_DEBUG_PRINT(::getProtocolString(BANG_OLUFSEN)); BEO_DEBUG_PRINTLN(F(": 4. (start) mark length is wrong")); @@ -395,7 +403,7 @@ bool IRrecv::decodeBangOlufsen() { } } } else { -#endif +#endif // !defined(ENABLE_BEO_WITHOUT_FRAME_GAP) /* * Decode header / data @@ -421,7 +429,7 @@ bool IRrecv::decodeBangOlufsen() { break; } #if !defined(ENABLE_BEO_WITHOUT_FRAME_GAP) - if (tRawBufferMarkIndex >= decodedIRData.rawDataPtr->rawlen - 3) { // (rawlen - 3) is index of trailing bit mark + if (tRawBufferMarkIndex >= decodedIRData.rawlen - 3) { // (rawlen - 3) is index of trailing bit mark BEO_DEBUG_PRINT(::getProtocolString(BANG_OLUFSEN)); BEO_DEBUG_PRINTLN(F(": End of buffer, but no trailing bit detected")); return false; @@ -462,7 +470,7 @@ bool IRrecv::decodeBangOlufsen() { /* * Check for last bit after decoding it */ - if (tRawBufferMarkIndex >= decodedIRData.rawDataPtr->rawlen - 3) { // (rawlen - 3) is index of last bit mark + if (tRawBufferMarkIndex >= decodedIRData.rawlen - 3) { // (rawlen - 3) is index of last bit mark BEO_TRACE_PRINT(::getProtocolString(BANG_OLUFSEN)); BEO_TRACE_PRINTLN(F(": Last bit reached")); break; diff --git a/src/ir_BoseWave.hpp b/src/ir_BoseWave.hpp index bac9dcce9..336d886f0 100644 --- a/src/ir_BoseWave.hpp +++ b/src/ir_BoseWave.hpp @@ -9,7 +9,7 @@ #ifndef _IR_BOSEWAVE_HPP #define _IR_BOSEWAVE_HPP -#if defined(DEBUG) && !defined(LOCAL_DEBUG) +#if defined(DEBUG) #define LOCAL_DEBUG #else //#define LOCAL_DEBUG // This enables debug output only for this file @@ -30,10 +30,10 @@ // // Support for Bose Wave Radio CD initially provided by https://github.com/uvotguy. // -// As seen on my trusty oscilloscope, there is no repeat code. Instead, when I +// As seen on my oscilloscope, there is no repeat code. Instead, when I // press and hold a button on my remote, it sends a command, makes a 51.2ms space, -// and resends the command, etc, etc. -// LSB first, 1 start bit + 8 bit data + 8 bit inverted data + 1 stop bit. +// and resends the command again, and so on. +// 38 kHz, LSB first, 1 start bit + 8 bit data + 8 bit inverted data + 1 stop bit. #define BOSEWAVE_BITS 16 // Command and inverted command #define BOSEWAVE_HEADER_MARK 1014 // 1014 are 39 clock periods (I counted 3 times!) @@ -46,9 +46,9 @@ #define BOSEWAVE_REPEAT_DISTANCE 50000 #define BOSEWAVE_MAXIMUM_REPEAT_DISTANCE 62000 -struct PulseDistanceWidthProtocolConstants BoseWaveProtocolConstants = { BOSEWAVE, BOSEWAVE_KHZ, BOSEWAVE_HEADER_MARK, -BOSEWAVE_HEADER_SPACE, BOSEWAVE_BIT_MARK, BOSEWAVE_ONE_SPACE, BOSEWAVE_BIT_MARK, BOSEWAVE_ZERO_SPACE, PROTOCOL_IS_LSB_FIRST - , (BOSEWAVE_REPEAT_PERIOD / MICROS_IN_ONE_MILLI), NULL }; +struct PulseDistanceWidthProtocolConstants const BoseWaveProtocolConstants PROGMEM = {BOSEWAVE, BOSEWAVE_KHZ, BOSEWAVE_HEADER_MARK, + BOSEWAVE_HEADER_SPACE, BOSEWAVE_BIT_MARK, BOSEWAVE_ONE_SPACE, BOSEWAVE_BIT_MARK, BOSEWAVE_ZERO_SPACE, PROTOCOL_IS_LSB_FIRST + , (BOSEWAVE_REPEAT_PERIOD / MICROS_IN_ONE_MILLI), nullptr}; /************************************ * Start of send and decode functions @@ -58,25 +58,25 @@ void IRsend::sendBoseWave(uint8_t aCommand, int_fast8_t aNumberOfRepeats) { // send 8 command bits and then 8 inverted command bits LSB first uint16_t tData = ((~aCommand) << 8) | aCommand; - sendPulseDistanceWidth(&BoseWaveProtocolConstants, tData, BOSEWAVE_BITS, aNumberOfRepeats); + sendPulseDistanceWidth_P(&BoseWaveProtocolConstants, tData, BOSEWAVE_BITS, aNumberOfRepeats); } bool IRrecv::decodeBoseWave() { - if (!checkHeader(&BoseWaveProtocolConstants)) { + if (!checkHeader_P(&BoseWaveProtocolConstants)) { return false; } // Check we have enough data +4 for initial gap, start bit mark and space + stop bit mark - if (decodedIRData.rawDataPtr->rawlen != (2 * BOSEWAVE_BITS) + 4) { + if (decodedIRData.rawlen != (2 * BOSEWAVE_BITS) + 4) { IR_DEBUG_PRINT(F("Bose: ")); IR_DEBUG_PRINT(F("Data length=")); - IR_DEBUG_PRINT(decodedIRData.rawDataPtr->rawlen); + IR_DEBUG_PRINT(decodedIRData.rawlen); IR_DEBUG_PRINTLN(F(" is not 36")); return false; } - if (!decodePulseDistanceWidthData(&BoseWaveProtocolConstants, BOSEWAVE_BITS)) { + if (!decodePulseDistanceWidthData_P(&BoseWaveProtocolConstants, BOSEWAVE_BITS)) { #if defined(LOCAL_DEBUG) Serial.print(F("Bose: ")); Serial.println(F("Decode failed")); diff --git a/src/ir_Denon.hpp b/src/ir_Denon.hpp index bfb48a6df..bfbe45caa 100644 --- a/src/ir_Denon.hpp +++ b/src/ir_Denon.hpp @@ -32,7 +32,7 @@ #ifndef _IR_DENON_HPP #define _IR_DENON_HPP -#if defined(DEBUG) && !defined(LOCAL_DEBUG) +#if defined(DEBUG) #define LOCAL_DEBUG #else //#define LOCAL_DEBUG // This enables debug output only for this file @@ -82,7 +82,7 @@ * 000A 0046 000A 0046 000A 001E 000A 001E 000A 001E 000A 0046 000A 001E 000A 001E // 8 inverted command bits * 000A 0046 000A 0046 000A 0679 // 2 frame bits 1,1 + stop bit + space for Repeat * From analyzing the codes for Tuner preset 1 to 8 in tab Main Zone ID#1 it is obvious, that the protocol is LSB first at least for command. - * All Denon codes with 32 as 3. value use the Kaseyikyo Denon variant. + * All Denon codes with 32 as 3. value use the Kaseikyo Denon variant. */ // LSB first, no start bit, 5 address + 8 command + 2 frame (0,0) + 1 stop bit - each frame 2 times // Every frame is auto repeated with a space period of 45 ms and the command and frame inverted to (1,1) or (0,1) for SHARP. @@ -105,27 +105,38 @@ #define DENON_HEADER_MARK DENON_UNIT // The length of the Header:Mark #define DENON_HEADER_SPACE (3 * DENON_UNIT) // 780 // The length of the Header:Space -struct PulseDistanceWidthProtocolConstants DenonProtocolConstants = { DENON, DENON_KHZ, DENON_HEADER_MARK, DENON_HEADER_SPACE, -DENON_BIT_MARK, DENON_ONE_SPACE, DENON_BIT_MARK, DENON_ZERO_SPACE, PROTOCOL_IS_LSB_FIRST, - (DENON_REPEAT_PERIOD / MICROS_IN_ONE_MILLI), NULL }; +struct PulseDistanceWidthProtocolConstants const DenonProtocolConstants PROGMEM = {DENON, DENON_KHZ, DENON_HEADER_MARK, DENON_HEADER_SPACE, + DENON_BIT_MARK, DENON_ONE_SPACE, DENON_BIT_MARK, DENON_ZERO_SPACE, PROTOCOL_IS_LSB_FIRST, + (DENON_REPEAT_PERIOD / MICROS_IN_ONE_MILLI), nullptr}; /************************************ * Start of send and decode functions ************************************/ void IRsend::sendSharp(uint8_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats) { - sendDenon(aAddress, aCommand, aNumberOfRepeats, true); + sendDenon(aAddress, aCommand, aNumberOfRepeats, 1); + // see https://github.com/Arduino-IRremote/Arduino-IRremote/issues/1272 } -void IRsend::sendDenon(uint8_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats, bool aSendSharp) { +void IRsend::sendSharp2(uint8_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats) { + sendDenon(aAddress, aCommand, aNumberOfRepeats, 2); +} + +/* + * Denon frames are always sent 3 times. A non inverted (normal), an inverted frame, ending with a normal frame. + * Repeats are done by just adding an inverted and a normal frame with no extra delay, so it is quite responsible :-) + * If you specify a repeat of e.g. 3, then 3 + 6 frames are sent. + * Measured at Denon RC 1081. + */ +void IRsend::sendDenon(uint8_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats, uint8_t aSendSharpFrameMarker) { // Set IR carrier frequency enableIROut (DENON_KHZ); // 38 kHz // Add frame marker for sharp uint16_t tCommand = aCommand; - if (aSendSharp) { - tCommand |= 0x0200; // the 2 upper bits are 00 for Denon and 10 for Sharp - } + // see https://github.com/Arduino-IRremote/Arduino-IRremote/issues/1272 + tCommand |= aSendSharpFrameMarker << 8; // the 2 upper bits are 00 for Denon and 01 or 10 for Sharp + uint16_t tData = aAddress | ((uint16_t) tCommand << DENON_ADDRESS_BITS); uint16_t tInvertedData = (tData ^ 0x7FE0); // Command and frame (upper 10 bits) are inverted @@ -133,19 +144,22 @@ void IRsend::sendDenon(uint8_t aAddress, uint8_t aCommand, int_fast8_t aNumberOf while (tNumberOfCommands > 0) { // Data - sendPulseDistanceWidthData(&DenonProtocolConstants, tData, DENON_BITS); + sendPulseDistanceWidthData_P(&DenonProtocolConstants, tData, DENON_BITS); // Inverted autorepeat frame delay(DENON_AUTO_REPEAT_DISTANCE / MICROS_IN_ONE_MILLI); - sendPulseDistanceWidthData(&DenonProtocolConstants, tInvertedData, DENON_BITS); + sendPulseDistanceWidthData_P(&DenonProtocolConstants, tInvertedData, DENON_BITS); tNumberOfCommands--; - // skip last delay! - if (tNumberOfCommands > 0) { - // send repeated command with a fixed space gap - delay( DENON_AUTO_REPEAT_DISTANCE / MICROS_IN_ONE_MILLI); - } + // send repeated command with a fixed space gap + delay( DENON_AUTO_REPEAT_DISTANCE / MICROS_IN_ONE_MILLI); } + /* + * always end with a normal frame + * skip last delay! + */ + sendPulseDistanceWidthData_P(&DenonProtocolConstants, tData, DENON_BITS); + } bool IRrecv::decodeSharp() { @@ -156,16 +170,16 @@ bool IRrecv::decodeDenon() { // we have no start bit, so check for the exact amount of data bits // Check we have the right amount of data (32). The + 2 is for initial gap + stop bit mark - if (decodedIRData.rawDataPtr->rawlen != (2 * DENON_BITS) + 2) { + if (decodedIRData.rawlen != (2 * DENON_BITS) + 2) { IR_DEBUG_PRINT(F("Denon: ")); IR_DEBUG_PRINT(F("Data length=")); - IR_DEBUG_PRINT(decodedIRData.rawDataPtr->rawlen); + IR_DEBUG_PRINT(decodedIRData.rawlen); IR_DEBUG_PRINTLN(F(" is not 32")); return false; } // Try to decode as Denon protocol - if (!decodePulseDistanceWidthData(&DenonProtocolConstants, DENON_BITS, 1)) { + if (!decodePulseDistanceWidthData_P(&DenonProtocolConstants, DENON_BITS, 1)) { #if defined(LOCAL_DEBUG) Serial.print(F("Denon: ")); Serial.println(F("Decode failed")); @@ -189,7 +203,7 @@ bool IRrecv::decodeDenon() { decodedIRData.command &= 0xFF; // Check for (auto) repeat - if (decodedIRData.rawDataPtr->rawbuf[0] < ((DENON_AUTO_REPEAT_DISTANCE + (DENON_AUTO_REPEAT_DISTANCE / 4)) / MICROS_PER_TICK)) { + if (decodedIRData.initialGapTicks < ((DENON_AUTO_REPEAT_DISTANCE + (DENON_AUTO_REPEAT_DISTANCE / 4)) / MICROS_PER_TICK)) { repeatCount++; if (repeatCount > 1) { // skip first auto repeat decodedIRData.flags = IRDATA_FLAGS_IS_REPEAT; @@ -200,8 +214,8 @@ bool IRrecv::decodeDenon() { * Here we are in the auto repeated frame with the inverted command */ #if defined(LOCAL_DEBUG) - Serial.print(F("Denon: ")); - Serial.println(F("Autorepeat received=")); + Serial.print(F("Denon: ")); + Serial.println(F("Autorepeat received=")); #endif decodedIRData.flags |= IRDATA_FLAGS_IS_AUTO_REPEAT; // Check parity of consecutive received commands. There is no parity in one data set. @@ -274,13 +288,13 @@ void IRsend::sendDenon(unsigned long data, int nbits) { * Old function without parameter aNumberOfRepeats */ void IRsend::sendSharp(uint16_t aAddress, uint16_t aCommand) { - sendDenon(aAddress, aCommand, true, 0); + sendDenon(aAddress, aCommand, 0, true); } bool IRrecv::decodeDenonOld(decode_results *aResults) { // Check we have the right amount of data - if (decodedIRData.rawDataPtr->rawlen != 1 + 2 + (2 * DENON_BITS) + 1) { + if (decodedIRData.rawlen != 1 + 2 + (2 * DENON_BITS) + 1) { return false; } @@ -293,8 +307,8 @@ bool IRrecv::decodeDenonOld(decode_results *aResults) { return false; } - // Try to decode as Denon protocol - if (!decodePulseDistanceWidthData(DENON_BITS, 3, DENON_BIT_MARK, 0, DENON_ONE_SPACE, DENON_ZERO_SPACE, PROTOCOL_IS_MSB_FIRST)) { + // Try to decode as Denon protocol. + if (!decodePulseDistanceWidthData(DENON_BITS, 3, DENON_BIT_MARK, DENON_ONE_SPACE, 0, PROTOCOL_IS_MSB_FIRST)) { return false; } diff --git a/src/ir_DistanceWidthProtocol.hpp b/src/ir_DistanceWidthProtocol.hpp index 0908f1544..bea846768 100644 --- a/src/ir_DistanceWidthProtocol.hpp +++ b/src/ir_DistanceWidthProtocol.hpp @@ -2,7 +2,10 @@ * ir_DistanceWidthProtocol.hpp * * Contains only the decoder functions for universal pulse width or pulse distance protocols! - * The send functions are used by almost all protocols and therefore in IRSend.hh. + * The send functions are used by almost all protocols and are therefore located in IRSend.hpp. + * + * If RAM is not more than 2k, the decoder only accepts mark or space durations up to 50 * 50 (MICROS_PER_TICK) = 2500 microseconds + * to save RAM space, otherwise it accepts durations up to 10 ms. * * This decoder tries to decode a pulse distance or pulse distance width with constant period (or pulse width - not enabled yet) protocol. * 1. Analyze all space and mark length @@ -23,15 +26,15 @@ * https://github.com/Arduino-IRremote/Arduino-IRremote/blob/d51b540cb2ddf1424888d2d9e6b62fe1ef46859d/examples/SendDemo/SendDemo.ino#L175 * sendPulseDistanceWidthFromArray(uint_fast8_t aFrequencyKHz, unsigned int aHeaderMarkMicros, * unsigned int aHeaderSpaceMicros, unsigned int aOneMarkMicros, unsigned int aOneSpaceMicros, unsigned int aZeroMarkMicros, - * unsigned int aZeroSpaceMicros, uint32_t *aDecodedRawDataArray, unsigned int aNumberOfBits, bool aMSBFirst, - * bool aSendStopBit, unsigned int aRepeatPeriodMillis, int_fast8_t aNumberOfRepeats) + * unsigned int aZeroSpaceMicros, uint32_t *aDecodedRawDataArray, unsigned int aNumberOfBits, uint8_t aFlags, + * unsigned int aRepeatPeriodMillis, int_fast8_t aNumberOfRepeats) * * This file is part of Arduino-IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. * ************************************************************************************ * MIT License * - * Copyright (c) 2022-2023 Armin Joachimsmeyer + * Copyright (c) 2022-2024 Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -59,14 +62,19 @@ #define DISTANCE_WIDTH_MAXIMUM_REPEAT_DISTANCE_MICROS 100000 // 100 ms, bit it is just a guess #endif -#if defined(DEBUG) && !defined(LOCAL_DEBUG) +#if defined(DEBUG) #define LOCAL_DEBUG #else //#define LOCAL_DEBUG // This enables debug output only for this file #endif -// accept durations up to 50 * 50 (MICROS_PER_TICK) 2500 microseconds -#define DURATION_ARRAY_SIZE 50 +#if !defined(DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE) +# if (defined(RAMEND) && RAMEND <= 0x8FF) || (defined(RAMSIZE) && RAMSIZE < 0x8FF) +#define DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE 50 // To save program space, the decoder only accepts mark or space durations up to 50 * 50 (MICROS_PER_TICK) = 2500 microseconds +# else +#define DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE 200 // The decoder accepts mark or space durations up to 200 * 50 (MICROS_PER_TICK) = 10 milliseconds +# endif +#endif // Switch the decoding according to your needs //#define USE_MSB_DECODING_FOR_DISTANCE_DECODER // If active, it resembles LG, otherwise LSB first as most other protocols e.g. NEC and Kaseikyo/Panasonic @@ -82,6 +90,34 @@ // DDD III SSSS TT A A N N CCC EEEE W W III DDD TT H H //===================================================================================== // see: https://www.mikrocontroller.net/articles/IRMP_-_english#Codings +/* + Example output of UnitTest.ino for PulseWidth protocol: + Protocol=PulseWidth Raw-Data=0x87654321 32 bits LSB first + Send on a 8 bit platform with: IrSender.sendPulseDistanceWidth(38, 950, 550, 600, 300, 300, 300, 0x87654321, 32, PROTOCOL_IS_LSB_FIRST, , ); + rawData[66]: + -1088600 + + 950,- 550 + + 600,- 300 + 300,- 300 + 350,- 250 + 350,- 250 + + 350,- 300 + 600,- 300 + 300,- 300 + 300,- 300 + + 650,- 250 + 650,- 250 + 300,- 300 + 350,- 250 + + 350,- 300 + 300,- 300 + 600,- 300 + 300,- 300 + + 600,- 300 + 350,- 250 + 600,- 300 + 350,- 250 + + 350,- 300 + 600,- 300 + 600,- 300 + 300,- 300 + + 600,- 300 + 600,- 300 + 600,- 300 + 300,- 300 + + 300,- 300 + 300,- 300 + 350,- 250 + 650 + Sum: 24500 + + Example output of UnitTest.ino for PulseDistanceWidth protocol: + Protocol=PulseDistance Raw-Data=0x76 7 bits LSB first + Send on a 8 bit platform with: IrSender.sendPulseDistanceWidth(38, 5950, 500, 550, 1450, 1550, 500, 0x76, 7, PROTOCOL_IS_LSB_FIRST, , ); + rawData[18]: + -1092450 + +5950,- 500 + +1500,- 500 + 500,-1450 + 550,-1450 +1550,- 450 + + 550,-1450 + 550,-1450 + 550,-1450 + 550 + Sum: 20950 + */ + #if defined(LOCAL_DEBUG) void printDurations(uint8_t aArray[], uint8_t aMaxIndex) { for (uint_fast8_t i = 0; i <= aMaxIndex; i++) { @@ -108,11 +144,13 @@ void printDurations(uint8_t aArray[], uint8_t aMaxIndex) { #endif /* + * We count all consecutive (allow only one gap between) durations and compute the average. * @return false if more than 2 distinct duration values found */ bool aggregateArrayCounts(uint8_t aArray[], uint8_t aMaxIndex, uint8_t *aShortIndex, uint8_t *aLongIndex) { uint8_t tSum = 0; uint16_t tWeightedSum = 0; + uint8_t tGapCount = 0; for (uint_fast8_t i = 0; i <= aMaxIndex; i++) { uint8_t tCurrentDurations = aArray[i]; if (tCurrentDurations != 0) { @@ -120,9 +158,14 @@ bool aggregateArrayCounts(uint8_t aArray[], uint8_t aMaxIndex, uint8_t *aShortIn tSum += tCurrentDurations; tWeightedSum += (tCurrentDurations * i); aArray[i] = 0; + tGapCount = 0; + } else { + tGapCount++; } - if ((tCurrentDurations == 0 || i == aMaxIndex) && tSum != 0) { - // here we have a sum and a gap after the values + if (tSum != 0 && (i == aMaxIndex || tGapCount > 1)) { + /* + * Here we have a sum AND last element OR more than 1 consecutive gap + */ uint8_t tAggregateIndex = (tWeightedSum + (tSum / 2)) / tSum; // with rounding aArray[tAggregateIndex] = tSum; // disabling this line increases code size by 2 - unbelievable! // store aggregate for later decoding @@ -148,34 +191,38 @@ bool aggregateArrayCounts(uint8_t aArray[], uint8_t aMaxIndex, uint8_t *aShortIn * 2. Decide if we have an pulse width or distance protocol * 3. Try to decode with the mark and space data found in step 1 * No data and address decoding, only raw data as result. + * + * calloc() version is 700 bytes larger :-( */ bool IRrecv::decodeDistanceWidth() { - uint8_t tDurationArray[DURATION_ARRAY_SIZE]; // For up to 49 ticks / 2450 us + /* + * Array for up to 49 ticks / 2500 us (or 199 ticks / 10 ms us if RAM > 2k) + * 0 tick covers mark or space durations from 0 to 49 us, and 49 ticks from 2450 to 2499 us + */ + uint8_t tDurationArray[DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE]; /* - * Accept only protocols with at least 8 bits + * Accept only protocols with at least 7 bits */ - if (decodedIRData.rawDataPtr->rawlen < (2 * 8) + 4) { + if (decodedIRData.rawlen < (2 * 7) + 4) { IR_DEBUG_PRINT(F("PULSE_DISTANCE_WIDTH: ")); IR_DEBUG_PRINT(F("Data length=")); - IR_DEBUG_PRINT(decodedIRData.rawDataPtr->rawlen); - IR_DEBUG_PRINTLN(F(" is less than 20")); + IR_DEBUG_PRINT(decodedIRData.rawlen); + IR_DEBUG_PRINTLN(F(" is less than 18")); return false; } - uint_fast8_t i; - // Reset duration array - memset(tDurationArray, 0, DURATION_ARRAY_SIZE); + memset(tDurationArray, 0, DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE); uint8_t tIndexOfMaxDuration = 0; /* - * Count number of mark durations up to 49 ticks. Skip leading start and trailing stop bit. + * Count number of mark durations. Skip leading start and trailing stop bit. */ - for (i = 3; i < (uint_fast8_t) decodedIRData.rawDataPtr->rawlen - 2; i += 2) { + for (IRRawlenType i = 3; i < decodedIRData.rawlen - 2; i += 2) { auto tDurationTicks = decodedIRData.rawDataPtr->rawbuf[i]; - if (tDurationTicks < DURATION_ARRAY_SIZE) { - tDurationArray[tDurationTicks]++; // count duration if less than DURATION_ARRAY_SIZE (50) + if (tDurationTicks < DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE) { + tDurationArray[tDurationTicks]++; // count duration if less than DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE if (tIndexOfMaxDuration < tDurationTicks) { tIndexOfMaxDuration = tDurationTicks; } @@ -185,7 +232,7 @@ bool IRrecv::decodeDistanceWidth() { Serial.print(F("Mark ")); Serial.print(tDurationTicks * MICROS_PER_TICK); Serial.print(F(" is longer than maximum ")); - Serial.print(DURATION_ARRAY_SIZE * MICROS_PER_TICK); + Serial.print(DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE * MICROS_PER_TICK); Serial.print(F(" us. Index=")); Serial.println(i); #endif @@ -213,15 +260,15 @@ bool IRrecv::decodeDistanceWidth() { } // Reset duration array - memset(tDurationArray, 0, DURATION_ARRAY_SIZE); + memset(tDurationArray, 0, DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE); /* * Count number of space durations. Skip leading start and trailing stop bit. */ tIndexOfMaxDuration = 0; - for (i = 4; i < (uint_fast8_t) decodedIRData.rawDataPtr->rawlen - 2; i += 2) { + for (IRRawlenType i = 4; i < decodedIRData.rawlen - 2; i += 2) { auto tDurationTicks = decodedIRData.rawDataPtr->rawbuf[i]; - if (tDurationTicks < DURATION_ARRAY_SIZE) { + if (tDurationTicks < DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE) { tDurationArray[tDurationTicks]++; if (tIndexOfMaxDuration < tDurationTicks) { tIndexOfMaxDuration = tDurationTicks; @@ -231,8 +278,8 @@ bool IRrecv::decodeDistanceWidth() { Serial.print(F("PULSE_DISTANCE_WIDTH: ")); Serial.print(F("Space ")); Serial.print(tDurationTicks * MICROS_PER_TICK); - Serial.print(F(" is longer than ")); - Serial.print(DURATION_ARRAY_SIZE * MICROS_PER_TICK); + Serial.print(F(" is longer than maximum ")); + Serial.print(DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE * MICROS_PER_TICK); Serial.print(F(" us. Index=")); Serial.println(i); #endif @@ -260,7 +307,7 @@ bool IRrecv::decodeDistanceWidth() { } /* - * Print characteristics of this protocol. Durations are in ticks. + * Print characteristics of this protocol. Durations are in (50 us) ticks. * Number of bits, start bit, start pause, long mark, long space, short mark, short space * * NEC: 32, 180, 90, 0, 34, 11, 11 @@ -269,6 +316,8 @@ bool IRrecv::decodeDistanceWidth() { * JVC: 16, 168, 84, 0, 32, 10, 10 * Kaseikyo: 48. 69, 35, 0, 26, 9, 9 * Sony: 12|15|20, 48, 12, 24, 0, 12, 12 // the only known pulse width protocol + * Disney monorail + * model: 7, 120, 10, 30, 30, 10, 10 // PulseDistanceWidth. Can be seen as direct conversion of a 7 bit serial timing at 250 baud with a 6 ms start bit. */ #if defined(LOCAL_DEBUG) Serial.print(F("DistanceWidthTimingInfoStruct: ")); @@ -284,11 +333,14 @@ bool IRrecv::decodeDistanceWidth() { Serial.print(F(", ")); Serial.println(tSpaceTicksShort * MICROS_PER_TICK); #endif - uint8_t tStartIndex = 3; - // skip leading start bit for decoding. - uint16_t tNumberOfBits = (decodedIRData.rawDataPtr->rawlen / 2) - 1; - if (tSpaceTicksLong > 0 && tMarkTicksLong == 0) { - // For PULSE_DISTANCE a stop bit is mandatory, for PULSE_WIDTH it is not required! +#if RAW_BUFFER_LENGTH <= (512 -4) + uint_fast8_t tNumberOfBits; +#else + uint16_t tNumberOfBits; +#endif + tNumberOfBits = (decodedIRData.rawlen / 2) - 1; + if (tSpaceTicksLong > 0) { + // For PULSE_DISTANCE -including PULSE_DISTANCE_WIDTH- a stop bit is mandatory, for PULSE_WIDTH it is not required! tNumberOfBits--; // Correct for stop bit } decodedIRData.numberOfBits = tNumberOfBits; @@ -296,10 +348,9 @@ bool IRrecv::decodeDistanceWidth() { /* * We can have the following protocol timings - * Pulse distance: Pulses/marks are constant, pause/spaces have different length, like NEC. - * Pulse width: Pulses/marks have different length, pause/spaces are constant, like Sony. - * Pulse distance width: Pulses/marks and pause/spaces have different length, often the bit length is constant, like MagiQuest. - * Pulse distance width can be decoded by pulse width decoder, if this decoder does not check the length of pause/spaces. + * PULSE_DISTANCE: Pause/spaces have different length and determine the bit value, longer space is 1. Pulses/marks can be constant, like NEC. + * PULSE_WIDTH: Pulses/marks have different length and determine the bit value, longer mark is 1. Pause/spaces can be constant, like Sony. + * PULSE_DISTANCE_WIDTH: Pulses/marks and pause/spaces have different length, often the bit length is constant, like MagiQuest. Can be decoded by PULSE_DISTANCE decoder. */ if (tMarkTicksLong == 0 && tSpaceTicksLong == 0) { @@ -320,6 +371,7 @@ bool IRrecv::decodeDistanceWidth() { unsigned int tMarkMicrosShort = tMarkTicksShort * MICROS_PER_TICK; unsigned int tMarkMicrosLong = tMarkTicksLong * MICROS_PER_TICK; unsigned int tSpaceMicrosLong = tSpaceTicksLong * MICROS_PER_TICK; + IRRawlenType tStartIndex = 3; // skip leading start bit for decoding. for (uint_fast8_t i = 0; i <= tNumberOfAdditionalArrayValues; ++i) { uint8_t tNumberOfBitsForOneDecode = tNumberOfBits; @@ -330,13 +382,14 @@ bool IRrecv::decodeDistanceWidth() { tNumberOfBitsForOneDecode = BITS_IN_RAW_DATA_TYPE; } bool tResult; - if (tMarkTicksLong > 0) { + if (tSpaceTicksLong > 0) { /* - * Here short and long mark durations found. + * Here short and long space durations found. + * Since parameters aOneMarkMicros and aOneSpaceMicros are equal, we only check tSpaceMicrosLong here. */ - decodedIRData.protocol = PULSE_WIDTH; - tResult = decodePulseDistanceWidthData(tNumberOfBitsForOneDecode, tStartIndex, tMarkMicrosLong, tMarkMicrosShort, - tSpaceMicrosShort, 0, + decodedIRData.protocol = PULSE_DISTANCE; // Sony + PULSE_DISTANCE_WIDTH + tResult = decodePulseDistanceWidthData(tNumberOfBitsForOneDecode, tStartIndex, tMarkMicrosShort, tSpaceMicrosLong, + tMarkMicrosShort, #if defined(USE_MSB_DECODING_FOR_DISTANCE_DECODER) true #else @@ -345,17 +398,19 @@ bool IRrecv::decodeDistanceWidth() { ); } else { /* - * Here short and long space durations found. + * Here no long space duration found. => short and long mark durations found, check tMarkMicrosLong here + * This else case will most likely never be used, but it only requires 12 bytes additional programming space :-) */ - decodedIRData.protocol = PULSE_DISTANCE; - tResult = decodePulseDistanceWidthData(tNumberOfBitsForOneDecode, tStartIndex, tMarkMicrosShort, tMarkMicrosShort, - tSpaceMicrosLong, tSpaceMicrosShort, + decodedIRData.protocol = PULSE_WIDTH; // NEC etc. + tResult = decodePulseDistanceWidthData(tNumberOfBitsForOneDecode, tStartIndex, tMarkMicrosLong, tSpaceMicrosShort, + tMarkMicrosShort, #if defined(USE_MSB_DECODING_FOR_DISTANCE_DECODER) true #else false #endif ); + } if (!tResult) { #if defined(LOCAL_DEBUG) @@ -379,8 +434,12 @@ bool IRrecv::decodeDistanceWidth() { decodedIRData.flags = IRDATA_FLAGS_IS_MSB_FIRST; #endif - // Check for repeat - checkForRepeatSpaceTicksAndSetFlag(DISTANCE_WIDTH_MAXIMUM_REPEAT_DISTANCE_MICROS / MICROS_PER_TICK); + // Check for repeat. Check also for equality of last DecodedRawData. + if (decodedIRData.initialGapTicks < DISTANCE_WIDTH_MAXIMUM_REPEAT_DISTANCE_MICROS / MICROS_PER_TICK + && decodedIRData.decodedRawDataArray[tNumberOfAdditionalArrayValues] == lastDecodedRawData) { + decodedIRData.flags |= IRDATA_FLAGS_IS_REPEAT; + } + lastDecodedRawData = decodedIRData.decodedRawData; /* * Store timing data to reproduce frame for sending @@ -390,17 +449,25 @@ bool IRrecv::decodeDistanceWidth() { decodedIRData.DistanceWidthTimingInfo.ZeroMarkMicros = tMarkMicrosShort; decodedIRData.DistanceWidthTimingInfo.ZeroSpaceMicros = tSpaceMicrosShort; if (tMarkMicrosLong != 0) { - decodedIRData.DistanceWidthTimingInfo.OneMarkMicros = tMarkMicrosLong; - - decodedIRData.DistanceWidthTimingInfo.OneSpaceMicros = tSpaceMicrosShort; - if (tSpaceMicrosLong != 0) { - // Assume long space for zero when we have PulseDistanceWidth -> enables constant bit length - decodedIRData.DistanceWidthTimingInfo.ZeroSpaceMicros = tSpaceMicrosLong; + if (tSpaceMicrosLong == 0) { + // PULSE_DISTANCE, Sony + decodedIRData.DistanceWidthTimingInfo.OneMarkMicros = tMarkMicrosLong; + decodedIRData.DistanceWidthTimingInfo.OneSpaceMicros = tSpaceMicrosShort; + } else { + // PULSE_DISTANCE_WIDTH, we have 4 distinct values here + // Assume long space for a one when we have PulseDistanceWidth like for RS232, where a long inactive period (high) is a 1 + decodedIRData.DistanceWidthTimingInfo.OneSpaceMicros = tSpaceMicrosLong; + decodedIRData.DistanceWidthTimingInfo.OneMarkMicros = tMarkMicrosShort; + decodedIRData.DistanceWidthTimingInfo.ZeroMarkMicros = tMarkMicrosLong; +// // Assume long mark for a one when we have PulseDistanceWidth +// decodedIRData.DistanceWidthTimingInfo.OneSpaceMicros = tSpaceMicrosShort; +// decodedIRData.DistanceWidthTimingInfo.ZeroSpaceMicros = tSpaceMicrosLong; +// decodedIRData.DistanceWidthTimingInfo.OneMarkMicros = tMarkMicrosLong; } } else { - decodedIRData.DistanceWidthTimingInfo.OneMarkMicros = tMarkMicrosShort; - + // PULSE_WIDTH, NEC etc. // Here tMarkMicrosLong is 0 => tSpaceMicrosLong != 0 + decodedIRData.DistanceWidthTimingInfo.OneMarkMicros = tMarkMicrosShort; decodedIRData.DistanceWidthTimingInfo.OneSpaceMicros = tSpaceMicrosLong; } diff --git a/src/ir_FAST.hpp b/src/ir_FAST.hpp index 09998ac0e..e01f98296 100644 --- a/src/ir_FAST.hpp +++ b/src/ir_FAST.hpp @@ -1,7 +1,8 @@ /* * ir_FAST.hpp * - * Contains functions for receiving and sending FAST IR protocol with 8 bit command + * Contains functions for receiving and sending FAST IR protocol + * with no address and 16 bit data, interpreted as 8 bit command and 8 bit inverted command * * This file is part of Arduino-IRremote https://github.com/Arduino-IRremote/Arduino-IRremote. * @@ -34,7 +35,7 @@ #include "TinyIR.h" -#if defined(DEBUG) && !defined(LOCAL_DEBUG) +#if defined(DEBUG) #define LOCAL_DEBUG #else //#define LOCAL_DEBUG // This enables debug output only for this file @@ -53,18 +54,19 @@ //============================================================================== #include "TinyIR.h" /* -Protocol=FAST Address=0x0 Command=0x76 Raw-Data=0x8976 16 bits LSB first + Protocol=FAST Address=0x0 Command=0x76 Raw-Data=0x8976 16 bits LSB first +2100,-1050 + 550,- 500 + 550,-1550 + 550,-1550 + 550,- 500 + 550,-1550 + 550,-1550 + 550,-1550 + 550,- 500 + 550,-1550 + 550,- 500 + 550,- 500 + 550,-1550 + 550,- 500 + 550,- 500 + 550,- 500 + 550,-1550 + 550 -Sum: 28900 -*/ -struct PulseDistanceWidthProtocolConstants FASTProtocolConstants = { FAST, FAST_KHZ, FAST_HEADER_MARK, FAST_HEADER_SPACE, -FAST_BIT_MARK, FAST_ONE_SPACE, FAST_BIT_MARK, FAST_ZERO_SPACE, PROTOCOL_IS_LSB_FIRST, (FAST_REPEAT_PERIOD / MICROS_IN_ONE_MILLI), -NULL }; + Sum: 28900 + */ +struct PulseDistanceWidthProtocolConstants const FASTProtocolConstants PROGMEM = { FAST, FAST_KHZ, FAST_HEADER_MARK, + FAST_HEADER_SPACE, + FAST_BIT_MARK, FAST_ONE_SPACE, FAST_BIT_MARK, FAST_ZERO_SPACE, PROTOCOL_IS_LSB_FIRST, (FAST_REPEAT_PERIOD + / MICROS_IN_ONE_MILLI), nullptr }; /************************************ * Start of send and decode functions @@ -83,7 +85,7 @@ void IRsend::sendFAST(uint8_t aCommand, int_fast8_t aNumberOfRepeats) { mark(FAST_HEADER_MARK); space(FAST_HEADER_SPACE); - sendPulseDistanceWidthData(&FASTProtocolConstants, aCommand | (((uint8_t)(~aCommand)) << 8), FAST_BITS); + sendPulseDistanceWidthData_P(&FASTProtocolConstants, aCommand | (((uint8_t)(~aCommand)) << 8), FAST_BITS); tNumberOfCommands--; // skip last delay! @@ -96,22 +98,22 @@ void IRsend::sendFAST(uint8_t aCommand, int_fast8_t aNumberOfRepeats) { bool IRrecv::decodeFAST() { -// uint_fast8_t tRawlen = decodedIRData.rawDataPtr->rawlen; // Using a local variable does not improve code size +// uint_fast8_t tRawlen = decodedIRData.rawlen; // Using a local variable does not improve code size // Check we have the right amount of data (36). The +4 is for initial gap, start bit mark and space + stop bit mark. - if (decodedIRData.rawDataPtr->rawlen != ((2 * FAST_BITS) + 4)) { + if (decodedIRData.rawlen != ((2 * FAST_BITS) + 4)) { IR_DEBUG_PRINT(F("FAST: ")); IR_DEBUG_PRINT(F("Data length=")); - IR_DEBUG_PRINT(decodedIRData.rawDataPtr->rawlen); + IR_DEBUG_PRINT(decodedIRData.rawlen); IR_DEBUG_PRINTLN(F(" is not 36")); return false; } - if (!checkHeader(&FASTProtocolConstants)) { + if (!checkHeader_P(&FASTProtocolConstants)) { return false; } - if (!decodePulseDistanceWidthData(&FASTProtocolConstants, FAST_BITS)) { + if (!decodePulseDistanceWidthData_P(&FASTProtocolConstants, FAST_BITS)) { #if defined(LOCAL_DEBUG) Serial.print(F("FAST: ")); Serial.println(F("Decode failed")); @@ -122,7 +124,7 @@ bool IRrecv::decodeFAST() { WordUnion tValue; tValue.UWord = decodedIRData.decodedRawData; - if (tValue.UByte.LowByte != (uint8_t)~(tValue.UByte.HighByte)) { + if (tValue.UByte.LowByte != (uint8_t) ~(tValue.UByte.HighByte)) { #if defined(LOCAL_DEBUG) Serial.print(F("FAST: ")); Serial.print(F("8 bit parity is not correct. Expected=0x")); diff --git a/src/ir_JVC.hpp b/src/ir_JVC.hpp index 1e94f5307..ef69a5986 100644 --- a/src/ir_JVC.hpp +++ b/src/ir_JVC.hpp @@ -32,7 +32,7 @@ #ifndef _IR_JVC_HPP #define _IR_JVC_HPP -#if defined(DEBUG) && !defined(LOCAL_DEBUG) +#if defined(DEBUG) #define LOCAL_DEBUG #else //#define LOCAL_DEBUG // This enables debug output only for this file @@ -62,7 +62,8 @@ // IRP: {38k,525}<1,-1|1,-3>(16,-8,(D:8,F:8,1,-45)+) // LSB first, 1 start bit + 8 bit address + 8 bit command + 1 stop bit. // The JVC protocol repeats by skipping the header mark and space -> this leads to a poor repeat detection for JVC protocol. -// Some JVC devices require to send 3 repeats. https://github.com/Arduino-IRremote/Arduino-IRremote/issues/21 +// Some JVC devices require to send 3 repeats. + #define JVC_ADDRESS_BITS 8 // 8 bit address #define JVC_COMMAND_BITS 8 // Command @@ -76,12 +77,11 @@ #define JVC_ONE_SPACE (3 * JVC_UNIT) // 1578 - The length of a Bit:Space for 1's #define JVC_ZERO_SPACE JVC_UNIT // The length of a Bit:Space for 0's -#define JVC_REPEAT_DISTANCE (uint16_t)(45 * JVC_UNIT) // 23625 - Commands are repeated with a distance of 23 ms for as long as the key on the remote control is held down. -#define JVC_REPEAT_PERIOD 65000 // assume around 40 ms for a JVC frame +#define JVC_REPEAT_DISTANCE (uint16_t)(45 * JVC_UNIT) // 23625 - Commands are repeated with a distance of 23 ms for as long as the key on the remote control is held down. +#define JVC_REPEAT_PERIOD 65000 // assume around 40 ms for a JVC frame. JVC IR Remotes: RM-SA911U, RM-SX463U have 45 ms period -struct PulseDistanceWidthProtocolConstants JVCProtocolConstants = { JVC, JVC_KHZ, JVC_HEADER_MARK, JVC_HEADER_SPACE, JVC_BIT_MARK, -JVC_ONE_SPACE, JVC_BIT_MARK, JVC_ZERO_SPACE, PROTOCOL_IS_LSB_FIRST, (JVC_REPEAT_PERIOD - / MICROS_IN_ONE_MILLI), NULL }; +struct PulseDistanceWidthProtocolConstants const JVCProtocolConstants PROGMEM = {JVC, JVC_KHZ, JVC_HEADER_MARK, JVC_HEADER_SPACE, JVC_BIT_MARK, + JVC_ONE_SPACE, JVC_BIT_MARK, JVC_ZERO_SPACE, PROTOCOL_IS_LSB_FIRST, (JVC_REPEAT_PERIOD / MICROS_IN_ONE_MILLI), nullptr}; /************************************ * Start of send and decode functions @@ -106,7 +106,7 @@ void IRsend::sendJVC(uint8_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRe while (tNumberOfCommands > 0) { // Address + command - sendPulseDistanceWidthData(&JVCProtocolConstants, aAddress | (aCommand << JVC_ADDRESS_BITS), JVC_BITS); + sendPulseDistanceWidthData_P(&JVCProtocolConstants, aAddress | (aCommand << JVC_ADDRESS_BITS), JVC_BITS); tNumberOfCommands--; // skip last delay! @@ -119,26 +119,26 @@ void IRsend::sendJVC(uint8_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRe bool IRrecv::decodeJVC() { -// uint_fast8_t tRawlen = decodedIRData.rawDataPtr->rawlen; // Using a local variable does not improve code size +// uint_fast8_t tRawlen = decodedIRData.rawlen; // Using a local variable does not improve code size // Check we have the right amount of data (36 or 34). The +4 is for initial gap, start bit mark and space + stop bit mark. // +4 is for first frame, +2 is for repeats - if (decodedIRData.rawDataPtr->rawlen != ((2 * JVC_BITS) + 2) && decodedIRData.rawDataPtr->rawlen != ((2 * JVC_BITS) + 4)) { + if (decodedIRData.rawlen != ((2 * JVC_BITS) + 2) && decodedIRData.rawlen != ((2 * JVC_BITS) + 4)) { IR_DEBUG_PRINT(F("JVC: ")); IR_DEBUG_PRINT(F("Data length=")); - IR_DEBUG_PRINT(decodedIRData.rawDataPtr->rawlen); + IR_DEBUG_PRINT(decodedIRData.rawlen); IR_DEBUG_PRINTLN(F(" is not 34 or 36")); return false; } - if (decodedIRData.rawDataPtr->rawlen == ((2 * JVC_BITS) + 2)) { + if (decodedIRData.rawlen == ((2 * JVC_BITS) + 2)) { /* * Check for repeat * Check leading space and first and last mark length */ - if (decodedIRData.rawDataPtr->rawbuf[0] < ((JVC_REPEAT_DISTANCE + (JVC_REPEAT_DISTANCE / 4) / MICROS_PER_TICK)) + if (decodedIRData.initialGapTicks < ((JVC_REPEAT_DISTANCE + (JVC_REPEAT_DISTANCE / 4) / MICROS_PER_TICK)) && matchMark(decodedIRData.rawDataPtr->rawbuf[1], JVC_BIT_MARK) - && matchMark(decodedIRData.rawDataPtr->rawbuf[decodedIRData.rawDataPtr->rawlen - 1], JVC_BIT_MARK)) { + && matchMark(decodedIRData.rawDataPtr->rawbuf[decodedIRData.rawlen - 1], JVC_BIT_MARK)) { /* * We have a repeat here, so do not check for start bit */ @@ -149,11 +149,11 @@ bool IRrecv::decodeJVC() { } } else { - if (!checkHeader(&JVCProtocolConstants)) { + if (!checkHeader_P(&JVCProtocolConstants)) { return false; } - if (!decodePulseDistanceWidthData(&JVCProtocolConstants, JVC_BITS)) { + if (!decodePulseDistanceWidthData_P(&JVCProtocolConstants, JVC_BITS)) { #if defined(LOCAL_DEBUG) Serial.print(F("JVC: ")); Serial.println(F("Decode failed")); @@ -208,7 +208,7 @@ bool IRrecv::decodeJVCMSB(decode_results *aResults) { } offset++; - if (!decodePulseDistanceWidthData(JVC_BITS, offset, JVC_BIT_MARK, 0, JVC_ONE_SPACE, JVC_ZERO_SPACE, PROTOCOL_IS_MSB_FIRST)) { + if (!decodePulseDistanceWidthData(JVC_BITS, offset, JVC_BIT_MARK, JVC_ONE_SPACE, 0, PROTOCOL_IS_MSB_FIRST)) { return false; } @@ -232,6 +232,7 @@ bool IRrecv::decodeJVCMSB(decode_results *aResults) { /** * With Send sendJVCMSB() you can send your old 32 bit codes. * To convert one into the other, you must reverse the byte positions and then reverse all bit positions of each byte. + * Use bitreverse32Bit(). * Or write it as one binary string and reverse/mirror it. * Example: * 0xCB340102 byte reverse -> 02 01 34 CB bit reverse-> 40 80 2C D3. @@ -250,8 +251,7 @@ void IRsend::sendJVCMSB(unsigned long data, int nbits, bool repeat) { } // Old version with MSB first Data - sendPulseDistanceWidthData(JVC_BIT_MARK, JVC_ONE_SPACE, JVC_BIT_MARK, JVC_ZERO_SPACE, data, nbits, - PROTOCOL_IS_MSB_FIRST); + sendPulseDistanceWidthData(JVC_BIT_MARK, JVC_ONE_SPACE, JVC_BIT_MARK, JVC_ZERO_SPACE, data, nbits, PROTOCOL_IS_MSB_FIRST); } /** @}*/ diff --git a/src/ir_Kaseikyo.hpp b/src/ir_Kaseikyo.hpp index 9f6ddafff..9abce660c 100644 --- a/src/ir_Kaseikyo.hpp +++ b/src/ir_Kaseikyo.hpp @@ -32,7 +32,7 @@ #ifndef _IR_KASEIKYO_HPP #define _IR_KASEIKYO_HPP -#if defined(DEBUG) && !defined(LOCAL_DEBUG) +#if defined(DEBUG) #define LOCAL_DEBUG #else //#define LOCAL_DEBUG // This enables debug output only for this file @@ -75,22 +75,22 @@ */ // http://www.hifi-remote.com/johnsfine/DecodeIR.html#Panasonic // http://www.hifi-remote.com/johnsfine/DecodeIR.html#Kaseikyo +// LSB first // The first two (8-bit) bytes contains the vendor code. +// The next 4 bit is VendorID parity. +// The last byte is parity (XOR) of the 3 bytes before. // There are multiple interpretations of the next fields: // IRP: {37k,432}<1,-1|1,-3>(8,-4,M:8,N:8,X:4,D:4,S:8,F:8,G:8,1,-173)+ {X=M:4:0^M:4:4^N:4:0^N:4:4} -// 1. interpretation: After the vendor code, the next byte is 4 bit VendorID parity and 4 bit Device and Subdevice -// The 5th byte is the function and the last (6.th) byte is xor of the three bytes before it. -// 0_______ 1_______ 2______ 3_______ 4_______ 5 +// 1. interpretation: 4 bit Device, 8 bitSubdevice and 8 bit function. +// 0_______ 1_______ 2______ 3_______ 4_______ 5_______ // 01234567 89ABCDEF 01234567 01234567 01234567 01234567 -// 01000000 00100100 Dev____ Sub_Dev_ Fun____ XOR( B2, B3, B4) - showing Panasonic vendor code 0x2002 +// 01000000 00100100 0110Dev_ Sub_Dev_ Fun____ XOR( B2, B3, B4) - Byte 0,1 and vendor parity showing Panasonic vendor code 0x2002. +// 1. interpretation: // see: http://www.remotecentral.com/cgi-bin/mboard/rc-pronto/thread.cgi?26152 -// -// 2. interpretation: LSB first, start bit + 16 VendorID + 4 VendorID parity + 4 Genre1 + 4 Genre2 + 10 Command + 2 ID + 8 Parity + stop bit +// 2. interpretation (Flipper Zero style): // see: https://www.mikrocontroller.net/articles/IRMP_-_english#KASEIKYO -// 32 bit raw data LSB is VendorID parity. -// -// We reduce it to: IRP: {37k,432}<1,-1|1,-3>(8,-4,V:16,X:4,D:4,S:8,F:8,(X^D^S^F):8,1,-173)+ {X=M:4:0^M:4:4^N:4:0^N:4:4} -// start bit + 16 VendorID + 4 VendorID parity + 12 Address + 8 Command + 8 Parity of VendorID parity, Address and Command + stop bit +// Implemented is Samsung style: +// which is derived from Samsung remotes and may not be optimal for Denon kind of Kaseikyo protokol usage. // #define KASEIKYO_VENDOR_ID_BITS 16 #define KASEIKYO_VENDOR_ID_PARITY_BITS 4 @@ -118,16 +118,16 @@ #define SHARP_VENDOR_ID_CODE 0x5AAA #define JVC_VENDOR_ID_CODE 0x0103 -struct PulseDistanceWidthProtocolConstants KaseikyoProtocolConstants = { KASEIKYO, KASEIKYO_KHZ, KASEIKYO_HEADER_MARK, -KASEIKYO_HEADER_SPACE, KASEIKYO_BIT_MARK, KASEIKYO_ONE_SPACE, KASEIKYO_BIT_MARK, KASEIKYO_ZERO_SPACE, PROTOCOL_IS_LSB_FIRST - , (KASEIKYO_REPEAT_PERIOD / MICROS_IN_ONE_MILLI), NULL }; +struct PulseDistanceWidthProtocolConstants const KaseikyoProtocolConstants PROGMEM = {KASEIKYO, KASEIKYO_KHZ, KASEIKYO_HEADER_MARK, + KASEIKYO_HEADER_SPACE, KASEIKYO_BIT_MARK, KASEIKYO_ONE_SPACE, KASEIKYO_BIT_MARK, KASEIKYO_ZERO_SPACE, PROTOCOL_IS_LSB_FIRST + , (KASEIKYO_REPEAT_PERIOD / MICROS_IN_ONE_MILLI), nullptr}; /************************************ * Start of send and decode functions ************************************/ /** - * Address can be interpreted as sub-device << 8 + device + * Address can be interpreted as sub-device << 4 + 4 bit device */ void IRsend::sendKaseikyo(uint16_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats, uint16_t aVendorCode) { // Set IR carrier frequency @@ -140,13 +140,13 @@ void IRsend::sendKaseikyo(uint16_t aAddress, uint8_t aCommand, int_fast8_t aNumb #if __INT_WIDTH__ < 32 LongUnion tSendValue; // Compute parity - tSendValue.UWord.LowWord = (aAddress << KASEIKYO_VENDOR_ID_PARITY_BITS) | tVendorParity; // set low nibble to parity + tSendValue.UWord.LowWord = (aAddress << KASEIKYO_VENDOR_ID_PARITY_BITS) | tVendorParity; // set low nibble with vendor parity tSendValue.UBytes[2] = aCommand; - tSendValue.UBytes[3] = aCommand ^ tSendValue.UBytes[0] ^ tSendValue.UBytes[1]; // Parity + tSendValue.UBytes[3] = aCommand ^ tSendValue.UBytes[0] ^ tSendValue.UBytes[1]; // 8 bit parity of 3 bytes command, address and vendor parity IRRawDataType tRawKaseikyoData[2]; tRawKaseikyoData[0] = (uint32_t) tSendValue.UWord.LowWord << 16 | aVendorCode; // LSB of tRawKaseikyoData[0] is sent first tRawKaseikyoData[1] = tSendValue.UWord.HighWord; - IrSender.sendPulseDistanceWidthFromArray(&KaseikyoProtocolConstants, &tRawKaseikyoData[0], KASEIKYO_BITS, aNumberOfRepeats); + sendPulseDistanceWidthFromArray_P(&KaseikyoProtocolConstants, &tRawKaseikyoData[0], KASEIKYO_BITS, aNumberOfRepeats); #else LongLongUnion tSendValue; tSendValue.UWords[0] = aVendorCode; @@ -154,7 +154,7 @@ void IRsend::sendKaseikyo(uint16_t aAddress, uint8_t aCommand, int_fast8_t aNumb tSendValue.UWords[1] = (aAddress << KASEIKYO_VENDOR_ID_PARITY_BITS) | tVendorParity; // set low nibble to parity tSendValue.UBytes[4] = aCommand; tSendValue.UBytes[5] = aCommand ^ tSendValue.UBytes[2] ^ tSendValue.UBytes[3]; // Parity - IrSender.sendPulseDistanceWidth(&KaseikyoProtocolConstants, tSendValue.ULongLong, KASEIKYO_BITS, aNumberOfRepeats); + sendPulseDistanceWidth_P(&KaseikyoProtocolConstants, tSendValue.ULongLong, KASEIKYO_BITS, aNumberOfRepeats); #endif } @@ -200,20 +200,20 @@ bool IRrecv::decodeKaseikyo() { decode_type_t tProtocol; // Check we have enough data (96 + 4) 4 for initial gap, start bit mark and space + stop bit mark - if (decodedIRData.rawDataPtr->rawlen != ((2 * KASEIKYO_BITS) + 4)) { + if (decodedIRData.rawlen != ((2 * KASEIKYO_BITS) + 4)) { IR_DEBUG_PRINT(F("Kaseikyo: ")); IR_DEBUG_PRINT(F("Data length=")); - IR_DEBUG_PRINT(decodedIRData.rawDataPtr->rawlen); + IR_DEBUG_PRINT(decodedIRData.rawlen); IR_DEBUG_PRINTLN(F(" is not 100")); return false; } - if (!checkHeader(&KaseikyoProtocolConstants)) { + if (!checkHeader_P(&KaseikyoProtocolConstants)) { return false; } // decode first 16 Vendor ID bits - if (!decodePulseDistanceWidthData(&KaseikyoProtocolConstants, KASEIKYO_VENDOR_ID_BITS)) { + if (!decodePulseDistanceWidthData_P(&KaseikyoProtocolConstants, KASEIKYO_VENDOR_ID_BITS)) { #if defined(LOCAL_DEBUG) Serial.print(F("Kaseikyo: ")); Serial.println(F("Vendor ID decode failed")); @@ -243,7 +243,7 @@ bool IRrecv::decodeKaseikyo() { /* * Decode next 32 bits, 8 VendorID parity parity + 12 address (device and subdevice) + 8 command + 8 parity */ - if (!decodePulseDistanceWidthData(&KaseikyoProtocolConstants, + if (!decodePulseDistanceWidthData_P(&KaseikyoProtocolConstants, KASEIKYO_VENDOR_ID_PARITY_BITS + KASEIKYO_ADDRESS_BITS + KASEIKYO_COMMAND_BITS + KASEIKYO_PARITY_BITS, 3 + (2 * KASEIKYO_VENDOR_ID_BITS))) { #if defined(LOCAL_DEBUG) diff --git a/src/ir_LG.hpp b/src/ir_LG.hpp index 6990cff78..ad35f8126 100644 --- a/src/ir_LG.hpp +++ b/src/ir_LG.hpp @@ -8,7 +8,7 @@ ************************************************************************************ * MIT License * - * Copyright (c) 2017-2023 Darryl Smith, Armin Joachimsmeyer + * Copyright (c) 2017-2024 Darryl Smith, Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -32,7 +32,7 @@ #ifndef _IR_LG_HPP #define _IR_LG_HPP -#if defined(DEBUG) && !defined(LOCAL_DEBUG) +#if defined(DEBUG) #define LOCAL_DEBUG #else //#define LOCAL_DEBUG // This enables debug output only for this file @@ -114,17 +114,17 @@ //#define LG_REPEAT_DURATION (LG_HEADER_MARK + LG_REPEAT_HEADER_SPACE + LG_BIT_MARK) //#define LG_REPEAT_DISTANCE (LG_REPEAT_PERIOD - LG_AVERAGE_DURATION) // 52 ms -struct PulseDistanceWidthProtocolConstants LGProtocolConstants = { LG, LG_KHZ, LG_HEADER_MARK, LG_HEADER_SPACE, LG_BIT_MARK, -LG_ONE_SPACE, LG_BIT_MARK, LG_ZERO_SPACE, PROTOCOL_IS_MSB_FIRST, (LG_REPEAT_PERIOD / MICROS_IN_ONE_MILLI), &sendNECSpecialRepeat }; +struct PulseDistanceWidthProtocolConstants const LGProtocolConstants PROGMEM= {LG, LG_KHZ, LG_HEADER_MARK, LG_HEADER_SPACE, LG_BIT_MARK, + LG_ONE_SPACE, LG_BIT_MARK, LG_ZERO_SPACE, PROTOCOL_IS_MSB_FIRST, (LG_REPEAT_PERIOD / MICROS_IN_ONE_MILLI), &sendNECSpecialRepeat}; -struct PulseDistanceWidthProtocolConstants LG2ProtocolConstants = { LG2, LG_KHZ, LG2_HEADER_MARK, LG2_HEADER_SPACE, LG_BIT_MARK, -LG_ONE_SPACE, LG_BIT_MARK, LG_ZERO_SPACE, PROTOCOL_IS_MSB_FIRST, (LG_REPEAT_PERIOD / MICROS_IN_ONE_MILLI), &sendLG2SpecialRepeat }; +struct PulseDistanceWidthProtocolConstants const LG2ProtocolConstants PROGMEM = {LG2, LG_KHZ, LG2_HEADER_MARK, LG2_HEADER_SPACE, LG_BIT_MARK, + LG_ONE_SPACE, LG_BIT_MARK, LG_ZERO_SPACE, PROTOCOL_IS_MSB_FIRST, (LG_REPEAT_PERIOD / MICROS_IN_ONE_MILLI), &sendLG2SpecialRepeat}; /************************************ * Start of send and decode functions ************************************/ /* - * Send special LG2 repeat not used yet + * Send special LG2 repeat - not used internally */ void IRsend::sendLG2Repeat() { enableIROut (LG_KHZ); // 38 kHz @@ -163,14 +163,14 @@ uint32_t IRsend::computeLGRawDataAndChecksum(uint8_t aAddress, uint16_t aCommand * LG uses the NEC repeat. */ void IRsend::sendLG(uint8_t aAddress, uint16_t aCommand, int_fast8_t aNumberOfRepeats) { - sendPulseDistanceWidth(&LGProtocolConstants, computeLGRawDataAndChecksum(aAddress, aCommand), LG_BITS, aNumberOfRepeats); + sendPulseDistanceWidth_P(&LGProtocolConstants, computeLGRawDataAndChecksum(aAddress, aCommand), LG_BITS, aNumberOfRepeats); } /** * LG2 uses a special repeat. */ void IRsend::sendLG2(uint8_t aAddress, uint16_t aCommand, int_fast8_t aNumberOfRepeats) { - sendPulseDistanceWidth(&LG2ProtocolConstants, computeLGRawDataAndChecksum(aAddress, aCommand), LG_BITS, aNumberOfRepeats); + sendPulseDistanceWidth_P(&LG2ProtocolConstants, computeLGRawDataAndChecksum(aAddress, aCommand), LG_BITS, aNumberOfRepeats); } bool IRrecv::decodeLG() { @@ -184,30 +184,30 @@ bool IRrecv::decodeLG() { */ // Check we have the right amount of data (60). The +4 is for initial gap, start bit mark and space + stop bit mark. - if (decodedIRData.rawDataPtr->rawlen != ((2 * LG_BITS) + 4) && (decodedIRData.rawDataPtr->rawlen != 4)) { + if (decodedIRData.rawlen != ((2 * LG_BITS) + 4) && (decodedIRData.rawlen != 4)) { IR_DEBUG_PRINT(F("LG: ")); IR_DEBUG_PRINT(F("Data length=")); - IR_DEBUG_PRINT(decodedIRData.rawDataPtr->rawlen); + IR_DEBUG_PRINT(decodedIRData.rawlen); IR_DEBUG_PRINTLN(F(" is not 60 or 4")); return false; } // Check header "mark" this must be done for repeat and data if (!matchMark(decodedIRData.rawDataPtr->rawbuf[1], LG_HEADER_MARK)) { - if (!matchMark(decodedIRData.rawDataPtr->rawbuf[1], LG2_HEADER_MARK)) { + if (matchMark(decodedIRData.rawDataPtr->rawbuf[1], LG2_HEADER_MARK)) { + tProtocol = LG2; + tHeaderSpace = LG2_HEADER_SPACE; + } else { #if defined(LOCAL_DEBUG) Serial.print(F("LG: ")); Serial.println(F("Header mark is wrong")); #endif - return false; - } else { - tProtocol = LG2; - tHeaderSpace = LG2_HEADER_SPACE; + return false; // neither LG nor LG2 header } } // Check for repeat - here we have another header space length - if (decodedIRData.rawDataPtr->rawlen == 4) { + if (decodedIRData.rawlen == 4) { if (matchSpace(decodedIRData.rawDataPtr->rawbuf[2], LG_REPEAT_HEADER_SPACE) && matchMark(decodedIRData.rawDataPtr->rawbuf[3], LG_BIT_MARK)) { decodedIRData.flags = IRDATA_FLAGS_IS_REPEAT | IRDATA_FLAGS_IS_MSB_FIRST; @@ -232,7 +232,7 @@ bool IRrecv::decodeLG() { return false; } - if (!decodePulseDistanceWidthData(&LGProtocolConstants, LG_BITS)) { + if (!decodePulseDistanceWidthData_P(&LGProtocolConstants, LG_BITS)) { #if defined(LOCAL_DEBUG) Serial.print(F("LG: ")); Serial.println(F("Decode failed")); @@ -284,7 +284,7 @@ bool IRrecv::decodeLG() { * @param aNumberOfRepeats If < 0 then only a special repeat frame will be sent. */ void IRsend::sendLGRaw(uint32_t aRawData, int_fast8_t aNumberOfRepeats) { - sendPulseDistanceWidth(&LGProtocolConstants, aRawData, LG_BITS, aNumberOfRepeats); + sendPulseDistanceWidth_P(&LGProtocolConstants, aRawData, LG_BITS, aNumberOfRepeats); } bool IRrecv::decodeLGMSB(decode_results *aResults) { @@ -306,7 +306,7 @@ bool IRrecv::decodeLGMSB(decode_results *aResults) { } offset++; - if (!decodePulseDistanceWidthData(LG_BITS, offset, LG_BIT_MARK, 0, LG_ONE_SPACE, LG_ZERO_SPACE, PROTOCOL_IS_MSB_FIRST)) { + if (!decodePulseDistanceWidthData(LG_BITS, offset, LG_BIT_MARK, LG_ONE_SPACE, 0, PROTOCOL_IS_MSB_FIRST)) { return false; } // Stop bit diff --git a/src/ir_Lego.hpp b/src/ir_Lego.hpp index 2f87be673..156bf7439 100644 --- a/src/ir_Lego.hpp +++ b/src/ir_Lego.hpp @@ -45,15 +45,16 @@ // from LEGO Power Functions RC Manual 26.02.2010 Version 1.20 // https://github.com/jurriaan/Arduino-PowerFunctions/raw/master/LEGO_Power_Functions_RC_v120.pdf // https://oberguru.net/elektronik/ir/codes/lego_power_functions_train.lircd.conf +// For original LEGO receiver see: https://www.philohome.com/pfrec/pfrec.htm and https://www.youtube.com/watch?v=KCM4Ug1bPrM // // To ensure correct detection of IR messages six 38 kHz cycles are transmitted as mark. -// Low bit consists of 6 cycles of IR and 10 “cycles” of pause, -// high bit of 6 cycles IR and 21 “cycles” of pause and start bit of 6 cycles IR and 39 “cycles” of pause. +// Low bit consists of 6 cycles of IR and 10 �cycles� of pause, +// high bit of 6 cycles IR and 21 �cycles� of pause and start bit of 6 cycles IR and 39 �cycles� of pause. // Low bit range 316 - 526 us -// High bit range 526 – 947 us -// Start/stop bit range 947 – 1579 us +// High bit range 526 � 947 us +// Start/stop bit range 947 � 1579 us // If tm is the maximum message length (16ms) and Ch is the channel number, then -// The delay before transmitting the first message is: (4 – Ch)*tm +// The delay before transmitting the first message is: (4 � Ch)*tm // The time from start to start for the next 2 messages is: 5*tm // The time from start to start for the following messages is: (6 + 2*Ch)*tm // Supported Devices @@ -82,9 +83,9 @@ #define LEGO_MODE_COMBO 1 #define LEGO_MODE_SINGLE 0x4 // here the 2 LSB have meanings like Output A / Output B -struct PulseDistanceWidthProtocolConstants LegoProtocolConstants = { LEGO_PF, 38, LEGO_HEADER_MARK, LEGO_HEADER_SPACE, LEGO_BIT_MARK, -LEGO_ONE_SPACE, LEGO_BIT_MARK, LEGO_ZERO_SPACE, PROTOCOL_IS_LSB_FIRST, (LEGO_AUTO_REPEAT_PERIOD_MIN - / MICROS_IN_ONE_MILLI), NULL }; +struct PulseDistanceWidthProtocolConstants LegoProtocolConstants = { LEGO_PF, 38, LEGO_HEADER_MARK, LEGO_HEADER_SPACE, +LEGO_BIT_MARK, LEGO_ONE_SPACE, LEGO_BIT_MARK, LEGO_ZERO_SPACE, PROTOCOL_IS_LSB_FIRST, (LEGO_AUTO_REPEAT_PERIOD_MIN + / MICROS_IN_ONE_MILLI), nullptr }; /************************************ * Start of send and decode functions @@ -131,7 +132,7 @@ bool IRrecv::decodeLegoPowerFunctions() { } // Check we have enough data - +4 for initial gap, start bit mark and space + stop bit mark - if (decodedIRData.rawDataPtr->rawlen != (2 * LEGO_BITS) + 4) { + if (decodedIRData.rawlen != (2 * LEGO_BITS) + 4) { IR_DEBUG_PRINT(F("LEGO: ")); IR_DEBUG_PRINT(F("Data length=")); IR_DEBUG_PRINT(decodedIRData.rawDataPtr->rawlen); @@ -186,7 +187,7 @@ bool IRrecv::decodeLegoPowerFunctions() { /* * Check for autorepeat (should happen 4 times for one press) */ - if (decodedIRData.rawDataPtr->rawbuf[0] < (LEGO_AUTO_REPEAT_PERIOD_MAX / MICROS_PER_TICK)) { + if (decodedIRData.initialGapTicks < (LEGO_AUTO_REPEAT_PERIOD_MAX / MICROS_PER_TICK)) { decodedIRData.flags |= IRDATA_FLAGS_IS_AUTO_REPEAT; } decodedIRData.address = tToggleEscapeChannel; diff --git a/src/ir_MagiQuest.hpp b/src/ir_MagiQuest.hpp index 6e82550bf..ccd214f89 100644 --- a/src/ir_MagiQuest.hpp +++ b/src/ir_MagiQuest.hpp @@ -14,7 +14,7 @@ ************************************************************************************ * MIT License * - * Copyright (c) 2017-2023 E. Stuart Hicks , Armin Joachimsmeyer + * Copyright (c) 2017-2024 E. Stuart Hicks , Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -38,7 +38,7 @@ #ifndef _IR_MAGIQUEST_HPP #define _IR_MAGIQUEST_HPP -#if defined(DEBUG) && !defined(LOCAL_DEBUG) +#if defined(DEBUG) #define LOCAL_DEBUG #else //#define LOCAL_DEBUG // This enables debug output only for this file @@ -55,7 +55,6 @@ //============================================================================== /* * https://github.com/kitlaan/Arduino-IRremote/blob/master/ir_Magiquest.cpp - * https://github.com/Arduino-IRremote/Arduino-IRremote/discussions/1027#discussioncomment-3636857 * https://github.com/Arduino-IRremote/Arduino-IRremote/issues/1015#issuecomment-1222247231 Protocol=MagiQuest Address=0xFF00 Command=0x176 Raw-Data=0x6BCDFF00 56 bits MSB first @@ -79,6 +78,8 @@ // Checksum (+ sum of the 5 bytes before == 0) + 250,- 900 + 300,- 900 + 250,- 850 + 550,- 600 + 600,- 550 + 300,- 900 + 250,- 850 + 550 + + // No stop bit! */ // MSB first, 8 start bits (zero), 31 wand id bits, 9 magnitude bits 8 checksum bits and no stop bit => 56 bits #define MAGIQUEST_CHECKSUM_BITS 8 // magiquest_t.cmd.checksum @@ -107,8 +108,9 @@ #define MAGIQUEST_ZERO_SPACE (3 * MAGIQUEST_UNIT) // 864 // assume 110 as repeat period -struct PulseDistanceWidthProtocolConstants MagiQuestProtocolConstants = { MAGIQUEST, 38, MAGIQUEST_ZERO_MARK, MAGIQUEST_ZERO_SPACE, -MAGIQUEST_ONE_MARK, MAGIQUEST_ONE_SPACE, MAGIQUEST_ZERO_MARK, MAGIQUEST_ZERO_SPACE, PROTOCOL_IS_MSB_FIRST, 110, NULL }; +struct PulseDistanceWidthProtocolConstants const MagiQuestProtocolConstants PROGMEM = { MAGIQUEST, 38, MAGIQUEST_ZERO_MARK, MAGIQUEST_ZERO_SPACE, +MAGIQUEST_ONE_MARK, MAGIQUEST_ONE_SPACE, MAGIQUEST_ZERO_MARK, MAGIQUEST_ZERO_SPACE, PROTOCOL_IS_MSB_FIRST | SUPPRESS_STOP_BIT, 110, +nullptr }; //+============================================================================= // /** @@ -128,11 +130,11 @@ void IRsend::sendMagiQuest(uint32_t aWandId, uint16_t aMagnitude) { tChecksum = ~tChecksum + 1; // 8 start bits - sendPulseDistanceWidthData(&MagiQuestProtocolConstants, 0, 8); + sendPulseDistanceWidthData_P(&MagiQuestProtocolConstants, 0, 8); // 48 bit data - sendPulseDistanceWidthData(&MagiQuestProtocolConstants, aWandId, MAGIQUEST_WAND_ID_BITS); // send only 31 bit, do not send MSB here - sendPulseDistanceWidthData(&MagiQuestProtocolConstants, aMagnitude, MAGIQUEST_MAGNITUDE_BITS); - sendPulseDistanceWidthData(&MagiQuestProtocolConstants, tChecksum, MAGIQUEST_CHECKSUM_BITS); + sendPulseDistanceWidthData_P(&MagiQuestProtocolConstants, aWandId, MAGIQUEST_WAND_ID_BITS); // send only 31 bit, do not send MSB here + sendPulseDistanceWidthData_P(&MagiQuestProtocolConstants, aMagnitude, MAGIQUEST_MAGNITUDE_BITS); + sendPulseDistanceWidthData_P(&MagiQuestProtocolConstants, tChecksum, MAGIQUEST_CHECKSUM_BITS); #if defined(LOCAL_DEBUG) // must be after sending, in order not to destroy the send timing Serial.print(F("MagiQuest checksum=0x")); @@ -151,10 +153,10 @@ void IRsend::sendMagiQuest(uint32_t aWandId, uint16_t aMagnitude) { bool IRrecv::decodeMagiQuest() { // Check we have the right amount of data, magnitude and ID bits and 8 start bits + 0 stop bit - if (decodedIRData.rawDataPtr->rawlen != (2 * MAGIQUEST_BITS)) { + if (decodedIRData.rawlen != (2 * MAGIQUEST_BITS)) { IR_DEBUG_PRINT(F("MagiQuest: ")); IR_DEBUG_PRINT(F("Data length=")); - IR_DEBUG_PRINT(decodedIRData.rawDataPtr->rawlen); + IR_DEBUG_PRINT(decodedIRData.rawlen); IR_DEBUG_PRINTLN(F(" is not 112")); return false; } @@ -162,7 +164,7 @@ bool IRrecv::decodeMagiQuest() { /* * Check for 8 zero header bits */ - if (!decodePulseDistanceWidthData(&MagiQuestProtocolConstants, MAGIQUEST_START_BITS, 1)) { + if (!decodePulseDistanceWidthData_P(&MagiQuestProtocolConstants, MAGIQUEST_START_BITS, 1)) { #if defined(LOCAL_DEBUG) Serial.print(F("MagiQuest: ")); Serial.println(F("Start bit decode failed")); @@ -181,7 +183,7 @@ bool IRrecv::decodeMagiQuest() { /* * Decode the 31 bit ID */ - if (!decodePulseDistanceWidthData(&MagiQuestProtocolConstants, MAGIQUEST_WAND_ID_BITS, (MAGIQUEST_START_BITS * 2) + 1)) { + if (!decodePulseDistanceWidthData_P(&MagiQuestProtocolConstants, MAGIQUEST_WAND_ID_BITS, (MAGIQUEST_START_BITS * 2) + 1)) { #if defined(LOCAL_DEBUG) Serial.print(F("MagiQuest: ")); Serial.println(F("ID decode failed")); @@ -205,7 +207,7 @@ bool IRrecv::decodeMagiQuest() { /* * Decode the 9 bit Magnitude + 8 bit checksum */ - if (!decodePulseDistanceWidthData(&MagiQuestProtocolConstants, MAGIQUEST_MAGNITUDE_BITS + MAGIQUEST_CHECKSUM_BITS, + if (!decodePulseDistanceWidthData_P(&MagiQuestProtocolConstants, MAGIQUEST_MAGNITUDE_BITS + MAGIQUEST_CHECKSUM_BITS, ((MAGIQUEST_WAND_ID_BITS + MAGIQUEST_START_BITS) * 2) + 1)) { #if defined(LOCAL_DEBUG) Serial.print(F("MagiQuest: ")); diff --git a/src/ir_NEC.hpp b/src/ir_NEC.hpp index 8f856c950..5bf750fea 100644 --- a/src/ir_NEC.hpp +++ b/src/ir_NEC.hpp @@ -32,10 +32,10 @@ #ifndef _IR_NEC_HPP #define _IR_NEC_HPP -#if defined(DEBUG) && !defined(LOCAL_DEBUG) -#define LOCAL_DEBUG +#if defined(DEBUG) +#define LOCAL_DEBUG // IR_DEBUG_PRINT is a real print function here. Add local debug output. #else -//#define LOCAL_DEBUG // This enables debug output only for this file +//#define LOCAL_DEBUG // This enables debug output only for this file. IR_DEBUG_PRINT is still a void function here. #endif /** \addtogroup Decoder Decoders and encoders for different protocols @@ -71,16 +71,20 @@ */ // http://www.hifi-remote.com/wiki/index.php/NEC // https://www.sbprojects.net/knowledge/ir/nec.php -// for Apple see https://en.wikipedia.org/wiki/Apple_Remote - Fixed address 0x87EE, 8 bit device ID, 7 bit command, 1 bit parity - untested! -// ONKYO like NEC but 16 independent command bits -// PIONEER (not implemented) is NEC2 with 40 kHz -// LSB first, 1 start bit + 16 bit address (or 8 bit address and 8 bit inverted address) + 8 bit command + 8 bit inverted command + 1 stop bit. +// NEC: LSB first, (or ) . +// ONKYO: like NEC but force to 16 independent address and 16 bit command bits: // Standard NEC sends a special fixed repeat frame. -// NEC2 sends the same full frame after the 110 ms. I have a DVD remote with NEC2. +// NEC2: like NEC, but for repeat, the same full frame is sent after the 110 ms. I have a DVD remote with NEC2. // NEC and NEC 2 only differ in the repeat frames, so the protocol can only be detected correctly after the first repeat. +// PIONEER (not implemented) is NEC2 with 40 kHz // +// For Apple see https://en.wikipedia.org/wiki/Apple_Remote - <0x87EE:16> - not implemented! +// The parity is not implemented, so we get: <0x87EE:16> +// +// IRP notation: // IRP: NEC {38.0k,564}<1,-1|1,-3>(16,-8,D:8,S:8,F:8,~F:8,1,^108m,(16,-4,1,^108m)*) ==> "*" means send special repeat frames o ore more times // IRP: NEC2 {38.0k,564}<1,-1|1,-3>(16,-8,D:8,S:8,F:8,~F:8,1,^108m)+ ==> "+" means send frame 1 or more times (special repeat is missing here!) +// Interpretation of IRP notation: // {38.0k,564} ==> 38.0k -> Frequency , 564 -> unit in microseconds (we use 560), no "msb", so "lsb" is assumed // <1,-1|1,-3> ==> Zero is 1 unit mark and space | One is 1 unit mark and 3 units space // 16,-8 ==> Start bit durations @@ -111,14 +115,13 @@ #define APPLE_ADDRESS 0x87EE -struct PulseDistanceWidthProtocolConstants NECProtocolConstants = - { NEC, NEC_KHZ, NEC_HEADER_MARK, NEC_HEADER_SPACE, NEC_BIT_MARK, - NEC_ONE_SPACE, NEC_BIT_MARK, NEC_ZERO_SPACE, PROTOCOL_IS_LSB_FIRST, (NEC_REPEAT_PERIOD / MICROS_IN_ONE_MILLI), - &sendNECSpecialRepeat }; +struct PulseDistanceWidthProtocolConstants const NECProtocolConstants PROGMEM = {NEC, NEC_KHZ, NEC_HEADER_MARK, NEC_HEADER_SPACE, NEC_BIT_MARK, + NEC_ONE_SPACE, NEC_BIT_MARK, NEC_ZERO_SPACE, PROTOCOL_IS_LSB_FIRST, (NEC_REPEAT_PERIOD / MICROS_IN_ONE_MILLI), + &sendNECSpecialRepeat}; // Like NEC but repeats are full frames instead of special NEC repeats -struct PulseDistanceWidthProtocolConstants NEC2ProtocolConstants = { NEC2, NEC_KHZ, NEC_HEADER_MARK, NEC_HEADER_SPACE, NEC_BIT_MARK, -NEC_ONE_SPACE, NEC_BIT_MARK, NEC_ZERO_SPACE, PROTOCOL_IS_LSB_FIRST, (NEC_REPEAT_PERIOD / MICROS_IN_ONE_MILLI), NULL }; +struct PulseDistanceWidthProtocolConstants const NEC2ProtocolConstants PROGMEM = {NEC2, NEC_KHZ, NEC_HEADER_MARK, NEC_HEADER_SPACE, NEC_BIT_MARK, + NEC_ONE_SPACE, NEC_BIT_MARK, NEC_ZERO_SPACE, PROTOCOL_IS_LSB_FIRST, (NEC_REPEAT_PERIOD / MICROS_IN_ONE_MILLI), nullptr}; /************************************ * Start of send and decode functions @@ -136,7 +139,7 @@ void IRsend::sendNECRepeat() { } /** - * Static function for sending special repeat frame. + * Static function variant of IRsend::sendNECRepeat * For use in ProtocolConstants. Saves up to 250 bytes compared to a member function. */ void sendNECSpecialRepeat() { @@ -146,6 +149,13 @@ void sendNECSpecialRepeat() { IrSender.mark(NEC_BIT_MARK); // + 560 } +/** + * Convert 16 bit address and 16 bit command to 32 bit NECRaw data + * If we get a command < 0x100, we send command and then ~command + * If we get an address < 0x100, we send 8 bit address and then ~address + * !!! Be aware, that this is flexible, but makes it impossible to send e.g. 0x0042 as 16 bit value!!! + * To force send 16 bit address, use: sendOnkyo(). + */ uint32_t IRsend::computeNECRawDataAndChecksum(uint16_t aAddress, uint16_t aCommand) { LongUnion tRawData; @@ -167,61 +177,58 @@ uint32_t IRsend::computeNECRawDataAndChecksum(uint16_t aAddress, uint16_t aComma /** * NEC Send frame and special repeats * There is NO delay after the last sent repeat! - * @param aNumberOfRepeats If < 0 then only a special repeat frame without leading and trailing space - * will be sent by calling NECProtocolConstants.SpecialSendRepeatFunction(). + * @param aNumberOfRepeats If < 0 then only a special NEC repeat frame will be sent by calling NECProtocolConstants.SpecialSendRepeatFunction(). */ -void IRsend::sendNEC(uint16_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats) { - sendPulseDistanceWidth(&NECProtocolConstants, computeNECRawDataAndChecksum(aAddress, aCommand), NEC_BITS, aNumberOfRepeats); +void IRsend::sendNEC(uint16_t aAddress, uint16_t aCommand, int_fast8_t aNumberOfRepeats) { + sendPulseDistanceWidth_P(&NECProtocolConstants, computeNECRawDataAndChecksum(aAddress, aCommand), NEC_BITS, aNumberOfRepeats); } -/* - * NEC2 Send frame and repeat the frame for each requested repeat +/** * There is NO delay after the last sent repeat! - * @param aNumberOfRepeats If < 0 then nothing is sent. + * @param aNumberOfRepeats If < 0 then only a special repeat frame without leading and trailing space + * will be sent by calling NECProtocolConstants.SpecialSendRepeatFunction(). */ -void IRsend::sendNEC2(uint16_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats) { - sendPulseDistanceWidth(&NEC2ProtocolConstants, computeNECRawDataAndChecksum(aAddress, aCommand), NEC_BITS, aNumberOfRepeats); +void IRsend::sendOnkyo(uint16_t aAddress, uint16_t aCommand, int_fast8_t aNumberOfRepeats) { + sendPulseDistanceWidth_P(&NECProtocolConstants, (uint32_t) aCommand << 16 | aAddress, NEC_BITS, aNumberOfRepeats); } -/* - * Repeat commands should be sent in a 110 ms raster. +/** + * NEC2 Send frame !!! and repeat the frame for each requested repeat !!! * There is NO delay after the last sent repeat! - * @param aNumberOfRepeats If < 0 then only a special repeat frame without leading and trailing space - * will be sent by calling NECProtocolConstants.SpecialSendRepeatFunction(). + * @param aNumberOfRepeats If < 0 then nothing is sent. */ -void IRsend::sendOnkyo(uint16_t aAddress, uint16_t aCommand, int_fast8_t aNumberOfRepeats) { - sendPulseDistanceWidth(&NECProtocolConstants, (uint32_t) aCommand << 16 | aAddress, NEC_BITS, aNumberOfRepeats); +void IRsend::sendNEC2(uint16_t aAddress, uint16_t aCommand, int_fast8_t aNumberOfRepeats) { + sendPulseDistanceWidth_P(&NEC2ProtocolConstants, computeNECRawDataAndChecksum(aAddress, aCommand), NEC_BITS, aNumberOfRepeats); } -/* - * Repeat commands should be sent in a 110 ms raster. +/** + * Apple: Send NEC with fixed 16 bit Apple address 0x87EE. * There is NO delay after the last sent repeat! * https://en.wikipedia.org/wiki/Apple_Remote * https://gist.github.com/darconeous/4437f79a34e3b6441628 - * @param aAddress is the DeviceId* * @param aNumberOfRepeats If < 0 then only a special repeat frame without leading and trailing space * will be sent by calling NECProtocolConstants.SpecialSendRepeatFunction(). */ void IRsend::sendApple(uint8_t aDeviceId, uint8_t aCommand, int_fast8_t aNumberOfRepeats) { LongUnion tRawData; - // Address 16 bit LSB first + // Address 16 bit LSB first fixed value of 0x87EE tRawData.UWord.LowWord = APPLE_ADDRESS; // send Apple code and then 8 command bits LSB first tRawData.UByte.MidHighByte = aCommand; tRawData.UByte.HighByte = aDeviceId; // e.g. 0xD7 - sendPulseDistanceWidth(&NECProtocolConstants, tRawData.ULong, NEC_BITS, aNumberOfRepeats); + sendPulseDistanceWidth_P(&NECProtocolConstants, tRawData.ULong, NEC_BITS, aNumberOfRepeats); } -/* - * Sends NEC1 protocol +/** + * Sends NEC protocol * @param aNumberOfRepeats If < 0 then only a special repeat frame without leading and trailing space * will be sent by calling NECProtocolConstants.SpecialSendRepeatFunction(). */ void IRsend::sendNECRaw(uint32_t aRawData, int_fast8_t aNumberOfRepeats) { - sendPulseDistanceWidth(&NECProtocolConstants, aRawData, NEC_BITS, aNumberOfRepeats); + sendPulseDistanceWidth_P(&NECProtocolConstants, aRawData, NEC_BITS, aNumberOfRepeats); } /** @@ -234,10 +241,10 @@ bool IRrecv::decodeNEC() { * Next try the decode */ // Check we have the right amount of data (68). The +4 is for initial gap, start bit mark and space + stop bit mark. - if (decodedIRData.rawDataPtr->rawlen != ((2 * NEC_BITS) + 4) && (decodedIRData.rawDataPtr->rawlen != 4)) { + if (decodedIRData.rawlen != ((2 * NEC_BITS) + 4) && (decodedIRData.rawlen != 4)) { IR_DEBUG_PRINT(F("NEC: ")); IR_DEBUG_PRINT(F("Data length=")); - IR_DEBUG_PRINT(decodedIRData.rawDataPtr->rawlen); + IR_DEBUG_PRINT(decodedIRData.rawlen); IR_DEBUG_PRINTLN(F(" is not 68 or 4")); return false; } @@ -248,7 +255,7 @@ bool IRrecv::decodeNEC() { } // Check for repeat - here we have another header space length - if (decodedIRData.rawDataPtr->rawlen == 4) { + if (decodedIRData.rawlen == 4) { if (matchSpace(decodedIRData.rawDataPtr->rawbuf[2], NEC_REPEAT_HEADER_SPACE) && matchMark(decodedIRData.rawDataPtr->rawbuf[3], NEC_BIT_MARK)) { decodedIRData.flags = IRDATA_FLAGS_IS_REPEAT | IRDATA_FLAGS_IS_LSB_FIRST; @@ -270,7 +277,7 @@ bool IRrecv::decodeNEC() { } // Try to decode as NEC protocol - if (!decodePulseDistanceWidthData(&NECProtocolConstants, NEC_BITS)) { + if (!decodePulseDistanceWidthData_P(&NECProtocolConstants, NEC_BITS)) { #if defined(LOCAL_DEBUG) Serial.print(F("NEC: ")); Serial.println(F("Decode failed")); @@ -283,6 +290,13 @@ bool IRrecv::decodeNEC() { LongUnion tValue; tValue.ULong = decodedIRData.decodedRawData; decodedIRData.command = tValue.UByte.MidHighByte; // 8 bit + +#if defined(DECODE_ONKYO) + // Here only Onkyo protocol is supported -> force 16 bit address and command decoding + decodedIRData.address = tValue.UWord.LowWord; // first 16 bit + decodedIRData.protocol = ONKYO; + decodedIRData.command = tValue.UWord.HighWord; // 16 bit command +#else // Address if (tValue.UWord.LowWord == APPLE_ADDRESS) { /* @@ -310,12 +324,15 @@ bool IRrecv::decodeNEC() { decodedIRData.command = tValue.UWord.HighWord; // 16 bit command } } +#endif + decodedIRData.numberOfBits = NEC_BITS; // check for NEC2 repeat, do not check for same content ;-) checkForRepeatSpaceTicksAndSetFlag(NEC_MAXIMUM_REPEAT_DISTANCE / MICROS_PER_TICK); if (decodedIRData.flags & IRDATA_FLAGS_IS_REPEAT) { decodedIRData.protocol = NEC2; + decodedIRData.flags |= IRDATA_FLAGS_IS_PROTOCOL_WITH_DIFFERENT_REPEAT; } return true; } @@ -362,7 +379,7 @@ bool IRrecv::decodeNECMSB(decode_results *aResults) { } offset++; - if (!decodePulseDistanceWidthData(NEC_BITS, offset, NEC_BIT_MARK, 0, NEC_ONE_SPACE, NEC_ZERO_SPACE, PROTOCOL_IS_MSB_FIRST)) { + if (!decodePulseDistanceWidthData(NEC_BITS, offset, NEC_BIT_MARK, NEC_ONE_SPACE, 0, PROTOCOL_IS_MSB_FIRST)) { #if defined(LOCAL_DEBUG) Serial.print(F("NEC MSB: ")); Serial.println(F("Decode failed")); @@ -391,6 +408,7 @@ bool IRrecv::decodeNECMSB(decode_results *aResults) { /** * With Send sendNECMSB() you can send your old 32 bit codes. * To convert one into the other, you must reverse the byte positions and then reverse all bit positions of each byte. + * Use bitreverse32Bit(). * Or write it as one binary string and reverse/mirror it. * Example: * 0xCB340102 byte reverse -> 02 01 34 CB bit reverse-> 40 80 2C D3. diff --git a/src/ir_Others.hpp b/src/ir_Others.hpp index 29fcf6c9d..20e4cc62c 100644 --- a/src/ir_Others.hpp +++ b/src/ir_Others.hpp @@ -58,11 +58,11 @@ #define DISH_ZERO_SPACE 2800 #define DISH_REPEAT_SPACE 6200 // really? -struct PulseDistanceWidthProtocolConstants DishProtocolConstants = { UNKNOWN, 56, DISH_HEADER_MARK, DISH_HEADER_SPACE, -DISH_BIT_MARK, DISH_ONE_SPACE, DISH_BIT_MARK, DISH_ZERO_SPACE, PROTOCOL_IS_MSB_FIRST, 40, NULL }; +struct PulseDistanceWidthProtocolConstants const DishProtocolConstants PROGMEM = { UNKNOWN, 56, DISH_HEADER_MARK, DISH_HEADER_SPACE, +DISH_BIT_MARK, DISH_ONE_SPACE, DISH_BIT_MARK, DISH_ZERO_SPACE, PROTOCOL_IS_MSB_FIRST, 40, nullptr }; void IRsend::sendDish(uint16_t aData) { - sendPulseDistanceWidth(&DishProtocolConstants, aData, DISH_BITS, 4); + sendPulseDistanceWidth_P(&DishProtocolConstants, aData, DISH_BITS, 4); } //============================================================================== @@ -84,22 +84,22 @@ void IRsend::sendDish(uint16_t aData) { #define WHYNTER_ONE_SPACE 2150 #define WHYNTER_ZERO_SPACE 750 -struct PulseDistanceWidthProtocolConstants WhynterProtocolConstants = { WHYNTER, 38, WHYNTER_HEADER_MARK, WHYNTER_HEADER_SPACE, -WHYNTER_BIT_MARK, WHYNTER_ONE_SPACE, WHYNTER_BIT_MARK, WHYNTER_ZERO_SPACE, PROTOCOL_IS_MSB_FIRST, 110, NULL }; +struct PulseDistanceWidthProtocolConstants const WhynterProtocolConstants PROGMEM = { WHYNTER, 38, WHYNTER_HEADER_MARK, WHYNTER_HEADER_SPACE, +WHYNTER_BIT_MARK, WHYNTER_ONE_SPACE, WHYNTER_BIT_MARK, WHYNTER_ZERO_SPACE, PROTOCOL_IS_MSB_FIRST, 110, nullptr }; void IRsend::sendWhynter(uint32_t aData, uint8_t aNumberOfBitsToSend) { - sendPulseDistanceWidth(&WhynterProtocolConstants, aData, NEC_BITS, aNumberOfBitsToSend); + sendPulseDistanceWidth_P(&WhynterProtocolConstants, aData, NEC_BITS, aNumberOfBitsToSend); } bool IRrecv::decodeWhynter() { // Check we have the right amount of data (68). The +4 is for initial gap, start bit mark and space + stop bit mark. - if (decodedIRData.rawDataPtr->rawlen != (2 * WHYNTER_BITS) + 4) { + if (decodedIRData.rawlen != (2 * WHYNTER_BITS) + 4) { return false; } - if (!checkHeader(&WhynterProtocolConstants)) { + if (!checkHeader_P(&WhynterProtocolConstants)) { return false; } - if (!decodePulseDistanceWidthData(&WhynterProtocolConstants, WHYNTER_BITS)) { + if (!decodePulseDistanceWidthData_P(&WhynterProtocolConstants, WHYNTER_BITS)) { return false; } // Success diff --git a/src/ir_Pronto.hpp b/src/ir_Pronto.hpp index 2a8c9bc32..5fbad18c5 100644 --- a/src/ir_Pronto.hpp +++ b/src/ir_Pronto.hpp @@ -2,6 +2,8 @@ * @file ir_Pronto.hpp * @brief In this file, the functions IRrecv::compensateAndPrintPronto and IRsend::sendPronto are defined. * + * Pronto is the standard for the professional audio and video hardware market. + * * See http://www.harctoolbox.org/Glossary.html#ProntoSemantics * Pronto database http://www.remotecentral.com/search.htm * @@ -34,7 +36,7 @@ #ifndef _IR_PRONTO_HPP #define _IR_PRONTO_HPP -#if defined(DEBUG) && !defined(LOCAL_DEBUG) +#if defined(DEBUG) #define LOCAL_DEBUG #else //#define LOCAL_DEBUG // This enables debug output only for this file @@ -174,7 +176,7 @@ void IRsend::sendPronto(const char *str, int_fast8_t aNumberOfRepeats) { void IRsend::sendPronto_PF(uint_farptr_t str, int_fast8_t aNumberOfRepeats) { size_t len = strlen_PF(str); char work[len + 1]; - strncpy_PF(work, str, len); + strcpy_PF(work, str); // We know that string including terminating character fits in work sendPronto(work, aNumberOfRepeats); } @@ -182,15 +184,18 @@ void IRsend::sendPronto_PF(uint_farptr_t str, int_fast8_t aNumberOfRepeats) { void IRsend::sendPronto_P(const char *str, int_fast8_t aNumberOfRepeats) { size_t len = strlen_P(str); char work[len + 1]; - strncpy_P(work, str, len); + strcpy_P(work, str); sendPronto(work, aNumberOfRepeats); } #endif +/* + * Copy flash data to ram buffer in stack + */ void IRsend::sendPronto(const __FlashStringHelper *str, int_fast8_t aNumberOfRepeats) { size_t len = strlen_P(reinterpret_cast(str)); char work[len + 1]; - strncpy_P(work, reinterpret_cast(str), len); + strcpy_P(work, reinterpret_cast(str)); return sendPronto(work, aNumberOfRepeats); } @@ -229,7 +234,7 @@ static void dumpDuration(Print *aSerial, uint32_t duration, uint16_t timebase) { /* * Compensate received values by MARK_EXCESS_MICROS, like it is done for decoding! */ -static void compensateAndDumpSequence(Print *aSerial, const volatile uint16_t *data, size_t length, uint16_t timebase) { +static void compensateAndDumpSequence(Print *aSerial, const volatile IRRawbufType *data, size_t length, uint16_t timebase) { for (size_t i = 0; i < length; i++) { uint32_t tDuration = data[i] * MICROS_PER_TICK; if (i & 1) { @@ -256,11 +261,11 @@ void IRrecv::compensateAndPrintIRResultAsPronto(Print *aSerial, uint16_t aFreque aSerial->print(F("char prontoData[] = \"")); dumpNumber(aSerial, aFrequencyHertz > 0 ? learnedToken : learnedNonModulatedToken); dumpNumber(aSerial, toFrequencyCode(aFrequencyHertz)); - dumpNumber(aSerial, (decodedIRData.rawDataPtr->rawlen + 1) / 2); + dumpNumber(aSerial, (decodedIRData.rawlen + 1) / 2); dumpNumber(aSerial, 0); uint16_t timebase = toTimebase(aFrequencyHertz); - compensateAndDumpSequence(aSerial, &decodedIRData.rawDataPtr->rawbuf[1], decodedIRData.rawDataPtr->rawlen - 1, timebase); // skip leading space - aSerial->println("\";"); + compensateAndDumpSequence(aSerial, &decodedIRData.rawDataPtr->rawbuf[1], decodedIRData.rawlen - 1, timebase); // skip leading space + aSerial->println(F("\";")); } /* @@ -294,7 +299,7 @@ static size_t dumpDuration(String *aString, uint32_t duration, uint16_t timebase return dumpNumber(aString, (duration + timebase / 2) / timebase); } -static size_t compensateAndDumpSequence(String *aString, const volatile uint16_t *data, size_t length, uint16_t timebase) { +static size_t compensateAndDumpSequence(String *aString, const volatile IRRawbufType *data, size_t length, uint16_t timebase) { size_t size = 0; @@ -326,9 +331,9 @@ size_t IRrecv::compensateAndStorePronto(String *aString, uint16_t frequency) { size += dumpNumber(aString, frequency > 0 ? learnedToken : learnedNonModulatedToken); size += dumpNumber(aString, toFrequencyCode(frequency)); - size += dumpNumber(aString, (decodedIRData.rawDataPtr->rawlen + 1) / 2); + size += dumpNumber(aString, (decodedIRData.rawlen + 1) / 2); size += dumpNumber(aString, 0); - size += compensateAndDumpSequence(aString, &decodedIRData.rawDataPtr->rawbuf[1], decodedIRData.rawDataPtr->rawlen - 1, + size += compensateAndDumpSequence(aString, &decodedIRData.rawDataPtr->rawbuf[1], decodedIRData.rawlen - 1, timebase); // skip leading space return size; diff --git a/src/ir_RC5_RC6.hpp b/src/ir_RC5_RC6.hpp index 594bb079a..b8eebb57a 100644 --- a/src/ir_RC5_RC6.hpp +++ b/src/ir_RC5_RC6.hpp @@ -8,6 +8,8 @@ ************************************************************************************ * MIT License * + * Copyright (c) 2020-2024 Armin Joachimsmeyer + * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights @@ -30,7 +32,7 @@ #ifndef _IR_RC5_RC6_HPP #define _IR_RC5_RC6_HPP -#if defined(DEBUG) && !defined(LOCAL_DEBUG) +#if defined(DEBUG) #define LOCAL_DEBUG #else //#define LOCAL_DEBUG // This enables debug output only for this file @@ -68,6 +70,7 @@ uint8_t sLastSendToggleValue = 1; // To start first command with toggle 0 // // see: https://www.sbprojects.net/knowledge/ir/rc5.php // https://en.wikipedia.org/wiki/Manchester_code +// https://en.wikipedia.org/wiki/RC-5 // https://forum.arduino.cc/t/sending-rc-5-extended-code-using-irsender/1045841/10 - Protocol Maranz Extended // mark->space => 0 // space->mark => 1 @@ -85,7 +88,7 @@ uint8_t sLastSendToggleValue = 1; // To start first command with toggle 0 #define RC5_UNIT 889 // 32 periods of 36 kHz (888.8888) -#define MIN_RC5_MARKS ((RC5_BITS + 1) / 2) // 7. Divided by 2 to handle the bit sequence of 01010101 which gives one mark and space for each 2 bits +#define MIN_RC5_MARKS ((RC5_BITS + 1) / 2) // 7 - Divided by 2 to handle the bit sequence of 01010101 which gives one mark and space for each 2 bits #define RC5_DURATION (15L * RC5_UNIT) // 13335 #define RC5_REPEAT_PERIOD (128L * RC5_UNIT) // 113792 @@ -160,11 +163,11 @@ bool IRrecv::decodeRC5() { initBiphaselevel(1, RC5_UNIT); // Skip gap space // Check we have the right amount of data (11 to 26). The +2 is for initial gap and start bit mark. - if (decodedIRData.rawDataPtr->rawlen < ((RC5_BITS + 1) / 2) + 2 && (RC5_BITS + 2) < decodedIRData.rawDataPtr->rawlen) { + if (decodedIRData.rawlen < ((RC5_BITS + 1) / 2) + 2 && (RC5_BITS + 2) < decodedIRData.rawlen) { // no debug output, since this check is mainly to determine the received protocol IR_DEBUG_PRINT(F("RC5: ")); IR_DEBUG_PRINT(F("Data length=")); - IR_DEBUG_PRINT(decodedIRData.rawDataPtr->rawlen); + IR_DEBUG_PRINT(decodedIRData.rawlen); IR_DEBUG_PRINTLN(F(" is not between 9 and 15")); return false; } @@ -179,7 +182,7 @@ bool IRrecv::decodeRC5() { /* * Get data bits - MSB first */ - for (tBitIndex = 0; sBiphaseDecodeRawbuffOffset < decodedIRData.rawDataPtr->rawlen; tBitIndex++) { + for (tBitIndex = 0; sBiphaseDecodeRawbuffOffset < decodedIRData.rawlen; tBitIndex++) { // get next 2 levels and check for transition uint8_t tStartLevel = getBiphaselevel(); uint8_t tEndLevel = getBiphaselevel(); @@ -243,8 +246,8 @@ bool IRrecv::decodeRC5() { + 450 Sum: 23150 */ -// Frame RC6: 1 start bit + 1 Bit "1" + 3 mode bits (000) + 1 toggle bit + 8 address + 8 command bits + 2666us pause -// Frame RC6A: 1 start bit + 1 Bit "1" + 3 mode bits (110) + 1 toggle bit + "1" + 14 customer bits + 8 system bits + 8 command bits (=31bits) + 2666us pause +// Frame RC6: 1 start bit + 1 Bit "1" + 3 mode bits (000) + 1 toggle bit + 8 address + 8 command bits + 2666us pause - 22 bits incl. start bit +// Frame RC6A: 1 start bit + 1 Bit "1" + 3 mode bits (110) + 1 toggle bit + "1" + 14 customer bits + 8 system bits + 8 command bits + 2666us pause - 37 bits incl. start bit // !!! toggle bit has another timing :-( !!! // mark->space => 1 // space->mark => 0 @@ -261,8 +264,10 @@ bool IRrecv::decodeRC5() { #define RC6_TOGGLE_BIT_INDEX RC6_MODE_BITS // fourth position, index = 3 #define RC6_ADDRESS_BITS 8 #define RC6_COMMAND_BITS 8 +#define RC6_CUSTOMER_BITS 14 #define RC6_BITS (RC6_LEADING_BIT + RC6_MODE_BITS + RC6_TOGGLE_BIT + RC6_ADDRESS_BITS + RC6_COMMAND_BITS) // 21 +#define RC6A_BITS (RC6_LEADING_BIT + RC6_MODE_BITS + RC6_TOGGLE_BIT + 1 + RC6_CUSTOMER_BITS + RC6_ADDRESS_BITS + RC6_COMMAND_BITS) // 36 #define RC6_UNIT 444 // 16 periods of 36 kHz (444.4444) @@ -388,6 +393,57 @@ void IRsend::sendRC6(uint8_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRe } } +/** + * Assemble raw data for RC6 from parameters and toggle state and send + * We do not wait for the minimal trailing space of 2666 us + * @param aEnableAutomaticToggle Send toggle bit according to the state of the static sLastSendToggleValue variable. + */ +void IRsend::sendRC6A(uint8_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats, uint16_t aCustomer, + bool aEnableAutomaticToggle) { + + LongUnion tIRRawData; + tIRRawData.UByte.LowByte = aCommand; + tIRRawData.UByte.MidLowByte = aAddress; + + tIRRawData.UWord.HighWord = aCustomer | 0x400; // bit 31 is always 1 + + if (aEnableAutomaticToggle) { + if (sLastSendToggleValue == 0) { + sLastSendToggleValue = 1; + // set toggled bit + IR_DEBUG_PRINT(F("Set Toggle ")); + tIRRawData.UByte.HighByte |= 0x80; // toggle bit is bit 32 + } else { + sLastSendToggleValue = 0; + } + } + + // Set mode bits + uint64_t tRawData = tIRRawData.ULong + 0x0600000000; + +#if defined(LOCAL_DEBUG) + Serial.print(F("RC6A: ")); + Serial.print(F("sLastSendToggleValue=")); + Serial.print (sLastSendToggleValue); + Serial.print(F(" RawData=")); + Serial.println(tIRRawData.ULong, HEX); +#endif + + uint_fast8_t tNumberOfCommands = aNumberOfRepeats + 1; + while (tNumberOfCommands > 0) { + + // start and leading bits are sent by sendRC6 + sendRC6Raw(tRawData, RC6A_BITS - 1); // -1 since the leading bit is additionally sent by sendRC6 + + tNumberOfCommands--; + // skip last delay! + if (tNumberOfCommands > 0) { + // send repeated command in a fixed raster + delay(RC6_REPEAT_DISTANCE / MICROS_IN_ONE_MILLI); + } + } +} + /** * Try to decode data as RC6 protocol */ @@ -396,10 +452,10 @@ bool IRrecv::decodeRC6() { uint32_t tDecodedRawData = 0; // Check we have the right amount of data (). The +3 for initial gap, start bit mark and space - if (decodedIRData.rawDataPtr->rawlen < MIN_RC6_MARKS + 3 && (RC6_BITS + 3) < decodedIRData.rawDataPtr->rawlen) { + if (decodedIRData.rawlen < MIN_RC6_MARKS + 3 && (RC6_BITS + 3) < decodedIRData.rawlen) { IR_DEBUG_PRINT(F("RC6: ")); IR_DEBUG_PRINT(F("Data length=")); - IR_DEBUG_PRINT(decodedIRData.rawDataPtr->rawlen); + IR_DEBUG_PRINT(decodedIRData.rawlen); IR_DEBUG_PRINTLN(F(" is not between 15 and 25")); return false; } @@ -428,7 +484,7 @@ bool IRrecv::decodeRC6() { return false; } - for (tBitIndex = 0; sBiphaseDecodeRawbuffOffset < decodedIRData.rawDataPtr->rawlen; tBitIndex++) { + for (tBitIndex = 0; sBiphaseDecodeRawbuffOffset < decodedIRData.rawlen; tBitIndex++) { uint8_t tStartLevel; // start level of coded bit uint8_t tEndLevel; // end level of coded bit @@ -482,7 +538,7 @@ bool IRrecv::decodeRC6() { tValue.ULong = tDecodedRawData; decodedIRData.decodedRawData = tDecodedRawData; - if (tBitIndex < 36) { + if (tBitIndex < 35) { // RC6 8 address bits, 8 command bits decodedIRData.flags = IRDATA_FLAGS_IS_MSB_FIRST; decodedIRData.command = tValue.UByte.LowByte; @@ -494,21 +550,23 @@ bool IRrecv::decodeRC6() { if (tBitIndex > 20) { decodedIRData.flags |= IRDATA_FLAGS_EXTRA_INFO; } + decodedIRData.protocol = RC6; + } else { - // RC6A - 32 bits - decodedIRData.flags = IRDATA_FLAGS_IS_MSB_FIRST; - if ((tValue.UByte.MidLowByte & 0x80) != 0) { - decodedIRData.flags = IRDATA_FLAGS_TOGGLE_BIT | IRDATA_FLAGS_IS_MSB_FIRST; - } - tValue.UByte.MidLowByte &= 0x87F; // mask toggle bit + // RC6A + decodedIRData.flags = IRDATA_FLAGS_IS_MSB_FIRST | IRDATA_FLAGS_EXTRA_INFO; decodedIRData.command = tValue.UByte.LowByte; decodedIRData.address = tValue.UByte.MidLowByte; + decodedIRData.extra = tValue.UWord.HighWord & 0x3FFF; // Mask to 14 bits, remove toggle and constant 1 + if ((tValue.UByte.HighByte & 0x80) != 0) { + decodedIRData.flags |= IRDATA_FLAGS_TOGGLE_BIT; + } + decodedIRData.protocol = RC6A; } // check for repeat, do not check toggle bit yet checkForRepeatSpaceTicksAndSetFlag(RC6_MAXIMUM_REPEAT_DISTANCE / MICROS_PER_TICK); - decodedIRData.protocol = RC6; return true; } diff --git a/src/ir_Samsung.hpp b/src/ir_Samsung.hpp index 681886a25..976e88078 100644 --- a/src/ir_Samsung.hpp +++ b/src/ir_Samsung.hpp @@ -8,7 +8,7 @@ ************************************************************************************ * MIT License * - * Copyright (c) 2017-2023 Darryl Smith, Armin Joachimsmeyer + * Copyright (c) 2017-2024 Darryl Smith, Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -32,7 +32,7 @@ #ifndef _IR_SAMSUNG_HPP #define _IR_SAMSUNG_HPP -#if defined(DEBUG) && !defined(LOCAL_DEBUG) +#if defined(DEBUG) #define LOCAL_DEBUG #else //#define LOCAL_DEBUG // This enables debug output only for this file @@ -63,7 +63,7 @@ Sum: 68750 */ /* - * Samsung repeat frame can be the original frame again or a special repeat frame, + * Samsung repeat frame can be the original frame again or a special short repeat frame, * then we call the protocol SamsungLG. They differ only in the handling of repeat, * so we can not decide for the first frame which protocol is used. */ @@ -72,6 +72,12 @@ // https://www.mikrocontroller.net/articles/IRMP_-_english#SAMSUNG48 // LSB first, 1 start bit + 16 bit address + 16 or 32 bit data + 1 stop bit. // Here https://forum.arduino.cc/t/klimaanlage-per-ir-steuern/1051381/10 the address (0xB24D) is also 8 bits and then 8 inverted bits +// +// Here https://github.com/flipperdevices/flipperzero-firmware/blob/master/lib/infrared/encoder_decoder/samsung/infrared_decoder_samsung.c#L18 +// Address is 8 bit + same 8 bit if command is 8 bit and ~8 bit. +// +// So we assume 8 bit address, if command is 8 bit and ~8 bit! +// // IRP notation: {38k,5553}<1,-1|1,-3>(8,-8,D:8,S:8,F:8,~F:8,1,^110)+ ==> 8 bit + 8 bit inverted data - Samsung32 // IRP notation: {38k,5553}<1,-1|1,-3>(8,-8,D:8,S:8,F:16,1,^110)+ ==> 16 bit data - still Samsung32 // IRP notation: {38k,5553}<1,-1|1,-3>(8,-8,D:8,S:8,F:8,~F:8,G:8,~G:8,1,^110)+ ==> 2 x (8 bit + 8 bit inverted data) - Samsung48 @@ -84,7 +90,7 @@ // except SAMSUNG_HEADER_MARK, values are like NEC #define SAMSUNG_UNIT 560 // 21.28 periods of 38 kHz, 11.2 ticks TICKS_LOW = 8.358 TICKS_HIGH = 15.0 -#define SAMSUNG_HEADER_MARK (8 * SAMSUNG_UNIT) // 4500 | 180 +#define SAMSUNG_HEADER_MARK (8 * SAMSUNG_UNIT) // 4500 | 180 periods #define SAMSUNG_HEADER_SPACE (8 * SAMSUNG_UNIT) // 4500 #define SAMSUNG_BIT_MARK SAMSUNG_UNIT #define SAMSUNG_ONE_SPACE (3 * SAMSUNG_UNIT) // 1690 | 33.8 TICKS_LOW = 25.07 TICKS_HIGH = 45.0 @@ -93,13 +99,16 @@ #define SAMSUNG_AVERAGE_DURATION 55000 // SAMSUNG_HEADER_MARK + SAMSUNG_HEADER_SPACE + 32 * 2,5 * SAMSUNG_UNIT + SAMSUNG_UNIT // 2.5 because we assume more zeros than ones #define SAMSUNG_REPEAT_DURATION (SAMSUNG_HEADER_MARK + SAMSUNG_HEADER_SPACE + SAMSUNG_BIT_MARK + SAMSUNG_ZERO_SPACE + SAMSUNG_BIT_MARK) #define SAMSUNG_REPEAT_PERIOD 110000 // Commands are repeated every 110 ms (measured from start to start) for as long as the key on the remote control is held down. -#define SAMSUNG_REPEAT_DISTANCE (SAMSUNG_REPEAT_PERIOD - SAMSUNG_AVERAGE_DURATION) -#define SAMSUNG_MAXIMUM_REPEAT_DISTANCE (SAMSUNG_REPEAT_DISTANCE + (SAMSUNG_REPEAT_DISTANCE / 4)) // Just a guess +#define SAMSUNG_MAXIMUM_REPEAT_DISTANCE (SAMSUNG_REPEAT_PERIOD + (SAMSUNG_REPEAT_PERIOD / 4)) // 137000 - Just a guess -struct PulseDistanceWidthProtocolConstants SamsungProtocolConstants = { SAMSUNG, SAMSUNG_KHZ, SAMSUNG_HEADER_MARK, -SAMSUNG_HEADER_SPACE, SAMSUNG_BIT_MARK, SAMSUNG_ONE_SPACE, SAMSUNG_BIT_MARK, SAMSUNG_ZERO_SPACE, PROTOCOL_IS_LSB_FIRST, - (SAMSUNG_REPEAT_PERIOD / MICROS_IN_ONE_MILLI), &sendSamsungLGSpecialRepeat }; +// 19 byte RAM +struct PulseDistanceWidthProtocolConstants const SamsungProtocolConstants PROGMEM = {SAMSUNG, SAMSUNG_KHZ, SAMSUNG_HEADER_MARK, + SAMSUNG_HEADER_SPACE, SAMSUNG_BIT_MARK, SAMSUNG_ONE_SPACE, SAMSUNG_BIT_MARK, SAMSUNG_ZERO_SPACE, PROTOCOL_IS_LSB_FIRST, + (SAMSUNG_REPEAT_PERIOD / MICROS_IN_ONE_MILLI), nullptr}; +struct PulseDistanceWidthProtocolConstants const SamsungLGProtocolConstants PROGMEM = {SAMSUNGLG, SAMSUNG_KHZ, SAMSUNG_HEADER_MARK, + SAMSUNG_HEADER_SPACE, SAMSUNG_BIT_MARK, SAMSUNG_ONE_SPACE, SAMSUNG_BIT_MARK, SAMSUNG_ZERO_SPACE, PROTOCOL_IS_LSB_FIRST, + (SAMSUNG_REPEAT_PERIOD / MICROS_IN_ONE_MILLI), &sendSamsungLGSpecialRepeat}; /************************************ * Start of send and decode functions ************************************/ @@ -119,7 +128,8 @@ void IRsend::sendSamsungLGRepeat() { } /** - * Static function for sending special repeat frame. + * Like above, but implemented as a static function + * Used for sending special repeat frame. * For use in ProtocolConstants. Saves up to 250 bytes compared to a member function. */ void sendSamsungLGSpecialRepeat() { @@ -133,6 +143,7 @@ void sendSamsungLGSpecialRepeat() { /* * Sent e.g. by an LG 6711R1P071A remote + * @param aAddress 16 bit address. If < 0x100, i.e. only 8 bit, then a (standard) 16 bit address <8_bit_address><8_bit_address> is generated. * @param aNumberOfRepeats If < 0 then only a special repeat frame will be sent */ void IRsend::sendSamsungLG(uint16_t aAddress, uint16_t aCommand, int_fast8_t aNumberOfRepeats) { @@ -144,31 +155,81 @@ void IRsend::sendSamsungLG(uint16_t aAddress, uint16_t aCommand, int_fast8_t aNu // send 16 bit address and 8 command bits and then 8 inverted command bits LSB first LongUnion tRawData; tRawData.UWord.LowWord = aAddress; + if (aAddress < 0x100) { // This disables the sending of an (non standard?) 16 bit address with upper byte = 0 like 0x0014. + tRawData.UByte.MidLowByte = aAddress; // here we have 8 bit address which must be duplicated + } tRawData.UByte.MidHighByte = aCommand; tRawData.UByte.HighByte = ~aCommand; - sendPulseDistanceWidth(&SamsungProtocolConstants, tRawData.ULong, SAMSUNG_BITS, aNumberOfRepeats); + sendPulseDistanceWidth_P(&SamsungLGProtocolConstants, tRawData.ULong, SAMSUNG_BITS, aNumberOfRepeats); } /** * Here we send Samsung32 * If we get a command < 0x100, we send command and then ~command + * If we get an address < 0x100, we send 8 bit address and then the same 8 bit address again, this makes it flipper IRDB compatible + * !!! Be aware, that this is flexible, but makes it impossible to send e.g. 0x0042 as 16 bit value!!! + * To force send 16 bit address, use: sendSamsung16BitAddressAndCommand(). + * @param aNumberOfRepeats If < 0 then only a special repeat frame will be sent */ void IRsend::sendSamsung(uint16_t aAddress, uint16_t aCommand, int_fast8_t aNumberOfRepeats) { - // send 16 bit address and 8 command bits and then 8 inverted command bits LSB first LongUnion tSendValue; - tSendValue.UWords[0] = aAddress; + if (aAddress < 0x100) { + // This makes it flipper IRDB compatible: + // https://github.com/flipperdevices/flipperzero-firmware/blob/master/lib/infrared/encoder_decoder/samsung/infrared_decoder_samsung.c#L18 + // Duplicate address byte, if address is only 8 bit + tSendValue.UBytes[1] = aAddress; + tSendValue.UBytes[0] = aAddress; + } else { + tSendValue.UWords[0] = aAddress; + } + if (aCommand < 0x100) { + // Send 8 command bits and then 8 inverted command bits LSB first tSendValue.UBytes[2] = aCommand; tSendValue.UBytes[3] = ~aCommand; + } else { + // Send 16 command bits tSendValue.UWords[1] = aCommand; } - IrSender.sendPulseDistanceWidth(&SamsungProtocolConstants, tSendValue.ULong, SAMSUNG_BITS, aNumberOfRepeats); + sendPulseDistanceWidth_P(&SamsungProtocolConstants, tSendValue.ULong, SAMSUNG_BITS, aNumberOfRepeats); +} + +/** + * Maybe no one needs it in the wild... + * As above, but we are able to send e.g. 0x0042 as 16 bit address + * @param aNumberOfRepeats If < 0 then only a special repeat frame will be sent + */ +void IRsend::sendSamsung16BitAddressAnd8BitCommand(uint16_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats) { + + LongUnion tSendValue; + // send 16 bit address + tSendValue.UWords[0] = aAddress; + // Send 8 command bits and then 8 inverted command bits LSB first + tSendValue.UBytes[2] = aCommand; + tSendValue.UBytes[3] = ~aCommand; + + sendPulseDistanceWidth_P(&SamsungProtocolConstants, tSendValue.ULong, SAMSUNG_BITS, aNumberOfRepeats); } +/** + * Maybe no one needs it in the wild... + * As above, but we are able to send e.g. 0x0042 as 16 bit address + * @param aNumberOfRepeats If < 0 then only a special repeat frame will be sent + */ +void IRsend::sendSamsung16BitAddressAndCommand(uint16_t aAddress, uint16_t aCommand, int_fast8_t aNumberOfRepeats) { + + LongUnion tSendValue; + // send 16 bit address + tSendValue.UWords[0] = aAddress; + // Send 16 command bits + tSendValue.UWords[1] = aCommand; + + sendPulseDistanceWidth_P(&SamsungProtocolConstants, tSendValue.ULong, SAMSUNG_BITS, aNumberOfRepeats); +} /** * Here we send Samsung48 * We send 2 x (8 bit command and then ~command) @@ -187,7 +248,7 @@ void IRsend::sendSamsung48(uint16_t aAddress, uint32_t aCommand, int_fast8_t aNu tRawSamsungData[1] = tUpper8BitsOfCommand | (~tUpper8BitsOfCommand) << 8; tRawSamsungData[0] = tSendValue.ULong; - IrSender.sendPulseDistanceWidthFromArray(&SamsungProtocolConstants, &tRawSamsungData[0], SAMSUNG48_BITS, aNumberOfRepeats); + sendPulseDistanceWidthFromArray_P(&SamsungProtocolConstants, &tRawSamsungData[0], SAMSUNG48_BITS, aNumberOfRepeats); #else LongLongUnion tSendValue; tSendValue.UWords[0] = aAddress; @@ -200,39 +261,44 @@ void IRsend::sendSamsung48(uint16_t aAddress, uint32_t aCommand, int_fast8_t aNu } else { tSendValue.ULongLong = aAddress | aCommand << 16; } - IrSender.sendPulseDistanceWidth(&SamsungProtocolConstants, tSendValue.ULongLong, SAMSUNG48_BITS, aNumberOfRepeats); + sendPulseDistanceWidth_P(&SamsungProtocolConstants, tSendValue.ULongLong, SAMSUNG48_BITS, aNumberOfRepeats); #endif } +/* + * We cannot decode frames with 8 command bits and then 8 inverted command bits LSB and 16 bit address, + * because in this case we always assume 8 bit address. + * This is, because we did not see 8 bit command and real 16 bit address in the wild. + */ bool IRrecv::decodeSamsung() { // Check we have enough data (68). The +4 is for initial gap, start bit mark and space + stop bit mark - if (decodedIRData.rawDataPtr->rawlen != ((2 * SAMSUNG_BITS) + 4) - && decodedIRData.rawDataPtr->rawlen != ((2 * SAMSUNG48_BITS) + 4) && (decodedIRData.rawDataPtr->rawlen != 6)) { + if (decodedIRData.rawlen != ((2 * SAMSUNG_BITS) + 4) && decodedIRData.rawlen != ((2 * SAMSUNG48_BITS) + 4) + && (decodedIRData.rawlen != 6)) { IR_DEBUG_PRINT(F("Samsung: ")); IR_DEBUG_PRINT(F("Data length=")); - IR_DEBUG_PRINT(decodedIRData.rawDataPtr->rawlen); + IR_DEBUG_PRINT(decodedIRData.rawlen); IR_DEBUG_PRINTLN(F(" is not 6 or 68 or 100")); return false; } - if (!checkHeader(&SamsungProtocolConstants)) { + if (!checkHeader_P(&SamsungProtocolConstants)) { return false; } // Check for SansungLG style repeat - if (decodedIRData.rawDataPtr->rawlen == 6) { - decodedIRData.flags = IRDATA_FLAGS_IS_REPEAT | IRDATA_FLAGS_IS_LSB_FIRST; + if (decodedIRData.rawlen == 6) { + decodedIRData.flags = IRDATA_FLAGS_IS_REPEAT | IRDATA_FLAGS_IS_PROTOCOL_WITH_DIFFERENT_REPEAT | IRDATA_FLAGS_IS_LSB_FIRST; decodedIRData.address = lastDecodedAddress; decodedIRData.command = lastDecodedCommand; - decodedIRData.protocol = SAMSUNG_LG; + decodedIRData.protocol = SAMSUNGLG; return true; } /* * Decode first 32 bits */ - if (!decodePulseDistanceWidthData(&SamsungProtocolConstants, SAMSUNG_BITS, 3)) { + if (!decodePulseDistanceWidthData_P(&SamsungProtocolConstants, SAMSUNG_BITS, 3)) { #if defined(LOCAL_DEBUG) Serial.print(F("Samsung: ")); Serial.println(F("Decode failed")); @@ -243,12 +309,12 @@ bool IRrecv::decodeSamsung() { tValue.ULong = decodedIRData.decodedRawData; decodedIRData.address = tValue.UWord.LowWord; - if (decodedIRData.rawDataPtr->rawlen == (2 * SAMSUNG48_BITS) + 4) { + if (decodedIRData.rawlen == (2 * SAMSUNG48_BITS) + 4) { /* * Samsung48 */ // decode additional 16 bit - if (!decodePulseDistanceWidthData(&SamsungProtocolConstants, (SAMSUNG_COMMAND32_BITS - SAMSUNG_COMMAND16_BITS), + if (!decodePulseDistanceWidthData_P(&SamsungProtocolConstants, (SAMSUNG_COMMAND32_BITS - SAMSUNG_COMMAND16_BITS), 3 + (2 * SAMSUNG_BITS))) { #if defined(LOCAL_DEBUG) Serial.print(F("Samsung: ")); @@ -285,12 +351,17 @@ bool IRrecv::decodeSamsung() { * Samsung32 */ if (tValue.UByte.MidHighByte == (uint8_t)(~tValue.UByte.HighByte)) { - // 8 bit command protocol + // 8 bit command protocol -> assume 8 bit address decodedIRData.command = tValue.UByte.MidHighByte; // first 8 bit + } + + if (tValue.UByte.MidLowByte == tValue.UByte.LowByte) { + decodedIRData.address = tValue.UByte.LowByte; // assume LowByte == MidLowByte as seen for a LG HX906 A/V Receive E8172C2C } else { - // 16 bit command protocol + // 16 bit command protocol, address is filled above with the 16 bit value decodedIRData.command = tValue.UWord.HighWord; // first 16 bit } + decodedIRData.numberOfBits = SAMSUNG_BITS; decodedIRData.protocol = SAMSUNG; } @@ -330,8 +401,7 @@ bool IRrecv::decodeSAMSUNG(decode_results *aResults) { } offset++; - if (!decodePulseDistanceWidthData(SAMSUNG_BITS, offset, SAMSUNG_BIT_MARK, 0, SAMSUNG_ONE_SPACE, SAMSUNG_ZERO_SPACE, - PROTOCOL_IS_MSB_FIRST)) { + if (!decodePulseDistanceWidthData(SAMSUNG_BITS, offset, SAMSUNG_BIT_MARK, SAMSUNG_ONE_SPACE, 0, PROTOCOL_IS_MSB_FIRST)) { return false; } @@ -344,7 +414,7 @@ bool IRrecv::decodeSAMSUNG(decode_results *aResults) { } // Old version with MSB first -void IRsend::sendSAMSUNG(unsigned long data, int nbits) { +void IRsend::sendSamsungMSB(unsigned long data, int nbits) { // Set IR carrier frequency enableIROut (SAMSUNG_KHZ); @@ -356,6 +426,9 @@ void IRsend::sendSAMSUNG(unsigned long data, int nbits) { sendPulseDistanceWidthData(SAMSUNG_BIT_MARK, SAMSUNG_ONE_SPACE, SAMSUNG_BIT_MARK, SAMSUNG_ZERO_SPACE, data, nbits, PROTOCOL_IS_MSB_FIRST); } +void IRsend::sendSAMSUNG(unsigned long data, int nbits) { + sendSamsungMSB(data, nbits); +} /** @}*/ #if defined(LOCAL_DEBUG) diff --git a/src/ir_Sony.hpp b/src/ir_Sony.hpp index 591d58dcc..bcb9eb9d2 100644 --- a/src/ir_Sony.hpp +++ b/src/ir_Sony.hpp @@ -30,7 +30,7 @@ #ifndef _IR_SONY_HPP #define _IR_SONY_HPP -#if defined(DEBUG) && !defined(LOCAL_DEBUG) +#if defined(DEBUG) #define LOCAL_DEBUG #else //#define LOCAL_DEBUG // This enables debug output only for this file @@ -52,7 +52,7 @@ // 7 command bits +1300,- 450 +1350,- 450 +1300,- 450 + 700,- 450 + 700,- 450 + 750,- 450 + 700,- 400 - // (5,8,) 13 address bits + // (5,8,) 13 address bits and NO stop bit! +1300,- 500 + 700,- 450 + 700,- 450 +1300,- 500 +1300,- 450 +1300,- 450 + 700,- 450 +1350,- 400 + 750,- 450 @@ -90,8 +90,8 @@ #define SONY_REPEAT_PERIOD 45000 // Commands are repeated every 45 ms (measured from start to start) for as long as the key on the remote control is held down. #define SONY_MAXIMUM_REPEAT_DISTANCE (SONY_REPEAT_PERIOD - SONY_AVERAGE_DURATION_MIN) // 24 ms -struct PulseDistanceWidthProtocolConstants SonyProtocolConstants = { SONY, SONY_KHZ, SONY_HEADER_MARK, SONY_SPACE, SONY_ONE_MARK, -SONY_SPACE, SONY_ZERO_MARK, SONY_SPACE, PROTOCOL_IS_LSB_FIRST, (SONY_REPEAT_PERIOD / MICROS_IN_ONE_MILLI), NULL }; +struct PulseDistanceWidthProtocolConstants const SonyProtocolConstants PROGMEM = { SONY, SONY_KHZ, SONY_HEADER_MARK, SONY_SPACE, SONY_ONE_MARK, +SONY_SPACE, SONY_ZERO_MARK, SONY_SPACE, PROTOCOL_IS_LSB_FIRST, (SONY_REPEAT_PERIOD / MICROS_IN_ONE_MILLI), nullptr }; /************************************ * Start of send and decode functions @@ -103,26 +103,26 @@ SONY_SPACE, SONY_ZERO_MARK, SONY_SPACE, PROTOCOL_IS_LSB_FIRST, (SONY_REPEAT_PERI void IRsend::sendSony(uint16_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats, uint8_t numberOfBits) { uint32_t tData = (uint32_t) aAddress << 7 | (aCommand & 0x7F); // send 5, 8, 13 address bits LSB first - sendPulseDistanceWidth(&SonyProtocolConstants, tData, numberOfBits, aNumberOfRepeats); + sendPulseDistanceWidth_P(&SonyProtocolConstants, tData, numberOfBits, aNumberOfRepeats); } bool IRrecv::decodeSony() { - if (!checkHeader(&SonyProtocolConstants)) { + if (!checkHeader_P(&SonyProtocolConstants)) { return false; } // Check we have enough data. +2 for initial gap and start bit mark and space minus the last/MSB space. NO stop bit! 26, 32, 42 - if (decodedIRData.rawDataPtr->rawlen != (2 * SONY_BITS_MIN) + 2 && decodedIRData.rawDataPtr->rawlen != (2 * SONY_BITS_MAX) + 2 - && decodedIRData.rawDataPtr->rawlen != (2 * SONY_BITS_15) + 2) { + if (decodedIRData.rawlen != (2 * SONY_BITS_MIN) + 2 && decodedIRData.rawlen != (2 * SONY_BITS_MAX) + 2 + && decodedIRData.rawlen != (2 * SONY_BITS_15) + 2) { IR_DEBUG_PRINT(F("Sony: ")); IR_DEBUG_PRINT(F("Data length=")); - IR_DEBUG_PRINT(decodedIRData.rawDataPtr->rawlen); + IR_DEBUG_PRINT(decodedIRData.rawlen); IR_DEBUG_PRINTLN(F(" is not 12, 15 or 20")); return false; } - if (!decodePulseDistanceWidthData(&SonyProtocolConstants, (decodedIRData.rawDataPtr->rawlen - 1) / 2, 3)) { + if (!decodePulseDistanceWidthData_P(&SonyProtocolConstants, (decodedIRData.rawlen - 1) / 2, 3)) { #if defined(LOCAL_DEBUG) Serial.print(F("Sony: ")); Serial.println(F("Decode failed")); @@ -134,7 +134,7 @@ bool IRrecv::decodeSony() { // decodedIRData.flags = IRDATA_FLAGS_IS_LSB_FIRST; // Not required, since this is the start value decodedIRData.command = decodedIRData.decodedRawData & 0x7F; // first 7 bits decodedIRData.address = decodedIRData.decodedRawData >> 7; // next 5 or 8 or 13 bits - decodedIRData.numberOfBits = (decodedIRData.rawDataPtr->rawlen - 1) / 2; + decodedIRData.numberOfBits = (decodedIRData.rawlen - 1) / 2; decodedIRData.protocol = SONY; //Check for repeat @@ -213,7 +213,7 @@ bool IRrecv::decodeSonyMSB(decode_results *aResults) { /** * Old version with MSB first data */ -void IRsend::sendSony(unsigned long data, int nbits) { +void IRsend::sendSonyMSB(unsigned long data, int nbits) { // Set IR carrier frequency enableIROut (SONY_KHZ); @@ -224,6 +224,9 @@ void IRsend::sendSony(unsigned long data, int nbits) { // Old version with MSB first Data sendPulseDistanceWidthData(SONY_ONE_MARK, SONY_SPACE, SONY_ZERO_MARK, SONY_SPACE, data, nbits, PROTOCOL_IS_MSB_FIRST); } +void IRsend::sendSony(unsigned long data, int nbits) { + sendSonyMSB(data, nbits); +} /** @}*/ #if defined(LOCAL_DEBUG) diff --git a/src/ir_Template.hpp b/src/ir_Template.hpp index 9855f51a3..ce1dab069 100644 --- a/src/ir_Template.hpp +++ b/src/ir_Template.hpp @@ -123,9 +123,9 @@ #define SHUZU_OTHER 1234 // Other things you may need to define // use BOSEWAVE, we have no SHUZU code -struct PulseDistanceWidthProtocolConstants ShuzuProtocolConstants = { BOSEWAVE, 38, SHUZU_HEADER_MARK, SHUZU_HEADER_SPACE, -SHUZU_BIT_MARK, SHUZU_ONE_SPACE, SHUZU_BIT_MARK, SHUZU_ZERO_SPACE, PROTOCOL_IS_LSB_FIRST, (SHUZU_REPEAT_PERIOD - / MICROS_IN_ONE_MILLI), NULL }; +struct PulseDistanceWidthProtocolConstants const ShuzuProtocolConstants PROGMEM = {BOSEWAVE, 38, SHUZU_HEADER_MARK, SHUZU_HEADER_SPACE, + SHUZU_BIT_MARK, SHUZU_ONE_SPACE, SHUZU_BIT_MARK, SHUZU_ZERO_SPACE, PROTOCOL_IS_LSB_FIRST, (SHUZU_REPEAT_PERIOD + / MICROS_IN_ONE_MILLI), nullptr}; /************************************ * Start of send and decode functions @@ -133,7 +133,7 @@ SHUZU_BIT_MARK, SHUZU_ONE_SPACE, SHUZU_BIT_MARK, SHUZU_ZERO_SPACE, PROTOCOL_IS_L void IRsend::sendShuzu(uint16_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats) { - sendPulseDistanceWidth(&ShuzuProtocolConstants, (uint32_t) aCommand << 8 | aCommand, SHUZU_BITS, aNumberOfRepeats); + sendPulseDistanceWidth_P(&ShuzuProtocolConstants, (uint32_t) aCommand << 8 | aCommand, SHUZU_BITS, aNumberOfRepeats); } bool IRrecv::decodeShuzu() { @@ -149,12 +149,12 @@ bool IRrecv::decodeShuzu() { } // Check header - if (!checkHeader(&ShuzuProtocolConstants)) { + if (!checkHeader_P(&ShuzuProtocolConstants)) { return false; } // Decode - if (!decodePulseDistanceData(&ShuzuProtocolConstants, SHUZU_BITS)) { + if (!decodePulseDistanceData_P(&ShuzuProtocolConstants, SHUZU_BITS)) { IR_DEBUG_PRINT(F("Shuzu: ")); IR_DEBUG_PRINTLN(F("Decode failed")); return false; diff --git a/src/private/IRTimer.hpp b/src/private/IRTimer.hpp index 4e794d934..872c4eddf 100644 --- a/src/private/IRTimer.hpp +++ b/src/private/IRTimer.hpp @@ -11,7 +11,7 @@ ************************************************************************************* * MIT License * - * Copyright (c) 2021-2022 Armin Joachimsmeyer + * Copyright (c) 2021-2023 Armin Joachimsmeyer * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -44,20 +44,23 @@ /* * Functions declared here */ -void timerResetInterruptPending(); -void timerEnableReceiveInterrupt(); -void timerDisableReceiveInterrupt(); -void timerConfigForReceive(); -void enableSendPWMByTimer(); -void disableSendPWMByTimer(); -void timerConfigForSend(uint8_t aFrequencyKHz); - -#if defined(SEND_PWM_BY_TIMER) && ( (defined(ESP32) || defined(ARDUINO_ARCH_RP2040) || defined(PARTICLE)) || defined(ARDUINO_ARCH_MBED) ) -#define SEND_PWM_DOES_NOT_USE_RECEIVE_TIMER // Receive timer and send generation are independent, so it is recommended to always define SEND_PWM_BY_TIMER +void timerConfigForReceive(); // Initialization of 50 us timer, interrupts are still disabled +void timerEnableReceiveInterrupt(); // Enable interrupts of an initialized timer +void timerDisableReceiveInterrupt(); // Disable interrupts of an initialized timer +void timerResetInterruptPending(); // ISR helper function for some architectures, which require a manual reset +// of the pending interrupt (TIMER_REQUIRES_RESET_INTR_PENDING is defined). Otherwise empty. + +void timerConfigForSend(uint16_t aFrequencyKHz); // Initialization of timer hardware generated PWM, if defined(SEND_PWM_BY_TIMER) +void enableSendPWMByTimer(); // Switch on PWM generation +void disableSendPWMByTimer(); // Switch off PWM generation + +// SEND_PWM_BY_TIMER for different architectures is enabled / defined at IRremote.hpp line 195. +#if defined(SEND_PWM_BY_TIMER) && ( (defined(ESP32) || defined(ARDUINO_ARCH_RP2040) || defined(PARTICLE)) || defined(ARDUINO_ARCH_MBED) ) +#define SEND_PWM_DOES_NOT_USE_RECEIVE_TIMER // Receive timer and send generation timer are independent here. #endif -#if defined(IR_SEND_PIN) && defined(SEND_PWM_BY_TIMER) && !defined(SEND_PWM_DOES_NOT_USE_RECEIVE_TIMER) // For e.g ESP32 IR_SEND_PIN definition is useful -#undef IR_SEND_PIN // avoid warning below, user warning is done at IRremote.hpp +#if defined(IR_SEND_PIN) && defined(SEND_PWM_BY_TIMER) && !defined(SEND_PWM_DOES_NOT_USE_RECEIVE_TIMER) // For ESP32 etc. IR_SEND_PIN definition is useful +#undef IR_SEND_PIN // To avoid "warning: "IR_SEND_PIN" redefined". The user warning is done at IRremote.hpp line 202. #endif // Macros for enabling timers for development @@ -85,6 +88,7 @@ void timerConfigForSend(uint8_t aFrequencyKHz); //#define __STM32F1__ //#define STM32F1xx //#define PARTICLE +//#define ARDUINO_ARCH_RENESAS #if defined (DOXYGEN) /** @@ -122,7 +126,7 @@ void timerDisableReceiveInterrupt() { * timerConfigForSend() is used exclusively by IRsend::enableIROut(). * @param aFrequencyKHz Frequency of the sent PWM signal in kHz. There is no practical reason to have a sub kHz resolution for sending frequency :-). */ -void timerConfigForSend(uint8_t aFrequencyKHz) { +void timerConfigForSend(uint16_t aFrequencyKHz) { } /** @@ -179,7 +183,7 @@ void disableSendPWMByTimer() { #elif defined(__AVR_ATtiny816__) || defined(__AVR_ATtiny1614__) || defined(__AVR_ATtiny1616__) || defined(__AVR_ATtiny3216__) || defined(__AVR_ATtiny3217__) // e.g. TinyCore boards # if !defined(IR_USE_AVR_TIMER_A) && !defined(IR_USE_AVR_TIMER_D) -#define IR_USE_AVR_TIMER_A // use this if you use MegaTinyCore, Tone is on TCB and millis() on TCD +#define IR_USE_AVR_TIMER_A // use this if you use megaTinyCore, Tone is on TCB and millis() on TCD //#define IR_USE_AVR_TIMER_D // use this if you use TinyCore # endif @@ -192,7 +196,7 @@ void disableSendPWMByTimer() { // ATtiny84 #elif defined(__AVR_ATtiny84__) || defined(__AVR_ATtiny88__) # if !defined(IR_USE_AVR_TIMER1) -#define IR_USE_AVR_TIMER1 // send pin = pin 6 +#define IR_USE_AVR_TIMER1 // send pin = pin 6, no tone() available when using ATTinyCore # endif #elif defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__) @@ -407,7 +411,8 @@ void disableSendPWMByTimer() { # else # if defined(USE_TIMER_CHANNEL_B) void enableSendPWMByTimer() { - TCNT1 = 0; (TCCR1A |= _BV(COM1B1)) // Clear OC1A/OC1B on Compare Match when up-counting. Set OC1A/OC1B on Compare Match when downcounting. + TCNT1 = 0; + TCCR1A |= _BV(COM1B1); // Clear OC1A/OC1B on Compare Match when up-counting. Set OC1A/OC1B on Compare Match when counting down. } void disableSendPWMByTimer() { TCCR1A &= ~(_BV(COM1B1)); @@ -427,7 +432,7 @@ void disableSendPWMByTimer() { * timerConfigForSend() is used exclusively by IRsend::enableIROut() * Set output pin mode and disable receive interrupt if it uses the same resource */ -void timerConfigForSend(uint8_t aFrequencyKHz) { +void timerConfigForSend(uint16_t aFrequencyKHz) { timerDisableReceiveInterrupt(); # if (((F_CPU / 2000) / 38) < 256) @@ -457,7 +462,7 @@ void timerConfigForSend(uint8_t aFrequencyKHz) { # endif // defined(SEND_PWM_BY_TIMER) /* - * AVR Timer2 (8 bits) // Tone timer on UNO + * AVR Timer2 (8 bits) // Tone timer on Uno */ #elif defined(IR_USE_AVR_TIMER2) @@ -517,14 +522,19 @@ void disableSendPWMByTimer() { * timerConfigForSend() is used exclusively by IRsend::enableIROut() * Set output pin mode and disable receive interrupt if it uses the same resource */ -void timerConfigForSend(uint8_t aFrequencyKHz) { +void timerConfigForSend(uint16_t aFrequencyKHz) { timerDisableReceiveInterrupt(); # if (((F_CPU / 2000) / 38) < 256) - const uint16_t tPWMWrapValue = (F_CPU / 2000) / (aFrequencyKHz); // 210,52 for 38 kHz @16 MHz clock, 2000 instead of 1000 because of Phase Correct PWM + /* + * tPWMWrapValue is 210.52 for 38 kHz, 17.58 for 455 kHz @16 MHz clock. + * 210 -> 38.095 kHz, 17 -> 470.588 kHz @16 MHz clock. + * We use 2000 instead of 1000 in the formula, because of Phase Correct PWM. + */ + const uint16_t tPWMWrapValue = (F_CPU / 2000) / (aFrequencyKHz); TCCR2A = _BV(WGM20); // PWM, Phase Correct, Top is OCR2A TCCR2B = _BV(WGM22) | _BV(CS20); // CS20 -> no prescaling - OCR2A = tPWMWrapValue - 1; // The top value for the timer. The modulation frequency will be F_CPU / 2 / OCR2A. + OCR2A = tPWMWrapValue - 1; // The top value for the timer. The modulation frequency will be F_CPU / 2 / (OCR2A + 1). OCR2B = ((tPWMWrapValue * IR_SEND_DUTY_CYCLE_PERCENT) / 100) - 1; TCNT2 = 0; // not really required, since we have an 8 bit counter, but makes the signal more reproducible # else @@ -586,7 +596,7 @@ void disableSendPWMByTimer() { * timerConfigForSend() is used exclusively by IRsend::enableIROut() * Set output pin mode and disable receive interrupt if it uses the same resource */ -void timerConfigForSend(uint8_t aFrequencyKHz) { +void timerConfigForSend(uint16_t aFrequencyKHz) { #if F_CPU > 16000000 #error "Creating timer PWM with timer 3 is not supported for F_CPU > 16 MHz" #endif @@ -637,7 +647,7 @@ void disableSendPWMByTimer() { TCCR4A &= ~(_BV(COM4A1)); } -void timerConfigForSend(uint8_t aFrequencyKHz) { +void timerConfigForSend(uint16_t aFrequencyKHz) { #if F_CPU > 16000000 #error "Creating timer PWM with timer 4 is not supported for F_CPU > 16 MHz" #endif @@ -688,8 +698,13 @@ void timerConfigForReceive() { # endif # if defined(ARDUINO_AVR_PROMICRO) // Sparkfun Pro Micro -void enableSendPWMByTimer() { TCNT4 = 0; (TCCR4A |= _BV(COM4A0)) // Use complementary OC4A output on pin 5 -void disableSendPWMByTimer() { (TCCR4A &= ~(_BV(COM4A0))) // (Pro Micro does not map PC7 (32/ICP3/CLK0/OC4A) +void enableSendPWMByTimer() { + TCNT4 = 0; + TCCR4A |= _BV(COM4A0); // Use complementary OC4A output on pin 5 +} +void disableSendPWMByTimer() { + TCCR4A &= ~(_BV(COM4A0)); // (Pro Micro does not map PC7 (32/ICP3/CLK0/OC4A) +} // of ATmega32U4 ) # else void enableSendPWMByTimer() { @@ -706,7 +721,7 @@ void disableSendPWMByTimer() { * timerConfigForSend() is used exclusively by IRsend::enableIROut() * Set output pin mode and disable receive interrupt if it uses the same resource */ -void timerConfigForSend(uint8_t aFrequencyKHz) { +void timerConfigForSend(uint16_t aFrequencyKHz) { #if F_CPU > 16000000 #error "Creating timer PWM with timer 4 HS is not supported for F_CPU > 16 MHz" #endif @@ -767,7 +782,7 @@ void disableSendPWMByTimer() { * timerConfigForSend() is used exclusively by IRsend::enableIROut() * Set output pin mode and disable receive interrupt if it uses the same resource */ -void timerConfigForSend(uint8_t aFrequencyKHz) { +void timerConfigForSend(uint16_t aFrequencyKHz) { #if F_CPU > 16000000 #error "Creating timer PWM with timer 5 is not supported for F_CPU > 16 MHz" #endif @@ -826,7 +841,7 @@ void disableSendPWMByTimer() { * timerConfigForSend() is used exclusively by IRsend::enableIROut() * Set output pin mode and disable receive interrupt if it uses the same resource */ -void timerConfigForSend(uint8_t aFrequencyKHz) { +void timerConfigForSend(uint16_t aFrequencyKHz) { #if F_CPU > 16000000 #error "Creating timer PWM with timer TINY0 is not supported for F_CPU > 16 MHz" #endif @@ -885,7 +900,7 @@ void disableSendPWMByTimer() { * timerConfigForSend() is used exclusively by IRsend::enableIROut() * Set output pin mode and disable receive interrupt if it uses the same resource */ -void timerConfigForSend(uint8_t aFrequencyKHz) { +void timerConfigForSend(uint16_t aFrequencyKHz) { timerDisableReceiveInterrupt(); # if (((F_CPU / 1000) / 38) < 256) @@ -981,7 +996,7 @@ void disableSendPWMByTimer() { * timerConfigForSend() is used exclusively by IRsend::enableIROut() * Set output pin mode and disable receive interrupt if it uses the same resource */ -void timerConfigForSend(uint8_t aFrequencyKHz) { +void timerConfigForSend(uint16_t aFrequencyKHz) { #if F_CPU > 16000000 // we have only prescaler 2 or must take clock of timer A (which is non deterministic) #error "Creating timer PWM with timer TCB0 is not possible for F_CPU > 16 MHz" @@ -1050,7 +1065,7 @@ void disableSendPWMByTimer() { * timerConfigForSend() is used exclusively by IRsend::enableIROut() * Set output pin mode and disable receive interrupt if it uses the same resource */ -void timerConfigForSend(uint8_t aFrequencyKHz) { +void timerConfigForSend(uint16_t aFrequencyKHz) { timerDisableReceiveInterrupt(); const uint16_t tPWMWrapValue = (F_CPU / 1000) / (aFrequencyKHz); // 526,31 for 38 kHz @20 MHz clock @@ -1079,6 +1094,67 @@ void timerConfigForSend(uint8_t aFrequencyKHz) { * End of AVR timers **********************************************************************************************************************/ +/********************************************** + * Uno R4 boards + **********************************************/ +#elif defined(ARDUINO_ARCH_RENESAS) +#include "FspTimer.h" +FspTimer s50usTimer; + +// Undefine ISR, because we register/call the plain function IRReceiveTimerInterruptHandler() +# if defined(ISR) +#undef ISR +# endif + +// callback method used by timer +void IRTimerInterruptHandlerHelper(timer_callback_args_t __attribute((unused)) *p_args) { + IRReceiveTimerInterruptHandler(); +} +void timerEnableReceiveInterrupt() { +// s50usTimer.enable_overflow_irq(); + s50usTimer.start(); +} +void timerDisableReceiveInterrupt() { +// s50usTimer.disable_overflow_irq(); + s50usTimer.stop(); // May save power +} + +void timerConfigForReceive() { + uint8_t tTimerType = GPT_TIMER; + int8_t tIndex = FspTimer::get_available_timer(tTimerType); // Get first unused channel. Here we need the address of tTimerType + if (tIndex < 0 || tTimerType != GPT_TIMER) { + // here we found no unused GPT channel + tIndex = FspTimer::get_available_timer(tTimerType, true); // true to force use of already used PWM channel. Sets "force_pwm_reserved" if timer found + if (tIndex < 0) { + // If we already get an tIndex < 0 we have an error, but do not know how to handle :-( + return; + } + } + s50usTimer.begin(TIMER_MODE_PERIODIC, tTimerType, tIndex, MICROS_IN_ONE_SECOND / MICROS_PER_TICK, 0.0, + IRTimerInterruptHandlerHelper); + s50usTimer.setup_overflow_irq(); + s50usTimer.open(); // In turn calls R_GPT_Enable() + s50usTimer.stop(); // May save power +} + +# if defined(SEND_PWM_BY_TIMER) +#error PWM generation by hardware not yet implemented for Arduino Uno R4 +// Not yet implemented +void enableSendPWMByTimer() { +} +void disableSendPWMByTimer() { +} + +/* + * timerConfigForSend() is used exclusively by IRsend::enableIROut() + */ +void timerConfigForSend(uint16_t aFrequencyKHz) { +# if defined(IR_SEND_PIN) +# else +# endif +} +# endif + /********************************************** * Teensy 3.0 / Teensy 3.1 / Teensy 3.2 boards **********************************************/ @@ -1140,7 +1216,7 @@ void disableSendPWMByTimer() { * timerConfigForSend() is used exclusively by IRsend::enableIROut() * Set output pin mode and disable receive interrupt if it uses the same resource */ -void timerConfigForSend(uint8_t aFrequencyKHz) { +void timerConfigForSend(uint16_t aFrequencyKHz) { timerDisableReceiveInterrupt(); // TODO really required here? Do we have a common resource for Teensy3.0, 3.1 # if defined(IR_SEND_PIN) pinMode(IR_SEND_PIN, OUTPUT); @@ -1209,7 +1285,7 @@ void disableSendPWMByTimer() { * timerConfigForSend() is used exclusively by IRsend::enableIROut() * Set output pin mode and disable receive interrupt if it uses the same resource */ -void timerConfigForSend(uint8_t aFrequencyKHz) { +void timerConfigForSend(uint16_t aFrequencyKHz) { timerDisableReceiveInterrupt(); # if defined(IR_SEND_PIN) pinMode(IR_SEND_PIN, OUTPUT); @@ -1230,6 +1306,8 @@ void timerConfigForSend(uint8_t aFrequencyKHz) { * Teensy 4.0, 4.1, MicroMod boards ***************************************/ #elif defined(__IMXRT1062__) +// forward declare ISR function (will be implemented by IRReceive.hpp) +void pwm1_3_isr(); // defines for FlexPWM1 timer on Teensy 4 #define TIMER_REQUIRES_RESET_INTR_PENDING @@ -1250,7 +1328,6 @@ void timerDisableReceiveInterrupt() { #undef ISR # endif #define ISR(f) void (f)(void) -void pwm1_3_isr(); void timerConfigForReceive() { uint32_t period = (float) F_BUS_ACTUAL * (float) (MICROS_PER_TICK) * 0.0000005f; @@ -1291,7 +1368,7 @@ void disableSendPWMByTimer() { * timerConfigForSend() is used exclusively by IRsend::enableIROut() * Set output pin mode and disable receive interrupt if it uses the same resource */ -void timerConfigForSend(uint8_t aFrequencyKHz) { +void timerConfigForSend(uint16_t aFrequencyKHz) { timerDisableReceiveInterrupt(); # if defined(IR_SEND_PIN) pinMode(IR_SEND_PIN, OUTPUT); @@ -1322,6 +1399,9 @@ void timerConfigForSend(uint8_t aFrequencyKHz) { } # endif // defined(SEND_PWM_BY_TIMER) +/********************************************************** + * ESP8266 boards + **********************************************************/ #elif defined(ESP8266) # if defined(SEND_PWM_BY_TIMER) #error "No support for hardware PWM generation for ESP8266" @@ -1336,7 +1416,7 @@ void timerEnableReceiveInterrupt() { timer1_attachInterrupt(&IRReceiveTimerInterruptHandler); // enables interrupt too } void timerDisableReceiveInterrupt() { - timer1_detachInterrupt(); // disables interrupt too } + timer1_detachInterrupt(); // disables interrupt too } void timerConfigForReceive() { @@ -1356,65 +1436,137 @@ void timerConfigForReceive() { * so it is recommended to always define SEND_PWM_BY_TIMER **********************************************************/ #elif defined(ESP32) +# if !defined(ESP_ARDUINO_VERSION) +#define ESP_ARDUINO_VERSION 0x010101 // Version 1.1.1 +# endif +# if !defined(ESP_ARDUINO_VERSION_VAL) +#define ESP_ARDUINO_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) +# endif + // Variables specific to the ESP32. // the ledc functions behave like hardware timers for us :-), so we do not require our own soft PWM generation code. -hw_timer_t *s50usTimer; // set by timerConfigForReceive() +hw_timer_t *s50usTimer = nullptr; // set by timerConfigForReceive() - -# if !defined(SEND_AND_RECEIVE_TIMER_LEDC_CHANNEL) -#define SEND_AND_RECEIVE_TIMER_LEDC_CHANNEL 0 // The channel used for PWM 0 to 7 are high speed PWM channels +# if ESP_ARDUINO_VERSION < ESP_ARDUINO_VERSION_VAL(3, 0, 0) && !defined(SEND_LEDC_CHANNEL) +#define SEND_LEDC_CHANNEL 0 // The channel used for PWM 0 to 7 are high speed PWM channels # endif void timerEnableReceiveInterrupt() { - timerAlarmEnable (s50usTimer); +# if ESP_ARDUINO_VERSION >= ESP_ARDUINO_VERSION_VAL(3, 0, 0) + timerStart(s50usTimer); +# else + timerAlarmEnable(s50usTimer); +# endif } -#if ESP_ARDUINO_VERSION < ESP_ARDUINO_VERSION_VAL(2, 0, 2) + +# if ESP_ARDUINO_VERSION < ESP_ARDUINO_VERSION_VAL(2, 0, 2) +/* + * Special support for ESP core < 202 + */ void timerDisableReceiveInterrupt() { - if (s50usTimer != NULL) { - timerEnd(s50usTimer); + if (s50usTimer != nullptr) { timerDetachInterrupt(s50usTimer); + timerEnd(s50usTimer); } } -#else +# else + void timerDisableReceiveInterrupt() { - if (s50usTimer != NULL) { - timerAlarmDisable (s50usTimer); + if (s50usTimer != nullptr) { +# if ESP_ARDUINO_VERSION >= ESP_ARDUINO_VERSION_VAL(3, 0, 0) + timerStop(s50usTimer); +# else + timerAlarmDisable(s50usTimer); +# endif } } -#endif +# endif + // Undefine ISR, because we register/call the plain function IRReceiveTimerInterruptHandler() # if defined(ISR) #undef ISR # endif +# if !defined(DISABLE_CODE_FOR_RECEIVER) // Otherwise the &IRReceiveTimerInterruptHandler is referenced, but not available void timerConfigForReceive() { // ESP32 has a proper API to setup timers, no weird chip macros needed // simply call the readable API versions :) // 3 timers, choose #1, 80 divider for microsecond precision @80MHz clock, count_up = true - s50usTimer = timerBegin(1, 80, true); - timerAttachInterrupt(s50usTimer, &IRReceiveTimerInterruptHandler, false); // false -> level interrupt, true -> edge interrupt, but this is not supported :-( + if(s50usTimer == nullptr) { +# if ESP_ARDUINO_VERSION >= ESP_ARDUINO_VERSION_VAL(3, 0, 0) + s50usTimer = timerBegin(1000000); // Only 1 parameter is required. 1000000 corresponds to 1 MHz / 1 uSec. After successful setup the timer will automatically start. + timerStop(s50usTimer); // Stop it here, to avoid "error E (3447) gptimer: gptimer_start(348): timer is not enabled yet" at timerEnableReceiveInterrupt() + timerAttachInterrupt(s50usTimer, &IRReceiveTimerInterruptHandler); + timerAlarm(s50usTimer, MICROS_PER_TICK, true, 0); // 0 in the last parameter is repeat forever +# else + s50usTimer = timerBegin(1, 80, true); + timerAttachInterrupt(s50usTimer, &IRReceiveTimerInterruptHandler, false); // false -> level interrupt, true -> edge interrupt, but this is not supported :-( + timerAlarmWrite(s50usTimer, MICROS_PER_TICK, true); +# endif + } // every 50 us, autoreload = true - timerAlarmWrite(s50usTimer, MICROS_PER_TICK, true); } +# endif + + +uint8_t sLastSendPin = 0; // Avoid multiple attach() or if pin changes, detach before attach # if defined(SEND_PWM_BY_TIMER) void enableSendPWMByTimer() { - ledcWrite(SEND_AND_RECEIVE_TIMER_LEDC_CHANNEL, (IR_SEND_DUTY_CYCLE_PERCENT * 256) / 100); // * 256 since we have 8 bit resolution +# if ESP_ARDUINO_VERSION >= ESP_ARDUINO_VERSION_VAL(3, 0, 0) +# if defined(IR_SEND_PIN) + ledcWrite(IR_SEND_PIN, (IR_SEND_DUTY_CYCLE_PERCENT * 256) / 100); // 3.x API +# else + ledcWrite(IrSender.sendPin, (IR_SEND_DUTY_CYCLE_PERCENT * 256) / 100); // 3.x API +# endif +# else + // ESP version < 3.0 + ledcWrite(SEND_LEDC_CHANNEL, (IR_SEND_DUTY_CYCLE_PERCENT * 256) / 100); // * 256 since we have 8 bit resolution +# endif } void disableSendPWMByTimer() { - ledcWrite(SEND_AND_RECEIVE_TIMER_LEDC_CHANNEL, 0); +# if ESP_ARDUINO_VERSION >= ESP_ARDUINO_VERSION_VAL(3, 0, 0) +# if defined(IR_SEND_PIN) + ledcWrite(IR_SEND_PIN, 0); // 3.x API +# else + ledcWrite(IrSender.sendPin, 0); // 3.x API +# endif +# else + // ESP version < 3.0 + ledcWrite(SEND_LEDC_CHANNEL, 0); +# endif } /* - * timerConfigForSend() is used exclusively by IRsend::enableIROut() - * ledcWrite since ESP 2.0.2 does not work if pin mode is set. Disable receive interrupt if it uses the same resource + * timerConfigForSend() is used exclusively by IRsend::enableIROut() (or enableHighFrequencyIROut()) + * ledcWrite since ESP 2.0.2 does not work if pin mode is set. */ -void timerConfigForSend(uint8_t aFrequencyKHz) { - ledcSetup(SEND_AND_RECEIVE_TIMER_LEDC_CHANNEL, aFrequencyKHz * 1000, 8); // 8 bit PWM resolution -# if defined(IR_SEND_PIN) - ledcAttachPin(IR_SEND_PIN, SEND_AND_RECEIVE_TIMER_LEDC_CHANNEL); // bind pin to channel +void timerConfigForSend(uint16_t aFrequencyKHz) { +# if ESP_ARDUINO_VERSION >= ESP_ARDUINO_VERSION_VAL(3, 0, 0) +# if defined(IR_SEND_PIN) + if(sLastSendPin == 0){ + ledcAttach(IR_SEND_PIN, aFrequencyKHz * 1000, 8); // 3.x API + sLastSendPin = IR_SEND_PIN; + } +# else + if(sLastSendPin != 0 && sLastSendPin != IrSender.sendPin){ + ledcDetach(IrSender.sendPin); // detach pin before new attaching see #1194 + } + ledcAttach(IrSender.sendPin, aFrequencyKHz * 1000, 8); // 3.x API + sLastSendPin = IrSender.sendPin; +# endif # else - ledcAttachPin(IrSender.sendPin, SEND_AND_RECEIVE_TIMER_LEDC_CHANNEL); // bind pin to channel + // ESP version < 3.0 + ledcSetup(SEND_LEDC_CHANNEL, aFrequencyKHz * 1000, 8); // 8 bit PWM resolution +# if defined(IR_SEND_PIN) + ledcAttachPin(IR_SEND_PIN, SEND_LEDC_CHANNEL); // attach pin to channel +# else + if(sLastSendPin != 0 && sLastSendPin != IrSender.sendPin){ + ledcDetachPin(IrSender.sendPin); // detach pin before new attaching see #1194 + } + ledcAttachPin(IrSender.sendPin, SEND_LEDC_CHANNEL); // attach pin to channel + sLastSendPin = IrSender.sendPin; +# endif # endif } # endif // defined(SEND_PWM_BY_TIMER) @@ -1429,8 +1581,13 @@ void timerConfigForSend(uint8_t aFrequencyKHz) { # if !defined(IR_SAMD_TIMER) # if defined(__SAMD51__) +# if defined(TC5) #define IR_SAMD_TIMER TC5 #define IR_SAMD_TIMER_IRQ TC5_IRQn +# else +#define IR_SAMD_TIMER TC3 +#define IR_SAMD_TIMER_IRQ TC3_IRQn +# endif # else // SAMD21 #define IR_SAMD_TIMER TC3 @@ -1465,7 +1622,11 @@ void timerConfigForReceive() { # if defined(__SAMD51__) // Enable the TC5 clock, use generic clock generator 0 (F_CPU) for TC5 +# if defined(TC5_GCLK_ID) GCLK->PCHCTRL[TC5_GCLK_ID].reg = GCLK_PCHCTRL_GEN_GCLK0_Val | (1 << GCLK_PCHCTRL_CHEN_Pos); +# else + GCLK->PCHCTRL[TC3_GCLK_ID].reg = GCLK_PCHCTRL_GEN_GCLK0_Val | (1 << GCLK_PCHCTRL_CHEN_Pos); +# endif // The TC should be disabled before the TC is reset in order to avoid undefined behavior. TC->CTRLA.reg &= ~TC_CTRLA_ENABLE; // Disable the Timer @@ -1498,7 +1659,7 @@ void timerConfigForReceive() { ; // wait for sync to ensure that we can write again to COUNT16.CTRLA.reg // Reset TCx TC->CTRLA.reg = TC_CTRLA_SWRST; - // When writing a ‘1’ to the CTRLA.SWRST bit it will immediately read as ‘1’. + // When writing a 1 to the CTRLA.SWRST bit it will immediately read as 1. while (TC->CTRLA.bit.SWRST) ; // CTRL.SWRST will be cleared by hardware when the peripheral has been reset. @@ -1522,18 +1683,12 @@ void timerConfigForReceive() { } # if !defined(DISABLE_CODE_FOR_RECEIVER) -# if defined(__SAMD51__) -void TC5_Handler(void) { - TcCount16 *TC = (TcCount16*) IR_SAMD_TIMER; - // Check for right interrupt bit - if (TC->INTFLAG.bit.MC0 == 1) { - // reset bit for next turn - TC->INTFLAG.bit.MC0 = 1; - IRReceiveTimerInterruptHandler(); - } -} +# if defined(__SAMD51__) && defined(TC5) +void TC5_Handler(void) # else -void TC3_Handler(void) { +void TC3_Handler(void) +# endif // defined(__SAMD51__) +{ TcCount16 *TC = (TcCount16*) IR_SAMD_TIMER; // Check for right interrupt bit if (TC->INTFLAG.bit.MC0 == 1) { @@ -1542,7 +1697,6 @@ void TC3_Handler(void) { IRReceiveTimerInterruptHandler(); } } -# endif // defined(__SAMD51__) # endif // !defined(DISABLE_CODE_FOR_RECEIVER) /*************************************** @@ -1592,7 +1746,7 @@ void disableSendPWMByTimer() { * timerConfigForSend() is used exclusively by IRsend::enableIROut() * Set output pin mode and disable receive interrupt if it uses the same resource */ -void timerConfigForSend(uint8_t aFrequencyKHz) { +void timerConfigForSend(uint16_t aFrequencyKHz) { sPwmOutForSendPWM.period_us(1000 / aFrequencyKHz); // 26.315 for 38 kHz sIROutPuseWidth = (1000 * IR_SEND_DUTY_CYCLE_PERCENT) / (aFrequencyKHz * 100); } @@ -1621,7 +1775,7 @@ bool IRTimerInterruptHandlerHelper(repeating_timer_t*) { } void timerEnableReceiveInterrupt() { - add_repeating_timer_us(-(MICROS_PER_TICK), IRTimerInterruptHandlerHelper, NULL, &s50usTimer); + add_repeating_timer_us(-(MICROS_PER_TICK), IRTimerInterruptHandlerHelper, nullptr, &s50usTimer); } void timerDisableReceiveInterrupt() { cancel_repeating_timer(&s50usTimer); @@ -1653,7 +1807,7 @@ void disableSendPWMByTimer() { * timerConfigForSend() is used exclusively by IRsend::enableIROut() * Set output pin mode and disable receive interrupt if it uses the same resource */ -void timerConfigForSend(uint8_t aFrequencyKHz) { +void timerConfigForSend(uint16_t aFrequencyKHz) { # if defined(IR_SEND_PIN) gpio_set_function(IR_SEND_PIN, GPIO_FUNC_PWM); // Find out which PWM slice is connected to IR_SEND_PIN @@ -1679,7 +1833,7 @@ void timerConfigForSend(uint8_t aFrequencyKHz) { /*************************************** * NRF5 boards like the BBC:Micro ***************************************/ -#elif defined(NRF5) || defined(ARDUINO_ARCH_NRF52840) +#elif defined(NRF5) || defined(ARDUINO_ARCH_NRF52840) || defined(ARDUINO_ARCH_NRF52) # if defined(SEND_PWM_BY_TIMER) #error PWM generation by hardware not implemented for NRF5 # endif @@ -1855,7 +2009,7 @@ void disableSendPWMByTimer() { * timerConfigForSend() is used exclusively by IRsend::enableIROut() * Set output pin mode and disable receive interrupt if it uses the same resource */ -void timerConfigForSend(uint8_t aFrequencyKHz) { +void timerConfigForSend(uint16_t aFrequencyKHz) { timerDisableReceiveInterrupt(); # if defined(IR_SEND_PIN) pinMode(IR_SEND_PIN, OUTPUT); @@ -1892,7 +2046,7 @@ void enableSendPWMByTimer() { void disableSendPWMByTimer() { } -void timerConfigForSend(uint8_t aFrequencyKHz) { +void timerConfigForSend(uint16_t aFrequencyKHz) { timerDisableReceiveInterrupt(); # if defined(IR_SEND_PIN) pinMode(IR_SEND_PIN, OUTPUT);