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