CAN-binder/low-can-binding/binding/low-can-cb.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 #include <string>
  19 #include "../utils/socketcan-bcm.hpp"
  20
  21 struct event_filter_t
  22 {
  23         float frequency;
  24         float min;
  25         float max;
  26 };
  27
  28 class low_can_subscription_t
  29 {
  30 private:
  31         int index_;
  32
  33         /// Signal part
  34         std::string sig_name_;
  35         std::string bus_name_;
  36         uint32_t can_id_;
  37         uint8_t bit_position_; /*!< bitPosition_ - The starting bit of the signal in its CAN message (assuming
  38                                                                         *       non-inverted bit numbering, i.e. the most significant bit of
  39                                                                         *       each byte is 0) */
  40         uint8_t bit_size_; /*!< bit_size_ - The width of the bit field in the CAN message. */
  41         float factor_; /*!< factor_ - The final value will be multiplied by this factor. Use 1 if you
  42                                                         *       don't need a factor. */
  43         float offset_; /*!< offset_ - The final value will be added to this offset. Use 0 if you
  44                                                         *       don't need an offset. */
  45
  46         /// Filtering part
  47         struct event_filter_t event_filter_ = {-1.0, -1.0, -1.0};
  48
  49         utils::socketcan_bcm_t socket_;
  50 public:
  51         low_can_subscription_t();
  52         low_can_subscription_t(struct event_filter_t event_filter);
  53         low_can_subscription_t(const low_can_subscription_t& s) = delete;
  54         low_can_subscription_t(low_can_subscription_t&& s);
  55
  56         low_can_subscription_t& operator=(const low_can_subscription_t& s);
  57         explicit operator bool() const;
  58
  59         int get_index() const;
  60         const std::string get_sig_name() const;
  61         float get_frequency() const;
  62         float get_min() const;
  63         float get_max() const;
  64         utils::socketcan_bcm_t& get_socket();
  65
  66         void set_frequency(float freq);
  67         void set_min(float min);
  68         void set_max(float max);
  69
  70         int create_rx_filter();
  71         int create_rx_filter(const std::string& bus_name, const std::string& sig_name, uint32_t can_id, uint8_t bit_position, uint8_t bit_size, float factor, float offset);
  72 };