summaryrefslogtreecommitdiffstats
path: root/can-signals.h
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2017-02-13 23:25:02 +0000
committerRomain Forlot <romain.forlot@iot.bzh>2017-02-13 23:31:56 +0000
commit53f4e096efa72a05b1f469fe082e6fa4b55bca01 (patch)
treea7de0c75bd943af4cb7e1be257ba1524b2a03673 /can-signals.h
parente28b4da3cf2042695e0c0a99b9448eb3a548e0f5 (diff)
Beginning of Obd2 handling with a handle object
inspired from openxc library. Change-Id: I664eb8dde9bccb29e7be3642df9e5c0f0cf25d28 Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'can-signals.h')
-rw-r--r--can-signals.h62
1 files changed, 31 insertions, 31 deletions
diff --git a/can-signals.h b/can-signals.h
index 394c8673..f34c743e 100644
--- a/can-signals.h
+++ b/can-signals.h
@@ -6,7 +6,7 @@
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
@@ -18,41 +18,41 @@
#pragma once
#include "can-utils.h"
+#include <string>
/** Public: Return the currently active CAN configuration. */
CanMessageSet* getActiveMessageSet();
/** Public: Retrive a list of all possible CAN configurations.
- * *
- * * Returns a pointer to an array of all configurations.
- * */
+ * *
+ * * Returns a pointer to an array of all configurations.
+ * */
CanMessageSet* getMessageSets();
/** Public: Return the length of the array returned by getMessageSets() */
int getMessageSetCount();
/* Public: Return the number of CAN buses configured in the active
- * * configuration. This is limited to 2, as the hardware controller only has 2
- * * CAN channels.
- * */
+ * * configuration. This is limited to 2, as the hardware controller only has 2
+ * * CAN channels.
+ * */
int getCanBusCount();
/* Public: Return an array of all CAN messages to be processed in the active
- * * configuration.
- * */
+ * * configuration.
+ * */
CanMessageDefinition* getMessages();
-/* Public: Return an array of all CAN signals to be processed in the active
- * configuration.
+/* Public: Return signals from an signals array filtered on name.
*/
-CanSignal* getSignals();
+CanSignal* getSignals(std::string name);
/* Public: Return an array of all OpenXC CAN commands enabled in the active
- * * configuration that can write back to CAN with a custom handler.
- * *
- * * Commands not defined here are handled using a 1-1 mapping from the signals
- * * list.
- * */
+ * * configuration that can write back to CAN with a custom handler.
+ * *
+ * * Commands not defined here are handled using a 1-1 mapping from the signals
+ * * list.
+ * */
CanCommand* getCommands();
/* Public: Return the length of the array returned by getCommandCount(). */
@@ -65,20 +65,20 @@ int getSignalCount();
int getMessageCount();
/* Public: Return an array of the metadata for the 2 CAN buses you want to
- * * monitor. The size of this array is fixed at 2.
- * */
+ * * monitor. The size of this array is fixed at 2.
+ * */
CanBus* getCanBuses();
/* Public: Decode CAN signals from raw CAN messages, translate from engineering
- * * units to something more human readable, and send the resulting value over USB
- * * as an OpenXC-style JSON message.
- * *
- * * This is the main workhorse function of the VI. Every time a new
- * * CAN message is received that matches one of the signals in the list returend
- * * by getSignals(), this function is called with the message ID and 64-bit data
- * * field.
- * *
- * * bus - The CAN bus this message was received on.
- * * message - The received CAN message.
- * */
-void decodeCanMessage(openxc::pipeline::Pipeline* pipeline, CanBus* bus, CanMessage* message); \ No newline at end of file
+ * * units to something more human readable, and send the resulting value over USB
+ * * as an OpenXC-style JSON message.
+ * *
+ * * This is the main workhorse function of the VI. Every time a new
+ * * CAN message is received that matches one of the signals in the list returend
+ * * by getSignals(), this function is called with the message ID and 64-bit data
+ * * field.
+ * *
+ * * bus - The CAN bus this message was received on.
+ * * message - The received CAN message.
+ * */
+void decodeCanMessage(openxc::pipeline::Pipeline* pipeline, CanBus* bus, CanMessage* message);