Pulse-distance encoding/decoding utility class for IR communication. More...

#include <PulseDistanceCodec.h>

Inheritance diagram for pulsewire::PulseDistanceCodec:

Collaboration diagram for pulsewire::PulseDistanceCodec:

[legend]

Public Member Functions
	PulseDistanceCodec (Preamble &detector, uint32_t toleranceUs=0, uint32_t shortPulseUs=0, uint32_t longPulseUs=0)

void	init (Preamble &detector, uint32_t shortPulseUs=0, uint32_t longPulseUs=0, uint32_t toleranceUs=0)

bool	begin (uint32_t bitFrequencyHz) override
	initialization method for codecs that require setup before use (e.g., loading PIO programs, configuring state machines).

size_t	getEdgeCount () const override
	Get the number of protocol symbols (bits, pulses, etc.) per encoded byte.

int	getEndOfFrameDelayUs () override

CodecEnum	getCodecType () const override

bool	getIdleLevel ()

size_t	encode (uint8_t byte, Vector< OutputEdge > &output) override
	Fill output vector with protocol-specific OutputSpec(s) for a byte.

bool	decodeEdge (uint32_t durationUs, bool level, uint8_t &result) override
	Edge-based decoding for protocol-agnostic RX drivers.

virtual void	reset ()
	Reset the internal state of the codec.

void	setPreamble (Preamble &preamble)
	Set the Preamble Detector object.

Preamble &	getPreamble ()
	Get the preamble detector associated with this codec.

void	setFrameSize (uint16_t size)
	Set the Frame Size.

uint16_t	getFrameSize () const
	Get the configured frame size.

virtual bool	getIdleLevel () const
	Provides the initial ldle state (low or hith)

const char *	name () const
	Get the name of the codec type as a string (e.g., "PulseDistance", "Manchester").

size_t	encodePreamble (Vector< OutputEdge > &output)

virtual size_t	flushEncoder (Vector< OutputEdge > &output)
	Flush any pending encoder state at end of frame.

Protected Member Functions
size_t	encodeBit (bool bit, Vector< OutputEdge > &output)
	Fill output vector with PulseDistance OutputSpec(s) for a bit.

bool	decodeByte (Vector< OutputEdge > &edges, uint8_t &result)

bool	bitMatch (uint32_t duration, bool bit) const

virtual void	encodeByte (uint8_t byte, std::vector< bool > &bits) const
	Encode a byte to protocol bitstream. Default implementation encodes to raw bits (MSB first), but can be overridden by protocols that require different bit formatting (e.g., Manchester). The output bits are stored in.

Protected Attributes
uint32_t	_shortPulseUs = 0

uint32_t	_longPulseUs = 0

uint32_t	_toleranceUs = 0

CustomPreambleUs	_defaultPreamble

Preamble *	_preamble = &_defaultPreamble

uint16_t	_bitFrequencyHz = 0

uint32_t	_bitPeriodUs = 0

Vector< OutputEdge >	_decodeEdgeStream

volatile bool	_inFrame = false

uint16_t	_frameSize = 0

Detailed Description

Pulse-distance encoding/decoding utility class for IR communication.

Encodes bytes using pulse-distance modulation (e.g., NEC, RC5, custom protocols). Decodes pulse-distance bitstreams to bytes, with frame and checksum support.

Logical '1': long pulse, short space
Logical '0': short pulse, long space Timing parameters are configurable.

Definition at line 22 of file PulseDistanceCodec.h.

Constructor & Destructor Documentation

◆ PulseDistanceCodec()

pulsewire::PulseDistanceCodec::PulseDistanceCodec	(	Preamble &	detector,
		uint32_t	toleranceUs = `0`,
		uint32_t	shortPulseUs = `0`,
		uint32_t	longPulseUs = `0`
	)

inline

Definition at line 26 of file PulseDistanceCodec.h.

Member Function Documentation

◆ begin()

bool pulsewire::PulseDistanceCodec::begin ( uint32_t bitFrequencyHz )

inlineoverridevirtual

initialization method for codecs that require setup before use (e.g., loading PIO programs, configuring state machines).

Reimplemented from pulsewire::Codec.

Definition at line 42 of file PulseDistanceCodec.h.

◆ bitMatch()

bool pulsewire::PulseDistanceCodec::bitMatch	(	uint32_t	duration,
		bool	bit
	)		const

inlineprotected

Definition at line 161 of file PulseDistanceCodec.h.

◆ decodeByte()

bool pulsewire::PulseDistanceCodec::decodeByte	(	Vector< OutputEdge > &	edges,
		uint8_t &	result
	)

