summaryrefslogtreecommitdiffstats
path: root/docs/uca-net.rst
diff options
context:
space:
mode:
authorMatthias Vogelgesang <matthias.vogelgesang@gmail.com>2016-08-26 14:35:15 +0200
committerGitHub <noreply@github.com>2016-08-26 14:35:15 +0200
commitbbd887b5915dcdac2ee60061700e89e8141dc31a (patch)
treeca1f4a3bc0838b94b9fe9774d23ca1848948c303 /docs/uca-net.rst
parentd0aabc426cb01d488e9d41a66623773da73ff5e3 (diff)
parent48b868c5208816b007ec1d9c7940e75b4c64e5ce (diff)
downloaduca-bbd887b5915dcdac2ee60061700e89e8141dc31a.tar.gz
uca-bbd887b5915dcdac2ee60061700e89e8141dc31a.tar.bz2
uca-bbd887b5915dcdac2ee60061700e89e8141dc31a.tar.xz
uca-bbd887b5915dcdac2ee60061700e89e8141dc31a.zip
Merge pull request #76 from ufo-kit/docs
Update documentation
Diffstat (limited to 'docs/uca-net.rst')
-rw-r--r--docs/uca-net.rst42
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/uca-net.rst b/docs/uca-net.rst
new file mode 100644
index 0000000..7a71608
--- /dev/null
+++ b/docs/uca-net.rst
@@ -0,0 +1,42 @@
+TCP-based network bridge camera
+===============================
+
+`uca-net`_ is a transparent TCP-based network bridge camera for remote access of ``libuca``
+cameras.
+
+.. _uca-net: https://github.com/ufo-kit/uca-net
+
+
+Installation
+------------
+
+The only dependency is libuca itself and any camera you wish to access.
+
+Clone the repository::
+
+ $ git clone https://github.com/ufo-kit/uca-net.git
+
+and create a new build directory inside::
+
+ $ cd uca-net/
+ $ mkdir build
+
+The installation process is the same as by ``libuca``::
+
+ $ cd build/
+ $ cmake ..
+ $ make
+ $ sudo make install
+
+
+Usage
+-----
+
+You can start a server on a remote machine with::
+
+ $ ucad camera-model
+
+and connect to it from any other machine, for example::
+
+ $ uca-grab -p host=foo.bar.com:4567 -n 10 net // grab ten frames
+ $ uca-camera-control -c net // control graphically