deCONZ::Node Class Reference

Represents a ZigBee node with all its descriptors and clusters. More...

#include <node.h>

Public Member Functions
	Node ()
	Constructor.
	Node (const Node &other)
	Copy constructor.
Node &	operator= (const Node &other)
	Assignment operator.
virtual	~Node ()
	Deconstructor.
virtual CommonState	state () const =0
	Returns the current node state.
const deCONZ::Address &	address () const
	Returns the const node address.
bool	isCoordinator () const
	Returns true if the node is a coordinator.
bool	isRouter () const
	Returns true if the node is a router.
bool	isEndDevice () const
	Returns true if the node is a end-device.
bool	isZombie () const
	Returns true if the node not reachable.
void	setIsZombie (bool isZombie)
	Sets the reachable state of the node.
const QString &	userDescriptor () const
	Returns the user descriptor (usually the nodes name).
void	setUserDescriptor (const QString &userDescriptor)
	Sets the user descriptor.
QString	deviceTypeString ()
	Returns the device type as string which might be Coordinator, Router or End device.
const std::vector< uint8_t > &	endpoints () const
	Returns all known active endpoint numbers.
void	setActiveEndpoints (const std::vector< uint8_t > &ep)
	Sets the active endpoint numbers.
SimpleDescriptor *	getSimpleDescriptor (uint8_t endpoint)
	Returns a simple descriptor for a endpoint.
bool	setSimpleDescriptor (const SimpleDescriptor &descr)
	Adds or updates a simple descriptor.
std::vector< SimpleDescriptor > &	simpleDescriptors ()
	Returns the modifyable list of a simple descriptors.
const std::vector< SimpleDescriptor > &	simpleDescriptors () const
	Returns the const list of a simple descriptors.
int	copySimpleDescriptor (uint8_t endpoint, SimpleDescriptor *descr) const
	Copy the simple descriptor specified by endpoint from internal storage to descr.
const NodeDescriptor &	nodeDescriptor () const
	Returns the node descriptor.
void	setNodeDescriptor (const NodeDescriptor &descr)
	Sets the node descriptor.
const PowerDescriptor &	powerDescriptor () const
	Returns the power descriptor.
void	setPowerDescriptor (const PowerDescriptor &descr)
	Sets the power descriptor.
const MacCapabilities &	macCapabilities () const
	Returns the mac capabilities.
void	setMacCapabilities (MacCapabilities cap)
	Sets the mac capabilities.
void	resetAll ()
	Resets internal fields and state.
virtual const std::vector< NodeNeighbor > &	neighbors () const =0
	Returns all neighbors of the node.
const std::vector< SourceRoute > &	sourceRoutes () const
	Returns all source routes of the node.
int	addSourceRoute (const SourceRoute &sourceRoute)
	Add or update a source route.
bool	updateSourceRoute (const SourceRoute &sourceRoute)
	Update a source route.
int	removeSourceRoute (uint srHash)
	Removes a source route specified by srHash.
virtual const BindingTable &	bindingTable () const =0
	Returns the binding table of a node.
void	pushEdScan (int ed)
int	edScanValue () const
bool	needRedraw () const
void	setNeedRedraw (bool redraw)

Protected Attributes
NodePrivate *	d_ptr = nullptr

Detailed Description

Represents a ZigBee node with all its descriptors and clusters.

Member Function Documentation

addSourceRoute()

int deCONZ::Node::addSourceRoute

(

const SourceRoute &

sourceRoute

)

Add or update a source route.

If a source route with the same order or uuid exists, it will be replaced.

Parameters

sourceRoute

Return values

0	on success, a new source route was added
1	on success, existing source route was updated
-1	if the source route isn't valid

copySimpleDescriptor()

int deCONZ::Node::copySimpleDescriptor	(	uint8_t	endpoint,
		SimpleDescriptor *	descr
	)		const

Copy the simple descriptor specified by endpoint from internal storage to descr.

Parameters

endpoint	shall be between 1-254
descr	pointer to a user simple descriptor

Return values

0	on success
-1	if not found
-1	descr is 0

endpoints()

const std::vector< uint8_t > & deCONZ::Node::endpoints

(

)

const

Returns all known active endpoint numbers.

Returns a list of all active application endpoints on the node.

The list might be empty if the ZDP active endpoint request is not done for the node yet.

getSimpleDescriptor()

SimpleDescriptor * deCONZ::Node::getSimpleDescriptor

(

uint8_t

endpoint

)

Returns a simple descriptor for a endpoint.

Parameters

endpoint

shall be between 1-254

Returns

a pointer to the internal SimpleDescriptor if found

Return values

0	if no simple descriptor is available for endpoint

removeSourceRoute()

int deCONZ::Node::removeSourceRoute

(

uint

srHash

)

Removes a source route specified by srHash.

Return values

0	if the source route was removed
-1	if there was no source route with the given uuid

setMacCapabilities()

void deCONZ::Node::setMacCapabilities

(

MacCapabilities

cap

)

Sets the mac capabilities.

Parameters

cap	or combined value of deCONZ::MacCapability

setNodeDescriptor()

void deCONZ::Node::setNodeDescriptor

(

const NodeDescriptor &

descr

)

Sets the node descriptor.

Parameters

descr

a node descriptor

setPowerDescriptor()

void deCONZ::Node::setPowerDescriptor

(

const PowerDescriptor &

descr

)

Sets the power descriptor.

Parameters

descr

a power descriptor

setSimpleDescriptor()

bool deCONZ::Node::setSimpleDescriptor

(

const SimpleDescriptor &

descr

)

Adds or updates a simple descriptor.

Parameters

descr

a simple descriptor with endpoint between 1-254

Returns

true on updated added, false if nothing changed

setUserDescriptor()

void deCONZ::Node::setUserDescriptor

(

const QString &

userDescriptor

)

Sets the user descriptor.

Parameters

userDescriptor

a string with a max length of 16

updateSourceRoute()

bool deCONZ::Node::updateSourceRoute

(

const SourceRoute &

sourceRoute

)

Update a source route.

If a source route with the same order or uuid exists, it will be replaced.

Parameters

sourceRoute

Return values

true	when existing source route was updated
false	if the source route wasn't found

---

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

• /home/mpi/src/deconz-lib/deconz/node.h
• /home/mpi/src/deconz-lib/node.cpp