Some cleaning and comments

Change-Id: Iad73e3a34c5638e012819506b56741f62cfa3e30
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>

diff --git a/src/can-utils.hpp b/src/can-utils.hpp
index 58a9873..20267ae 100644 (file)
--- a/src/can-utils.hpp
+++ b/src/can-utils.hpp
@@ -283,32 +283,6 @@ struct CanMessageDefinition {
 };
 typedef struct CanMessageDefinition CanMessageDefinition;
 
-/* Private: An entry in the list of acceptance filters for each CanBus.
- *
- * This struct is meant to be used with a LIST type from <sys/queue.h>.
- *
- * filter - the value for the CAN acceptance filter.
- * activeUserCount - The number of active consumers of this filter's messages.
- *             When 0, this filter can be removed.
- * format - the format of the ID for the filter.
-struct AcceptanceFilterListEntry {
-       uint32_t filter;
-       uint8_t activeUserCount;
-       CanMessageFormat format;
-       LIST_ENTRY(AcceptanceFilterListEntry) entries;
-};
- */
-
-/* Private: A type of list containing CAN acceptance filters.
-LIST_HEAD(AcceptanceFilterList, AcceptanceFilterListEntry);
-
-struct CanMessageDefinitionListEntry {
-       CanMessageDefinition definition;
-       LIST_ENTRY(CanMessageDefinitionListEntry) entries;
-};
-LIST_HEAD(CanMessageDefinitionList, CanMessageDefinitionListEntry);
- */
-
 /**
  * @brief A parent wrapper for a particular set of CAN messages and associated
  *     CAN buses(e.g. a vehicle or program).
@@ -377,7 +351,7 @@ typedef struct {
  * @param[in] buses - An array of all CAN buses.
  * @param[in] int busCount - The length of the buses array.
  */
-void pre_initialize(can_bus_dev_t* bus, bool writable, CanBus* buses, const int busCount);
+void pre_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
 
 /* Post-initialize actions made after CAN bus initialization and before the
  * event loop connection.
@@ -388,7 +362,7 @@ void pre_initialize(can_bus_dev_t* bus, bool writable, CanBus* buses, const int
  * buses - An array of all CAN buses.
  * busCount - The length of the buses array.
  */
-void post_initialize(can_bus_dev_t* bus, bool writable, CanBus* buses, const int busCount);
+void post_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
 
 /* Public: Check if the device is connected to an active CAN bus, i.e. it's
  * received a message in the recent past.
@@ -403,4 +377,4 @@ bool isBusActive(can_bus_dev_t* bus);
  * buses - an array of active CAN buses.
  * busCount - the length of the buses array.
  */
-void logBusStatistics(CanBus* buses, const int busCount);
+void logBusStatistics(can_bus_dev_t* buses, const int busCount);

diff --git a/src/obd2.hpp b/src/obd2.hpp
index bdccad6..42ba9fa 100644 (file)
--- a/src/obd2.hpp
+++ b/src/obd2.hpp
@@ -48,8 +48,8 @@ const char *UNIT_NAMES[10] = {
        "NM"
 };
 
