Blinker

documentation for operator connection, phone connector module and operator connection printer module
Parent eb638ea
Stefan Schuermans

Stefan Schuermans commited on 2011-12-22 21:43:13
Showing 5 changed files, with 107 additions and 3 deletions.

doc/index.html
View file @ 7b3a897
... ... 
@@ -46,6 +46,19 @@
46 46 
       If multiple parties send video frames to the stream, the frames
47 47 
       are mixed, which is most likely not what you want.
48 48 
     </p>
49 
+    <h2>Operator Connections</h2>
50 
+    <p>
51 
+      Some modules can react to events and/or send events to other modules.
52 
+      Suche events are delivered over so-called operator connections.
53 
+      A module can caonnect to another module listen for incoming operator
54 
+      connections.
55 
+      If this connection is accepted, both modules can exchange events over
56 
+      the connection until one of the modules choses to close the connection.
57 
+      <br>
58 
+      In the context of controlling Blinkenlights style displays over a phone
59 
+      connections, events can be keys pressed on the phone or requests to play
60 
+      a certain sound.
61 
+    </p>
49 62 
     <h2>Configuration Directory</h2>
50 63 
     <p>
51 64 
       The configuration of blinker is not stored in a single file, but in a
... ... 
@@ -86,12 +99,14 @@
86 99 
       <ul>
87 100 
         <li><a href="canvas.html">Canvas</a></li>
88 101 
         <li><a href="flexipix.html">FlexiPix</a></li>
102 
+        <li><a href="opprinter.html">Operator Connection Printer</a></li>
89 103 
         <li><a href="output.html">Output</a></li>
90 104 
         <li><a href="player.html">Player</a></li>
91 105 
         <li><a href="printer.html">Printer</a></li>
92 106 
         <li><a href="priority.html">Priority</a></li>
93 107 
         <li><a href="resizer.html">Resizer</a></li>
94 108 
         <li><a href="scaler.html">Scaler</a></li>
109 
+        <li><a href="udp4phone.html">UDP4 Phone Connector</a></li>
95 110 
         <li><a href="udp4receiver.html">UDP4 Receiver</a></li>
96 111 
         <li><a href="udp4sender.html">UDP4 Sender</a></li>
97 112 
       </ul>
doc/opprinter.html
View file @ 7b3a897
... ... 
@@ -0,0 +1,26 @@
1 
+<html>
2 
+  <head>
3 
+    <title>Blinker - Operator Connection Printer</title>
4 
+  </head>
5 
+  <body>
6 
+    <h1>Blinker - Operator Connection Printer</h1>
7 
+    <p>
8 
+      The operator connection printer module is primary intended for debugging
9 
+      purposes.
10 
+      It accepts all incoming operator connections and prints events received
11 
+      to standard output.
12 
+      It also replies with a sound play request to the key events 7 and 9.
13 
+    </p>
14 
+    <h2>Configuration</h2>
15 
+    <p>
16 
+      The configuration of the operator connection printer module with name
17 
+      <code>NAME</code> is located in the <code>opprinters/NAME</code>
18 
+      subdirectory.
19 
+    </p>
20 
+    <p>
21 
+      There are no further configuration files, i.e. the subdirectory for
22 
+      an operator connector module is empty.
23 
+    </p>
24 
+  </body>
25 
+</html>
26 
+
doc/udp4phone.html
View file @ 7b3a897
... ... 
@@ -0,0 +1,63 @@
1 
+<html>
2 
+  <head>
3 
+    <title>Blinker - UDPv4 Phone Connector</title>
4 
+  </head>
5 
+  <body>
6 
+    <h1>Blinker - UDPv4 Phone Connector</h1>
7 
+    <p>
8 
+      The UDPv4 phone connector module provides an interface between an
9 
+      external phone interface (using EBIP protocol) and the internal
10 
+      operator connections.
11 
+      The calls coming in over EBIP, can be accepted depedning on the
12 
+      called number and forwarded to different modules over operator
13 
+      connections.
14 
+    </p>
15 
+    <h2>Configuration</h2>
16 
+    <p>
17 
+      The configuration of the UDPv4 phone connector module with name
18 
+      <code>NAME</code> is located in the <code>udp4phones/NAME</code>
19 
+      subdirectory.
20 
+    </p>
21 
+    <h3>Bind Address</h3>
22 
+    <p>
23 
+      The file <code>bind</code> contains the local address to bind to.
24 
+      It must contain the IP address and the port, i.e. a string
25 
+      <code>&lt;IP&gt;:&lt;port&gt;</code> (hostnames are not supported).
26 
+      If the local address should be determined automatically, the file
27 
+      can contain <code>0.0.0.0:0</code>.
28 
+    </p>
29 
+    <h3>Server Address</h3>
30 
+    <p>
31 
+      The file <code>server</code> contains the address of the EBIP server
32 
+      as a string <code>&lt;IP&gt;:&lt;port&gt;</code>
33 
+      (hostnames are not supported).
34 
+      <br>
35 
+      The phone connector module will register with this server and
36 
+      accept incoming calls.
37 
+    </p>
38 
+    <h3>Extensions / Phone Numbers</h3>
39 
+    <p>
40 
+      The virtual extensions (i.e. phone numbers) that can be called via EBIP
41 
+      are configured in the subdirectory <code>extensions</code>.
42 
+      <br>
43 
+      Each extension is configured in its own subdirectory.
44 
+      E.g. the configuration for the extension with the phone number
45 
+      <code>12345678</code> resides in the subdirectory
46 
+      <code>extensions/12345678</code>.
47 
+    </p>
48 
+    <p>
49 
+      The configuration inside an extension consists of the following
50 
+      settings:
51 
+    </p>
52 
+    <h4>Module</h4>
53 
+    <p>
54 
+      The file <code>module</code> contains the name of the module to
55 
+      contact via an operator connection if the extension is called.
56 
+      The module name consists of two parts: <code>CLASS/NAME</class>
57 
+      E.g. to connect to the operator connection printer named
58 
+      <code>debug</code>, the file has to contain
59 
+      <code>opprinters/debug</code> as module name.
60 
+    </p>
61 
+  </body>
62 
+</html>
63 
+
doc/udp4receiver.html
View file @ 7b3a897
... ... 
@@ -36,7 +36,7 @@
36 36 
       If the local address should be determined automatically, the file
37 37 
       can contain <code>0.0.0.0:0</code>.
38 38 
     </p>
39 
-    <h3>Source address</h3>
39 
+    <h3>Source Address</h3>
40 40 
     <p>
41 41 
       The file <code>source</code> contains the source address
42 42 
       as a string <code>&lt;IP&gt;:&lt;port&gt;</code>
doc/udp4sender.html
View file @ 7b3a897
... ... 
@@ -39,7 +39,7 @@
39 39 
     <p>
40 40 
       Static destinations to supply with a network stream in the configured
41 41 
       protocol can be configured in the subdirectory <code>destinations</code>.
42 
-
42 
+      <br>
43 43 
       Each static destination is configured in an own subdirectory.
44 44 
       E.g. the configuration for a static destination with name
45 45 
       <code>local</code> resides in the subdirectory
... ... 
@@ -49,7 +49,7 @@
49 49 
       The configuration inside a static destination consists of the following
50 50 
       settings:
51 51 
     </p>
52 
-    <h4>Destination address</h4>
52 
+    <h4>Destination Address</h4>
53 53 
     <p>
54 54 
       The file <code>addr</code> contains the destination address
55 55 
       as a string <code>&lt;IP&gt;:&lt;port&gt;</code>
56 56