src/obd2.h

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