NRZ (Non-Return-to-Zero) codec for serial-like encoding/decoding with start/stop bit framing. More...

#include <NRZCodec.h>

Inheritance diagram for pulsewire::NRZCodec:

Collaboration diagram for pulsewire::NRZCodec:

[legend]

Public Member Functions
	NRZCodec (uint8_t stopBits=1)

	NRZCodec (Preamble &preambleDetector, uint8_t stopBits=1)

CodecEnum	getCodecType () const override
	instance.

bool	getIdleLevel ()

void	setStopBits (uint8_t stopBits)

uint8_t	getStopBits () const

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

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.

bool	decodeByte (Vector< OutputEdge > &edges, uint8_t &result) override
	Decode edges into a byte.

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

int	getEndOfFrameDelayUs () override
	Provide the end of frame delay in microseconds for this protocol, used by RX driver to.

virtual void	init (Preamble &detector, uint32_t shortPulseUs=600, uint32_t longPulseUs=1200, uint32_t toleranceUs=200)

virtual void	reset ()

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

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

size_t	encodePreamble (Vector< OutputEdge > &output)

void	setFrameSize (uint16_t size)

virtual size_t	encodeBit (bool bit, Vector< OutputEdge > &output)
	Fill output vector with protocol-specific OutputSpec(s) for a bit.

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.

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").

Protected Member Functions
bool	bitMatch (uint32_t duration, bool bit) const

Protected Attributes
uint8_t	_stopBits

CustomPreambleUs	_defaultPreamble

Preamble *	_preamble = &_defaultPreamble

uint16_t	_bitFrequencyHz = 0

uint32_t	_bitPeriodUs = 0

Vector< OutputEdge >	_decodeEdgeStream

volatile bool	_inFrame = false

Detailed Description

NRZ (Non-Return-to-Zero) codec for serial-like encoding/decoding with start/stop bit framing.

Definition at line 10 of file NRZCodec.h.

Constructor & Destructor Documentation

◆ NRZCodec() [1/2]

pulsewire::NRZCodec::NRZCodec ( uint8_t stopBits = 1 )

inline

Definition at line 12 of file NRZCodec.h.

◆ NRZCodec() [2/2]

pulsewire::NRZCodec::NRZCodec	(	Preamble &	preambleDetector,
		uint8_t	stopBits = `1`
	)

inline

Definition at line 14 of file NRZCodec.h.

Member Function Documentation

◆ begin()

bool pulsewire::NRZCodec::begin ( uint16_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 25 of file NRZCodec.h.

◆ bitMatch()

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

inlineprotected

Definition at line 118 of file NRZCodec.h.

◆ decodeByte()

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

inlineoverridevirtual

Decode edges into a byte.

Implements pulsewire::Codec.

Definition at line 91 of file NRZCodec.h.

◆ decodeEdge()

bool pulsewire::NRZCodec::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.

Reimplemented from pulsewire::Codec.

Definition at line 69 of file NRZCodec.h.

◆ encode()

size_t pulsewire::NRZCodec::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.

Reimplemented from pulsewire::Codec.

Definition at line 38 of file NRZCodec.h.

◆ encodeBit()

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

inlinevirtualinherited

Fill output vector with protocol-specific 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.

Reimplemented in pulsewire::RecorderCodec, pulsewire::DifferentialManchesterCodec, pulsewire::ManchesterCodec, pulsewire::PulseDistanceCodec, and pulsewire::PulseWidthCodec.

Definition at line 184 of file Codec.h.

◆ encodeByte()

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

inlinevirtualinherited

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).

Reimplemented in pulsewire::RecorderCodec.

Definition at line 194 of file Codec.h.

◆ encodePreamble()

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

inlineinherited

Definition at line 146 of file Codec.h.

◆ getCodecType()

CodecEnum pulsewire::NRZCodec::getCodecType ( ) const

inlineoverridevirtual

instance.

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

Implements pulsewire::Codec.

Definition at line 17 of file NRZCodec.h.

