Added c++ client API

5 files changed, 525 insertions, 0 deletions

diff --git a/doc/zmq-ctrl/cpp/OdrModCtrl.cpp b/doc/zmq-ctrl/cpp/OdrModCtrl.cpp
new file mode 100644
index 0000000..9b3f8dd
--- /dev/null
+++ b/doc/zmq-ctrl/cpp/OdrModCtrl.cpp
@@ -0,0 +1,306 @@
+/*!
+ * This is an implementation for the zmq ctrl API of the odr-dabmod.
+ *
+ * Copyright (c) 2015 by Jörgen Scott (jorgen.scott@paneda.se)
+ *
+ * ODR-DabMod is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * ODR-DabMod is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with ODR-DabMod.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * \code
+ * #include "OdrModCtrl.hpp"
+ * #include <zmq.hpp>
+ * ...
+ *  zmq::context_t ctx;
+ *  std::string error;
+ *  COdrModCtrl *pCtrl = new COdrModCtrl(&context, // zmq context
+ *							"tcp://127.0.0.1:9400", // zmq endpoint
+ *							1000); // timeout in milliseconds
+ *	if (pCtrl->SetTxGain(50, error))
+ *		std::cout << "Tx gain set to 50" << std::endl;
+ *	else
+ *		std::cout << "An error occured: " << error << std::endl;
+ *	delete pCtrl; // destructor will close zmq socket
+ *
+ * \endcode
+ **/
+#include "OdrModCtrl.hpp"
+#include <sstream>
+
+COdrModCtrl::COdrModCtrl(zmq::context_t *pContext, std::string odrEndpoint,
+		unsigned int timeoutMs)
+{
+	m_pContext = pContext;
+	m_odrEndpoint = odrEndpoint;
+	m_timeoutMs = (uint32_t) timeoutMs;
+}
+
+COdrModCtrl::~COdrModCtrl()
+{
+	if (m_pReqSocket != NULL)
+	{
+		m_pReqSocket->close();
+		delete m_pReqSocket;
+	}
+}
+
+//// public get methods /////////////////////////////////////////////////////////
+bool COdrModCtrl::GetDigitalGain(double &gain, std::string &error)
+{
+	return DoGet("gain", "digital", gain, error);
+}
+
+bool COdrModCtrl::GetTxGain(double &gain, std::string &error)
+{
+	return DoGet("uhd", "txgain", gain, error);
+}
+
+bool COdrModCtrl::GetTxFrequency(double &freqHz, std::string &error)
+{
+	return DoGet("uhd", "freq", freqHz, error);
+}
+
+bool COdrModCtrl::GetMuting(bool &mute, std::string &error)
+{
+	return DoGet("uhd", "muting", (uint32_t&) mute, error);
+}
+
+bool COdrModCtrl::GetStaticDelay(uint32_t &delayUs, std::string &error)
+{
+	return DoGet("uhd", "staticdelay", delayUs, error);
+}
+
+
+//// public set methods /////////////////////////////////////////////////////////
+
+bool COdrModCtrl::SetDigitalGain(const double gain, std::string &error)
+{
+	return DoSet("gain", "digital", gain, error);
+}
+
+bool COdrModCtrl::SetTxGain(const double gain, std::string &error)
+{
+	return DoSet("uhd", "txgain", gain, error);
+}
+
+bool COdrModCtrl::SetTxFrequency(const double freqHz, std::string &error)
+{
+	return DoSet("uhd", "freq", freqHz, error);
+}
+
+bool COdrModCtrl::SetMuting(const bool mute, std::string &error)
+{
+	return DoSet("uhd", "muting", mute, error);
+}
+
+bool COdrModCtrl::SetStaticDelay(const uint32_t delayUs, std::string &error)
+{
+	return DoSet("uhd", "staticdelay", delayUs, error);
+}
+
+
+//// private methods ////////////////////////////////////////////////////////////
+
+template<typename Type>
+bool COdrModCtrl::DoSet(const std::string module, const std::string parameter,
+		const Type value, std::string &error)
+{
+	if (m_pReqSocket == NULL)
+	{
+		m_pReqSocket = new zmq::socket_t(*m_pContext, ZMQ_REQ);
+		if (!ConnectSocket(m_pReqSocket, m_odrEndpoint, error))
+			return false;
+	}
+
+	std::vector<std::string> msg;
+	msg.push_back("set");
+	msg.push_back(module);
+	msg.push_back(parameter);
+	std::stringstream ss;
+	ss << value;
+	msg.push_back(ss.str());
+
+	// send the message
+	if (!SendMessage(m_pReqSocket, msg, error))
+	{
+		// destroy the socket according to the "Lazy Pirate Pattern" in 
+		// the zmq guide
+		m_pReqSocket->close();
+		delete m_pReqSocket;
+		m_pReqSocket = NULL;
+		return false;
+	}
+
+	// wait for reply
+	if (!RecvAll(m_pReqSocket, msg, m_timeoutMs, error))
+		return false;
+
+	return ParseSetReply(msg, error);
+}
+
+bool COdrModCtrl::ParseSetReply(const std::vector<std::string> &msg,
+		std::string &error)
+{
+	error = "";
+	if (msg.size() < 1)
+		error =  "Bad reply format";
+	else if (msg.size() == 1 && msg[0] == "ok")
+		return true;
+	else if (msg.size() == 2 && msg[0] == "fail")
+	{
+		error =  msg[1];
+		return false;
+	}
+	else
+	{
+		error = "Bad reply format";
+		return false;
+	}
+}
+
+template<typename Type>
+bool COdrModCtrl::DoGet(const std::string module, const std::string parameter,
+		Type &value, std::string &error)
+{
+	if (m_pReqSocket == NULL)
+	{
+		m_pReqSocket = new zmq::socket_t(*m_pContext, ZMQ_REQ);
+		if (!ConnectSocket(m_pReqSocket, m_odrEndpoint, error))
+			return false;
+	}
+
+	std::vector<std::string> msg;
+	msg.push_back("get");
+	msg.push_back(module);
+	msg.push_back(parameter);
+
+	// send the message
+	if (!SendMessage(m_pReqSocket, msg, error))
+	{
+		// destroy the socket according to the "Lazy Pirate Pattern" 
+		// in the zmq guide
+		m_pReqSocket->close();
+		delete m_pReqSocket;
+		m_pReqSocket = NULL;
+		return false;
+	}
+
+	// wait for reply
+	if (!RecvAll(m_pReqSocket, msg, m_timeoutMs, error))
+		return false;
+
+	return ParseGetReply(msg, value, error);
+}
+
+template<typename Type>
+bool COdrModCtrl::ParseGetReply(const std::vector<std::string> &msg,
+		Type &value, std::string &error)
+{
+	error = "";
+	if (msg.size() < 1)
+		error =  "Bad reply format";
+	else if (msg.size() == 1)
+	{
+		std::stringstream ss(msg[0]);
+		ss >> value;
+		return true;
+	}
+	else if (msg.size() == 2 && msg[0] == "fail")
+	{
+		error =  msg[1];
+		return false;
+	}
+	else
+	{
+		error = "Bad reply format";
+		return false;
+	}
+}
+
+bool COdrModCtrl::ConnectSocket(zmq::socket_t *pSocket, const std::string endpoint,
+		std::string &error)
+{
+	error = "";
+	try
+	{
+		int hwm = 1;
+		int linger = 0;
+		pSocket->setsockopt(ZMQ_RCVHWM, &hwm, sizeof(hwm));
+		pSocket->setsockopt(ZMQ_SNDHWM, &hwm, sizeof(hwm));
+		pSocket->setsockopt(ZMQ_LINGER, &linger, sizeof(linger));
+		pSocket->connect(endpoint.c_str());
+		return true;
+	}
+	catch(zmq::error_t &ex)
+	{
+		error = "Failed to connect: " + endpoint + 
+				std::string(". ZMQ: " + std::string(ex.what()));	
+		return false;
+	}
+}
+
+bool COdrModCtrl::SendMessage(zmq::socket_t* pSocket, 
+		const std::vector<std::string> &message, std::string &error)
+{
+	error = "";
+	try
+	{
+		std::vector<std::string>::size_type i = 0;
+		for ( ; i < message.size() - 1; i++)
+		{
+			zmq::message_t zmqMsg(message[i].length());
+			memcpy ((void*) zmqMsg.data(), message[i].data(), message[i].length());
+			pSocket->send(zmqMsg, ZMQ_SNDMORE);
+		}
+		zmq::message_t zmqMsg(message[i].length());
+		memcpy ((void*) zmqMsg.data(), message[i].data(), message[i].length());
+		pSocket->send(zmqMsg, 0);
+		return true;
+	}
+	catch(zmq::error_t &ex)
+	{
+		error = "ZMQ send error: " + std::string(ex.what());	
+		return false;
+	}
+}
+
+bool COdrModCtrl::RecvAll(zmq::socket_t* pSocket,
+		std::vector<std::string> &message, unsigned int timeoutMs,
+		std::string &error)
+{
+	error = "";
+	message.clear();
+
+	int more = -1;
+	size_t more_size = sizeof(more);
+	zmq::pollitem_t pollItems[] = { {*pSocket, 0, ZMQ_POLLIN, 0} };
+	zmq::poll(&pollItems[0], 1, timeoutMs);
+
+	while (more != 0)
+	{				
+		if (pollItems[0].revents & ZMQ_POLLIN)
+		{
+			zmq::message_t msg;
+			pSocket->recv(&msg);
+			message.push_back(std::string((char*)msg.data(), msg.size()));
+			pSocket->getsockopt(ZMQ_RCVMORE, &more, &more_size);
+		}
+		else
+		{
+			error = "Receive timeout";
+			return false;
+		}
+	}
+
+	return true;
+}
+
diff --git a/doc/zmq-ctrl/cpp/OdrModCtrl.hpp b/doc/zmq-ctrl/cpp/OdrModCtrl.hpp
new file mode 100644
index 0000000..0651311
--- /dev/null
+++ b/doc/zmq-ctrl/cpp/OdrModCtrl.hpp
@@ -0,0 +1,86 @@
+/**
+ * This is an interface for the zmq ctrl API of the odr-dabmod.
+ * The class is intended for clients that wish to control the odr-mod.
+ *
+ * Copyright (c) 2015 by Jörgen Scott (jorgen.scott@paneda.se)
+ *
+ * ODR-DabMod is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * ODR-DabMod is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with ODR-DabMod.  If not, see <http://www.gnu.org/licenses/>.
+ **/
+#pragma once
+
+#include <stdint.h>
+#include <string>
+#include <vector>
+#include <zmq.hpp>
+
+class COdrModCtrl
+{
+	public:
+		// ctors
+		COdrModCtrl(zmq::context_t *pContext, std::string odrEndpoint,
+				unsigned int timeoutMs);
+		virtual ~COdrModCtrl();
+
+		// All methods return true if successful, when false check the error
+		// string.
+		// 
+		// IMPORTANT! All methods must be accessed from the same thread.
+		//
+		// For a detailed description of the various parameters, see
+		// example.ini.
+		virtual bool GetDigitalGain(double &gain, std::string &error);
+		virtual bool GetTxGain(double &gain, std::string &error);
+		virtual bool GetTxFrequency(double &freqHz, std::string &error);
+		virtual bool GetMuting(bool &mute, std::string &error);
+		virtual bool GetStaticDelay(uint32_t &delayUs, std::string &error);
+
+		virtual bool SetDigitalGain(const double gain, std::string &error);
+		virtual bool SetTxGain(const double gain, std::string &error);
+		virtual bool SetTxFrequency(const double freqHz, std::string &error);
+		virtual bool SetMuting(const bool mute, std::string &error);
+		virtual bool SetStaticDelay(const uint32_t delayUs, std::string &error);
+	
+	private:
+		// methods
+		
+		template<typename Type>
+		bool DoSet(const std::string module, const std::string parameter,
+				const Type value, std::string &error);
+
+		bool ParseSetReply(const std::vector<std::string> &msg, std::string &error);
+
+		template<typename Type>
+		bool DoGet(const std::string module, const std::string parameter,
+				Type &value, std::string &error);
+
+		template<typename Type>
+		bool ParseGetReply(const std::vector<std::string> &msg, Type &value,
+				std::string &error);
+
+		bool ConnectSocket(zmq::socket_t *pSocket, const std::string endpoint,
+			std::string &error);
+
+		bool SendMessage(zmq::socket_t* pSocket,
+				const std::vector<std::string> &message, std::string &error);
+
+		bool RecvAll(zmq::socket_t* pSocket,
+				std::vector<std::string> &message, unsigned int timeoutMs,
+				std::string &error);
+
+		// data
+		zmq::context_t *m_pContext;
+		std::string m_odrEndpoint;
+		uint32_t m_timeoutMs;
+		zmq::socket_t *m_pReqSocket;
+};
diff --git a/doc/zmq-ctrl/cpp/test/CMakeLists.txt b/doc/zmq-ctrl/cpp/test/CMakeLists.txt
new file mode 100755
index 0000000..4b877d0
--- /dev/null
+++ b/doc/zmq-ctrl/cpp/test/CMakeLists.txt
@@ -0,0 +1,31 @@
+cmake_minimum_required(VERSION 2.6)
+project (ctrl_test)
+ 
+ADD_DEFINITIONS(-DBOOST_TEST_DYN_LINK -D_SCL_SECURE_NO_WARNINGS)
+
+set(BOOST_LIBRARYDIR)
+set(BOOST_INCLUDEDIR)
+set(BOOST_USE_MULTITHREADED ON)
+set(BOOST_USE_STATIC_LIBS ON)
+set(BOOST_MIN_VERSION 1.55)
+
+find_package( Boost ${BOOST_MIN_VERSION} REQUIRED 
+            unit_test_framework 
+            system 
+            )
+
+set(PROJECT_TEST_SRCS 
+${CMAKE_CURRENT_SOURCE_DIR}/ctrl_test.cpp
+${CMAKE_CURRENT_SOURCE_DIR}/../OdrModCtrl.cpp
+)
+
+include_directories( ${PROJECT_SOURCE_DIR}/../ )
+link_directories (/usr/local/lib)
+add_executable(${PROJECT_NAME} ${PROJECT_TEST_SRCS})
+
+target_link_libraries(${PROJECT_NAME}
+	zmq 
+	${Boost_LIBRARIES}
+	)
+
+SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}") 
diff --git a/doc/zmq-ctrl/cpp/test/README b/doc/zmq-ctrl/cpp/test/README
new file mode 100644
index 0000000..76a1188
--- /dev/null
+++ b/doc/zmq-ctrl/cpp/test/README
@@ -0,0 +1,14 @@
+Instructions for zmq ctrl api test program
+
+Dependencies boost, zmq (and cpp binding through zmq.hpp)
+
+Build instruction (make sure your in the directory of this file)
+* mkdir build
+* cd build
+* cmake ../
+* make
+
+Run
+* make sure the ODR-DABMOD is started and that zmq ctrl api is enabled
+* make sure the zmq endpoint matches (see ctrl_test.cpp)
+* run the ctrl_test
diff --git a/doc/zmq-ctrl/cpp/test/ctrl_test.cpp b/doc/zmq-ctrl/cpp/test/ctrl_test.cpp
new file mode 100644
index 0000000..3c38c89
--- /dev/null
+++ b/doc/zmq-ctrl/cpp/test/ctrl_test.cpp
@@ -0,0 +1,88 @@
+/**
+ * This is a test program for the zmq ctrl API of the odr-dabmod.
+ *
+ * Copyright (c) 2015 by Jörgen Scott (jorgen.scott@paneda.se)
+ 
+ * This file is part of CtrlTest.
+ *
+ * ODR-DabMod is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * ODR-DabMod is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with ODR-DabMod.  If not, see <http://www.gnu.org/licenses/>.
+ **/
+#define BOOST_TEST_MODULE "C++ unit tests for odr-mod zmq ctrl"
+#include <boost/test/unit_test.hpp>
+#include "OdrModCtrl.hpp"
+
+
+// Variables used in the test suite
+struct TemplateVars
+{
+	std::string error;
+	zmq::context_t context;
+	COdrModCtrl modCtrl;
+
+	// NOTE: Make sure the odr-dabmod is started before running the test and
+	// that the zmq endpoint matches.
+	TemplateVars() : context(1), modCtrl(&context, "tcp://127.0.0.1:9400", 1000) {}
+	~TemplateVars() {}
+};
+
+// Note. The odr-mod do not validate parameters therefore there are no tests
+// made for setting invalid parameters.
+BOOST_FIXTURE_TEST_SUITE(test_template1, TemplateVars)
+
+BOOST_AUTO_TEST_CASE (DigitalGain)
+{
+	BOOST_CHECK(modCtrl.SetDigitalGain(0.5, error) == true);
+	double value;
+	BOOST_CHECK(modCtrl.GetDigitalGain(value, error) == true);
+	BOOST_CHECK(value == 0.5);
+}
+
+BOOST_AUTO_TEST_CASE (TxGain)
+{
+	BOOST_CHECK(modCtrl.SetTxGain(50, error) == true);
+	double value;
+	BOOST_CHECK(modCtrl.GetTxGain(value, error) == true);
+	BOOST_CHECK(value == 50);
+}
+
+BOOST_AUTO_TEST_CASE (TxFrequency)
+{
+	BOOST_CHECK(modCtrl.SetTxFrequency(234208000, error) == true);
+	double value;
+	BOOST_CHECK(modCtrl.GetTxFrequency(value, error) == true);
+	BOOST_CHECK(value == 234208000);
+}
+
+BOOST_AUTO_TEST_CASE (Muting)
+{
+	BOOST_CHECK(modCtrl.SetMuting(true, error) == true);
+	bool value;
+	BOOST_CHECK(modCtrl.GetMuting(value, error) == true);
+	BOOST_CHECK(value == true);
+	BOOST_CHECK(modCtrl.SetMuting(false, error) == true);
+}
+
+BOOST_AUTO_TEST_CASE (StaticDelay)
+{
+	// reset first or else test will fail on successive calls	
+	BOOST_CHECK(modCtrl.SetStaticDelay(-1, error) == true);
+	BOOST_CHECK(modCtrl.SetStaticDelay(45000, error) == true);
+	uint32_t value;
+	BOOST_CHECK(modCtrl.GetStaticDelay(value, error) == true);
+	BOOST_CHECK(value == 45000);
+}
+
+
+BOOST_AUTO_TEST_SUITE_END()
+