Change subscription/unsubcription logic
authorRomain Forlot <romain.forlot@iot.bzh>
Tue, 31 Jan 2017 18:01:11 +0000 (18:01 +0000)
committerRomain Forlot <romain.forlot@iot.bzh>
Tue, 31 Jan 2017 18:01:11 +0000 (18:01 +0000)
Add max, min and units to OBD2_PIDS and add some PIDS

Change-Id: I14b9c3dc8775674c47ea3e16c5cf2ba109a0bbef
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
ll-can-binding.c
obd2.h [new file with mode: 0644]
obdII.h [deleted file]

index adf878b..8f96d7b 100644 (file)
@@ -39,6 +39,7 @@
 #include <afb/afb-service-itf.h>
 
 #include "ll-can-binding.h"
+#include "obd2.h"
 
 /*************************************************************************/
 /*************************************************************************/
@@ -545,75 +546,87 @@ static int get_type_for_req(struct afb_req req, enum type *type)
        return 0;
 }
 
-/*
- * subscribe to notification of new CAN messages
- *
- * parameters of the subscription are:
- *
- *    TODO type: string:  choose between CAN and OBDII messages formats.
- *
- * returns an object with 2 fields:
- *
- *    name:   string:  the name of the event without its prefix
- *    id:     integer: a numeric identifier of the event to be used for unsubscribing
- */
-static void subscribe(struct afb_req req)
+static int subscribe_unsubscribe_sig(struct afb_req request, int subscribe, struct signal *sig)
 {
-       enum type type;
-       event *event;
-       uint32_t id;
-       struct json_object *json;
-
-       if (get_type_for_req(req, &type))
-       {
-               id = (uint32_t)atoi(afb_req_value(req, "id"));
-               event = get_event(id, type);
-               if (event == NULL)
-                       afb_req_fail(req, "out-of-memory", NULL);
-               else if (afb_req_subscribe(req, event->afb_event) != 0)
-                       afb_req_fail_f(req, "failed", "afb_req_subscribe returned an error: %m");
-               else
-               {
-                       /* TODO : build json openXC message to send. I guess */
-                       json = json_object_new_object();
-                       json_object_object_add(json, "name", json_object_new_string(event->name));
-                       afb_req_success(req, json, NULL);
+       if (!afb_event_is_valid(sig->event)) {
+               if (!subscribe)
+                       return 1;
+               sig->event = afb_daemon_make_event(afbitf->daemon, sig->name);
+               if (!afb_event_is_valid(sig->event)) {
+                       return 0;
                }
        }
+
+       if (((subscribe ? afb_req_subscribe : afb_req_unsubscribe)(request, sig->event)) < 0) {
+               return 0;
+       }
+
+       return 1;
 }
 
-/*
- * unsubscribe a previous subscription
- *
- * parameters of the unsubscription are:
- *
- *    id:   integer: the numeric identifier of the event as returned when subscribing
- */
-static void unsubscribe(struct afb_req req)
+static int subscribe_unsubscribe_all(struct afb_req request, int subscribe)
 {
-       const char *id;
-       can_event *events_list;
-       event *event;
+       int i, n, e;
 
-       id = afb_req_value(req, "id");
-       if (id == NULL)
-               afb_req_fail(req, "missing-id", NULL);
-       else
-       {
-               events_list = get_event_list_of_id((uint32_t)atoi(id));
-               event = events_list->events;
-               while(event)
-               {
-                       if (event == NULL)
-                               afb_req_fail(req, "bad-id", NULL);
-                       else
-                       {
-                               afb_req_unsubscribe(req, event->afb_event);
-                               afb_req_success(req, NULL, NULL);
-                       }
-                       event = event->next;
+       n = sizeof OBD2_PIDS / sizeof * OBD2_PIDS;
+       e = 0;
+       for (i = 0 ; i < n ; i++)
+               e += !subscribe_unsubscribe_sig(request, subscribe, &OBD2_PIDS[i]);
+       return e == 0;
+}
+
+static int subscribe_unsubscribe_name(struct afb_req request, int subscribe, const char *name)
+{
+       struct signal *sig;
+
+       if (0 == strcmp(name, "*"))
+               return subscribe_unsubscribe_all(request, subscribe);
+
+       sig = getsig(name);
+       if (sig == NULL) {
+               return 0;
+       }
+
+       return subscribe_unsubscribe_sig(request, subscribe, sig);
+}
+
+static void subscribe_unsubscribe(struct afb_req request, int subscribe)
+{
+       int ok, i, n;
+       struct json_object *args, *a, *x;
+
+       /* makes the subscription/unsubscription */
+       args = afb_req_json(request);
+       if (args == NULL || !json_object_object_get_ex(args, "event", &a)) {
+               ok = subscribe_unsubscribe_all(request, subscribe);
+       } else if (json_object_get_type(a) != json_type_array) {
+               ok = subscribe_unsubscribe_name(request, subscribe, json_object_get_string(a));
+       } else {
+               n = json_object_array_length(a);
+               ok = 0;
+               for (i = 0 ; i < n ; i++) {
+                       x = json_object_array_get_idx(a, i);
+                       if (subscribe_unsubscribe_name(request, subscribe, json_object_get_string(x)))
+                               ok++;
                }
+               ok = (ok == n);
        }
+
+       /* send the report */
+       if (ok)
+               afb_req_success(request, NULL, NULL);
+       else
+               afb_req_fail(request, "error", NULL);
+}
+
+static void subscribe(struct afb_req request)
+{
+       subscribe_unsubscribe(request, 1);
+}
+
+static void unsubscribe(struct afb_req request)
+{
+       subscribe_unsubscribe(request, 0);
 }
 
 static const struct afb_verb_desc_v1 verbs[]=
diff --git a/obd2.h b/obd2.h
new file mode 100644 (file)
index 0000000..940e5de
--- /dev/null
+++ b/obd2.h
@@ -0,0 +1,106 @@
+/*
+ * Copyright (C) 2015, 2016 "IoT.bzh"
+ * Author "Romain Forlot" <romain.forlot@iot.bzh>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/*
+ *  A representation of an OBD-II PID.
+ *
+ * pid - The 1 byte PID.
+ * name - A human readable name to use for this PID when published.
+ * frequency - The frequency to request this PID if supported by the vehicle
+ *      when automatic, recurring OBD-II requests are enabled.
+ */
+
+enum UNIT {
+       POURCENT,
+       DEGREES_CELSIUS,
+       KPA,
+       RPM,
+       GRAMS_SEC,
+       SECONDS,
+       KM,
+       KM_H,
+       PA,
+       NM
+};
+
+const char *UNIT_NAMES[10] = {
+       "POURCENT",
+       "DEGREES_CELSIUS",
+       "KPA",
+       "RPM",
+       "GRAMS_SEC",
+       "SECONDS",
+       "KM",
+       "KM_H",
+       "PA",
+       "NM"
+};
+
+typedef struct _Obd2Pid {
+    uint8_t pid;
+    const char* name;
+    const int min;
+    const int max;
+    enum UNIT unit;
+    int frequency;
+} Obd2Pid;
+
+/*
+ * Pre-defined OBD-II PIDs to query for if supported by the vehicle.
+ */
+const Obd2Pid OBD2_PIDS[] = {
+    { pid: 0x4, name: "engine.load", min:0, max: 100, unit: POURCENT, frequency: 5 },
+    { pid: 0x5, name: "engine.coolant.temperature", min: -40, max: 215, unit: DEGREES_CELSIUS, frequency: 1 },
+    { pid: 0xa, name: "fuel.pressure", min: 0, max: 765, unit: KPA, frequency: 1 },
+    { pid: 0xb, name: "intake.manifold.pressure", min: 0, max: 255, unit: KPA, frequency: 1 },
+    { pid: 0xc, name: "engine.speed", min: 0, max: 16383, unit: RPM, frequency: 5 },
+    { pid: 0xd, name: "vehicle.speed", min: 0, max: 255, unit: KM_H, frequency: 5 },
+    { pid: 0xf, name: "intake.air.temperature", min: -40, max:215, unit: DEGREES_CELSIUS, frequency: 1 },
+    { pid: 0x10, name: "mass.airflow", min: 0, max: 655, unit: GRAMS_SEC, frequency: 5 },
+    { pid: 0x11, name: "throttle.position", min: 0, max: 100, unit: POURCENT, frequency: 5 },
+    { pid: 0x1f, name: "running.time", min: 0, max: 65535, unit: SECONDS, frequency: 1 },
+    { pid: 0x2d, name: "EGR.error", min: -100, max: 99, unit: POURCENT, frequency: 0 },
+    { pid: 0x2f, name: "fuel.level", min: 0, max: 100, unit: POURCENT, frequency: 1 },
+    { pid: 0x33, name: "barometric.pressure", min: 0, max: 255, unit: KPA, frequency: 1 },
+    { pid: 0x4c, name: "commanded.throttle.position", min: 0, max: 100, unit: POURCENT, frequency: 1 },
+    { pid: 0x52, name: "ethanol.fuel.percentage", min: 0, max: 100, unit: POURCENT, frequency: 1 },
+    { pid: 0x5a, name: "accelerator.pedal.position", min: 0, max: 100, unit: POURCENT, frequency: 5 },
+    { pid: 0x5b, name: "hybrid.battery-pack.remaining.life", min: 0, max: 100, unit: POURCENT, frequency: 5 },
+    { pid: 0x5c, name: "engine.oil.temperature",min: -40, max: 210, unit: DEGREES_CELSIUS, frequency: 1 },
+    { pid: 0x63, name: "engine.torque", min: 0, max: 65535, unit: NM, frequency: 1 },
+};
+
+/*
+    { pid: 0x4, name: "engine.load", frequency: 5 },
+    { pid: 0x5, name: "engine.coolant.temperature", frequency: 1 },
+    { pid: 0xa, name: "fuel.pressure", frequency: 1 },
+    { pid: 0xb, name: "intake.manifold.pressure", frequency: 1 },
+    { pid: 0xc, name: "engine.speed", frequency: 5 },
+    { pid: 0xd, name: "vehicle.speed", frequency: 5 },
+    { pid: 0xf, name: "intake.air.temperature", frequency: 1 },
+    { pid: 0x10, name: "mass.airflow", frequency: 5 },
+    { pid: 0x11, name: "throttle.position", frequency: 5 },
+    { pid: 0x1f, name: "running.time", frequency: 1 },
+    { pid: 0x27, name: "fuel.level", frequency: 1 },
+    { pid: 0x33, name: "barometric.pressure", frequency: 1 },
+    { pid: 0x4c, name: "commanded.throttle.position", frequency: 1 },
+    { pid: 0x52, name: "ethanol.fuel.percentage", frequency: 1 },
+    { pid: 0x5a, name: "accelerator.pedal.position", frequency: 5 },
+    { pid: 0x5c, name: "engine.oil.temperature", frequency: 1 },
+    { pid: 0x63, name: "engine.torque", frequency: 1 },
+};
+ */
diff --git a/obdII.h b/obdII.h
deleted file mode 100644 (file)
index 968ec80..0000000
--- a/obdII.h
+++ /dev/null
@@ -1,53 +0,0 @@
-/*
- * Copyright (C) 2015, 2016 "IoT.bzh"
- * Author "Romain Forlot" <romain.forlot@iot.bzh>
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/*
- *  A representation of an OBD-II PID.
- *
- * pid - The 1 byte PID.
- * name - A human readable name to use for this PID when published.
- * frequency - The frequency to request this PID if supported by the vehicle
- *      when automatic, recurring OBD-II requests are enabled.
- */
-typedef struct _Obd2Pid {
-    uint8_t pid;
-    const char* name;
-    float frequency;
-} Obd2Pid;
-
-/*
- * Pre-defined OBD-II PIDs to query for if supported by the vehicle.
- */
-const Obd2Pid OBD2_PIDS[] = {
-    { pid: 0xc, name: "engine_speed", frequency: 5 },
-    { pid: 0xd, name: "vehicle_speed", frequency: 5 },
-    { pid: 0x4, name: "engine_load", frequency: 5 },
-    { pid: 0x5, name: "engine_coolant_temperature", frequency: 1 },
-    { pid: 0x33, name: "barometric_pressure", frequency: 1 },
-    { pid: 0x4c, name: "commanded_throttle_position", frequency: 1 },
-    { pid: 0x27, name: "fuel_level", frequency: 1 },
-    { pid: 0xf, name: "intake_air_temperature", frequency: 1 },
-    { pid: 0xb, name: "intake_manifold_pressure", frequency: 1 },
-    { pid: 0x1f, name: "running_time", frequency: 1 },
-    { pid: 0x11, name: "throttle_position", frequency: 5 },
-    { pid: 0xa, name: "fuel_pressure", frequency: 1 },
-    { pid: 0x10, name: "mass_airflow", frequency: 5 },
-    { pid: 0x5a, name: "accelerator_pedal_position", frequency: 5 },
-    { pid: 0x52, name: "ethanol_fuel_percentage", frequency: 1 },
-    { pid: 0x5c, name: "engine_oil_temperature", frequency: 1 },
-    { pid: 0x63, name: "engine_torque", frequency: 1 },
-};