deCONZ C++ API v2.6.1
Loading...
Searching...
No Matches
deCONZ::TouchlinkController Class Referenceabstract

Provides services to access interpan and touchlink functionality. More...

#include <touchlink_controller.h>

Inherits QObject.

Signals

void startInterpanModeConfirm (TouchlinkStatus status)
 Is emitted after starting interpan mode request is processed.
 
void sendInterpanConfirm (TouchlinkStatus status)
 Is emitted after send interpan request is processed.
 
void interpanIndication (const QByteArray &ind)
 Is emitted on the reception of a interpan frame.
 

Public Member Functions

 TouchlinkController (QObject *parent)
 Constructor.
 
virtual ~TouchlinkController ()
 Deconstructor.
 
virtual int startInterpanMode (uint8_t channel)=0
 Start interpan networking.
 
virtual int sendInterpanRequest (const TouchlinkRequest &req)=0
 Sends a interpan request.
 
uint32_t generateTransactionId () const
 Generates a new random transaction identifier.
 

Static Public Member Functions

static TouchlinkControllerinstance ()
 Get the singleton instance of the TouchlinkController.
 

Detailed Description

Provides services to access interpan and touchlink functionality.

Member Function Documentation

◆ generateTransactionId()

uint32_t deCONZ::TouchlinkController::generateTransactionId ( ) const

Generates a new random transaction identifier.

Returns
a non zero random number

◆ interpanIndication

void deCONZ::TouchlinkController::interpanIndication ( const QByteArray &  ind)
signal

Is emitted on the reception of a interpan frame.

Parameters
indhold the raw interpan indication frame in the following format
// all fields are little endian
uint16_t srcPanId
uint64_t srcAddress
uint16_t dstPanId
uint8_t dstAddressMode
uint64_t dstExtAddress // (if dstAddressmode is 0x03)
uint16_t dstShortAddress // (if dstAddressmode is not 0x03)
uint16_t profileId
uint16_t clusterId
uint8_t asduLength
uint8_t asdu[asduLength]

◆ sendInterpanConfirm

void deCONZ::TouchlinkController::sendInterpanConfirm ( TouchlinkStatus  status)
signal

Is emitted after send interpan request is processed.

Parameters
statusthe result of the request
See also
sendInterpanRequest()

◆ sendInterpanRequest()

virtual int deCONZ::TouchlinkController::sendInterpanRequest ( const TouchlinkRequest req)
pure virtual

Sends a interpan request.

Parameters
reqthe request parameters
Return values
0if the request will be processed
-1then the request could not be done

◆ startInterpanMode()

virtual int deCONZ::TouchlinkController::startInterpanMode ( uint8_t  channel)
pure virtual

Start interpan networking.

Interpan networking is only possible then the network state is NotInNetwork.

Parameters
channelthe channel to tune in (11-26)
Return values
0if the request will be processed
-1then the request could not be done
-2then the network state is not NotInNetwork
-3if channel is not valid (11-26)

◆ startInterpanModeConfirm

void deCONZ::TouchlinkController::startInterpanModeConfirm ( TouchlinkStatus  status)
signal

Is emitted after starting interpan mode request is processed.

Parameters
statusthe result of the request
See also
startInterpanMode()

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