File Information
Library: IoT/XBee
Package: Generated
Header: IoT/XBee/XBeeNodeRemoteObject.h
Description
This class provides a high-level interface to a Digi XBee device using the Digi XBee API frame-based protocol. This class can be used with all XBee devices supporting the XBee API frame-based protocol, including ZigBee devices. Actually supported methods and events are depending on the kind of XBee device, e.g., an 802.15.4 module won't support ZigBee-specific API frames, and vice-versa. Please refer to the XBee product manual for detailed information about the API.
Inheritance
Direct Base Classes: IXBeeNode, Poco::RemotingNG::RemoteObject
All Base Classes: IXBeeNode, Poco::OSP::Service, Poco::RefCountedObject, Poco::RemotingNG::Identifiable, Poco::RemotingNG::RemoteObject
Member Summary
Member Functions: event__commandResponseReceived, event__explicitAddressingZigBeePacketReceived, event__frameReceived, event__ioDataReceived, event__ioSampleReceived, event__modemStatusReceived, event__packetReceived, event__remoteCommandResponseReceived, event__sensorReadReceived, event__transmitStatusReceived, event__zigBeePacketReceived, event__zigBeeTransmitStatusReceived, queueCommand, remoting__enableEvents, remoting__enableRemoteEvents, remoting__hasEvents, remoting__typeId, sendCommand, sendExplicitAddressingZigBeeTransmitRequest, sendFrame, sendRemoteCommand, sendTransmitRequest, sendZigBeeTransmitRequest
Inherited Functions: duplicate, isA, mutex, queueCommand, referenceCount, release, remoting__enableEvents, remoting__enableRemoteEvents, remoting__getURI, remoting__hasEvents, remoting__objectId, remoting__setURI, remoting__typeId, sendCommand, sendExplicitAddressingZigBeeTransmitRequest, sendFrame, sendRemoteCommand, sendTransmitRequest, sendZigBeeTransmitRequest, type
Types Aliases
Ptr
using Ptr = Poco::AutoPtr < XBeeNodeRemoteObject >;
Constructors
XBeeNodeRemoteObject
XBeeNodeRemoteObject(
const Poco::RemotingNG::Identifiable::ObjectId & oid,
Poco::SharedPtr < IoT::XBee::XBeeNode > pServiceObject
);
Creates a XBeeNodeRemoteObject.
Destructor
~XBeeNodeRemoteObject 
virtual ~XBeeNodeRemoteObject();
Destroys the XBeeNodeRemoteObject.
Member Functions
queueCommand 
virtual void queueCommand(
const IoT::XBee::ATCommand & command
);
Queues an AT command for execution on the connected XBee device.
In contrast to sendCommand(), new parameter values are queued and not applied until either sendCommand() is called or the Apply Changes (AC) AT command is issued. Register queries (reading parameter values) are returned immediately.
See also: IoT::XBee::IXBeeNode::queueCommand()
remoting__enableEvents
virtual std::string remoting__enableEvents(
Poco::RemotingNG::Listener::Ptr pListener,
bool enable = bool (true)
);
remoting__enableRemoteEvents
virtual void remoting__enableRemoteEvents(
const std::string & protocol
);
remoting__hasEvents
virtual bool remoting__hasEvents() const;
remoting__typeId
virtual const Poco::RemotingNG::Identifiable::TypeId & remoting__typeId() const;
sendCommand
virtual void sendCommand(
const IoT::XBee::ATCommand & command
);
Sends an AT command to the connected XBee device.
See also: IoT::XBee::IXBeeNode::sendCommand()
sendExplicitAddressingZigBeeTransmitRequest
virtual void sendExplicitAddressingZigBeeTransmitRequest(
const IoT::XBee::ExplicitAddressingZigBeeTransmitRequest & request
);
Sends an ExplicitAddressingZigBeeTransmitRequest to the XBee device.
sendFrame
virtual void sendFrame(
const IoT::XBee::APIFrame & frame
);
Sends an API frame to the connected XBee device.
The caller is responsible for correct formatting of the API frame's data. Refer to the XBee module documentation for supported frames and their format.
This can be used to send API frames not directly supported by the XBeeNode interface.
See also: IoT::XBee::IXBeeNode::sendFrame()
sendRemoteCommand
virtual void sendRemoteCommand(
const IoT::XBee::RemoteATCommand & command
);
Sends an AT command to a remote XBee device.
sendTransmitRequest
virtual void sendTransmitRequest(
const IoT::XBee::TransmitRequest & request
);
Sends a TransmitRequest message to the XBee device.
sendZigBeeTransmitRequest
virtual void sendZigBeeTransmitRequest(
const IoT::XBee::ZigBeeTransmitRequest & request
);
Sends a ZigBeeTransmitRequest to the XBee device.
event__commandResponseReceived 
void event__commandResponseReceived(
const IoT::XBee::ATCommandResponse & data
);
event__explicitAddressingZigBeePacketReceived
void event__explicitAddressingZigBeePacketReceived(
const IoT::XBee::ExplicitAddressingZigBeeReceivePacket & data
);
event__frameReceived
void event__frameReceived(
const IoT::XBee::APIFrame & data
);
event__ioDataReceived
void event__ioDataReceived(
const IoT::XBee::ReceivePacket & data
);
event__ioSampleReceived
void event__ioSampleReceived(
const IoT::XBee::IOSample & data
);
event__modemStatusReceived
void event__modemStatusReceived(
const IoT::XBee::ModemStatus & data
);
event__packetReceived
void event__packetReceived(
const IoT::XBee::ReceivePacket & data
);
event__remoteCommandResponseReceived
void event__remoteCommandResponseReceived(
const IoT::XBee::RemoteATCommandResponse & data
);
event__sensorReadReceived
void event__sensorReadReceived(
const IoT::XBee::SensorRead & data
);
event__transmitStatusReceived
void event__transmitStatusReceived(
const IoT::XBee::TransmitStatus & data
);
event__zigBeePacketReceived
void event__zigBeePacketReceived(
const IoT::XBee::ZigBeeReceivePacket & data
);
event__zigBeeTransmitStatusReceived
void event__zigBeeTransmitStatusReceived(
const IoT::XBee::ZigBeeTransmitStatus & data
);