knx
ETS configurable knx-stack
Public Member Functions | List of all members
KnxFacade< P, B > Class Template Reference

#include <knx_facade.h>

Inheritance diagram for KnxFacade< P, B >:
[legend]
Collaboration diagram for KnxFacade< P, B >:
[legend]

Public Member Functions

 KnxFacade ()
 
 KnxFacade (B &bau)
 
 KnxFacade (IsrFunctionPtr buttonISRFunction)
 
virtual ~KnxFacade ()
 
P & platform ()
 
B & bau ()
 
bool enabled ()
 
void enabled (bool value)
 
bool progMode ()
 
void progMode (bool value)
 
void toggleProgMode ()
 To be called by ISR handling on button press. More...
 
bool configured ()
 
uint32_t ledPinActiveOn ()
 returns HIGH if led is active on HIGH, LOW otherwise More...
 
void ledPinActiveOn (uint32_t value)
 Sets if the programming led is active on HIGH or LOW. More...
 
int32_t ledPin ()
 
void ledPin (int32_t value)
 
void setProgLedOffCallback (ProgLedOffCallback progLedOffCallback)
 
void setProgLedOnCallback (ProgLedOnCallback progLedOnCallback)
 
int32_t buttonPin ()
 
void buttonPin (int32_t value)
 
void readMemory ()
 
void writeMemory ()
 
uint16_t individualAddress ()
 
void loop ()
 
void manufacturerId (uint16_t value)
 
void bauNumber (uint32_t value)
 
void orderNumber (const uint8_t *value)
 
void hardwareType (const uint8_t *value)
 
void version (uint16_t value)
 
void start ()
 
void setButtonISRFunction (IsrFunctionPtr progButtonISRFuncPtr)
 
void setSaveCallback (SaveCallback func)
 
void setRestoreCallback (RestoreCallback func)
 
uint8_t * paramData (uint32_t addr)
 
bool paramBit (uint32_t addr, uint8_t shift)
 
uint8_t paramByte (uint32_t addr)
 
int8_t paramSignedByte (uint32_t addr)
 
uint16_t paramWord (uint32_t addr)
 
uint32_t paramInt (uint32_t addr)
 
double paramFloat (uint32_t addr, ParameterFloatEncodings enc)
 
GroupObject & getGroupObject (uint16_t goNr)
 
void restart (uint16_t individualAddress)
 
void beforeRestartCallback (BeforeRestartCallback func)
 
BeforeRestartCallback beforeRestartCallback ()
 

Detailed Description

template<class P, class B>
class KnxFacade< P, B >

Definition at line 75 of file knx_facade.h.

Constructor & Destructor Documentation

◆ KnxFacade() [1/3]

template<class P , class B >
KnxFacade< P, B >::KnxFacade ( )
inline

Definition at line 78 of file knx_facade.h.

Here is the call graph for this function:

◆ KnxFacade() [2/3]

template<class P , class B >
KnxFacade< P, B >::KnxFacade ( B &  bau)
inline

Definition at line 85 of file knx_facade.h.

Here is the call graph for this function:

◆ KnxFacade() [3/3]

template<class P , class B >
KnxFacade< P, B >::KnxFacade ( IsrFunctionPtr  buttonISRFunction)
inline

Definition at line 93 of file knx_facade.h.

Here is the call graph for this function:

◆ ~KnxFacade()

template<class P , class B >
virtual KnxFacade< P, B >::~KnxFacade ( )
inlinevirtual

Definition at line 101 of file knx_facade.h.

Member Function Documentation

◆ bau()

template<class P , class B >
B& KnxFacade< P, B >::bau ( )
inline

Definition at line 115 of file knx_facade.h.

Here is the caller graph for this function:

◆ bauNumber()

template<class P , class B >
void KnxFacade< P, B >::bauNumber ( uint32_t  value)
inline

Definition at line 248 of file knx_facade.h.

Here is the caller graph for this function:

◆ beforeRestartCallback() [1/2]

template<class P , class B >
BeforeRestartCallback KnxFacade< P, B >::beforeRestartCallback ( )
inline

Definition at line 427 of file knx_facade.h.

◆ beforeRestartCallback() [2/2]

template<class P , class B >
void KnxFacade< P, B >::beforeRestartCallback ( BeforeRestartCallback  func)
inline

Definition at line 422 of file knx_facade.h.

◆ buttonPin() [1/2]

template<class P , class B >
int32_t KnxFacade< P, B >::buttonPin ( )
inline

Definition at line 191 of file knx_facade.h.

◆ buttonPin() [2/2]

template<class P , class B >
void KnxFacade< P, B >::buttonPin ( int32_t  value)
inline

Definition at line 196 of file knx_facade.h.

◆ configured()

template<class P , class B >
bool KnxFacade< P, B >::configured ( )
inline

Definition at line 148 of file knx_facade.h.

◆ enabled() [1/2]

template<class P , class B >
bool KnxFacade< P, B >::enabled ( )
inline

Definition at line 120 of file knx_facade.h.

Here is the caller graph for this function:

◆ enabled() [2/2]

template<class P , class B >
void KnxFacade< P, B >::enabled ( bool  value)
inline

Definition at line 125 of file knx_facade.h.

◆ getGroupObject()

template<class P , class B >
GroupObject& KnxFacade< P, B >::getGroupObject ( uint16_t  goNr)
inline

Definition at line 410 of file knx_facade.h.

◆ hardwareType()

template<class P , class B >
void KnxFacade< P, B >::hardwareType ( const uint8_t *  value)
inline

Definition at line 258 of file knx_facade.h.

◆ individualAddress()

template<class P , class B >
uint16_t KnxFacade< P, B >::individualAddress ( )
inline

