pulsewire::NoPreamble Class Reference

NoPreamble: For protocols that do not require a preamble. Always returns true for detect, does nothing for getEdges, and preambleLength is 0. More...

#include <Preamble.h>

Inheritance diagram for pulsewire::NoPreamble:

Collaboration diagram for pulsewire::NoPreamble:

Public Member Functions
bool	begin (uint16_t bitFrequencyHz) override
bool	detect (const pulsewire::OutputEdge &edge) override
	Detects if the incoming edge matches the expected preamble pattern.
int	getEdges (pulsewire::Vector< pulsewire::OutputEdge > &output) const override
	Returns the expected preamble edges for this protocol.
size_t	preambleLength () const override
void	reset ()
bool	inRange (uint32_t value, uint32_t target, uint32_t tolerance) const

Protected Attributes
pulsewire::Vector< pulsewire::OutputEdge >	_history
pulsewire::Vector< pulsewire::OutputEdge >	_expected

Detailed Description

NoPreamble: For protocols that do not require a preamble. Always returns true for detect, does nothing for getEdges, and preambleLength is 0.

Definition at line 110 of file Preamble.h.

Member Function Documentation

begin()

bool pulsewire::NoPreamble::begin ( uint16_t  bitFrequencyHz )

inlineoverridevirtual

Reimplemented from pulsewire::Preamble.

Definition at line 112 of file Preamble.h.

detect()

bool pulsewire::NoPreamble::detect ( const pulsewire::OutputEdge &  edge )

inlineoverridevirtual

Detects if the incoming edge matches the expected preamble pattern.

Reimplemented from pulsewire::Preamble.

Definition at line 113 of file Preamble.h.

getEdges()

int pulsewire::NoPreamble::getEdges ( pulsewire::Vector< pulsewire::OutputEdge > &  output ) const

inlineoverridevirtual

Returns the expected preamble edges for this protocol.

Implements pulsewire::Preamble.

Definition at line 114 of file Preamble.h.

inRange()

bool pulsewire::Preamble::inRange ( uint32_t  value, uint32_t  target, uint32_t  tolerance  ) const

inlineinherited

Utility function to check if a value is within a specified tolerance range of a target

Definition at line 95 of file Preamble.h.

preambleLength()

size_t pulsewire::NoPreamble::preambleLength ( ) const

inlineoverridevirtual

Implements pulsewire::Preamble.

Definition at line 118 of file Preamble.h.

reset()

void pulsewire::Preamble::reset ( )

inlineinherited

Definition at line 49 of file Preamble.h.

Field Documentation

_expected

pulsewire::Vector<pulsewire::OutputEdge> pulsewire::Preamble::_expected

protectedinherited

Definition at line 102 of file Preamble.h.

_history

pulsewire::Vector<pulsewire::OutputEdge> pulsewire::Preamble::_history

protectedinherited

Definition at line 101 of file Preamble.h.

---

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

• src/pulse/Preamble.h