summaryrefslogtreecommitdiffstats
path: root/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart
diff options
context:
space:
mode:
Diffstat (limited to 'docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart')
-rw-r--r--docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/1_Usage.md26
-rw-r--r--docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/2_can_device_socketcan_backend.md44
-rw-r--r--docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/3_Add_CAN_Device.md41
-rw-r--r--docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/4_Configure_CanRawSender_Node.md28
-rw-r--r--docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/5_Using_CanRawView.md18
-rw-r--r--docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/pictures/CANdevStudio.pngbin0 -> 52285 bytes
-rw-r--r--docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/pictures/canrawsender.pngbin0 -> 43850 bytes
-rw-r--r--docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/pictures/canrawviewer.pngbin0 -> 125506 bytes
8 files changed, 157 insertions, 0 deletions
diff --git a/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/1_Usage.md b/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/1_Usage.md
new file mode 100644
index 0000000..a58171c
--- /dev/null
+++ b/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/1_Usage.md
@@ -0,0 +1,26 @@
+---
+edit_link: ''
+title: Usage Guide
+origin_url: >-
+ https://raw.githubusercontent.com/automotive-grade-linux/docs-sources/master/agl-documentation/candevstudio/docs/1_Usage.md
+---
+
+<!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/apis_services/master/candevstudio-developer-guides-api-services-book.yml -->
+
+# Usage
+
+You can find the installation part
+[here](http://docs.automotivelinux.org/master/docs/devguides/en/dev/reference/host-configuration/docs/5_Candevstudio.html).
+
+The official repo of CanDevStudio is a subpart of GENIVI and can be found
+[here](https://github.com/GENIVI/CANdevStudio/).
+
+Launch it with following command:
+
+```bash
+CANdevStudio
+```
+
+Then start a new project.
+
+![CANdevStudio general screenshot](pictures/CANdevStudio.png)
diff --git a/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/2_can_device_socketcan_backend.md b/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/2_can_device_socketcan_backend.md
new file mode 100644
index 0000000..1a6a52b
--- /dev/null
+++ b/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/2_can_device_socketcan_backend.md
@@ -0,0 +1,44 @@
+---
+edit_link: ''
+title: Bringing up a CAN device using socketcan backend
+origin_url: >-
+ https://raw.githubusercontent.com/automotive-grade-linux/docs-sources/master/agl-documentation/candevstudio/docs/2_can_device_socketcan_backend.md
+---
+
+<!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/apis_services/master/candevstudio-developer-guides-api-services-book.yml -->
+
+# Bringing up a CAN device using socketcan backend
+
+* [Using a supported Linux CAN device](https://www.elinux.org/CAN_Bus):
+
+```bash
+# Find your interface name (e.g. can0)
+ip link
+# Configure bitrate
+sudo ip link set can0 type can bitrate 1000000
+# Bring the device up
+sudo ip link set can0 up
+# Optionally configure CAN termination
+sudo ip link set can0 type can termination 1
+```
+
+## Using slcand
+
+* Based on FTDI Serial driver
+* Requires slcand to "convert" serial device to SocketCAN.
+* Officially supported in Linux Kernel v2.6.38
+
+```bash
+# Create SocketCAN device from serial interface
+sudo slcand -o -c -s8 -S1000000 /dev/ttyUSB0 can0
+# Bring the device up
+sudo ip link set can0 up
+```
+
+## Using builtin Linux kernel virtual CAN module vcan
+
+```bash
+sudo modprobe vcan
+sudo ip link add dev can0 type vcan
+sudo ip link set can0 up
+```
diff --git a/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/3_Add_CAN_Device.md b/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/3_Add_CAN_Device.md
new file mode 100644
index 0000000..9eef2c7
--- /dev/null
+++ b/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/3_Add_CAN_Device.md
@@ -0,0 +1,41 @@
+---
+edit_link: ''
+title: Add a CAN device in CANdevStudio
+origin_url: >-
+ https://raw.githubusercontent.com/automotive-grade-linux/docs-sources/master/agl-documentation/candevstudio/docs/3_Add_CAN_Device.md
+---
+
+<!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/apis_services/master/candevstudio-developer-guides-api-services-book.yml -->
+
+# Add a CAN device in CANdevStudio
+
+Start a new project and grab a ***CanDevice*** from the left pane in the
+***Device Layer*** section and drop it on the grid workspace. Right-Click on it
+and open its ***Properties***. Here you have to set the ***backend*** and the
+***interface*** name you'll want to use. Backend available are:
+
+- socketcan: CAN stack present by default in the Linux Kernel. This use Linux socket and open source CAN device driver (More information here).
+- systeccan: CAN bus backend using the SYS TEC CAN adapters.
+- peakcan: CAN bus plugin using the PEAK CAN adapters.
+- tinycan: CAN bus plugin using the MHS CAN adapters.
+- vectorcan: CAN bus plugin using the Vector CAN adapters.
+
+More details about CANdevStudio CAN bus support [here](http://doc.qt.io/qt-5.10/qtcanbus-backends.html).
+
+***Interface*** is the name of the device you want to use. Bring up your CAN device and use the following command to find out which one are available:
+
+```bash
+ip link
+1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN mode DEFAULT group default qlen 1000
+ link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
+2: enp0s25: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc fq_codel state UP mode DEFAULT group default qlen 1000
+ link/ether 90:b1:1c:6b:b2:21 brd ff:ff:ff:ff:ff:ff
+3: virbr0: <NO-CARRIER,BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue state DOWN mode DEFAULT group default qlen 1000
+ link/ether 52:54:00:56:86:80 brd ff:ff:ff:ff:ff:ff
+4: virbr0-nic: <BROADCAST,MULTICAST> mtu 1500 qdisc fq_codel master virbr0 state DOWN mode DEFAULT group default qlen 1000
+ link/ether 52:54:00:56:86:80 brd ff:ff:ff:ff:ff:ff
+5: docker0: <NO-CARRIER,BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue state DOWN mode DEFAULT group default
+ link/ether 02:42:81:38:a8:75 brd ff:ff:ff:ff:ff:ff
+12: can0: <NOARP,UP,LOWER_UP> mtu 72 qdisc noqueue state UNKNOWN mode DEFAULT group default qlen 1000
+ link/can
+```
diff --git a/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/4_Configure_CanRawSender_Node.md b/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/4_Configure_CanRawSender_Node.md
new file mode 100644
index 0000000..9fc2675
--- /dev/null
+++ b/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/4_Configure_CanRawSender_Node.md
@@ -0,0 +1,28 @@
+---
+edit_link: ''
+title: Configure a CanRawSender node
+origin_url: >-
+ https://raw.githubusercontent.com/automotive-grade-linux/docs-sources/master/agl-documentation/candevstudio/docs/4_Configure_CanRawSender_Node.md
+---
+
+<!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/apis_services/master/candevstudio-developer-guides-api-services-book.yml -->
+
+# Configure a CanRawSender node
+
+CanRawSender node lets you set a predefined list of CAN Raw messages to send.
+
+![CanRawSender screenshot](pictures/canrawsender.png)
+
+Click on the + sign to add as much as needed signals to send. For each signals, you has to define:
+
+- the CAN arbitration ID
+- Data load
+- Loop checkbox make the signal repeat infinitely
+- Interval is used with loop to define how much time between 2 sends
+
+Once clicked on ***Play*** button in the main Window to launch the simulation,
+then each signals will be sent in the same order than defined in the
+CanRawSender node then using interval to repeat themselves.
+
+Signals without ***loop*** checked will not be sent, you have to click manually
+on the ***Send*** button to trigger a sending.
diff --git a/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/5_Using_CanRawView.md b/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/5_Using_CanRawView.md
new file mode 100644
index 0000000..0d44a87
--- /dev/null
+++ b/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/5_Using_CanRawView.md
@@ -0,0 +1,18 @@
+---
+edit_link: ''
+title: Using CanRawView
+origin_url: >-
+ https://raw.githubusercontent.com/automotive-grade-linux/docs-sources/master/agl-documentation/candevstudio/docs/5_Using_CanRawView.md
+---
+
+<!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/apis_services/master/candevstudio-developer-guides-api-services-book.yml -->
+
+# Using CanRawView
+
+***CanRawViewer*** is pretty simple to use, once simulation launched you'll see
+signal flows in the window. You can use ***Clear*** button to wipe the window.
+
+![CanRawViewer screenshot](pictures/canrawviewer.png)
+
+Use the ***Combine*** button to stack by arbitration ID the CAN signals.
+Then only the latest signal for each arbitration ID will be displayed.
diff --git a/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/pictures/CANdevStudio.png b/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/pictures/CANdevStudio.png
new file mode 100644
index 0000000..c944e02
--- /dev/null
+++ b/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/pictures/CANdevStudio.png
Binary files differ
diff --git a/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/pictures/canrawsender.png b/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/pictures/canrawsender.png
new file mode 100644
index 0000000..766ca63
--- /dev/null
+++ b/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/pictures/canrawsender.png
Binary files differ
diff --git a/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/pictures/canrawviewer.png b/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/pictures/canrawviewer.png
new file mode 100644
index 0000000..f20488b
--- /dev/null
+++ b/docs/4_APIs_and_Services/4.5_Message_Signaling/7_CanDevStudio_Quickstart/candevstudio/pictures/canrawviewer.png
Binary files differ