Definition at line 211 of file knx_facade.h.

Here is the caller graph for this function:

◆ ledPin() [1/2]

template<class P , class B >
int32_t KnxFacade< P, B >::ledPin ( )
inline

Definition at line 171 of file knx_facade.h.

Here is the caller graph for this function:

◆ ledPin() [2/2]

template<class P , class B >
void KnxFacade< P, B >::ledPin ( int32_t  value)
inline

Definition at line 176 of file knx_facade.h.

◆ ledPinActiveOn() [1/2]

template<class P , class B >
uint32_t KnxFacade< P, B >::ledPinActiveOn ( )
inline

returns HIGH if led is active on HIGH, LOW otherwise

Definition at line 156 of file knx_facade.h.

◆ ledPinActiveOn() [2/2]

template<class P , class B >
void KnxFacade< P, B >::ledPinActiveOn ( uint32_t  value)
inline

Sets if the programming led is active on HIGH or LOW.

Set to HIGH for GPIO–RESISTOR–LED–GND or to LOW for GPIO–LED–RESISTOR–VDD

Definition at line 166 of file knx_facade.h.

◆ loop()

template<class P , class B >
void KnxFacade< P, B >::loop ( )
inline

Definition at line 216 of file knx_facade.h.

Here is the call graph for this function:

◆ manufacturerId()

template<class P , class B >
void KnxFacade< P, B >::manufacturerId ( uint16_t  value)
inline

Definition at line 243 of file knx_facade.h.

Here is the caller graph for this function:

◆ orderNumber()

template<class P , class B >
void KnxFacade< P, B >::orderNumber ( const uint8_t *  value)
inline

Definition at line 253 of file knx_facade.h.

◆ paramBit()

template<class P , class B >
bool KnxFacade< P, B >::paramBit ( uint32_t  addr,
uint8_t  shift 
)
inline

Definition at line 356 of file knx_facade.h.

◆ paramByte()

template<class P , class B >
uint8_t KnxFacade< P, B >::paramByte ( uint32_t  addr)
inline

Definition at line 364 of file knx_facade.h.

◆ paramData()

template<class P , class B >
uint8_t* KnxFacade< P, B >::paramData ( uint32_t  addr)
inline

Definition at line 322 of file knx_facade.h.

◆ paramFloat()

template<class P , class B >
double KnxFacade< P, B >::paramFloat ( uint32_t  addr,
ParameterFloatEncodings  enc 
)
inline

Definition at line 401 of file knx_facade.h.

◆ paramInt()

template<class P , class B >
uint32_t KnxFacade< P, B >::paramInt ( uint32_t  addr)
inline

Definition at line 393 of file knx_facade.h.

◆ paramSignedByte()

template<class P , class B >
int8_t KnxFacade< P, B >::paramSignedByte ( uint32_t  addr)
inline

Definition at line 377 of file knx_facade.h.

◆ paramWord()

template<class P , class B >
uint16_t KnxFacade< P, B >::paramWord ( uint32_t  addr)
inline

Definition at line 385 of file knx_facade.h.

◆ platform()

template<class P , class B >
P& KnxFacade< P, B >::platform ( )
inline

Definition at line 110 of file knx_facade.h.

Here is the caller graph for this function:

◆ progMode() [1/2]

template<class P , class B >
bool KnxFacade< P, B >::progMode ( )
inline

Definition at line 130 of file knx_facade.h.

Here is the caller graph for this function:

◆ progMode() [2/2]

template<class P , class B >
void KnxFacade< P, B >::progMode ( bool  value)
inline

Definition at line 135 of file knx_facade.h.

◆ readMemory()

template<class P , class B >
void KnxFacade< P, B >::readMemory ( )
inline

Definition at line 201 of file knx_facade.h.

◆ restart()

template<class P , class B >
void KnxFacade< P, B >::restart ( uint16_t  individualAddress)
inline

Definition at line 416 of file knx_facade.h.

Here is the call graph for this function:

◆ setButtonISRFunction()

template<class P , class B >
void KnxFacade< P, B >::setButtonISRFunction ( IsrFunctionPtr  progButtonISRFuncPtr)
inline

Definition at line 307 of file knx_facade.h.

Here is the caller graph for this function:

◆ setProgLedOffCallback()

template<class P , class B >
void KnxFacade< P, B >::setProgLedOffCallback ( ProgLedOffCallback  progLedOffCallback)
inline

Definition at line 181 of file knx_facade.h.

◆ setProgLedOnCallback()

template<class P , class B >
void KnxFacade< P, B >::setProgLedOnCallback ( ProgLedOnCallback  progLedOnCallback)
inline

Definition at line 186 of file knx_facade.h.

◆ setRestoreCallback()

template<class P , class B >
void KnxFacade< P, B >::setRestoreCallback ( RestoreCallback  func)
inline

Definition at line 317 of file knx_facade.h.

◆ setSaveCallback()

template<class P , class B >
void KnxFacade< P, B >::setSaveCallback ( SaveCallback  func)
inline

Definition at line 312 of file knx_facade.h.

◆ start()

template<class P , class B >
void KnxFacade< P, B >::start ( )
inline

Definition at line 268 of file knx_facade.h.

Here is the call graph for this function:

◆ toggleProgMode()

template<class P , class B >
void KnxFacade< P, B >::toggleProgMode ( )
inline

To be called by ISR handling on button press.

Definition at line 143 of file knx_facade.h.

◆ version()

template<class P , class B >
void KnxFacade< P, B >::version ( uint16_t  value)
inline

Definition at line 263 of file knx_facade.h.

◆ writeMemory()

template<class P , class B >
void KnxFacade< P, B >::writeMemory ( )
inline

Definition at line 206 of file knx_facade.h.

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