Programming Design Kit
Programming Design Kit
Programming Design Kit
Crestron, the Crestron logo, Crestron Home, ADMS Intermedia Delivery System, Cameo, Cresnet, DigitalMedia, DigitalMedia 8G, e-Control, TouchPoint , V-Panel,
VisionTools Pro-e and VT Pro-e are either trademarks or registered trademarks of Crestron Electronics, Inc. in the United States and/or other countries. Acrobat,
Adobe, and Flash are either trademarks or registered trademarks of Adobe Systems Incorporated in the United States and/or other countries. Blu-ray Disc is either
a trademark or registered trademark of the Blu-ray Disc Association (BDA) in the United States and/or other countries. HDMI is either a trademark or registered
trademark of HDMI Licensing LLC in the United States and/or other countries. Excel, Internet Explorer, PowerPoint, Windows, Windows Media Player and Word
are either trademarks or registered trademarks of Microsoft Corporation in the United States and/or other countries. Other trademarks, registered trademarks
and trade names may be used in this document to refer to either the entities claiming the marks and names or their products. Crestron disclaims any proprietary
interest in the marks and names of others. Crestron is not responsible for errors in typography or photography.
This document was written by the Technical Publications department at Crestron.
2013 Crestron Electronics, Inc.
Contents
Introduction 1
Managing Expectations
Programming Software
Sound....................................................................................................................................................................2
Background Images...............................................................................................................................................2
Bit Depth and File Size...........................................................................................................................................2
Project Planning
12
19
Crestron Engraver
20
21
29
34
Web Objects........................................................................................................................................................40
41
45
52
Typeface (Fonts)..................................................................................................................................................52
Lower-case versus Upper-case Characters..........................................................................................................54
Font Height (Type Size)........................................................................................................................................55
List of Typography Design Recommendations......................................................................................................57
Acknowledgements.............................................................................................................................................57
Further Inquiries
ii
57
Introduction
Crestron connects people with technology. As products and systems become more complex, our touch screens
and keypads streamline and simplify technology so people can fully utilize and enjoy its advantages. Crestron
touch screens and keypads provide an intuitive way for people to interact with and experience the systems in their
homes, offices, schools and churches. Using touch screens, individuals can create a comfortable environment, set a
mood, and benefit from technology.
Managing Expectations
The key to designing a successful user interface is having a clear vision of the project, space, subsystems, the
customers desires and expectations all of which dictate functionality. It is vital to know the functions to be
controlled and have a clear vision from the end user regarding system use.
Will the touch screen interface with subsystems such as lighting, HVAC, and security?
How does the customer want the zones divided and controlled for lighting, audio, and video?
Does the customer expect complex lighting, water, and climate control events and scenarios, or do they
just want to turn lights on and off?
It is equally important to evaluate the level of technical sophistication that the end user possesses. The programmer
must work within the customers abilities while striving to meet expectations. If the customer is pushed beyond
their comfort zone, then the system will be unappealing to the client, resulting in disappointment and/or
intimidation. Managing expectations is extremely important and knowing when and why to say no is critical to the
success of any given project. If there are too many buttons on a page, reorganize or reprioritize the subcategories
to reduce the number of buttons per page. The number of buttons that can comfortably be positioned on a screen
is determined by the physical size of the touch screens. Therefore, a more attractive, intuitive, easy-to-read and
use interface is achieved with a larger touch screen. The ideal number of button presses to affect an event from
anywhere in the GUI is one to three. Reducing navigation, button presses, and subpages for the end user makes the
interface more useful and attractive. When designing a custom interface, start by talking to the customer about the
dcor of the room, corporate image, or favorite colors. It is essential to understand how the interface is intended to
complement or match the clients dcor and environment.
Programming Software
VisionTools Pro-e (or VT Pro-e) is the Crestron Windows-based software for designing the page layouts and
functionality of user interfaces. Controls are grouped together on pages and these control pages are organized
and grouped together as a project. A typical page layout includes objects such as buttons and sliders that start
actions and provide feedback to the end user. Pages can also include video windows, decorative graphics,
background graphics, text and a variety of other objects. A page flip causes the screen to switch from one page
to another when a button is pressed. Browser projects also support page flips to a URL, or even to a different
section of the current (large) page. Subpages are similar in many ways to standard pages, in that they may
contain buttons, text, graphics, etc. However, subpages ordinarily do not take up the entire display area. Instead, a
subpage often defines a small area with buttons serving a specific function, such as VCR control. A subpage can be
designed to appear on top of a standard page at any time and then disappear when no longer needed. VisionTools
Pro-e software enables layering of objects on top of each other, allowing for versatile design possibilities. Objects
are layered in the order they are created. That is, a newly created object will be overlaid onto an existing one, and
if one object is dragged over to another, the more recently created object is visible on top. Refer to Appendix B for
an example program.
Doc. 5277J | crestron.com
Background Images
VisionTools Pro-e supports BMP, PCX, DIB, and JPEG formats. Images can be modified to fit the page. The Tile
option fills the space on the page with multiple copies of the image (This feature works best with smaller images).
The Stretch to Fit option stretches out the image to fill the entire page.
Number of Colors
Black and White
4 Colors
16 Colors
256 Colors
65,536 Colors (Highcolor)
16.7 million Colors (Truecolor)
16.7 million Colors plus Transparency
When creating a VisionTools Pro-e project, elect to compress and reduce the image size in the Page Properties
window for the entire page and/or perform the same function of reducing the image size using the Image
Properties window. A reduction in image size saves a considerable amount of memory space for the project.
In VisionTools Pro-e, the Compress checkbox permits the image to be compressed when compiling. The 16 Bits
checkbox converts a 24-bit or 32-bit image to 16 bits. This conversion to a 16-bit image may cause the loss of
some subtle shading. To compensate for this, use the dithering to simulate the original shading. Various dithering
types are available.
Project Planning
Planning the project carefully produces good results. This involves providing complete information on the required
forms. This kit contains forms to fill in to define the project.
Form A is a complete list of all equipment to be controlled.
Form B defines the customer interface.
Form C defines the routing of source to destination.
Form D provides a method to specify button panel operation and engraving.
Additional forms are provided for lighting control.
10
11
12
Gestures Navigation
Adjust AV and lighting settings, surf the Internet, and browse the music and movie libraries with a natural sweep of
the finger using DNav gestures. Crestron DNav technology affords enhanced touch screen functionality, providing
dynamic navigation control objects for scrolling effortlessly through all touch screen apps, cover art, and favorite
channels.
Embedded PC
The DGE-1's embedded PC engine combines touch screen graphics with built-in Windows Media Player and
RealPlayer, Internet Explorer, Adobe Acrobat Reader, and Microsoft Word, Excel, and PowerPoint document
viewers. While simultaneously controlling the home, boardroom, or lecture hall, the DGE-1 provides everything
needed for enjoying online music and movies, viewing Web pages and accessing most types of digital media
without necessitating a separate computer. In addition, VNC Viewer support delivers enhanced cross-platform
interaction with computers over the network or Internet, allowing remote access and control of desktop applications
to unleash all kinds of new presentation and system integration possibilities.
Full-Motion Video
The DGE-1 supports the display of standard-definition video from an external composite or S-Video source. The
video image can be displayed full-screen or in a fully scalable window anywhere on the V-Panel touch screen.
External audio signals are handled by a single analog line input.
Streaming Video
Through its embedded Web browser and media players, the DGE-1 supports streaming and downloadable video
in a variety of formats, enabling access to all kinds of media from online sources and network servers. Additional
support for the motion-JPEG streaming format allows the display of live video from a Web camera or network video
streamer (Crestron CEN-NVS100, CEN-NVS200, or equivalent).
13
Remote Annotation
Remote annotation capability allows multiple touch screen users to draw with their fingertips over the same
video image or whiteboard screen, enabling enhanced interaction between several participants in a courtroom,
classroom, or council chamber.
14
But, the power of Core 3 extends beyond impressive graphics and animated objects,unleashing
tremendous new capabilities for controlling devices and managing acomplete integrated system. Using
the Core 3 SDK, programmers can develop fully functioning "device apps" that can be dropped into
each touch screen project without additional programming or resizing. Or, choose from an expanding
library of fully developed device apps to instantly add controls for security systems and HVAC, provide
sophisticated navigation for media servers and tuners, and enable user friendly editing of lighting scenes
and channel presets. With Core 3, the possibilities are virtually limitless.
Embedded PC
The DGE-2's embedded PC engine combines rock solid touch screen graphics performance with
built-in Windows Media Player, Internet Explorer, Adobe Acrobat Reader, and Microsoft Word, Excel, and
PowerPoint document viewers. While simultaneously controlling the home, boardroom, or lecture hall,
the DGE-2 provides everything needed for enjoying online music and movies, viewing Web pages and
accessing most types of digital media without necessitating a separate computer. In addition, VNC Viewer
support delivers enhanced cross-platform interaction with computers over the network or Internet,
allowing remote access and control of desktop applications to unleash all kinds of new presentation and
system integration possibilities.
Dual-Window HD Video and RGB
The DGE-2 can simultaneously generate two fully-scalable, full-motion video windows, each supporting
standard video, HDTV, and high-resolution RGB signals from external AV and computer sources. Input
connections include two HDMI, two analog RGB, and two multi-format analog video. The HDMI inputs
support digital HD sources including HDMI, DVI, and DisplayPort Multimode[4]. The RGB inputs handle
high-resolution analog VGA computer sources, and the multi-format video inputs accept analog
composite, S-Video, and component HD video sources. External audio signals are handled by the HDMI
inputs, and by a single analog line input.
HDCP Support
Industry-leading support for HDCP (High-bandwidth Digital Content Protection) ensures seamless
compatibility with content-protected DVD, Blu-ray Disc, digital HDTV, and multimedia computer sources.
15
16
17
18
19
Crestron Engraver
The Crestron Engraver allows the user to create projects for engraveable interfaces such as Crestron touch screen
hard buttons, keypads, lighting controls, and FlipTop devices. These interfaces provide engrave-able text areas on
the buttons, and sometimes, on the faceplates.
Button caps are laser-engrave-able using the Crestron Engraver software; spacers are not engrave-able. The
engraving software provides up to three fields for each button cap to allow for the left/right and center press
functions, permits multiple lines of text, and also allows the user to specify the orientation of each button cap.
Use the Engraver to assign text, combine and un-combine buttons, exclude buttons, and add decorative borders.
Send the completed engraving project to Crestron via email for quick processing using the latest high quality laser
engraving technology. The new Crestron engraving software and equipment offers a more streamlined process that
allows for the delivery of finished buttons within 2-3 business days.
The Crestron Engraver allows the user to create cutout projects for non-engrave-able devices such as Crestron
switchers and control modules. These devices provide plastic slots where labeled strips can be inserted to identify
the push buttons on the unit. Use the Engraver to create and print the labeled strips that are properly formatted and
sized for the device. Simply cut the strip from the printout using the cut marks as a guide, and insert the strip into
the plastic slot.
For engrave-able devices such as Crestron keypads and touch screens, use the Crestron Engraver to:
Select the color and finish of the faceplate and trim.
Combine and un-combine button caps and engrave-able text areas.
Exclude button caps.
Assign text and decorative borders to buttons and engrave-able text areas.
Once the engraving project is created, send it directly to Crestron via email for quick processing using the latest
laser engraving technology. For non-engraveable devices, use the Engraver to design and print cutout labels that
are correctly formatted and sized for insertion into the plastic slots on the unit.
20
The switch caps have white LED backlighting that is programmable from 0 to 100% intensity as well. True
backlighting is not practical in certain circumstances, such as when using black switch caps. Instead, the program
can use the feedback LEDs to perform a backlighting function, turning them all on but at a fixed percentage of their
active state intensity.
21
22
23
24
25
26
27
Model Number
B10-BTNB-T 5 Blank
B10-BTNB-T 5 Engraved
B10-BTNW-T 5 Blank
B10-BTNW-T 5 Engraved
Description
Blank Buttons, Black
Engraved Buttons, Black
Blank Buttons, White
Engraved Buttons, White
Form J - HTT-B10X
28
29
30
31
32
33
34
35
36
37
38
39
Web Anchor
A Web anchor allows the Web browser to jump to a different section of the current HTML page - either when a
button or hit point is clicked - while giving the appearance to the user that an entirely different page is being
displayed. In this way a single HTML page can be designed that downloads once, rather than a number of pages
that each take time to download.
Web Marquee
A Web marquee displays scrolling text within a framed box.
Web Dial
A Web dial enables the mouse pointer to control and adjust analog values such as lighting levels, audio volume and
temperature.
XPanel Projects
Within VT Pro-e, Crestron touch screen GUI design software, there are four XPanel options. All are compatible with
any Ethernet-equipped 2 or 3-Series control system, which support DHCP/DNS for the ultimate integration of IT
and AV.
XPanel EXE - provides ultra fast and secure control through an executable application rather than web
pages. The runtime executable loads directly onto one or more specific computers and runs from the
desktop or start menu.
XPanel IE - provides web browser based control using ActiveX to attain true Crestron touch screen
behavior.
XPanel PDA - brings the power of e-Control to any Pocket PC 2002 device. XPanel PDA delivers benefits
similar to XPanel EXE on smaller PDA and Table PC formats.
XPanel Emulator - allows the control system programmer to easily generate an executable file that
emulates the entire flow and function of an Isys touch screen or e-Control 2 XPanel project on any
Windows PC.
40
Location
Ktichen
CNX-B6 Keypad
Patio
Great Room
Office
Dining Room
Controlled Equipment
Location
CD Jukebox
Equipment Room
DSS Receiver
Equipment Room
Equipment Room
Equipment Room
Equipment Room
41
42
The buttons are easily programmed in SystemBuilder. The following touch screen programming example was
created using the gel blue.vtt template in VT Pro-e. When a template is applied, the user can select from a list of
Project Graphic Resources to maintain professional consistently and usability throughout the design process.
43
44
45
Color Perception
Warm colors (reds, and yellows) appear to be in front of cool colors (blues and violets). The warm colors seem
to advance or be on top of or in front of the receding cool colors. In addition, there are other psychological
components to color. Red is the color of fire and blood, so it is associated with energy, war, danger, strength, power,
determination as well as passion, desire, and love.
Red is a very emotionally intense color. Red brings text and images to the foreground. Use it as an accent color to
stimulate people to make quick decisions. Red is widely used to indicate danger.
Orange combines the energy of red and the happiness of yellow. It is associated with joy, sunshine, and the
tropics. Orange represents enthusiasm, fascination, happiness, creativity, determination, attraction, success,
encouragement, and stimulation. To the human eye, orange is a very hot color, so it gives the sensation of heat.
Orange is not as aggressive as red. Orange has very high visibility, use it to catch attention and highlight the most
important elements of the design.
Yellow is the color of sunshine. It is associated with joy, happiness, intellect, and energy. Yellow produces a
warming effect, arouses cheerfulness, stimulates mental activity, and generates muscle energy. Yellow is often
associated with food. Bright, pure yellow is an attention getter, which is the reason taxicabs are painted this color.
Yellow is seen before other colors when placed against black; this combination is often used to issue a warning.
Yellow is very effective for attracting attention, so use it to highlight the most important elements of the design.
Light yellow tends to disappear into white, so it usually needs a dark color to highlight it. Shades of yellow are
visually unappealing because they loose cheerfulness and become dingy.
46
Color Harmony
Harmony is a set of colors that are pleasing to the eye, creating a sense of order and balance. The visual task of
screen design requires a logical structure. Color harmony delivers visual interest, a sense of order, and creates
a dynamic visual equilibrium. Inharmonious color schemes are either dull or confused. At these extremes of bad
design are a bland uninteresting display or an overdone, chaotic display that repulses the viewer.
47
48
49
Specifying Colors
Color properties are specified by a set of associated number values.
50
NOTE: If large areas of a light hue are used, the whole screen will appear light; conversely, if large areas of dark
values are used, the whole screen appears dark.
When fully saturated complements are brought together, interesting effects are noticeable such as vibrating
boundaries. This may be a desirable illusion, or a problem if creating visuals that are to be read. An occurrence
known as simultaneous contrast (chromostereopsis) happens when opposing colors are placed in close proximity.
Text may appear to vibrate, or cast a shadow.
When creating visuals that are designed for reading, the viewer must have adequate contrast between the background and the text. Text presentations ideally offer at least an 80% contrast between figure and ground (black text
on a white background is ideal). When there is not enough contrast between figure and ground, the viewer must
squint to read the text, causing eye fatigue. Yellow text on a white background or blue text on a black background,
are difficult to read due to the low level of contrast between figure and ground.
51
Typeface (Fonts)
Typefaces or fonts refer to the style of the alphanumeric. There are over 2300 typefaces currently available. The two
major groups of fonts are roman and sans serif. Roman is well known since it is used in newspapers, journals, and
books. Sans serif is a contemporary font that does not include the little strokes (serifs) that project horizontally from
the top or bottom of a main stroke.
Several researchers have reported that when other typographical factors are controlled, sans-serif fonts are more
legible than roman. The premise behind this statement is that absence of serifs presents a more simple and clean
typeface, and therefore improves the legibility of the print. Serifs disrupt character discrimination and may add
uneven appearance to the shape of strokes and characters. However, it is also evident that they somewhat aid the
horizontal movement of the eye along the printed linethe serifs at the top and bottom of a character create a
railroad track for the eye to follow along the line of print.
Therefore, when using a typeface without serifs, adequate spacing between the lines of print is required to prevent
the eye from ridging (slipping) to the adjoining line. The designer should safeguard against this factor as it may lead
to skipping a line while reading a long list.
52
Most human factors design handbooks advocate the use of sans-serif fontsemphasizing the characteristics of
modern sans-serif fonts as clean and simple fonts. The sub-optimal effect of their over-modularity on the legibility
and readability.
Recommendations
Sans-serif fonts are usually more legible than fonts with serifs. Avoid using a font that has characters that are too
similar to one another, as this reduces the legibility of the print.
53
Recommendations
Long chunks of text should be set in lower case. If upper case is required, the first letter of the word should be
made larger in order to enhance the legibility of the word.
DURING READING OF UPPER-CASE WORDS, PERCEPTION OCCURS IN A CHARACTER-BY-CHARACTER ORDER,
THEREBY REDUCING THE SPEED OF READING AND READABILITY OF THE ENTIRE WORD.
The pattern or shape of a familiar word is stored in the human memory. While reading text, a matching sequence
occurs between the observed word and the memory patterns stored in the brain. The more unique the patterns of
the word, the easier it is to perform the matching sequence.
RESEARCH SUGGESTS THAT SUCCESSIVE LINES OF PRINTED TEXT, COMPOSING A PATTERN OF STRIPES, MAY
INDUCE DISCOMFORT AND ANOMALOUS VISUAL EFFECTS TO THE READERS.
Lower-case words consist of characters that have ascenders (the vertical stroke of d) and descenders (p, q),
which contribute to the unique shape and pattern of a word. This makes the lower-case word-form appear more
characteristic. Conversely, an upper-case word appears like a rectangular box with no distinguishable contour.
Another explanation of the superior legibility of lower-case text is the combination of a capital letter and lower-case
characters at the beginning of a sentence and/or proper names. Research has shown that visual emphasis given to
the first letter of a word significantly improves the speed of a search. This finding is true for lower-case words as
well as for upper-case words combined with a larger first character. This can be useful when a designer decides
to make a distinction by using typographical features such as lower- and upper-case words and still maintain
discriminability and search speed.
54
55
Contrast
Crestron recommends the use of dark characters over a light background for normal illumination conditions.
However, when the observer must maintain a dark adaption condition (a darkened home theater environment for
example), Crestron recommends a light character over a dark background.
Color Coding
A character and its background may differ in the amount of light they reflect and color. When viewed from a short
distance, the visual difference between the character and background is better reinforced by using large luminance
differences than by employing large chromatic (color) differences. In other words, the contrast is more important
than color differences in determining visibility of the characters. For example, red and blue have considerable color
contrast; yet can have a very small luminance contrast. Yellow characters over black and dark blue over white
are probably the best choices of color contrast. In several experiments to determine the effect of color contrast on
legibility to test the perception of different colored numerals at a glance, black characters over yellow background
showed the best results.
As a general recommendation, the x height of a font used for important flightdeck documentation should
not be below 0.10 inch.
The recommended height-to-width ratio of a font that is viewed in front of the observer is 5:3.
The vertical spacing between lines should not be smaller than 25-33% of the overall size of the font.
The horizontal spacing between characters should be 25% of the overall size and not less than one stroke
width.
Avoid using long strings of text set in italics.
Use primarily one or two typefaces for emphasis.
Avoid using black over dark red, green, and blue.
Acknowledgements
The original work for the typography recommendations was NASA CONTRACTOR REPORT # 177605 ON THE
TYPOGRAPHY OF FLIGHT-DECK DOCUMENTATION by ASAF DEGANI, and supported by NASA research grant
No. NCC2-327 from the Ames Research Center to the San Jose State University and grant No. NCC2-377 to the
University of Miami.
Further Inquiries
If there are questions after reviewing this guide, please take advantage of Crestron Sales Support Services by
calling Crestron corporate headquarters at 1-888-CRESTRON (1-888-273-7876).
The online help section of the Crestron website provides answers to questions about Crestron products. First-time
users need to establish a user account to fully benefit from all available features.
57