low-can-binding/can/can-encoder.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-encoder.hpp"
  19
  20 #include "canutil/write.h"
  21 #include "../utils/openxc-utils.hpp"
  22 #include "message-definition.hpp"
  23 #include "../utils/converter.hpp"
  24
  25 /**
  26  * @brief Allows to encode data for a signal
  27  *
  28  * @param sig The signal to know its location
  29  * @param data The data to encod
  30  * @param filter If true that will generate the filter BCM for the signal
  31  * @param factor If true that will use the factor of the signal else 1
  32  * @param offset If true that will use the offset of the signal else 0
  33  */
  34 void encoder_t::encode_data(std::shared_ptr<signal_t> sig, std::vector<uint8_t> &data, bool filter, bool factor, bool offset)
  35 {
  36         uint32_t bit_size = sig->get_bit_size();
  37         uint32_t bit_position = sig->get_bit_position();
  38         int new_start_byte = 0;
  39         int new_end_byte = 0;
  40         uint8_t new_start_bit = 0;
  41         uint8_t new_end_bit = 0;
  42
  43         converter_t::signal_to_bits_bytes(bit_position, bit_size, new_start_byte, new_end_byte, new_start_bit, new_end_bit);
  44
  45         int len_signal_bytes_tmp = new_end_byte - new_start_byte + 1;
  46
  47         uint8_t len_signal_bytes = 0;
  48         if(len_signal_bytes_tmp > 255)
  49         {
  50                 AFB_ERROR("Error signal %s too long", sig->get_name().c_str());
  51         }
  52         else
  53         {
  54                 len_signal_bytes = (uint8_t) len_signal_bytes_tmp;
  55         }
  56 /*
  57         if(new_start_bit > 255)
  58         {
  59                 AFB_ERROR("Error signal %s too long", sig->get_name().c_str());
  60         }
  61 */
  62         uint8_t new_bit_size = 0;
  63         if(bit_size > 255)
  64         {
  65                 AFB_ERROR("Error signal %s to long bit size", sig->get_name().c_str());
  66         }
  67         else
  68         {
  69                 new_bit_size = (uint8_t) bit_size;
  70         }
  71
  72         uint8_t data_signal[len_signal_bytes] = {0};
  73         float factor_v = 1;
  74         if(factor)
  75         {
  76                 factor_v = sig->get_factor();
  77         }
  78
  79         float offset_v = 0;
  80         if(factor)
  81         {
  82                 offset_v = sig->get_offset();
  83         }
  84
  85         if(filter)
  86         {
  87                 uint8_t tmp = 0;
  88                 int j=0;
  89                 for(int i=0;i<new_bit_size;i++)
  90                 {
  91                         int mask = 1 << ((i%8)+new_start_bit);
  92
  93                         uint8_t mask_v = 0;
  94                         if(mask > 255)
  95                         {
  96                                 AFB_ERROR("Error mask too large");
  97                         }
  98                         else
  99                         {
 100                                 mask_v = (uint8_t) mask;
 101                         }
 102                         tmp = tmp|mask_v;
 103
 104                         if(i%8 == 7)
 105                         {
 106                                 data_signal[j] = tmp;
 107                                 tmp = 0;
 108                                 j++;
 109                         }
 110                 }
 111                 data_signal[j]=tmp;
 112         }
 113         else
 114         {
 115                 bitfield_encode_float(  sig->get_last_value(),
 116                                                 new_start_bit,
 117                                                 new_bit_size,
 118                                                 factor_v,
 119                                                 offset_v,
 120                                                 data_signal,
 121                                                 len_signal_bytes);
 122         }
 123
 124         for(size_t i = new_start_byte; i <= new_end_byte ; i++)
 125         {
 126                 data[i] = data[i] | data_signal[i-new_start_byte];
 127         }
 128 }
 129
 130 /**
 131  * @brief Allows to build a multi frame message with correct data to be send
 132  *
 133  * @param signal The CAN signal to write, including the bit position and bit size.
 134  * @param value The encoded integer value to write in the CAN signal.
 135  * @param message A multi frame message to complete
 136  * @param factor If true that will use the factor of the signal else 1
 137  * @param offset If true that will use the offset of the signal else 0
 138  * @return message_t*  The message that is generated
 139  */
 140 message_t* encoder_t::build_frame(const std::shared_ptr<signal_t>& signal, uint64_t value, message_t *message, bool factor, bool offset)
 141 {
 142         signal->set_last_value((float)value);
 143         std::vector<uint8_t> data;
 144         for(int i = 0; i<message->get_length();i++)
 145         {
 146                 data.push_back(0);
 147         }
 148
 149         for(const auto& sig: signal->get_message()->get_signals())
 150         {
 151                 encode_data(sig, data, false, factor, offset);
 152         }
 153         message->set_data(data);
 154         return message;
 155 }
 156
 157 /**
 158  * @brief Allows to build a message_t with correct data to be send
 159  *
 160  * @param signal The CAN signal to write, including the bit position and bit size.
 161  * @param value The encoded integer value to write in the CAN signal.
 162  * @param factor If true that will use the factor of the signal else 1
 163  * @param offset If true that will use the offset of the signal else 0
 164  * @return message_t* The message that is generated
 165  */
 166 message_t* encoder_t::build_message(const std::shared_ptr<signal_t>& signal, uint64_t value, bool factor, bool offset)
 167 {
 168         message_t *message;
 169         std::vector<uint8_t> data;
 170         if(signal->get_message()->is_fd())
 171         {
 172                 message = new can_message_t( CANFD_MAX_DLEN,
 173                                                                          signal->get_message()->get_id(),
 174                                                                          CANFD_MAX_DLEN,
 175                                                                          false,
 176                                                                          signal->get_message()->get_flags(),
 177                                                                          data,
 178                                                                          0);
 179
 180                 return build_frame(signal, value, message, factor, offset);
 181         }
 182 #ifdef USE_FEATURE_J1939
 183         else if(signal->get_message()->is_j1939())
 184         {
 185                 message = new j1939_message_t( signal->get_message()->get_length(),
 186                                                                            data,
 187                                                                            0,
 188                                                                            J1939_NO_NAME,
 189                                                                            signal->get_message()->get_id(),
 190                                                                            J1939_NO_ADDR);
 191                 return build_frame(signal, value, message, factor, offset);
 192         }
 193 #endif
 194         else
 195         {
 196                 message = new can_message_t(CAN_MAX_DLEN,
 197                                                                         signal->get_message()->get_id(),
 198                                                                         CAN_MAX_DLEN,
 199                                                                         false,
 200                                                                         signal->get_message()->get_flags(),
 201                                                                         data,
 202                                                                         0);
 203                 return build_frame(signal, value, message, factor, offset);
 204         }
 205 }
 206
 207
 208 /**
 209  * @brief Allows to build a single frame message with correct data to be send
 210  *
 211  * @param signal The CAN signal to write, including the bit position and bit size.
 212  * @param value The encoded integer value to write in the CAN signal.
 213  * @param message A single frame message to complete
 214  * @return message_t*  The message that is generated
 215  */
 216 message_t* encoder_t::build_one_frame_message(const std::shared_ptr<signal_t>& signal, uint64_t value, message_t *message)
 217 {
 218         signal->set_last_value((float)value);
 219         uint8_t data_tab[message->get_length()];
 220         std::vector<uint8_t> data;
 221
 222         for(const auto& sig: signal->get_message()->get_signals())
 223         {
 224                 float last_value = sig->get_last_value();
 225                 bitfield_encode_float(last_value,
 226                                         sig->get_bit_position(),
 227                                         sig->get_bit_size(),
 228                                         sig->get_factor(),
 229                                         sig->get_offset(),
 230                                         data_tab,
 231                                         (uint8_t)message->get_length());
 232         }
 233
 234         for (size_t i = 0; i < (uint8_t) message->get_length(); i++)
 235         {
 236                 data.push_back(data_tab[i]);
 237         }
 238
 239         message->set_data(data);
 240         return message;
 241 }
 242
 243 /**
 244  * @brief Allows to build a multi frame message with correct data to be send
 245  *
 246  * @param signal The CAN signal to write, including the bit position and bit size.
 247  * @param value The encoded integer value to write in the CAN signal.
 248  * @param message A multi frame message to complete
 249  * @return message_t*  The message that is generated
 250  */
 251 message_t* encoder_t::build_multi_frame_message(const std::shared_ptr<signal_t>& signal, uint64_t value, message_t *message)
 252 {
 253         signal->set_last_value((float)value);
 254         std::vector<uint8_t> data;
 255
 256         uint32_t msgs_len = signal->get_message()->get_length(); // multi frame - number of bytes
 257         int number_of_frame = (int) msgs_len / 8;
 258
 259         uint8_t data_tab[number_of_frame][8] = {0};
 260
 261         for(const auto& sig: signal->get_message()->get_signals())
 262         {
 263
 264                 int frame_position = (int) sig->get_bit_position() / 64;
 265                 float last_value = sig->get_last_value();
 266                 uint8_t bit_position = sig->get_bit_position() - ((uint8_t)(64 * frame_position));
 267
 268                 bitfield_encode_float(last_value,
 269                                         bit_position,
 270                                         sig->get_bit_size(),
 271                                         sig->get_factor(),
 272                                         sig->get_offset(),
 273                                         data_tab[frame_position],
 274                                         8);
 275         }
 276
 277         for (size_t i = 0; i < number_of_frame; i++)
 278         {
 279                 for(size_t j = 0; j < 8 ; j++)
 280                 {
 281                         data.push_back(data_tab[i][j]);
 282                 }
 283         }
 284
 285         message->set_data(data);
 286         return message;
 287 }
 288
 289 /**
 290  * @brief Allows to build a message_t with correct data to be send
 291  *
 292  * @param signal The CAN signal to write, including the bit position and bit size.
 293  * @param value The encoded integer value to write in the CAN signal.
 294  * @return message_t* The message that is generated
 295  */
 296 message_t* encoder_t::build_message(const std::shared_ptr<signal_t>& signal, uint64_t value)
 297 {
 298         message_t *message;
 299         std::vector<uint8_t> data;
 300         if(signal->get_message()->is_fd())
 301         {
 302                 message = new can_message_t(CANFD_MAX_DLEN,
 303                                             signal->get_message()->get_id(),
 304                                             CANFD_MAX_DLEN,
 305                                             false,
 306                                             signal->get_message()->get_flags(),
 307                                             data,
 308                                             0);
 309                 return build_one_frame_message(signal, value, message);
 310         }
 311 #ifdef USE_FEATURE_J1939
 312         else if(signal->get_message()->is_j1939())
 313         {
 314                 message = new j1939_message_t(signal->get_message()->get_length(),
 315                                               data,
 316                                               0,
 317                                               J1939_NO_NAME,
 318                                               signal->get_message()->get_id(),
 319                                               J1939_NO_ADDR);
 320                 return build_multi_frame_message(signal, value, message);
 321         }
 322 #endif
 323         else
 324         {
 325                 message = new can_message_t(CAN_MAX_DLEN,
 326                                             signal->get_message()->get_id(),
 327                                             CAN_MAX_DLEN,
 328                                             false,
 329                                             signal->get_message()->get_flags(),
 330                                             data,
 331                                             0);
 332                 return build_one_frame_message(signal, value, message);
 333         }
 334 }
 335
 336 /// @brief Encode a boolean into an integer, fit for a CAN signal bitfield.
 337 ///
 338 /// This is a shortcut for encodeDynamicField(CanSignal*, openxc_DynamicField*,
 339 /// bool*) that takes care of creating the DynamicField object for you with the
 340 /// boolean value.
 341 ///
 342 /// @param[in] signal  - The CAN signal to encode this value for..
 343 /// @param[in] value - The boolean value to encode
 344 /// @param[out] send - An output argument that will be set to false if the value should
 345 ///     not be sent for any reason.
 346 ///
 347 /// @return Returns the encoded integer. If 'send' is changed to false, the field could
 348 /// not be encoded and the return value is undefined.
 349 ///
 350 uint64_t encoder_t::encode_boolean(const signal_t& signal, bool value, bool* send)
 351 {
 352         return encode_number(signal, float(value), send);
 353 }
 354 /// @brief Encode a float into an integer, fit for a CAN signal's bitfield.
 355 ///
 356 /// This is a shortcut for encodeDynamicField(CanSignal*, openxc_DynamicField*,
 357 /// bool*) that takes care of creating the DynamicField object for you with the
 358 /// float value.
 359 ///
 360 /// @param[in] signal  - The CAN signal to encode this value for.
 361 /// @param[in] value - The float value to encode.
 362 /// @param[out] send - This output argument will always be set to false, so the caller will
 363 ///      know not to publish this value to the pipeline.
 364 ///
 365 /// @return Returns the encoded integer. If 'send' is changed to false, the field could
 366 /// not be encoded and the return value is undefined.
 367 ///
 368 uint64_t encoder_t::encode_number(const signal_t& signal, float value, bool* send)
 369 {
 370         return float_to_fixed_point(value, signal.get_factor(), signal.get_offset());
 371 }
 372
 373 /// @brief Encode a string into an integer, fit for a CAN signal's bitfield.
 374 ///
 375 /// Be aware that the behavior is undefined if there are multiple values assigned
 376 /// to a single state. See https://github.com/openxc/vi-firmware/issues/185.
 377 ///
 378 /// This is a shortcut for encodeDynamicField(CanSignal*, openxc_DynamicField*,
 379 /// bool*) that takes care of creating the DynamicField object for you with the
 380 /// string state value.
 381 ///
 382 /// @param[in] signal  - The details of the signal that contains the state mapping.
 383 /// @param[in] value - The string state value to encode.
 384 /// @param[out] send - An output argument that will be set to false if the value should
 385 ///     not be sent for any reason.
 386 ///
 387 /// @return Returns the encoded integer. If 'send' is changed to false, the field could
 388 /// not be encoded and the return value is undefined.
 389 ///
 390 uint64_t encoder_t::encode_state(const signal_t& signal, const std::string& state, bool* send)
 391 {
 392         uint64_t value = 0;
 393         if(state == "")
 394         {
 395                 AFB_DEBUG("Can't write state of "" -- not sending");
 396                 *send = false;
 397         }
 398         else
 399         {
 400                 uint64_t signal_state = signal.get_states(state);
 401                 if(signal_state != -1) {
 402                         value = signal_state;
 403                 } else {
 404                         AFB_DEBUG("Couldn't find a valid signal state for %s", state.c_str());
 405                         *send = false;
 406                 }
 407         }
 408         return value;
 409 }
 410
 411 /// @brief Parse a signal from a CAN message and apply any required
 412 /// transforations to get a human readable value.
 413 ///
 414 /// If the signal_t has a non-NULL 'decoder' field, the raw CAN signal value
 415 /// will be passed to the decoder before returning.
 416 ///
 417 /// @param[in] signal - The details of the signal to decode and forward.
 418 /// @param[in] value - The numerical value that will be converted to a boolean.
 419 /// @param[out] send - An output parameter that will be flipped to false if the value could
 420 ///      not be decoded.
 421 ///
 422 /// @return The decoder returns an openxc_DynamicField, which may contain a number,
 423 /// string or boolean. If 'send' is false, the return value is undefined.
 424 ///
 425 uint64_t encoder_t::encode_DynamicField( signal_t& signal, const openxc_DynamicField& field, bool* send)
 426 {
 427         uint64_t value = 0;
 428         switch(field.type) {
 429                 case openxc_DynamicField_Type_STRING:
 430                         value = encode_state(signal, field.string_value, send);
 431                         break;
 432                 case openxc_DynamicField_Type_NUM:
 433                         value = encode_number(signal, (float)field.numeric_value, send);
 434                         break;
 435                 case openxc_DynamicField_Type_BOOL:
 436                         value = encode_boolean(signal, field.boolean_value, send);
 437                         break;
 438                 default:
 439                         AFB_DEBUG("Dynamic field didn't have a value, can't encode");
 440                         *send = false;
 441                         break;
 442         }
 443         return value;
 444 }