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 = decoder_t::handle_sign(signal, data_signal, new_end_bit, data);
 113
 114         if(data_signal.size() > 65535)
 115                 AFB_ERROR("Too long data signal %s", signal.get_name().c_str());
 116
 117         return static_cast<float>(sign) * bitfield_parse_float(data_signal.data(), (uint16_t) data_signal.size(),
 118                         new_start_bit, bit_size, signal.get_factor(),
 119                         signal.get_offset());
 120 }
 121
 122
 123 /// @brief Decode and return string bytes (hex) for a CAN signal's.
 124 ///
 125 /// This is an implementation of the Signal type signature, and can be
 126 /// used directly in the signal_t.decoder field.
 127 ///
 128 /// @param[in] signal  - The details of the signal.
 129 /// @param[in] message - The message with data to decode.
 130 /// @param[out] send - An output argument that will be set to false if the value should
 131 ///     not be sent for any reason.
 132 ///
 133 /// @return Returns a DynamicField with a string value of bytes (hex)
 134 ///
 135 openxc_DynamicField decoder_t::decode_bytes(signal_t& signal, std::shared_ptr<message_t> message, bool* send)
 136 {
 137         int i=0;
 138         openxc_DynamicField decoded_value;
 139         std::vector<uint8_t> data = message->get_data_vector();
 140         uint32_t length = message->get_length();
 141         uint32_t bit_position = signal.get_bit_position();
 142         uint32_t bit_size = signal.get_bit_size();
 143
 144         std::vector<uint8_t> new_data = std::vector<uint8_t>();
 145         new_data.reserve((bit_size / 8) + 1);
 146
 147         int new_start_byte = 0;
 148         int new_end_byte = 0;
 149         uint8_t new_start_bit = 0;
 150         uint8_t new_end_bit = 0;
 151
 152         converter_t::signal_to_bits_bytes(bit_position, bit_size, new_start_byte, new_end_byte, new_start_bit, new_end_bit);
 153
 154         if(new_end_byte >= length)
 155                 new_end_byte = length-1;
 156
 157         if(new_start_byte >= length)
 158         {
 159                 AFB_ERROR("Error in signal's description");
 160                 return decoded_value;
 161         }
 162
 163         uint8_t mask_first_v = static_cast<uint8_t>(0xFF << new_start_bit);
 164         uint8_t mask_last_v = static_cast<uint8_t>(0xFF >> (7 - new_end_bit));
 165
 166         if(new_start_byte == new_end_byte)
 167         {
 168                 data[new_start_byte] = data[new_start_byte] & (mask_first_v & mask_last_v);
 169         }
 170         else
 171         {
 172                 data[new_start_byte] = data[new_start_byte] & mask_first_v;
 173                 data[new_end_byte] = data[new_end_byte] & mask_last_v;
 174         }
 175
 176         for(i=new_start_byte ; i <= new_end_byte ; i++)
 177                 new_data.push_back(data[i]);
 178
 179         decoded_value = build_DynamicField(new_data);
 180
 181         return decoded_value;
 182 }
 183
 184 /// @brief Wraps a raw CAN signal value in a DynamicField without modification.
 185 ///
 186 /// This is an implementation of the Signal type signature, and can be
 187 /// used directly in the signal_t.decoder field.
 188 ///
 189 /// @param[in] signal - The details of the signal that contains the state mapping.
 190 /// @param[in] message - The message with data to decode.
 191 /// @param[out] send - An output argument that will be set to false if the value should
 192 ///     not be sent for any reason.
 193 ///
 194 /// @return Returns a DynamicField with the original, unmodified raw CAN signal value as
 195 /// its numeric value. The 'send' argument will not be modified as this decoder
 196 /// always succeeds.
 197 ///
 198 openxc_DynamicField decoder_t::decode_noop(signal_t& signal, std::shared_ptr<message_t> message, bool* send)
 199 {
 200         float value = decoder_t::parse_signal_bitfield(signal, message);
 201         AFB_DEBUG("Decoded message from parse_signal_bitfield: %f", value);
 202         openxc_DynamicField decoded_value = build_DynamicField(value);
 203
 204         // Don't send if they is no changes
 205         if ((signal.get_last_value() == value && !signal.get_send_same()) || !*send )
 206         {
 207                 *send = false;
 208         }
 209         signal.set_last_value(value);
 210
 211         return decoded_value;
 212 }
 213 /// @brief Coerces a numerical value to a boolean.
 214 ///
 215 /// This is an implementation of the Signal type signature, and can be
 216 /// used directly in the signal_t.decoder field.
 217 ///
 218 /// @param[in] signal  - The details of the signal that contains the state mapping.
 219 /// @param[in] message - The message with data to decode.
 220 /// @param[out] send - An output argument that will be set to false if the value should
 221 ///     not be sent for any reason.
 222 ///
 223 /// @return Returns a DynamicField with a boolean value of false if the raw signal value
 224 /// is 0.0, otherwise true. The 'send' argument will not be modified as this
 225 /// decoder always succeeds.
 226 ///
 227 openxc_DynamicField decoder_t::decode_boolean(signal_t& signal, std::shared_ptr<message_t> message, bool* send)
 228 {
 229         float value = decoder_t::parse_signal_bitfield(signal, message);
 230         AFB_DEBUG("Decoded message from parse_signal_bitfield: %f", value);
 231         openxc_DynamicField decoded_value = build_DynamicField(value == 0.0 ? false : true);
 232
 233         // Don't send if they is no changes
 234         if ((signal.get_last_value() == value && !signal.get_send_same()) || !*send )
 235                 *send = false;
 236
 237         signal.set_last_value(value);
 238
 239
 240         return decoded_value;
 241 }
 242 /// @brief Update the metadata for a signal and the newly received value.
 243 ///
 244 /// This is an implementation of the Signal type signature, and can be
 245 /// used directly in the signal_t.decoder field.
 246 ///
 247 /// This function always flips 'send' to false.
 248 ///
 249 /// @param[in] signal  - The details of the signal that contains the state mapping.
 250 /// @param[in] message - The message with data to decode.
 251 /// @param[out] send - This output argument will always be set to false, so the caller will
 252 ///      know not to publish this value to the pipeline.
 253 ///
 254 /// @return Return value is undefined.
 255 ///
 256 openxc_DynamicField decoder_t::decode_ignore(signal_t& signal, std::shared_ptr<message_t> message, bool* send)
 257 {
 258         float value = decoder_t::parse_signal_bitfield(signal, message);
 259         if(send)
 260           *send = false;
 261
 262         signal.set_last_value(value);
 263         openxc_DynamicField decoded_value;
 264
 265         return decoded_value;
 266 }
 267
 268 /// @brief Find and return the corresponding string state for a CAN signal's
 269 /// raw integer value.
 270 ///
 271 /// This is an implementation of the Signal type signature, and can be
 272 /// used directly in the signal_t.decoder field.
 273 ///
 274 /// @param[in] signal  - The details of the signal that contains the state mapping.
 275 /// @param[in] message - The message with data to decode.
 276 /// @param[out] send - An output argument that will be set to false if the value should
 277 ///     not be sent for any reason.
 278 ///
 279 /// @return Returns a DynamicField with a string value if a matching state is found in
 280 /// the signal. If an equivalent isn't found, send is sent to false and the
 281 /// return value is undefined.
 282 ///
 283 openxc_DynamicField decoder_t::decode_state(signal_t& signal, std::shared_ptr<message_t> message, bool* send)
 284 {
 285         float value = decoder_t::parse_signal_bitfield(signal, message);
 286         AFB_DEBUG("Decoded message from parse_signal_bitfield: %f", value);
 287         const std::string signal_state = signal.get_states((uint8_t)value);
 288         openxc_DynamicField decoded_value = build_DynamicField(signal_state);
 289         if(signal_state.size() <= 0)
 290         {
 291                 *send = false;
 292                 AFB_ERROR("No state found with index: %d", (int)value);
 293         }
 294
 295         // Don't send if they is no changes
 296         if ((signal.get_last_value() == value && !signal.get_send_same()) || !*send )
 297         {
 298                 *send = false;
 299         }
 300         signal.set_last_value(value);
 301
 302
 303         return decoded_value;
 304 }
 305
 306
 307 /// @brief Parse a signal from a CAN message, apply any required transforations
 308 ///      to get a human readable value and public the result to the pipeline.
 309 ///
 310 /// If the signal_t has a non-NULL 'decoder' field, the raw CAN signal value
 311 /// will be passed to the decoder before publishing.
 312 ///
 313 /// @param[in] signal - The details of the signal to decode and forward.
 314 /// @param[in] message - The message with data to decode.
 315 /// @param[out] send - An output parameter that will be flipped to false if the value could
 316 ///      not be decoded.
 317 ///
 318 /// The decoder returns an openxc_DynamicField, which may contain a number,
 319 /// string or boolean.
 320 ///
 321 openxc_DynamicField decoder_t::translate_signal(signal_t& signal, std::shared_ptr<message_t> message, bool* send)
 322 {
 323         if(!signal.get_message()->frame_layout_is_little() && !signal.bit_position_is_swapped())
 324         {
 325                 signal.set_bit_position(converter_t::bit_position_swap(signal.get_bit_position(),signal.get_bit_size()));
 326                 signal.bit_position_is_swapped_reverse();
 327         }
 328         // Must call the decoders every time, regardless of if we are going to
 329         // decide to send the signal or not.
 330         openxc_DynamicField decoded_value = decoder_t::decode_signal(signal,
 331                         message, send);
 332
 333         signal.set_received(true);
 334         signal.set_timestamp(message->get_timestamp());
 335         signal.get_message()->set_last_value(message);
 336         return decoded_value;
 337 }
 338
 339 /// @brief Parse a signal from a CAN message and apply any required
 340 /// transforations to get a human readable value.
 341 ///
 342 /// If the signal_t has a non-NULL 'decoder' field, the raw CAN signal value
 343 /// will be passed to the decoder before returning.
 344 ///
 345 /// @param[in] signal - The details of the signal to decode and forward.
 346 /// @param[in] message - The message with data to decode.
 347 /// @param[out] send - An output parameter that will be flipped to false if the value could
 348 ///      not be decoded.
 349 ///
 350 /// @return The decoder returns an openxc_DynamicField, which may contain a number,
 351 /// string or boolean. If 'send' is false, the return value is undefined.
 352 ///
 353 openxc_DynamicField decoder_t::decode_signal( signal_t& signal, std::shared_ptr<message_t> message, bool* send)
 354 {
 355         signal_decoder decoder = signal.get_decoder() == nullptr ?
 356                                                         decode_noop : signal.get_decoder();
 357
 358         openxc_DynamicField decoded_value = decoder(signal,
 359                         message, send);
 360         return decoded_value;
 361 }
 362
 363 ///
 364 /// @brief Decode the payload of an OBD-II PID.
 365 ///
 366 /// This function matches the type signature for a DiagnosticResponse, so
 367 /// it can be used as the decoder for a DiagnosticRequest. It returns the decoded
 368 /// value of the PID, using the standard formulas (see
 369 /// http://en.wikipedia.org/wiki/OBD-II_PIDs#Mode_01).
 370 ///
 371 /// @param[in] response - the received DiagnosticResponse (the data is in response.payload,
 372 ///  a byte array). This is most often used when the byte order is
 373 ///  signiticant, i.e. with many OBD-II PID formulas.
 374 /// @param[in] parsed_payload - the entire payload of the response parsed as an int.
 375 ///
 376 /// @return Float decoded value.
 377 ///
 378 float decoder_t::decode_obd2_response(const DiagnosticResponse* response, float parsed_payload)
 379 {
 380         return diagnostic_decode_obd2_pid(response);
 381 }