174 lines
7.5 KiB
C
174 lines
7.5 KiB
C
/**
|
|
* @file IRProtocol.h
|
|
* @brief Common declarations for receiving and sending.
|
|
*
|
|
* This file is part of Arduino-IRremote https://github.com/Arduino-IRremote/Arduino-IRremote.
|
|
*
|
|
*
|
|
************************************************************************************
|
|
* MIT License
|
|
*
|
|
* Copyright (c) 2020-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
|
|
* 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.
|
|
*
|
|
************************************************************************************
|
|
*/
|
|
#ifndef _IR_PROTOCOL_H
|
|
#define _IR_PROTOCOL_H
|
|
|
|
/**
|
|
* An enum consisting of all supported formats.
|
|
* You do NOT need to remove entries from this list when disabling protocols!
|
|
* !!!Must be the same order as ProtocolNames in IRReceive.hpp!!!
|
|
*/
|
|
typedef enum {
|
|
UNKNOWN = 0,
|
|
PULSE_WIDTH,
|
|
PULSE_DISTANCE,
|
|
APPLE,
|
|
DENON,
|
|
JVC,
|
|
LG,
|
|
LG2,
|
|
NEC,
|
|
NEC2, /* NEC with full frame as repeat */
|
|
ONKYO,
|
|
PANASONIC,
|
|
KASEIKYO,
|
|
KASEIKYO_DENON,
|
|
KASEIKYO_SHARP,
|
|
KASEIKYO_JVC,
|
|
KASEIKYO_MITSUBISHI,
|
|
RC5,
|
|
RC6,
|
|
SAMSUNG,
|
|
SAMSUNGLG,
|
|
SAMSUNG48,
|
|
SHARP,
|
|
SONY,
|
|
/* Now the exotic protocols */
|
|
BANG_OLUFSEN,
|
|
BOSEWAVE,
|
|
LEGO_PF,
|
|
MAGIQUEST,
|
|
WHYNTER,
|
|
FAST
|
|
} decode_type_t;
|
|
|
|
#define SIRCS_12_PROTOCOL 12
|
|
#define SIRCS_15_PROTOCOL 15
|
|
#define SIRCS_20_PROTOCOL 20
|
|
|
|
struct DistanceWidthTimingInfoStruct {
|
|
uint16_t HeaderMarkMicros;
|
|
uint16_t HeaderSpaceMicros;
|
|
uint16_t OneMarkMicros;
|
|
uint16_t OneSpaceMicros;
|
|
uint16_t ZeroMarkMicros;
|
|
uint16_t ZeroSpaceMicros;
|
|
};
|
|
|
|
/*
|
|
* Definitions for member IRData.flags
|
|
*/
|
|
#define IRDATA_FLAGS_EMPTY 0x00
|
|
#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_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.
|
|
/**
|
|
* Data structure for the user application, available as decodedIRData.
|
|
* Filled by decoders and read by print functions or user application.
|
|
*/
|
|
struct IRData {
|
|
decode_type_t protocol; ///< UNKNOWN, NEC, SONY, RC5, PULSE_DISTANCE, ...
|
|
uint16_t address; ///< Decoded address, Distance protocol (tMarkTicksLong (if tMarkTicksLong == 0, then tMarkTicksShort) << 8) | tSpaceTicksLong
|
|
uint16_t command; ///< Decoded command, Distance protocol (tMarkTicksShort << 8) | tSpaceTicksShort
|
|
uint16_t extra; ///< Contains upper 16 bit of Magiquest WandID, Kaseikyo unknown vendor ID and Distance protocol (HeaderMarkTicks << 8) | HeaderSpaceTicks.
|
|
IRRawDataType decodedRawData; ///< Up to 32/64 bit decoded raw data, to be used for send functions.
|
|
#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.
|
|
#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; ///< IRDATA_FLAGS_IS_REPEAT, IRDATA_FLAGS_WAS_OVERFLOW etc. See IRDATA_FLAGS_* definitions above
|
|
|
|
// These 2 variables allow to call resume() directly after decode, if no dump is required. Since 4.3.0.
|
|
IRRawlenType rawlen; ///< counter of entries in rawbuf
|
|
uint16_t initialGap; ///< rawbuf[0] contains the initial gap of the last frame.
|
|
|
|
irparams_struct *rawDataPtr; ///< Pointer of the raw timing data to be decoded. Mainly the OverflowFlag and the data buffer filled by receiving ISR.
|
|
};
|
|
|
|
struct PulseDistanceWidthProtocolConstants {
|
|
decode_type_t ProtocolIndex;
|
|
uint_fast8_t FrequencyKHz;
|
|
DistanceWidthTimingInfoStruct DistanceWidthTimingInfo;
|
|
uint8_t Flags;
|
|
unsigned int RepeatPeriodMillis;
|
|
void (*SpecialSendRepeatFunction)(); // using non member functions here saves up to 250 bytes for send demo
|
|
// void (IRsend::*SpecialSendRepeatFunction)();
|
|
};
|
|
/*
|
|
* Definitions for member PulseDistanceWidthProtocolConstants.Flags
|
|
*/
|
|
#define SUPPRESS_STOP_BIT_FOR_THIS_DATA 0x20 // Stop bit is otherwise sent for all pulse distance protocols.
|
|
#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
|
|
*/
|
|
#if !defined(BEO_KHZ) // guard used for unit test, which sends and receive Bang&Olufsen with 38 kHz.
|
|
#define BEO_KHZ 455
|
|
#endif
|
|
#define SONY_KHZ 40
|
|
#define BOSEWAVE_KHZ 38
|
|
#define DENON_KHZ 38
|
|
#define JVC_KHZ 38
|
|
#define LG_KHZ 38
|
|
#define NEC_KHZ 38
|
|
#define SAMSUNG_KHZ 38
|
|
#define KASEIKYO_KHZ 37
|
|
#define RC5_RC6_KHZ 36
|
|
|
|
#if defined(__AVR__)
|
|
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.
|
|
|
|
/*
|
|
* Convenience functions to convert MSB to LSB values
|
|
*/
|
|
uint8_t bitreverseOneByte(uint8_t aValue);
|
|
uint32_t bitreverse32Bit(uint32_t aInput);
|
|
|
|
#endif // _IR_PROTOCOL_H
|