READ

Chyron Knowledge Base
Intelligent Interface
Troubleshooting for Automation, Elections & Sports
January 17th, 2010
“II Update” vs. “EXT Update”
• Updatable elements* can be tagged as
either II Update or EXT Update.
*2D/3D Template Fields, 2D Graphics, Textures on 3D Objects, and Movie Objects.
II Update
• II Update is a one-way “data dump”
from a data source to the Chyron.
II Update
Common Sources:
• NRCS (iNews, ENPS, Dalet, etc.)
• Elias (Sports Biographical Data)
• Avid LeaderPlus (Elections)
II Update
Lyric messages are created via the
“Write (W) Command.”
Example:
W\101\100\FIRST NAME\LAST NAME\\
This example creates a Template Data Message at page
101, based on message number 100 and populates two
template fields.
II Update
Notes:
- “Machine Code” only important in event of multiple Chyrons controlled from a single system.
- If IGNORING MACHINE CODE (in Lyric), V Command must be <UPPER CASE>.
- If USING MACHINE CODE (in Lyric), V Command must be <lower case>.
EXT Update
(COM1 or Telnet ONLY!)
• EXT Update is a two-way query/return
between the Chyron and data source.
EXT Update
(COM1 or Telnet ONLY!)
Common Source:
• SportsMedia (Dynamic In-Game Stats)
• An “X Command” is sent from the Chyron
to the source computer, which responds
with data returned via the “R Command.”
• Returns dynamic data, e.g. scores.
Recall: The V Command
Lyric messages are recalled via the
“Read (V) Command.”
Example:
V\5\3\1\1\5000\0\\
This example reads message 5000 to the preview
(canvas) of Frame Buffer 1.
Recall: The V Command
Notes:
- “Machine Code” only important in event of multiple Chyrons controlled from a single system.
- If IGNORING MACHINE CODE (in Lyric), V Command must be <UPPER CASE>.
- If USING MACHINE CODE (in Lyric), V Command must be <lower case>.
CONNECTION TYPES:
Telnet (TCP/IP) vs. Serial
SERIAL PROs & CONs
☺ Always On
-When the computers are on, the connection is “hot.”
Requires special “null modem” serial cable
-Often times a bad/incorrect cable is the culprit.
Manually manage COM PORT settings
-Must manually set baud rate, stop bits, parity, etc.
CONNECTION TYPES:
Telnet (TCP/IP) vs. Serial
TELNET PROs & CONs
!!! Not always On
-When a computer reboots or a program re-launches, the
connection must be re-established each time from the data
source computer.
☺ Communication settings
-Settings are handled by Windows.
US or THEM:
Testing Intelligent Interface via HyperTerminal
It is not uncommon to encounter errors or non-responsiveness when
initially setting up Intelligent Interface with a NRCS or with
automation control. Unfortunately, when errors are encountered,
there is a tendency to point at the Chyron.
It is therefore useful to know how to troubleshoot communication
and scripting errors manually. This can be accomplished easily and
from nearly any computer.
US or THEM:
Testing Intelligent Interface via HyperTerminal
Conducting a test of Intelligent Interface is easy! The test will require
just a few supplies:
1)
2)
3)
4)
5)
Chyron
Lyric message with at least one II tagged Template Field
Null modem (serial) cable supplied by the client
Laptop or a PC with a serial port
Pre-printed II materials already available:
- II_Commands.pdf, II_Error_Codes.pdf and *II_Pinout.pdf
*If an engineer needs to make a cable from scratch.
US or THEM:
Testing Intelligent Interface via HyperTerminal
Setup:
1) Attach COM1 one of the Chyron to the other PC via the null
modem cable.
2) On the Chyron, take note of the COM1 settings
- Go into Device Manager (right click on My Computer > Manage)
- In “PORTS (COM & LPT),” right click on COM1 > Properties >
Port Settings and take note of the settings
- i.e.: BAUD Rate, Data Bits, Parity, Stop Bits, Flow Control
3) Launch Lyric and enable II on COM1.
US or THEM:
Testing Intelligent Interface via HyperTerminal
4) On the PC launch
HyperTerminal
Start > Programs >
Accessories >
Communications>
HyperTerminal
US or THEM:
Testing Intelligent Interface via HyperTerminal
5) Give the new
connection a
description,
e.g. “Chyron II Test.”
Click ‘Okay.’
US or THEM:
Testing Intelligent Interface via HyperTerminal
6) Connect using COM1
Click ‘Okay.’
US or THEM:
Testing Intelligent Interface via HyperTerminal
7) Make the Port
Settings match those of
the Chyron:
Example
BAUD:
Data Bits:
Parity:
Stop Bits:
Flow Control:
Click ‘Okay.’
9600
8
None
1
Hardware
US or THEM:
Testing Intelligent Interface via HyperTerminal
8) Click
File >
Properties >
Settings >
[ASCII Setup]
US or THEM:
Testing Intelligent Interface via HyperTerminal
9) Check
“Send line ends with
line feeds.”
“Echo typed
characters locally.”
Click ‘Okay’ and
‘Okay’ again.
US or THEM:
Testing Intelligent Interface via HyperTerminal
The same test may be run via Telnet by:
1) Making sure that the Chyron and data source PC are on
the same network.
2) Enabling TELNET in Lyric’s II Config (disable COM1).
3) Configuring the HyperTerminal to connect to the Chyron
via TCP/IP (Winsock)
4) Entering the Chyron’s IP address and connecting thru
Port 23.
US or THEM:
Testing Intelligent Interface via HyperTerminal
If the serial cable is good, and if the settings are correct on both
ends, the PC and the Chyron are now connected. When sending the
command, remember that if “IGNORE MACHINE CODE” is checked in
Lyric’s II configuration, the commands must be issued in ALL CAPS.
In HyperTerminal, type the following command:
V\5\3\1\1\########\0\\
Hit [ENTER]
If successful, this will READ the message to PVW (Canvas) of FB1
######## = Message number. Leading zeroes are not required.
US or THEM:
Testing Intelligent Interface via HyperTerminal
If the command is successful, in addition to the page appearing on
the Canvas, a return code or acknowledgement (*) will appear in
the HyperTerminal window.
If a code is returned to the HyperTerminal window, but the Lyric
message does NOT display on canvas, an error has occurred. The
error code in the HyperTerminal window may be compared with the
“II_Error_Codes.pdf” to find the source of the problem.
US or THEM:
Testing Intelligent Interface via HyperTerminal
Next, test the creation of a message that has two template fields
checked for II update.
In HyperTerminal, type the following command:
W\####\####\Text for Template0\Text for Template1\\
Hit [ENTER]
If successful, this will return an acknowledgement to HyperTemrinal. If not, an
error will be returned and can be compared to “II_Error_Codes.pdf.”
The first \####\ is the destination; the new page to be created.
The second \####\ is the source; the template page to be used.
US or THEM:
Testing Intelligent Interface via HyperTerminal
After the new message is created, recall it via the V command, and
play it to air via PLAY command. There are two primary V\6 play
commands: Synchronous & Asynchronous (follow with [ENTER]).
V\6\1\\ (Synchronous): Plays the message on canvas to air and
waits for message completion before allowing the Chyron to process
subsequent commands (this is often a problem when looping and/or
persistent messages are used in Lyric playout).
V\6\1\1\\ (Asynchronous): Plays the message on canvas to air
and allows the Chyron to process subsequent commands
immediately.
COMMON ISSUES:
“Gotchas Associated with II Update”
Assuming that II is connected and working, here are some common
symptoms and potential causes & solutions:
Symptom:
A Lyric message is played to air. Then the Chyron seems to become
non-responsive to subsequent II commands. As soon as the output
is cleared, the Chyron rapidly starts executing buffered II
commands.
COMMON ISSUES:
“Gotchas Associated with II Update”
Assuming that II is connected and working, here are some common
symptoms and potential causes & solutions:
Likely Cause (Serial):
The message contains a looping element and does not return a
“completed state.” The synchronous V\6\1\\ command was used
to initiate playout and is now waiting for completion before allowing
the Chyron to continue processing incoming commands.
Solution (Serial):
Change the PLAY command to asynchronous V\6\1\1\\.
COMMON ISSUES:
“Gotchas Associated with II Update”
Assuming that II is connected and working, here are some common
symptoms and potential causes & solutions:
Likely Cause (Telnet):
Telnet prevents the system from attempting to process II
commands before the previously received II command completed,
thus causing Lyric to queue an incoming command until the previous
command has been executed.
Solution (Telnet):
Check NON-BLOCKING TELNET in Lyric’s II Configuration.
COMMON ISSUES:
“Gotchas Associated with II Update”
Assuming that II is connected and working, here are some common
symptoms and potential causes & solutions:
Symptom:
While the base message is verified as created, II tagged, and in the
proper directory, the Chyron returns consistent error code: 412C
(“Requested Description File is not a Tab Description File”). This is
the same as Lyric’s error: “Not a valid Template Description
Message.”
COMMON ISSUES:
“Gotchas Associated with II Update”
Assuming that II is connected and working, here are some common
symptoms and potential causes & solutions:
Likely Cause:
In Lyric’s Preferences > Default Paths, the TEMPLATES folder is
checked, which is causing the Chyron to look for the description
message outside the MESSAGES directory.
Solution:
Uncheck the TEMPLATES folder, OR copy the base message to the
TEMPLATES folder in the directory structure.
COMMON ISSUES:
“Gotchas Associated with II Update”
Assuming that II is connected and working, here are some common
symptoms and potential causes & solutions:
Symptom:
When W commands are used to create messages, file paths appear
in text template fields and images are not updated correctly.
COMMON ISSUES:
“Gotchas Associated with II Update”
Assuming that II is connected and working, here are some common
symptoms and potential causes & solutions:
Likely Cause:
Lyric processes graphics updates first, followed by text updates. If
incoming command strings are in any other order, information will
be pushed to the wrong destinations.
Solution:
Re-order command strings. If using Avid LeaderPlus, implement
“II Translator.”
COMMON ISSUES:
“Gotchas Associated with II Update”
Assuming that II is connected and working, here are some common
symptoms and potential causes & solutions:
Symptom:
Commands and messages have been manually tested and verified,
but when “II Translator” is in use for Avid LeaderPlus, the Chyron is
not responding to commands OR the template data is still out of
order.
COMMON ISSUES:
“Gotchas Associated with II Update”
Assuming that II is connected and working, here are some common
symptoms and potential causes & solutions:
Likely Cause:
“II Translator” is hard-coded to use COM1. If COM2 or Telnet is in
use for II, the commands will be ignored by “II Translator” and will
be processed out of order.
Solution:
Re-cable Chyron from COM2 or Telnet to COM1.
COMMON ISSUES:
“Gotchas Associated with II Update”
Assuming that II is connected and working, here are some common
symptoms and potential causes & solutions:
Symptom:
Command strings are in the correct order. “II Translator” is not in
use, but graphics are still being updated in the incorrect order.
COMMON ISSUES:
“Gotchas Associated with II Update”
Assuming that II is connected and working, here are some common
symptoms and potential causes & solutions:
Likely Cause:
In the current scheme of II update, graphics are updated in the
order they appear in the Scene Graph, from top down, regardless of
grouping. If “Classic II Ordering” is checked, graphics will update in
the order they were created, regardless of Scene Graph position.
Solution:
Check or uncheck “Classic II Ordering” in Lyric’s II configuration.
COMMON ISSUES:
“Gotchas Associated with II Update”
Assuming that II is connected and working, here are some common
symptoms and potential causes & solutions:
Symptom:
While using Telnet, the Chyron stops responding to II commands.
This is especially common in the truck environment when using
SportsMedia.
COMMON ISSUES:
“Gotchas Associated with II Update”
Assuming that II is connected and working, here are some common
symptoms and potential causes & solutions:
Likely Cause:
Telnet sessions are NOT “always on” like serial connections. If Lyric
is restarted by the operator, the Telnet connection is broken and
must be re-established from the data source computer. Because of
this, many SportsMedia operators prefer serial connection.
Solution:
Re-establish Telnet session or change connection to serial (COM1).
SO MUCH MORE:
Other Types of II Commands
This document shows how to troubleshoot the major connection and
playout issues facing Intelligent Interface using a few basic kinds of
commands: W commands & V commands and, to a lesser extent, X
& R Commands.
A variety of other commands exist for addition functionality, such as:
- B Commands: Channel Box Commands
- E Commands: Run VB Macro
- M Commands: Change Directory
- U Commands: Update Specified Template Field(s)
- Y Commands: Assorted
Many more can be found in “II_Commands.pdf”
Y COMMANDS:
“I Put a Hex on You”
Y- Commands can perform a variety of functions, including: XFER,
Play Animation, Stop Animation, Clear FB, Select FB, etc.
Working with Y Commands is a little tricky, because Lyric’s Help file
lists all of the commands in hexadecimal. An associated document
called “II_Y-Commands.pdf” demystifies this and translates the hex
to decimal and ASCII to make testing easier.
It is important to be careful about mixing Y commands and V
commands. Messages played with a V command CANNOT be
stopped via Y command. Only messages played with a Y command
can be stopped with a Y command.
SUPPORTING DOCUMENTS:
“II_Commands.pdf” – A list of all II commands for Lyric.
“II_Graphics.pdf” – How to update graphics via II.
“II_Y-Commands.pdf” – Working with special Y commands in
hexadecimal, decimal and ASCII.
“II_Pinout.pdf” – The pinouts for a null modem serial cable, in the
event that an engineer needs to create the cable from scratch.
“II_Error_Codes.pdf” – A list of all II error codes used for
troubleshooting problems via HyperTerminal or Lyric’s II diagnostic.
Documents available at:
Chyron’s KNOWLEDGE BASE, Keywords: II SUPPORT