src/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 <queue>
  21 #include <string>
  22 #include <vector>
  23 #include <fnmatch.h>
  24 #include <linux/can.h>
  25
  26 #include "can-utils.hpp"
  27
  28 extern "C"
  29 {
  30         #include <afb/afb-event-itf.h>
  31 }
  32
  33 #define MESSAGE_SET_ID 0
  34
  35 /**
  36  * @brief Dumb SIGNALS array. It is composed by CanMessageSet
  37  * SIGNALS[MESSAGE_SET_ID][CanSignal]
  38  */
  39 std::vector<std::vector<CanSignal>> SIGNALS {
  40         {}// message set: example
  41 };
  42
  43 /** Public: Return the currently active CAN configuration. */
  44 CanMessageSet* getActiveMessageSet();
  45
  46 /** Public: Retrive a list of all possible CAN configurations.
  47  *
  48  * Returns a pointer to an array of all configurations.
  49  */
  50 CanMessageSet* getMessageSets();
  51
  52 /** Public: Return the length of the array returned by getMessageSets() */
  53 int getMessageSetCount();
  54
  55 /* Public: Return the number of CAN buses configured in the active
  56  * configuration. This is limited to 2, as the hardware controller only has 2
  57  * CAN channels.
  58  */
  59 int getCanBusCount();
  60
  61 /* Public: Return an array of all CAN messages to be processed in the active
  62  * configuration.
  63  */
  64 CanMessageDefinition* getMessages();
  65
  66 /* Public: Return signals from an signals array filtered on name.
  67  */
  68 const std::vector<CanSignal> getSignals();
  69
  70 /* Public: Return an array of all OpenXC CAN commands enabled in the active
  71  * configuration that can write back to CAN with a custom handler.
  72  *
  73  * * Commands not defined here are handled using a 1-1 mapping from the signals
  74  * list.
  75  *              */
  76 CanCommand* getCommands();
  77
  78 /* Public: Return the length of the array returned by getCommandCount(). */
  79 int getCommandCount();
  80
  81 /* Public: Return the length of the array returned by getSignals(). */
  82 size_t getSignalCount();
  83
  84 /* Public: Return the length of the array returned by getMessages(). */
  85 int getMessageCount();
  86
  87 /**
  88  * @brief Return an array of the metadata for the 2 CAN buses you want to
  89  * monitor. The size of this array is fixed at 2.
  90  */
  91 CanBus* getCanBuses();
  92
  93 /**
  94  * @brief Find one or many signals based on its name or id
  95  * passed through openxc_DynamicField.
  96  *
  97  * params[openxc_DynamicField&] - a const reference with the key to search into signal.
  98  * Key is either a signal name or its CAN arbitration id.
  99  *
 100  * return[std::vector<std::string>] return found CanSignal generic name vector.
 101  */
 102 std::vector<CanSignal> find_can_signals(const struct afb_binding_interface* interface, const openxc_DynamicField &key);
 103
 104 uint32_t get_CanSignal_id(const CanSignal& sig)
 105 {
 106         return sig.message->id;
 107 }