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"
21 #include "../binding/application.hpp"
24 /// @brief Build a specific VehicleMessage containing a DiagnosticResponse.
26 /// @param[in] request - Original request use to retrieve decoder and callback
27 /// @param[in] response - Response to the request that will be decoded if decoder set
28 /// and put into the DiagnosticResponse of the VehicleMessage.
29 /// @param[in] parsed_value - raw parsed value of the payload from CAN message
31 /// @return a vehicle message including simple message that will be convert into
32 /// a JSON object before being pushed to the subscribers
34 const openxc_VehicleMessage build_VehicleMessage(active_diagnostic_request_t* request, const DiagnosticResponse& response, float parsed_value)
36 openxc_VehicleMessage message;
37 application_t& app = application_t::instance();
39 message.has_type = true;
40 message.type = openxc_VehicleMessage_Type::openxc_VehicleMessage_Type_DIAGNOSTIC;
41 message.has_diagnostic_response = true;
42 message.diagnostic_response.has_bus = true;
43 message.diagnostic_response.bus = app.get_can_bus_manager().get_can_device_index(
44 app.get_diagnostic_manager().get_bus_name());
45 message.diagnostic_response.has_message_id = true;
47 if(request->get_id() != OBD2_FUNCTIONAL_BROADCAST_ID)
49 message.diagnostic_response.message_id = response.arbitration_id
50 - DIAGNOSTIC_RESPONSE_ARBITRATION_ID_OFFSET;
54 // must preserve responding arb ID for responses to functional broadcast
55 // requests, as they are the actual module address and not just arb ID +
57 message.diagnostic_response.message_id = response.arbitration_id;
60 message.diagnostic_response.has_mode = true;
61 message.diagnostic_response.mode = response.mode;
62 message.diagnostic_response.has_pid = response.has_pid;
63 if(message.diagnostic_response.has_pid)
64 message.diagnostic_response.pid = response.pid;
65 message.diagnostic_response.has_success = true;
66 message.diagnostic_response.success = response.success;
67 message.diagnostic_response.has_negative_response_code = !response.success;
68 message.diagnostic_response.negative_response_code =
69 response.negative_response_code;
71 if(response.payload_length > 0)
73 if(request->get_decoder() != nullptr)
75 message.diagnostic_response.has_value = true;
76 message.diagnostic_response.value = parsed_value;
80 message.diagnostic_response.has_payload = true;
81 ::memcpy(message.diagnostic_response.payload.bytes, response.payload,
82 response.payload_length);
83 message.diagnostic_response.payload.size = response.payload_length;
90 /// @brief Build a specific VehicleMessage containing a SimpleMessage with associated timestamp
92 /// @param[in] message - simple message to include into openxc_VehicleMessage
93 /// @param[in] timestamp - timestamp from ioctl when reading the socket
95 /// @return a vehicle message including simple message that will be convert into
96 /// a JSON object before being pushed to the subscribers
98 const openxc_VehicleMessage build_VehicleMessage(const openxc_SimpleMessage& message, uint64_t timestamp)
100 openxc_VehicleMessage v;
103 v.type = openxc_VehicleMessage_Type::openxc_VehicleMessage_Type_SIMPLE;
104 v.has_simple_message = true;
105 v.simple_message = message;
106 v.has_timestamp = true;
107 v.timestamp = timestamp;
113 /// @brief Build a specific VehicleMessage containing a SimpleMessage.
115 /// @param[in] message - simple message to include into openxc_VehicleMessage
117 /// @return a vehicle message including simple message that will be convert into
118 /// a JSON object before being pushed to the subscribers
120 const openxc_VehicleMessage build_VehicleMessage(const openxc_SimpleMessage& message)
122 openxc_VehicleMessage v;
125 v.type = openxc_VehicleMessage_Type::openxc_VehicleMessage_Type_SIMPLE;
126 v.has_simple_message = true;
127 v.simple_message = message;
128 v.has_timestamp = true;
129 v.timestamp = system_time_us();
135 /// @brief Build an empty VehicleMessage that isn't usable by at least the struct
136 /// is initialized for the most part and can be use to check a false return value.
138 /// @return A VehicleMessage with all boolean value to false.
140 openxc_VehicleMessage build_VehicleMessage()
142 openxc_VehicleMessage v;
144 ::memset(&v, 0, sizeof(openxc_VehicleMessage));
148 bool is_valid(const openxc_VehicleMessage& v)
150 if (v.has_type == false &&
151 v.has_can_message == false &&
152 v.has_simple_message == false &&
153 v.has_diagnostic_response == false &&
154 v.has_control_command == false &&
155 v.has_command_response == false &&
156 v.has_timestamp == false)
162 /// @brief Build an openxc_SimpleMessage associating a name to an openxc_DynamicField
164 /// @param[in] name - const string reference name to assign to the created SimpleMessage
165 /// this will set has_name member to true and assign name to the name member. Maximum size for name is
167 /// @param[in] value - const reference with DynamicField to assign to SimpleMessage
170 /// @return an openxc_SimpleMessage struct initialized with name and value provided.
172 const openxc_SimpleMessage build_SimpleMessage(const std::string& name, const openxc_DynamicField& value)
174 openxc_SimpleMessage s;
177 ::strncpy(s.name, name.c_str(), 100);
185 /// @brief Build an openxc_DynamicField with a string value
187 /// @param[in] value - const string reference value to assign to builded
188 /// openxc_DynamicField.
190 /// @return openxc_DynamicField initialized with a string value.
192 const openxc_DynamicField build_DynamicField(const char* value)
194 openxc_DynamicField d;
196 d.type = openxc_DynamicField_Type_STRING;
198 d.has_string_value = true;
199 d.has_numeric_value = false;
200 d.has_boolean_value = false;
201 ::strncpy(d.string_value, value, 100);
207 /// @brief Build an openxc_DynamicField with a string value
209 /// @param[in] value - const string reference value to assign to builded
210 /// openxc_DynamicField.
212 /// @return openxc_DynamicField initialized with a string value.
214 const openxc_DynamicField build_DynamicField(const std::string& value)
216 openxc_DynamicField d;
218 d.type = openxc_DynamicField_Type_STRING;
220 d.has_string_value = true;
221 d.has_numeric_value = false;
222 d.has_boolean_value = false;
223 ::strncpy(d.string_value, value.c_str(), 100);
229 /// @fn openxc_DynamicField build_DynamicField(double value);
231 /// @brief Build an openxc_DynamicField with a double value
233 /// @param[in] value - double value to assign to builded openxc_DynamicField.
235 /// @return openxc_DynamicField initialized with a double value.
237 const openxc_DynamicField build_DynamicField(double value)
239 openxc_DynamicField d;
241 d.type = openxc_DynamicField_Type_NUM;
243 d.has_string_value = false;
244 d.has_numeric_value = true;
245 d.has_boolean_value = false;
246 d.numeric_value = value;
252 /// @brief Build an openxc_DynamicField with a boolean value
254 /// @param[in] value - boolean value to assign to builded openxc_DynamicField.
256 /// @return openxc_DynamicField initialized with a boolean value.
258 const openxc_DynamicField build_DynamicField(bool value)
260 openxc_DynamicField d;
262 d.type = openxc_DynamicField_Type_BOOL;
264 d.has_string_value = false;
265 d.has_numeric_value = false;
266 d.has_boolean_value = true;
267 d.boolean_value = value;
273 /// @brief Extract the simple message value from an openxc_VehicleMessage
274 /// and return it. If there isn't SimpleMessage in the VehicleMessage then
275 /// returned value will be a SimpleMessage with all field set at false.
276 /// DynamicField from SimpleMessage will be boolean DynamicField set to false too.
278 /// @param[in] v_msg - const reference to openxc_VehicleMessage
280 /// @return A simpleMessage from the provided VehicleMessage.
282 const openxc_SimpleMessage get_simple_message(const openxc_VehicleMessage& v_msg)
284 if (v_msg.has_simple_message)
285 return v_msg.simple_message;
287 openxc_SimpleMessage s_msg = { false, "", false, build_DynamicField(false), false, build_DynamicField(false)};
292 /// @brief Make a JSON object from a DynamicField
294 /// @param[in] field - openxc_DynamicField struct to convert into
296 /// @param[out] value - pointer to the object to set up.
298 void jsonify_DynamicField(const openxc_DynamicField& field, json_object* value)
300 if(field.has_numeric_value)
301 json_object_object_add(value, "value", json_object_new_double(field.numeric_value));
302 else if(field.has_boolean_value)
303 json_object_object_add(value, "value", json_object_new_boolean(field.boolean_value));
304 else if(field.has_string_value)
305 json_object_object_add(value, "value", json_object_new_string(field.string_value));
309 /// @brief Make a JSON object from a SimpleMessage
311 /// @param[in] s_msg - const reference to an openxc_SimpleMessage
312 /// struct to convert into a json object.
313 /// @param[out] json - pointer with the DynamicField converted into json object
315 /// @return True if SimpleMessage has been transformed into json object
316 /// and false if not. In such case, a json object is returned { "error": "error msg"}
318 bool jsonify_simple(const openxc_SimpleMessage& s_msg, json_object* json)
322 json_object_object_add(json, "name", json_object_new_string(s_msg.name));
323 jsonify_DynamicField(s_msg.value, json);
326 json_object_object_add(json, "error", json_object_new_string("openxc_SimpleMessage doesn't have name'"));