RC5 Demo
Classes | Public Member Functions | Private Attributes | List of all members
RC5Telegram Class Reference

Class representing a RC5 telegram. More...

#include <rc5telegram.h>

Classes

union  ProtocolDataUnit
 

Public Member Functions

 RC5Telegram (uint16_t bits=0)
 
 operator uint16_t () const
 
Bit getFieldBit (void) const
 
void setFieldBit (Bit state)
 
Bit getToggleBit (void) const
 
void setToggleBit (Bit state)
 
uint8_t getAddress (void) const
 
void setAddress (uint8_t address)
 
uint8_t getCode (void) const
 
void setCode (uint8_t code)
 

Private Attributes

ProtocolDataUnit m_pdu
 Internal buffer holding the protocol data unit. More...
 

Detailed Description

Class representing a RC5 telegram.

Internally it stores data in a bitfield that matches the binary layout of the RC5 protocol data units. It provides getters and setters for both, a raw bit pattern (as uint16_t) and individual elements (e.g. address or code). Thus it can be also used for preparing a RC5 telegram for transmission (even though this isn't used in this demo).

Constructor & Destructor Documentation

◆ RC5Telegram()

RC5Telegram::RC5Telegram ( uint16_t  bits = 0)
inline

Constructor that optionally initializes from a bit pattern.

Parameters
[in]bitsPattern to initialize with

Member Function Documentation

◆ getAddress()

uint8_t RC5Telegram::getAddress ( void  ) const
inline

Getter for address.

Returns
Address

◆ getCode()

uint8_t RC5Telegram::getCode ( void  ) const
inline

Getter for code.

Returns
Code

◆ getFieldBit()

Bit RC5Telegram::getFieldBit ( void  ) const
inline

Getter for field bit.

Returns
Field bit

◆ getToggleBit()

Bit RC5Telegram::getToggleBit ( void  ) const
inline

Getter for toggle bit.

Returns
Toggle bit

◆ operator uint16_t()

RC5Telegram::operator uint16_t ( ) const
inline

Cast operator for converting telegram into bit pattern.

Note
The start bit is implicitly set to 1.

◆ setAddress()

void RC5Telegram::setAddress ( uint8_t  address)
inline

Setter for address.

Parameters
[in]addressAddress to set

◆ setCode()

void RC5Telegram::setCode ( uint8_t  code)
inline

Setter for code.

Parameters
[in]codeCode to set

◆ setFieldBit()

void RC5Telegram::setFieldBit ( Bit  state)
inline

Setter for field bit.

Parameters
[in]stateState of field bit to set

◆ setToggleBit()

void RC5Telegram::setToggleBit ( Bit  state)
inline

Setter for toggle bit.

Parameters
[in]stateState of toggle bit to set

Member Data Documentation

◆ m_pdu

ProtocolDataUnit RC5Telegram::m_pdu
private

Internal buffer holding the protocol data unit.


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