Crestron D3 Pro™
Reference Guide
This document was prepared and written by the Technical Documentation department at:
Crestron Electronics, Inc.
15 Volvo Drive
Rockleigh, NJ 07647
1-888-CRESTRON
All brand names, product names and trademarks are the property of their respective owners.
2002 Crestron Electronics. Inc.
Crestron D3 Pro™ Software
Contents
D3 PRO™.........................................................................................................................1
OVERVIEW......................................................................................................................1
System Views..............................................................................................................2
Interface View........................................................................................................2
Load Schedule View..............................................................................................2
Module and Enclosure Assignment View..............................................................2
Equipment View .................................................................................................... 2
Programming View................................................................................................ 3
Finish View............................................................................................................3
System Requirements .................................................................................................3
File Structure .............................................................................................................3
Import/Export Archive ...............................................................................................4
Documentation...........................................................................................................4
Live Update................................................................................................................6
Live Update Firmware............................................................................................... 7
CREATING A NEW LIGHTING SYSTEM .............................................................................8
Set System Properties.................................................................................................8
Add Areas and Rooms.............................................................................................. 11
SYSTEM VIEWS .............................................................................................................12
Interfaces View ........................................................................................................12
Interface Properties .................................................................................................14
Engraving Options ...............................................................................................16
Load Schedule View.................................................................................................21
Create a user-defined fixture................................................................................24
Controlled Circuit Properties ...............................................................................27
Advanced Lighting/Motor Properties ..................................................................29
Module and Enclosure Assignment View................................................................. 31
Module Assignment Wizard ................................................................................31
Manual Assignment Mode...................................................................................34
Equipment View .......................................................................................................39
Auxiliary Devices Mode......................................................................................39
Controlled Devices Mode ....................................................................................40
Device Properties.................................................................................................41
Remote System Definitions .................................................................................43
Programming View ..................................................................................................45
Actions and Events ..............................................................................................46
Digital, Analog, and Serial Commands................................................................46
User Interfaces .....................................................................................................48
Button Models......................................................................................................49
Button Feedback .................................................................................................. 55
Button Groups...................................................................................................... 57
Synchronize Events..............................................................................................58
Assigning Actions to Events................................................................................58
Device Commands...............................................................................................61
Copy/Paste Steps and Button Logic.....................................................................63
Learnable Lighting...............................................................................................65
Reference Guide – DOC. 5998a Contents • i
Adjusting Lighting Levels in Real Time..............................................................66
Conditional Statements ........................................................................................68
Global Variables .................................................................................................. 72
Global Presets ...................................................................................................... 74
D3 Pro Scheduler .................................................................................................76
Vacation Scheduler ..............................................................................................81
Trace Tool............................................................................................................83
Finish View ..............................................................................................................84
Sync Learned Lighting.........................................................................................86
Set Network IDs...................................................................................................86
Build System........................................................................................................92
Upload System.....................................................................................................93
SOFTWARE LICENSE AGREEMENT ................................................................................96
RETURN AND WARRANTY POLICIES .............................................................................98
Merchandise Returns / Repair Service.....................................................................98
CRESTRON Limited Warranty ................................................................................ 98
ii • Crestron D3 Pro™ Reference Guide – DOC. 5998a
Crestron D3 Pro™ Software
D3 Pro™
Overview
Crestron D3 Pro™ software offers design, development, and documentation for
home automation. The current version of D3 Pro provides all the tools necessary to
create a complete lighting system, with additional support for auxiliary devices such
as security systems, motion detectors and shades.
D3 Pro Interfaces View
The design aspect of D3 Pro enables you to easily organize each lighting system into
areas and rooms. To each room you can add user interfaces (selected from Crestron's
extensive lineup of touchpanels, keypads, and hand held remotes). Then you can add
lighting, motor, and fan circuits as dictated by your load schedule. Finally, you can
let the Module and Enclosure Assignment Wizard create the appropriate lighting
hardware to control your loads, or you can add this hardware manually.
Reference Guide – DOC. 5998a Crestron D3 Pro™• 1
Software Crestron D3 Pro
The development aspect allows you to determine what actions occur when the user
presses a button on a keypad, remote, or touchpanel. You can program actions to
occur based on time of day, or when a contact closure is detected. Programming is
accomplished using a simple yet powerful series of programming screens.
Finally, D3 Pro allows you to document your project by creating attractive and easy
to read reports. These reports are generated in HTML, meaning that they can easily
be sent via e-mail or imported into another application such as Microsoft Word or
Excel for inclusion in a larger document.
D3 Pro is fully integrated with Crestron's suite of software development tools,
including SIMPL™ Windows, VisionTools Pro-e™ and the Crestron databases.
These tools work together to provide the link between Crestron systems hardware,
touchpanels, and the world of equipment to be controlled.
D3 Pro presents an easy-to-use graphical interface. Programming is organized into
six Views of the system, each providing a moveable toolbox of devices such as
interfaces, fixtures, and control modules.
System Views
™
Interface View
The Interfaces View allows you to add user interfaces and, depending on the
interface, to set engraving attributes. The Interfaces toolbox includes a variety of
Crestron wired keypads, touchpanels, and wireless remotes. If you set engraving
options for an interface, a file containing the engraving data and your dealer
information will be stored in the \Engraving subfolder of your system directory. The
file will have the name of the interface and an .egr extension. You can send the .egr
file to engraving@crestron.com
for processing and engraving.
Load Schedule View
The Load Schedule View allows you to add lighting loads, motors and ceiling fans to
the system and to set the load type, quantity and wattage. Information about each
device is displayed in fields that you can sort, show or hide as desired. You can also
set advanced properties for dimmable lights, fans and motors. Finally, you can adjust
lighting levels in real time.
Module and Enclosure Assignment View
The Module and Enclosure Assignment View allows you to set up enclosures, select
Crestron control modules, and connect modules to the controlled circuits in your load
schedule. Alternatively, you can use the D3 Pro Module and Enclosure Assignment
Wizard to add the required equipment and generate these connections automatically.
This view also allows you to adjust lighting levels in real time.
Equipment View
The Equipment View allows you to add generic or third party non-lighting devices
such as security systems, controllers for screens, and garage door openers. In
addition, you can set up communication with a remote Crestron processor. The
Equipment View also allows you to add plug-in control cards and other auxiliary
devices to the control system.
2 • Crestron D3 Pro™ Reference Guide – DOC. 5998a
Crestron D3 Pro™ Software
Programming View
The Programming View allows you to assign functionality to button presses and
other system inputs, and to adjust lighting levels in real time. You can also schedule
events according to the 24-hour or astronomic clock.
Finish View
Allows you to synchronize learned lighting levels, set Cresnet IDs, verify system
communication, and generate the control system logic program. Finally, you can
upload program files to the control system and user interfaces.
System Requirements
D3 Pro requires the following minimum system configuration:
• Windows 98/NT/2000/XP operating system
• 333 MHz Pentium II processor (1.3 GHz Pentium 4 recommended)
• 128 MB of RAM (256 MB recommended)
• 256 color setting (High color 16-bit recommended)
D3 Pro also requires the following minimum versions of Crestron software:
• SIMPL Windows version 2.04.11 with Cross Compiler
• Crestron Database version 15.9.9
• VisionTools Pro-e version 3.0.0.8
• Engraver version 2.1.0.2
File Structure
By default, D3 Pro lighting programs are saved in \Crestron\D3 Pro\Systems. The
\Systems directory contains one subfolder for each program you create. Each
program subfolder contains a system file with the name of the program and the
extension .d3p, in addition to the following subfolders:
\Interfaces: Contains VisionTools Pro-e project files for each touchpanel.
\Engraving: Contains Crestron Engraver files that are generated in Interfaces View.
You can send .egr files to engraving@crestron.com for processing and engraving.
\Programs: Contains the control system logic program.
\Documentation: Contains reports (in HTML format) that you generate.
\AUTOSAVE: Contains system backup files (if you enable the auto backup feature
in System Preferences).
\DATA: Contains scheduling data for the D3 Pro Scheduler.
\RemoteSystemDefinitions: Contains the RSD file (remote system definition file) if
you export device signals to a remote system.
Reference Guide – DOC. 5998a Crestron D3 Pro™• 3
Software Crestron D3 Pro
Import/Export Archive
D3 Pro can compress system files for long-term storage or transfer to another PC.
The compressed files are saved in .zip format.
To archive a D3 Pro system, open the system and click Export Archive on the D3
Pro File menu. Browse to the directory where you want to save the file and click
Open. The archive file will have the name "Export of system filename" with a .zip
extension.
To open an archived system, click Import Archive, browse to the directory
containing the .zip file and click Open. Then browse to the destination folder where
you want to unzip the files and click OK. This will create a subfolder for the system
under the selected folder.
Documentation
D3 Pro provides various kinds of documentation, all generated in HTML format,
which you can use as a reference when installing and wiring your lighting system.
When you generate a report it is saved in your lighting program's \Documentation
subfolder.
™
You can select from the following reports:
The Bill of Materials lists all Crestron hardware such as the control system, control
modules, user interfaces, auxiliary devices and control cards. The Bill of Materials
can be saved as an Excel spreadsheet for easy modification and customization.
In order to include prices in the spreadsheet, you must download the price list from
the Crestron Web site and save it in your lighting program’s \Reports subfolder:
1. Go to http://www.crestron.com/pricelist
2. Click Crestron Home Dealer.
3. Enter your user name and password, and then follow the screen instructions
and prompts to download the pricelist.
The Connection Sheet lists the network devices that are connected to each slot on
the control system. The information here includes the Network ID and port
assignment, as well any notes or comments you enter in the properties of the device.
The Contact and System Information report gives basic dealer and system
information.
The Load Schedule report lists all controlled circuits defined in the program,
including lighting, motors and fans. The information includes the type of fixture
(downlights, accents, drapes, etc.) as well as wattage and load type (incandescent,
fluorescent, 3-wire motor, etc.) just as it appears in Load Schedule View.
The Project Fixture Schedule report provides a detailed listing of all user-defined
fixtures in the project. This report provides a convenient cross-reference to the Load
Schedule report.
The Load Schedule w/Panel Terminations gives the controlled circuit panel
terminations in addition to all the information given in the Load Schedule report.
The Load Wiring report gives a graphical representation of each control module,
with color-coded inputs and outputs to the module.
4 • Crestron D3 Pro™ Reference Guide – DOC. 5998a
Crestron D3 Pro™ Software
Load Wiring Report
The Modules and Enclosures report gives a graphical representation of the slots on
each Crestron enclosure, with the assigned modules and control system.
Modules and Enclosures Report
To print a report
1. Click Documentation on the File menu, or click the Generate
Documentation toolbar button.
2. Select the desired report and click Create/View to launch the default Web
browser.
3. Click Print on the Web browser’s File menu.
Reference Guide – DOC. 5998a Crestron D3 Pro™• 5
Software Crestron D3 Pro
Live Update
Crestron Live Update allows you to easily download the latest software updates via
the Internet. When you launch Live Update (on the Help menu) you will see a
display list of Crestron software programs and databases. Live Update will compare
the versions of the Crestron software on your PC with the latest versions available at
Crestron. If a newer version of a program is available, that program will be checked
off and "Update Available" will appear in brackets. You can clear the check box next
to any program you don't want to download.
™
You can click Get Update to download the programs you have selected. Here Live
Update will download the selected program as well as all its associated files, called
dependencies. Since some dependencies can be large, you should check the list to
verify that you need them. To check dependencies, click More. The files will be
listed in the Dependencies list. You can select an item to view its version and file
size.
6 • Crestron D3 Pro™ Reference Guide – DOC. 5998a
Crestron D3 Pro™ Software
You can clear the check box next to a dependency, meaning that the un-checked file
will not be downloaded. If you find that this causes the program not to work, run
Live Update again and download the necessary files.
After you select or clear the dependencies click OK to go back to the Live Update
screen. Click Browse to select the location where the software will be downloaded.
Then click Get Update.
After download, open the file and run the installation program.
It's a good idea to run Live Update periodically to ensure that you always have the
newest versions of all Crestron software.
Live Update Firmware
Crestron Live Update Firmware allows you to determine the current firmware your
Crestron control system and Cresnet devices should be using and update the firmware
if necessary.
To use Live Update Firmware, start your Internet connection and click Live Update
Firmware on the Help menu. If your PC is connected to the control system, then
Live Update will poll the network and compare the firmware versions of all detected
network devices to the latest firmware versions available at Crestron. If newer
firmware versions are available then those devices will be shown in the display list.
If you are not connected to the control system the display list shows all Cresnet
devices and control systems.
To download the update to your hard drive
1. Select the check box next the device you want to update.
2. Click Browse and select the directory where you want to save the file.
3. Click Download to transfer the file to your hard drive.
The format of the file differs depending on the type of device. Control system
updates are .cuz files; those for touchpanels, .csf files; those for network devices,
.upg files. If the downloaded file is zipped, extract all the zipped files to one folder
and review any "Readme" documentation before continuing with the upload
procedure. Sometimes the update is a self-extracting ZIP file with an .exe extension.
To upload the new firmware to the device
1. Establish communication with the control system (see Finish View on page
84).
2. Connect the device to the network.
3. Click the Viewport
4. Go to the File Transfer menu and select the appropriate command. That is,
to update a touchpanel or keypad, click Update Touchpanel/Keypad
Firmware; for the control system, click Update Control System; for a
network device, click Load Network Device.
button to start the Crestron Viewport.
5. Select the Network ID of the device if prompted and then click OK to start
the transfer.
Reference Guide – DOC. 5998a Crestron D3 Pro™• 7
Software Crestron D3 Pro
Creating a New Lighting System
Set System Properties
1. Start D3 Pro and select New on the File menu, or click the Create New
System
2. Click the General tab and select a control system, i.e., the PAC2, Crestron's
specially designed processor for lighting applications.
toolbar button.
™
Enter the filename of the program in the System Name field. When you save
your program, a subfolder is created with the name of the program in the D3
Pro \Systems folder. The program file itself will be saved in the subfolder
and have a .d3p extension. The Location field gives the default file path,
although you can specify a different file path.
You can type information into the other optional text fields, including a
System Number and Purchase Order number. This additional information is
for reference only, and will also appear on any documentation you generate.
D3 Pro lighting programs can store runtime data (such as Scheduler events
and dynamic adjustments to lighting levels) and XPanel/Web browser pages
either on a Compact Flash card installed in the control system, or on the
8 • Crestron D3 Pro™ Reference Guide – DOC. 5998a
Crestron D3 Pro™ Software
control processor's NVRAM disk. To set where the system will store its
runtime data and XPanel pages, select the Compact Flash or NVRAM
button. Note that some processors do not provide a Compact Flash slot. Here
both options will be disabled and all runtime data will go to NVRAM.
D3 Pro supports the use of a "virtual" keypad called the Virtual CNX-B12.
This keypad is included in the Interfaces toolbox and can be programmed
just like a real keypad, except that the virtual keypad has no Network ID and
does not exist physically on the network.
The purpose of the virtual keypad is to provide a simple interface for a
remote Crestron processor to control lighting. Virtual keypads must be
exported via a remote system definition (see page 44), or RSD file, in order
to be available to the remote processor. If your project will include virtual
keypads you can select the Automatically add remote system check box.
This will add a remote system automatically as soon as the virtual keypad is
added, without need to manually bring it into the project in Equipment View.
As long as the check box remains selected any additional virtual keypads will
automatically be exported via that RSD.
3. Click the Location tab to specify the location of the residence where you will
install the lighting system. You can select from the list of regions and major
cities, or manually enter the longitude, latitude and time zone. (If you
schedule events according to an Astronomic Clock, D3 Pro uses the
longitude and latitude to calculate sunrise and sunset times.) You can also
select the option to automatically adjust the internal control system clock for
daylight savings.
4. Click the Notes tab to type comments about your project. This and other
system information will be included in any documentation that you generate.
5. Click the Lighting tab to set the size of the circuit breaker (the choices are 15
or 20 amps), which limits the maximum current that can be supplied by a
single feed. The circuit breaker size is determined by the location of the
residence.
You can also enter a Transformer Loss percentage, which applies only to
magnetic low-voltage or neon cold-cathode loads, and specifies the expected
loss factor for a magnetic transformer. The loss factor is included in the
calculation of a controlled circuit's total wattage.
Finally, you can enter a default Ramp Time, which specifies the number of
seconds it takes to ramp dimmable lights from 0% to 100% during manual
Raise and Lower operations.
6. The Vacation Scheduler is a built-in utility that memorizes and replays light
levels over a one or two week period. This is useful, as the name implies, for
maintaining a semblance of occupancy while on vacation. The available
scheduling options are:
Record Period: Records lighting levels for the selected period, 1 or 2 weeks.
When the period is over, a new recording period begins and the new values
overwrite the old values.
Reference Guide – DOC. 5998a Crestron D3 Pro™• 9
Software Crestron D3 Pro
Vary Playback: Adds randomness to the playback. (Specifically, the light
levels will be played back at the sampled time plus or minus the recorded
interval divided by 2.)
Recording Interval: Determines how often the light levels are sampled
during the recording period, and how often they are recalled during playback.
™
The Vacation Scheduler is only capable of learning light levels, so circuits
that have non-lighting load types such as ceiling fans cannot be learned. Only
circuits that have been explicitly set to be recorded will be affected. To mark
a circuit to be recorded, go to the Advanced Lighting Properties screen of the
Load Schedule View (see page 30) and select the Record check box.
The Vacation Scheduler device provides three commands that you can assign
to events: Record, Play or Stop. By default the Vacation Scheduler is in
Stop mode, so you must provide the user with a way to put the Vacation
Scheduler record or playback mode—for more information, see Vacation
Scheduler on page 81.
7. When you are satisfied with your system settings click OK to begin
designing your system. You can view or modify system properties at any
time by clicking the System Properties
10 • Crestron D3 Pro™ Reference Guide – DOC. 5998a
button.
Crestron D3 Pro™ Software
Add Areas and Rooms
An area defines a collection of rooms that are usually in proximity to each other, i.e.,
First Floor, East Wing, or Top Floor. Your first task in building a lighting system is
to define each area, and then to assign rooms to those areas. In this way, you can
organize your project and more easily find rooms in a large project. Organizing
rooms into areas also makes it easier to configure groups within the Module and
Enclosure Wizard. Some rules regarding areas and rooms are as follows:
• A room can only belong to one area.
• Areas can only contain rooms.
• Each area and room must have a unique name. However, an area and room
can have the same name.
Every system starts with one pre-defined area, called the Equipment Area, which
contains one pre-defined room, called the Equipment Room. The purpose of the
Equipment Room is to provide the lighting system with a default location for the
control processor. In addition, if you place a device in the Equipment Room, that
device can be controlled from any user interface in the system. That is, the device is
considered global, and touchpanel templates pages will be added for that device to all
the touchpanels in the system.
You can rename the Equipment Room and Equipment Area, but you cannot remove
them.
You can define areas in several ways. You can drag an area from the General toolbox
to the system folder. Or you can right-click the system folder, point to New, and
select Area.
To add multiple areas, hold down the Shift key while you drag an area from the
General toolbox to the system directory. Then select the number of areas you want to
add.
To rename an area, right-click and select Rename from the submenu, or press F2.
You use the same methods to add rooms; that is, you can drag a room from the
General toolbox to the system directory, add multiple rooms at a time by holding
down the Shift key, or right click an area, point to New, and select Room. The
method for renaming a room is also the same: right-click and select Rename, or
select the room and press F2.
You can also right-click to view the properties of an area or room. Areas and rooms
provide only one property that you can set, and that is the Description field. If you
enter a description it will be included with any documentation that you generate.
D3 Pro allows you to add areas and rooms from any of the system Views, except for
the Finish View.
Reference Guide – DOC. 5998a Crestron D3 Pro™• 11
Software Crestron D3 Pro
System Views
Interfaces View
The Interfaces View allows you to add user interfaces and, depending on the
interface, to set engraving attributes and faceplate/trim colors. The Interfaces toolbox
includes Crestron CNX and C2N keypads, CLW wall dimmers and switches, hand
held remotes, and touchpanels. CLW dimmers and switches also provide two "slave"
interfaces, the CLW-SLVD and CLW-SLVS, with non-programmable buttons. SLV
interfaces are wired to a master interface and control the same load, but are not
physically connected to the load.
The toolbox also includes a keypad called Virtual CNX-B12. As described earlier,
this keypad can be programmed just like a real keypad. The only difference is that the
virtual keypad has no Cresnet ID and does not exist physically on the network. The
virtual keypad provides a simple interface for a remote Crestron processor to control
the lighting program. For example, suppose the only user interface in a room is a
touchpanel, and that this touchpanel is connected directly to an AV control processor,
which is separate from the lighting control processor. The virtual keypad allows the
lighting programmer to provide functionality to a remote processor that does not exist
on any physical keypad on the lighting system.
™
Virtual keypads must be exported via a remote system definition in order to be
available to a remote system. If your project will include virtual keypads you can
select the Automatically add remote system check box in System Properties. This
will add a remote system automatically as soon as the virtual keypad is added,
without need to manually bring it into the project in Equipment View. As long as the
check box remains selected any additional virtual keypads will automatically be
exported via that RSD.
The methods for adding an interface are the same as for areas, rooms and other
devices:
• Drag the interface from the Interfaces toolbox to a room.
• You can right-click a room, point to New, and then select an interface from
the submenu.
• To add multiple interfaces, hold down the Shift key while you drag the
interface from the toolbox to a room. Then select the number of interfaces
you want to add. You can also hold down the Shift key, right-click a room,
point to New, and click the interface. Then enter the number of interfaces.
• If you add a CLW wall dimmer or switch, you can then add a slave interface.
Right-click the CLW interface, point to New, and then select the slave. It will
appear as a sub-category of the master interface. Only the CLW-DIMS and
CLW-SWS allow slaves.
• To rename the interface, right click and select Rename, or select it and press
F2. Each interface in the system must have a unique name.
If you add an interface that can be engraved, then a graphic image of the interface
will be displayed in the center of the screen. Sometimes a graphic image is also
12 • Crestron D3 Pro™ Reference Guide – DOC. 5998a
Crestron D3 Pro™ Software
displayed for non-engravable interfaces such as CLW dimmers. If the interface is
engravable, you can right-click buttons on the interface graphic and select engraving
options from the submenu. You can also add text by double-clicking engravable
areas.
If you select a room from the system tree on the left side of the D3 Pro screen, the
program detail area lists all the interfaces that you have added to that room.
Similarly, selecting an area will display all the interfaces in every room in that area.
Finally, if you select the top-level system folder you will see the list of all interfaces
in the system. The information includes the name of the interface, its type and
location, and its Network ID (I/O Assignment).
You can click a column header to sort the interfaces by that category.
Reference Guide – DOC. 5998a Crestron D3 Pro™• 13
Software Crestron D3 Pro
You can drag any interface to a different room. To select multiple interfaces, press
the Shift or Ctrl key while you click each interface. If you right click an interface in
the system directory, you can select from the submenu to cut and paste, rename the
interface, delete it or view its properties. Interface names must be unique throughout
the system.
Interface Properties
Use the General tab to view or change general information about an interface. For
example, you can change the location of the interface by selecting a different room
from the Location list.
Some keypads provide LED indicators and/or a backlight that illuminates the buttons.
Here you can enter a brightness level (from 0% to 100%) for the LED in the
Indicator Intensity field, and for the backlight in the Backlight Intensity field.
The backlight illuminates all the buttons on the interface all the time. The LED
indicator is used only when a given button has feedback.
™
Some touchpanels provide templates that are used to design the touchpanel pages. If
the touchpanel provides templates, you can select a template from the Template
drop-down list. To view a preview image of a sample page, click the Template
button.
Type descriptive information about the interface in the Notes field. This information
will be included in any documentation that you generate.
Use the I/O Assignment tab to view or change the Network ID of the interface. A
Network ID is a hexadecimal value that must be unique to identify each device on a
network. All Crestron devices have an internal Network ID set at the factory. This
internal Network ID has to match the ID that is set for that device in the D3 Pro
lighting program. Generally you have to change the internal Network ID of each
device to match the ID assigned in D3 Pro (see page 86).
14 • Crestron D3 Pro™ Reference Guide – DOC. 5998a
Crestron D3 Pro™ Software
If the device is a Cresnet device the Network ID is referred to as a Cresnet ID, or Net
ID.
If the interface is an Ethernet touchpanel, such as the TPS-5000 or TPS-6000 with
TPS-ENET card, then the Network ID is referred to as an IP ID. In addition to the IP
ID, you should enter the IP address of the Ethernet touchpanel.
With wireless interfaces, such as the MT-500C, the Network ID is an RF ID. Here
the RF ID identifies the wireless receiver, such as the CNRFGWA.
Reference Guide – DOC. 5998a Crestron D3 Pro™• 15
Software Crestron D3 Pro
The Advanced tab allows you to re-compile a touchpanel project, which will
overwrite any changes or customization done to the project in Programming View or
Finish View. Select the Rebuild interface project check box and click OK to
completely rebuild the touchpanel project from the selected template.
Engraving Options
If you add a user interface that can be engraved, a graphic of that interface will be
shown in the program detail area in the center of the screen with the engravable areas
outlined by dotted rectangles.
You can right-click a button on the interface graphic and select an engraving option
from the submenu. Depending on the interface, you may have the option to select a
faceplate/trim color combination. You can also show or hide engravable areas by
toggling Show Text Area Outlines on the submenu.
Engraving Options for the CNX-B6
™
The right-click submenu provides a WYSIWYG (What You See is What You Get)
print option that allows you to print an interface just as it appears on the screen,
except that the faceplate color is always white.
Before printing, select or clear the attributes you want to view or hide. For example,
if you want to hide the dotted lines around the engravable areas, verify that Show
Text Area Outlines is not selected.
When the interface appears the way you want, right-click the interface and select
Print Panel from the submenu.
When you set engraving attributes, those attributes are automatically saved to an .egr
file in your system’s \Engraver subfolder. You can email the .egr file to
engraving@crestron.com
16 • Crestron D3 Pro™ Reference Guide – DOC. 5998a
for processing and engraving.
Crestron D3 Pro™ Software
CNX AND C2N KEYPADS
Crestron's CNX keypads provide 2, 4, 6, 8, or 12 buttons, while the C2N keypads
come in 6, 8, or 12-button configurations. Only the buttons on the keypads are
engravable.
The CNX keypads also provide you with the option to exclude buttons from your
order. For example, if you only want to engrave six buttons for a CNX-B12 keypad,
you can remove the other six buttons from your order. Simply right-click each button
and choose Exclude Button from Order from the submenu. A red X will cross out
the excluded buttons.
You cannot exclude buttons from the C2N keypads.
CT-1000, LC-1000
AND TPS-2000
The CT-1000, LC-1000, and TPS-2000 touchpanels provide ten engravable buttons,
five on each side of the touchscreen.
The available options for engraving depend on the faceplate/trim combination you
choose. Some combinations provide engravable areas on the faceplate as well as on
the buttons, whereas others only provide engravable areas on the buttons.
ST-1700, STX-1700C
AND TPS-3000L
The ST-1700 and STX-1700C touchpanels provide ten engravable buttons, five on
either side of the touchscreen. The TPS-3000L provides five buttons. On each of
these interfaces only the buttons are engravable, not the faceplate.
To enter text
1. Double-click the button or engravable area you want to engrave.
2. Go to Field One and select a font from the Font list.
You can choose from two fonts: Arial, for readable text; and Crestron
Transport Outline, which consists of symbols that represent standard device
functions such as Fast Forward, Rewind, Volume Up and Volume Down.
Each symbol corresponds to a letter of the alphabet (from A to P, not case
sensitive) as follows:
3. After selecting the font, enter the desired text in the Field One text box.
4. You can click the Field Two check box to enter more text. Here you can
choose a font just as described above.
5. Depending on the interface and the size of the button, you may have the
further option to place Field One on top of Field Two (click Two Horizontal
Fields). In most cases you have the option to place the two fields next to
Reference Guide – DOC. 5998a Crestron D3 Pro™• 17
Software Crestron D3 Pro
each other (click One Horizontal Field). Choose the latter if you want to use
two different fonts within the same line.
D3 Pro will verify that the text will fit within the margins of the button. If the text
does not fit, an error message will be generated.
™
CNRFHT-30A
The CNRFHT-30A is a hand-held transmitter with up to 30 buttons. It provides the
following options:
Button color - You can change the color of selected buttons as follows:
1. Click each button while pressing the Ctrl key.
2. Right-click and select Button Cap Color from the submenu to open the
color palette.
3. Choose the desired color for the selected button(s).
Button grouping and ungrouping - By default, all 30 buttons on the transmitter are
displayed. Alternatively, you can combine two adjacent buttons to create one longer
button that lies horizontally or vertically:
1. Click each button while pressing the Ctrl key. (You can only group two
buttons at a time. Also, the buttons must be adjacent to each other, either
horizontally or vertically).
2. Right-click and choose Combine Button Caps from the submenu. The new
button will be shown in the selected horizontal or vertical position.
3. To revert back to the two-button setting, right-click the long button and select
Uncombine Button Caps from the submenu.
Showing/Hiding Buttons - By default, all 30 buttons on the transmitter are
displayed. However, you can remove buttons as desired. For example, if your
application requires only 20 buttons, you can remove any 10 buttons from the
transmitter.
To hide buttons
1. Click each button you want to remove while pressing the Ctrl key.
2. Right-click and choose Hide Buttons from the submenu. This will replace
the selected button(s) with engravable areas.
3. You can restore the buttons you removed by right-clicking the transmitter
and selecting Unhide all buttons.
Text area grouping and ungrouping - Just as you can combine two buttons to
create one longer button, you can combine two text areas to form one longer text
field. In addition, you can combine two of these longer text areas to form one long
text field that stretches across the entire row. The engravable text areas are outlined
by dotted rectangles (when you right-click and enable Show Text Area Outlines on
the submenu).
18 • Crestron D3 Pro™ Reference Guide – DOC. 5998a
Crestron D3 Pro™ Software
To combine text areas
1. Verify that Show Text Area Outlines is enabled on the right-click submenu.
2. Click each text area while pressing the Ctrl key. (You can only group two
text areas at a time.)
3. Right-click and choose Combine Text Areas from the submenu.
4. If you have two long text areas in one row, you can repeat steps 2 and 3 to
create one text area that stretches across the entire row.
5. To revert to the smaller text area setting, select the long text area, right-click
and choose Uncombine Text Areas from the submenu.
Entering Text and Lines - When you enter text in an engravable area, you can also
draw lines around the text and button(s). In this way you can separate buttons from
one another, or you can create a border around related buttons.
To enter text
1. Double-click the engravable text area.
2. Go to Field One and select a font from the Font list.
As shown in the diagram on page 18, you can choose from two fonts: Arial,
for readable text; and Crestron Transport Outline, which consists of
symbols that represent standard device functions such as Fast Forward,
Rewind, Volume Up and Volume Down. Each symbol corresponds to a letter
of the alphabet from A to P, not case sensitive.
After selecting the font, enter the desired text in the Field One text box.
If you enter text only in the Field One text box, you can align the text
horizontally and vertically by selecting from the Align Text lists.
3. You can click the Field Two check box to enter a second line of text. Here
you can choose a font just as described above.
4. You have the further option to place Field One on top of Field Two (click
Two Horizontal Fields), or to place the two fields next to each other (click
One Horizontal Field). Choose the latter if you want to use two different
fonts within the same line.
If you have text in Field One and Field Two, you can only align the text
horizontally, not vertically.
To draw lines around a text area
1. After you enter the desired text and align it within the text area, select the
check boxes that appear around the drawing of the text area and button.
For example, if you want to draw a vertical line on the left side of the text
area/button(s), click the check box on the left side. To draw a border around
the entire area, click all four check boxes.
Reference Guide – DOC. 5998a Crestron D3 Pro™• 19
Software Crestron D3 Pro
2. Click OK to save your settings. D3 Pro will verify that the text you entered
will fit within the margins of the engravable area. If the text does not fit, an
error message will be generated.
3. You can right-click and select Show Lines on the submenu to display any
lines you have drawn. (You can hide the dotted lines that show engravable
areas by toggling Show Text Area Outlines on the right-click submenu.)
Replacing center buttons with text and lines - This feature allows you replace
center buttons with horizontal text and lines, in the manner shown below:
™
To replace center buttons with text and lines
1. Use the methods described earlier to hide two center buttons. Two text areas
will replace the buttons.
2. Combine the two text areas you just created into one text area.
3. Double-click the new text area and enter the desired text.
4. Select the Text Area check box to add a horizontal line on either side of the
text.
20 • Crestron D3 Pro™ Reference Guide – DOC. 5998a
Crestron D3 Pro™ Software
Load Schedule View
The Load Schedule View allows you to add loads, also called controlled circuits, to
your D3 Pro system. Loads are connected to Crestron's CLX and CLW control
modules, which support all standard fixtures and load types, as shown in the
following table:
Control Module Load Support
Incandescent (Dim, Non-Dim)
Magnetic Low Voltage (Dim, Non-Dim)
Electronic Low Voltage (Dim, Non-Dim)
CLX-DIM
CLX-4HSW4
CLX-1DELV4
CLX-1MC4 3-wire Motor
CLX-1FAN4 Ceiling Fan
CLW-DIM
CLW-DIMS
CLW-SW
CLW-SWS
Neon/Cold-Cathode (Dim, Non-Dim)
Fluorescent Dim (2-Wire) (Dim, Non-Dim)
Fluorescent Non-Dim
Switched
Switched
Incandescent (Non-Dim only)
Magnetic Low Voltage (Non-Dim only)
Electronic Low Voltage (Non-Dim only)
Neon/Cold-Cathode (Non-Dim only)
Fluorescent Dim (2-Wire) (Non-Dim only)
Fluorescent Non-Dim
H.I.D
Electronic Low Voltage (Dim, Non-Dim)
Incandescent (Dim, Non-Dim)
Incandescent (Dim only)
Magnetic Low Voltage (Dim only)
Switched, i.e., general purpose fan (consult CLW-SW/S
documentation to verify the appropriateness of a particular
switched load)
Incandescent (Non-Dim only)
Magnetic Low Voltage (Non-Dim only)
Electronic Low Voltage (Non-Dim only)
Neon/Cold-Cathode (Non-Dim only)
Fluorescent. Dim (2-Wire) (Non-Dim only)
Fluorescent Non-Dim
H.I.D
The Load Schedule toolbox provides two fixture libraries: Global and Project. Each
library contains 16 generic fixture categories.
When adding loads to your load schedule, you can select one of the 16 generic
fixtures from either library, or you can create your own user-defined fixtures that
appear as sub-categories of the generic categories. If you add a user-defined fixture to
the Global Library, that fixture will be available to any D3 Pro project you design on
your computer. If you add a user-defined fixture to the Project Library, that fixture is
available only in the current project.
Reference Guide – DOC. 5998a Crestron D3 Pro™• 21
Software Crestron D3 Pro
™
You can add a generic fixture in a number of ways:
• Drag the generic fixture from either library in the Fixtures toolbox to a room.
• If you select a room in the system tree, you can also drag the fixture from the
toolbox onto the Load Schedule area in the center of the screen.
• To add multiple fixtures, hold down the Shift key while you drag the fixture
from the toolbox to a room. Then select the number of fixtures you want to
add. You can also hold down the Shift key, right-click a room, point to New,
and select the fixture. Then select the amount.
• You can right-click a room, point to New, and then select a generic fixture
from the submenu. A generic fixture appears as one of the 16 main fixture
categories.
To add a user-defined fixture:
• Drag the fixture from the Global or Project library to a room, just as
described above. User-defined fixtures appear as sub-categories of a generic
fixture.
• You can right-click a room, point to New, and then point to the generic
fixture category. Select the user-defined fixture from the submenu.
• Use the methods described above to add multiple user-defined fixtures.
22 • Crestron D3 Pro™ Reference Guide – DOC. 5998a
Crestron D3 Pro™ Software
You can right-click any fixture you have added to cut, copy and paste, rename or
delete the fixture. You can also activate the Trace tool (see page 83).
The table below lists the load types and corresponding generic categories:
Load Type Default Generic Category Description
Accents
Bath/Vanity
Ceiling Light
Chandeliers
Incandescent
Neon/Cold Cathode
Ceiling Fan
Magnetic Low Voltage
3-Wire Motor
Switched
Fluorescent Non-Dim
Fluorescent Dim (2-Wire)
Electronic Low-Voltage Lighting
H.I.D.
Downlights
Outdoor Lights
Pendants
Sconces
Table Lamps
Other
Bent Glass
Ceiling Fan
Cove Lights
Drapes
Exhaust Fan
Pump
Lighting
Lighting
Multi-speed ceiling fan motor
Lighting
3-wire, 2-direction motor
Any non-lighting load that can be turned
full on or off only
Lighting
Non-dimmable fluorescent ballasts
Lighting
2-wire dimmable fluorescent ballasts
Lighting
High Intensity Discharge
Reference Guide – DOC. 5998a Crestron D3 Pro™• 23
Software Crestron D3 Pro
Create a user-defined fixture
1. Open the desired library, Global or Project. As described earlier, global
fixtures are available to any project you create on your computer, while
project fixtures are available only in the current project.
2. Right-click a fixture category and select Add.
™
3. Enter the name of the fixture and select a load type from the list.
4. Enter the fixture wattage. This is the default, per fixture, wattage.
5. For lighting loads, you can select advanced light properties. First, select or
clear the Dimmable check box.
If the lighting load is dimmable, you can enter Upper Limit and Lower
Limit values, which define the lower and upper light levels for dimming.
That is, Upper Limit is the maximum intensity that the controlled circuit can
achieve regardless of the programmed level. A circuit with an upper level of
95% will never get brighter than 95%, even if a button has been programmed
to set that light to 100%.
Similarly, Lower Limit is the minimum intensity prior to shutting off. If a
button has been programmed to set the level to less than the lower limit, the
light will stay at the lower limit, unless the light is instructed to go to 0%, at
which point it will turn off.
24 • Crestron D3 Pro™ Reference Guide – DOC. 5998a
Crestron D3 Pro™ Software
Valid values for Lower Limit range from 0% - 45%. For Upper Limit, valid
values range from 55% - 100%. For non-dimmed fixtures, upper and lower
limit values are fixed at 100% and 0%.
For 3-wire motor loads, you can select advanced motor properties.
Max Time sets the maximum time that the motor can remain in the Open or
Close state. That is, when an "Open" or "Close" command turns the motor
on, the motor will move in the indicated direction 1) until <Max Time>
expires; 2) until another command turns the motor off; or 3) until it hits a
limit switch in the motor assembly.
Valid values for Max Time range from 10 seconds to 8 minutes. It should be
set to a value greater than the full-range travel time of the motor being
controlled.
Jog Time sets the time that the motor will move in the Open or Close
direction during a "Jog" command. That is, a rising edge of a Jog Open or
Jog Close command will cause the motor to move in the indicated direction
for <Jog Time> seconds.
Reference Guide – DOC. 5998a Crestron D3 Pro™• 25
Software Crestron D3 Pro
Valid values for Jog Time range from 0.05s to 2.00s.
Lockout Time sets the minimum time that the motor must remain in the
"stop" state before changing directions between "open" and "close." If the
motor is commanded to move in one direction while it is moving in the
opposite direction, the motor will stop for <Lockout Time> seconds before
moving in the new direction. This is done to prevent damage to the motor,
and the value should be set according to the requirements of the particular
motor being controlled.
Valid values for Lockout Time range from 0.2s to 2.00s.
6. Finally, you can enter optional information about the load, including the
manufacturer, model number and description in the text fields. This
information will be included in any Project Fixture Schedule that you
generate.
7. When you are satisfied with the properties of your user-defined fixture, click
OK to add the fixture to the Global or Project Library. It will appear as a
sub-category of the generic fixture. You can then drag the fixture to a room
your project.
™
As shown below, once you have created a user-defined fixture You can right-click to
edit its properties, copy, paste or delete, or add the fixture type to the Global library.
26 • Crestron D3 Pro™ Reference Guide – DOC. 5998a
Loading...