summaryrefslogtreecommitdiffstats
path: root/src/can/can-signals.hpp
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2017-03-08 09:44:53 +0100
committerRomain Forlot <romain.forlot@iot.bzh>2017-03-16 17:10:39 +0100
commitc01da10d067038794eb845735e2a7959744ca2b3 (patch)
treecbaa9ff7fa7338c96ebd5d2f0766872df5963283 /src/can/can-signals.hpp
parent9519e9d5b875b45fbf6f32267b728b1d11377276 (diff)
Added a warning that it is an example code
Change-Id: Ib66e49960a348896020fba56f7d98910623af83f Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'src/can/can-signals.hpp')
-rw-r--r--src/can/can-signals.hpp39
1 files changed, 39 insertions, 0 deletions
diff --git a/src/can/can-signals.hpp b/src/can/can-signals.hpp
index 17b189c6..99f62c74 100644
--- a/src/can/can-signals.hpp
+++ b/src/can/can-signals.hpp
@@ -122,4 +122,43 @@ struct CanSignal {
};
typedef struct CanSignal CanSignal;
+class can_signal_t
+{
+ private:
+ struct CanMessageDefinition* message_; /*!< message - The message this signal is a part of. */
+ const std::string generic_name_; /*!< generic_name - The name of the signal to be output over USB.*/
+ uint8_t bitPosition_; /*!< bitPosition - The starting bit of the signal in its CAN message (assuming
+ * non-inverted bit numbering, i.e. the most significant bit of
+ * each byte is 0) */
+ uint8_t bitSize_; /*!< bitSize - The width of the bit field in the CAN message. */
+ float factor_; /*!< factor - The final value will be multiplied by this factor. Use 1 if you
+ * don't need a factor. */
+ float offset_; /*!< offset - The final value will be added to this offset. Use 0 if you
+ * don't need an offset. */
+ float min_value_; /*!< minValue - The minimum value for the processed signal.*/
+ float max_value_; /*!< maxValue - The maximum value for the processed signal. */
+ FrequencyClock clock_; /*!< clock_ - A FrequencyClock struct to control the maximum frequency to
+ * process and send this signal. To process every value, set the
+ * clock's frequency to 0. */
+ bool sendSame_; /*!< sendSame - If true, will re-send even if the value hasn't changed.*/
+ bool forceSendChanged_; /*!< forceSendChanged - If true, regardless of the frequency, it will send the
+ * value if it has changed. */
+ const std::map<const int, const std::string> states_; /*!< states_ - A map of CAN signal state describing the mapping
+ * between numerical and string values for valid states. */
+ uint8_t state_count_; /*!< state_count_ - The length of the states array. */
+ bool writable_; /*!< writable - True if the signal is allowed to be written from the USB host
+ * back to CAN. Defaults to false.*/
+ SignalDecoder decoder_; /*!< decoder_ - An optional function to decode a signal from the bus to a human
+ * readable value. If NULL, the default numerical decoder is used. */
+ SignalEncoder encoder_; /*!< encoder_ - An optional function to encode a signal value to be written to
+ * CAN into a byte array. If NULL, the default numerical encoder
+ * is used. */
+ bool received_; /*!< received_ - True if this signal has ever been received.*/
+ float lastValue_; /*!< lastValue_ - The last received value of the signal. If 'received' is false,
+ * this value is undefined. */
+
+ public:
+
+};
+
void find_can_signals(const openxc_DynamicField &key, std::vector<CanSignal*>& found_signals);