BeeeOn::ZWaveNetwork Class Reference

ZWaveNetwork is an interface to a real Z-Wave network. More...

#include <ZWaveNetwork.h>

Inheritance diagram for BeeeOn::ZWaveNetwork:

Data Structures
class	PollEvent
	Representation of events reported by the ZWaveNetwork implementation via the call pollEvent(). More...

Public Types
typedef Poco::SharedPtr < ZWaveNetwork >	Ptr

Public Member Functions
virtual PollEvent	pollEvent (const Poco::Timespan &timeout)=0
	Poll for new events in the ZWaveNetwork. More...
virtual void	startInclusion ()=0
	Starts the Z-Wave network node inclusion process. More...
virtual void	cancelInclusion ()=0
	Cancel inclusion if it is running.
virtual void	startRemoveNode ()=0
	Start node removal process in the Z-Wave network. More...
virtual void	cancelRemoveNode ()=0
	Cancel remove node if it is running.
virtual void	interrupt ()=0
	Interrupt any blocking calls currently in progress.
virtual void	postValue (const ZWaveNode::Value &)=0
	Post the given value into the Z-Wave network. There is no implicit feedback about the result status. More...

Detailed Description

ZWaveNetwork is an interface to a real Z-Wave network.

It provides just high-level operations:

• start and cancel of the inclusion process
• start and cancel of the node removal process
• access to high-level events by polling

Member Function Documentation

virtual PollEvent BeeeOn::ZWaveNetwork::pollEvent ( const Poco::Timespan &  timeout )

pure virtual

Poll for new events in the ZWaveNetwork.

The call is blocking or non-blocking based on the given timeout.

Implemented in BeeeOn::AbstractZWaveNetwork.

virtual void BeeeOn::ZWaveNetwork::postValue ( const ZWaveNode::Value &  )

pure virtual

Post the given value into the Z-Wave network. There is no implicit feedback about the result status.

The method might throw Poco::NotImplementedException in case of setting unsupported values or if not supported by the backend.

Implemented in BeeeOn::OZWNetwork.

virtual void BeeeOn::ZWaveNetwork::startInclusion ( )

pure virtual

Starts the Z-Wave network node inclusion process.

The call is non-blocking.

Implemented in BeeeOn::OZWNetwork.

virtual void BeeeOn::ZWaveNetwork::startRemoveNode ( )

pure virtual

Start node removal process in the Z-Wave network.

The call is blocking.

Implemented in BeeeOn::OZWNetwork.

---

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

• /var/lib/jenkins/workspace/beeeon-gateway-master/src/zwave/ZWaveNetwork.h
• /var/lib/jenkins/workspace/beeeon-gateway-master/src/zwave/ZWaveNetwork.cpp