Class IoT::XBee::XBeePort

File Information

Library: IoT/XBee
Package: XBee
Header: IoT/XBee/XBeePort.h

This class provides an interface to a Digi XBee module using the Digi XBee API frame-based protocol.

Member Functions: poll, receiveFrame, sendFrame

Creates a XBeePort using the given SerialPort.

The SerialPort must be open and properly configured for communication with the Digi XBee module.

Destroys the ZBPort.

bool poll(
const Poco::Timespan & timeout
);

Waits for data to arrive at the port.

Returns true immediately if data is already in the internal buffer, or if data arrives during the specified time interval, otherwise false.

std::size_t receiveFrame(
XBeeFrame & frame
);

Receives an API frame from the XBee ZB module.

Blocks until data becomes available.

std::size_t receiveFrame(
XBeeFrame & frame,
const Poco::Timespan & timeout
);

Receives an API frame from the XBee ZB module.

Returns the number of bytes received, which may be 0 if the receive operation times out.

void sendFrame(
const XBeeFrame & frame
);

Sends an API frame to the XBee ZB module.