Bas Vuyk / XBeeLib_Handheld_V2

Library to easily communicate with XBee modules.

Fork of XBeeLib by Digi International Inc.

FrameHandlers/FH_AtCmdResp.h@10:273032d9299a, 2018-03-27 (annotated)

Committer:
basvuyk
Date:
Tue Mar 27 14:13:12 2018 +0000
Revision:
10:273032d9299a
Parent:
6:06522f3a6642 
Slave V1.0

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 4:629712865107 27
spastor 0:fcaad0dfa051 28 public:
spastor 4:629712865107 29
spastor 0:fcaad0dfa051 30 /** Class constructor */
spastor 0:fcaad0dfa051 31 FH_AtCmdResp();
spastor 4:629712865107 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 4:629712865107 41
spastor 0:fcaad0dfa051 42 virtual void register_at_cmd_resp_cb(at_cmd_resp_cb_t function);
spastor 0:fcaad0dfa051 43
spastor 0:fcaad0dfa051 44 virtual void unregister_at_cmd_resp_cb();
spastor 0:fcaad0dfa051 45 };
spastor 0:fcaad0dfa051 46
spastor 0:fcaad0dfa051 47 /**
spastor 0:fcaad0dfa051 48 * @defgroup callback_types "Callback types declaration"
spastor 0:fcaad0dfa051 49 * @{
spastor 0:fcaad0dfa051 50 */
spastor 0:fcaad0dfa051 51 /** Node Discovery Response callback type declaration for ZigBee
spastor 0:fcaad0dfa051 52 * @param remote discovered remote node.
spastor 0:fcaad0dfa051 53 * @param node_id Node Identifier (NI parameter) of remote.
spastor 0:fcaad0dfa051 54 */
spastor 0:fcaad0dfa051 55 typedef void (*node_discovery_zb_cb_t)(const RemoteXBeeZB& remote, char const * const node_id);
spastor 0:fcaad0dfa051 56 /**
spastor 0:fcaad0dfa051 57 * @}
spastor 4:629712865107 58 */
spastor 0:fcaad0dfa051 59
spastor 0:fcaad0dfa051 60 class FH_NodeDiscoveryZB : public FH_AtCmdResp
spastor 0:fcaad0dfa051 61 {
spastor 0:fcaad0dfa051 62 private:
spastor 0:fcaad0dfa051 63 /** Callback function, invoked (if registered) when an at command response packet is received */
spastor 0:fcaad0dfa051 64 node_discovery_zb_cb_t node_discovery_cb;
spastor 4:629712865107 65
spastor 0:fcaad0dfa051 66 public:
spastor 4:629712865107 67
spastor 0:fcaad0dfa051 68 /** Class constructor */
spastor 0:fcaad0dfa051 69 FH_NodeDiscoveryZB();
spastor 0:fcaad0dfa051 70
spastor 0:fcaad0dfa051 71 /** Class destructor */
spastor 0:fcaad0dfa051 72 virtual ~FH_NodeDiscoveryZB();
spastor 0:fcaad0dfa051 73
spastor 0:fcaad0dfa051 74 virtual void process_frame_data(const ApiFrame *const frame);
spastor 4:629712865107 75
spastor 0:fcaad0dfa051 76 virtual void register_node_discovery_cb(node_discovery_zb_cb_t function);
spastor 0:fcaad0dfa051 77
spastor 0:fcaad0dfa051 78 virtual void unregister_node_discovery_cb();
spastor 0:fcaad0dfa051 79 };
spastor 0:fcaad0dfa051 80
spastor 0:fcaad0dfa051 81 /**
spastor 0:fcaad0dfa051 82 * @defgroup callback_types "Callback types declaration"
spastor 0:fcaad0dfa051 83 * @{
spastor 0:fcaad0dfa051 84 */
hbujanda 6:06522f3a6642 85 /** Node Discovery Response callback type declaration for ZigBee
hbujanda 6:06522f3a6642 86 * @param remote discovered remote node.
hbujanda 6:06522f3a6642 87 * @param node_id Node Identifier (NI parameter) of remote.
hbujanda 6:06522f3a6642 88 */
hbujanda 6:06522f3a6642 89 typedef void (*node_discovery_dm_cb_t)(const RemoteXBeeDM& remote, char const * const node_id);
hbujanda 6:06522f3a6642 90 /**
hbujanda 6:06522f3a6642 91 * @}
hbujanda 6:06522f3a6642 92 */
hbujanda 6:06522f3a6642 93
hbujanda 6:06522f3a6642 94 class FH_NodeDiscoveryDM : public FH_AtCmdResp
hbujanda 6:06522f3a6642 95 {
hbujanda 6:06522f3a6642 96 private:
hbujanda 6:06522f3a6642 97 /** Callback function, invoked (if registered) when an at command response packet is received */
hbujanda 6:06522f3a6642 98 node_discovery_dm_cb_t node_discovery_cb;
hbujanda 6:06522f3a6642 99
hbujanda 6:06522f3a6642 100 public:
hbujanda 6:06522f3a6642 101
hbujanda 6:06522f3a6642 102 /** Class constructor */
hbujanda 6:06522f3a6642 103 FH_NodeDiscoveryDM();
hbujanda 6:06522f3a6642 104
hbujanda 6:06522f3a6642 105 /** Class destructor */
hbujanda 6:06522f3a6642 106 virtual ~FH_NodeDiscoveryDM();
hbujanda 6:06522f3a6642 107
hbujanda 6:06522f3a6642 108 virtual void process_frame_data(const ApiFrame *const frame);
hbujanda 6:06522f3a6642 109
hbujanda 6:06522f3a6642 110 virtual void register_node_discovery_cb(node_discovery_dm_cb_t function);
hbujanda 6:06522f3a6642 111
hbujanda 6:06522f3a6642 112 virtual void unregister_node_discovery_cb();
hbujanda 6:06522f3a6642 113 };
hbujanda 6:06522f3a6642 114
hbujanda 6:06522f3a6642 115 /**
hbujanda 6:06522f3a6642 116 * @defgroup callback_types "Callback types declaration"
hbujanda 6:06522f3a6642 117 * @{
hbujanda 6:06522f3a6642 118 */
spastor 0:fcaad0dfa051 119 /** Node Discovery Response callback type declaration for 802.15.4
spastor 0:fcaad0dfa051 120 * @param remote discovered remote node.
spastor 0:fcaad0dfa051 121 * @param node_id Node Identifier (NI parameter) of remote.
spastor 0:fcaad0dfa051 122 */
spastor 0:fcaad0dfa051 123 typedef void (*node_discovery_802_cb_t)(const RemoteXBee802& remote, char const * const node_id);
spastor 0:fcaad0dfa051 124 /**
spastor 0:fcaad0dfa051 125 * @}
spastor 4:629712865107 126 */
spastor 0:fcaad0dfa051 127
spastor 0:fcaad0dfa051 128 class FH_NodeDiscovery802 : public FH_AtCmdResp
spastor 0:fcaad0dfa051 129 {
spastor 0:fcaad0dfa051 130 private:
spastor 0:fcaad0dfa051 131 /** Callback function, invoked (if registered) when an at command response packet is received */
spastor 0:fcaad0dfa051 132 node_discovery_802_cb_t node_discovery_cb;
spastor 4:629712865107 133
spastor 0:fcaad0dfa051 134 public:
spastor 4:629712865107 135
spastor 0:fcaad0dfa051 136 /** Class constructor */
spastor 0:fcaad0dfa051 137 FH_NodeDiscovery802();
spastor 0:fcaad0dfa051 138
spastor 0:fcaad0dfa051 139 /** Class destructor */
spastor 0:fcaad0dfa051 140 virtual ~FH_NodeDiscovery802();
spastor 0:fcaad0dfa051 141
spastor 0:fcaad0dfa051 142 virtual void process_frame_data(const ApiFrame *const frame);
spastor 4:629712865107 143
spastor 0:fcaad0dfa051 144 virtual void register_node_discovery_cb(node_discovery_802_cb_t function);
spastor 0:fcaad0dfa051 145
spastor 0:fcaad0dfa051 146 virtual void unregister_node_discovery_cb();
spastor 0:fcaad0dfa051 147 };
spastor 0:fcaad0dfa051 148
spastor 0:fcaad0dfa051 149 } /* namespace XBeeLib */
spastor 0:fcaad0dfa051 150
spastor 0:fcaad0dfa051 151 #endif /* __FH_AT_CMD_RESP_H_ */