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