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 Parses the signal's bitfield from the given data and returns the raw
  27 /// value.
  28 ///
  29 /// @param[in] signal - The signal to be parsed from the data.
  30 /// @param[in] message - can_message_t to parse
  31 ///
  32 /// @return Returns the raw value of the signal parsed as a bitfield from the given byte
  33 /// array.
  34 ///
  35 float decoder_t::parse_signal_bitfield(signal_t& signal, std::shared_ptr<message_t> message)
  36 {
  37         const std::vector<uint8_t> data = message->get_data_vector();
  38         std::vector<uint8_t> data_signal;
  39         uint32_t bit_size = signal.get_bit_size();
  40         uint32_t bit_position = signal.get_bit_position();
  41
  42         int new_start_byte = 0;
  43         int new_end_byte = 0;
  44         int new_start_bit = 0;
  45         int new_end_bit = 0;
  46
  47         converter_t::signal_to_bits_bytes(bit_position, bit_size, new_start_byte, new_end_byte, new_start_bit, new_end_bit);
  48
  49         for(int i=new_start_byte;i<=new_end_byte;i++)
  50         {
  51                 data_signal.push_back(data[i]);
  52         }
  53
  54         uint8_t new_bit_size = 0;
  55
  56         if(bit_size > 255)
  57         {
  58                 AFB_ERROR("Error signal %s to long bit size",signal.get_name().c_str());
  59         }
  60         else
  61         {
  62                 new_bit_size = (uint8_t) bit_size;
  63         }
  64
  65         uint8_t bit_offset = 0;
  66         if(new_start_bit > 255)
  67         {
  68                 AFB_ERROR("Too long signal offset %d", new_start_bit);
  69         }
  70         else
  71         {
  72                 bit_offset = (uint8_t) new_start_bit;
  73         }
  74
  75         uint16_t length = 0;
  76
  77         if(data_signal.size() > 65535)
  78         {
  79                 AFB_ERROR("Too long data signal %s",signal.get_name().c_str());
  80         }
  81         else
  82         {
  83                 length = (uint16_t) data_signal.size();
  84         }
  85
  86         return bitfield_parse_float(data_signal.data(), length,
  87                         bit_offset, new_bit_size, signal.get_factor(),
  88                         signal.get_offset());
  89 }
  90
  91 /// @brief Wraps a raw CAN signal value in a DynamicField without modification.
  92 ///
  93 /// This is an implementation of the Signal type signature, and can be
  94 /// used directly in the signal_t.decoder field.
  95 ///
  96 /// @param[in] signal - The details of the signal that contains the state mapping.
  97 /// @param[in] value - The numerical value that will be wrapped in a DynamicField.
  98 /// @param[out] send - An output argument that will be set to false if the value should
  99 ///     not be sent for any reason.
 100 ///
 101 /// @return Returns a DynamicField with the original, unmodified raw CAN signal value as
 102 /// its numeric value. The 'send' argument will not be modified as this decoder
 103 /// always succeeds.
 104 ///
 105 openxc_DynamicField decoder_t::decode_noop(signal_t& signal, float value, bool* send)
 106 {
 107         openxc_DynamicField decoded_value = build_DynamicField(value);
 108
 109         return decoded_value;
 110 }
 111 /// @brief Coerces a numerical value to a boolean.
 112 ///
 113 /// This is an implementation of the Signal type signature, and can be
 114 /// used directly in the signal_t.decoder field.
 115 ///
 116 /// @param[in] signal  - The details of the signal that contains the state mapping.
 117 /// @param[in] value - The numerical value that will be converted to a boolean.
 118 /// @param[out] send - An output argument that will be set to false if the value should
 119 ///     not be sent for any reason.
 120 ///
 121 /// @return Returns a DynamicField with a boolean value of false if the raw signal value
 122 /// is 0.0, otherwise true. The 'send' argument will not be modified as this
 123 /// decoder always succeeds.
 124 ///
 125 openxc_DynamicField decoder_t::decode_boolean(signal_t& signal, float value, bool* send)
 126 {
 127         openxc_DynamicField decoded_value = build_DynamicField(value == 0.0 ? false : true);
 128
 129         return decoded_value;
 130 }
 131 /// @brief Update the metadata for a signal and the newly received value.
 132 ///
 133 /// This is an implementation of the Signal type signature, and can be
 134 /// used directly in the signal_t.decoder field.
 135 ///
 136 /// This function always flips 'send' to false.
 137 ///
 138 /// @param[in] signal  - The details of the signal that contains the state mapping.
 139 /// @param[in] value - The numerical value that will be converted to a boolean.
 140 /// @param[out] send - This output argument will always be set to false, so the caller will
 141 ///      know not to publish this value to the pipeline.
 142 ///
 143 /// @return Return value is undefined.
 144 ///
 145 openxc_DynamicField decoder_t::decode_ignore(signal_t& signal, float value, bool* send)
 146 {
 147         if(send)
 148           *send = false;
 149
 150         openxc_DynamicField decoded_value;
 151
 152         return decoded_value;
 153 }
 154
 155 /// @brief Find and return the corresponding string state for a CAN signal's
 156 /// raw integer value.
 157 ///
 158 /// This is an implementation of the Signal type signature, and can be
 159 /// used directly in the signal_t.decoder field.
 160 ///
 161 /// @param[in] signal  - The details of the signal that contains the state mapping.
 162 /// @param[in] value - The numerical value that should map to a state.
 163 /// @param[out] send - An output argument that will be set to false if the value should
 164 ///     not be sent for any reason.
 165 ///
 166 /// @return Returns a DynamicField with a string value if a matching state is found in
 167 /// the signal. If an equivalent isn't found, send is sent to false and the
 168 /// return value is undefined.
 169 ///
 170 openxc_DynamicField decoder_t::decode_state(signal_t& signal, float value, bool* send)
 171 {
 172         const std::string signal_state = signal.get_states((uint8_t)value);
 173         openxc_DynamicField decoded_value = build_DynamicField(signal_state);
 174         if(signal_state.size() <= 0)
 175         {
 176                 *send = false;
 177                 AFB_ERROR("No state found with index: %d", (int)value);
 178         }
 179         return decoded_value;
 180 }
 181
 182
 183 /// @brief Parse a signal from a CAN message, apply any required transforations
 184 ///      to get a human readable value and public the result to the pipeline.
 185 ///
 186 /// If the signal_t has a non-NULL 'decoder' field, the raw CAN signal value
 187 /// will be passed to the decoder before publishing.
 188 ///
 189 /// @param[in] signal - The details of the signal to decode and forward.
 190 /// @param[in] message - The received CAN message that should contain this signal.
 191 /// @param[out] send - An output parameter that will be flipped to false if the value could
 192 ///      not be decoded.
 193 ///
 194 /// The decoder returns an openxc_DynamicField, which may contain a number,
 195 /// string or boolean.
 196 ///
 197 openxc_DynamicField decoder_t::translate_signal(signal_t& signal, std::shared_ptr<message_t> message, bool* send)
 198 {
 199         float value = decoder_t::parse_signal_bitfield(signal, message);
 200         AFB_DEBUG("Decoded message from parse_signal_bitfield: %f", value);
 201
 202         // Must call the decoders every time, regardless of if we are going to
 203         // decide to send the signal or not.
 204         openxc_DynamicField decoded_value = decoder_t::decode_signal(signal,
 205                         value, send);
 206
 207         signal.set_received(true);
 208
 209         // Don't send if they is no changes
 210         if ((signal.get_last_value() == value && !signal.get_send_same()) || !*send )
 211         {
 212                 *send = false;
 213         }
 214         signal.set_last_value(value);
 215         signal.set_timestamp(message->get_timestamp());
 216         signal.get_message()->set_last_value(message);
 217         return decoded_value;
 218 }
 219
 220 /// @brief Parse a signal from a CAN message and apply any required
 221 /// transforations to get a human readable value.
 222 ///
 223 /// If the signal_t has a non-NULL 'decoder' field, the raw CAN signal value
 224 /// will be passed to the decoder before returning.
 225 ///
 226 /// @param[in] signal - The details of the signal to decode and forward.
 227 /// @param[in] value - The numerical value that will be converted to a boolean.
 228 /// @param[out] send - An output parameter that will be flipped to false if the value could
 229 ///      not be decoded.
 230 ///
 231 /// @return The decoder returns an openxc_DynamicField, which may contain a number,
 232 /// string or boolean. If 'send' is false, the return value is undefined.
 233 ///
 234 openxc_DynamicField decoder_t::decode_signal( signal_t& signal, float value, bool* send)
 235 {
 236         signal_decoder decoder = signal.get_decoder() == nullptr ?
 237                                                         decode_noop : signal.get_decoder();
 238         openxc_DynamicField decoded_value = decoder(signal,
 239                         value, send);
 240         return decoded_value;
 241 }
 242
 243 /// @brief Decode a transformed, human readable value from an raw CAN signal
 244 /// already parsed from a CAN message.
 245 ///
 246 /// This is the same as decode_signal but you must parse the bitfield value of the signal from the CAN
 247 /// message yourself. This is useful if you need that raw value for something
 248 /// else.
 249 ///
 250 /// @param[in] signal - The details of the signal to decode and forward.
 251 /// @param[in] message - Raw CAN message to decode
 252 /// @param[out] send - An output parameter that will be flipped to false if the value could
 253 ///      not be decoded.
 254 ///
 255 openxc_DynamicField decoder_t::decode_signal( signal_t& signal, std::shared_ptr<message_t> message, bool* send)
 256 {
 257         float value = parse_signal_bitfield(signal, message);
 258         return decode_signal(signal, value, send);
 259 }
 260
 261
 262 ///
 263 /// @brief Decode the payload of an OBD-II PID.
 264 ///
 265 /// This function matches the type signature for a DiagnosticResponse, so
 266 /// it can be used as the decoder for a DiagnosticRequest. It returns the decoded
 267 /// value of the PID, using the standard formulas (see
 268 /// http://en.wikipedia.org/wiki/OBD-II_PIDs#Mode_01).
 269 ///
 270 /// @param[in] response - the received DiagnosticResponse (the data is in response.payload,
 271 ///  a byte array). This is most often used when the byte order is
 272 ///  signiticant, i.e. with many OBD-II PID formulas.
 273 /// @param[in] parsed_payload - the entire payload of the response parsed as an int.
 274 ///
 275 /// @return Float decoded value.
 276 ///
 277 float decoder_t::decode_obd2_response(const DiagnosticResponse* response, float parsed_payload)
 278 {
 279         return diagnostic_decode_obd2_pid(response);
 280 }