271 lines
10 KiB
C++
271 lines
10 KiB
C++
/*
|
|
* ir_Samsung.hpp
|
|
*
|
|
* Contains functions for receiving and sending Samsung IR Protocol in "raw" and standard format with 16 bit address and 16 or 32 bit command
|
|
*
|
|
* This file is part of Arduino-IRremote https://github.com/Arduino-IRremote/Arduino-IRremote.
|
|
*
|
|
************************************************************************************
|
|
* MIT License
|
|
*
|
|
* Copyright (c) 2017-2021 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
|
|
* 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 CONSAMSUNGTION WITH THE SOFTWARE
|
|
* OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*
|
|
************************************************************************************
|
|
*/
|
|
#ifndef _IR_SAMSUNG_HPP
|
|
#define _IR_SAMSUNG_HPP
|
|
|
|
#include <Arduino.h>
|
|
|
|
//#define DEBUG // Activate this for lots of lovely debug output from this decoder.
|
|
#include "IRremoteInt.h" // evaluates the DEBUG for IR_DEBUG_PRINT
|
|
#include "LongUnion.h"
|
|
|
|
/** \addtogroup Decoder Decoders and encoders for different protocols
|
|
* @{
|
|
*/
|
|
//==============================================================================
|
|
// SSSS AAA MMM SSSS U U N N GGGG
|
|
// S A A M M M S U U NN N G
|
|
// SSS AAAAA M M M SSS U U N N N G GG
|
|
// S A A M M S U U N NN G G
|
|
// SSSS A A M M SSSS UUU N N GGG
|
|
//==============================================================================
|
|
// see http://www.hifi-remote.com/wiki/index.php?title=DecodeIR#Samsung
|
|
// https://www.mikrocontroller.net/articles/IRMP_-_english#SAMSUNG32
|
|
// LSB first, 1 start bit + 16 bit address + 16,32,20 bit data + 1 stop bit.
|
|
// On my Samsung remote they are plain repeats of the complete frame.
|
|
#define SAMSUNG_ADDRESS_BITS 16
|
|
#define SAMSUNG_COMMAND16_BITS 16
|
|
#define SAMSUNG_COMMAND32_BITS 32
|
|
#define SAMSUNG_BITS (SAMSUNG_ADDRESS_BITS + SAMSUNG_COMMAND16_BITS)
|
|
#define SAMSUNG48_BITS (SAMSUNG_ADDRESS_BITS + SAMSUNG_COMMAND32_BITS)
|
|
|
|
#define SAMSUNG_UNIT 553 // 21 periods of 38 kHz (552,631) TICKS_LOW = 8.253 TICKS_HIGH = 14.825
|
|
#define SAMSUNG_HEADER_MARK (8 * SAMSUNG_UNIT) // 4400
|
|
#define SAMSUNG_HEADER_SPACE (8 * SAMSUNG_UNIT) // 4400
|
|
#define SAMSUNG_BIT_MARK SAMSUNG_UNIT
|
|
#define SAMSUNG_ONE_SPACE (3 * SAMSUNG_UNIT) // 1650 TICKS_LOW = 24.62 TICKS_HIGH = 42.25
|
|
#define SAMSUNG_ZERO_SPACE SAMSUNG_UNIT
|
|
|
|
#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_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.
|
|
|
|
/**
|
|
* Please note me (armin.arduino@gmail.com) if you ever see this special repeat in the wild
|
|
* Send repeat
|
|
* Repeat commands should be sent in a 110 ms raster.
|
|
*/
|
|
void IRsend::sendSamsungRepeat() {
|
|
enableIROut(SAMSUNG_KHZ); // 38 kHz
|
|
mark(SAMSUNG_HEADER_MARK);
|
|
space(SAMSUNG_HEADER_SPACE);
|
|
mark(SAMSUNG_BIT_MARK);
|
|
space(SAMSUNG_ZERO_SPACE);
|
|
mark(SAMSUNG_BIT_MARK);
|
|
IrReceiver.restartAfterSend();
|
|
}
|
|
|
|
void IRsend::sendSamsung(uint16_t aAddress, uint16_t aCommand, uint_fast8_t aNumberOfRepeats) {
|
|
|
|
// Set IR carrier frequency
|
|
enableIROut(SAMSUNG_KHZ);
|
|
|
|
uint_fast8_t tNumberOfCommands = aNumberOfRepeats + 1;
|
|
while (tNumberOfCommands > 0) {
|
|
unsigned long tStartOfFrameMillis = millis();
|
|
|
|
// Header
|
|
mark(SAMSUNG_HEADER_MARK);
|
|
space(SAMSUNG_HEADER_SPACE);
|
|
|
|
// Address
|
|
sendPulseDistanceWidthData(SAMSUNG_BIT_MARK, SAMSUNG_ONE_SPACE, SAMSUNG_BIT_MARK, SAMSUNG_ZERO_SPACE, aAddress,
|
|
SAMSUNG_ADDRESS_BITS, PROTOCOL_IS_LSB_FIRST);
|
|
|
|
// Command
|
|
|
|
// send 8 command bits and then 8 inverted command bits LSB first
|
|
aCommand = aCommand & 0xFF;
|
|
aCommand = ((~aCommand) << 8) | aCommand;
|
|
|
|
sendPulseDistanceWidthData(SAMSUNG_BIT_MARK, SAMSUNG_ONE_SPACE, SAMSUNG_BIT_MARK, SAMSUNG_ZERO_SPACE, aCommand,
|
|
SAMSUNG_COMMAND16_BITS, PROTOCOL_IS_LSB_FIRST, SEND_STOP_BIT);
|
|
|
|
tNumberOfCommands--;
|
|
// skip last delay!
|
|
if (tNumberOfCommands > 0) {
|
|
// send repeat in a 110 ms raster
|
|
while (millis() - tStartOfFrameMillis < (SAMSUNG_REPEAT_PERIOD / MICROS_IN_ONE_MILLI)) {
|
|
delay(1);
|
|
}
|
|
}
|
|
}
|
|
IrReceiver.restartAfterSend();
|
|
}
|
|
|
|
//+=============================================================================
|
|
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)) {
|
|
IR_DEBUG_PRINT(F("Samsung: "));
|
|
IR_DEBUG_PRINT(F("Data length="));
|
|
IR_DEBUG_PRINT(decodedIRData.rawDataPtr->rawlen);
|
|
IR_DEBUG_PRINTLN(F(" is not 68 or 100"));
|
|
return false;
|
|
}
|
|
|
|
// Check header "mark" + "space"
|
|
if (!matchMark(decodedIRData.rawDataPtr->rawbuf[1], SAMSUNG_HEADER_MARK)
|
|
|| !matchSpace(decodedIRData.rawDataPtr->rawbuf[2], SAMSUNG_HEADER_SPACE)) {
|
|
IR_DEBUG_PRINT(F("Samsung: "));
|
|
IR_DEBUG_PRINTLN(F("Header mark or space length is wrong"));
|
|
|
|
return false;
|
|
}
|
|
|
|
if (decodedIRData.rawDataPtr->rawlen == (2 * SAMSUNG48_BITS) + 4) {
|
|
/*
|
|
* Samsung48
|
|
*/
|
|
// decode address
|
|
if (!decodePulseDistanceData(SAMSUNG_ADDRESS_BITS, 3, SAMSUNG_BIT_MARK, SAMSUNG_ONE_SPACE, SAMSUNG_ZERO_SPACE,
|
|
PROTOCOL_IS_LSB_FIRST)) {
|
|
IR_DEBUG_PRINT(F("Samsung: "));
|
|
IR_DEBUG_PRINTLN(F("Decode failed"));
|
|
return false;
|
|
}
|
|
decodedIRData.address = decodedIRData.decodedRawData;
|
|
|
|
// decode 32 bit command
|
|
if (!decodePulseDistanceData(SAMSUNG_COMMAND32_BITS, 3, SAMSUNG_BIT_MARK, SAMSUNG_ONE_SPACE, SAMSUNG_ZERO_SPACE,
|
|
PROTOCOL_IS_LSB_FIRST)) {
|
|
IR_DEBUG_PRINT(F("Samsung: "));
|
|
IR_DEBUG_PRINTLN(F("Decode failed"));
|
|
return false;
|
|
}
|
|
|
|
// Success
|
|
// decodedIRData.flags = IRDATA_FLAGS_IS_LSB_FIRST; // Not required, since this is the start value
|
|
LongUnion tValue;
|
|
tValue.ULong = decodedIRData.decodedRawData;
|
|
// receive 2 * (8 bits then 8 inverted bits) LSB first
|
|
if (tValue.UByte.HighByte != (uint8_t) (~tValue.UByte.MidHighByte)
|
|
&& tValue.UByte.MidLowByte != (uint8_t) (~tValue.UByte.LowByte)) {
|
|
decodedIRData.flags = IRDATA_FLAGS_PARITY_FAILED | IRDATA_FLAGS_IS_LSB_FIRST;
|
|
}
|
|
decodedIRData.command = tValue.UByte.HighByte << 8 | tValue.UByte.MidLowByte;
|
|
decodedIRData.numberOfBits = SAMSUNG48_BITS;
|
|
|
|
} else {
|
|
/*
|
|
* Samsung32
|
|
*/
|
|
if (!decodePulseDistanceData(SAMSUNG_BITS, 3, SAMSUNG_BIT_MARK, SAMSUNG_ONE_SPACE, SAMSUNG_ZERO_SPACE,
|
|
PROTOCOL_IS_LSB_FIRST)) {
|
|
IR_DEBUG_PRINT(F("Samsung: "));
|
|
IR_DEBUG_PRINTLN(F("Decode failed"));
|
|
return false;
|
|
}
|
|
LongUnion tValue;
|
|
tValue.ULong = decodedIRData.decodedRawData;
|
|
decodedIRData.address = tValue.UWord.LowWord;
|
|
|
|
if (tValue.UByte.MidHighByte == (uint8_t) (~tValue.UByte.HighByte)) {
|
|
// 8 bit command protocol
|
|
decodedIRData.command = tValue.UByte.MidHighByte; // first 8 bit
|
|
} else {
|
|
// 16 bit command protocol
|
|
decodedIRData.command = tValue.UWord.HighWord; // first 16 bit
|
|
}
|
|
decodedIRData.numberOfBits = SAMSUNG_BITS;
|
|
}
|
|
|
|
// check for repeat
|
|
if (decodedIRData.rawDataPtr->rawbuf[0] < (SAMSUNG_REPEAT_PERIOD / MICROS_PER_TICK)) {
|
|
decodedIRData.flags |= IRDATA_FLAGS_IS_REPEAT;
|
|
}
|
|
|
|
decodedIRData.protocol = SAMSUNG;
|
|
|
|
return true;
|
|
}
|
|
|
|
bool IRrecv::decodeSAMSUNG(decode_results *aResults) {
|
|
unsigned int offset = 1; // Skip first space
|
|
|
|
// Initial mark
|
|
if (!matchMark(aResults->rawbuf[offset], SAMSUNG_HEADER_MARK)) {
|
|
return false;
|
|
}
|
|
offset++;
|
|
|
|
// Check for repeat -- like a NEC repeat
|
|
if ((aResults->rawlen == 4) && matchSpace(aResults->rawbuf[offset], 2250)
|
|
&& matchMark(aResults->rawbuf[offset + 1], SAMSUNG_BIT_MARK)) {
|
|
aResults->bits = 0;
|
|
aResults->value = 0xFFFFFFFF;
|
|
decodedIRData.flags = IRDATA_FLAGS_IS_REPEAT;
|
|
decodedIRData.protocol = SAMSUNG;
|
|
return true;
|
|
}
|
|
if (aResults->rawlen < (2 * SAMSUNG_BITS) + 4) {
|
|
return false;
|
|
}
|
|
|
|
// Initial space
|
|
if (!matchSpace(aResults->rawbuf[offset], SAMSUNG_HEADER_SPACE)) {
|
|
return false;
|
|
}
|
|
offset++;
|
|
|
|
if (!decodePulseDistanceData(SAMSUNG_BITS, offset, SAMSUNG_BIT_MARK, SAMSUNG_ONE_SPACE, SAMSUNG_ZERO_SPACE,
|
|
PROTOCOL_IS_MSB_FIRST)) {
|
|
return false;
|
|
}
|
|
|
|
// Success
|
|
aResults->value = decodedIRData.decodedRawData;
|
|
aResults->bits = SAMSUNG_BITS;
|
|
aResults->decode_type = SAMSUNG;
|
|
decodedIRData.protocol = SAMSUNG;
|
|
return true;
|
|
}
|
|
|
|
// Old version with MSB first
|
|
void IRsend::sendSAMSUNG(unsigned long data, int nbits) {
|
|
// Set IR carrier frequency
|
|
enableIROut(SAMSUNG_KHZ);
|
|
|
|
// Header
|
|
mark(SAMSUNG_HEADER_MARK);
|
|
space(SAMSUNG_HEADER_SPACE);
|
|
|
|
// Old version with MSB first Data + stop bit
|
|
sendPulseDistanceWidthData(SAMSUNG_BIT_MARK, SAMSUNG_ONE_SPACE, SAMSUNG_BIT_MARK, SAMSUNG_ZERO_SPACE, data, nbits,
|
|
PROTOCOL_IS_MSB_FIRST, SEND_STOP_BIT);
|
|
IrReceiver.restartAfterSend();
|
|
}
|
|
|
|
/** @}*/
|
|
#endif // _IR_SAMSUNG_HPP
|