inlineprotected

Definition at line 136 of file PulseDistanceCodec.h.

◆ decodeEdge()

bool pulsewire::PulseDistanceCodec::decodeEdge	(	uint32_t	durationUs,
		bool	level,
		uint8_t &	result
	)

inlineoverridevirtual

Edge-based decoding for protocol-agnostic RX drivers.

Called on each signal edge (duration since last edge, new level, minUs, maxUs). The codec maintains its own state and assembles frames internally.

Parameters

durationUs	Time in microseconds since last edge.
level	New logic level after the edge (true = HIGH, false = LOW).
frameBuffer	Output buffer for decoded frame (if available).
frameBufferSize	Size of frameBuffer (bytes).
frameLen	Set to decoded frame length if a frame is available.

Returns: True if a complete frame is decoded and available in frameBuffer.

Implements pulsewire::Codec.

Definition at line 73 of file PulseDistanceCodec.h.

◆ encode()

size_t pulsewire::PulseDistanceCodec::encode	(	uint8_t	byte,
		Vector< OutputEdge > &	output
	)

inlineoverridevirtual

Fill output vector with protocol-specific OutputSpec(s) for a byte.

Encodes the byte to protocol bits and appends OutputSpec(s) for each bit.

Parameters

byte	The byte to encode.
output	Vector to append OutputSpec(s).

Returns: Number of OutputSpec entries added.

Implements pulsewire::Codec.

Definition at line 62 of file PulseDistanceCodec.h.

◆ encodeBit()

size_t pulsewire::PulseDistanceCodec::encodeBit	(	bool	bit,
		Vector< OutputEdge > &	output
	)

inlineprotected

Fill output vector with PulseDistance OutputSpec(s) for a bit.

Parameters

bit	The bit to encode (true/false).
output	Vector to append OutputSpec(s).

Returns: Number of OutputSpec entries added.

Definition at line 124 of file PulseDistanceCodec.h.

◆ encodeByte()

virtual void pulsewire::Codec::encodeByte	(	uint8_t	byte,
		std::vector< bool > &	bits
	)		const

inlineprotectedvirtualinherited

Encode a byte to protocol bitstream. Default implementation encodes to raw bits (MSB first), but can be overridden by protocols that require different bit formatting (e.g., Manchester). The output bits are stored in.

Parameters

byte	The input byte to encode.
bits	Output buffer for encoded bits (protocol-specific format).

Definition at line 204 of file Codec.h.

◆ encodePreamble()

size_t pulsewire::Codec::encodePreamble ( Vector< OutputEdge > & output )

inlineinherited

Definition at line 157 of file Codec.h.

◆ flushEncoder()

virtual size_t pulsewire::Codec::flushEncoder ( Vector< OutputEdge > & output )

inlinevirtualinherited

Flush any pending encoder state at end of frame.

Some codecs (e.g., Miller) accumulate pending duration that must be output at the end of the frame. This method outputs any remaining pending state. Default implementation does nothing.

Parameters

output Vector to append OutputSpec(s).

Returns: Number of OutputSpec entries added.

Reimplemented in pulsewire::MillerCodec.

Definition at line 185 of file Codec.h.

◆ getCodecType()

CodecEnum pulsewire::PulseDistanceCodec::getCodecType ( ) const

inlineoverridevirtual

Get the codec type (e.g., PulseDistance, Manchester) for this Codec instance.

Implements pulsewire::Codec.

Definition at line 58 of file PulseDistanceCodec.h.

◆ getEdgeCount()

size_t pulsewire::PulseDistanceCodec::getEdgeCount ( ) const

inlineoverridevirtual

Get the number of protocol symbols (bits, pulses, etc.) per encoded byte.

Returns: Number of protocol symbols per byte.

Implements pulsewire::Codec.

Definition at line 54 of file PulseDistanceCodec.h.

◆ getEndOfFrameDelayUs()

int pulsewire::PulseDistanceCodec::getEndOfFrameDelayUs ( )

inlineoverridevirtual

Provide the end of frame delay in microseconds for this protocol, used by RX driver to

Implements pulsewire::Codec.

Definition at line 56 of file PulseDistanceCodec.h.

◆ getFrameSize()

uint16_t pulsewire::Codec::getFrameSize ( ) const

inlineinherited

Get the configured frame size.

Definition at line 120 of file Codec.h.

◆ getIdleLevel() [1/2]

bool pulsewire::PulseDistanceCodec::getIdleLevel ( )

inline

Definition at line 60 of file PulseDistanceCodec.h.

◆ getIdleLevel() [2/2]

virtual bool pulsewire::Codec::getIdleLevel ( ) const

