Implement check of supported diagnostic PID.
[apps/agl-service-can-low-level.git] / src / diagnostic / diagnostic-message.hpp
index 062f7b5..ae37d7d 100644 (file)
 #include <vector>
 
 #include "uds/uds.h"
-#include "can/can-bus.hpp"
-#include "can/can-message.hpp"
+#include "../can/can-bus.hpp"
+#include "../can/can-message.hpp"
+#include "active-diagnostic-request.hpp"
 
-#include "low-can-binding.hpp"
+#include "../low-can-binding.hpp"
 
 enum UNIT {
        POURCENT,
@@ -40,55 +41,41 @@ enum UNIT {
 };
 
 /**
- *     @brief A representation of an OBD-II PID.
- *
- * pid - The 1 byte PID.
- * name - A human readable name to use for this PID when published.
- * min - minimum value for this pid
- * max - maximum value for this pid
- * unit - unit used
- * frequency - The frequency to request this PID if supported by the vehicle
- *             when automatic, recurring OBD-II requests are enabled.
- *     supported - is it supported by the vehicle. Initialized after scan
+ * @brief - A representation of an OBD-II PID.
  */
-typedef struct _Obd2Pid {
-       uint8_t pid;
-       const char* generic_name;
-       const int min;
-       const int max;
-       enum UNIT unit;
-       int frequency;
-       bool supported;
-} Obd2Pid;
-
-/**
- * @brief - Object to handle obd2 session with pre-scan of supported pid
- * then request them regularly
- */
-class obd2_signals_t {
+class diagnostic_message_t {
        private:
-               uint8_t pid_;
-               const char* generic_name_;
-               const int min_;
-               const int max_;
-               enum UNIT unit_;
-               int frequency_;
-               bool supported_;
+               uint8_t pid_; /*!< pid - The 1 byte PID.*/
+               std::string generic_name_; /*!< generic_name_ - A human readable name to use for this PID when published.*/
+               int min_; /*!< min_ - Minimum value that can take this pid */
+               int max_; /*!< max_ - Maximum value that can take this pid */
+               enum UNIT unit_; /*!< unit_ : Which unit system is used by that pid. See enum UNIT above.*/
+               float frequency_; /*!< frequency - The frequency to request this PID if supported by the vehicle when automatic, recurring OBD-II requests are enabled.*/
+               DiagnosticResponseDecoder decoder_; /*!< decoder_ - An optional DiagnosticResponseDecoder to parse the payload of responses
+                                                                                        * to this request. If the decoder is NULL, the output will include the raw payload
+                                                                                        * instead of a parsed value.*/
+               DiagnosticResponseCallback callback_; /*!< callback_ - An optional DiagnosticResponseCallback to be notified whenever a
+                                                                                          * response is received for this request.*/
+               
+               bool supported_; /*!< supported_ - boolean indicating whether this pid is supported by the vehicle or not.*/
 
        public:
-               const char* generic_name = generic_name_;
-               obd2_signals_t(uint8_t pid, const char* generic_name, const int min_, const int max_, enum UNIT unit, int frequency, bool supported);
+               const char* generic_name = generic_name_.c_str();
+               diagnostic_message_t(uint8_t pid, const std::string generic_name, const int min, const int max, enum UNIT unit, float frequency,
+                                                                                       DiagnosticResponseDecoder decoder, DiagnosticResponseCallback callback, bool supported);
 
-               void add_request(int pid);
+               uint32_t get_pid();
+               const std::string& get_generic_name() const;
+               const std::string get_name() const;
+               float get_frequency() const;
+               DiagnosticResponseDecoder get_decoder() const;
+               DiagnosticResponseCallback get_callback() const;
+               bool get_supported() const;
 
-               void find_obd2_signals(const openxc_DynamicField &key, std::vector<obd2_signals_t*>& found_signals);
+               void set_supported(bool value);
 
-               bool is_obd2_response(can_message_t can_message);
-               bool is_obd2_request(DiagnosticRequest *request);
-               bool is_obd2_signal(const char *name);
+               const DiagnosticRequest build_diagnostic_request();
 
-               float decode_obd2_response(const DiagnosticResponse* response, float parsedPayload);
+               bool is_obd2_response(const can_message_t& can_message);
+               bool is_obd2_request(const DiagnosticRequest *request);
 };
-
-uint32_t get_signal_id(const obd2_signals_t& sig);
-std::vector<obd2_signals_t>& get_obd2_signals();
\ No newline at end of file