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.
21 #include "active-diagnostic-request.hpp"
23 #include "../binding/configuration.hpp"
25 #define ERROR_PID 0xFF
27 std::string active_diagnostic_request_t::prefix_ = "diagnostic_messages";
29 bool active_diagnostic_request_t::operator==(const active_diagnostic_request_t& b)
31 return (bus_ == b.bus_ && id_ == b.id_ && handle_ == b.handle_);
34 active_diagnostic_request_t& active_diagnostic_request_t::operator=(const active_diagnostic_request_t& adr)
40 handle_ = adr.handle_;
42 decoder_ = adr.decoder_;
43 callback_ = adr.callback_;
44 recurring_ = adr.recurring_;
45 wait_for_multiple_responses_ = adr.wait_for_multiple_responses_;
46 in_flight_ = adr.in_flight_;
47 frequency_clock_ = adr.frequency_clock_;
48 timeout_clock_ = adr.timeout_clock_;
54 active_diagnostic_request_t::active_diagnostic_request_t()
62 wait_for_multiple_responses_{false},
64 frequency_clock_{frequency_clock_t()},
65 timeout_clock_{frequency_clock_t()}
68 active_diagnostic_request_t::active_diagnostic_request_t(const std::string& bus, DiagnosticRequest* request,
69 const std::string& name,
70 bool wait_for_multiple_responses,
71 const DiagnosticResponseDecoder decoder,
72 const DiagnosticResponseCallback callback,
75 id_{request->arbitration_id},
80 recurring_{frequencyHz ? true : false},
81 wait_for_multiple_responses_{wait_for_multiple_responses},
83 frequency_clock_{frequency_clock_t(frequencyHz)},
84 timeout_clock_{frequency_clock_t(10)}
87 uint32_t active_diagnostic_request_t::get_id() const
92 const std::shared_ptr<can_bus_dev_t> active_diagnostic_request_t::get_can_bus_dev() const
94 return can_bus_t::get_can_device(bus_);
97 uint16_t active_diagnostic_request_t::get_pid() const
99 if (handle_->request.has_pid)
100 return handle_->request.pid;
104 DiagnosticRequestHandle* active_diagnostic_request_t::get_handle()
109 const std::string active_diagnostic_request_t::get_name() const
114 std::string& active_diagnostic_request_t::get_prefix()
116 return active_diagnostic_request_t::prefix_;
119 DiagnosticResponseDecoder& active_diagnostic_request_t::get_decoder()
124 DiagnosticResponseCallback& active_diagnostic_request_t::get_callback()
129 bool active_diagnostic_request_t::get_recurring() const
134 bool active_diagnostic_request_t::get_in_flight() const
139 frequency_clock_t& active_diagnostic_request_t::get_frequency_clock()
141 return frequency_clock_;
144 frequency_clock_t& active_diagnostic_request_t::get_timeout_clock()
146 return timeout_clock_;
149 utils::socketcan_bcm_t& active_diagnostic_request_t::get_socket()
154 void active_diagnostic_request_t::set_handle(DiagnosticShims& shims, DiagnosticRequest* request)
156 handle_ = new DiagnosticRequestHandle(generate_diagnostic_request(&shims, request, nullptr));
159 void active_diagnostic_request_t::set_in_flight(bool val)
165 /// @brief Check if requested signal name is a diagnostic message. If the name
166 /// begin with the diagnostic message prefix then true else false.
168 /// @param[in] name - A signal name.
170 /// @return true if name began with the diagnostic message prefix else false.
172 bool active_diagnostic_request_t::is_diagnostic_signal(const std::string& name)
174 const std::string p = active_diagnostic_request_t::prefix_ + "*";
175 if(::fnmatch(p.c_str(), name.c_str(), FNM_CASEFOLD) == 0)
180 /// @brief Check is the request should be sent or not
182 /// @return true if the request is not running or recurring nor completed,
183 /// or it's recurring, its clock elapsed
184 /// so it's time to send another one.
185 bool active_diagnostic_request_t::should_send()
187 return !in_flight_ && ( (!recurring_ && !request_completed()) ||
188 (recurring_ && frequency_clock_.elapsed(true)) );
191 /// @brief check if the timeout clock has elapsed
193 /// @return true if elapsed, so it is a timeout, else false.
194 bool active_diagnostic_request_t::timed_out()
196 // don't use staggered start with the timeout clock
197 return timeout_clock_.elapsed(false);
200 /// @brief Returns true if a sufficient response has been received for a
201 /// diagnostic request.
203 /// This is true when at least one response has been received and the request is
204 /// configured to not wait for multiple responses. Functional broadcast requests
205 /// may often wish to wait the full 100ms for modules to respond.
206 bool active_diagnostic_request_t::response_received() const
208 return !wait_for_multiple_responses_ &&
212 /// @brief Returns true if the request has timed out waiting for a response,
213 /// or a sufficient number of responses has been received.
214 bool active_diagnostic_request_t::request_completed()
216 return response_received() ||
217 (timed_out() && diagnostic_request_sent(handle_));