Beginning of work on obd2 object and

files reorganization.

Change-Id: Idaa7ad05c45d734ce771506fd6e41f1a09a6ac66
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>

6 files changed, 484 insertions, 0 deletions

diff --git a/src/utils/openxc-utils.cpp b/src/utils/openxc-utils.cpp
new file mode 100644
index 00000000..40745a06
--- /dev/null
+++ b/src/utils/openxc-utils.cpp
@@ -0,0 +1,134 @@
+/*
+ * Copyright (C) 2015, 2016 "IoT.bzh"
+ * Author "Romain Forlot" <romain.forlot@iot.bzh>
+ * Author "Loic Collignon" <loic.collignon@iot.bzh>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *	 http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "openxc-utils.hpp"
+
+openxc_VehicleMessage build_VehicleMessage_with_SimpleMessage(openxc_DynamicField_Type type, const openxc_SimpleMessage& message)
+{
+	struct timeb t_msec;
+	long long int timestamp_msec;
+	
+	openxc_VehicleMessage v;
+	
+	if(!::ftime(&t_msec))
+	{
+		timestamp_msec = ((long long int) t_msec.time) * 1000ll + 
+							(long long int) t_msec.millitm;
+
+		v.has_type = true;
+		v.type = openxc_VehicleMessage_Type::openxc_VehicleMessage_Type_SIMPLE;
+		v.has_simple_message = true;
+		v.simple_message =  message;
+		v.has_timestamp = true;
+		v.timestamp = timestamp_msec;
+
+		return v;
+	}
+
+	v.has_type = true,
+	v.type = openxc_VehicleMessage_Type::openxc_VehicleMessage_Type_SIMPLE;
+	v.has_simple_message = true;
+	v.simple_message =  message;
+
+	return v;
+}
+
+openxc_SimpleMessage build_SimpleMessage(const std::string& name, const openxc_DynamicField& value)
+{
+	openxc_SimpleMessage s;
+
+	s.has_name = true;
+	::strncpy(s.name, name.c_str(), 100);
+	s.has_value = true;
+	s.value = value;
+
+	return s;
+}
+
+openxc_DynamicField build_DynamicField(const std::string& value)
+{
+	openxc_DynamicField d;
+	d.has_type = true;
+	d.type = openxc_DynamicField_Type_STRING;
+	
+	d.has_string_value = true;
+	d.has_numeric_value = false;
+	d.has_boolean_value = false;
+	::strncpy(d.string_value, value.c_str(), 100);
+	
+	return d;
+}
+
+openxc_DynamicField build_DynamicField(double value)
+{
+	openxc_DynamicField d;
+	d.has_type = true;
+	d.type = openxc_DynamicField_Type_NUM;
+	
+	d.has_string_value = false;
+	d.has_numeric_value = true;
+	d.has_boolean_value = false;
+	d.numeric_value = value;
+	
+	return d;
+}
+
+openxc_DynamicField build_DynamicField(bool value)
+{
+	openxc_DynamicField d;
+	d.has_type = true;
+	d.type = openxc_DynamicField_Type_BOOL;
+	
+	d.has_string_value = false;
+	d.has_numeric_value = false;
+	d.has_boolean_value = true;
+	d.boolean_value = value;
+	
+	return d;
+}
+
+openxc_SimpleMessage get_simple_message(const openxc_VehicleMessage& v_msg)
+{
+	if (v_msg.has_simple_message)
+		return v_msg.simple_message;
+	
+	openxc_SimpleMessage s_msg = { false, "", false, build_DynamicField(false), false, build_DynamicField(false)};
+	return s_msg;
+}
+
+void jsonify_DynamicField(const openxc_DynamicField& field, json_object* value)
+{
+	if(field.has_numeric_value)
+		json_object_object_add(value, "value", json_object_new_double(field.numeric_value));
+	else if(field.has_boolean_value)
+		json_object_object_add(value, "value", json_object_new_boolean(field.boolean_value));
+	else if(field.has_string_value)
+		json_object_object_add(value, "value", json_object_new_string(field.string_value));
+}
+
+bool jsonify_simple(const openxc_SimpleMessage& s_msg, json_object* json)
+{
+	if(s_msg.has_name)
+	{
+		json_object_object_add(json, "name", json_object_new_string(s_msg.name));
+		jsonify_DynamicField(s_msg.value, json);
+		return true;
+	}
+	json_object_object_add(json, "error", json_object_new_string("openxc_SimpleMessage doesn't have name'"));
+	return false;
+}
\ No newline at end of file
diff --git a/src/utils/openxc-utils.hpp b/src/utils/openxc-utils.hpp
new file mode 100644
index 00000000..b7fa7884
--- /dev/null
+++ b/src/utils/openxc-utils.hpp
@@ -0,0 +1,126 @@
+/*
+ * Copyright (C) 2015, 2016 "IoT.bzh"
+ * Author "Romain Forlot" <romain.forlot@iot.bzh>
+ * Author "Loic Collignon" <loic.collignon@iot.bzh>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *	 http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include <string>
+#include <json-c/json.h>
+#include <sys/timeb.h>
+
+#include "openxc.pb.h"
+
+/**
+ * @fn openxc_VehicleMessage build_VehicleMessage_with_SimpleMessage(openxc_DynamicField_Type type, const openxc_SimpleMessage& message);
+ *
+ * @brief Build a specific VehicleMessage containing a SimpleMessage.
+ *
+ * @param[in] openxc_DynamicField_Type type - The type of message to build
+ * @param[in] openxc_SimpleMessage& message - simple message to include into openxc_VehicleMessage
+ *
+ * @return openxc_VehicleMessage - a vehicle message including simple message that will be convert into 
+ * a JSON object before being pushed to the subscribers
+ */
+openxc_VehicleMessage build_VehicleMessage_with_SimpleMessage(openxc_DynamicField_Type type, const openxc_SimpleMessage& message);
+
+/**
+ * @fn openxc_SimpleMessage build_SimpleMessage(const std::string& name, const openxc_DynamicField& value);
+ *
+ * @brief Build an openxc_SimpleMessage associating a name to an openxc_DynamicField
+ *
+ * @param[in] std::string name - const string reference name to assign to the created SimpleMessage
+ *  this will set has_name member to true and assign name to the name member. Maximum size for name is 
+ *  set to 100 char.
+ * @param[in] openxc_DynamicField value - const reference with DynamicField to assign to SimpleMessage
+ *  value.
+ *
+ * @return an openxc_SimpleMessage struct initialized with name and value provided.
+ */
+openxc_SimpleMessage build_SimpleMessage(const std::string& name, const openxc_DynamicField& value);
+
+/**
+ * @fn openxc_DynamicField build_DynamicField(const std::string& value);
+ *
+ * @brief Build an openxc_DynamicField with a string value
+ *
+ * @param std::string value - const string reference value to assign to builded
+ *  openxc_DynamicField.
+ *
+ * @return openxc_DynamicField initialized with a string value.
+ */
+openxc_DynamicField build_DynamicField(const std::string& value);
+
+/**
+ * @fn openxc_DynamicField build_DynamicField(double value);
+ *
+ * @brief Build an openxc_DynamicField with a double value
+ *
+ * @param double value - double value to assign to builded openxc_DynamicField.
+ *
+ * @return openxc_DynamicField initialized with a double value.
+ */
+openxc_DynamicField build_DynamicField(double value);
+
+/**
+ * @fn openxc_DynamicField build_DynamicField(bool value);
+ *
+ * @brief Build an openxc_DynamicField with a boolean value
+ *
+ * @param bool value - boolean value to assign to builded openxc_DynamicField.
+ *
+ * @return openxc_DynamicField initialized with a boolean value.
+ */
+openxc_DynamicField build_DynamicField(bool value);
+
+/**
+ * @fn void jsonify_DynamicField(const openxc_DynamicField& field, json_object* value);
+ *
+ * @brief Make a JSON object from a DynamicField
+ *
+ * @param[in] openxc_DynamicField field - openxc_DynamicField struct to convert into
+ *  a json object.
+ * @param[out] json_object pointer with the DynamicField converted
+ */
+void jsonify_DynamicField(const openxc_DynamicField& field, json_object* value);
+
+/**
+ * @fn openxc_SimpleMessage get_simple_message(const openxc_VehicleMessage& v_msg);
+ *
+ * @brief Extract the simple message value from an openxc_VehicleMessage
+ *  and return it. If there isn't SimpleMessage in the VehicleMessage then
+ *  returned value will be a SimpleMessage with all field set at false.
+ *  DynamicField from SimpleMessage will be boolean DynamicField set to false too.
+ *
+ * @param[in] openxc_VehicleMessage - const reference to openxc_VehicleMessage
+ *
+ * @return openxc_SimpleMessage - SimpleMessage from the provided VehicleMessage.
+ */
+openxc_SimpleMessage get_simple_message(const openxc_VehicleMessage& v_msg);
+
+/**
+ * @fn json_object* jsonify_simple(const openxc_SimpleMessage& s_msg);
+ *
+ * @brief Make a JSON object from a SimpleMessage
+ *
+ * @param[in] openxc_SimpleMessage s_msg - const reference to an openxc_SimpleMessage 
+ * struct to convert into a json object.
+ * @param[out] json_object pointer with the DynamicField converted
+ * 
+ * @return boolean value - true if SimpleMessage has been transformed into json object
+ *  and false if not. In such case, a json object is returned { "error": "error msg"}
+ */
+bool jsonify_simple(const openxc_SimpleMessage& s_msg, json_object* json);
\ No newline at end of file
diff --git a/src/utils/signals.cpp b/src/utils/signals.cpp
new file mode 100644
index 00000000..6e2f396a
--- /dev/null
+++ b/src/utils/signals.cpp
@@ -0,0 +1,76 @@
+/*
+ * Copyright (C) 2015, 2016 "IoT.bzh"
+ * Author "Romain Forlot" <romain.forlot@iot.bzh>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *	 http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "signals.hpp"
+
+/** 
+ * @brief Can signal event map making access to afb_event
+ * externaly to an openxc existing structure.
+ *
+ * @desc Event map is making relation between CanSignal generic name
+ * and the afb_event struct used by application framework to pushed
+ * to the subscriber.
+ */
+std::map<std::string, struct afb_event> subscribed_signals;
+
+/**
+* @brief Mutex allowing safe manipulation on subscribed_signals map.
+* @desc To ensure that the map object isn't modified when we read it, you
+*  have to set this mutex before use subscribed_signals map object.
+*/
+std::mutex subscribed_signals_mutex;
+
+std::mutex& get_subscribed_signals_mutex()
+{
+	return subscribed_signals_mutex;
+}
+
+std::map<std::string, struct afb_event>& get_subscribed_signals()
+{
+	return subscribed_signals;
+}
+
+/**
+ * @fn std::vector<std::string> find_signals(const openxc_DynamicField &key)
+ * @brief return signals name found searching through CAN_signals and OBD2 pid
+ *
+ * @param[in] const openxc_DynamicField : can contain numeric or string value in order to search against 
+ *   can signals or obd2 signals name.
+ *
+ * @return std::vector<std::string> Vector of signals name found. 
+ */
+std::vector<std::string> find_signals(const openxc_DynamicField &key)
+{
+	std::vector<std::string> found_signals_name;
+
+	switch(key.type)
+	{
+		case openxc_DynamicField_Type::openxc_DynamicField_Type_STRING:
+				lookup_signals_by_name(key.string_value, get_can_signals(), found_signals_name);
+				lookup_signals_by_name(key.string_value, get_obd2_signals(), found_signals_name);
+			break;
+		case openxc_DynamicField_Type::openxc_DynamicField_Type_NUM:
+				lookup_signals_by_id(key.numeric_value, get_can_signals(), found_signals_name);
+				lookup_signals_by_id(key.numeric_value, get_obd2_signals(), found_signals_name);
+			break;
+		default:
+			ERROR(binder_interface, "find_signals: wrong openxc_DynamicField specified. Use openxc_DynamicField_Type_NUM or openxc_DynamicField_Type_STRING type only.");
+			break;
+	}
+	DEBUG(binder_interface, "Found %d signal(s)", (int)found_signals_name.size());
+	return found_signals_name;
+}
diff --git a/src/utils/signals.hpp b/src/utils/signals.hpp
new file mode 100644
index 00000000..81ed4248
--- /dev/null
+++ b/src/utils/signals.hpp
@@ -0,0 +1,72 @@
+/*
+ * Copyright (C) 2015, 2016 "IoT.bzh"
+ * Author "Romain Forlot" <romain.forlot@iot.bzh>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *	 http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include <vector>
+#include <string>
+#include <fnmatch.h>
+
+#include "openxc.pb.h"
+#include "can-signals.hpp"
+#include "obd2-signals.hpp"
+
+template <typename T>
+void lookup_signals_by_name(const std::string& key, std::vector<T>& signals, std::vector<T*>& found_signals)
+{
+	for(T& s : signals)
+	{
+		if(::fnmatch(key.c_str(), s.generic_name, FNM_CASEFOLD) == 0)
+			found_signals.push_back(&s);
+	}
+}
+
+template <typename T>
+void lookup_signals_by_name(const std::string& key, std::vector<T>& signals, std::vector<std::string>& found_signals_name)
+{
+	for(const T& s : signals)
+	{
+		if(::fnmatch(key.c_str(), s.generic_name, FNM_CASEFOLD) == 0)
+			found_signals_name.push_back(s.generic_name);
+	}
+}
+
+template <typename T>
+void lookup_signals_by_id(const double key, std::vector<T>& signals, std::vector<T*>& found_signals)
+{
+	for(T& s : signals)
+	{
+		if(get_signal_id(s) == key)
+		{
+			found_signals.push_back(&s);
+		}
+	}
+}
+
+template <typename T>
+void lookup_signals_by_id(const double key, std::vector<T>& signals, std::vector<std::string>& found_signals_name)
+{
+	for(T& s : signals)
+	{
+		if(get_signal_id(s) == key)
+		{
+			found_signals_name.push_back(s.generic_name);
+		}
+	}
+}
+
+std::vector<std::string> find_signals(const openxc_DynamicField &key);
diff --git a/src/utils/timer.cpp b/src/utils/timer.cpp
new file mode 100644
index 00000000..01fd7636
--- /dev/null
+++ b/src/utils/timer.cpp
@@ -0,0 +1,31 @@
+/*
+ * Copyright (C) 2015, 2016 "IoT.bzh"
+ * Author "Romain Forlot" <romain.forlot@iot.bzh>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *	 http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "timer.hpp"
+
+long long int systemTimeMs()
+{
+	struct timeb t_msec;
+	long long int timestamp_msec;
+	
+	if(!::ftime(&t_msec))
+	{
+		timestamp_msec = (t_msec.time) * 1000ll + 
+			t_msec.millitm;
+	}
+	return timestamp_msec;
+}
\ No newline at end of file
diff --git a/src/utils/timer.hpp b/src/utils/timer.hpp
new file mode 100644
index 00000000..7d0e4669
--- /dev/null
+++ b/src/utils/timer.hpp
@@ -0,0 +1,45 @@
+/*
+ * Copyright (C) 2015, 2016 "IoT.bzh"
+ * Author "Romain Forlot" <romain.forlot@iot.bzh>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *	 http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include <sys/timeb.h>
+
+/*
+ * @brief return epoch in milliseconds
+ *
+ * @return long long int epoch in milliseconds
+ */
+typedef long long int (*TimeFunction)();
+
+/**
+ * @struct FrequencyClock 
+ * @brief A frequency counting clock.
+ *
+ * @var FrequencyClock::frequency
+ *  the clock frequency in Hz.
+ * @var FrequencyClock::last_time
+ *  the last time (in milliseconds since startup) that the clock
+ *	ticked.
+ * @var FrequencyClock::time_function
+ *  a function returning current time
+ */
+typedef struct {
+		float frequency;
+		unsigned long lastTick;
+		TimeFunction timeFunction;
+} FrequencyClock;
\ No newline at end of file