diff options
| -rw-r--r-- | src/can_event_push.cpp | 9 | ||||
| -rw-r--r-- | src/can_event_push.hpp | 2 | ||||
| -rw-r--r-- | src/openxc-utils.cpp | 27 | ||||
| -rw-r--r-- | src/openxc-utils.hpp | 71 | ||||
| -rw-r--r-- | src/timer.hpp | 17 |
5 files changed, 100 insertions, 26 deletions
diff --git a/src/can_event_push.cpp b/src/can_event_push.cpp index 703a242..2842c63 100644 --- a/src/can_event_push.cpp +++ b/src/can_event_push.cpp @@ -22,6 +22,7 @@ void can_event_push(can_bus_t& can_bus) { openxc_VehicleMessage v_message; openxc_SimpleMessage s_message; + json_object* jo; while(can_bus.has_vehicle_message()) { @@ -30,6 +31,10 @@ void can_event_push(can_bus_t& can_bus) std::map<std::string, struct afb_event> subscribed_signals = get_subscribed_signals(); const auto& it_event = subscribed_signals.find(s_message.name); if(it_event != subscribed_signals.end() && afb_event_is_valid(it_event->second)) - afb_event_push(it_event->second, jsonify_simple(s_message)); + { + jo = json_object_new_object(); + jsonify_simple(s_message, jo); + afb_event_push(it_event->second, jo); + } } -} +}
\ No newline at end of file diff --git a/src/can_event_push.hpp b/src/can_event_push.hpp index 7497a1c..0e614f1 100644 --- a/src/can_event_push.hpp +++ b/src/can_event_push.hpp @@ -16,7 +16,7 @@ * limitations under the License. */ - #pragma once +#pragma once #include "can-utils.hpp" #include "can-signals.hpp" diff --git a/src/openxc-utils.cpp b/src/openxc-utils.cpp index cef8681..bbea968 100644 --- a/src/openxc-utils.cpp +++ b/src/openxc-utils.cpp @@ -96,6 +96,15 @@ openxc_DynamicField build_DynamicField(bool 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) @@ -106,25 +115,15 @@ void jsonify_DynamicField(const openxc_DynamicField& field, json_object* value) json_object_object_add(value, "value", json_object_new_string(field.string_value)); } -openxc_SimpleMessage get_simple_message(const openxc_VehicleMessage& v_msg) +bool jsonify_simple(const openxc_SimpleMessage& s_msg, json_object* json) { - if (v_msg.has_simple_message) - return v_msg.simple_message; - - openxc_SimpleMessage s_msg = { true, "", false, build_DynamicField(false), false, build_DynamicField(false)}; - return s_msg; -} - -json_object* jsonify_simple(const openxc_SimpleMessage& s_msg) -{ - json_object *json; - json = nullptr; - if(s_msg.has_name) { json = json_object_new_object(); json_object_object_add(json, "name", json_object_new_string(s_msg.name)); jsonify_DynamicField(s_msg.value, json); + return true; } - return json; + 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/openxc-utils.hpp b/src/openxc-utils.hpp index ad2d1c5..b7fa788 100644 --- a/src/openxc-utils.hpp +++ b/src/openxc-utils.hpp @@ -25,6 +25,8 @@ #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 @@ -36,30 +38,89 @@ 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); + /** - * @brief Build an openxc_DynamicField depending what we pass as argument + * @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); /** - * @brief Build an openxc_DynamicField depending what we pass as argument + * @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); /** - * @brief Build an openxc_DynamicField depending what we pass as argument + * @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, or null if there isn't. + * 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); -json_object* jsonify_simple(const openxc_SimpleMessage& s_msg);
\ No newline at end of file +/** + * @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/timer.hpp b/src/timer.hpp index 0454a80..7d0e466 100644 --- a/src/timer.hpp +++ b/src/timer.hpp @@ -19,15 +19,24 @@ #include <sys/timeb.h> +/* + * @brief return epoch in milliseconds + * + * @return long long int epoch in milliseconds + */ typedef long long int (*TimeFunction)(); /** - * @brief: A frequency counting clock. + * @struct FrequencyClock + * @brief A frequency counting clock. * - * frequency - the clock frequency in Hz. - * last_time - the last time (in milliseconds since startup) that the clock + * @var FrequencyClock::frequency + * the clock frequency in Hz. + * @var FrequencyClock::last_time + * the last time (in milliseconds since startup) that the clock * ticked. - * time_function - a function returning current time + * @var FrequencyClock::time_function + * a function returning current time */ typedef struct { float frequency; |