jeans/Tasmota
jeans/Tasmota
1
0
Fork 0
mirror of https://github.com/arendst/Tasmota.git synced 2025-07-26 04:06:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation of protocol format

Browse Source
This commit is contained in:
Jason2866 2021-09-07 17:44:02 +02:00 committed by GitHub
parent d665bf10c1
commit 4a0788f33c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 38 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
lib/lib_rf/rc-switch/src/RCSwitch.cpp
View File

@ -56,33 +56,58 @@
/* Protocol description format /* Protocol description format
* *
* {Pulse length, Preamble, Sync bit, "0" bit, "1" bit, Inverted Signal, Guard time} * {
* * Pulse length,
* Pulse length: pulse duration Te in microseconds, *
* example 350 * PreambleFactor,
* Preamble: Alternating high and low levels * Preamble {high,low},
* {20, 1} means 20 alternations of 1 Te duration *
* _ _ _ _ _ _ _ _ _ _ * HeaderFactor,
* | |_| |_| |_| |_| |_| |_| |_| |_| |_| |_ * Header {high,low},
* Sync bit: Header and clock *
* {1, 31} means 1 pulse long Te high and 31 low * "0" bit {high,low},
* "1" bit {high,low},
*
* Inverted Signal,
* Guard time
* }
*
* Pulse length: pulse duration (Te) in microseconds,
* for example 350
* PreambleFactor: Number of high and low states to send
* (One pulse = 2 states, in orther words, number of pulses is
* ceil(PreambleFactor/2).)
* Preamble: Pulse shape which defines a preamble bit.
* Sent ceil(PreambleFactor/2) times.
* For example, {1, 2} with factor 3 would send
* _ _
* | |__| |__ (each horizontal bar has a duration of Te,
* vertical bars are ignored)
* HeaderFactor: Number of times to send the header pulse.
* Header: Pulse shape which defines a header (or "sync"/"clock") pulse.
* {1, 31} means one pulse of duration 1 Te high and 31 Te low
* _ * _
* | |_______________________________ (don't count the vertical bars) * | |_______________________________ (don't count the vertical bars)
*
* "0" bit: pulse shape defining a data bit, which is a logical "0" * "0" bit: pulse shape defining a data bit, which is a logical "0"
* {1, 3} means 1 pulse duration Te high level and 3 low * {1, 3} means 1 pulse duration Te high level and 3 low
* _ * _
* | |___ * | |___
*
* "1" bit: pulse shape that defines the data bit, which is a logical "1" * "1" bit: pulse shape that defines the data bit, which is a logical "1"
* {3, 1} means 3 pulses with a duration of Te high level and 1 low * {3, 1} means 3 pulses with a duration of Te high level and 1 low
* ___ * ___
* | |_ * | |_
* *
* (note: to form the state bit Z (Tri-State bit), these two codes are combined) * (note: to form the state bit Z (Tri-State bit), two codes are combined)
*
* Inverted Signal: Signal inversion - if true the signal is inverted * Inverted Signal: Signal inversion - if true the signal is inverted
* replacing high to low in a transmitted / received packet * replacing high to low in a transmitted / received packet
* Guard time: Safety time, followed by the next preamble of the next packet * Guard time: Separation time between two retries. It will be followed by the
* for example 39 pulses of low duration Te * next preamble of the next packet. In number of Te.
* e.g. 39 pulses of duration Te low level
*/ */
#if defined(ESP8266) || defined(ESP32) #if defined(ESP8266) || defined(ESP32)
static const VAR_ISR_ATTR RCSwitch::Protocol proto[] = { static const VAR_ISR_ATTR RCSwitch::Protocol proto[] = {
#else #else