Browse Source

Added README for QRNet

Sebastian Lohff 8 years ago
parent
commit
091c12b5f4
1 changed files with 46 additions and 0 deletions
  1. 46
    0
      tunnel/qrnet/README

+ 46
- 0
tunnel/qrnet/README View File

@@ -0,0 +1,46 @@
1
+QRNet
2
+=====
3
+QRNet, sometimes also known as "The Clacks", is an ethernet tunnel providing an
4
+opto-uncoupled ether via two laptops with webcams reading qr-codes from each
5
+others display.
6
+
7
+This tunnel was written at the Chaos Communication Camp (CCCamp). Until day 2
8
+there was no stable internet connection at our part of the camp and wifi was
9
+not reliable, but the guys across the road had a pretty decent connection.
10
+Sadly no two beamers could be acquired and QRNet did not save the day.
11
+Nevertheless the code has been finnished and a 90cm connection has been
12
+established at camp site.
13
+
14
+
15
+Installation and requirements
16
+=============================
17
+ * python-opencv
18
+ * python-zbar
19
+ * python-qrencode
20
+ * python-gtk
21
+ * ether2any
22
+ * 2 displays
23
+ * 2 webcams, videocams or other optical qrcode scanners
24
+
25
+Configuration can be done in the conf.py. After starting the tunnel you need to
26
+adjust the webcams. The percent bar at the bottom of the screen will show how
27
+many qrcodes could be read per time interval.
28
+
29
+
30
+How it works
31
+============
32
+The tunnel accesses the laptops webcam and tries to read a qrcode from each
33
+received image. If it can be decoded, it is written as network traffic to the
34
+interface as incoming traffic. Outgoing traffic is displayed as qrcodes on the
35
+laptop's screen.
36
+
37
+
38
+What could be done
39
+==================
40
+ * allow QRNet to run as IP tunnel, configurable via config
41
+
42
+
43
+Licensing
44
+=========
45
+Published under the GPLv3 or later
46
+

Loading…
Cancel
Save