Make error goes back to the subscribed clients when unsupported.
[apps/agl-service-can-low-level.git] / src / configuration.hpp
index 2fd59e5..57eeef3 100644 (file)
  * limitations under the License.
  */
 
+#pragma once
+
+#include <map>
 #include <vector>
+#include <string>
+#include <fcntl.h>
 
 #include "can/can-bus.hpp"
 #include "can/can-signals.hpp"
-#include "obd2/diagnostic-manager.hpp"
-
-/**
- * @brief Class representing a configuration attached to the binding.
- *
- * @desc It regroups all needed objects instance from other class
- *  that will be used along the binding life. It gets a global vision 
- *  on which signals are implemented for that binding. 
- *  Here, it is only the definition of the class with predefined accessors
- *  methods used in the binding.
- *
- *  It will be the reference point to needed objects.
- */
+#include "can/can-message.hpp"
+#include "diagnostic/diagnostic-manager.hpp"
 
 #include "low-can-binding.hpp"
 
+///
+/// @brief Class representing a configuration attached to the binding.
+///
+/// It regroups all needed objects instance from other class
+///  that will be used along the binding life. It gets a global vision 
+///  on which signals are implemented for that binding. 
+///  Here, it is only the definition of the class with predefined accessors
+///  methods used in the binding.
+///
+///  It will be the reference point to needed objects.
+///
 class configuration_t
 {
        private:
-               can_bus_t can_bus_manager_(afb_daemon_rootdir_open_locale(binder_interface->daemon, "can_buses.json", O_RDONLY, NULL));
-               diagnostic_manager_t diagnostic_manager_;
-               uint8_t active_message_set_ = 0;
+               can_bus_t can_bus_manager_ = can_bus_t(
+                       afb_daemon_rootdir_open_locale(
+                               binder_interface->daemon, "etc/can_buses.json", O_RDONLY, NULL)); ///< instanciate the CAN bus
+                               ///< This will read the configuration file and initialize all CAN devices specified in it.
+               diagnostic_manager_t diagnostic_manager_; ///< Diagnostic manager use to manage diagnostic message communication.
+               uint8_t active_message_set_ = 0; ///< Which is the active message set ? Default to 0.
+
+               std::vector<can_message_set_t> can_message_set_;
+               std::vector<std::vector<can_message_definition_t>> can_message_definition_;
+               std::vector<std::vector<can_signal_t>> can_signals_;
+               std::vector<std::vector<diagnostic_message_t>> diagnostic_messages_;
+
+               configuration_t(); ///< Private constructor with implementation generated by the AGL generator.
 
        public:
-               const std::vector<obd2_signals_t> obd2_signals_;
-               const std::vector<can_message_set_t> can_message_set_;
-               const std::vector<std::vector<can_signal_t>> can_signals_;
-               const std::vector<std::vector<can_message_definition_t>> can_message_definition_;
-
-               configuration_t& get_configuration()
-               { 
-                       return this;
-               }
-
-               can_bus_t& get_can_bus_manager()
-               {
-                       return can_bus_manager_;
-               }
-               
-               diagnostic_manager_t& get_diagnostic_manager()
-               {
-                       return diagnostic_manager_;
-               }
-
-               uint8_t get_active_message_set()
-               {
-                       return active_message_set_;
-               }
-
-               std::vector<can_message_set>& get_can_message_set()
-               {
-                       return can_message_set_;
-               }
-
-               std::vector<can_signal>& get_can_signals()
-               {
-                       return can_signal_[active_message_set_];
-               }
-
-               std::vector<CanSignal>& get_can_signals()
-               {
-                       return SIGNALS[active_message_set_];
-               }
-
-               std::vector<can_message_definition>& get_can_message_definition()
-               {
-                       return can_message_definition_[active_message_set_];
-               }
-
-               std::vector<obd2_signals_t>& get_obd2_signals()
-               {
-                       return obd2_signals_;
-               }
-
-               std::vector<obd2_signals_t>& get_obd2_signals()
-               {
-                       return OBD2_PIDS;
-               }
-
-               uint32_t get_signal_id(obd2_signals_t& sig)
-               {
-                       return sig.get_pid();
-               }
-
-               uint32_t get_signal_id(const CanSignal& sig)
-               {
-                       return sig.message->id;
-               }
-
-               void set_active_message_set(uint8_t id)
-               {
-                       active_message_set_ = id;
-               }
-};
\ No newline at end of file
+               static configuration_t& instance();
+
+               can_bus_t& get_can_bus_manager();
+
+               const std::map<std::string, std::shared_ptr<can_bus_dev_t>>& get_can_bus_devices();
+
+               const std::string get_diagnostic_bus() const;
+
+               diagnostic_manager_t& get_diagnostic_manager() ;
+
+               uint8_t get_active_message_set() const;
+
+               const std::vector<can_message_set_t>& get_can_message_set();
+
+               std::vector<can_signal_t>& get_can_signals();
+
+               std::vector<diagnostic_message_t>& get_diagnostic_messages();
+
+               const std::vector<std::string>& get_signals_prefix() const;
+
+               const std::vector<can_message_definition_t>& get_can_message_definition();
+               const can_message_definition_t& get_can_message_definition(std::uint8_t message_set_id, std::uint8_t message_id);
+
+               uint32_t get_signal_id(diagnostic_message_t& sig) const;
+
+               uint32_t get_signal_id(can_signal_t& sig) const;
+
+               void set_active_message_set(uint8_t id);
+
+               void find_diagnostic_messages(const openxc_DynamicField &key, std::vector<diagnostic_message_t*>& found_signals);
+
+               void find_can_signals(const openxc_DynamicField &key, std::vector<can_signal_t*>& found_signals);
+
+/*
+               /// TODO: implement this function as method into can_bus class
+               /// @brief Pre initialize actions made before CAN bus initialization
+               /// @param[in] bus A CanBus struct defining the bus's metadata
+               /// @param[in] writable Configure the controller in a writable mode. If false, it will be configured as "listen only" and will not allow writes or even CAN ACKs.
+               /// @param[in] buses An array of all CAN buses.
+               void pre_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
+               /// TODO: implement this function as method into can_bus class
+               /// @brief Post-initialize actions made after CAN bus initialization
+               /// @param[in] bus A CanBus struct defining the bus's metadata
+               /// @param[in] writable Configure the controller in a writable mode. If false, it will be configured as "listen only" and will not allow writes or even CAN ACKs.
+               /// @param[in] buses An array of all CAN buses.
+               void post_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
+               /// TODO: implement this function as method into can_bus class
+               /// @brief Check if the device is connected to an active CAN bus, i.e. it's received a message in the recent past.
+               /// @return true if a message was received on the CAN bus within CAN_ACTIVE_TIMEOUT_S seconds.
+               void logBusStatistics(can_bus_dev_t* buses, const int busCount);
+               /// TODO: implement this function as method into can_bus class
+               /// @brief Log transfer statistics about all active CAN buses to the debug log.
+               /// @param[in] buses An array of active CAN buses.
+               bool isBusActive(can_bus_dev_t* bus);
+               */
+};
+