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