Wiki source code of Features

Last modified by Scott Kohlmann on 2023/04/21 15:15
Show last authors
1 ShowRunnerCLC™ is a commercial lighting control and lighting management system.  ShowRunnerCLC™ contains a large number of features focused on the needs of the commercial lighting and hospitality markets and is adaptable to the residential market.  Hardware support is extensive and growing all the time.  This document is not a complete feature list and Chief Integrations reserves the right to make modifications at any time.
2
3 {{box cssClass="floatinginfobox"}}
4 (% class="wikigeneratedid wikigeneratedheader" id="HTableofContents" %)
5 **CONTENTS**
6
7 {{toc start="4"/}}
8 {{/box}}
9
10 ==== Key Capabilities ====
11
12 * Configuration driven with runtime adaptability enables rapid commissioning of commercial lighting systems
13 * Extensive feature set allows Crestron systems to comply with the majority of DIV 26s and customer requirements
14 * Large native hardware support with the ability to extend support to new hardware quickly and easily
15 * Touchpanel and web based UIs cover users' needs
16 * Runs entirely on a Crestron processor or VC-4 eliminating the need to manage expensive servers
17 * Floorplans with pinch, zoom, and insight!
18 * Powerful scheduling capabilities enable set and forget scheduling of lighting and easy management to handle changes
19
20 ==== Area Features ====
21
22 * Lighting Loads
23 * Scene recall
24 * Master raise/lower
25 * User configurable scene name, fade time, and load include by scene
26 * Individual scenes may be locked to prevent changing their settings
27 * Individual load control within an area
28 * Area selection from touchpanel, areas can be restricted by panel
29 * RGB controls for applicable fixtures, saved per scene
30 * Configurable Load Grouping for load consolidation including linked/group area loads
31 * Dynamic White/Circadian Rhythm CCT Control
32 ** CCT Control per area for applicable fixtures
33 ** Global schedule for CCT, astronomical and/or fixed schedules
34 ** Manual CCT override per area
35 * Demand Response with ability to exclude area from Demand Response event
36 * Configurable load grouping allows aggregation of loads to a single slider per group, can include linked areas
37 * HVAC Control
38 * Shades
39 * Occupancy Features
40 ** Occupancy Modes
41 *** Occupancy
42 *** Vacancy
43 *** Disabled
44 *** Use Hardware Logic (if supported by edge controller)
45 ** Extend occupancy timeout by user specified seconds, can be scheduled
46 ** Configurable occupied and vacant scenes, scheduled
47 ** Configurable grace occupancy support without needing support in hardware
48 * After Hours support for automatic shutoff after configurable timeout w/ alerting
49 * Parent Area feature allows one area to trickle down scene recall and raise/lower (if enabled)
50 * Last Scene Recall timestamp and triggering action recorded
51 * Organized in a node tree with multiple depths
52
53 ==== Load Features ====
54
55 * Dynamically assigned/unassigned at runtime to areas
56 * Supported load types
57 ** Single Channel
58 ** Dynamic White/CCT
59 *** Warm/Cool
60 *** Intensity/CCT
61 *** DALI Type 8
62 *** Pharos Dynamic White
63 ** RGB/W/A
64 *** Color Picker
65 *** W/A channels can be controlled individually or mixed (Pharos)
66 * Supported load behaviors
67 ** Dimmable
68 ** Switched
69 ** Plug Load
70 * Dimming Curves
71 ** Unaffected
72 ** Linear
73 ** Linear No Zero Pass (support for EM lights that are not allowed to turn off i.e. Chicago 10%)
74 ** Logarithmic
75 ** Non Dim
76 ** S Curve
77 ** Soft Linear
78 ** Square
79 ** Always On
80 ** Inverse Log
81 ** Custom based on input output ranges
82 * Min/Mix Trim, performed in hardware if supported
83 * Override Level, performed in hardware if supported
84 * Unoccupied Level
85 * Demand Response Level
86 * Enable/Disable/Override states
87 * Option to ignore long fade times if the loads is off
88 * Option to recall last on level
89 * Individual daylight harvesting settings, enabled/disabled by scene
90 ** Open/closed loop
91 ** Min/Max levels
92 ** Sensitivity
93 ** Fade time
94 * Loads may track other loads
95 * Remap channels for unusual fixture channel mappings
96 * Raise/lower, performed with software fade engine if not supported by hardware
97 * Dynamic White/Circadian Rhythm CCT
98 ** Custom CCT curves per load or default algorithm
99 ** Min/Max CCT per load
100 ** Support for Warm/Cool or Intensity/CCT fixture types
101 ** Configurable automatic fixture shut off if outside CCT range
102 ** Crestron GLS-LCCT (SolarSync™) sensor integration for daylight tracking
103 * Load flashing for identification
104 * Verified timestamp option
105 * DALI (DIN-DALI-2/ZUMNET-JBOX-DALI Legacy mode)
106 ** Addressing/Grouping/Driver Replacement for DALI.  DALI groups are referenced by their controlled load simplifying addressing and replacement procedures.
107
108 ==== Scheduling Features ====
109
110 * Algorithm based scheduling engine ensures predictable operation year after year with no need to define a system wide schedule per-day
111 * Area and/or Tag based schedules
112 * Individual global events or grouped events
113 * ShowRunnerCLC™ HUB UI Features
114 ** Day/Week/Month/Time Grid views display all events calculated by the scheduler engine
115 ** Tree based event/event groups
116 ** View Built-In Calendars and Groups
117 ** Create/Edit/Delete Custom Calendars and Groups
118 * Execute last event on startup (configurable) to bring system in to correct state
119 * Configurable Actions
120 ** Scene w/ option to override fade time
121 ** Change Keypad State (Enable/Disable/Disable Off)
122 ** Change Occupancy Mode (Occupancy/Vacancy/Disable/Last/Use Hardware)
123 ** Switch between Normal and After Hours (for Timeout)
124 ** Change CCT Mode (Auto/Manual)
125 ** Assign Manual CCT
126 ** Extend Occupancy Timeout setting
127 ** Change Scenes Recalled by Occupied/Vacant/On/Off
128 ** Shade Command (Open/Close)
129 ** Plug Load Mode (Off/On/Auto)
130 * Copy Actions from Area to Area
131 * AM, PM, and Relative to Astronomical (Sunrise/Sunset) Time References
132 * Event Verification by Date in real-time with month calendar view and event description
133 * Require a scene to be active before recalling the scheduled scene (optional)
134 * Advanced Scheduling Feature (Licensed)
135 ** Event Include and/or Exclude by Calendar(s) and/or Calendar Group(s)
136 ** Calendar Groups consist of one or more Calendars
137 ** Calendars can be based on a Date Range or Date Pattern
138 ** Calendar Properties:
139 *** Date Range:
140 **** Start and End Dates
141 **** Specific Dates selected using Date Picker
142 **** Recur Annually Option
143 *** Date Pattern:
144 **** Year - Restrict to specific year or none
145 **** Month - Restrict to specific Month(s) or none
146 **** Week - Restrict to specific Week of the month or none
147 **** Week Day - Restrict to specific day of the week or none
148 **** Day - Restrict to a specific day of the month or none
149 **** Optional: Offset - Offset date based on restrictions
150 **** Optional: Calculate Observed Weekday Date Before, After, or BeforeOrAfter
151 *** Enable/Disable
152 ** Pre-loaded with US Federal and common non-Federal US Holidays
153 ** Support for additional algorithms available upon request
154
155 ==== Circadian Rhythm/Dynamic White ====
156
157 * Global system CCT Level
158 * Override CCT per area by scene or manually
159 * Crestron GLS-LCCT (SolarSync™) sensor integration for daylight tracking
160 * Time period based
161 ** Time References for start and end of period
162 *** AM/PM
163 *** Relative to
164 **** Sunrise
165 **** Sunset
166 **** Solar Noon
167 ** Each time period can have the following setting for CCT
168 *** Static
169 *** Linear change over time
170 *** Sensor with configured CCT when sensor is out of range
171 * Supported with 0-10V, DMX, and DALI. Additional support via APIs
172
173 ==== Supported Hardware Features ====
174
175 Virtually the entire Crestron lighting product line is supported along with several 3rd party products
176
177 * Common Settings to all devices
178 ** Contractor Label
179 ** Name
180 ** GlobalId
181 ** UniqueId (GUID)
182 * HVAC
183 ** Temperature control by area
184 ** Support for some Crestron Thermostats, more can be added as needed
185 ** Support for some 3rd party systems, more can be added as needed
186 * Keypads
187 ** Support for common fixed configurations, user assignable at runtime. Includes all standard Crestron SpecsBuilder types.
188 ** Custom keypads with configurable actions per button at runtime
189 *** Graphic based programming using ShowRunnerHUB™ UI
190 *** Master raise/lower button support allows assignment of currently selected load/shade/area/etc
191 *** Custom button layouts w/ labels to assist with generating engravings
192 ** Flexible Templating Engine
193 *** Create common keypad templates
194 *** Apply keypad templates to individual keypads
195 **** Remap hardware when template is applied
196 **** Optionally exclude specific hardware and/or buttons
197 ** User configurable area to control
198 ** Enable/Disable/Disable Off states
199 ** Prevent disable option
200 ** Flip raise/lower on common keypad types
201 ** Configurable hold time support, done in software if not supported by hardware
202 ** Configurable double tap time support if supported by hardware
203 ** Simulate keypads from ShowRunnerCLC™ HUB UI or console
204 ** Direct load mapping for some common keypads
205 * Keyswitch/Contact Closure Inputs
206 ** Supports all versiport and digital inputs
207 ** Maintained and Momentary supported
208 ** Feedback output supported
209 ** Functions
210 *** Override
211 *** Scene Recall for Active and Inactive States
212 *** Demand Response
213 *** Actions for Active and Inactive States
214 ** Commonly used for FACP, override, demand response, and panic inputs
215 * Occupancy Sensors:
216 ** Occupancy configuration for CN and ZUMLINK occupancy sensors
217 ** ​3rd Party and Non-System occupancy sensor support
218 ** Occupancy/Vacancy/Disabled/Use Hardware Logic modes, user configurable
219 ** Configure scenes recalled by area for occupancy and vacancy states
220 ** Individual max unoccupied level by load for IECC 2018 C405.2.1.3 compliance (open office 600sqft)
221 ** User configurable assignment of sensor to area(s) and load(s)
222 ** Occupancy sensors may feed data to multiple areas and loads
223 ** Last occupied and vacant times recorded
224 * Output Signal
225 ** Logic object capable of triggering additional logic
226 ** Can trigger physical outputs via versiports/IOs
227 ** Supports conditional logic
228 ** Independent actions for active/inactive states
229 ** Configurable delays for active/inactive execution
230 * Partition sensors
231 ** Support for divisible areas
232 ** GLS-PART-CN with adjustable sensitivity
233 ** 3rd party sensor support via hardware inputs
234 ** User configurable Auto (use sensor) with manual override for Combined and Divided
235 ** Filtering to ignore noisy partition sensors
236 ** Change count and last change recorded help troubleshoot
237 ** Hardware not required, may be setup as a virtual sensor
238 * Photocell
239 ** Supports Open Loop, Closed Loop, Exterior, and LCCT (as SolarSync™ and exterior)
240 ** Configurable coefficient
241 ** Configurable thresholds
242 ** Assignable to individual loads for daylight harvesting
243 * Serial Interface
244 ** RS-232/422/484 depending on hardware
245 ** Configurable Baud Rate and Com settings
246 ** Simple ASCII API for controlling/monitoring
247 ** Areas/Loads/Occupancy/Partition/Shades supported
248 * Shades
249 ** Support for Crestron shades/drapes
250 ** Support for many 3rd party shade and drape systems
251 * Zum Wired
252 ** Edge logic operation in Zum App mode
253 *** Override occupancy logic and use ShowRunnerCLC™ logic
254 ** Central logic in CNET mode
255 ** Cresnet devices attached to ZUMNET-JBOXs in either Edge or Central modes
256 * Zum Wireless
257 ** Override keypad buttons (except buttons 5-6)
258 ** Edge logic operation
259 ** Override occupancy behavior with ShowRunnerCLC™ logic
260 ** Direct load control
261 ** Scene save
262 * Support for configuring hardware symbol properties on Crestron hardware
263
264 ==== Energy Efficiency ====
265
266 * Demand Response/Load Shedding
267 ** Automatic via sensor input
268 ** Manually via user input
269 * Calculated or Measured Power (Watts)
270 * Energy Efficiency visualization on floorplan
271
272 ==== Security ====
273
274 * Touchscreens: Global User and Technician Passcodes, user configurable.
275 * ShowRunnerCLC™ HUB
276 ** Role Based permissions by Group
277 ** Granular Create, Edit, View, Delete, and Execute permissions by Role
278 ** Users and API Users assignable to groups
279 ** Restrict Group by area and tag
280 ** HTTPS enforced
281 ** Auto session timeout
282 ** Login via username/password or PIN code
283 ** Support for Processor and internal user database with configurable priority or specify one exclusively
284 ** Best practices for password handling
285 * API using AWSv4 scheme for authentication per request for maximum security
286 * Encrypted storage of all credentials and keys
287
288 ==== General Features ====
289
290 * User configurable time zone, location, and current time
291 * Addressing and Verification of Cresnet devices by serial number
292 * Cresnet Device Serial Number capture
293 * Extensive console command interface (CLI)
294 * Simulate sensor and keypad inputs to test without hardware
295 * DHCP server on single LAN processors allows setup of isolated networks without additional DHCP server. 
296 Note: DHCP server is not designed to be used in production and will automatically be disabled on a reboot, use for setup only.
297
298 ==== Diagnostics ====
299
300 * Provides diagnostic data when supported by hardware
301 * Diagnostics available from load controllers all the way up to Cresnet bridges
302 * Status indications quickly assist with identifying severity of the problem: Normal, Warning, Critical, Status Only
303
304 ==== Discovery ====
305
306 * Discover and automatically define Zum Wired hardware
307 * Discover and automatically define Zum Wireless hardware
308 * Discover Cresnet devices connected to the system, automatic addressing for configured hardware by serial number
309 * Discover and claim select Crestron Ethernet devices connected to the local network, automatic IP Table setup when claiming
310
311 ==== Event Log ====
312
313 * Central logging mechanism
314 * Messages time stamped
315 * CSV format
316 * Multiple logging levels: Critical, Error, Warning, Information, Debug, Trace
317 * Filter by logging level
318 * Filter by source object
319 * Filter by GlobalId
320 * Trace option allows tracking the triggering event through execution
321 * Thread option allows tracking of the thread executing
322 * Logging to console
323 * Logging to file
324 * Logging to remote syslog (via processor)
325 * Heartbeat option with configurable interval
326 * Debugging writes to the event log
327 * Global Enable flag
328
329 ==== Extensibility ====
330
331 * Actions
332 ** Logic objects exist on ShowRunnerCLC™ objects
333 ** Functionality can be triggered via APIs
334 ** Used for defining the behaviors of global actions, custom keypads, and numerous other logic operations within ShowRunnerCLC™
335 * Extensions
336 ** Extension model allows customization and additional functionality to be added to the ShowRunnerCLC™ ecosystem
337 ** [[Supported functions>>doc:SHOWRUNNER™ Integrations Guide.Integration Options.Extensions.WebHome]]
338 * Global Actions
339 ** Allow manual or input triggered operations against the system
340 ** Can be custom programmed at runtime
341
342 ==== User Interfaces ====
343
344 * ShowRunnerHUB™
345 ** Web based, touch and mouse friendly design
346 ** Runs directly on the processor or VC-4 instance
347 ** HTTPS required
348 ** Can be run in kiosk mode on a touchscreen PC for the full touchscreen experience
349 ** Node Tree
350 *** Organize areas in logical locations based on physical topology
351 *** Searchable, only shows matching areas
352 ** Floorplans
353 *** Assigned to a node, multiple floor plans are supported
354 *** Pinch zoom/touch pan
355 *** User provided floorplan
356 *** Draw directly on floorplan for areas and objects
357 **** Areas
358 **** Loads
359 **** Partitions
360 **** Occupancy Sensors
361 **** Keypads
362 **** Photocells
363 *** Crestron product line icons area available to match the installed sensor
364 *** Interactive control screens depending on clicked object
365 *** Multiple different views help visualize data
366 **** Area View - Shows areas with user selected colors
367 **** Tags View - Shows areas based on their assigned tag
368 **** Occupancy View - Shows areas based on their current occupancy status and how recently that status changed
369 **** Intensity View - Shows areas shaded based on the current overall light intensity
370 **** Energy View - Shows areas shaded based on the areas current energy efficiency from efficient to inefficient
371 *** Automatic navigation to area when selected from the node tree
372 *** Fullscreen view
373 ** Schedule
374 *** See [[Scheduling Features>>doc:||anchor="Scheduling Features"]] for more info
375 ** Reports
376 *** Interactive data
377 **** Area Loads
378 **** Area Scenes
379 **** Areas
380 **** Cresnet (Query)
381 **** Device Status
382 **** Events
383 **** Keypads
384 ** Setup
385 *** Device Diagnostic - Show Diagnostic data from supported devices
386 *** Hardware Management - Tree view of Ethernet, Cresnet, and RF topologies
387 *** File Management - Manage config, license, currently active config, and backup/restore operations
388 *** Global Actions - Add/Delete/Configure
389 *** Integrations - Manage integrations with other ShowRunnerCLC™ systems
390 *** Keypad Configuration - Configure keypads
391 *** Maps - Add/Manage floorplan images
392 *** Network - DHCP Server (for processors without routers only)
393 *** System Settings - Manage various system settings
394 *** Tags - Manage tags and association of tags with areas
395 *** User Management - Manage users/groups/API users
396 * Crestron TS/TSWs and Crestron App (iPad/iPhone/Android)
397 ** Area Control Screen
398 *** Select Area (Can be disabled or restricted)
399 *** Divide/Combine status, if divisible
400 *** Occupancy/vacancy status, if has an occupancy sensor
401 *** Individual load controls
402 *** Dynamic white color temperature control, if supported
403 *** RGB color picker, if load supported
404 *** Scenes, up to 20, save with press and hold
405 *** Master Raise/Lower
406 *** Global Actions, if defined, can be hidden
407 *** HVAC controls, if supported
408 *** Shade controls, if supported
409 *** Passcode protected, if enabled
410 ** Setup Screen
411 *** Passcode protected, if enabled
412 *** Area Configuration
413 **** Area List
414 **** Area Name, editable
415 **** Load Configuration - Configure load control type and labeling, test fixture operation
416 **** Occupancy Setup - Configure area occupancy behavior and occupancy settings
417 **** Daylight Harvesting - Configure daylight harvesting settings per load/scene
418 **** Scene Setup - Configure and add/delete scenes
419 **** Properties - Configure area behavior settings
420 **** Add/Delete areas
421 *** Area Layout - Configure partition sensors and area assignments to partition sensors
422 *** Crestron Integration - Configure EISCs
423 *** Device Addressing - Address and verify Cresnet devices
424 *** Keypad Configuration - Configure keypad type, area assignment, and enable status
425 *** Load Hardware - Configure loads and load controllers
426 *** Location and System Clock - View/Set system clock, site lat/lon, and timezone
427 *** Occupancy Assignment - Assign occupancy sensors to loads/areas
428 *** Scheduler / Events - Add/Edit/Delete events, configure calendars, configure actions (for non-group events)
429 *** Security Settings - Enable/Disable/Change PIN codes
430 *** Zum Integration - Configure export to Zum Floor Hub
431 *** Help Screen - Support contact information,  ShowRunnerCLC™ version list, and license status
432 ** Custom Logo option for splash screen
433 ** Optional floor plan area selection, zoom/pan are NOT supported, static image only
434 ** Optional partition control on floor plan screen
435
436 === Integrations ===
437
438 * AV Integration protocol via serial port, simple ASCII protocol with feedback
439 * BACnet Support for integration of Areas, Loads (Licensed Feature, both ShowRunnerCLC™ and Crestron)
440 ** Global
441 *** Override
442 *** Demand Response
443 *** Device Offline Count
444 *** Alarm
445 *** System Normal/After Hours
446 ** Area Specific
447 *** ShowRunnerCLC™ Mode
448 **** Occupancy Status
449 **** Occupancy Enable
450 **** Scenes
451 **** Loads
452 **** Photocell Level
453 **** Overall Intensity
454 **** Power (watts)
455 *** Zum Hub Emulation Mode
456 **** Online
457 **** On
458 **** Scenes
459 **** Occupied
460 **** Occupancy Sensor Enable
461 * Crestron Fusion EM (Licensed Feature)
462 ** Scenes, Recall and Save
463 ** Load Control
464 ** Occupancy Status
465 ** Photocell
466 * e-DMX Receiver
467 ** SACN and/or Art-Net
468 ** Enable/Disable control for loads using e-DMX channel value
469 ** Map DMX to ShowRunnerCLC™ loads
470 * EISC Export for AV Integration, dynamic creation from the UI (3-series, classic, EISC Client, EISC Server, VC-4 Client)
471 ** Configurable IP address and IP-ID, change at runtime
472 ** Configurable rooms to export, change at runtime
473 ** Changes generate new RSD file at runtime that may be provided to the AV programmer
474 * HTTP REST API w/ Authorization
475 * Lightweight API provides real-time control/feedback using CoAP
476 * TCP Interface using simple ASCII commands, subscriptions supported
477 * UDP Receiver using simple ASCII commands
478 * Zum Floor Hub Support for integration, Export ShowRunnerCLC™ areas to the Floor Hub (Licensed Feature)
479 * Remote hardware support from neighbor ShowRunnerCLC™ System:
480 ** ​Allows a central ShowRunner system to integrate edge processors
481 ** AV Serial Interface
482 ** Loads
483 ** Controllers
484 ** Keypad
485 ** Keyswitches
486 ** Occupancy Sensor (including setup for Cresnet sensors)
487 ** Partition Sensors (including setup for Cresnet sensors)
488 ** Photocells
489
490 ==== Reporting ====
491
492 ShowRunner provides a website via the processor's internal webserver with the following reports.  All data is live at the time of the generation of the report.
493
494 * Area Load Schedule - Load schedule by Area
495 * Area Scene Schedule - Scene settings by Area
496 * Area - Areas defined
497 * Cresnet Discovery - Performs an auto-discovery on every attached Cresnet bus and returns the results in a table.  Duplicates are identified.
498 * Device Status - Provides Cresnet, Ethernet, and Device online status and associated devices.  Cresnet devices include Serial Number [TSID] and version #.
499 * Event Schedule - Provides configured lat/lon, timezone, sunrise and sunset for current date, scheduled events with associated actions, and Calendars (Advanced Calendaring)
500 * Keypad Schedule - Provides a list of keypads with Model, Name, Type, Connection Details, Enabled Status, Online Status, settings, and custom actions (if defined)
501 * Load Schedule - Provides a list of loads per module per panel with connection information and settings.  Report is grouped by panel and module.
502 * Panel Schedule - Provides a list of lighting modules by panel with module type, label, and connection information.

Navigation