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