inlinevirtualinherited

Provides the initial ldle state (low or hith)

Reimplemented in pulsewire::DifferentialManchesterCodec, pulsewire::MillerCodec, pulsewire::NRZCodec, and pulsewire::RZCodec.

Definition at line 127 of file Codec.h.

◆ getPreamble()

Preamble & pulsewire::Codec::getPreamble ( )

inlineinherited

Get the preamble detector associated with this codec.

Returns: Reference to the Preamble instance used for preamble detection.

Definition at line 100 of file Codec.h.

◆ init()

void pulsewire::PulseDistanceCodec::init	(	Preamble &	detector,
		uint32_t	shortPulseUs = `0`,
		uint32_t	longPulseUs = `0`,
		uint32_t	toleranceUs = `0`
	)

inlinevirtual

Used by IRTransceiver to initialize codec with protocol-specific parameters

Reimplemented from pulsewire::Codec.

Definition at line 34 of file PulseDistanceCodec.h.

◆ name()

const char * pulsewire::Codec::name ( ) const

inlineinherited

Get the name of the codec type as a string (e.g., "PulseDistance", "Manchester").

Definition at line 135 of file Codec.h.

◆ reset()

virtual void pulsewire::Codec::reset ( )

inlinevirtualinherited

Reset the internal state of the codec.

Reimplemented in pulsewire::DifferentialManchesterCodec, pulsewire::MillerCodec, pulsewire::NRZCodec, and pulsewire::RZCodec.

Definition at line 84 of file Codec.h.

◆ setFrameSize()

void pulsewire::Codec::setFrameSize ( uint16_t size )

inlineinherited

Set the Frame Size.

Parameters

size

Definition at line 114 of file Codec.h.

◆ setPreamble()

void pulsewire::Codec::setPreamble ( Preamble & preamble )

inlineinherited

Set the Preamble Detector object.

Parameters

preamble

Definition at line 94 of file Codec.h.

Field Documentation

◆ _bitFrequencyHz

uint16_t pulsewire::Codec::_bitFrequencyHz = 0

protectedinherited

Definition at line 190 of file Codec.h.

◆ _bitPeriodUs

uint32_t pulsewire::Codec::_bitPeriodUs = 0

protectedinherited

Definition at line 191 of file Codec.h.

◆ _decodeEdgeStream

Vector<OutputEdge> pulsewire::Codec::_decodeEdgeStream

protectedinherited

Definition at line 192 of file Codec.h.

◆ _defaultPreamble

CustomPreambleUs pulsewire::Codec::_defaultPreamble

protectedinherited

Definition at line 188 of file Codec.h.

◆ _frameSize

uint16_t pulsewire::Codec::_frameSize = 0

protectedinherited

Definition at line 194 of file Codec.h.

◆ _inFrame

volatile bool pulsewire::Codec::_inFrame = false

protectedinherited

Definition at line 193 of file Codec.h.

◆ _longPulseUs

uint32_t pulsewire::PulseDistanceCodec::_longPulseUs = 0

protected

Definition at line 115 of file PulseDistanceCodec.h.

◆ _preamble

Preamble* pulsewire::Codec::_preamble = &_defaultPreamble

protectedinherited

Definition at line 189 of file Codec.h.

◆ _shortPulseUs

uint32_t pulsewire::PulseDistanceCodec::_shortPulseUs = 0

protected

Definition at line 114 of file PulseDistanceCodec.h.

◆ _toleranceUs

uint32_t pulsewire::PulseDistanceCodec::_toleranceUs = 0

protected

Definition at line 116 of file PulseDistanceCodec.h.

The documentation for this class was generated from the following file:

src/pulse/codecs/PulseDistanceCodec.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PulseDistanceCodec()

Member Function Documentation

◆ begin()

◆ bitMatch()

◆ decodeByte()

◆ decodeEdge()

◆ encode()

◆ encodeBit()

◆ encodeByte()

◆ encodePreamble()

◆ flushEncoder()

◆ getCodecType()

◆ getEdgeCount()

◆ getEndOfFrameDelayUs()

◆ getFrameSize()

◆ getIdleLevel() [1/2]

◆ getIdleLevel() [2/2]

◆ getPreamble()

◆ init()

◆ name()

◆ reset()

◆ setFrameSize()

◆ setPreamble()

Field Documentation

◆ _bitFrequencyHz

◆ _bitPeriodUs

◆ _decodeEdgeStream

◆ _defaultPreamble

◆ _frameSize

◆ _inFrame

◆ _longPulseUs

◆ _preamble

◆ _shortPulseUs

◆ _toleranceUs