Difference between revisions of "Eth8x8 Control Interface"

From eMDeeWiki
Jump to navigationJump to search
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
Data can be passed from a client to an Eth8x8 through the Eth8x8 Control Interface.  Packets are sent from the client to the Eth8x8 through a TCP/IP port.  The following rules apply:
 +
<ul>
 +
<li>The Eth8x8 shall listen for TCP/IP connections on IP port number 33001</li>
 +
<li>A maximum of 3 clients can simultaneously connect to the Control Interface port</li>
 +
<li>All elements of each packet shall be in network byte order</li>
 +
</ul>
 +
 +
The following sections define the packets that can be sent to the Eth8x8
 +
 +
 +
==Data Request==
 +
<ul>
 +
<li>Each element of the Data Request Packet is a 16 bit integer</li>
 +
<li>The first 16 bit word of the packet represents the unique identifier and must be equal to 0x100</li>
 +
<li>A Status Packet with the requested data will be sent back to the client in response to each Data Request</li>
 +
</ul>
 +
 +
 +
{| style="text-align:center"
 +
 +
|-
 +
! width="100" bgcolor="#CCCCCC" |Byte Offset
 +
! width="200" bgcolor="#CCCCCC" |Element
 +
 +
|-
 +
! bgcolor="#CCCCCC" |0
 +
| bgcolor="#FFBBBB" |0x100
 +
 +
|-
 +
! bgcolor="#CCCCCC" |2
 +
| bgcolor="#FFBBBB" |Unique Identifier of Requested Data
 +
 +
|}
 +
 +
 
==Mixer Control Packet 8 input x 8 output==
 
==Mixer Control Packet 8 input x 8 output==
 
<ul>
 
<ul>
−
<li>Each element of the Mixer Control Packet is a 16 bit integer</li>
+
<li>Each element of the Mixer Control Packet is a 16 bit unsigned integer</li>
 
<li>The first 16 bit word of the packet represents the unique identifier and must be equal to 0x808</li>
 
<li>The first 16 bit word of the packet represents the unique identifier and must be equal to 0x808</li>
−
<li>All elements of the packet shall be in network byte order</li>
 
 
</ul>
 
</ul>
  
Line 78: Line 112:
  
 
|}
 
|}
 +
 +
 +
<ul>
 +
<li>Each Mixer Control element is a gain value represented by a fixed point integer in 2.14 format</li>
 +
<li>For example:</li>
 +
  <ul>
 +
  <li>use 0x8000 to set the gain to 2.0 (+6dB)</li>
 +
  <li>use 0x4000 to set the gain to 1.0 (0dB)</li>
 +
  <li>use 0x2000 to set the gain to 0.5 (-6dB)</li>
 +
  <li>use 0 to mute</li>
 +
  </ul>
 +
<li>Care must be taken when using gain values greater than 1.0 (0dB) to avoid over-amplification resulting in clipping of the resultant signal</li>
 +
</ul>
 +
 +
 +
==Mixer Control Packet 4 input x 4 output==
 +
<ul>
 +
<li>Each element of the Mixer Control Packet is a 16 bit unsigned integer</li>
 +
<li>The first 16 bit word of the packet represents the unique identifier and must be equal to 0x404</li>
 +
</ul>
 +
 +
 +
{| style="text-align:center"
 +
 +
|-
 +
! width="100" bgcolor="#CCCCCC" |Byte Offset
 +
! width="200" bgcolor="#CCCCCC" |Element
 +
 +
|-
 +
! bgcolor="#CCCCCC" |0
 +
| bgcolor="#FFBBBB" |0x404
 +
 +
|-
 +
! bgcolor="#CCCCCC" |2
 +
| bgcolor="#FFBBBB" |In 1 to Out 1
 +
 +
|-
 +
! bgcolor="#CCCCCC" |4
 +
| bgcolor="#FFBBBB" |In 1 to Out 2
 +
 +
|-
 +
! bgcolor="#CCCCCC" |6
 +
| bgcolor="#FFBBBB" |In 1 to Out 3
 +
 +
|-
 +
! bgcolor="#CCCCCC" |8
 +
| bgcolor="#FFBBBB" |In 1 to Out 4
 +
 +
|-
 +
! bgcolor="#CCCCCC" |10 - 16
 +
| bgcolor="#FFBBBB" |In 2 to Out 1 <br>...<br>In 2 to Out 4
 +
 +
|-
 +
! bgcolor="#CCCCCC" |18 - 24
 +
| bgcolor="#FFBBBB" |In 3 to Out 1 <br>...<br>In 3 to Out 4
 +
 +
|-
 +
! bgcolor="#CCCCCC" |26 - 32
 +
| bgcolor="#FFBBBB" |In 4 to Out 1 <br>...<br>In 4 to Out 4
 +
 +
|}
 +
 +
 +
