2 * Copyright (C) 2015, 2016 "IoT.bzh"
3 * Author "Romain Forlot" <romain.forlot@iot.bzh>
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
24 #include "../can/can-message-set.hpp"
25 #include "../can/can-message.hpp"
26 #include "active-diagnostic-request.hpp"
42 class can_message_set_t;
44 /// @brief - A representation of an OBD-II PID.
45 class diagnostic_message_t
48 can_message_set_t* parent_; /*!< parent_ - Pointer to the CAN message set holding this diagnostic message */
49 uint8_t pid_; /*!< pid_ - The 1 byte PID.*/
50 std::string generic_name_; /*!< generic_name_ - A human readable name to use for this PID when published.*/
51 int min_; /*!< min_ - Minimum value that can take this pid */
52 int max_; /*!< max_ - Maximum value that can take this pid */
53 enum UNIT unit_; /*!< unit_ : Which unit system is used by that pid. See enum UNIT above.*/
54 float frequency_; /*!< frequency_ - The frequency to request this PID if supported by the vehicle when automatic, recurring OBD-II requests are enabled.*/
55 DiagnosticResponseDecoder decoder_; /*!< decoder_ - An optional DiagnosticResponseDecoder to parse the payload of responses
56 * to this request. If the decoder is NULL, the output will include the raw payload
57 * instead of a parsed value.*/
58 DiagnosticResponseCallback callback_; /*!< callback_ - An optional DiagnosticResponseCallback to be notified whenever a
59 * response is received for this request.*/
61 bool supported_; /*!< supported_ - boolean indicating whether this pid is supported by the vehicle or not.*/
64 const char* generic_name = generic_name_.c_str();
65 diagnostic_message_t(uint8_t pid, const std::string& generic_name, const int min, const int max, enum UNIT unit, float frequency,
66 DiagnosticResponseDecoder decoder, DiagnosticResponseCallback callback, bool supported);
69 const std::string get_generic_name() const;
70 const std::string get_name() const;
71 float get_frequency() const;
72 DiagnosticResponseDecoder get_decoder() const;
73 DiagnosticResponseCallback get_callback() const;
74 bool get_supported() const;
76 void set_supported(bool value);
77 void set_parent(can_message_set_t* parent);
78 const DiagnosticRequest build_diagnostic_request() const;
80 bool is_obd2_response(const can_message_t& can_message);
81 bool is_obd2_request(const DiagnosticRequest *request);