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 "can-utils.hpp"
  21 #include <string>
  22
  23 /** Public: Return the currently active CAN configuration. */
  24 CanMessageSet* getActiveMessageSet();
  25
  26 /** Public: Retrive a list of all possible CAN configurations.
  27  *      *
  28  *       * Returns a pointer to an array of all configurations.
  29  *        */
  30 CanMessageSet* getMessageSets();
  31
  32 /** Public: Return the length of the array returned by getMessageSets() */
  33 int getMessageSetCount();
  34
  35 /* Public: Return the number of CAN buses configured in the active
  36  *      * configuration. This is limited to 2, as the hardware controller only has 2
  37  *       * CAN channels.
  38  *        */
  39 int getCanBusCount();
  40
  41 /* Public: Return an array of all CAN messages to be processed in the active
  42  *      * configuration.
  43  *       */
  44 CanMessageDefinition* getMessages();
  45
  46 /* Public: Return signals from an signals array filtered on name.
  47  */
  48 CanSignal* getSignals(std::string name);
  49
  50 /* Public: Return an array of all OpenXC CAN commands enabled in the active
  51  *      * configuration that can write back to CAN with a custom handler.
  52  *       *
  53  *        * Commands not defined here are handled using a 1-1 mapping from the signals
  54  *         * list.
  55  *              */
  56 CanCommand* getCommands();
  57
  58 /* Public: Return the length of the array returned by getCommandCount(). */
  59 int getCommandCount();
  60
  61 /* Public: Return the length of the array returned by getSignals(). */
  62 int getSignalCount();
  63
  64 /* Public: Return the length of the array returned by getMessages(). */
  65 int getMessageCount();
  66
  67 /* Public: Return an array of the metadata for the 2 CAN buses you want to
  68  *      * monitor. The size of this array is fixed at 2.
  69  *       */
  70 CanBus* getCanBuses();
  71
  72
  73 /**
  74  * @brief Find one or many signals based on its name or id
  75  * passed through openxc_DynamicField.
  76  *
  77  * params[openxc_DynamicField&] - a const reference with the key to search into signal.
  78  * Key is either a signal name or its CAN arbitration id.
  79  *
  80  * return[std::vector<CanSignal>] return found CanSignal array.
  81  */
  82 std::vector <CanSignal> find_can_signals(const openxc_DynamicField &key)