background image

 

Document type:

  

Last modified:

 

Page:

 

Based on template: ‘

Technical Documentation.dot

 

Technical Documentation  09-01-16 

Page 7 of 21 

File: ‘

NLB-60E communication protocol - Revision 2 DRFT 2A.doc

   

 

 

 

3  Addressing 

3.1  Addressing a bridge 

The bridge is addressed using its IP-number. For fixed installations relying on static IP 
addresses it is highly recommended that bridges have fixed IP addresses instead of using 
DHCP. 

3.2  Addressing an amplifier 

An individual amplifier is addressed using its ‘Virtual Device Name’ (VDN). This is a user 
configurable name that is being held by the bridge (see Virtual Device Name Management in 
chapter 6) that corresponds to a specific amplifiers’ serial number. Thus, if an amplifier is 
replaced only the VDN table needs to be altered in order to make the system work properly 
again for that particular device. The bridge can contain up to 60 ‘virtual device names’. 
Observe that a serial number should only be associated with 

one

 VDN and all VDNs should 

be unique. 

A ‘virtual device name’ can contain up to 10 alphanumerical characters and special characters 
where the allowed characters are: 

 

A..Z, 0..9, ‘@’, and ‘-‘ 

Please observe that whitespaces, and the string ‘Subnet’ is not allowed in VDNs. 

Example of valid names are: 

“B1-zone2-1” 

“B01-Z-2-1” 

“B1@Zone2-1” 

“Bldg1Zone1”

  

Where as the following is not allowed: 

“Building 1-zone 2-1”

 (contains a whitespace and too many characters) 

4  Message overview 

The commands are divided into two main categories: device messages and subnet messages. 
As the names indicate they addresses either a single amplifier or all amplifiers in the subnet. 
To address the connected subnet, the address context should be “subnet” and to address a 
specific amplifier within that subnet the amplifiers’ VDN is used as context. 

The reply to any “set” message (=) is the same as the reply for the “get” operation (?) 
hence status is always returned in the same format as if the parameter’s value was 
queried. 

All 3

rd

 party messages follow the same layout, requests as well as replies. They are all 

alphanumerical 

case insensitive

 strings which are terminated with a newline (CR+LF). 

Address 

Context.Parameter

 

Operation

 

Value(s) 

[Subnet/VDN] 

[Parameter] 

=  

To set a value 

?  

To get a value 

[Value] 

Table 1 - Message format 

Summary of Contents for NLB 60E

Page 1: ...File NLB 60E communication protocol Revision 2 DRFT 2A doc Modified Jan 16 2009 Page 2 of 21 NLB 60E Third Party Integration Protocol Description Revision 2 Date January 16 2009 Revision 2A...

Page 2: ...5 2 4 Subnet Status 11 5 2 5 Subnet Serial at Position 12 5 3 DEVICE MESSAGES 12 5 3 1 Power 12 5 3 2 Mute 13 5 3 3 Mute Status 14 5 3 4 Status 15 5 4 VIRTUAL DEVICE NAME MANAGEMENT 16 5 4 1 Subnet VD...

Page 3: ...logy Acronyms Device Control Lab gruppen application for control and monitoring of a NomadLink network GPI General Purpose Input ports on the back of NLB 60E that can trigger certain actions on the No...

Page 4: ...protocol in this document is both an extension and a revision of the previous 3rd party protocol for the NLB 60E The following is a short summary of controllable and monitorable parameters Mute Un mut...

Page 5: ...connection would never block newer incoming 3rd party connections The NLB 60E can only be connected to one control application at the same time e g DeviceControl or a 3rd party control client Althoug...

Page 6: ...me can contain up to 10 alphanumerical characters and special characters where the allowed characters are A Z 0 9 and Please observe that whitespaces and the string Subnet is not allowed in VDNs Examp...

Page 7: ...racter Subnet Mute 1 The reply would then be also ending with a newline character 1 to indicate that it was successfully changed hence new status is 1 And to get current subnet mute status simply send...

Page 8: ...evice Control is connected a Device control is currently connected i e not accepting 3rd party messages 5 ERROR Channel number is out of range a The channel that was referred to was outside the range...

Page 9: ...DRFT 2A doc 5 2 2 Subnet Mute Sets gets subnet mute control mutes or un mutes all devices in the subnet Address Op Value 0 Un mute subnet 1 Mute subnet Reply Subnet Mute 0 Subnet is un muted 1 Subnet...

Page 10: ...open loop 0 GPI1 is low 1 GPI1 is high 0 GPI2 is low 1 GPI2 is high 0 GPI3 is low 1 GPI3 is high Power status 0 All devices are off 1 All devices are on 2 Mixed some are on and some are off 3 In trans...

Page 11: ...work Serial number Note If no amplifier is present at the position in the subnet topology that is addressed zero is returned as serial number Examples Getting the serial number for device at position...

Page 12: ...of 21 File NLB 60E communication protocol Revision 2 DRFT 2A doc 5 3 2 Mute Set get mute control for an individual channel Address Op Value 0 Set to un muted 1 Set to muted Reply VDN MuteX Where X is...

Page 13: ...Un muted 1 Muted Mute status for channel B 0 Un muted 1 Muted Mute status for channel C 0 Un muted 1 Muted Mute status for channel D 0 Un muted 1 Muted Mute status for channel E 0 Un muted 1 Muted Mut...

Page 14: ...nel X as a negative dB number relative max output level Possible values are 100 silent 44 29 28 1 and 0 is VPL clip 0 VPL clip for channel X not active 1 VPL clip for channel X active 0 CPL for channe...

Page 15: ...ministration of the VDN table should normally be done using the VDN Manager application see Chapter 6 Address Op Values values from top to bottom VDN Virtual device name SN Serial number to be associa...

Page 16: ...The VDN Manager application The VDN application is a stand alone program that is not part of the DeviceControl software package It can be found and downloaded from our website at www labgruppen com su...

Page 17: ...Revision 2 DRFT 2A doc 6 3 Adding devices to the virtual device name table 6 3 1 Adding devices that are present on the NomadLink network 1 2 1 Select the devices that shall be added to the virtual de...

Page 18: ...Edit the virtual device name by selecting the cell and typing the desired name The name must a only include characters A Z a z 0 9 and b not start with the name Subnet c be 1 to 10 characters in lengt...

Page 19: ...ot present on the NomadLink network 1 2 2 3 1 Click on the row marked by a star to add a new entry to the virtual device name table The Position column will state Missing for the new entry since it is...

Page 20: ...be a replacement for the missing device 3 Press the Replace button to replace the serial number of the missing device with that of the selected unassigned device The selected unassigned device will no...

Reviews: