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 typedef struct _Obd2Pid {
  54     uint8_t pid;
  55     const char* name;
  56     const int min;
  57     const int max;
  58     enum UNIT unit;
  59     int frequency;
  60 } Obd2Pid;
  61
  62 /*
  63     { pid: 0x4, name: "engine.load", frequency: 5 },
  64     { pid: 0x5, name: "engine.coolant.temperature", frequency: 1 },
  65     { pid: 0xa, name: "fuel.pressure", frequency: 1 },
  66     { pid: 0xb, name: "intake.manifold.pressure", frequency: 1 },
  67     { pid: 0xc, name: "engine.speed", frequency: 5 },
  68     { pid: 0xd, name: "vehicle.speed", frequency: 5 },
  69     { pid: 0xf, name: "intake.air.temperature", frequency: 1 },
  70     { pid: 0x10, name: "mass.airflow", frequency: 5 },
  71     { pid: 0x11, name: "throttle.position", frequency: 5 },
  72     { pid: 0x1f, name: "running.time", frequency: 1 },
  73     { pid: 0x27, name: "fuel.level", frequency: 1 },
  74     { pid: 0x33, name: "barometric.pressure", frequency: 1 },
  75     { pid: 0x4c, name: "commanded.throttle.position", frequency: 1 },
  76     { pid: 0x52, name: "ethanol.fuel.percentage", frequency: 1 },
  77     { pid: 0x5a, name: "accelerator.pedal.position", frequency: 5 },
  78     { pid: 0x5c, name: "engine.oil.temperature", frequency: 1 },
  79     { pid: 0x63, name: "engine.torque", frequency: 1 },
  80 };
  81  */
  82
  83 /* Public: Check if a request is an OBD-II PID request.
  84  *
  85  * Returns true if the request is a mode 1  request and it has a 1 byte PID.
  86  */
  87 bool isObd2Request(DiagnosticRequest* request);
  88
  89 /* Public: Decode the payload of an OBD-II PID.
  90  *
  91  * This function matches the type signature for a DiagnosticResponseDecoder, so
  92  * it can be used as the decoder for a DiagnosticRequest. It returns the decoded
  93  * value of the PID, using the standard formulas (see
  94  * http://en.wikipedia.org/wiki/OBD-II_PIDs#Mode_01).
  95  */
  96 float handleObd2Pid(const DiagnosticResponse* response, float parsedPayload);
  97
  98 /*
  99  * Object to handle obd2 session with pre-scan of supported pid
 100  * then request them regularly
 101  */
 102 class Obd2Handler_c {
 103     private:
 104         /*
 105         * Pre-defined OBD-II PIDs to query for if supported by the vehicle.
 106         */
 107         const Obd2Pid OBD2_PIDS[] = {
 108             { pid: 0x4, name: "obd2.engine.load", min:0, max: 100, unit: POURCENT, frequency: 5 },
 109             { pid: 0x5, name: "obd2.engine.coolant.temperature", min: -40, max: 215, unit: DEGREES_CELSIUS, frequency: 1 },
 110             { pid: 0xa, name: "obd2.fuel.pressure", min: 0, max: 765, unit: KPA, frequency: 1 },
 111             { pid: 0xb, name: "obd2.intake.manifold.pressure", min: 0, max: 255, unit: KPA, frequency: 1 },
 112             { pid: 0xc, name: "obd2.engine.speed", min: 0, max: 16383, unit: RPM, frequency: 5 },
 113             { pid: 0xd, name: "obd2.vehicle.speed", min: 0, max: 255, unit: KM_H, frequency: 5 },
 114             { pid: 0xf, name: "obd2.intake.air.temperature", min: -40, max:215, unit: DEGREES_CELSIUS, frequency: 1 },
 115             { pid: 0x10, name: "obd2.mass.airflow", min: 0, max: 655, unit: GRAMS_SEC, frequency: 5 },
 116             { pid: 0x11, name: "obd2.throttle.position", min: 0, max: 100, unit: POURCENT, frequency: 5 },
 117             { pid: 0x1f, name: "obd2.running.time", min: 0, max: 65535, unit: SECONDS, frequency: 1 },
 118             { pid: 0x2d, name: "obd2.EGR.error", min: -100, max: 99, unit: POURCENT, frequency: 0 },
 119             { pid: 0x2f, name: "obd2.fuel.level", min: 0, max: 100, unit: POURCENT, frequency: 1 },
 120             { pid: 0x33, name: "obd2.barometric.pressure", min: 0, max: 255, unit: KPA, frequency: 1 },
 121             { pid: 0x4c, name: "obd2.commanded.throttle.position", min: 0, max: 100, unit: POURCENT, frequency: 1 },
 122             { pid: 0x52, name: "obd2.ethanol.fuel.percentage", min: 0, max: 100, unit: POURCENT, frequency: 1 },
 123             { pid: 0x5a, name: "obd2.accelerator.pedal.position", min: 0, max: 100, unit: POURCENT, frequency: 5 },
 124             { pid: 0x5b, name: "obd2.hybrid.battery-pack.remaining.life", min: 0, max: 100, unit: POURCENT, frequency: 5 },
 125             { pid: 0x5c, name: "obd2.engine.oil.temperature",min: -40, max: 210, unit: DEGREES_CELSIUS, frequency: 1 },
 126             { pid: 0x63, name: "obd2.engine.torque", min: 0, max: 65535, unit: NM, frequency: 1 },
 127         };
 128
 129         /*
 130          * Will be populated with constructor
 131          */
 132         Obd2Pid supported_pids[];
 133
 134         public:
 135             Obd2Handler_c();
 136
 137             bool isObd2Request(request);
 138 }