Sort and comment the code
[apps/agl-service-can-low-level.git] / src / can-signals.cpp
1 /*
2  * Copyright (C) 2015, 2016 "IoT.bzh"
3  * Author "Romain Forlot" <romain.forlot@iot.bzh>
4  *
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
8  *
9  *       http://www.apache.org/licenses/LICENSE-2.0
10  *
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.
16  */
17
18 #include "can-signals.hpp"
19
20 #include <fnmatch.h>
21
22 #include "signals.hpp"
23 #include "obd2-signals.hpp"
24 #include "can-decoder.hpp"
25 #include "low-can-binding.hpp"
26
27 std::vector<std::vector<CanMessageDefinition>> CAN_MESSAGES = {
28         {
29                 {0x620, CanMessageFormat::STANDARD, {10, 0, nullptr}, false, (uint8_t)NULL},
30                 {0x442, CanMessageFormat::STANDARD, {10, 0, nullptr}, false, (uint8_t)NULL},
31         },
32 };
33
34 /**
35  * @brief Dumb SIGNALS array. It is composed by CanMessageSet
36  * SIGNALS[MESSAGE_SET_ID][CanSignal]
37  */
38 std::vector<std::vector<CanSignal>> SIGNALS = {
39         {
40                 {&(CAN_MESSAGES[MESSAGE_SET_ID][0]), "can.driver_door.open", 2, 4, 1.000000, 0.000000, 0.000000, 0.000000, {10, 0, nullptr}, false, true, nullptr, 0, false, decoder_t::booleanDecoder, nullptr, false, 0.0},
41                 {&(CAN_MESSAGES[MESSAGE_SET_ID][1]), "can.driver_door.close", 0, 4, 1.000000, 0.000000, 0.000000, 0.000000, {10, 0, nullptr}, false, true, nullptr, 0, false, decoder_t::booleanDecoder, nullptr, false, 0.0}
42         },
43 };
44
45 /**
46  * @fn std::vector<CanSignal>& get_can_signals()
47  *
48  * @return A reference to a vector of signals
49  */
50 std::vector<CanSignal>& get_can_signals()
51 {
52         return SIGNALS[MESSAGE_SET_ID];
53 }
54
55 /**
56  * @fn size_t getSignalCount()
57  *
58  * @return the length of the array returned by get_can_signals().
59  */
60 size_t getSignalCount()
61 {
62         return SIGNALS[MESSAGE_SET_ID].size();
63 }
64
65 /**
66  * @brief Retrieve can arbitration id of a given CanSignal
67  *
68  * @param[in] CanSignal& - a const reference to a CanSignal
69  *
70  * @return uint32_t - unsigned integer representing the arbitration id.
71  */
72 uint32_t get_signal_id(const CanSignal& sig)
73 {
74         return sig.message->id;
75 }
76
77 /**
78  * @fn void find_can_signals(const openxc_DynamicField& key, std::vector<CanSignal*>& found_signals)
79  * @brief return signals name found searching through CAN_signals and OBD2 pid
80  * 
81  * @param[in] const openxc_DynamicField : can contain numeric or string value in order to search against 
82  *   can signals or obd2 signals name.
83  * @param[out] std::vector<CanSignal*>& found_signals : provided vector to fill with ponter to signals matched.
84  *
85  */
86 void find_can_signals(const openxc_DynamicField& key, std::vector<CanSignal*>& found_signals)
87 {
88         switch(key.type)
89         {
90                 case openxc_DynamicField_Type::openxc_DynamicField_Type_STRING:
91                         lookup_signals_by_name(key.string_value, get_can_signals(), found_signals);
92                         break;
93                 case openxc_DynamicField_Type::openxc_DynamicField_Type_NUM:
94                         lookup_signals_by_id(key.numeric_value, get_can_signals(), found_signals);
95                         break;
96                 default:
97                         ERROR(binder_interface, "find_signals: wrong openxc_DynamicField specified. Use openxc_DynamicField_Type_NUM or openxc_DynamicField_Type_STRING type only.");
98                         break;
99         }
100         DEBUG(binder_interface, "Found %d signal(s)", (int)found_signals.size());
101 }