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/configuration.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 openxc_VehicleMessage build_VehicleMessage(active_diagnostic_request_t* request, const DiagnosticResponse& response, float parsed_value)
36 openxc_VehicleMessage message;
37 configuration_t& conf = configuration_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 = conf.get_can_bus_manager().get_can_device_index(
44 conf.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;
91 /// @brief Build a specific VehicleMessage containing a SimpleMessage.
93 /// @param[in] message - simple message to include into openxc_VehicleMessage
95 /// @return a vehicle message including simple message that will be convert into
96 /// a JSON object before being pushed to the subscribers
98 openxc_VehicleMessage build_VehicleMessage(const openxc_SimpleMessage& message)
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 = system_time_ms();
113 /// @brief Build an empty VehicleMessage that isn't usable by at least the struct
114 /// is initialized for the most part and can be use to check a false return value.
116 /// @return A VehicleMessage with all boolean value to false.
118 openxc_VehicleMessage build_VehicleMessage()
120 openxc_VehicleMessage v;
122 ::memset(&v, 0, sizeof(openxc_VehicleMessage));
126 bool is_valid(const openxc_VehicleMessage& v)
128 if (v.has_type == false &&
129 v.has_can_message == false &&
130 v.has_simple_message == false &&
131 v.has_diagnostic_response == false &&
132 v.has_control_command == false &&
133 v.has_command_response == false &&
134 v.has_timestamp == false)
140 /// @brief Build an openxc_SimpleMessage associating a name to an openxc_DynamicField
142 /// @param[in] name - const string reference name to assign to the created SimpleMessage
143 /// this will set has_name member to true and assign name to the name member. Maximum size for name is
145 /// @param[in] value - const reference with DynamicField to assign to SimpleMessage
148 /// @return an openxc_SimpleMessage struct initialized with name and value provided.
150 openxc_SimpleMessage build_SimpleMessage(const std::string& name, const openxc_DynamicField& value)
152 openxc_SimpleMessage s;
155 ::strncpy(s.name, name.c_str(), 100);
163 /// @brief Build an openxc_DynamicField with a string value
165 /// @param[in] value - const string reference value to assign to builded
166 /// openxc_DynamicField.
168 /// @return openxc_DynamicField initialized with a string value.
170 openxc_DynamicField build_DynamicField(const std::string& value)
172 openxc_DynamicField d;
174 d.type = openxc_DynamicField_Type_STRING;
176 d.has_string_value = true;
177 d.has_numeric_value = false;
178 d.has_boolean_value = false;
179 ::strncpy(d.string_value, value.c_str(), 100);
185 /// @fn openxc_DynamicField build_DynamicField(double value);
187 /// @brief Build an openxc_DynamicField with a double value
189 /// @param[in] value - double value to assign to builded openxc_DynamicField.
191 /// @return openxc_DynamicField initialized with a double value.
193 openxc_DynamicField build_DynamicField(double value)
195 openxc_DynamicField d;
197 d.type = openxc_DynamicField_Type_NUM;
199 d.has_string_value = false;
200 d.has_numeric_value = true;
201 d.has_boolean_value = false;
202 d.numeric_value = value;
208 /// @brief Build an openxc_DynamicField with a boolean value
210 /// @param[in] value - boolean value to assign to builded openxc_DynamicField.
212 /// @return openxc_DynamicField initialized with a boolean value.
214 openxc_DynamicField build_DynamicField(bool value)
216 openxc_DynamicField d;
218 d.type = openxc_DynamicField_Type_BOOL;
220 d.has_string_value = false;
221 d.has_numeric_value = false;
222 d.has_boolean_value = true;
223 d.boolean_value = value;
229 /// @brief Extract the simple message value from an openxc_VehicleMessage
230 /// and return it. If there isn't SimpleMessage in the VehicleMessage then
231 /// returned value will be a SimpleMessage with all field set at false.
232 /// DynamicField from SimpleMessage will be boolean DynamicField set to false too.
234 /// @param[in] v_msg - const reference to openxc_VehicleMessage
236 /// @return A simpleMessage from the provided VehicleMessage.
238 openxc_SimpleMessage get_simple_message(const openxc_VehicleMessage& v_msg)
240 if (v_msg.has_simple_message)
241 return v_msg.simple_message;
243 openxc_SimpleMessage s_msg = { false, "", false, build_DynamicField(false), false, build_DynamicField(false)};
248 /// @brief Make a JSON object from a DynamicField
250 /// @param[in] field - openxc_DynamicField struct to convert into
252 /// @param[out] value - pointer to the object to set up.
254 void jsonify_DynamicField(const openxc_DynamicField& field, json_object* value)
256 if(field.has_numeric_value)
257 json_object_object_add(value, "value", json_object_new_double(field.numeric_value));
258 else if(field.has_boolean_value)
259 json_object_object_add(value, "value", json_object_new_boolean(field.boolean_value));
260 else if(field.has_string_value)
261 json_object_object_add(value, "value", json_object_new_string(field.string_value));
265 /// @brief Make a JSON object from a SimpleMessage
267 /// @param[in] s_msg - const reference to an openxc_SimpleMessage
268 /// struct to convert into a json object.
269 /// @param[out] json - pointer with the DynamicField converted into json object
271 /// @return True if SimpleMessage has been transformed into json object
272 /// and false if not. In such case, a json object is returned { "error": "error msg"}
274 bool jsonify_simple(const openxc_SimpleMessage& s_msg, json_object* json)
278 json_object_object_add(json, "name", json_object_new_string(s_msg.name));
279 jsonify_DynamicField(s_msg.value, json);
282 json_object_object_add(json, "error", json_object_new_string("openxc_SimpleMessage doesn't have name'"));