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