Implement check of supported diagnostic PID.
[apps/agl-service-can-low-level.git] / src / diagnostic / diagnostic-message.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 "diagnostic-message.hpp"
19
20 #include "../configuration.hpp"
21 #include "../utils/signals.hpp"
22
23 const char *UNIT_NAMES[10] = {
24         "POURCENT",
25         "DEGREES_CELSIUS",
26         "KPA",
27         "RPM",
28         "GRAMS_SEC",
29         "SECONDS",
30         "KM",
31         "KM_H",
32         "PA",
33         "NM"
34 };
35
36 diagnostic_message_t::diagnostic_message_t(uint8_t pid, const std::string generic_name, const int min, const int max, enum UNIT unit, float frequency,
37                                                                                         DiagnosticResponseDecoder decoder, DiagnosticResponseCallback callback, bool supported)
38         : pid_{pid}, generic_name_{generic_name}, min_{min}, max_{max}, unit_{unit}, frequency_{frequency}, decoder_{decoder}, callback_{callback}, supported_{supported}
39 {}
40
41 uint32_t diagnostic_message_t::get_pid()
42 {
43         return (uint32_t)pid_;
44 }
45
46 const std::string& diagnostic_message_t::get_generic_name() const
47 {
48         return generic_name_;
49 }
50
51 const std::string diagnostic_message_t::get_name() const
52 {
53         return active_diagnostic_request_t::get_prefix() + "." + generic_name_;
54 }
55
56 float diagnostic_message_t::get_frequency() const
57 {
58         return frequency_;
59 }
60
61 DiagnosticResponseDecoder diagnostic_message_t::get_decoder() const
62 {
63         return decoder_;
64 }
65 DiagnosticResponseCallback diagnostic_message_t::get_callback() const
66 {
67         return callback_;
68 }
69
70 bool diagnostic_message_t::get_supported() const
71 {
72         return supported_;
73 }
74
75 void diagnostic_message_t::set_supported(bool value)
76 {
77         supported_ = value;
78 }
79
80 /**
81  * @brief Build a DiagnosticRequest struct to be passed
82  *  to diagnostic manager instance.
83  */
84 const DiagnosticRequest diagnostic_message_t::build_diagnostic_request()
85 {
86         return {/*arbitration_id: */OBD2_FUNCTIONAL_BROADCAST_ID,
87                         /*mode: */0x1,
88                         /*has_pid: */true,
89                         /*pid: */pid_,
90                         /*pid_length: */0,
91                         /*payload[]: */{0},
92                         /*payload_length: */0,
93                         /*no_frame_padding: */false,
94                         /*DiagnosticRequestType: */DiagnosticRequestType::DIAGNOSTIC_REQUEST_TYPE_PID };
95 }
96
97 /**
98 * @brief Check if a request is an OBD-II PID request.
99 *
100 * @return true if the request is a mode 1 request and it has a 1 byte PID.
101 */
102 bool diagnostic_message_t::is_obd2_request(const DiagnosticRequest* request)
103 {
104         return request->mode == 0x1 && request->has_pid && request->pid < 0xff;
105 }