src/diagnostic/diagnostic-message.hpp

   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 #pragma once
  19
  20 #include <vector>
  21
  22 #include "uds/uds.h"
  23 #include "../can/can-bus.hpp"
  24 #include "../can/can-message.hpp"
  25 #include "active-diagnostic-request.hpp"
  26
  27 #include "../low-can-binding.hpp"
  28
  29 enum UNIT {
  30         POURCENT,
  31         DEGREES_CELSIUS,
  32         KPA,
  33         RPM,
  34         GRAMS_SEC,
  35         SECONDS,
  36         KM,
  37         KM_H,
  38         PA,
  39         NM,
  40         INVALID
  41 };
  42
  43 /**
  44  * @brief - A representation of an OBD-II PID.
  45  */
  46 class diagnostic_message_t {
  47         private:
  48                 uint8_t pid_; /*!< pid - The 1 byte PID.*/
  49                 std::string generic_name_; /*!< generic_name_ - A human readable name to use for this PID when published.*/
  50                 int min_; /*!< min_ - Minimum value that can take this pid */
  51                 int max_; /*!< max_ - Maximum value that can take this pid */
  52                 enum UNIT unit_; /*!< unit_ : Which unit system is used by that pid. See enum UNIT above.*/
  53                 float frequency_; /*!< frequency - The frequency to request this PID if supported by the vehicle when automatic, recurring OBD-II requests are enabled.*/
  54                 DiagnosticResponseDecoder decoder_; /*!< decoder_ - An optional DiagnosticResponseDecoder to parse the payload of responses
  55                                                                                          * to this request. If the decoder is NULL, the output will include the raw payload
  56                                                                                          * instead of a parsed value.*/
  57                 DiagnosticResponseCallback callback_; /*!< callback_ - An optional DiagnosticResponseCallback to be notified whenever a
  58                                                                                            * response is received for this request.*/
  59
  60                 bool supported_; /*!< supported_ - boolean indicating whether this pid is supported by the vehicle or not.*/
  61
  62         public:
  63                 const char* generic_name = generic_name_.c_str();
  64                 diagnostic_message_t(uint8_t pid, const std::string generic_name, const int min, const int max, enum UNIT unit, float frequency,
  65                                                                                         DiagnosticResponseDecoder decoder, DiagnosticResponseCallback callback, bool supported);
  66
  67                 uint32_t get_pid();
  68                 const std::string& get_generic_name() const;
  69                 const std::string get_name() const;
  70                 float get_frequency() const;
  71                 DiagnosticResponseDecoder get_decoder() const;
  72                 DiagnosticResponseCallback get_callback() const;
  73                 bool get_supported() const;
  74
  75                 void set_supported(bool value);
  76
  77                 const DiagnosticRequest build_diagnostic_request();
  78
  79                 bool is_obd2_response(const can_message_t& can_message);
  80                 bool is_obd2_request(const DiagnosticRequest *request);
  81 };