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-message-set.hpp"
27 #include "../can/can-signals.hpp"
28 #include "../diagnostic/diagnostic-manager.hpp"
31 /// @brief Class represents a configuration attached to the binding.
33 /// It regroups all object instances from other classes
34 /// that will be used through the binding life. It receives a global vision
35 /// on which signals are implemented for that binding.
36 /// Here, only the definition of the class is given 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_; ///< instanciate the CAN bus manager. It's responsible of initializing the CAN bus devices.
45 diagnostic_manager_t diagnostic_manager_; ///< Diagnostic manager use to manage diagnostic message communication.
46 uint8_t active_message_set_ = 0; ///< Which is the active message set ? Default to 0.
48 std::vector<std::shared_ptr<can_message_set_t> > can_message_set_; ///< Vector holding all message set from JSON signals description file
50 std::map<std::string, std::shared_ptr<low_can_subscription_t> > can_devices_; ///< Map containing all independant opened CAN sockets, key is the socket int value.
52 application_t(); ///< Private constructor with implementation generated by the AGL generator.
55 static application_t& instance();
57 can_bus_t& get_can_bus_manager();
59 std::map<std::string, std::shared_ptr<low_can_subscription_t> >& get_can_devices();
61 const std::string get_diagnostic_bus() const;
63 diagnostic_manager_t& get_diagnostic_manager() ;
65 uint8_t get_active_message_set() const;
67 std::vector<std::shared_ptr<can_message_set_t> > get_can_message_set();
69 std::vector<std::shared_ptr<can_signal_t> > get_all_can_signals();
71 std::vector<std::shared_ptr<diagnostic_message_t> >& get_diagnostic_messages();
73 const std::vector<std::string>& get_signals_prefix() const;
75 std::vector<std::shared_ptr<can_message_definition_t> >& get_can_message_definition();
77 uint32_t get_signal_id(diagnostic_message_t& sig) const;
79 uint32_t get_signal_id(can_signal_t& sig) const;
83 void set_active_message_set(uint8_t id);
86 /// TODO: implement this function as method into can_bus class
87 /// @brief Pre initialize actions made before 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 void pre_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
92 /// TODO: implement this function as method into can_bus class
93 /// @brief Post-initialize actions made after CAN bus initialization
94 /// @param[in] bus A CanBus struct defining the bus's metadata
95 /// @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.
96 /// @param[in] buses An array of all CAN buses.
97 void post_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
98 /// TODO: implement this function as method into can_bus class
99 /// @brief Check if the device is connected to an active CAN bus, i.e. it's received a message in the recent past.
100 /// @return true if a message was received on the CAN bus within CAN_ACTIVE_TIMEOUT_S seconds.
101 bool isBusActive(can_bus_dev_t* bus);