2 * Copyright (C) 2015, 2016 "IoT.bzh"
3 * Author "Romain Forlot" <romain.forlot@iot.bzh>
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
25 #include "can/can-bus.hpp"
26 #include "can/can-signals.hpp"
27 #include "can/can-message.hpp"
28 #include "diagnostic/diagnostic-manager.hpp"
30 #include "low-can-binding.hpp"
33 * @brief Class representing a configuration attached to the binding.
35 * @desc It regroups all needed objects instance from other class
36 * that will be used along the binding life. It gets a global vision
37 * on which signals are implemented for that binding.
38 * Here, it is only the definition of the class with predefined accessors
39 * methods used in the binding.
41 * It will be the reference point to needed objects.
46 can_bus_t can_bus_manager_ = can_bus_t(
47 afb_daemon_rootdir_open_locale(
48 binder_interface->daemon, "etc/can_buses.json", O_RDONLY, NULL)); ///< instanciate the CAN bus
49 ///< This will read the configuration file and initialize all CAN devices specified in it.
50 diagnostic_manager_t diagnostic_manager_; ///< Diagnostic manager use to manage diagnostic message communication.
51 uint8_t active_message_set_ = 0; ///< Which is the active message set ? Default to 0.
53 std::vector<can_message_set_t> can_message_set_;
54 std::vector<std::vector<can_message_definition_t>> can_message_definition_;
55 std::vector<std::vector<can_signal_t>> can_signals_;
56 std::vector<std::vector<diagnostic_message_t>> diagnostic_messages_;
58 configuration_t(); ///< Private constructor with implementation generated by the AGL generator.
61 static configuration_t& instance();
63 can_bus_t& get_can_bus_manager();
65 const std::map<std::string, std::shared_ptr<can_bus_dev_t>>& get_can_bus_devices();
67 const std::string get_diagnostic_bus() const;
69 diagnostic_manager_t& get_diagnostic_manager() ;
71 uint8_t get_active_message_set() const;
73 const std::vector<can_message_set_t>& get_can_message_set();
75 std::vector<can_signal_t>& get_can_signals();
77 std::vector<diagnostic_message_t>& get_diagnostic_messages();
79 const std::vector<std::string>& get_signals_prefix() const;
81 const std::vector<can_message_definition_t>& get_can_message_definition();
82 const can_message_definition_t& get_can_message_definition(std::uint8_t message_set_id, std::uint8_t message_id);
84 uint32_t get_signal_id(diagnostic_message_t& sig) const;
86 uint32_t get_signal_id(can_signal_t& sig) const;
88 void set_active_message_set(uint8_t id);
90 void find_diagnostic_messages(const openxc_DynamicField &key, std::vector<diagnostic_message_t*>& found_signals);
92 void find_can_signals(const openxc_DynamicField &key, std::vector<can_signal_t*>& found_signals);
95 /// TODO: implement this function as method into can_bus class
96 /// @brief Pre initialize actions made before CAN bus initialization
97 /// @param[in] bus A CanBus struct defining the bus's metadata
98 /// @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.
99 /// @param[in] buses An array of all CAN buses.
100 void pre_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
101 /// TODO: implement this function as method into can_bus class
102 /// @brief Post-initialize actions made after CAN bus initialization
103 /// @param[in] bus A CanBus struct defining the bus's metadata
104 /// @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.
105 /// @param[in] buses An array of all CAN buses.
106 void post_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
107 /// TODO: implement this function as method into can_bus class
108 /// @brief Check if the device is connected to an active CAN bus, i.e. it's received a message in the recent past.
109 /// @return true if a message was received on the CAN bus within CAN_ACTIVE_TIMEOUT_S seconds.
110 void logBusStatistics(can_bus_dev_t* buses, const int busCount);
111 /// TODO: implement this function as method into can_bus class
112 /// @brief Log transfer statistics about all active CAN buses to the debug log.
113 /// @param[in] buses An array of active CAN buses.
114 bool isBusActive(can_bus_dev_t* bus);