Reordering class method.
[apps/low-level-can-service.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 "obd2-signals.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 obd2_signal_t::obd2_signal_t(uint8_t pid, const char* generic_name, const int min, const int max, enum UNIT unit, int frequency, bool supported)
37         :       pid_{pid}, generic_name_{generic_name}, min_{min}, max_{max}, unit_{unit}, frequency_{frequency}, supported_{supported}
38 {
39 }
40
41 uint32_t obd2_signal_t::get_pid()
42 {
43         return (uint32_t)pid_;
44 }
45
46 const std::string& obd2_signal_t::get_generic_name() const
47 {
48         return generic_name_;
49 }
50
51 const std::string obd2_signal_t::get_name() const
52 {
53         return prefix_ + "." + generic_name_;
54 }
55
56 const std::string& obd2_signal_t::get_prefix() const
57 {
58         return prefix_;
59 }
60
61 int obd2_signal_t::get_frequency() const
62 {
63         return frequency_;
64 }
65
66 void obd2_signal_t::set_prefix(std::string val)
67 {
68         prefix_ = val;
69 }
70
71 /**
72  * @brief Build a DiagnosticRequest struct to be passed
73  *  to diagnostic manager instance.
74  */
75 const DiagnosticRequest obd2_signal_t::build_diagnostic_request()
76 {
77         return {/*arbitration_id: */OBD2_FUNCTIONAL_BROADCAST_ID,
78                         /*mode: */0x1,
79                         /*has_pid: */true,
80                         /*pid: */pid_,
81                         /*pid_length: */0,
82                         /*payload[]: */{0},
83                         /*payload_length: */0,
84                         /*no_frame_padding: */false,
85                         /*DiagnosticRequestType: */DiagnosticRequestType::DIAGNOSTIC_REQUEST_TYPE_PID };
86 }
87
88 bool obd2_signal_t::is_obd2_response(can_message_t can_message)
89 {
90         /*
91         if(can_message.get_id() >= 0x7E8 && can_message.get_id() <= 0x7EF)
92         {
93                 openxc_VehicleMessage message = {0};
94                 message.has_type = true;
95                 message.type = openxc_VehicleMessage_Type_DIAGNOSTIC;
96                 message.has_diagnostic_response = true;
97                 message.diagnostic_response = {0};
98                 message.diagnostic_response.has_bus = true;
99                 message.diagnostic_response.bus = bus->address;
100                 message.diagnostic_response.has_message_id = true;
101                 //7DF should respond with a random message id between 7e8 and 7ef
102                 //7E0 through 7E7 should respond with a id that is 8 higher (7E0->7E8)
103                 if(can_message.get_id() == 0x7DF)
104                 {
105                         message.diagnostic_response.message_id = rand()%(0x7EF-0x7E8 + 1) + 0x7E8;
106                 }
107                 else if(commandRequest->message_id >= 0x7E0 && commandRequest->message_id <= 0x7E7)
108                 {
109                         message.diagnostic_response.message_id = commandRequest->message_id + 8;
110                 }
111                 message.diagnostic_response.has_mode = true;
112                 message.diagnostic_response.mode = commandRequest->mode;
113                 if(commandRequest->has_pid)
114                 {
115                         message.diagnostic_response.has_pid = true;
116                         message.diagnostic_response.pid = commandRequest->pid;
117                 }
118                 message.diagnostic_response.has_value = true;
119                 message.diagnostic_response.value = rand() % 100;
120                 pipeline::publish(&message, &getConfiguration()->pipeline);
121         }
122         else //If it's outside the range, the command_request will return false
123         {
124                 debug("Sent message ID is outside the valid range for emulator (7DF to 7E7)");
125                 status=false;
126         }
127         return false;
128         */
129         return false;
130 }       
131
132 /**
133 * @brief Check if a request is an OBD-II PID request.
134 *
135 * @return true if the request is a mode 1 request and it has a 1 byte PID.
136 */
137 bool obd2_signal_t::is_obd2_request(DiagnosticRequest* request)
138 {
139         return request->mode == 0x1 && request->has_pid && request->pid < 0xff;
140 }
141
142 /**
143 * @brief Check if requested signal name is an obd2 pid
144
145 * @return true if name began with obd2 else false.
146 */
147 bool obd2_signal_t::is_obd2_signal(const char *name)
148 {
149         if(fnmatch("obd2.*", name, FNM_CASEFOLD) == 0)
150                 return true;
151         return false;
152 }
153
154 /**
155 * @brief Decode the payload of an OBD-II PID.
156 *
157 * This function matches the type signature for a DiagnosticResponseDecoder, so
158 * it can be used as the decoder for a DiagnosticRequest. It returns the decoded
159 * value of the PID, using the standard formulas (see
160 * http://en.wikipedia.org/wiki/OBD-II_PIDs#Mode_01).
161 *
162 * @param[in] response - the received DiagnosticResponse (the data is in response.payload,
163 *  a byte array). This is most often used when the byte order is
164 *  signiticant, i.e. with many OBD-II PID formulas.
165 * @param[in] parsed_payload - the entire payload of the response parsed as an int.
166 */
167 float obd2_signal_t::decode_obd2_response(const DiagnosticResponse* response, float parsedPayload)
168 {
169         return diagnostic_decode_obd2_pid(response);
170 }