Harkwood Services cmdBridge Reference Manual

Intelligent command protocol translation

Advertisement

Quick Links

Harkwood Services Ltd
Reference Manual
cmdBridge®
Intelligent command protocol translation

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the cmdBridge and is the answer not in the manual?

Questions and answers

Summary of Contents for Harkwood Services cmdBridge

  • Page 1 Harkwood Services Ltd Reference Manual cmdBridge® Intelligent command protocol translation...
  • Page 2: Fcc Class A Notice

    / loan stock. cmdBridge can also be deployed to extend the life of systems where the original control system source code is unavailable, or the system cannot be easily updated. For example, a complex room join requires new displays but the original source code is unavailable, cmdBridge can be deployed without the need to re-program the entire system.
  • Page 3: Document Conventions

    Document Conventi ons The following noti fi cati ons are used within this manual CAUTION Identi fi cati on of acti ons required to ensure correct operati on of equipment and prevent damage NOTE Provides informati on specifi c to a parti cular item Provides helpful informati on relati ng to operati on of confi gurati on Commands entered via the console end with a Carriage Return which is ASCII code 13 or 0x0D, as in the example below;...
  • Page 4: About This Manual

    Introduction About this manual This manual describes the installation, configuration, functions, and operation of cmdBridge. Features RS-232 Ports - Bi-directional RS-232 ports with optional hardware flow control. Presented on 3.5mm pitch phoenix connections. Ethernet Switch - Integral 2 port 10/100 Ethernet switch with Auto MDI-X automatic crossover support.
  • Page 5: Installation

    ② ④ ⑤ ① ① Console port - used to configure cmdBridge. NOTE Console port can also be used to supply power, no external PSU is required during configuration or deployment if the USB power source can supply 1A. NOTE Console port is a Serial over USB port, running at 230400 baud, 8 bits, no parity.
  • Page 6: Rear Panel Connections And Indicators

    ⑥ ⑨ ⑩ ⑥ Ethernet Switch - 2 port 10/100 Ethernet switch to connect cmdBridge to an Ethernet network. Both switch ports support MDI-X auto crossover. NOTE CAT5e shielded or CAT6 and above cables are recommended. The switch enables cmdBridge to installed in-line with equipment without the need to have an additional network port to be made available.
  • Page 7: System Configuration

    Command Line Interface (CLI) via the console port. Ge� ng Started Connect the Console Port ① to the computer used for confi gurati on, this will also power cmdBridge if no external Power Supply Unit (PSU) is available.
  • Page 8: Input Enable

    When a custom mac address is set, the LAN Led ④ will be blue to indicate a custom address is set when the network is acti ve. This enables cmdBridge to take the mac address of a device being replaced, negati ng the need to update a DHCP server that is stati cally assigning address by mac address.
  • Page 9 <config | all> Resets cmdBridge back to factory default. Confi g resets just the confi gurati on leaving stored translati ons intact. resets both the confi gurati on and all stored translati ons.
  • Page 10 When serial data is received or transmitt ed, the associated input/output LED will blink green. IP Ports (Ethernet) Source devices connect to the cmdBridge IP address and a specifi ed port number, using the command. input ip port <port> cmdBridge will connect to a Target device IP address and port, using the command;...
  • Page 11 Translati on fi les Translati on fi les enable a Source device to send commands to a Target device, with the data being translated en-route. Likewise Target device replies are translated into Source device replies. Multi ple replies per command are supported, combined with fl ags to send replies when certain circumstances are met. The full syntax can be found in Appendix A.
  • Page 12 Translati on data element Commands A Command consists of the data received from the source device (the source_cmd), if there is a match it is translated into the target command data (the target_cmd) and sent to the target device. If no match is found the source command is discarded. Target Command Source Command STATUS...
  • Page 13 A replacement device may support only a single global status request. Using variables to track the state of commands as they are received by cmdBridge, and conditi onal replies, such a situati on can be easily managed. default If a reply is received from the target device, and there is no other match found, then send this reply.
  • Page 14 conditional Send this reply if the specifi ed conditi on evaluates as true, even if no actual reply from the target device is received. command { desc = “Get Mute status”; source_cmd = “4D 55 54 45 3F 0D”; reply { desc = “Variable based reply, off”;...
  • Page 15 The complete example below shows how variables and conditi ons can be used to perform status tracking of events. desc = “EPSON EB-535W to NEX NP-M302WA (mute example)”; var mute = 0; command { desc = “Set Mute ON”; source_cmd = “4D 55 54 45 20 4F 4E 0D”; target_cmd = “02 10 00 00 00 12”;...
  • Page 16 Managing Translati ons Loading translati ons Translati ons can be loaded one of two ways; During confi gurati on from a USB memory sti ck inserted into port ②. If the fi le parsed without error, then the fi le is available for use. Files loaded directly from the memory sti ck are volati le and will not be loaded on a reboot.
  • Page 17: Monitor Mode

    Monitor Mode cmdBridge may also be used as a diagnosti c tool, enabling communicati on between a source and target device to be monitored. Data received is displayed, in real ti me, to the console port in ASCII and HEX, from the physically confi gured input and output ports.
  • Page 18: Firmware Update

    USB memory sti ck inserted into port ②. Firmware is uploaded with the command; sys firmware load <filename> Once the fi le has been verifi ed, cmdBridge will reboot and the fi rmware will be upgraded. This process cannot be interrupted. CAUTION Do not power off cmdBridge whilst the fi rmware is uploading.
  • Page 19: Troubleshooting

    This procedure should ONLY be performed if a normal firmware upgrade procedure is not possible. To recover cmdBridge from a failed or faulty firmware upgrade, this procedure may be performed to effect a total system reset. This will; Revert cmdBridge to the original factory shipped firmware image...
  • Page 20 Appendix A Translation file syntax The syntax for translation files is provided below as rail road diagrams. Translation desc quoted_string variable_name number source_commands source_commands command desc quoted_string source_cmd hex_data target_cmd hex_data variable_name set_variable_expression target_replies 20 of 24...
  • Page 21 target_replies reply desc quoted_string source_reply hex_data target_reply hex_data variable_name set_variable_expression flag always default conditional conditional_expression set_variable_expression number variable_name set_variable_expression set_variable_expression set_variable_expression 21 of 24...
  • Page 22 conditional_expression number variable_name conditional_expression conditional_expression && conditional_expression number digit hex_data <space> " " a-f A-F a-f A-F variable_name a-z A-Z a-z A-Z 22 of 24...
  • Page 23 quoted_string <printable character> " " 23 of 24...
  • Page 24 24 of 24...

Table of Contents