Library to easily communicate with XBee modules.
Fork of XBeeLib by
Diff: FrameHandlers/FH_RxPacketZB.h
- Revision:
- 0:fcaad0dfa051
- Child:
- 3:8662ebe83570
diff -r 000000000000 -r fcaad0dfa051 FrameHandlers/FH_RxPacketZB.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/FrameHandlers/FH_RxPacketZB.h Fri May 08 11:50:56 2015 +0200 @@ -0,0 +1,65 @@ +/** + * Copyright (c) 2015 Digi International Inc., + * All rights not expressly granted are reserved. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this file, + * You can obtain one at http://mozilla.org/MPL/2.0/. + * + * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343 + * ======================================================================= + */ + +#if !defined(__FH_RX_PACKET_ZB_H_) +#define __FH_RX_PACKET_ZB_H_ + +#include "FrameHandler.h" +#include "RemoteXBee/RemoteXBee.h" + +namespace XBeeLib { + +/** + * @defgroup callback_types "Callback types declaration" + * @{ + */ +/** receive callback type declaration + * @param remote the remote module that sent the data + * @param broadcast a boolean to tell if the message was broadcast (true) or unicast (false) + * @param data a pointer to data sent by @b remote. + * @param len length (in bytes) of @b data buffer + */ +typedef void (*receive_zb_cb_t)(const RemoteXBeeZB& remote, bool broadcast, const uint8_t *const data, uint16_t len); +/** + * @} + */ + +class FH_RxPacketZB : public FrameHandler +{ + private: + /** Callback function, invoked if registered */ + receive_zb_cb_t receive_cb; + + public: + /** Class constructor */ + FH_RxPacketZB(); + + /** Class destructor */ + virtual ~FH_RxPacketZB(); + + /** Method called by the stack to process the modem status frame data + + \param frame pointer pointing to api frame that must be processed */ + virtual void process_frame_data(const ApiFrame* const frame); + + /** */ + void register_receive_cb(receive_zb_cb_t function); + + /** */ + void unregister_receive_cb(); +}; + +} /* namespace XBeeLib */ + +#endif /* __FH_RX_PACKET_ZB_H_ */ + +