2 * Copyright (C) 2015, 2016 "IoT.bzh"
3 * Author "Romain Forlot" <romain.forlot@iot.bzh>
4 * Author "Loic Collignon" <loic.collignon@iot.bzh>
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
19 #include "openxc-utils.hpp"
20 #include "converter.hpp"
21 #include "../binding/application.hpp"
25 /// @brief Build a specific VehicleMessage containing a DiagnosticResponse.
27 /// @param[in] request - Original request use to retrieve decoder and callback
28 /// @param[in] response - Response to the request that will be decoded if decoder set
29 /// and put into the DiagnosticResponse of the VehicleMessage.
30 /// @param[in] parsed_value - raw parsed value of the payload from CAN message
32 /// @return a vehicle message including simple message that will be convert into
33 /// a JSON object before being pushed to the subscribers
35 const openxc_VehicleMessage build_VehicleMessage(active_diagnostic_request_t* request, const DiagnosticResponse& response, float parsed_value)
37 openxc_VehicleMessage message;
38 ::memset(&message, 0, sizeof(message));
39 application_t& app = application_t::instance();
41 message.has_type = true;
42 message.type = openxc_VehicleMessage_Type::openxc_VehicleMessage_Type_DIAGNOSTIC;
43 message.has_diagnostic_response = true;
44 message.diagnostic_response.has_bus = true;
45 message.diagnostic_response.bus = app.get_can_bus_manager().get_can_device_index(
46 app.get_diagnostic_manager().get_bus_name());
47 message.diagnostic_response.has_message_id = true;
49 if(request->get_id() != OBD2_FUNCTIONAL_BROADCAST_ID)
51 message.diagnostic_response.message_id = response.arbitration_id
52 - DIAGNOSTIC_RESPONSE_ARBITRATION_ID_OFFSET;
56 // must preserve responding arb ID for responses to functional broadcast
57 // requests, as they are the actual module address and not just arb ID +
59 message.diagnostic_response.message_id = response.arbitration_id;
62 message.diagnostic_response.has_mode = true;
63 message.diagnostic_response.mode = response.mode;
64 message.diagnostic_response.has_pid = response.has_pid;
65 if(message.diagnostic_response.has_pid)
66 message.diagnostic_response.pid = response.pid;
67 message.diagnostic_response.has_success = true;
68 message.diagnostic_response.success = response.success;
69 message.diagnostic_response.has_negative_response_code = !response.success;
70 message.diagnostic_response.negative_response_code =
71 response.negative_response_code;
73 if(response.payload_length > 0)
75 if(request->get_decoder() != nullptr)
77 message.diagnostic_response.has_value = true;
78 message.diagnostic_response.value = parsed_value;
82 message.diagnostic_response.has_payload = true;
83 ::memcpy(message.diagnostic_response.payload.bytes, response.payload,
84 response.payload_length);
85 message.diagnostic_response.payload.size = response.payload_length;
92 /// @brief Build a specific VehicleMessage containing a SimpleMessage with associated timestamp
94 /// @param[in] message - simple message to include into openxc_VehicleMessage
95 /// @param[in] timestamp - timestamp from ioctl when reading the socket
97 /// @return a vehicle message including simple message that will be convert into
98 /// a JSON object before being pushed to the subscribers
100 const openxc_VehicleMessage build_VehicleMessage(const openxc_SimpleMessage& message, uint64_t timestamp)
102 openxc_VehicleMessage v;
103 ::memset(&v, 0, sizeof(v));
106 v.type = openxc_VehicleMessage_Type::openxc_VehicleMessage_Type_SIMPLE;
107 v.has_simple_message = true;
108 v.simple_message = message;
109 v.has_timestamp = true;
110 v.timestamp = timestamp;
116 /// @brief Build a specific VehicleMessage containing a SimpleMessage.
118 /// @param[in] message - simple message to include into openxc_VehicleMessage
120 /// @return a vehicle message including simple message that will be convert into
121 /// a JSON object before being pushed to the subscribers
123 const openxc_VehicleMessage build_VehicleMessage(const openxc_SimpleMessage& message)
125 openxc_VehicleMessage v;
126 ::memset(&v, 0, sizeof(v));
129 v.type = openxc_VehicleMessage_Type::openxc_VehicleMessage_Type_SIMPLE;
130 v.has_simple_message = true;
131 v.simple_message = message;
132 v.has_timestamp = true;
133 v.timestamp = system_time_us();
139 /// @brief Build an empty VehicleMessage that isn't usable by at least the struct
140 /// is initialized for the most part and can be use to check a false return value.
142 /// @return A VehicleMessage with all boolean value to false.
144 openxc_VehicleMessage build_VehicleMessage()
146 openxc_VehicleMessage v;
148 ::memset(&v, 0, sizeof(v));
152 bool is_valid(const openxc_VehicleMessage& v)
154 if (v.has_type == false &&
155 v.has_can_message == false &&
156 v.has_simple_message == false &&
157 v.has_diagnostic_response == false &&
158 v.has_control_command == false &&
159 v.has_command_response == false &&
160 v.has_timestamp == false)
166 /// @brief Build an openxc_SimpleMessage associating a name to an openxc_DynamicField
168 /// @param[in] name - const string reference name to assign to the created SimpleMessage
169 /// this will set has_name member to true and assign name to the name member. Maximum size for name is
171 /// @param[in] value - const reference with DynamicField to assign to SimpleMessage
174 /// @return an openxc_SimpleMessage struct initialized with name and value provided.
176 const openxc_SimpleMessage build_SimpleMessage(const std::string& name, const openxc_DynamicField& value)
178 openxc_SimpleMessage s;
181 ::strncpy(s.name, name.c_str(), 100);
188 /// @brief Build an openxc_DynamicField with a json object
190 /// @param[in] value - const json_object pointer to assign to convert in an
191 /// openxc_DynamicField.
193 /// @return openxc_DynamicField initialized with a json object.
195 const openxc_DynamicField build_DynamicField(json_object* value)
197 switch(json_object_get_type(value))
199 case json_type_string:
200 return build_DynamicField(json_object_get_string(value));
201 case json_type_double:
202 return build_DynamicField(json_object_get_double(value));
204 return build_DynamicField(json_object_get_double(value));
205 case json_type_boolean:
206 return build_DynamicField((bool)json_object_get_boolean(value));
208 openxc_DynamicField d;
209 ::memset(&d, 0, sizeof(openxc_DynamicField));
214 const openxc_DynamicField build_DynamicField(std::vector<uint8_t> &array)
216 openxc_DynamicField d;
218 d.type = openxc_DynamicField_Type_BYTES;
220 d.has_string_value = false;
221 d.has_numeric_value = false;
222 d.has_boolean_value = false;
223 d.has_bytes_value = true;
226 size_t size = array.size();
230 AFB_ERROR("Error to generate array dynamic field, too large data");
235 d.length_array = (uint32_t) size;
239 for(int i=0;i<size;i++)
241 d.bytes_value[i] = array[i];
249 /// @brief Build an openxc_DynamicField with a string value
251 /// @param[in] value - const string reference value to assign to builded
252 /// openxc_DynamicField.
254 /// @return openxc_DynamicField initialized with a string value.
256 const openxc_DynamicField build_DynamicField(const char* value)
258 openxc_DynamicField d;
260 d.type = openxc_DynamicField_Type_STRING;
262 d.has_string_value = true;
263 d.has_numeric_value = false;
264 d.has_boolean_value = false;
265 d.has_bytes_value = false;
266 ::strncpy(d.string_value, value, 100);
272 /// @brief Build an openxc_DynamicField with a string value
274 /// @param[in] value - const string reference value to assign to builded
275 /// openxc_DynamicField.
277 /// @return openxc_DynamicField initialized with a string value.
279 const openxc_DynamicField build_DynamicField(const std::string& value)
281 openxc_DynamicField d;
283 d.type = openxc_DynamicField_Type_STRING;
285 d.has_string_value = true;
286 d.has_numeric_value = false;
287 d.has_boolean_value = false;
288 d.has_bytes_value = false;
289 ::strncpy(d.string_value, value.c_str(), 100);
295 /// @fn openxc_DynamicField build_DynamicField(double value);
297 /// @brief Build an openxc_DynamicField with a double value
299 /// @param[in] value - double value to assign to builded openxc_DynamicField.
301 /// @return openxc_DynamicField initialized with a double value.
303 const openxc_DynamicField build_DynamicField(double value)
305 openxc_DynamicField d;
307 d.type = openxc_DynamicField_Type_NUM;
309 d.has_string_value = false;
310 d.has_numeric_value = true;
311 d.has_boolean_value = false;
312 d.has_bytes_value = false;
313 d.numeric_value = value;
319 /// @brief Build an openxc_DynamicField with a boolean value
321 /// @param[in] value - boolean value to assign to builded openxc_DynamicField.
323 /// @return openxc_DynamicField initialized with a boolean value.
325 const openxc_DynamicField build_DynamicField(bool value)
327 openxc_DynamicField d;
329 d.type = openxc_DynamicField_Type_BOOL;
331 d.has_string_value = false;
332 d.has_numeric_value = false;
333 d.has_boolean_value = true;
334 d.has_bytes_value = false;
335 d.boolean_value = value;
341 int get_bool_from_DynamicField(const openxc_VehicleMessage& v_msg, bool* ret)
343 if(v_msg.has_simple_message && v_msg.simple_message.has_value && v_msg.simple_message.value.has_boolean_value)
345 *ret = v_msg.simple_message.value.boolean_value;
352 double get_numerical_from_DynamicField(const openxc_VehicleMessage& v_msg)
354 return (v_msg.has_simple_message && v_msg.simple_message.has_value && v_msg.simple_message.value.has_numeric_value) ?
355 v_msg.simple_message.value.numeric_value : -1.0;
358 const std::string get_string_from_DynamicField(const openxc_VehicleMessage& v_msg)
360 return (v_msg.has_simple_message && v_msg.simple_message.has_value && v_msg.simple_message.value.has_string_value) ?
361 v_msg.simple_message.value.string_value : "";
365 /// @brief Extract the simple message value from an openxc_VehicleMessage
366 /// and return it. If there isn't SimpleMessage in the VehicleMessage then
367 /// returned value will be a SimpleMessage with all field set at false.
368 /// DynamicField from SimpleMessage will be boolean DynamicField set to false too.
370 /// @param[in] v_msg - const reference to openxc_VehicleMessage
372 /// @return A simpleMessage from the provided VehicleMessage.
374 const openxc_SimpleMessage get_simple_message(const openxc_VehicleMessage& v_msg)
376 if (v_msg.has_simple_message)
377 return v_msg.simple_message;
379 openxc_SimpleMessage s_msg = { false, "", false, build_DynamicField(false), false, build_DynamicField(false)};
384 /// @brief Make a JSON object from a DynamicField
386 /// @param[in] field - openxc_DynamicField struct to convert into
388 /// @param[out] value - pointer to the object to set up.
390 void jsonify_DynamicField(const openxc_DynamicField& field, json_object* value)
392 if(field.has_numeric_value)
394 json_object_object_add(value, "value", json_object_new_double(field.numeric_value));
396 else if(field.has_boolean_value)
398 json_object_object_add(value, "value", json_object_new_boolean(field.boolean_value));
400 else if(field.has_string_value)
402 json_object_object_add(value, "value", json_object_new_string(field.string_value));
404 else if(field.has_bytes_value)
406 std::string s = converter_t::to_hex(field.bytes_value,field.length_array);
408 json_object_object_add(value, "value", json_object_new_string(s.c_str()));
413 /// @brief Make a JSON object from a SimpleMessage
415 /// @param[in] s_msg - const reference to an openxc_SimpleMessage
416 /// struct to convert into a json object.
417 /// @param[out] json - pointer with the DynamicField converted into json object
419 /// @return True if SimpleMessage has been transformed into json object
420 /// and false if not. In such case, a json object is returned { "error": "error msg"}
422 bool jsonify_simple(const openxc_SimpleMessage& s_msg, json_object* json)
426 json_object_object_add(json, "name", json_object_new_string(s_msg.name));
427 jsonify_DynamicField(s_msg.value, json);
430 json_object_object_add(json, "error", json_object_new_string("openxc_SimpleMessage doesn't have name'"));
435 /// @brief Make a JSON object from a VehicleMessage
437 /// @param[in] v_msg - const reference to an openxc_VehicleMessage
438 /// struct to convert into a json object.
439 /// @param[out] json - pointer with the DynamicField converted into json object
441 /// @return True if VehicleMessage has been transformed into json object
442 /// and false if not. In such case, a json object is returned { "error": "error msg"}
444 bool jsonify_vehicle(const openxc_VehicleMessage& v_msg, json_object* json)
446 if(jsonify_simple(get_simple_message(v_msg), json))
448 if(v_msg.has_timestamp)
450 json_object_object_add(json, "timestamp", json_object_new_int64(v_msg.timestamp));
455 json_object_object_add(json, "error", json_object_new_string("openxc_SimpleMessage doesn't have name'"));