src/diagnostic/active-diagnostic-request.hpp

   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 #pragma once
  19
  20 #include <vector>
  21
  22 #include "uds/uds.h"
  23 #include "uds/uds_types.h"
  24 #include "can/can-bus.hpp"
  25 #include "can/can-message.hpp"
  26
  27 #include "low-can-binding.hpp"
  28
  29 class active_diagnostic_request_t;
  30 class can_bus_dev_t;
  31
  32 /* Public: The signature for an optional function that can apply the neccessary
  33  * formula to translate the binary payload into meaningful data.
  34  *
  35  * response - the received DiagnosticResponse (the data is in response.payload,
  36  *      a byte array). This is most often used when the byte order is
  37  *      signiticant, i.e. with many OBD-II PID formulas.
  38  * parsed_payload - the entire payload of the response parsed as an int.
  39  */
  40 typedef float (*DiagnosticResponseDecoder)(const DiagnosticResponse* response,
  41                 float parsed_payload);
  42
  43 /* Public: The signature for an optional function to handle a new diagnostic
  44  * response.
  45  *
  46  * manager - The DiagnosticsManager providing this response.
  47  * request - The original diagnostic request.
  48  * response - The response object that was just received.
  49  * parsed_payload - The payload of the response, parsed as a float.
  50  */
  51 typedef void (*DiagnosticResponseCallback)(const active_diagnostic_request_t* request,
  52                 const DiagnosticResponse* response, float parsed_payload);
  53
  54 /**
  55  * @brief An active diagnostic request, either recurring or one-time.
  56  */
  57 class active_diagnostic_request_t {
  58         private:
  59                 can_bus_dev_t* bus_; /*!< can_bus_dev_t* bus_ - The CAN bus this request should be made on, or is currently in flight-on*/
  60                 uint32_t id_; /*!< The arbitration ID (aka message ID) for the request.*/
  61                 DiagnosticRequestHandle* handle_; /*!< DiagnosticRequestHandle* handle - A handle for the request to keep track of it between
  62                                                                                    * sending the frames of the request and receiving all frames of the response.*/
  63                 std::string name_; /*!< std::string name_ - An optional human readable name this response, to be used when publishing received
  64                                                         * responses. If the name is NULL, the published output will use the raw OBD-II response format.*/
  65                 DiagnosticResponseDecoder decoder_; /*!< decoder - An optional DiagnosticResponseDecoder to parse the payload of responses
  66                                                                                          * to this request. If the decoder is NULL, the output will include the raw payload
  67                                                                                          * instead of a parsed value.*/
  68                 DiagnosticResponseCallback callback_; /*!< callback - An optional DiagnosticResponseCallback to be notified whenever a
  69                                                                                            * response is received for this request.*/
  70                 bool recurring_; /*!< bool recurring_ - If true, this is a recurring request and it will remain as active until explicitly cancelled.
  71                                                   * The frequencyClock attribute controls how often a recurrin request is made.*/
  72                 bool waitForMultipleResponses_; /*!< bool waitForMultipleResponses_ - False by default, when any response is received for a request
  73                                                                                  * it will be removed from the active list. If true, the request will remain active until the timeout
  74                                                                                  * clock expires, to allow it to receive multiple response (e.g. to a functional broadcast request).*/
  75                 bool inFlight_; /*!< inFlight - True if the request has been sent and we are waiting for a response.*/
  76                 FrequencyClock frequencyClock_; /*!< FrequencyClock frequencyClock_ - A FrequencyClock struct to control the send rate for a
  77                                                                                  * recurring request. If the request is not reecurring, this attribute is not used.*/
  78                 FrequencyClock timeoutClock_; /*!< FrequencyClock timeoutClock_ - A FrequencyClock struct to monitor how long it's been since
  79                                                                            * this request was sent.*/
  80         public:
  81 };