-/*
- *     A representation of an OBD-II PID.
+/**
+ *     @brief A representation of an OBD-II PID.
  *
  * pid - The 1 byte PID.
  * name - A human readable name to use for this PID when published.
@@ -73,8 +73,8 @@ typedef struct _Obd2Pid {
 } Obd2Pid;
 
 /*
-       * Pre-defined OBD-II PIDs to query for if supported by the vehicle.
-       */
+* Pre-defined OBD-II PIDs to query for if supported by the vehicle.
+*/
 const std::vector<Obd2Pid> OBD2_PIDS {
        { pid: 0x04, name: "obd2.engine.load", min:0, max: 100, unit: POURCENT, frequency: 5, supported: false, event: {nullptr, nullptr} },
        { pid: 0x05, name: "obd2.engine.coolant.temperature", min: -40, max: 215, unit: DEGREES_CELSIUS, frequency: 1, supported: false, event: {nullptr, nullptr} },
@@ -97,21 +97,6 @@ const std::vector<Obd2Pid> OBD2_PIDS {
        { pid: 0x63, name: "obd2.engine.torque", min: 0, max: 65535, unit: NM, frequency: 1, supported: false, event: {nullptr, nullptr} }
 };
 
-/* Public: Check if a request is an OBD-II PID request.
- *
- * Returns true if the request is a mode 1     request and it has a 1 byte PID.
- */
-bool isObd2Request(DiagnosticRequest* request);
-
-/* Public: Decode the payload of an OBD-II PID.
- *
- * This function matches the type signature for a DiagnosticResponseDecoder, so
- * it can be used as the decoder for a DiagnosticRequest. It returns the decoded
- * value of the PID, using the standard formulas (see
- * http://en.wikipedia.org/wiki/OBD-II_PIDs#Mode_01).
- */
-float handleObd2Pid(const DiagnosticResponse* response, float parsedPayload);
-
 /**
  * @brief - Object to handle obd2 session with pre-scan of supported pid
  * then request them regularly
@@ -141,11 +126,18 @@ class obd2_handler_t {
                */
                bool is_obd2_signal(const char *name);
 
-               /*
-               * @brief pass response to UDS-C library function 
-               * diagnostic_decode_obd2_pid()
+               /**
+               * @brief Decode the payload of an OBD-II PID.
+               *
+               * This function matches the type signature for a DiagnosticResponseDecoder, so
+               * it can be used as the decoder for a DiagnosticRequest. It returns the decoded
+               * value of the PID, using the standard formulas (see
+               * http://en.wikipedia.org/wiki/OBD-II_PIDs#Mode_01).
                *
-               * @return float number representing the requested value.
+               * @param[in] DiagnosticResponse response - the received DiagnosticResponse (the data is in response.payload,
+               *      a byte array). This is most often used when the byte order is
+               *      signiticant, i.e. with many OBD-II PID formulas.
+               * @param[in] float parsed_payload - the entire payload of the response parsed as an int.
                */
-               bool decode_obd2_response(DiagnosticResponse* responce);
+               float handle_obd2_pid(const DiagnosticResponse* response, float parsedPayload);
 };
\ No newline at end of file

diff --git a/src/openxc-utils.cpp b/src/openxc-utils.cpp
index b53a5eb..bdc772e 100644 (file)
--- a/src/openxc-utils.cpp
+++ b/src/openxc-utils.cpp
@@ -16,8 +16,7 @@
  * limitations under the License.
  */
 
-openxc_VehicleMessage build_VehicleMessage_with_SimpleMessage(openxc_DynamicField_Type type,
-       const openxc_SimpleMessage& message)
+openxc_VehicleMessage build_VehicleMessage_with_SimpleMessage(openxc_DynamicField_Type type, const openxc_SimpleMessage& message)
 {
        struct timeb t_msec;
        long long int timestamp_msec;

diff --git a/src/openxc-utils.hpp b/src/openxc-utils.hpp
index b2b5c7f..295e99c 100644 (file)
--- a/src/openxc-utils.hpp
+++ b/src/openxc-utils.hpp
@@ -22,6 +22,12 @@
 
 /**
  * @brief Build a specific VehicleMessage containing a SimpleMessage.
+ *
+ * @param[in] openxc_DynamicField_Type type - The type of message to build
+ * @param[in] openxc_SimpleMessage& message - simple message to include into openxc_VehicleMessage
+ *
+ * @return openxc_VehicleMessage - a vehicle message including simple message that will be convert into 
+ * a JSON object before being pushed to the subscribers
  */
 openxc_VehicleMessage build_VehicleMessage_with_SimpleMessage(openxc_DynamicField_Type type, const openxc_SimpleMessage& message);