low-can-binding/can/can-decoder.cpp

   1 /*
   2  * Copyright (C) 2015, 2016 "IoT.bzh"
   3  * Author "Romain Forlot" <romain.forlot@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *       http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #include "can-decoder.hpp"
  19 #include <climits>
  20
  21 #include "canutil/read.h"
  22 #include "../utils/openxc-utils.hpp"
  23 #include "message-definition.hpp"
  24 #include "../binding/low-can-hat.hpp"
  25 #include "../utils/converter.hpp"
  26
  27 /// @brief Handle sign of the signal according to several decoding methods
  28 ///
  29 /// @param[in] signal - The signal
  30 /// @param[in] data_signal - The data of the signal
  31 /// @param[in] new_end_bit - The last bit of in the last byte of the data (data_signal[0])
  32 /// @param[in] can_data - The whole can data (needed for SIGN BIT EXTERN)
  33 ///
  34 /// @return Returns the sign of the data
  35 ///
  36 int decoder_t::handle_sign(const signal_t& signal, std::vector<uint8_t>& data_signal, uint8_t new_end_bit, const std::vector<uint8_t>& can_data)
  37 {
  38         uint8_t data_byte = 0;
  39         uint8_t mask = 0;
  40         int end_bit = 0;
  41
  42         if(signal.get_sign() == sign_t::UNSIGNED)
  43                 return 1;
  44         else if(signal.get_sign() == sign_t::SIGN_BIT_EXTERN) {
  45                 end_bit = signal.get_bit_sign_position() % CHAR_BIT;
  46                 mask = static_cast<uint8_t>((1 << (end_bit + 1)) - 1);
  47                 data_byte = can_data[signal.get_bit_sign_position() / CHAR_BIT] & mask;
  48         }
  49         else {
  50                 end_bit = new_end_bit;
  51                 mask = static_cast<uint8_t>((1 << (end_bit + 1)) - 1);
  52                 data_byte = data_signal[0] & mask;
  53         }
  54
  55         //if negative: decode with right method
  56         if(data_byte  >> end_bit) {
  57                 switch(signal.get_sign())
  58                 {
  59                         //remove the sign bit to get the absolute value
  60                         case sign_t::SIGN_BIT:
  61                                 data_signal[0] = static_cast<uint8_t>(data_signal[0] & (mask >> 1));
  62                                 break;
  63                         //same method twos complement = ones complement + 1
  64                         case sign_t::ONES_COMPLEMENT:
  65                         case sign_t::TWOS_COMPLEMENT:
  66                                 //complement only until end_bit
  67                                 data_signal[0] = ((data_signal[0] ^ mask) & mask);
  68                                 if(data_signal.size() > 1)
  69                                         for(int i=1; i < data_signal.size(); i++)
  70                                                 data_signal[i] = data_signal[i] ^ 0xFF;
  71                                 if(signal.get_sign() == sign_t::TWOS_COMPLEMENT)
  72                                         data_signal[data_signal.size() - 1] = static_cast<uint8_t>(data_signal[data_signal.size() - 1] + 1);
  73                                 break;
  74                         case sign_t::SIGN_BIT_EXTERN:
  75                                 break;
  76                         default:
  77                                 AFB_ERROR("Not a valid sign entry %d, considering the value as unsigned", signal.get_sign());
  78                                 break;
  79                 }
  80                 return -1;
  81         }
  82         return 1;
  83 }
  84
  85 /// @brief Parses the signal's bitfield from the given data and returns the raw
  86 /// value.
  87 ///
  88 /// @param[in] signal - The signal to be parsed from the data.
  89 /// @param[in] message - message_t to parse
  90 ///
  91 /// @return Returns the raw value of the signal parsed as a bitfield from the given byte
  92 /// array.
  93 ///
  94 float decoder_t::parse_signal_bitfield(signal_t& signal, std::shared_ptr<message_t> message)
  95 {
  96         int sign;
  97         std::vector<uint8_t> data;
  98         std::vector<uint8_t> data_signal;
  99         uint8_t bit_size = (uint8_t) signal.get_bit_size();
 100         uint32_t bit_position = signal.get_bit_position();
 101
 102         int new_start_byte = 0;
 103         int new_end_byte = 0;
 104         uint8_t new_start_bit = 0;
 105         uint8_t new_end_bit = 0;
 106
 107         data = message->get_data_vector();
 108         converter_t::signal_to_bits_bytes(bit_position, bit_size, new_start_byte, new_end_byte, new_start_bit, new_end_bit);
 109
 110         for(int i=new_start_byte;i<=new_end_byte;i++)
 111                 data_signal.push_back(data[i]);
 112
 113         sign = handle_sign(signal, data_signal, new_end_bit, data);
 114
 115         if(data_signal.size() > 65535)
 116                 AFB_ERROR("Too long data signal %s", signal.get_name().c_str());
 117
 118         return static_cast<float>(sign) * bitfield_parse_float(data_signal.data(), (uint16_t) data_signal.size(),
 119                         new_start_bit, bit_size, signal.get_factor(),
 120                         signal.get_offset());
 121 }
 122
 123
 124 /// @brief Decode and return string bytes (hex) for a CAN signal's.
 125 ///
 126 /// This is an implementation of the Signal type signature, and can be
 127 /// used directly in the signal_t.decoder field.
 128 ///
 129 /// @param[in] signal  - The details of the signal.
 130 /// @param[in] message - The message with data to decode.
 131 /// @param[out] send - An output argument that will be set to false if the value should
 132 ///     not be sent for any reason.
 133 ///
 134 /// @return Returns a DynamicField with a string value of bytes (hex)
 135 ///
 136 openxc_DynamicField decoder_t::decode_bytes(signal_t& signal, std::shared_ptr<message_t> message, bool* send)
 137 {
 138         int i=0;
 139         openxc_DynamicField decoded_value;
 140         std::vector<uint8_t> data = message->get_data_vector();
 141         uint32_t length = message->get_length();
 142         uint32_t bit_position = signal.get_bit_position();
 143         uint32_t bit_size = signal.get_bit_size();
 144
 145         std::vector<uint8_t> new_data = std::vector<uint8_t>();
 146         new_data.reserve((bit_size / CHAR_BIT) + 1);
 147
 148         int new_start_byte = 0;
 149         int new_end_byte = 0;
 150         uint8_t new_start_bit = 0;
 151         uint8_t new_end_bit = 0;
 152
 153         converter_t::signal_to_bits_bytes(bit_position, bit_size, new_start_byte, new_end_byte, new_start_bit, new_end_bit);
 154
 155         if(new_end_byte >= length)
 156                 new_end_byte = length-1;
 157
 158         if(new_start_byte >= length)
 159         {
 160                 AFB_ERROR("Error in signal's description");
 161                 return decoded_value;
 162         }
 163
 164         uint8_t mask_first_v = static_cast<uint8_t>(0xFF << new_start_bit);
 165         uint8_t mask_last_v = static_cast<uint8_t>(0xFF >> (7 - new_end_bit));
 166
 167         if(new_start_byte == new_end_byte)
 168         {
 169                 data[new_start_byte] = data[new_start_byte] & (mask_first_v & mask_last_v);
 170         }
 171         else
 172         {
 173                 data[new_start_byte] = data[new_start_byte] & mask_first_v;
 174                 data[new_end_byte] = data[new_end_byte] & mask_last_v;
 175         }
 176
 177         for(i=new_start_byte ; i <= new_end_byte ; i++)
 178                 new_data.push_back(data[i]);
 179
 180         decoded_value = build_DynamicField(new_data);
 181
 182         return decoded_value;
 183 }
 184
 185
 186 /// @brief Decode and return string bytes (hex) for a CAN signal's.
 187 ///
 188 /// This is an implementation of the Signal type signature, and can be
 189 /// used directly in the signal_t.decoder field.
 190 ///
 191 /// @param[in] signal  - The details of the signal.
 192 /// @param[in] message - The message with data to decode.
 193 /// @param[out] send - An output argument that will be set to false if the value should
 194 ///     not be sent for any reason.
 195 ///
 196 /// @return Returns a DynamicField with a string value of bytes (hex)
 197 ///
 198 openxc_DynamicField decoder_t::decode_ascii(signal_t& signal, std::shared_ptr<message_t> message, bool* send)
 199 {
 200         std::string ret_s = "";
 201         openxc_DynamicField openxc_bytes = decode_bytes(signal,message,send);
 202         if(!openxc_bytes.has_bytes_value)
 203                 AFB_ERROR("Error no bytes value to translate to ascii");
 204         ret_s = converter_t::to_ascii(openxc_bytes.bytes_value,openxc_bytes.length_array);
 205         openxc_DynamicField ret = build_DynamicField(ret_s);
 206         return ret;
 207 }
 208
 209 //edit
 210 openxc_DynamicField decoder_t::decode_date(signal_t& signal, std::shared_ptr<message_t> message, bool* send)
 211 {
 212         float value = decoder_t::parse_signal_bitfield(signal, message);
 213         AFB_DEBUG("Decoded message from parse_signal_bitfield: %f", value);
 214         openxc_DynamicField decoded_value = build_DynamicField(value);
 215
 216         // Don't send if they is no changes
 217         if ((signal.get_last_value() == value && !signal.get_send_same()) || !*send )
 218                 *send = false;
 219         signal.set_last_value(value);
 220
 221         return decoded_value;
 222 }
 223
 224 //edit
 225 openxc_DynamicField decoder_t::decode_time(signal_t& signal, std::shared_ptr<message_t> message, bool* send)
 226 {
 227         float value = decoder_t::parse_signal_bitfield(signal, message);
 228         AFB_DEBUG("Decoded message from parse_signal_bitfield: %f", value);
 229         openxc_DynamicField decoded_value = build_DynamicField(value);
 230
 231         // Don't send if they is no changes
 232         *send = (signal.get_last_value() == value && !signal.get_send_same()) || !*send ? false : true;
 233         signal.set_last_value(value);
 234
 235         return decoded_value;
 236 }
 237
 238
 239 /// @brief Wraps a raw CAN signal value in a DynamicField without modification.
 240 ///
 241 /// This is an implementation of the Signal type signature, and can be
 242 /// used directly in the signal_t.decoder field.
 243 ///
 244 /// @param[in] signal - The details of the signal that contains the state mapping.
 245 /// @param[in] message - The message with data to decode.
 246 /// @param[out] send - An output argument that will be set to false if the value should
 247 ///     not be sent for any reason.
 248 ///
 249 /// @return Returns a DynamicField with the original, unmodified raw CAN signal value as
 250 /// its numeric value. The 'send' argument will not be modified as this decoder
 251 /// always succeeds.
 252 ///
 253 openxc_DynamicField decoder_t::decode_noop(signal_t& signal, std::shared_ptr<message_t> message, bool* send)
 254 {
 255         float value = decoder_t::parse_signal_bitfield(signal, message);
 256         AFB_DEBUG("Decoded message from parse_signal_bitfield: %f", value);
 257         openxc_DynamicField decoded_value = build_DynamicField(value);
 258
 259         // Don't send if they is no changes
 260         if ((signal.get_last_value() == value && !signal.get_send_same()) || !*send )
 261                 *send = false;
 262         signal.set_last_value(value);
 263
 264         return decoded_value;
 265 }
 266 /// @brief Coerces a numerical value to a boolean.
 267 ///
 268 /// This is an implementation of the Signal type signature, and can be
 269 /// used directly in the signal_t.decoder field.
 270 ///
 271 /// @param[in] signal  - The details of the signal that contains the state mapping.
 272 /// @param[in] message - The message with data to decode.
 273 /// @param[out] send - An output argument that will be set to false if the value should
 274 ///     not be sent for any reason.
 275 ///
 276 /// @return Returns a DynamicField with a boolean value of false if the raw signal value
 277 /// is 0.0, otherwise true. The 'send' argument will not be modified as this
 278 /// decoder always succeeds.
 279 ///
 280 openxc_DynamicField decoder_t::decode_boolean(signal_t& signal, std::shared_ptr<message_t> message, bool* send)
 281 {
 282         float value = decoder_t::parse_signal_bitfield(signal, message);
 283         AFB_DEBUG("Decoded message from parse_signal_bitfield: %f", value);
 284         openxc_DynamicField decoded_value = build_DynamicField(value == 0.0 ? false : true);
 285
 286         // Don't send if they is no changes
 287         if ((signal.get_last_value() == value && !signal.get_send_same()) || !*send )
 288                 *send = false;
 289
 290         signal.set_last_value(value);
 291
 292
 293         return decoded_value;
 294 }
 295 /// @brief Update the metadata for a signal and the newly received value.
 296 ///
 297 /// This is an implementation of the Signal type signature, and can be
 298 /// used directly in the signal_t.decoder field.
 299 ///
 300 /// This function always flips 'send' to false.
 301 ///
 302 /// @param[in] signal  - The details of the signal that contains the state mapping.
 303 /// @param[in] message - The message with data to decode.
 304 /// @param[out] send - This output argument will always be set to false, so the caller will
 305 ///      know not to publish this value to the pipeline.
 306 ///
 307 /// @return Return value is undefined.
 308 ///
 309 openxc_DynamicField decoder_t::decode_ignore(signal_t& signal, std::shared_ptr<message_t> message, bool* send)
 310 {
 311         float value = decoder_t::parse_signal_bitfield(signal, message);
 312         if(send)
 313           *send = false;
 314
 315         signal.set_last_value(value);
 316         openxc_DynamicField decoded_value;
 317
 318         return decoded_value;
 319 }
 320
 321 /// @brief Find and return the corresponding string state for a CAN signal's
 322 /// raw integer value.
 323 ///
 324 /// This is an implementation of the Signal type signature, and can be
 325 /// used directly in the signal_t.decoder field.
 326 ///
 327 /// @param[in] signal  - The details of the signal that contains the state mapping.
 328 /// @param[in] message - The message with data to decode.
 329 /// @param[out] send - An output argument that will be set to false if the value should
 330 ///     not be sent for any reason.
 331 ///
 332 /// @return Returns a DynamicField with a string value if a matching state is found in
 333 /// the signal. If an equivalent isn't found, send is sent to false and the
 334 /// return value is undefined.
 335 ///
 336 openxc_DynamicField decoder_t::decode_state(signal_t& signal, std::shared_ptr<message_t> message, bool* send)
 337 {
 338         float value = decoder_t::parse_signal_bitfield(signal, message);
 339         AFB_DEBUG("Decoded message from parse_signal_bitfield: %f", value);
 340         const std::string signal_state = signal.get_states((uint8_t)value);
 341         openxc_DynamicField decoded_value = build_DynamicField(signal_state);
 342         if(signal_state.size() <= 0)
 343         {
 344                 *send = false;
 345                 AFB_ERROR("No state found with index: %d", (int)value);
 346         }
 347
 348         // Don't send if they is no changes
 349         if ((signal.get_last_value() == value && !signal.get_send_same()) || !*send )
 350                 *send = false;
 351         signal.set_last_value(value);
 352
 353
 354         return decoded_value;
 355 }
 356
 357
 358 /// @brief Parse a signal from a CAN message, apply any required transforations
 359 ///      to get a human readable value and public the result to the pipeline.
 360 ///
 361 /// If the signal_t has a non-NULL 'decoder' field, the raw CAN signal value
 362 /// will be passed to the decoder before publishing.
 363 ///
 364 /// @param[in] signal - The details of the signal to decode and forward.
 365 /// @param[in] message - The message with data to decode.
 366 /// @param[out] send - An output parameter that will be flipped to false if the value could
 367 ///      not be decoded.
 368 ///
 369 /// The decoder returns an openxc_DynamicField, which may contain a number,
 370 /// string or boolean.
 371 ///
 372 openxc_DynamicField decoder_t::translate_signal(signal_t& signal, std::shared_ptr<message_t> message, bool* send)
 373 {
 374         // Must call the decoders every time, regardless of if we are going to
 375         // decide to send the signal or not.
 376         openxc_DynamicField decoded_value = decoder_t::decode_signal(signal,
 377                         message, send);
 378
 379         signal.set_received(true);
 380         signal.set_timestamp(message->get_timestamp());
 381         signal.get_message()->set_last_value(message);
 382         return decoded_value;
 383 }
 384
 385 /// @brief Parse a signal from a CAN message and apply any required
 386 /// transforations to get a human readable value.
 387 ///
 388 /// If the signal_t has a non-NULL 'decoder' field, the raw CAN signal value
 389 /// will be passed to the decoder before returning.
 390 ///
 391 /// @param[in] signal - The details of the signal to decode and forward.
 392 /// @param[in] message - The message with data to decode.
 393 /// @param[out] send - An output parameter that will be flipped to false if the value could
 394 ///      not be decoded.
 395 ///
 396 /// @return The decoder returns an openxc_DynamicField, which may contain a number,
 397 /// string or boolean. If 'send' is false, the return value is undefined.
 398 ///
 399 openxc_DynamicField decoder_t::decode_signal( signal_t& signal, std::shared_ptr<message_t> message, bool* send)
 400 {
 401
 402
 403         if(signal.get_message()->get_flags() & CONTINENTAL_BIT_POSITION)
 404                 signal.set_bit_position(converter_t::continental_bit_position_mess(message->get_length(),
 405                                                               signal.get_bit_position(),
 406                                                               signal.get_bit_size()));
 407         if(signal.get_message()->get_flags() & BIT_POSITION_REVERSED)
 408                 signal.set_bit_position(converter_t::bit_position_swap(message->get_length(),
 409                                                               signal.get_bit_position(),
 410                                                               signal.get_bit_size()));
 411
 412         signal_decoder decoder = signal.get_decoder() == nullptr ?
 413                                                         decode_noop : signal.get_decoder();
 414
 415         openxc_DynamicField decoded_value = decoder(signal,
 416                         message, send);
 417         return decoded_value;
 418 }
 419
 420 ///
 421 /// @brief Decode the payload of an OBD-II PID.
 422 ///
 423 /// This function matches the type signature for a DiagnosticResponse, so
 424 /// it can be used as the decoder for a DiagnosticRequest. It returns the decoded
 425 /// value of the PID, using the standard formulas (see
 426 /// http://en.wikipedia.org/wiki/OBD-II_PIDs#Mode_01).
 427 ///
 428 /// @param[in] response - the received DiagnosticResponse (the data is in response.payload,
 429 ///  a byte array). This is most often used when the byte order is
 430 ///  signiticant, i.e. with many OBD-II PID formulas.
 431 /// @param[in] parsed_payload - the entire payload of the response parsed as an int.
 432 ///
 433 /// @return Float decoded value.
 434 ///
 435 float decoder_t::decode_obd2_response(const DiagnosticResponse* response, float parsed_payload)
 436 {
 437         return diagnostic_decode_obd2_pid(response);
 438 }