9a8572c9d4a27b27dcb99e83b08ee30a73e2f32d
[apps/agl-service-can-low-level.git] / low-can-binding / can / signals.hpp
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 #pragma once
19
20 #include <map>
21 #include <mutex>
22 #include <vector>
23 #include <string>
24 #include <memory>
25
26 #include "openxc.pb.h"
27 #include "message-definition.hpp"
28 #include "../utils/timer.hpp"
29 #include "../diagnostic/diagnostic-message.hpp"
30
31 #define MESSAGE_SET_ID 0
32
33 class signal_t;
34 ///
35 /// @brief The type signature for a CAN signal decoder.
36 ///
37 /// A signal_decoder transforms a raw floating point CAN signal into a number,
38 /// string or boolean.
39 ///
40 /// @param[in] signal - The CAN signal that we are decoding.
41 /// @param[in] signalCount - The length of the signals array.
42 /// @param[in] value - The CAN signal parsed from the message as a raw floating point
43 ///     value.
44 /// @param[out] send - An output parameter. If decoding fails or CAN signal is
45 ///     not sending, this should be flipped to false.
46 ///
47 /// @return a decoded value in an openxc_DynamicField struct.
48 ///
49 typedef openxc_DynamicField (*signal_decoder)(signal_t& signal, float value, bool* send);
50
51 ///
52 /// @brief: The type signature for a CAN signal encoder.
53 ///
54 /// A signal_encoder transforms a number, string or boolean into a raw floating
55 /// point value that fits in the CAN signal.
56 ///
57 /// @param[in] signal - The CAN signal to encode.
58 /// @param[in] value - The dynamic field to encode.
59 /// @param[out] send - An output parameter. If the encoding failed or the CAN signal should
60 /// not be encoded for some other reason, this will be flipped to false.
61 ///
62 typedef uint64_t (*signal_encoder)(signal_t& signal,
63                  const openxc_DynamicField& field, bool* send);
64
65 class signal_t
66 {
67 private:
68         std::shared_ptr<message_definition_t> parent_; /*!< parent_ - pointer to the parent message definition holding this signal*/
69         std::string generic_name_; /*!< generic_name_ - The name of the signal to be output.*/
70         static std::string prefix_; /*!< prefix_ - generic_name_ will be prefixed with it. It has to reflect the used protocol.
71                                          * which make easier to sort message when the come in.*/
72         uint8_t bit_position_; /*!< bitPosition_ - The starting bit of the signal in its CAN message (assuming
73                                 *       non-inverted bit numbering, i.e. the most significant bit of
74                                 *       each byte is 0) */
75         uint8_t bit_size_; /*!< bit_size_ - The width of the bit field in the CAN message. */
76         float factor_; /*!< factor_ - The final value will be multiplied by this factor. Use 1 if you
77                         *       don't need a factor. */
78         float offset_; /*!< offset_ - The final value will be added to this offset. Use 0 if you
79                         *       don't need an offset. */
80         float min_value_; /*!< min_value_ - The minimum value for the processed signal.*/
81         float max_value_; /*!< max_value_ - The maximum value for the processed signal. */
82         frequency_clock_t frequency_; /*!< frequency_ - A frequency_clock_t struct to control the maximum frequency to
83                                            * process and send this signal. To process every value, set the
84                                            * clock's frequency to 0. */
85         bool send_same_; /*!< send_same_ - If true, will re-send even if the value hasn't changed.*/
86         bool force_send_changed_; /*!< force_send_changed_ - If true, regardless of the frequency, it will send the
87                                    * value if it has changed. */
88         std::map<uint8_t, std::string> states_; /*!< states_ - A map of CAN signal state describing the mapping
89                                                  * between numerical and string values for valid states. */
90         bool writable_; /*!< writable - True if the signal is allowed to be written from the USB host
91                          * back to CAN. Defaults to false.*/
92         signal_decoder decoder_; /*!< decoder_ - An optional function to decode a signal from the bus to a human
93                                   * readable value. If NULL, the default numerical decoder is used. */
94         signal_encoder encoder_; /*!< encoder_ - An optional function to encode a signal value to be written to
95                                   * CAN into a byte array. If NULL, the default numerical encoder
96                                   * is used. */
97         bool received_; /*!< received_ - True if this signal has ever been received.*/
98         float last_value_; /*!< lastValue_ - The last received value of the signal. If 'received' is false,
99                                 * this value is undefined. */
100         std::pair<bool,int> multiplex_; /*!< multiplex_ - If bool is false and int is 0 is not a multiplex signal
101                                                                                 If bool is true, that indicate that is a multiplexor
102                                                                                 If int is different of 0, that indicate the link with a multiplexor */
103         bool is_big_endian_; /*!< is_big_endian - True if the signal's data are meant to be read as a big_endian */
104         bool is_signed_; /* !< is_signed_ - True if the data is signed */
105         std::string unit_; /* !< unit_ - The unit of the data */
106
107 public:
108
109         signal_t(
110                 std::string generic_name,
111                 uint8_t bit_position,
112                 uint8_t bit_size,
113                 float factor,
114                 float offset,
115                 float min_value,
116                 float max_value,
117                 frequency_clock_t frequency,
118                 bool send_same,
119                 bool force_send_changed,
120                 std::map<uint8_t, std::string> states,
121                 bool writable,
122                 signal_decoder decoder,
123                 signal_encoder encoder,
124                 bool received,
125                 std::pair<bool,int> multiplex,
126                 bool is_big_endian,
127                 bool is_signed,
128                 std::string unit);
129
130
131         signal_t(
132                 std::string generic_name,
133                 uint8_t bit_position,
134                 uint8_t bit_size,
135                 float factor,
136                 float offset,
137                 float min_value,
138                 float max_value,
139                 frequency_clock_t frequency,
140                 bool send_same,
141                 bool force_send_changed,
142                 std::map<uint8_t, std::string> states,
143                 bool writable,
144                 signal_decoder decoder,
145                 signal_encoder encoder,
146                 bool received);
147
148
149         std::shared_ptr<message_definition_t> get_message() const;
150         const std::string get_generic_name() const;
151         const std::string get_name() const;
152         uint8_t get_bit_position() const;
153         uint8_t get_bit_size() const;
154         float get_factor() const;
155         float get_offset() const;
156         frequency_clock_t& get_frequency();
157         bool get_send_same() const;
158         const std::string get_states(uint8_t value);
159         uint64_t get_states(const std::string& value) const;
160         bool get_writable() const;
161         signal_decoder& get_decoder();
162         signal_encoder& get_encoder();
163         bool get_received() const;
164         float get_last_value() const;
165         std::pair<float, uint64_t> get_last_value_with_timestamp() const;
166         std::pair<bool,int> get_multiplex() const;
167         bool get_is_big_endian() const;
168         bool get_is_signed() const;
169         const std::string get_unit() const;
170
171         void set_parent(std::shared_ptr<message_definition_t> parent);
172         void set_received(bool r);
173         void set_last_value(float val);
174         void set_timestamp(uint64_t timestamp);
175 };