class XBeeNodeRemoteObject

Library: IoT/XBee
Package: Generated
Header: IoT/XBee/XBeeNodeRemoteObject.h


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.


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


using Ptr = Poco::AutoPtr < XBeeNodeRemoteObject >;



    const Poco::RemotingNG::Identifiable::ObjectId & oid,
    Poco::SharedPtr < IoT::XBee::XBeeNode > pServiceObject


~XBeeNodeRemoteObject virtual

virtual ~XBeeNodeRemoteObject();

Destroys the XBeeNodeRemoteObject.

Member Functions

queueCommand virtual inline

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.

remoting__enableEvents virtual

virtual std::string remoting__enableEvents(
    Poco::RemotingNG::Listener::Ptr pListener,
    bool enable = bool (true)

remoting__enableRemoteEvents virtual

virtual void remoting__enableRemoteEvents(
    const std::string & protocol

remoting__hasEvents virtual

virtual bool remoting__hasEvents() const;

remoting__typeId virtual inline

virtual const Poco::RemotingNG::Identifiable::TypeId & remoting__typeId() const;

sendCommand virtual inline

virtual void sendCommand(
    const IoT::XBee::ATCommand & command

Sends an AT command to the connected XBee device.

sendExplicitAddressingZigBeeTransmitRequest virtual inline

virtual void sendExplicitAddressingZigBeeTransmitRequest(
    const IoT::XBee::ExplicitAddressingZigBeeTransmitRequest & request

sendFrame virtual inline

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.

sendRemoteCommand virtual inline

virtual void sendRemoteCommand(
    const IoT::XBee::RemoteATCommand & command

Sends an AT command to a remote XBee device.

sendTransmitRequest virtual inline

virtual void sendTransmitRequest(
    const IoT::XBee::TransmitRequest & request

Sends a TransmitRequest message to the XBee device.

sendZigBeeTransmitRequest virtual inline

virtual void sendZigBeeTransmitRequest(
    const IoT::XBee::ZigBeeTransmitRequest & request

Sends a ZigBeeTransmitRequest to the XBee device.

event__commandResponseReceived protected

void event__commandResponseReceived(
    const IoT::XBee::ATCommandResponse & data

event__explicitAddressingZigBeePacketReceived protected

void event__explicitAddressingZigBeePacketReceived(
    const IoT::XBee::ExplicitAddressingZigBeeReceivePacket & data

event__frameReceived protected

void event__frameReceived(
    const IoT::XBee::APIFrame & data

event__ioDataReceived protected

void event__ioDataReceived(
    const IoT::XBee::ReceivePacket & data

event__ioSampleReceived protected

void event__ioSampleReceived(
    const IoT::XBee::IOSample & data

event__modemStatusReceived protected

void event__modemStatusReceived(
    const IoT::XBee::ModemStatus & data

event__packetReceived protected

void event__packetReceived(
    const IoT::XBee::ReceivePacket & data

event__remoteCommandResponseReceived protected

void event__remoteCommandResponseReceived(
    const IoT::XBee::RemoteATCommandResponse & data

event__sensorReadReceived protected

void event__sensorReadReceived(
    const IoT::XBee::SensorRead & data

event__transmitStatusReceived protected

void event__transmitStatusReceived(
    const IoT::XBee::TransmitStatus & data

event__zigBeePacketReceived protected

void event__zigBeePacketReceived(
    const IoT::XBee::ZigBeeReceivePacket & data

event__zigBeeTransmitStatusReceived protected

void event__zigBeeTransmitStatusReceived(
    const IoT::XBee::ZigBeeTransmitStatus & data

Securely control IoT edge devices from anywhere   Connect a Device