From 1f6c0672fe78afbfd2415e88197926dc8fd13d70 Mon Sep 17 00:00:00 2001 From: Krisjanis Rijnieks Date: Thu, 22 Mar 2018 23:10:28 +0100 Subject: [PATCH] Add README.md to remote control server example --- example_remote-server/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 example_remote-server/README.md diff --git a/example_remote-server/README.md b/example_remote-server/README.md new file mode 100644 index 0000000..49d2ea6 --- /dev/null +++ b/example_remote-server/README.md @@ -0,0 +1,16 @@ +# Remote Control Server for ofxPiMapper + +This example demonstrates a TCP server for ofxPiMapper remote control. The other part of this is the [Remote Control Client](../). What it does is the following. + +- It creates a `TCPServer` singleton. +- Waits for a client to connect via TCP. +- Sends ofxPiMapper configuration once client is connected. +- Accepts keyboard and mouse events from client after. +- Forwards events to ofxPiMapper instance. + +In a real-world scenario, the server should reside on the Raspberry Pi side of your installation. The Raspberry Pi should be connected to wired or wireless network. An IP address should be set. + +The client should know the following. + +- The **IP address** of the Raspberry Pi with the server. +- The port, which is **9999** in this case.