Crestron RoomView Reference Manual
  1. Manuals
  2. Brands
  3. Crestron Manuals
  4. Software
  5. RoomView
  6. Reference manual
Crestron RoomView Reference Manual

Crestron RoomView Reference Manual

Intended for version 4.0 and later
Hide thumbs
Table of Contents

Advertisement

Quick Links

Crestron RoomView™

Software
Reference Guide
Intended for Version 4.0 and Later

Advertisement

Table of Contents
loading
Need help?

Need help?

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

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Crestron RoomView

Summary of Contents for Crestron RoomView

  • Page 1: Crestron Roomview

    Crestron RoomView™ Software Reference Guide Intended for Version 4.0 and Later...
  • Page 2 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. ©2003 Crestron Electronics, Inc.

  • Page 3: Table Of Contents

    Crestron RoomView Contents Crestron RoomView™ About Crestron RoomView ...1 Crestron RoomView Setup ...2 System Requirements ...2 License Installation...3 Shared License Setup (Client/Server)...4 Adding and Editing Users...7 Adding and Editing Rooms...9 Adding a Room ...9 Editing Room Parameters...11 Creating a New Room that has Similar Parameters to an Existing Room ...11 Adding and Editing Room Attributes ...12...
  • Page 4 Software Crestron Viewport ...52 Viewport: File Menu ...52 Viewport: Edit Menu...53 Viewport: Setup Menu ...53 Viewport: Diagnostics Menu...56 Viewport: Functions Menu...58 Viewport: File Transfer Menu...66 Viewport: Remote Menu ...71 Viewport: Shortcut Keys ...73 ASCII Conversions...74 Further Inquiries ...75 Software License Agreement...76 Return and Warranty Policies ...78...

  • Page 5: Crestron Roomview

    Administrator. • RoomView notifies the operator when an error or help request is received. The operator can respond directly to a help request by sending a text message to the control system.

  • Page 6: Crestron Roomview Setup

    Windows may be required in order to edit a program with this symbol. Library 2 • Crestron RoomView • The free version of RoomView supports 25 rooms, two users (one of which is the Administrator), and two contacts. • The licensed version of RoomView supports 250+ rooms, multiple users and multiple contacts.

  • Page 7: License Installation

    Use the following procedure to obtain and install the license. NOTE: If the icon is not on the task bar, start the RoomView License Manager from the RoomView program group. Reference Guide – Doc. 6133 www.crestron.com...

  • Page 8: Shared License Setup (Client/Server)

    Software Crestron RoomView 5. Right-click on the RoomView License Manager icon and select About License Manager to view license information. Shared License Setup (Client/Server) RoomView can share a single license among multiple, separate computer installations. One installation (the RoomView server) installs the license from Crestron and the other installations (clients) acquire the license from the computer where the license is installed.

  • Page 9: Setting Up The Clients

    Reference Guide – Doc. 6133 1. Install RoomView. 2. Acquire and install the license. 3. Right-click the RoomView License Manager icon in the task bar and select Preferences. 4. Check Run as a service if desired. 5. Enter the port number for client connections. The default port number is 1000, allowable port numbers are 0 to 65535.
  • Page 10 Software Crestron RoomView 7. Click OK. 8. After login, select About RoomView from the Help menu to display license information. 6 • Crestron RoomView Reference Guide - DOC. 6133...

  • Page 11: Adding And Editing Users

    Crestron RoomView Adding and Editing Users Reference Guide – Doc. 6133 1. Click Users on the Edit menu, or press <Ctrl+U>, or click the Edit Users icon , then click New User. 2. Enter the username. Software Crestron RoomView • 7...
  • Page 12 Software 8 • Crestron RoomView 3. Enter the E-mail address. 4. Enter and confirm the password. 5. Select User or Administrator for the program access. 6. Click the Rooms tab and select the rooms to which this user will have access.

  • Page 13: Adding And Editing Rooms

    NOTE: If you are using an unlicensed version of RoomView, you are limited to a maximum of 25 rooms.
  • Page 14 NOTE: You can assign a new group or select from an existing group by clicking the drop down arrow. 10 • Crestron RoomView 2. Enter a name for the room, and then enter the room location and group if desired. In large applications, the location and group can help organize the rooms and provide useful search parameters.

  • Page 15: Editing Room Parameters

    If no e-Control Link address is specified, the option is hidden in the context menu. An e-Control Link allows the RoomView user to browse to web pages for a given room. An e-Control Link can also point to an executable file generated by VisionTools Pro-e.

  • Page 16: Adding And Editing Room Attributes

    The join number must have a corresponding signal mapped to the RoomView symbol in the SIMPL Windows program. Custom attributes require changes to the RoomView symbol and to the SIMPL Windows program to function. An attribute must be assigned to a room in order for that room to monitor the attribute signal.
  • Page 17 NOTE: If the option to apply to all rooms is selected, the room tab is not shown. Reference Guide – Doc. 6133 2. Reserved attributes are displayed in gray and cannot be deleted. Click New Attribute to create a new attribute or select an existing attribute and click Edit. Software Crestron RoomView • 13...
  • Page 18 Software 14 • Crestron RoomView 3. In the General Tab, enter a Signal name. This is the title of the new attribute. 4. Select a Signal type from the pull down list (Digital, Analog, or Serial). The signal type determines which graphics are available to display the attribute.
  • Page 19 “Edit Room” window, and highlight the Alert Value field to enter a custom notification value for the alert. 12. If the option Apply attribute to all rooms is not checked, click the Rooms tab. Software Crestron RoomView • 15...
  • Page 20 Software Crestron RoomView 13. Check all rooms to which the attribute applies. 14. Click OK to save your changes. 16 • Crestron RoomView Reference Guide - DOC. 6133...

  • Page 21: Adding And Editing Contacts

    2. Click New Contact to create a new contact or select an existing contact and click Edit. 3. In the Name & Address tab enter the contact's name and address. The contact's full name is the only required field. Software Crestron RoomView • 17...
  • Page 22 Software 18 • Crestron RoomView 4. Click the Phone & E-mail tab and enter the telephone numbers and e- mail addresses. 5. As shown below, you can enter up to four e-mail addresses for event notification. 6. Click the Rooms tab and select the rooms that pertain to this contact.
  • Page 23 Crestron RoomView NOTE: A room may have more than one contact and a contact may be assigned more than one room. When you are satisfied with the settings, click OK. Reference Guide – Doc. 6133 Software Crestron RoomView • 19...

  • Page 24: Adding And Editing Events

    Software Adding and Editing Events Events are signals automatically sent from RoomView to the room at a scheduled date and time. Similar to attributes, events contain a name, type (digital, analog, or serial), and a join number that must be programmed in the SIMPL program.
  • Page 25 50, and the data state is 1 (signal on). 4. In an analog event, the data value can be any number from 0 to 65535. 5. In a serial event, the data string can be any string of up to 255 characters. Software Crestron RoomView • 21...
  • Page 26 Setting an Event Value Use the following procedure to set the schedule for this event. 22 • Crestron RoomView 1. Click the Enable this event box to turn the event on and off. 2. Click the Repeating event box if you want the event to repeat continuously.
  • Page 27 4. Click the Weekdays box to select Monday through Friday or click any combination of weekdays for the event. 5. Click the Weekends box to select Saturday and Sunday or click any combination of weekend days for the event. 6. Click the Rooms tab. Software Crestron RoomView • 23...
  • Page 28 Software NOTE: Refer to “Using Crestron RoomView” on page 30 for additional information. 24 • Crestron RoomView 7. Check all rooms that should send this event, or click Select All to enable this event for all rooms. 8. Click OK to complete the entry of a new event.

  • Page 29: Groups

    Edit Group icon 2. The “Edit Groups” window allows you to select either room groups or Attribute groups to view on the main screen. Check the box or boxes of the group(s) you want to display. Software Crestron RoomView • 25...
  • Page 30 3. You can choose to view the rooms by Room Group or Attribute Group. When viewing by group, tabs are displayed at the bottom of the screen for each of the selected groups. Click a tab to display the room(s) belonging to that group. 26 • Crestron RoomView Reference Guide - DOC. 6133...

  • Page 31: Preferences

    General Tab - Startup Options Program Options Because this version of RoomView allows multiple users to access the same database simultaneously, you can also automatically Check for database updates. You can set 1 through 10, and choose minutes, hours, days or weeks.

  • Page 32: E-Mail Tab

    Use Authentication feature on the E-mail tab. Room Messages Tab If the RoomView database is open, you will also see the Room Messages tab shown below. Here you can pre-define up to five responses to help requests.

  • Page 33: Simultaneous Database Access

    Crestron RoomView NOTE: If you have a licensed version of RoomView, you may also create custom messages. Simultaneous Database Access Multiple users can be viewing the same room database at the same time. While the database is open, it may be modified and updated by an Administrator.

  • Page 34: Using Crestron Roomview

    Software Using Crestron RoomView First Time Login Initially, RoomView opens with the following screen: No password is initially required. NOTE: The Administrator should change this password as soon as possible to avoid unauthorized access. NOTE: Passwords are save encrypted in the database.

  • Page 35: Administrator And User Privileges

    RoomView is a password-protected program with two levels of permissions, one for Administrators and the other for Users. NOTE: If you are using an unlicensed version of RoomView, you are limited to two users, one of which must have Administrator access.
  • Page 36 Software Crestron RoomView 6. When you are satisfied with the Administrator settings, click OK. The next time you start RoomView you will need the new user name and password to log on as Administrator. 32 • Crestron RoomView Reference Guide - DOC. 6133...

  • Page 37: Establishing A Connection

    Crestron RoomView Establishing a Connection When RoomView opens, a grid of rooms and attributes are displayed. If no connection is established with a control system, all the status fields display To establish an individual room connection, right-click a room and select Connect from the submenu.

  • Page 38: Navigation

    Edit Users - Opens the “Edit Users” window. Edit Groups - Opens the “Edit Groups” window. About - Displays the version number and date, number of room licensed, and number of rooms used. User Tool Bar 34 • Crestron RoomView Reference Guide - DOC. 6133...

  • Page 39: Attribute Definition

    The join number of default attributes may not be changed • The icon for digital attributes may be changed • The icon for analog attributes may not be changed • Additional attributes may be added (Refer to “Room Attributes” on page 12) Software Crestron RoomView • 35...

  • Page 40: Detail View

    Room attributes are sorted in the same order as they appear on the Main Window. 36 • Crestron RoomView 1. Left click on the name field of any room to display its Detail View. 2. Click the Digital, Analog and Serial buttons to view any and all combinations of signal types.

  • Page 41: Menu Selections

    The View menu allows you to turn the Toolbar, Status Bar and Grid displays on or off. The Default Layout selection returns the screen to the default settings. Access is provided in this menu to view the Entire Log File for the RoomView system.
  • Page 42 The Windows menu permits you to minimize, restore, close or cascade all open detail view windows. The Help menu provides access to the Help Topics, Live Update, and the About RoomView screen. 38 • Crestron RoomView Reference Guide - DOC. 6133...

  • Page 43: Monitoring Rooms

    Crestron RoomView Monitoring Rooms When you start RoomView and open the database, the screen displays a grid with attributes and status indicators for each room. The Name, Location, and Group fields are set by the Administrator when adding rooms. In large applications with many rooms, you can use these fields as search parameters—Refer to “Find Room”...
  • Page 44 Once a system is online, the status of the room is displayed through the various indicators, as shown in the following table. Additional icons are available (refer to “Room Attributes” on page12). 40 • Crestron RoomView • The icons that have been selected for custom attributes reflect current status.

  • Page 45: Sending Messages

    3. Select the message from the pull down menu or type a new message name. 4. Type the message and click Send or Send All to send the message to all rooms. Software Crestron RoomView • 41...

  • Page 46: Help Requests

    Crestron RoomView Help Requests A control system program can send help requests to RoomView. That is, a user in a room can flip to a help page on the room's touchpanel and press a help message button to send a help request to the monitoring station. When RoomView receives the help request, the Help status indicator for that room will change to a red plus sign.
  • Page 47 You can remove messages by clicking the Delete buttons. Click Close to return to the main screen. • The plus symbol remains until all help requests have been responded to or deleted. Software Crestron RoomView • 43...

  • Page 48: Find Room

    Software Find Room RoomView provides a search feature that makes it easy to locate a room in large applications with many rooms. You can search by name, location, group or IP address. 44 • Crestron RoomView 1. Click the Find Room button (or click Find Room on the Edit menu, or press <Ctrl+F>, and select the search parameters from the...

  • Page 49: Log File

    Crestron RoomView Log File RoomView automatically records all database and control system activity into a text file as it occurs. The file is called RoomView.log and is located in the RoomView | Log folder. When the error icon contents for only that room are displayed. If you select Delete Log from the file menu while viewing the contents for an individual room, only the log contents for that room are deleted from the log file.
  • Page 50 Software Crestron RoomView You can use Windows Explorer to open RoomView.log in Notepad. Control system programming can monitor the status of devices connected to the system and can bring up an icon based on the equipment malfunction. 46 • Crestron RoomView...

  • Page 51: Crestron Programming

    Detail View from the Ethernet Modules (Generic) folder of the Device Library. Both the IP address of the control system and the IP ID of the RoomView Interface symbol must match the set the IP ID of the RoomView Interface, double-click the symbol in System Views and click the IP Net Address tab.
  • Page 52 After you set the IP information, go to Program View and open the symbol detail. The RoomView Interface must be defined as shown below. That is, the join numbers are fixed and must be the same for every control system program.

  • Page 53: Digital Signals

    <SysOffWarning> goes high. This is the default setting and can be changed by editing the scheduled time for the SysOffWarning event. In this way, RoomView notifies the room that the System Off event is about to initiate, giving the user time to cancel the event if necessary.

  • Page 54: Serial Signals

    When the icon is clicked, the log file opens and displays all logged events for the clicked room. For RoomView to interpret the error string correctly, the string must be formatted as "<error severity>:<msg>", where error severity is the severity code 0-4, and...

  • Page 55: Network Traffic Analysis

    RoomView. The largest possible packet would be invoked by a help request containing a serial string of 255 characters, resulting in a packet that would total approximately 265 bytes.

  • Page 56: Crestron Viewport

    Crestron Viewport. NOTE: Viewport works on port 41795. The Crestron Viewport is a broad-based mechanism that performs multiple system tasks. It is used for diagnostics and to observe system processes, upload new operating systems and firmware, change network settings, and communicate with network device consoles, among many other tasks.

  • Page 57: Viewport: Edit Menu

    Program load output is data that is generated at the completion of a Send Program command. In 2-Series control systems, enabling the Show Program Load Output option is identical to clicking Program Reset after a program is transferred to the control system. Reference Guide – Doc. 6133 Software Crestron RoomView • 53...
  • Page 58 Incoming data displayed in one pane and Outgoing data displayed in the other. 54 • Crestron RoomView 1. Low Characters controls the display of characters with ASCII values below 20 hex. These characters represent commands, such as <Esc> or <Line Feed>.

  • Page 59: Other Settings

    • Baud rate: 115200 for 2-Series • Parity = None. • Number of data bits = 8. • Number of stop bits = 1. • Hardware handshaking (RTS/CTS) enabled. • Software handshaking (XON/XOFF) not enabled. Software Crestron RoomView • 55...

  • Page 60: Restore Defaults

    Verifies communication between the control system and the PC, and synchronizes the baud rates when they differ. 56 • Crestron RoomView 1. Point to Communications Presets and then click Add. 2. Type a name for the preset, and then select the desired key combination from the Hotkey drop-down list.
  • Page 61 Displays the current capacity of the mailbox and the name of any file that is currently being stored in the mailbox. Reference Guide – Doc. 6133 Suffix Control System Smartouch CNMS Lighting Rack or Card Cage CNRACKX 7:89 CNMSX Internal Relays Software Crestron RoomView • 57...

  • Page 62: Viewport: Functions Menu

    Hard Reset Loads the program that is in permanent memory, or flash PROM, into RAM. This will overwrite whichever program was previously in RAM. 58 • Crestron RoomView • In X-Generation processors, the contents of the mailbox is deleted whenever a new program is uploaded to the control system, or a new file is saved to the mailbox.
  • Page 63 Reference Guide – Doc. 6133 • BRAND X VCR CONTROL.UF takes up 144 bytes of ROM. • BRAND Y VCR CONTROL.UF takes up 128 bytes of ROM. • BRAND Z VCR CONTROL.UF takes up 384 bytes of ROM. Software Crestron RoomView • 59...

  • Page 64: Program Reset

    If the Viewport detects Web pages in Compact Flash, then click Yes to erase the Web pages from Compact Flash, or No to erase Web pages from internal memory. Click Cancel to cancel the operation. 60 • Crestron RoomView ~TEMP1[7] <-- Array out of bounds in BRAND Z VCR CONTROL.UF (Executive Planning Room) ~TEMP[16][17] <-- Array out of bounds in BRAND Z...

  • Page 65: Error Log

    To save the error messages to a file, click Save Error Log to File. Then locate the desired target directory, name the file and click Save. • Finally, to erase the front panel error messages, click Clear Error Log. Software Crestron RoomView • 61...
  • Page 66 Once the IP Table has been uploaded to the control system its entries can be modified or removed: 62 • Crestron RoomView 1. Click Add and select the IP ID of each device from the drop-down list. Enter the IP address in the IP Address text fields and click OK to add the entry to the IP Table editor.
  • Page 67 1700C touchpanel). Each transceiver in a system requires a unique hexadecimal RF channel; Crestron provides 16 channels ranging from 00 to 0F. First select the Net ID of the transceiver, then select the desired RF channel. To verify the new channel, click Report Network Devices on the Diagnostics menu.
  • Page 68 Takes Viewport out of passthrough mode (2-Series only). Configure CNXTA Telephone Audio Interface Card Uploads WAV files to the CNXTA card, Crestron's telephone interface to X- Generation and 2-Series control systems. The WAV files typically provide voice prompts and responses, and must be saved in PCM format at 8000 Hz, 16 bit, monaural (mono).
  • Page 69 Serial Number/TSID Conversion Tool e-Control 2 Activation Reference Guide – Doc. 6133 icon, denoting that the file resides on disk, Function not yet defined. Function not yet defined. Function not yet defined. Function not yet defined. Software Crestron RoomView • 65...

  • Page 70: Viewport: File Transfer Menu

    Send Touchpanel Uploads a compiled Crestron VisionTools First select the Net ID of the panel and click OK. Alternatively, click Send Direct to Wired Touchpanel if the touchpanel is connected directly to a COM port on the PC, or if you are connected to a TPS-5000 or TPS-6000 via Ethernet.
  • Page 71 FREE: If Compact Flash is the current directory, displays the amount of space available on the Compact Flash card. If internal, gives the amount left on internal flash. • XGETFILE: retrieves a file from Compact Flash. • XPUTFILE: sends a file to Compact Flash. Software Crestron RoomView • 67...

  • Page 72: Simpl Windows

    (Alternatively, the IP information can be specified at the page level using the Web tab of each “Page Properties” window.) SIMPL Windows For each IP ID in the browser project, there must be one corresponding Crestron ® e-Control PC Interface symbol defined in the SIMPL Windows program. This symbol is identical to a touchpanel symbol, except that the User interface it represents is a Web browser rather than a touchpanel.
  • Page 73 UPZ files; those for 2-Series processors, in CUZ files. Sometimes upgrades must be extracted from .zip files. Updates are obtained from the Crestron Web site. To download an update, click the file and choose the Save to Disk option, then specify the target directory. If the update is zipped, extract all the zipped files to the same directory and review any "Readme"...
  • Page 74 Software Crestron RoomView Updates are obtained from the Crestron Web site. To download an update, click the file and choose the Save to Disk option, then specify the target directory. If the update is zipped, extract all the zipped files to the same directory and review any "Readme"...

  • Page 75: Viewport: Remote Menu

    Modify; to remove an entry, select it and click Delete. Use the Copy command to make minor modifications to an entry without need to re-type all the information. To connect to an IP address, select it and click Connect. Reference Guide – Doc. 6133 Function not yet defined. Software Crestron RoomView • 71...

  • Page 76: Remote Console

    CNTV. Click Connect and then enter the Net ID of the device to be accessed, then click OK. Once the connection is established commands can be issued directly to that device console from Viewport. To terminate communication, click Disconnect. 72 • Crestron RoomView Reference Guide - DOC. 6133...

  • Page 77: Viewport: Shortcut Keys

    Send Program Alt+T Send Touchpanel Alt+O Update Control System Alt+U XModem 1K Upload Alt+A Address Book Alt+0 through Alt+9 User-specified presets for communication settings Ctrl+F1 through Send User-specified serial strings to the COM port Ctrl+F10 Software Crestron RoomView • 73...

  • Page 78: Ascii Conversions

    Software Crestron RoomView ASCII Conversions 74 • Crestron RoomView Reference Guide - DOC. 6133...

  • Page 79: Further Inquiries

    Crestron award winning customer service team by calling: You can also log onto the online help section of the Crestron website (www.crestron.com) to ask questions about Crestron products. First-time users will need to establish a user account to fully benefit from all available features.

  • Page 80: Software License Agreement

    Agreement, which shall remain valid and enforceable according to its terms. This Agreement may only be modified by a writing signed by an authorized officer of Crestron. Updates may be licensed to You by Crestron with additional or different terms. This is the entire agreement between Crestron and You relating to the Software and it supersedes any prior representations, discussions, undertakings, communications or advertising relating to the Software.
  • Page 81 Crestron or its authorized agents of the Software that deviates from any operating procedures established by Crestron in the material and files provided to You by Crestron or its authorized agent; (3) use of the Software on unauthorized hardware;...

  • Page 82: Return And Warranty Policies

    Purchasers should inquire of the dealer regarding the nature and extent of the dealer's warranty, if any. CRESTRON shall not be liable to honor the terms of this warranty if the product has been used in any application other than that for which it was intended, or if it has been subjected to misuse, accidental damage, modification, or improper installation procedures.
  • Page 83 Crestron RoomView Software This page intentionally left blank. Crestron RoomView • 79 Reference Guide – Doc. 6133...
  • Page 84 Crestron Electronics, Inc. Reference Guide – DOC. 6133 15 Volvo Drive Rockleigh, NJ 07647 01.04 Tel: 888.CRESTRON Fax: 201.767.7576 Specifications subject to www.crestron.com change without notice.

Table of Contents