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.
23 #include "can/can-bus.hpp"
24 #include "can/can-signals.hpp"
25 #include "can/can-message.hpp"
26 #include "obd2/diagnostic-manager.hpp"
28 #include "low-can-binding.hpp"
31 * @brief Class representing a configuration attached to the binding.
33 * @desc It regroups all needed objects instance from other class
34 * that will be used along the binding life. It gets a global vision
35 * on which signals are implemented for that binding.
36 * Here, it is only the definition of the class with predefined accessors
37 * methods used in the binding.
39 * It will be the reference point to needed objects.
44 can_bus_t can_bus_manager_ = can_bus_t(afb_daemon_rootdir_open_locale(binder_interface->daemon, "can_buses.json", O_RDONLY, NULL));
45 diagnostic_manager_t diagnostic_manager_;
46 uint8_t active_message_set_ = 0;
51 const std::vector<obd2_signal_t> obd2_signals_;
52 const std::vector<can_message_set_t> can_message_set_;
53 const std::vector<std::vector<can_signal_t>> can_signals_;
54 const std::vector<std::vector<can_message_definition_t>> can_message_definition_;
56 configuration_t& get_configuration() const;
58 can_bus_t& get_can_bus_manager();
60 diagnostic_manager_t& get_diagnostic_manager() const;
62 uint8_t get_active_message_set() const;
64 const std::vector<can_message_set_t>& get_can_message_set() const;
66 const std::vector<can_signal_t>& get_can_signals() const;
68 const std::vector<can_message_definition_t>& get_can_message_definition() const;
70 const std::vector<obd2_signal_t>& get_obd2_signals() const;
72 uint32_t get_signal_id(obd2_signal_t& sig) const;
74 uint32_t get_signal_id(can_signal_t& sig) const;
76 void set_active_message_set(uint8_t id);
79 /// TODO: implement this function as method into can_bus class
80 /// @brief Pre initialize actions made before CAN bus initialization
81 /// @param[in] bus A CanBus struct defining the bus's metadata
82 /// @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.
83 /// @param[in] buses An array of all CAN buses.
84 /// @param[in] busCount The length of the buses array.
85 void pre_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
86 /// TODO: implement this function as method into can_bus class
87 /// @brief Post-initialize actions made after CAN bus initialization
88 /// @param[in] bus A CanBus struct defining the bus's metadata
89 /// @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.
90 /// @param[in] buses An array of all CAN buses.
91 /// @param[in] busCount The length of the buses array.
92 void post_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
93 /// TODO: implement this function as method into can_bus class
94 /// @brief Check if the device is connected to an active CAN bus, i.e. it's received a message in the recent past.
95 /// @return true if a message was received on the CAN bus within CAN_ACTIVE_TIMEOUT_S seconds.
96 void logBusStatistics(can_bus_dev_t* buses, const int busCount);
97 /// TODO: implement this function as method into can_bus class
98 /// @brief Log transfer statistics about all active CAN buses to the debug log.
99 /// @param[in] buses An array of active CAN buses.
100 /// @param[in] busCount The length of the buses array.
101 bool isBusActive(can_bus_dev_t* bus);
105 // Make a global variable pointer
106 extern configuration_t *config;