CAN-binder/low-can-binding/utils/openxc-utils.cpp

   1 /*
   2  * Copyright (C) 2015, 2016 "IoT.bzh"
   3  * Author "Romain Forlot" <romain.forlot@iot.bzh>
   4  * Author "Loic Collignon" <loic.collignon@iot.bzh>
   5  *
   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
   9  *
  10  *       http://www.apache.org/licenses/LICENSE-2.0
  11  *
  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.
  17  */
  18
  19 #include "openxc-utils.hpp"
  20
  21 #include "../binding/configuration.hpp"
  22
  23 ///
  24 /// @brief Build a specific VehicleMessage containing a DiagnosticResponse.
  25 ///
  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
  30 ///
  31 /// @return a vehicle message including simple message that will be convert into
  32 /// a JSON object before being pushed to the subscribers
  33 ///
  34 openxc_VehicleMessage build_VehicleMessage(active_diagnostic_request_t* request, const DiagnosticResponse& response, float parsed_value)
  35 {
  36         openxc_VehicleMessage message;
  37         configuration_t& conf = configuration_t::instance();
  38
  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(
  44                                                                                                                                 conf.get_diagnostic_manager().get_can_bus())
  45                                                                                                                                 ->get_index();
  46         message.diagnostic_response.has_message_id = true;
  47
  48         if(request->get_id() != OBD2_FUNCTIONAL_BROADCAST_ID)
  49         {
  50                 message.diagnostic_response.message_id = response.arbitration_id
  51                         - DIAGNOSTIC_RESPONSE_ARBITRATION_ID_OFFSET;
  52         }
  53         else
  54         {
  55                 // must preserve responding arb ID for responses to functional broadcast
  56                 // requests, as they are the actual module address and not just arb ID +
  57                 // 8.
  58                 message.diagnostic_response.message_id = response.arbitration_id;
  59         }
  60
  61         message.diagnostic_response.has_mode = true;
  62         message.diagnostic_response.mode = response.mode;
  63         message.diagnostic_response.has_pid = response.has_pid;
  64         if(message.diagnostic_response.has_pid)
  65                 message.diagnostic_response.pid = response.pid;
  66         message.diagnostic_response.has_success = true;
  67         message.diagnostic_response.success = response.success;
  68         message.diagnostic_response.has_negative_response_code = !response.success;
  69         message.diagnostic_response.negative_response_code =
  70                         response.negative_response_code;
  71
  72         if(response.payload_length > 0)
  73         {
  74                 if(request->get_decoder() != nullptr)
  75                 {
  76                         message.diagnostic_response.has_value = true;
  77                         message.diagnostic_response.value = parsed_value;
  78                 }
  79                 else
  80                 {
  81                         message.diagnostic_response.has_payload = true;
  82                         ::memcpy(message.diagnostic_response.payload.bytes, response.payload,
  83                                         response.payload_length);
  84                         message.diagnostic_response.payload.size = response.payload_length;
  85                 }
  86         }
  87
  88         return message;
  89 }
  90
  91 ///
  92 /// @brief Build a specific VehicleMessage containing a SimpleMessage.
  93 ///
  94 /// @param[in] message - simple message to include into openxc_VehicleMessage
  95 ///
  96 /// @return a vehicle message including simple message that will be convert into
  97 /// a JSON object before being pushed to the subscribers
  98 ///
  99 openxc_VehicleMessage build_VehicleMessage(const openxc_SimpleMessage& message)
 100 {
 101         openxc_VehicleMessage v;
 102
 103         v.has_type = true,
 104         v.type = openxc_VehicleMessage_Type::openxc_VehicleMessage_Type_SIMPLE;
 105         v.has_simple_message = true;
 106         v.simple_message =  message;
 107         v.has_timestamp = true;
 108         v.timestamp = system_time_ms();
 109
 110         return v;
 111 }
 112
 113 ///
 114 /// @brief Build an empty VehicleMessage that isn't usable by at least the struct
 115 ///  is initialized for the most part and can be use to check a false return value.
 116 ///
 117 /// @return A VehicleMessage with all boolean value to false.
 118 ///
 119 openxc_VehicleMessage build_VehicleMessage()
 120 {
 121         openxc_VehicleMessage v;
 122
 123         ::memset(&v, 0, sizeof(openxc_VehicleMessage));
 124         return v;
 125 }
 126
 127 bool is_valid(const openxc_VehicleMessage& v)
 128 {
 129         if (v.has_type == false &&
 130                 v.has_can_message == false &&
 131                 v.has_simple_message == false &&
 132                 v.has_diagnostic_response == false &&
 133                 v.has_control_command == false &&
 134                 v.has_command_response == false &&
 135                 v.has_timestamp == false)
 136                         return false;
 137         return true;
 138 }
 139
 140 ///
 141 /// @brief Build an openxc_SimpleMessage associating a name to an openxc_DynamicField
 142 ///
 143 /// @param[in] name - const string reference name to assign to the created SimpleMessage
 144 ///  this will set has_name member to true and assign name to the name member. Maximum size for name is
 145 ///  set to 100 char.
 146 /// @param[in] value - const reference with DynamicField to assign to SimpleMessage
 147 ///  value.
 148 ///
 149 /// @return an openxc_SimpleMessage struct initialized with name and value provided.
 150 ///
 151 openxc_SimpleMessage build_SimpleMessage(const std::string& name, const openxc_DynamicField& value)
 152 {
 153         openxc_SimpleMessage s;
 154
 155         s.has_name = true;
 156         ::strncpy(s.name, name.c_str(), 100);
 157         s.has_value = true;
 158         s.value = value;
 159
 160         return s;
 161 }
 162
 163 ///
 164 /// @brief Build an openxc_DynamicField with a string value
 165 ///
 166 /// @param[in] value - const string reference value to assign to builded
 167 ///  openxc_DynamicField.
 168 ///
 169 /// @return openxc_DynamicField initialized with a string value.
 170 ///
 171 openxc_DynamicField build_DynamicField(const std::string& value)
 172 {
 173         openxc_DynamicField d;
 174         d.has_type = true;
 175         d.type = openxc_DynamicField_Type_STRING;
 176
 177         d.has_string_value = true;
 178         d.has_numeric_value = false;
 179         d.has_boolean_value = false;
 180         ::strncpy(d.string_value, value.c_str(), 100);
 181
 182         return d;
 183 }
 184
 185 ///
 186 /// @fn openxc_DynamicField build_DynamicField(double value);
 187 ///
 188 /// @brief Build an openxc_DynamicField with a double value
 189 ///
 190 /// @param[in] value - double value to assign to builded openxc_DynamicField.
 191 ///
 192 /// @return openxc_DynamicField initialized with a double value.
 193 ///
 194 openxc_DynamicField build_DynamicField(double value)
 195 {
 196         openxc_DynamicField d;
 197         d.has_type = true;
 198         d.type = openxc_DynamicField_Type_NUM;
 199
 200         d.has_string_value = false;
 201         d.has_numeric_value = true;
 202         d.has_boolean_value = false;
 203         d.numeric_value = value;
 204
 205         return d;
 206 }
 207
 208 ///
 209 /// @brief Build an openxc_DynamicField with a boolean value
 210 ///
 211 /// @param[in] value - boolean value to assign to builded openxc_DynamicField.
 212 ///
 213 /// @return openxc_DynamicField initialized with a boolean value.
 214 ///
 215 openxc_DynamicField build_DynamicField(bool value)
 216 {
 217         openxc_DynamicField d;
 218         d.has_type = true;
 219         d.type = openxc_DynamicField_Type_BOOL;
 220
 221         d.has_string_value = false;
 222         d.has_numeric_value = false;
 223         d.has_boolean_value = true;
 224         d.boolean_value = value;
 225
 226         return d;
 227 }
 228
 229 ///
 230 /// @brief Extract the simple message value from an openxc_VehicleMessage
 231 ///  and return it. If there isn't SimpleMessage in the VehicleMessage then
 232 ///  returned value will be a SimpleMessage with all field set at false.
 233 ///  DynamicField from SimpleMessage will be boolean DynamicField set to false too.
 234 ///
 235 /// @param[in] v_msg - const reference to openxc_VehicleMessage
 236 ///
 237 /// @return A simpleMessage from the provided VehicleMessage.
 238 ///
 239 openxc_SimpleMessage get_simple_message(const openxc_VehicleMessage& v_msg)
 240 {
 241         if (v_msg.has_simple_message)
 242                 return v_msg.simple_message;
 243
 244         openxc_SimpleMessage s_msg = { false, "", false, build_DynamicField(false), false, build_DynamicField(false)};
 245         return s_msg;
 246 }
 247
 248 ///
 249 /// @brief Make a JSON object from a DynamicField
 250 ///
 251 /// @param[in] field - openxc_DynamicField struct to convert into
 252 ///  a json object.
 253 /// @param[out] value - pointer to the object to set up.
 254 ///
 255 void jsonify_DynamicField(const openxc_DynamicField& field, json_object* value)
 256 {
 257         if(field.has_numeric_value)
 258                 json_object_object_add(value, "value", json_object_new_double(field.numeric_value));
 259         else if(field.has_boolean_value)
 260                 json_object_object_add(value, "value", json_object_new_boolean(field.boolean_value));
 261         else if(field.has_string_value)
 262                 json_object_object_add(value, "value", json_object_new_string(field.string_value));
 263 }
 264
 265 ///
 266 /// @brief Make a JSON object from a SimpleMessage
 267 ///
 268 /// @param[in] s_msg - const reference to an openxc_SimpleMessage
 269 /// struct to convert into a json object.
 270 /// @param[out] json - pointer with the DynamicField converted into json object
 271 ///
 272 /// @return True if SimpleMessage has been transformed into json object
 273 ///  and false if not. In such case, a json object is returned { "error": "error msg"}
 274 ///
 275 bool jsonify_simple(const openxc_SimpleMessage& s_msg, json_object* json)
 276 {
 277         if(s_msg.has_name)
 278         {
 279                 json_object_object_add(json, "name", json_object_new_string(s_msg.name));
 280                 jsonify_DynamicField(s_msg.value, json);
 281                 return true;
 282         }
 283         json_object_object_add(json, "error", json_object_new_string("openxc_SimpleMessage doesn't have name'"));
 284         return false;
 285 }