Bas Vuyk / XBeeLib_Handheld_V2

Library to easily communicate with XBee modules.

Fork of XBeeLib by Digi International Inc.

FrameHandlers/FH_AtCmdResp.h@0:fcaad0dfa051, 2015-05-08 (annotated)

Committer:
spastor
Date:
Fri May 08 11:50:56 2015 +0200
Revision:
0:fcaad0dfa051
Child:
3:8662ebe83570
Automatic upload

Who changed what in which revision?

UserRevisionLine numberNew contents of line
spastor 0:fcaad0dfa051 1 /**
spastor 0:fcaad0dfa051 2 * Copyright (c) 2015 Digi International Inc.,
spastor 0:fcaad0dfa051 3 * All rights not expressly granted are reserved.
spastor 0:fcaad0dfa051 4 *
spastor 0:fcaad0dfa051 5 * This Source Code Form is subject to the terms of the Mozilla Public
spastor 0:fcaad0dfa051 6 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
spastor 0:fcaad0dfa051 7 * You can obtain one at http://mozilla.org/MPL/2.0/.
spastor 0:fcaad0dfa051 8 *
spastor 0:fcaad0dfa051 9 * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343
spastor 0:fcaad0dfa051 10 * =======================================================================
spastor 0:fcaad0dfa051 11 */
spastor 0:fcaad0dfa051 12
spastor 0:fcaad0dfa051 13 #if !defined(__FH_AT_CMD_RESP_H_)
spastor 0:fcaad0dfa051 14 #define __FH_AT_CMD_RESP_H_
spastor 0:fcaad0dfa051 15
spastor 0:fcaad0dfa051 16 #include "FrameHandler.h"
spastor 0:fcaad0dfa051 17 #include "XBee/XBee.h"
spastor 0:fcaad0dfa051 18
spastor 0:fcaad0dfa051 19 namespace XBeeLib {
spastor 0:fcaad0dfa051 20 typedef void (*at_cmd_resp_cb_t)(const uint8_t * data, uint16_t len);
spastor 0:fcaad0dfa051 21
spastor 0:fcaad0dfa051 22 class FH_AtCmdResp : public FrameHandler
spastor 0:fcaad0dfa051 23 {
spastor 0:fcaad0dfa051 24 private:
spastor 0:fcaad0dfa051 25 /** Callback function, invoked (if registered) when an at command response packet is received */
spastor 0:fcaad0dfa051 26 at_cmd_resp_cb_t at_cmd_resp_cb;
spastor 0:fcaad0dfa051 27
spastor 0:fcaad0dfa051 28 public:
spastor 0:fcaad0dfa051 29
spastor 0:fcaad0dfa051 30 /** Class constructor */
spastor 0:fcaad0dfa051 31 FH_AtCmdResp();
spastor 0:fcaad0dfa051 32
spastor 0:fcaad0dfa051 33 /** Class constructor */
spastor 0:fcaad0dfa051 34 FH_AtCmdResp(ApiFrame::ApiFrameType type);
spastor 0:fcaad0dfa051 35
spastor 0:fcaad0dfa051 36
spastor 0:fcaad0dfa051 37 /** Class destructor */
spastor 0:fcaad0dfa051 38 virtual ~FH_AtCmdResp();
spastor 0:fcaad0dfa051 39
spastor 0:fcaad0dfa051 40 virtual void process_frame_data(const ApiFrame *const frame);
spastor 0:fcaad0dfa051 41
spastor 0:fcaad0dfa051 42 /** */
spastor 0:fcaad0dfa051 43 virtual void register_at_cmd_resp_cb(at_cmd_resp_cb_t function);
spastor 0:fcaad0dfa051 44
spastor 0:fcaad0dfa051 45 /** */
spastor 0:fcaad0dfa051 46 virtual void unregister_at_cmd_resp_cb();
spastor 0:fcaad0dfa051 47 };
spastor 0:fcaad0dfa051 48
spastor 0:fcaad0dfa051 49 /**
spastor 0:fcaad0dfa051 50 * @defgroup callback_types "Callback types declaration"
spastor 0:fcaad0dfa051 51 * @{
spastor 0:fcaad0dfa051 52 */
spastor 0:fcaad0dfa051 53 /** Node Discovery Response callback type declaration for ZigBee
spastor 0:fcaad0dfa051 54 * @param remote discovered remote node.
spastor 0:fcaad0dfa051 55 * @param node_id Node Identifier (NI parameter) of remote.
spastor 0:fcaad0dfa051 56 */
spastor 0:fcaad0dfa051 57 typedef void (*node_discovery_zb_cb_t)(const RemoteXBeeZB& remote, char const * const node_id);
spastor 0:fcaad0dfa051 58 /**
spastor 0:fcaad0dfa051 59 * @}
spastor 0:fcaad0dfa051 60 */
spastor 0:fcaad0dfa051 61
spastor 0:fcaad0dfa051 62 class FH_NodeDiscoveryZB : public FH_AtCmdResp
spastor 0:fcaad0dfa051 63 {
spastor 0:fcaad0dfa051 64 private:
spastor 0:fcaad0dfa051 65 /** Callback function, invoked (if registered) when an at command response packet is received */
spastor 0:fcaad0dfa051 66 node_discovery_zb_cb_t node_discovery_cb;
spastor 0:fcaad0dfa051 67
spastor 0:fcaad0dfa051 68 public:
spastor 0:fcaad0dfa051 69
spastor 0:fcaad0dfa051 70 /** Class constructor */
spastor 0:fcaad0dfa051 71 FH_NodeDiscoveryZB();
spastor 0:fcaad0dfa051 72
spastor 0:fcaad0dfa051 73 /** Class destructor */
spastor 0:fcaad0dfa051 74 virtual ~FH_NodeDiscoveryZB();
spastor 0:fcaad0dfa051 75
spastor 0:fcaad0dfa051 76 virtual void process_frame_data(const ApiFrame *const frame);
spastor 0:fcaad0dfa051 77
spastor 0:fcaad0dfa051 78 /** */
spastor 0:fcaad0dfa051 79 virtual void register_node_discovery_cb(node_discovery_zb_cb_t function);
spastor 0:fcaad0dfa051 80
spastor 0:fcaad0dfa051 81 /** */
spastor 0:fcaad0dfa051 82 virtual void unregister_node_discovery_cb();
spastor 0:fcaad0dfa051 83 };
spastor 0:fcaad0dfa051 84
spastor 0:fcaad0dfa051 85 /**
spastor 0:fcaad0dfa051 86 * @defgroup callback_types "Callback types declaration"
spastor 0:fcaad0dfa051 87 * @{
spastor 0:fcaad0dfa051 88 */
spastor 0:fcaad0dfa051 89 /** Node Discovery Response callback type declaration for 802.15.4
spastor 0:fcaad0dfa051 90 * @param remote discovered remote node.
spastor 0:fcaad0dfa051 91 * @param node_id Node Identifier (NI parameter) of remote.
spastor 0:fcaad0dfa051 92 */
spastor 0:fcaad0dfa051 93 typedef void (*node_discovery_802_cb_t)(const RemoteXBee802& remote, char const * const node_id);
spastor 0:fcaad0dfa051 94 /**
spastor 0:fcaad0dfa051 95 * @}
spastor 0:fcaad0dfa051 96 */
spastor 0:fcaad0dfa051 97
spastor 0:fcaad0dfa051 98 class FH_NodeDiscovery802 : public FH_AtCmdResp
spastor 0:fcaad0dfa051 99 {
spastor 0:fcaad0dfa051 100 private:
spastor 0:fcaad0dfa051 101 /** Callback function, invoked (if registered) when an at command response packet is received */
spastor 0:fcaad0dfa051 102 node_discovery_802_cb_t node_discovery_cb;
spastor 0:fcaad0dfa051 103
spastor 0:fcaad0dfa051 104 public:
spastor 0:fcaad0dfa051 105
spastor 0:fcaad0dfa051 106 /** Class constructor */
spastor 0:fcaad0dfa051 107 FH_NodeDiscovery802();
spastor 0:fcaad0dfa051 108
spastor 0:fcaad0dfa051 109 /** Class destructor */
spastor 0:fcaad0dfa051 110 virtual ~FH_NodeDiscovery802();
spastor 0:fcaad0dfa051 111
spastor 0:fcaad0dfa051 112 virtual void process_frame_data(const ApiFrame *const frame);
spastor 0:fcaad0dfa051 113
spastor 0:fcaad0dfa051 114 /** */
spastor 0:fcaad0dfa051 115 virtual void register_node_discovery_cb(node_discovery_802_cb_t function);
spastor 0:fcaad0dfa051 116
spastor 0:fcaad0dfa051 117 /** */
spastor 0:fcaad0dfa051 118 virtual void unregister_node_discovery_cb();
spastor 0:fcaad0dfa051 119 };
spastor 0:fcaad0dfa051 120
spastor 0:fcaad0dfa051 121 } /* namespace XBeeLib */
spastor 0:fcaad0dfa051 122
spastor 0:fcaad0dfa051 123 #endif /* __FH_AT_CMD_RESP_H_ */
spastor 0:fcaad0dfa051 124
spastor 0:fcaad0dfa051 125