◆ getEdgeCount()

size_t pulsewire::NRZCodec::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 110 of file NRZCodec.h.

◆ getEndOfFrameDelayUs()

int pulsewire::NRZCodec::getEndOfFrameDelayUs ( )

inlineoverridevirtual

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

Implements pulsewire::Codec.

Definition at line 112 of file NRZCodec.h.

◆ getIdleLevel() [1/2]

bool pulsewire::NRZCodec::getIdleLevel ( )

inline

Definition at line 19 of file NRZCodec.h.

◆ getIdleLevel() [2/2]

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

inlinevirtualinherited

Provides the initial ldle state (low or hith)

Reimplemented in pulsewire::DifferentialManchesterCodec.

Definition at line 208 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 77 of file Codec.h.

◆ getStopBits()

uint8_t pulsewire::NRZCodec::getStopBits ( ) const

inline

Definition at line 23 of file NRZCodec.h.

◆ init()

virtual void pulsewire::Codec::init	(	Preamble &	detector,
		uint32_t	shortPulseUs = `600`,
		uint32_t	longPulseUs = `1200`,
		uint32_t	toleranceUs = `200`
	)

inlinevirtualinherited

Used by IRTransceiver to initialize codec with protocol-specific parameters

Reimplemented in pulsewire::PulseWidthCodec, pulsewire::PulseDistanceCodec, and pulsewire::RecorderCodec.

Definition at line 49 of file Codec.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 218 of file Codec.h.

◆ reset()

virtual void pulsewire::Codec::reset ( )

inlinevirtualinherited

Definition at line 67 of file Codec.h.

◆ setFrameSize()

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

inlineinherited

Definition at line 173 of file Codec.h.

◆ setPreamble()

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

inlineinherited

Set the Preamble Detector object.

Parameters

preamble

Definition at line 84 of file Codec.h.

◆ setStopBits()

void pulsewire::NRZCodec::setStopBits ( uint8_t stopBits )

inline

Definition at line 21 of file NRZCodec.h.

Field Documentation

◆ _bitFrequencyHz

uint16_t pulsewire::Codec::_bitFrequencyHz = 0

protectedinherited

Definition at line 224 of file Codec.h.

◆ _bitPeriodUs

uint32_t pulsewire::Codec::_bitPeriodUs = 0

protectedinherited

Definition at line 225 of file Codec.h.

◆ _decodeEdgeStream

Vector<OutputEdge> pulsewire::Codec::_decodeEdgeStream

protectedinherited

Definition at line 226 of file Codec.h.

◆ _defaultPreamble

CustomPreambleUs pulsewire::Codec::_defaultPreamble

protectedinherited

Definition at line 222 of file Codec.h.

◆ _inFrame

volatile bool pulsewire::Codec::_inFrame = false

protectedinherited

Definition at line 227 of file Codec.h.

◆ _preamble

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

protectedinherited

Definition at line 223 of file Codec.h.

◆ _stopBits

uint8_t pulsewire::NRZCodec::_stopBits

protected

Definition at line 115 of file NRZCodec.h.

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

src/pulse/codecs/NRZCodec.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NRZCodec() [1/2]

◆ NRZCodec() [2/2]

Member Function Documentation

◆ begin()

◆ bitMatch()

◆ decodeByte()

◆ decodeEdge()

◆ encode()

◆ encodeBit()

◆ encodeByte()

◆ encodePreamble()

◆ getCodecType()

◆ getEdgeCount()

◆ getEndOfFrameDelayUs()

◆ getIdleLevel() [1/2]

◆ getIdleLevel() [2/2]

◆ getPreamble()

◆ getStopBits()

◆ init()

◆ name()

◆ reset()

◆ setFrameSize()

◆ setPreamble()

◆ setStopBits()

Field Documentation

◆ _bitFrequencyHz

◆ _bitPeriodUs

◆ _decodeEdgeStream

◆ _defaultPreamble

◆ _inFrame

◆ _preamble

◆ _stopBits