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 "../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_) ? true : false;
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()
55 : bus_{nullptr}, id_{0}, handle_{nullptr}, name_{""},
56 decoder_{nullptr}, callback_{nullptr}, recurring_{false}, wait_for_multiple_responses_{false},
57 in_flight_{false}, frequency_clock_{frequency_clock_t()}, timeout_clock_{frequency_clock_t()}
60 active_diagnostic_request_t::active_diagnostic_request_t(const std::string& bus, DiagnosticRequest* request,
61 const std::string& name, bool wait_for_multiple_responses, const DiagnosticResponseDecoder decoder,
62 const DiagnosticResponseCallback callback, float frequencyHz)
63 : bus_{bus}, id_{request->arbitration_id}, handle_{nullptr}, name_{name},
64 decoder_{decoder}, callback_{callback}, recurring_{frequencyHz ? true : false}, wait_for_multiple_responses_{wait_for_multiple_responses},
65 in_flight_{false}, frequency_clock_{frequency_clock_t(frequencyHz)}, timeout_clock_{frequency_clock_t(10)}
68 uint32_t active_diagnostic_request_t::get_id() const
73 const std::shared_ptr<can_bus_dev_t> active_diagnostic_request_t::get_can_bus_dev() const
75 return can_bus_t::get_can_device(bus_);
78 uint16_t active_diagnostic_request_t::get_pid() const
80 if (handle_->request.has_pid)
81 return handle_->request.pid;
85 DiagnosticRequestHandle* active_diagnostic_request_t::get_handle()
90 const std::string active_diagnostic_request_t::get_name() const
92 return active_diagnostic_request_t::prefix_ + "." + name_;
95 std::string& active_diagnostic_request_t::get_prefix()
97 return active_diagnostic_request_t::prefix_;
100 DiagnosticResponseDecoder& active_diagnostic_request_t::get_decoder()
105 DiagnosticResponseCallback& active_diagnostic_request_t::get_callback()
110 bool active_diagnostic_request_t::get_recurring() const
115 bool active_diagnostic_request_t::get_in_flight() const
120 frequency_clock_t& active_diagnostic_request_t::get_frequency_clock()
122 return frequency_clock_;
125 frequency_clock_t& active_diagnostic_request_t::get_timeout_clock()
127 return timeout_clock_;
130 void active_diagnostic_request_t::set_handle(DiagnosticShims& shims, DiagnosticRequest* request)
132 handle_ = new DiagnosticRequestHandle(generate_diagnostic_request(&shims, request, nullptr));
135 void active_diagnostic_request_t::set_in_flight(bool val)
141 * @brief Check if requested signal name is an obd2 pid
143 * @return true if name began with obd2 else false.
145 bool active_diagnostic_request_t::is_diagnostic_signal(const std::string& name)
147 const std::string p = active_diagnostic_request_t::prefix_ + "*";
148 if(::fnmatch(p.c_str(), name.c_str(), FNM_CASEFOLD) == 0)
153 bool active_diagnostic_request_t::should_send()
155 return !get_in_flight() && (
156 (!get_recurring() && !request_completed()) ||
157 (get_recurring() && get_frequency_clock().elapsed(true)));
160 bool active_diagnostic_request_t::timed_out()
162 // don't use staggered start with the timeout clock
163 return timeout_clock_.elapsed(false);
166 /// @brief Returns true if a sufficient response has been received for a
167 /// diagnostic request.
169 /// This is true when at least one response has been received and the request is
170 /// configured to not wait for multiple responses. Functional broadcast requests
171 /// may often wish to wait the full 100ms for modules to respond.
172 bool active_diagnostic_request_t::response_received() const
174 return !wait_for_multiple_responses_ &&
178 /// @brief Returns true if the request has timed out waiting for a response,
179 /// or a sufficient number of responses has been received.
180 bool active_diagnostic_request_t::request_completed()
182 return response_received() ||
183 (timed_out() && diagnostic_request_sent(handle_));