src/obd2.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 #include "uds/uds.h"
  22 #include "can-bus.hpp"
  23
  24 extern "C"
  25 {
  26         #include <afb/afb-binding.h>
  27 }
  28
  29 enum UNIT {
  30         POURCENT,
  31         DEGREES_CELSIUS,
  32         KPA,
  33         RPM,
  34         GRAMS_SEC,
  35         SECONDS,
  36         KM,
  37         KM_H,
  38         PA,
  39         NM
  40 };
  41
  42 const char *UNIT_NAMES[10] = {
  43         "POURCENT",
  44         "DEGREES_CELSIUS",
  45         "KPA",
  46         "RPM",
  47         "GRAMS_SEC",
  48         "SECONDS",
  49         "KM",
  50         "KM_H",
  51         "PA",
  52         "NM"
  53 };
  54
  55 /**
  56  *      @brief A representation of an OBD-II PID.
  57  *
  58  * pid - The 1 byte PID.
  59  * name - A human readable name to use for this PID when published.
  60  * min - minimum value for this pid
  61  * max - maximum value for this pid
  62  * unit - unit used
  63  * frequency - The frequency to request this PID if supported by the vehicle
  64  *              when automatic, recurring OBD-II requests are enabled.
  65  *      supported - is it supported by the vehicle. Initialized after scan
  66  * event - application framework event handler.
  67  */
  68 typedef struct _Obd2Pid {
  69         uint8_t pid;
  70         const char* name;
  71         const int min;
  72         const int max;
  73         enum UNIT unit;
  74         int frequency;
  75         bool supported;
  76         struct afb_event event;
  77 } Obd2Pid;
  78
  79 /*
  80 * Pre-defined OBD-II PIDs to query for if supported by the vehicle.
  81 */
  82 const std::vector<Obd2Pid> OBD2_PIDS {
  83         { pid: 0x04, name: "obd2.engine.load", min:0, max: 100, unit: POURCENT, frequency: 5, supported: false, event: {nullptr, nullptr} },
  84         { pid: 0x05, name: "obd2.engine.coolant.temperature", min: -40, max: 215, unit: DEGREES_CELSIUS, frequency: 1, supported: false, event: {nullptr, nullptr} },
  85         { pid: 0x0a, name: "obd2.fuel.pressure", min: 0, max: 765, unit: KPA, frequency: 1, supported: false, event: {nullptr, nullptr} },
  86         { pid: 0x0b, name: "obd2.intake.manifold.pressure", min: 0, max: 255, unit: KPA, frequency: 1, supported: false, event: {nullptr, nullptr} },
  87         { pid: 0x0c, name: "obd2.engine.speed", min: 0, max: 16383, unit: RPM, frequency: 5, supported: false, event: {nullptr, nullptr} },
  88         { pid: 0x0d, name: "obd2.vehicle.speed", min: 0, max: 255, unit: KM_H, frequency: 5, supported: false, event: {nullptr, nullptr} },
  89         { pid: 0x0f, name: "obd2.intake.air.temperature", min: -40, max:215, unit: DEGREES_CELSIUS, frequency: 1, supported: false, event: {nullptr, nullptr} },
  90         { pid: 0x10, name: "obd2.mass.airflow", min: 0, max: 655, unit: GRAMS_SEC, frequency: 5, supported: false, event: {nullptr, nullptr} },
  91         { pid: 0x11, name: "obd2.throttle.position", min: 0, max: 100, unit: POURCENT, frequency: 5, supported: false, event: {nullptr, nullptr} },
  92         { pid: 0x1f, name: "obd2.running.time", min: 0, max: 65535, unit: SECONDS, frequency: 1, supported: false, event: {nullptr, nullptr} },
  93         { pid: 0x2d, name: "obd2.EGR.error", min: -100, max: 99, unit: POURCENT, frequency: 0, supported: false, event: {nullptr, nullptr} },
  94         { pid: 0x2f, name: "obd2.fuel.level", min: 0, max: 100, unit: POURCENT, frequency: 1, supported: false, event: {nullptr, nullptr} },
  95         { pid: 0x33, name: "obd2.barometric.pressure", min: 0, max: 255, unit: KPA, frequency: 1, supported: false, event: {nullptr, nullptr} },
  96         { pid: 0x4c, name: "obd2.commanded.throttle.position", min: 0, max: 100, unit: POURCENT, frequency: 1, supported: false, event: {nullptr, nullptr} },
  97         { pid: 0x52, name: "obd2.ethanol.fuel.percentage", min: 0, max: 100, unit: POURCENT, frequency: 1, supported: false, event: {nullptr, nullptr} },
  98         { pid: 0x5a, name: "obd2.accelerator.pedal.position", min: 0, max: 100, unit: POURCENT, frequency: 5, supported: false, event: {nullptr, nullptr} },
  99         { pid: 0x5b, name: "obd2.hybrid.battery-pack.remaining.life", min: 0, max: 100, unit: POURCENT, frequency: 5, supported: false, event: {nullptr, nullptr} },
 100         { pid: 0x5c, name: "obd2.engine.oil.temperature",min: -40, max: 210, unit: DEGREES_CELSIUS, frequency: 1, supported: false, event: {nullptr, nullptr} },
 101         { pid: 0x63, name: "obd2.engine.torque", min: 0, max: 65535, unit: NM, frequency: 1, supported: false, event: {nullptr, nullptr} }
 102 };
 103
 104 /**
 105  * @brief - Object to handle obd2 session with pre-scan of supported pid
 106  * then request them regularly
 107  */
 108 class obd2_handler_t {
 109         private:
 110
 111         public:
 112                 /**
 113                  * @brief:
 114                  *
 115                  * Returns
 116                  */
 117                 void find_obd2_pid(const char *name, std::vector<Obd2Pid> *pids);
 118
 119                 /**
 120                  * @brief Check if a request is an OBD-II PID request.
 121                  *
 122                  * @return true if the request is a mode 1  request and it has a 1 byte PID.
 123                  */
 124                 bool is_obd2_request(DiagnosticRequest *request);
 125
 126                 /**
 127                 * @brief Check if requested signal name is an obd2 pid
 128                 *
 129                 * @return true if name began with ob2.* else false.
 130                 */
 131                 bool is_obd2_signal(const char *name);
 132
 133                 /**
 134                 * @brief Decode the payload of an OBD-II PID.
 135                 *
 136                 * This function matches the type signature for a DiagnosticResponseDecoder, so
 137                 * it can be used as the decoder for a DiagnosticRequest. It returns the decoded
 138                 * value of the PID, using the standard formulas (see
 139                 * http://en.wikipedia.org/wiki/OBD-II_PIDs#Mode_01).
 140                 *
 141                 * @param[in] DiagnosticResponse response - the received DiagnosticResponse (the data is in response.payload,
 142                 *      a byte array). This is most often used when the byte order is
 143                 *      signiticant, i.e. with many OBD-II PID formulas.
 144                 * @param[in] float parsed_payload - the entire payload of the response parsed as an int.
 145                 */
 146                 float handle_obd2_pid(const DiagnosticResponse* response, float parsedPayload);
 147 };