VirtualWireCodec Class Reference

#include <VirtualWireCodec.hh>

Inheritance diagram for VirtualWireCodec:

Collaboration diagram for VirtualWireCodec:

Public Member Functions
	VirtualWireCodec ()
virtual const uint8_t *	preamble ()
virtual uint8_t	encode4 (uint8_t nibble)
virtual uint8_t	decode4 (uint8_t symbol)
virtual uint8_t	decode8 (uint16_t symbol)

Public Attributes
const uint8_t	BITS_PER_SYMBOL
const uint16_t	START_SYMBOL
const uint8_t	PREAMBLE_MAX
const uint8_t	SYMBOL_MASK
const uint16_t	BITS_MSB

Detailed Description

VirtualWire 4-to-6 bit codec for the Cosa VWI (Virtual Wire Interface).

Definition at line 31 of file VirtualWireCodec.hh.

Constructor & Destructor Documentation

VirtualWireCodec::VirtualWireCodec ( )

inline

Construct VirtualWire codec with given bits per symbol, start symbol, and preamble size.

Definition at line 37 of file VirtualWireCodec.hh.

Member Function Documentation

uint8_t VirtualWireCodec::decode4 ( uint8_t  symbol )

virtual

Returns 4-bit data for given symbol.

Returns

4-bit data.

Implements VWI::Codec.

Definition at line 39 of file VirtualWireCodec.cpp.

virtual uint8_t VWI::Codec::decode8 ( uint16_t  symbol )

inlinevirtualinherited

Decode two packed symbols (max 16-bit) back to 8 bits (byte) of data.

Parameters

[in]

symbol

to decode.

Returns

data.

Definition at line 136 of file VWI.hh.

virtual uint8_t VirtualWireCodec::encode4 ( uint8_t  nibble )

inlinevirtual

Returns symbol for given 4-bit data.

Returns

6-bit code.

Implements VWI::Codec.

Definition at line 57 of file VirtualWireCodec.hh.

virtual const uint8_t* VirtualWireCodec::preamble ( )

inlinevirtual

Returns pointer to VirtualWire frame preamble in program memory.

Returns

pointer.

Implements VWI::Codec.

Definition at line 47 of file VirtualWireCodec.hh.

Member Data Documentation

const uint16_t VWI::Codec::BITS_MSB

inherited

Symbol MSB.

Definition at line 91 of file VWI.hh.

const uint8_t VWI::Codec::BITS_PER_SYMBOL

inherited

Bits per symbol.

Definition at line 76 of file VWI.hh.

const uint8_t VWI::Codec::PREAMBLE_MAX

inherited

Size of preamble with start symbol. Should be less or equal to Transmitter::PREAMBLE_MAX.

Definition at line 85 of file VWI.hh.

const uint16_t VWI::Codec::START_SYMBOL

inherited

Start symbol.

Definition at line 79 of file VWI.hh.

const uint8_t VWI::Codec::SYMBOL_MASK

inherited

Symbol mask.

Definition at line 88 of file VWI.hh.

---

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

• libraries/VirtualWireCodec/VirtualWireCodec.hh
• libraries/VirtualWireCodec/VirtualWireCodec.cpp