summaryrefslogtreecommitdiff
path: root/plugins/openxc/README
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/openxc/README')
-rw-r--r--plugins/openxc/README40
1 files changed, 40 insertions, 0 deletions
diff --git a/plugins/openxc/README b/plugins/openxc/README
new file mode 100644
index 00000000..57db1e40
--- /dev/null
+++ b/plugins/openxc/README
@@ -0,0 +1,40 @@
+OpenXC plugin
+
+This plugin uses the OpenXC protocol supported devices to provide information to AMB.
+
+To enable the OpenXC plugin, run cmake and enable the openxc_plugin option:
+
+cmake -Dopenxc_plugin=On ..
+
+To use the Database plugin, add the following to the "sources" array in /etc/ambd/config:
+
+{
+ "name" : "openxc",
+ "path" : "/usr/lib/automotive-message-broker/openxcplugin.so",
+ "device" : "/dev/ttyUSB0",
+ "bluetoothAdapter" : "00:00:00:00:00:00",
+ "test" : "false"
+}
+
+Configuration Key Definitions:
+
+"name"
+name of plugin. This key is not used by the plugin at this moment.
+
+"path"
+path to plugin on the filesystem.
+
+"device"
+openXC device. This must be a serial device. It can also be a bluetooth address.
+
+Default: none
+
+"bluetoothAdapter"
+Bluetooth adapter to use. This is only used if "device" is also a bluetooth device.
+Leave blank to use system default adapter.
+
+Default: none
+
+AMB Properties:
+
+none