summaryrefslogtreecommitdiffstats
path: root/waltham-receiver/README.md
diff options
context:
space:
mode:
authorJan-Simon Moeller <jsmoeller@linuxfoundation.org>2019-07-09 08:13:54 +0000
committerGerrit Code Review <gerrit@automotivelinux.org>2019-07-09 08:13:54 +0000
commit6b673b5726dea2d2f8d39caee34d0ca850cc146e (patch)
tree189b961689a2f3b0de09c46a4b1db08b06021149 /waltham-receiver/README.md
parent2e0789fdb4141807b9367787e3bb4098c40f7e2a (diff)
parent3344b0a0696c2670ccdc7fa9fb619efdf3764fca (diff)
Merge "receiver: Introduce waltham-receiver"halibut_8.0.0halibut_7.99.3halibut/8.0.0halibut/7.99.38.0.07.99.3
Diffstat (limited to 'waltham-receiver/README.md')
-rw-r--r--waltham-receiver/README.md126
1 files changed, 126 insertions, 0 deletions
diff --git a/waltham-receiver/README.md b/waltham-receiver/README.md
new file mode 100644
index 0000000..d0f63cb
--- /dev/null
+++ b/waltham-receiver/README.md
@@ -0,0 +1,126 @@
+# Waltham-receiver
+
+waltham-receiver component is a receiver side implementation for using
+Waltham protocol to obtain and process remote output received from
+waltham-transmitter
+
+This component is designed to be used for evaluating the functionalities of
+waltham-transmitter plugin.
+
+This component also acts as weston client application to display/handle various
+requests from actual weston client at transmitter side.
+
+###Architecture
+
+````
+
+ ECU 1 ECU 2
+ +-----------------------------------------------------+ +----------------------------------------------+
+ | +-----------------+ | | |
+ | | IVI-Application | | | +-----------+-----------+ |
+ | +-----------------+ | | | Gstreamer | | |
+ | ^ | Buffer -----------------------> (Decode) | | |
+ | wayland | +----------------------/ | +-----------+ | |
+ | v | | (Ethernet) | | Waltham-receiver | |
+ | +----+---------------------+ | | ----------------------------> | |
+ | | | Transmitter Plugin |<-----------------------------/ | +-----------------------+ |
+ | | | | | | Waltham-Protocol | ^ |
+ | | | +-------------------+ | | | wayland | |
+ | | | | waltham-renderer |------------+ | | v |
+ | | | |(gstreamer Encode) | | | +---------------------+ |
+ | | +-+-------------------+ | | | | |
+ | | | | | | WESTON | |
+ | | WESTON | | | | | |
+ | +------+-------------------+ | | +----------------+----+ |
+ | | | | | |
+ | v | | v |
+ | +------------+ | | +----------+ |
+ | | Display | | | | Display | |
+ | | | | | | | |
+ | +------------+ | | +----------+ |
+ +-----------------------------------------------------+ +----------------------------------------------+
+
+````
+
+###Build Steps
+
+
+1. Prerequisite before building
+
+ weston, wayland, waltham and gstreamer should be built and available.
+
+2. In waltham-receiver directory, create build directory
+
+ $cd waltham-receiver
+ $mkdir build
+ $cd build/
+
+3. Run cmake
+
+ $cmake ../
+ $cmake --build .
+
+4. waltham-receiver binary should be availaible in build directory
+
+###Configure pipeline
+You can use gstreamer pipeline as you want by configuring from "pipeline_receiver.cfg".
+This file should be in the folder "/etc/xdg/weston/".
+
+As an example, please refer to the example file named "pipeline_receiver_example*.cfg".
+
+ -pipeline_receiver_example_general.cfg : Does not use any HW decoder.
+ -pipeline_receiver_example_intel.cfg : Use Intel's HW decoder.
+ -pipeline_receiver_example_rcar.cfg : Use Rcar's HW decoder.
+
+Rename file as "pipeline_receiver.cfg" and put in correct place when you use them.
+
+###Connection Establishment
+
+1. Connect two board over ethernet.
+
+2. Assign IP to both the boards and check if the simple ping works.
+
+ For example:if transmitter IP: 192.168.2.51 and Waltham-Receiver IP: 192.168.2.52 then
+
+ $ping 192.168.2.52 (you can also ping vice versa)
+
+3. Make sure that IP address specified in the weston.ini under [remote-output] matches the Waltham-Receiver IP.
+
+4. Make sure that IP address in pipeline.cfg on the transmitter side match the Waltham-Receiver IP.
+
+###Basic test steps
+
+1. Start weston at receiver side
+
+ $weston &
+
+2. Run waltham-receiver
+
+ $waltham-receiver -p < port_number > -v &
+
+3. Start weston with transmitter plugin at transmitter side, run application and put it on transmitter screen.You should see the application rendered on receiver display.
+
+Connection established -receiver side logs:
+
+````
+set_sigint_handler >>>
+ <<< set_sigint_handler
+receiver_listen >>>
+ <<< receiver_listen
+watch_ctl >>>
+ <<< watch_ctl
+Waltham receiver listening on TCP port 34400...
+receiver_mainloop >>>
+receiver_flush_clients >>>
+ <<< receiver_flush_clients
+listen_socket_handle_data >>>
+EPOLLIN evnet received.
+receiver_accept_client >>>
+client_create >>>
+watch_ctl >>>
+ <<< watch_ctl
+Client 0xaaaadc4cde70 connected.
+ <<< client_create
+ <<< receiver_accept_client
+ <<< listen_socket_handle_data
+````