diff options
author | Stefan S <smarzlys@gmail.com> | 2015-01-20 13:11:43 +0100 |
---|---|---|
committer | Stefan S <smarzlys@gmail.com> | 2015-01-20 13:11:43 +0100 |
commit | 12c3a613409b43bdb1b57c3ab0b6827d6ec466ea (patch) | |
tree | df76055f1e90d4ff7721573cc460700e7624560d /documents/examples | |
parent | ba83bf8e38b70ea7a466dceae470d9f5b97d0d9c (diff) | |
download | Open-AVB-12c3a613409b43bdb1b57c3ab0b6827d6ec466ea.tar.gz |
Improved documentation: added variables for copy and paste solution
Diffstat (limited to 'documents/examples')
-rw-r--r-- | documents/examples/AVB_Talker_Listener_Example_Setup.md | 27 |
1 files changed, 17 insertions, 10 deletions
diff --git a/documents/examples/AVB_Talker_Listener_Example_Setup.md b/documents/examples/AVB_Talker_Listener_Example_Setup.md index 79deb96b..293eb686 100644 --- a/documents/examples/AVB_Talker_Listener_Example_Setup.md +++ b/documents/examples/AVB_Talker_Listener_Example_Setup.md @@ -2,18 +2,25 @@ _Note:_ this tutorial targets a Linux OS. -Fetch the Open-AVB repository. To ease the further steps, enter your local copy and export its path via +## Preparation + +Fetch the Open-AVB repository. To ease the further steps, enter your local copy +and export its path and AVB interfaces via ```bash export AVB_PATH=$(pwd) +export AVB_PC1_IF="eth0" +export AVB_PC2_IF="eth2" ``` -Then, you can use a terminal multiplexer like _byobu_ to start all needed AVB tools in different windows. +Then, you can use a terminal multiplexer like _byobu_ to start all needed AVB +tools in different windows. We assume the following PC setup: * PC1: ethernet eth0 for AVB connection * PC2: ethernet eth2 for AVB connection * Both ethernet cards are using the `igb_avb` driver. - Check via `ethtool -i eth0`. - If not, launch `sudo ./startup.sh eth0` in `kmod/igb` to load the required driver for the provided interface. + * Check via `ethtool -i eth0`. + * If not, launch `sudo ./startup.sh eth0` in `kmod/igb` to load the required + driver for the AVB interface. * Both PCs can ping each other through the AVB network cards. ## PC 1: start AVB environment + talker application @@ -23,18 +30,18 @@ Start AVB environment: ```bash # GPTP time synchronization daemon cd "${AVB_PATH}/daemons/gptp/linux/build/obj" -sudo ./daemon_cl eth0 -R 1 +sudo ./daemon_cl $AVB_PC1_IF -R 1 # Stream reservation daemon (m: MMRP, v: MVRP, s: MSRP) cd "${AVB_PATH}/daemons/mrpd" -sudo ./mrpd -mvs -i eth0 +sudo ./mrpd -mvs -i $AVB_PC1_IF ``` Start AVB talker example: ```bash cd "${AVB_PATH}/examples/simple_talker" -sudo ./simple_talker -i eth0 -t 2 +sudo ./simple_talker -i $AVB_PC1_IF -t 2 ``` ## PC 2: start AVB environment + listener application @@ -44,18 +51,18 @@ Start AVB environment similar to PC 1: ```bash # GPTP time synchronization daemon (will synchronize on PC 1) cd "${AVB_PATH}/daemons/gptp/linux/build/obj" -sudo ./daemon_cl eth2 +sudo ./daemon_cl $AVB_PC2_IF # Stream reservation daemon (m: MMRP, v: MVRP, s: MSRP) cd "${AVB_PATH}/daemons/mrpd" -sudo ./mrpd -mvs -i eth2 +sudo ./mrpd -mvs -i $AVB_PC2_IF ``` Start AVB listener example: ```bash cd "${AVB_PATH}/examples/simple_listener" -sudo ./simple_listener -i eth2 -f out.wav +sudo ./simple_listener -i $AVB_PC2_IF -f out.wav ``` :tada: |