From aa88eb93b65646a02064894df4c4af398749f80a Mon Sep 17 00:00:00 2001 From: Krisjanis Rijnieks Date: Thu, 22 Mar 2018 23:19:00 +0100 Subject: [PATCH] Add README.md to remote control client example --- example_remote-client/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 example_remote-client/README.md diff --git a/example_remote-client/README.md b/example_remote-client/README.md new file mode 100644 index 0000000..557787f --- /dev/null +++ b/example_remote-client/README.md @@ -0,0 +1,13 @@ +# Remote Control Client for ofxPiMapper + +This example demonstrates a TCP **client** for ofxPiMapper remote control. The other part of this is the [Remote Control Server](../example_remote-server). What it does is the following. + +- Reads IP address and port defined in `bin/data/config.json`. +- Connects to server by using the IP address and port. +- Once connected, ofxPiMapper configuration is received. +- Instance of ofxPiMapper class is being set up. +- TCP messages are sent on every keyboard and mouse event. + +In reality this example should be used as the remote control residing on your laptop computa. Set up your Raspberry Pi, connect it to the same network as your laptop and get to know the IP address of the Raspberry Pi. Update `bin/data/config.json` with the IP address of your Raspberry Pi and launch the app! + +**Warning!** Sources are not being sent. Click once with the mouse after the application launches to see the borders of the surfaces. There should be a green rectangle visible in the top left corner of the screen if the connection is successful.