<ul>
 +
<li>Each Mixer Control element is a gain value represented by a fixed point integer in 2.14 format</li>
 +
<li>For example:</li>
 +
  <ul>
 +
  <li>use 0x8000 to set the gain to 2.0 (+6dB)</li>
 +
  <li>use 0x4000 to set the gain to 1.0 (0dB)</li>
 +
  <li>use 0x2000 to set the gain to 0.5 (-6dB)</li>
 +
  <li>use 0 to mute</li>
 +
  </ul>
 +
<li>Care must be taken when using gain values greater than 1.0 (0dB) to avoid over-amplification resulting in clipping of the resultant signal</li>
 +
</ul>

Latest revision as of 14:52, 16 October 2019

Data can be passed from a client to an Eth8x8 through the Eth8x8 Control Interface. Packets are sent from the client to the Eth8x8 through a TCP/IP port. The following rules apply:

  • The Eth8x8 shall listen for TCP/IP connections on IP port number 33001
  • A maximum of 3 clients can simultaneously connect to the Control Interface port
  • All elements of each packet shall be in network byte order

The following sections define the packets that can be sent to the Eth8x8


Data Request

  • Each element of the Data Request Packet is a 16 bit integer
  • The first 16 bit word of the packet represents the unique identifier and must be equal to 0x100
  • A Status Packet with the requested data will be sent back to the client in response to each Data Request


Byte Offset Element
0 0x100
2 Unique Identifier of Requested Data


Mixer Control Packet 8 input x 8 output

  • Each element of the Mixer Control Packet is a 16 bit unsigned integer
  • The first 16 bit word of the packet represents the unique identifier and must be equal to 0x808


Byte Offset Element
0 0x808
2 In 1 to Out 1
4 In 1 to Out 2
6 In 1 to Out 3
8 In 1 to Out 4
10 In 1 to Out 5
12 In 1 to Out 6
14 In 1 to Out 7
16 In 1 to Out 8
18 - 32 In 2 to Out 1
...
In 2 to Out 8
34 - 48 In 3 to Out 1
...
In 3 to Out 8
50 - 64 In 4 to Out 1
...
In 4 to Out 8
66 - 80 In 5 to Out 1
...
In 5 to Out 8
82 - 96 In 6 to Out 1
...
In 6 to Out 8
98 - 112 In 7 to Out 1
...
In 7 to Out 8
114 - 128 In 8 to Out 1
...
In 8 to Out 8


  • Each Mixer Control element is a gain value represented by a fixed point integer in 2.14 format
  • For example:
    • use 0x8000 to set the gain to 2.0 (+6dB)
    • use 0x4000 to set the gain to 1.0 (0dB)
    • use 0x2000 to set the gain to 0.5 (-6dB)
    • use 0 to mute
  • Care must be taken when using gain values greater than 1.0 (0dB) to avoid over-amplification resulting in clipping of the resultant signal


Mixer Control Packet 4 input x 4 output

  • Each element of the Mixer Control Packet is a 16 bit unsigned integer
  • The first 16 bit word of the packet represents the unique identifier and must be equal to 0x404


Byte Offset Element
0 0x404
2 In 1 to Out 1
4 In 1 to Out 2
6 In 1 to Out 3
8 In 1 to Out 4
10 - 16 In 2 to Out 1
...
In 2 to Out 4
18 - 24 In 3 to Out 1
...
In 3 to Out 4
26 - 32 In 4 to Out 1
...
In 4 to Out 4


  • Each Mixer Control element is a gain value represented by a fixed point integer in 2.14 format
  • For example:
    • use 0x8000 to set the gain to 2.0 (+6dB)
    • use 0x4000 to set the gain to 1.0 (0dB)
    • use 0x2000 to set the gain to 0.5 (-6dB)
    • use 0 to mute
  • Care must be taken when using gain values greater than 1.0 (0dB) to avoid over-amplification resulting in clipping of the resultant signal
Retrieved from "https://emdee.com/wiki/index.php?title=Eth8x8_Control_Interface&oldid=12944"