Changed the decoding function
[apps/agl-service-can-low-level.git] / src / can-signals.hpp
index f34c743..fb77df5 100644 (file)
 
 #pragma once
 
-#include "can-utils.h"
+#include <map>
+#include <queue>
+#include <vector>
 #include <string>
+#include <thread>
+#include <linux/can.h>
+#include <mutex>
+#include <condition_variable>
+
+#include "timer.hpp"
+#include "openxc.pb.h"
+#include "can-utils.hpp"
+
+extern "C"
+{
+       #include <afb/afb-binding.h>
+       #include <afb/afb-event-itf.h>
+}
+
+#define MESSAGE_SET_ID 0
+
+/** 
+ * @brief Can signal event map making access to afb_event
+ * externaly to an openxc existing structure.
+ *
+ * @desc Event map is making relation between CanSignal generic name
+ * and the afb_event struct used by application framework to pushed
+ * to the subscriber.
+ */
+static std::map<std::string, struct afb_event> subscribed_signals;
+
+/**
+* @brief Mutex allowing safe manipulation on subscribed_signals map.
+* @desc To ensure that the map object isn't modified when we read it, you
+*  have to set this mutex before use subscribed_signals map object.
+*/
+extern std::mutex subscribed_signals_mutex;
 
 /** Public: Return the currently active CAN configuration. */
 CanMessageSet* getActiveMessageSet();
 
 /** Public: Retrive a list of all possible CAN configurations.
- *     *
- *      * Returns a pointer to an array of all configurations.
- *       */
+ *
+ * Returns a pointer to an array of all configurations.
+ */
 CanMessageSet* getMessageSets();
 
 /** Public: Return the length of the array returned by getMessageSets() */
 int getMessageSetCount();
 
 /* Public: Return the number of CAN buses configured in the active
- *     * configuration. This is limited to 2, as the hardware controller only has 2
- *      * CAN channels.
- *       */
+ * configuration. This is limited to 2, as the hardware controller only has 2
+ * CAN channels.
+ */
 int getCanBusCount();
 
 /* Public: Return an array of all CAN messages to be processed in the active
- *     * configuration.
- *      */
+ * configuration.
+ */
 CanMessageDefinition* getMessages();
 
 /* Public: Return signals from an signals array filtered on name.
  */
-CanSignal* getSignals(std::string name);
+const std::vector<CanSignal> getSignals();
 
 /* Public: Return an array of all OpenXC CAN commands enabled in the active
- *     * configuration that can write back to CAN with a custom handler.
- *      *
- *       * Commands not defined here are handled using a 1-1 mapping from the signals
- *        * list.
+ * configuration that can write back to CAN with a custom handler.
+ *
+ * * Commands not defined here are handled using a 1-1 mapping from the signals
+ * list.
  *             */
 CanCommand* getCommands();
 
@@ -59,26 +94,40 @@ CanCommand* getCommands();
 int getCommandCount();
 
 /* Public: Return the length of the array returned by getSignals(). */
-int getSignalCount();
+size_t getSignalCount();
 
 /* Public: Return the length of the array returned by getMessages(). */
 int getMessageCount();
 
-/* Public: Return an array of the metadata for the 2 CAN buses you want to
- *     * monitor. The size of this array is fixed at 2.
- *      */
+/**
+ * @brief Return an array of the metadata for the 2 CAN buses you want to
+ * monitor. The size of this array is fixed at 2.
+ */
 CanBus* getCanBuses();
 
-/* Public: Decode CAN signals from raw CAN messages, translate from engineering
- *     * units to something more human readable, and send the resulting value over USB
- *      * as an OpenXC-style JSON message.
- *       *
- *        * This is the main workhorse function of the VI. Every time a new
- *             * CAN message is received that matches one of the signals in the list returend
- *              * by getSignals(), this function is called with the message ID and 64-bit data
- *               * field.
- *                *
- *                     * bus - The CAN bus this message was received on.
- *                      * message - The received CAN message.
- *                       */
-void decodeCanMessage(openxc::pipeline::Pipeline* pipeline, CanBus* bus, CanMessage* message);
+/**
+ * @brief Find one or many signals based on its name or id
+ * passed through openxc_DynamicField.
+ *
+ * @param[in] openxc_DynamicField& - a const reference with the key to search into signal.
+ * Key is either a signal name or its CAN arbitration id.
+ *
+ * @return std::vector<std::string> return found CanSignal generic name vector.
+ */
+std::vector<CanSignal> find_can_signals(const openxc_DynamicField &key);
+
+/**
+ * @brief Retrieve can arbitration id of a given CanSignal
+ *
+ * @param[in] CanSignal& - a const reference to a CanSignal
+ *
+ * @return uint32_t - unsigned integer representing the arbitration id.
+ */
+inline uint32_t get_CanSignal_id(const CanSignal& sig);
+
+/**
+ * @brief return the subscribed_signals map.
+ * 
+ * return std::map<std::string, struct afb_event> - map of subscribed signals.
+ */
+const std::map<std::string, struct afb_event> get_subscribed_signals();
\ No newline at end of file