Add response specific callbacks

This adds a callback for each type of response that exists. Whenever a
respons is received, the corresponding callback is called. When it is
not defined, the onOtherResponse callback is called instead.

Author: matthijskooijman

XBee.cpp

@@ -1602,6 +1602,65 @@ void XBeeWithCallbacks::loop() {
 	readPacket();
 	if (getResponse().isAvailable()) {
 		_onResponse.call(getResponse());
+
+		bool called = false;
+
+		uint8_t id = getResponse().getApiId();
+
+		if (id == ZB_TX_STATUS_RESPONSE) {
+			ZBTxStatusResponse response;
+			getResponse().getZBTxStatusResponse(response);
+			called = _onZBTxStatusResponse.call(response);
+		} else if (id == ZB_RX_RESPONSE) {
+			ZBRxResponse response;
+			getResponse().getZBRxResponse(response);
+			called = _onZBRxResponse.call(response);
+		} else if (id == ZB_EXPLICIT_RX_RESPONSE) {
+			ZBExplicitRxResponse response;
+			getResponse().getZBExplicitRxResponse(response);
+			called = _onZBExplicitRxResponse.call(response);
+		} else if (id == ZB_IO_SAMPLE_RESPONSE) {
+			ZBRxIoSampleResponse response;
+			getResponse().getZBRxIoSampleResponse(response);
+			called = _onZBRxIoSampleResponse.call(response);
+		} else if (id == TX_STATUS_RESPONSE) {
+			TxStatusResponse response;
+			getResponse().getTxStatusResponse(response);
+			called = _onTxStatusResponse.call(response);
+		} else if (id == RX_16_RESPONSE) {
+			Rx16Response response;
+			getResponse().getRx16Response(response);
+			called = _onRx16Response.call(response);
+		} else if (id == RX_64_RESPONSE) {
+			Rx64Response response;
+			getResponse().getRx64Response(response);
+			called = _onRx64Response.call(response);
+		} else if (id == RX_16_IO_RESPONSE) {
+			Rx16IoSampleResponse response;
+			getResponse().getRx16IoSampleResponse(response);
+			called = _onRx16IoSampleResponse.call(response);
+		} else if (id == RX_64_IO_RESPONSE) {
+			Rx64IoSampleResponse response;
+			getResponse().getRx64IoSampleResponse(response);
+			called = _onRx64IoSampleResponse.call(response);
+		} else if (id == MODEM_STATUS_RESPONSE) {
+			ModemStatusResponse response;
+			getResponse().getModemStatusResponse(response);
+			called = _onModemStatusResponse.call(response);
+		} else if (id == AT_COMMAND_RESPONSE) {
+			AtCommandResponse response;
+			getResponse().getAtCommandResponse(response);
+			called = _onAtCommandResponse.call(response);
+		} else if (id == REMOTE_AT_COMMAND_RESPONSE) {
+			RemoteAtCommandResponse response;
+			getResponse().getRemoteAtCommandResponse(response);
+			called = _onRemoteAtCommandResponse.call(response);
+		}
+
+		if (!called)
+			_onOtherResponse.call(getResponse());
+
+
 	} else if (getResponse().isError()) {
 		_onPacketError.call(getResponse().getErrorCode());
 	}

XBee.h

@@ -808,20 +808,54 @@ class XBeeWithCallbacks : public XBee {
 	/**
 	 * Register a packet error callback. It is called whenever an
 	 * error occurs in the packet reading process. Arguments to the
-	 * callback will be the error code and the data parameter.
-	 * while registering the callback.
+	 * callback will be the error code (as returned by
+	 * XBeeResponse::getErrorCode()) and the data parameter.  while
+	 * registering the callback.
 	 */
 	void onPacketError(void (*func)(uint8_t, uintptr_t), uintptr_t data = 0) { _onPacketError.set(func, data); }
 
 	/**
 	 * Register a response received callback. It is called whenever
-	 * a response was succesfully received.
+	 * a response was succesfully received, before a response
+	 * specific callback (or onOtherResponse) below is called.
 	 *
 	 * Arguments to the callback will be the received response and
 	 * the data parameter passed while registering the callback.
 	 */
 	void onResponse(void (*func)(XBeeResponse&, uintptr_t), uintptr_t data = 0) { _onResponse.set(func, data); }
 
+	/**
+	 * Register an other response received callback. It is called
+	 * whenever a response was succesfully received, but no response
+	 * specific callback was registered using the functions below
+	 * (after the onResponse callback is called).
+	 *
+	 * Arguments to the callback will be the received response and
+	 * the data parameter passed while registering the callback.
+	 */
+	void onOtherResponse(void (*func)(XBeeResponse&, uintptr_t), uintptr_t data = 0) { _onOtherResponse.set(func, data); }
+
+	// These functions register a response specific callback. They
+	// are called whenever a response of the appropriate type was
+	// succesfully received (after the onResponse callback is
+	// called).
+	//
+	// Arguments to the callback will be the received response
+	// (already converted to the appropriate type) and the data
+	// parameter passed while registering the callback.
+	void onZBTxStatusResponse(void (*func)(ZBTxStatusResponse&, uintptr_t), uintptr_t data = 0) { _onZBTxStatusResponse.set(func, data); }
+	void onZBRxResponse(void (*func)(ZBRxResponse&, uintptr_t), uintptr_t data = 0) { _onZBRxResponse.set(func, data); }
+	void onZBExplicitRxResponse(void (*func)(ZBExplicitRxResponse&, uintptr_t), uintptr_t data = 0) { _onZBExplicitRxResponse.set(func, data); }
+	void onZBRxIoSampleResponse(void (*func)(ZBRxIoSampleResponse&, uintptr_t), uintptr_t data = 0) { _onZBRxIoSampleResponse.set(func, data); }
+	void onTxStatusResponse(void (*func)(TxStatusResponse&, uintptr_t), uintptr_t data = 0) { _onTxStatusResponse.set(func, data); }
+	void onRx16Response(void (*func)(Rx16Response&, uintptr_t), uintptr_t data = 0) { _onRx16Response.set(func, data); }
+	void onRx64Response(void (*func)(Rx64Response&, uintptr_t), uintptr_t data = 0) { _onRx64Response.set(func, data); }
+	void onRx16IoSampleResponse(void (*func)(Rx16IoSampleResponse&, uintptr_t), uintptr_t data = 0) { _onRx16IoSampleResponse.set(func, data); }
+	void onRx64IoSampleResponse(void (*func)(Rx64IoSampleResponse&, uintptr_t), uintptr_t data = 0) { _onRx64IoSampleResponse.set(func, data); }
+	void onModemStatusResponse(void (*func)(ModemStatusResponse&, uintptr_t), uintptr_t data = 0) { _onModemStatusResponse.set(func, data); }
+	void onAtCommandResponse(void (*func)(AtCommandResponse&, uintptr_t), uintptr_t data = 0) { _onAtCommandResponse.set(func, data); }
+	void onRemoteAtCommandResponse(void (*func)(RemoteAtCommandResponse&, uintptr_t), uintptr_t data = 0) { _onRemoteAtCommandResponse.set(func, data); }
+
 	/**
 	 * Regularly call this method, which ensures that the serial
 	 * buffer is processed and the appropriate callbacks are called.
@@ -846,6 +880,19 @@ class XBeeWithCallbacks : public XBee {
 
 	Callback<uint8_t> _onPacketError;
 	Callback<XBeeResponse&> _onResponse;
+	Callback<XBeeResponse&> _onOtherResponse;
+	Callback<ZBTxStatusResponse&> _onZBTxStatusResponse;
+	Callback<ZBRxResponse&> _onZBRxResponse;
+	Callback<ZBExplicitRxResponse&> _onZBExplicitRxResponse;
+	Callback<ZBRxIoSampleResponse&> _onZBRxIoSampleResponse;
+	Callback<TxStatusResponse&> _onTxStatusResponse;
+	Callback<Rx16Response&> _onRx16Response;
+	Callback<Rx64Response&> _onRx64Response;
+	Callback<Rx16IoSampleResponse&> _onRx16IoSampleResponse;
+	Callback<Rx64IoSampleResponse&> _onRx64IoSampleResponse;
+	Callback<ModemStatusResponse&> _onModemStatusResponse;
+	Callback<AtCommandResponse&> _onAtCommandResponse;
+	Callback<RemoteAtCommandResponse&> _onRemoteAtCommandResponse;
 };
 
 /**