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