£
$

FAQ

admin on October 7, 2023

2N

What models of 2N Hardware are supported.
Where can i find the 2N Driver in Crestron Home

Within the Crestron Home Setup App, navigate to Step 2 > Drivers > Locks.

LCD Licensing

How do I associate a Licence to a new Processor if my processor is bricked

For Products Launched prior to October 2023 if you cant deactivate the licence on the original hardware then the only way is to drop us a support ticket requesting the deactivation.

For products post October 2023 you can deactivate the licence your self on the hardware or on the licence management page. Once you deactivate a licence for an active product the active licenced product will no longer be functional and its function until a new licence is applied and activated.

LCD Crestron Simpl Modules

admin on May 17, 2023

Whats in the download

How to transfer into my own project

Each solution has detailed instruction on the main and submodules included within it however as a rule and a minimum you need to add the clz file and the main USH to your project root folder and then re-sync to make the modules show up in Simpl Windows.

Licensing and License Keys

We protect our IP and our investment by securing the functionality of our drivers using a system of a licencekeys which can be purchased from our web store.

The licensing system we have created is flexible to allow you to easliy apply licenses and to be able to move and reassign licence keys as required e.g. when a hardware swap is required.

We also anticipate that many of you are running scalable cookie cutter code where you need not to worry about managing induvidual licence keys per room.

For many of our tools we will provide you with a multi instance licence which allows you to put the same key into many programs. Each instance will register (activate) its own entitlement and you can manage you key usage on your myaccount page on our website.

Versioning

We want to be able to continue to improve the softwrae that we offer so good versioning and metrics on performance are key. When we have a new updated version available we really want you to be using it right away. Updated versions are posted on the product page, our social media channels and posted on our release pages to which you can subscribe. When compiling in Simpl windows we will actively ensure you are running a good pari of clz and Ush and warn you in the compile if we think this doesnt look good!

Furthermore if we detect in runtime a mismatch of the Simple+ File and the clz file that accompanies it we will do our level best to let you know that there is a version mismatch.

LCD Structured Logging

We have created some powerful tools for logging our software and these are used in all of our modules for crestron Simpl. We have also made these tools available for you to use in your programs more widely regardless of if you are using our modules or not you can benifit from our structured logging tools.

Currently these logs can be routed to the Crestron Console , or to a file stored on the processor.

We also log to our LCD Logging server in the cloud although if you dont want to do this its easy to turn off!

Soon in a free update to the logging tools we will allow you to log directly to your own cloud server which will enable you to log your programs and systems without ever needing to connect to the processor or local network.

InnerRange Inception Security SIMPL Windows Module User Manual

Tony Howard on May 11, 2023

DRAFT

“Simple & Easy Installation
Integrated Security – Access Control”

SIMPL Windows Modules

Our Inception modules for Crestron SIMPL windows consists of a central hardware connection module and multiple companion modules for control of areas, doors, inputs and outputs.

The Inception modules for Crestron SIMPL windows are compatible with 4 series processors and VC4.

Hardware Configuration

The central hardware connection module connects to the Inception as a standard user. The best practice is to create a user just for the Crestron system and set the web page profile to “REST Web Api User”. The user must be added with the relevant permissions for the Areas, Doors, Inputs and Outputs that you wish to control and monitor.

The area module arming and Disarming actions can be performed with or without a user pin to be entered.

  • Arming and Disarming with a pin – the action will be performed as the user associated with that pin, their area permissions checked and their name logged in the review event history. Each users area permissions should be enabled or disabled as necessary for the user requirements.
  • Arming and Disarming without a pin – the action will be performed as the REST Web Api User, using the REST Web Api User area permissions and name in the review event history. The REST Web Api User area permissions should be enabled or disabled as necessary the arming and disarming without pin requirements.

Here is an Example of a User Setup to Access Alarms , Doors and Inputs.

In addition any Security Areas you wish to control should have the Multi-Mode Arming Setting Checked as show in the Screenshot here

Where to download the module and purchase a licence

#container downloads, demo licences, purchased licences

Using the example project

We advise that you first run the supplied example project on your processor to understand how each of the InnerRange Inception modules work and confirm your InnerRange Inception is setup correctly

#container or link about using the example project

Adding modules to your system

Dynamic User interface Manual

Web Admin on November 10, 2022

  • Customisable UI Tile
  • Up to two, two state buttons
  • Customise Icons and State Text on Buttons
  • Customise and enable tile Icon (Update from multiple Buttons)
  • Extensive flexibility of usage through events and actions.
  • Show and Hide Buttons based on other button states.
  • Passthru Logic Functions for each button state.

Build your own UI with custom Buttons with feedback.

Like Quick Actions but so much more!

Usage

Currently we offer two different dynamic button drivers , a single button and a customisable user interface which offers up to ten buttons on a single user interface page, both also allow the use of the room tile aswell.

These two drivers allow for a multitude of uses to control and monitor the state of devices, functions and controls. The possibilities are really endless.

We have documented many examples in our library of use case examples here

Home View

From a user perspective the user interface provides a tile element on the room page and/or home page and a button or buttons in the main user interface page.

These buttons display an on or off state which can be changed by pressing the button (toggle) changed by pressing the room tile. Or changed using the Actions and Events System in Crestron Home.

In addition to the above which is all configurable in settings, the driver exposes a number of settings, actions and events making the simple button a hugely powerful control element.

Each State allows customisation of the text and icon , In addition the room tile icon and text can be set via actions allowing effecively many states including error states to be displayed.

The buttons can be used just as a status indicator with no user interaction via the user interface. Setting the state using Actions allows the state of a device or system to be displayed to the user.

The buttons state can also be used as a in simple logic allowing you only to allow or to action certain events in your system if the button is in a certain state.

Room View

Setup

Using the Setup pages of the driver you can hide and show buttons and setup the on and off text and icons for each of the buttons you require. NB: Dynamic Button single only has one button although you can hide it if you want!

The setup of the buttons is stored persistantly meaning once you setup a driver the settings will persist a reboot of the driver. The available settings are detailed in the table below and can be found in the setting page of the driver. Acces the setup pages as descibed here

Settings Page

The Settings page shows all current buttons.

Unique Index and Name

The Unique Index is shown for each button. This is used when setting up your actions and events. The name is just added for your reference.

The Current Text and Image are shown for each state.

Edit

The Edit Button (Sliders) allows you to change the Name and for each state the icon and text. In addition all of the per button settings can be found in the button edit page.

The Per Button Settings are detailed in the table in the related section further down this page.

Edit Button Page

The Icon select page is shown when you click to change a state Icon or the tile icon.

Simply click on the icon you wish to use and the Icon will update.

NB: Icons only update on the User facing button once a state change has occured.

Events and Actions

Setting NameDescription TypeNotes
NameName of button only used for your own reference.Text
Off State TextThe text displayed on the button when in the Off stateText
Off State IconThe Icon displayes on the button when in the Off stateIcon Selector
On State TextThe text displayed on the button when in the On stateText
On State IconThe Icon displayes on the button when in the On stateIcon Selector
Reboot Forces Button StateForce the Button state Off/On instead of using the memorized state (State at shutdown)Checkbox
Reboot Forces Button Off StateForce the Button state Off after a reboot CheckboxOnly visible if Reboot forces Button state
Reboot Forces Button On StateForce the Button state On after a rebootCheckboxOnly visible if Reboot forces Button state
Reboot Fires Button State EventFire the Button State Event after a rebootCheckbox
Button Is VisibleButton is shown on the User InterfaceCheckbox
Ignore Button PressesButton Presses on the user interface do not toggle the state of the button. Select if only using as a status button.Checkbox
Show User WarningShows warning on the user interface to warn user that button is ignored.CheckboxOnly visible if button ignored
Button State Changes Room TileAny state change of the button will cause the room tile to display the same icon and text of the button in the new state.Checkbox

Actions

ActionDescriptionParameterValueParameter 2Value
Passthru LogicTriggers the Button Passthru Off State event or Button Passthru On State event depending on the buttons stateButton1-10 *State to PassthruTest Both States
Triggers the Button Passthru Off State event only if the button is in an off stateButton1-10 *State to PassthruOnly Test Off State
Triggers the Button Passthru On State event only if the button is in an on stateButton1-10 *State to PassthruOnly Test On State
Set Button State and EventTriggers the Button State Set Off event and displays the button in an off state Button1-10 *State to setSet to Off State
Triggers the Button State Set On event and displays the button in an on state Button1-10 *State to setSet to On State
Toggles between the Button State Set Off event and Button State Set On event as well as update the button display stateButton1-10 *State to setToggle the State
Set Button StateChanges the button state to off without triggering the Button State Set Off eventButton1-10 *State to displayDisplay as Off State
Changes the button state to on without triggering the Button State Set On eventButton1-10 *State to displayDisplay as On State
Set Button VisibityShows the button on the user interfaceButton1-10 *Visibilty to setShow the button
Hides the button on the user interfaceButton1-10 *Visibilty to setHide the button
SetTileTextThis Event Sets the tile text from a list of available icons. This will be overidden by an icon from a button if enabled.TextText to Set
Set Tile IconThis Event Sets the tile icon from a list of available icons. This will be overidden by an icon from a button if enabled.IconList of Images

Events

EventDescriptionNotes
Button State was Set OffThis event fires whenever the button is set to the off state from the user interface or the Button Set To State action
Button State was Set OnThis event fires whenever the button is set to the on state from the user interface or the Button Set To State action
Button PressedThis event fires whenever the button is pressed on the user interface even if the Ignore Button Presses setting is enabledThis event always fires even is the Ignore Button Presses is setting is enabled
Button Passthru Off LogicThis event fires whenever the Button Passthru action is triggered and the button is in an off state
Button Passthru On LogicThis event fires whenever the Button Passthru action is triggered and the button is in an on state
Room Tile PressedThis event fires whenever the room tile is pressed on the user interfaceThis event always fires even is the Ignore Button Presses is setting is enabled
Driver LoadedThis event fires whenever the driver is loaded, like after a reboot or if the driver name is changed

Some Dynamic UI Ideas

Web Admin on November 10, 2022

BMS Example

For Example you might simply want to display the states of BMS Warnings in the property:

  • Displayed on the front page so users can at a glance check the status
  • Customise the Alert Reporting Text to show the current Status
  • Push Action on the button can be used to repoll the connected system

Sprinkler Example

  • Displayed on the front page so users can at a glance check the status
  • Customise the Names of the controlled Sprinklers
  • Group many Sprinklers into a single control

Use Case: 3rd Party Lighting

Tony Howard on November 9, 2022

When 3rd party lighting is in use in a system or mixed together with a few native Crestron Loads , bring things together into a central location using our Lighting Scheduler with a home page tile enabled.

User Features

  • Whole house Control
  • User Editable Schedules
  • Event History

Added Extra

If you want to Schedule PIR Control of your lighting then control the functionality on a Schedule and with a button to allow overide control and status.

Featured Drivers

Sprinkler Scheduler User Manual

lamine benbada on September 14, 2022

Schedule Sprinkler Events In Crestron Home

Crestron Home owners can now modify there own schedules!

Each sprinkler scheduler driver includes 4 user editable schedules for up to 10 dealer defined events

Usage

Once the quick setup is completed, users can modify schedules, override schedules and view the event history all with just a few clicks!

All of our Scheduler products have the same base functionality which is described below.

From the room page or home page of any Crestron Home User Interface the user can see the latest event status of the scheduler.

Click the navigation button to access more schedule functions.

The user is presented with manual override buttons as well as the current schedule information.

Simply click any of the override buttons to action that event immediately.

To edit any of the schedules simply press the Edit button associated with the schedule.

For each schedule you can:

  • Change the schedule name
  • Enable or disable the schedule
  • Change which days the schedule should run
  • Change the time the schedule should run
  • Change the event the schedule should run

System Setup

Add the Heating Scheduler

You can find driver in the Drivers section of the Crestron Home Setup App under:

Drivers -> Scheduler -> LCD Scheduler

Add the scheduler to your desired room

Enter the License Key

The Heating Scheduler license is a single licence, you can find more information regarding our licence types here at our Licensing Info Page

After you install the driver, you can add your licence details in any of the following places:

  • The driver installation settings of the Crestron Home Setup App
  • The installed driver page of the LCD Web App More Info Here
  • The drivers license settings on any Crestron Home User Interface

Access the driver settings

You can find the heating scheduler settings in the Crestron Home User Interface

Navigate to the room where you installed the driver

Click on the driver navigation button

Click on the Driver Settings button at the bottom of the page

Driver Settings

Heating Scheduler Customisable Events

The Heating Scheduler has up to 10 customisable events that can be triggered by any of the schedules or by using the manual override buttons.

Each of the customised events that you setup will also need to be pre-programmed in the Actions and Event section of the Crestron Home setup app.

An example of some typical events you might set up for the end user would be:

  • Simple on/off controls like “Heating On” and “Heating Off”
  • Direct temperature controls like “Set Heating to 22 C”, “Set Heating to 23 C” …
  • Device specific controls like “Quick Heat” or “Heating Setback”

The events you choose to setup will mostly depend on the device you are controlling and its actions available in Actions and Events.

Customising the Heating Scheduler Events

You customise the heating scheduler events in the drivers settings page on any Crestron Home UI

once you are on the driver settings page, press the “Event Setup” button at the top of the page and then select which event you would like to customise

Customisable options for each event include:

  • The event name which will be displayed:
    • to the dealer in actions and events
    • to the end user on the main schedule pages
    • to the end user on the UI tile after the event is triggered
  • The event icon which will be displayed:
    • to the end user on the main schedule pages
    • to the end user on the UI tile after the event is triggered
  • The option to show or hide this event on the main schedule pages

Additional Schedule Settings

Schedule Page Heading

Set the heading that is displayed to end user on main scheduler pages

Schedule Main Page Options:

User Can Edit Schedules Option – turn off to block the end user from modifying any of the schedules

User Can Enable/Disable Events – turn off to block the end user from changing the global event enable/disable function

Schedule Edit Page Options:

User Can Edit Name – Turn off to block the end user from changing the schedule names

User Can Edit Days – Turn off to block the end user from changing which days the schedules will run

User Can Edit Time – Turn off to block the end user from changing what time the schedules will run

User Can Edit Event – Turn off to block the end user from changing which event the schedules will trigger

Settings , Actions and Events

Setting NameDescription TypeNotes
Event SetupNavigation to event SetupEvent ListAllows you to chage names of Events and set an icon.
User can Edit SchedulesIf checked the user can edit the schedule.Checkbox
User can Enable/Disable EventsIf checked the user can enable and disable the scheduled events from firing.CheckboxNB: This does not disable the schedule just stops the events from firing.
User can edit NameIf Checked the user is allowed to edit the schedule name.Checkbox
User can Edit DaysIf Checked the user is allowed to edit on which days the schedule should apply.Checkbox
User can edit TimeIf Checked the user is allowed to edit the time that the schedule should occur.Checkbox
User can edit EventIf Checked the user is allowed to change which event should be fired when the schedule occurs.Checkbox
ActionDescriptionParameterValueNotes
Enable All EventsTurns all events on. Schedules will occure as per the settings of the scheduler and log entries will appear.
Disable All EventsTurns all events off. No log entries will be made and no events fired.
Enable ScheduleEnables the Selected ScheduleSchedule Number1 - Max number of schedules (dependant on driver product)
Manual Recall EventTriggers the Schedule and adds an entry to the log and fires the associated event if events are enabled.Schedule Number1 - Max number of schedules (dependant on driver product)
EventDescriptionNotes
EVENT [X] This event fires whenever the button is set to the off state from the user interface or the Button Set To State actionThe name of this event is updated dynamically when set in the user interface. X is the number of the event from 1 - 10
Room Tile PressedThis event fires whenever the room tile is pressed on the user interfaceThis event always fires even is the Ignore Button Presses is setting is enabled

Lighting Scheduler User Manual

lamine benbada on September 14, 2022

Schedule Lighting Events In Crestron Home

Crestron Home owners can now modify there own schedules!

Each lighting scheduler driver includes 4 user editable schedules for up to 10 dealer defined events

Each heating scheduler driver includes 4 user editable schedules for up to 10 dealer defined events

Usage

Once the quick setup is completed, users can modify schedules, override schedules and view the event history all with just a few clicks!

All of our Scheduler products have the same base functionality which is described below.

From the room page or home page of any Crestron Home User Interface the user can see the latest event status of the scheduler.

Click the navigation button to access more schedule functions.

The user is presented with manual override buttons as well as the current schedule information.

Simply click any of the override buttons to action that event immediately.

To edit any of the schedules simply press the Edit button associated with the schedule.

For each schedule you can:

  • Change the schedule name
  • Enable or disable the schedule
  • Change which days the schedule should run
  • Change the time the schedule should run
  • Change the event the schedule should run

System Setup

Add the Heating Scheduler

You can find driver in the Drivers section of the Crestron Home Setup App under:

Drivers -> Scheduler -> LCD Scheduler

Add the scheduler to your desired room

Enter the License Key

The Heating Scheduler license is a single licence, you can find more information regarding our licence types here at our Licensing Info Page

After you install the driver, you can add your licence details in any of the following places:

  • The driver installation settings of the Crestron Home Setup App
  • The installed driver page of the LCD Web App More Info Here
  • The drivers license settings on any Crestron Home User Interface

Access the driver settings

You can find the heating scheduler settings in the Crestron Home User Interface

Navigate to the room where you installed the driver

Click on the driver navigation button

Click on the Driver Settings button at the bottom of the page

Driver Settings

Heating Scheduler Customisable Events

The Heating Scheduler has up to 10 customisable events that can be triggered by any of the schedules or by using the manual override buttons.

Each of the customised events that you setup will also need to be pre-programmed in the Actions and Event section of the Crestron Home setup app.

An example of some typical events you might set up for the end user would be:

  • Simple on/off controls like “Heating On” and “Heating Off”
  • Direct temperature controls like “Set Heating to 22 C”, “Set Heating to 23 C” …
  • Device specific controls like “Quick Heat” or “Heating Setback”

The events you choose to setup will mostly depend on the device you are controlling and its actions available in Actions and Events.

Customising the Heating Scheduler Events

You customise the heating scheduler events in the drivers settings page on any Crestron Home UI

once you are on the driver settings page, press the “Event Setup” button at the top of the page and then select which event you would like to customise

Customisable options for each event include:

  • The event name which will be displayed:
    • to the dealer in actions and events
    • to the end user on the main schedule pages
    • to the end user on the UI tile after the event is triggered
  • The event icon which will be displayed:
    • to the end user on the main schedule pages
    • to the end user on the UI tile after the event is triggered
  • The option to show or hide this event on the main schedule pages

Additional Schedule Settings

Schedule Page Heading

Set the heading that is displayed to end user on main scheduler pages

Schedule Main Page Options:

User Can Edit Schedules Option – turn off to block the end user from modifying any of the schedules

User Can Enable/Disable Events – turn off to block the end user from changing the global event enable/disable function

Schedule Edit Page Options:

User Can Edit Name – Turn off to block the end user from changing the schedule names

User Can Edit Days – Turn off to block the end user from changing which days the schedules will run

User Can Edit Time – Turn off to block the end user from changing what time the schedules will run

User Can Edit Event – Turn off to block the end user from changing which event the schedules will trigger

Settings , Actions and Events


Setting NameDescription TypeNotes
Event SetupNavigation to event SetupEvent ListAllows you to chage names of Events and set an icon.
User can Edit SchedulesIf checked the user can edit the schedule.Checkbox
User can Enable/Disable EventsIf checked the user can enable and disable the scheduled events from firing.CheckboxNB: This does not disable the schedule just stops the events from firing.
User can edit NameIf Checked the user is allowed to edit the schedule name.Checkbox
User can Edit DaysIf Checked the user is allowed to edit on which days the schedule should apply.Checkbox
User can edit TimeIf Checked the user is allowed to edit the time that the schedule should occur.Checkbox
User can edit EventIf Checked the user is allowed to change which event should be fired when the schedule occurs.Checkbox


ActionDescriptionParameterValueNotes
Enable All EventsTurns all events on. Schedules will occure as per the settings of the scheduler and log entries will appear.
Disable All EventsTurns all events off. No log entries will be made and no events fired.
Enable ScheduleEnables the Selected ScheduleSchedule Number1 - Max number of schedules (dependant on driver product)
Manual Recall EventTriggers the Schedule and adds an entry to the log and fires the associated event if events are enabled.Schedule Number1 - Max number of schedules (dependant on driver product)


EventDescriptionNotes
EVENT [X] This event fires whenever the button is set to the off state from the user interface or the Button Set To State actionThe name of this event is updated dynamically when set in the user interface. X is the number of the event from 1 - 10
Room Tile PressedThis event fires whenever the room tile is pressed on the user interfaceThis event always fires even is the Ignore Button Presses is setting is enabled

Heating Scheduler User Manual

lamine benbada on September 14, 2022

Schedule Heating Events In Crestron Home

Crestron Home owners can now modify there own schedules!

Each heating scheduler driver includes 4 user editable schedules for up to 10 dealer defined events

Usage

Once the quick setup is completed, users can modify schedules, override schedules and view the event history all with just a few clicks!

All of our Scheduler products have the same base functionality which is described below.

From the room page or home page of any Crestron Home User Interface the user can see the latest event status of the scheduler.

Click the navigation button to access more schedule functions.

The user is presented with manual override buttons as well as the current schedule information.

Simply click any of the override buttons to action that event immediately.

To edit any of the schedules simply press the Edit button associated with the schedule.

For each schedule you can:

  • Change the schedule name
  • Enable or disable the schedule
  • Change which days the schedule should run
  • Change the time the schedule should run
  • Change the event the schedule should run

System Setup

Add the Heating Scheduler

You can find driver in the Drivers section of the Crestron Home Setup App under:

Drivers -> Scheduler -> LCD Scheduler

Add the scheduler to your desired room

Enter the License Key

The Heating Scheduler license is a single licence, you can find more information regarding our licence types here at our Licensing Info Page

After you install the driver, you can add your licence details in any of the following places:

  • The driver installation settings of the Crestron Home Setup App
  • The installed driver page of the LCD Web App More Info Here
  • The drivers license settings on any Crestron Home User Interface

Access the driver settings

You can find the heating scheduler settings in the Crestron Home User Interface

Navigate to the room where you installed the driver

Click on the driver navigation button

Click on the Driver Settings button at the bottom of the page

Driver Settings

Heating Scheduler Customisable Events

The Heating Scheduler has up to 10 customisable events that can be triggered by any of the schedules or by using the manual override buttons.

Each of the customised events that you setup will also need to be pre-programmed in the Actions and Event section of the Crestron Home setup app.

An example of some typical events you might set up for the end user would be:

  • Simple on/off controls like “Heating On” and “Heating Off”
  • Direct temperature controls like “Set Heating to 22 C”, “Set Heating to 23 C” …
  • Device specific controls like “Quick Heat” or “Heating Setback”

The events you choose to setup will mostly depend on the device you are controlling and its actions available in Actions and Events.

Customising the Heating Scheduler Events

You customise the heating scheduler events in the drivers settings page on any Crestron Home UI

once you are on the driver settings page, press the “Event Setup” button at the top of the page and then select which event you would like to customise

Customisable options for each event include:

  • The event name which will be displayed:
    • to the dealer in actions and events
    • to the end user on the main schedule pages
    • to the end user on the UI tile after the event is triggered
  • The event icon which will be displayed:
    • to the end user on the main schedule pages
    • to the end user on the UI tile after the event is triggered
  • The option to show or hide this event on the main schedule pages

Additional Schedule Settings

Schedule Page Heading

Set the heading that is displayed to end user on main scheduler pages

Schedule Main Page Options:

User Can Edit Schedules Option – turn off to block the end user from modifying any of the schedules

User Can Enable/Disable Events – turn off to block the end user from changing the global event enable/disable function

Schedule Edit Page Options:

User Can Edit Name – Turn off to block the end user from changing the schedule names

User Can Edit Days – Turn off to block the end user from changing which days the schedules will run

User Can Edit Time – Turn off to block the end user from changing what time the schedules will run

User Can Edit Event – Turn off to block the end user from changing which event the schedules will trigger

Settings , Actions and Events


Setting NameDescription TypeNotes
Event SetupNavigation to event SetupEvent ListAllows you to chage names of Events and set an icon.
User can Edit SchedulesIf checked the user can edit the schedule.Checkbox
User can Enable/Disable EventsIf checked the user can enable and disable the scheduled events from firing.CheckboxNB: This does not disable the schedule just stops the events from firing.
User can edit NameIf Checked the user is allowed to edit the schedule name.Checkbox
User can Edit DaysIf Checked the user is allowed to edit on which days the schedule should apply.Checkbox
User can edit TimeIf Checked the user is allowed to edit the time that the schedule should occur.Checkbox
User can edit EventIf Checked the user is allowed to change which event should be fired when the schedule occurs.Checkbox


ActionDescriptionParameterValueNotes
Enable All EventsTurns all events on. Schedules will occure as per the settings of the scheduler and log entries will appear.
Disable All EventsTurns all events off. No log entries will be made and no events fired.
Enable ScheduleEnables the Selected ScheduleSchedule Number1 - Max number of schedules (dependant on driver product)
Manual Recall EventTriggers the Schedule and adds an entry to the log and fires the associated event if events are enabled.Schedule Number1 - Max number of schedules (dependant on driver product)


EventDescriptionNotes
EVENT [X] This event fires whenever the button is set to the off state from the user interface or the Button Set To State actionThe name of this event is updated dynamically when set in the user interface. X is the number of the event from 1 - 10
Room Tile PressedThis event fires whenever the room tile is pressed on the user interfaceThis event always fires even is the Ignore Button Presses is setting is enabled

Nuki Smart Lock User Manual

lamine benbada on August 4, 2022

Control and monitor your NUKI Smart locks from Crestron Home

Connects to the NUKI bridge!

Lock, unlock and view the door status of any NUKI Smart Lock 2.0 or 3.0 connected to the NUKI bridge.

Usage

Once the quick setup is completed users are able to Lock and Unlock the NUKI smart lock from any Crestron Home user interface!

From the home page of the Crestron Home Interface the user clicks on the NUKI lock tile.

The user is presented with the current status of the lock (and door sensor if fitted) as well as options to Lock or Unlock the NUKI lock

Nuki System Setup

Before adding the LCD Driver to you system you must install and setup your Nuki Bridge and Nuki Lock as per the manufacturer instructions using the Nuki App.

Here is a screenshot of the application showing a correctly setup system including a Bridge and a single Lock.

The green indicators show a correct Server, bridge and Lock connection which are required for discovery and pairing.

NB: Once paired a cloud server connection is not required for the Crestron Home integration.

In the Nuki Bridge Settings the two developer options must be enabled:

  • API Quick Discovery – ( used for automatic discovery)
  • HttpAPI – (used for device control)

Add the Driver

Once you have added the Main Intercom Driver to a room you will see the controller UI tile in the room that you added the driver:

The Main page will show a button prompting you to change details of your Nuki Bridge.

Click the button to go straight to the device settings page.

Selecting Nuki Bridge

The Driver will automatically attempt to discover any Nuki Bridges on the same subnet as your device.

Click on a discovered Bridge to connect to that bridge or Click on the Connect Manually button to add a Bridge using a known IP Addess.

Top Tips:

We recommend setting up a MAC address reservation for your Nuki Bridge for the best stystem stability.

A Nuki Cloud server connection is required for the discovery to work and so we also give you the option to connect manually by adding the ip address of your bridge.

(this can be found in the Nuki App using Manage Bridges)

Pairing Nuki Bridge

If you have already paired with the bridge the pairing information and API key will be show if its the first time then press Pair with Bridge to start the pairing process.

Once you have pressed the Pair with Bridge button you can complete the pairing (within 30 seconds) by pressing the button on the Nuki Bridge.

Once pairing is complete the status on the page will show the API key and a Paired Status for your System and the Online Status will show ONLINE.

IP Details View

Pairing Progress View

Manually Pairing a Bridge

In the event that you cannot press the pair button or the discovery is not possible due to the lack of a server connection it is possible to manually add the IP and API details to the driver to pair the bridge manually.

We recommend using the automatic pairing above but this provides full flexibility to the installer.

Actions and Events

Normal Events
Event Locked Event fires when state is updated to locked / closed
Event Unlocked Event fires when state is updated to Unlocked / Opened
Function Actions NB: All Function Actions will trigger Normal Events above
Action Unlock Unlock from an Action
Action Lock Lock from an Action
Action Lock and Go See Nuki Documentation for more details
Action Unlatch See Nuki Documentation for more details
Action Latch See Nuki Documentation for more details

Open Authentication

admin on August 1, 2022

Open authentication is used to allow an LCD driver or service access to your account without giving or storing your user passwords. Many services such as Sonos, Google insist on this level of security to allow users to access.

LCD using our Webapp allows you to grant access to your cloud devices using our Open Authenitcation Flow.

The article below uses our sonos driver flow as an example which is applicable to all drivers which use Open Authentication.

Link to Sonos

When you first install the Sonos Chimes driver it will need to be linked with your Sonos account

Open a web browser connected to the network and navigate to the LCD Webapp using the IP address of the Crestron home processor http://<IPADDRESS>/LCD/Index.html

Locate the Sonos Chimes driver in the list of installed drivers

Click the “Manage” button and open the authentication tab

Click the “Authenticate” button to start the linking process

Continue the Sonos user account sign in process

When the Authentication process is complete you will see the Authenticated Status on the Sonos Device Settings page on any Crestron Home UI

Inner Range Inception Alarm UI Extension

admin on July 7, 2022

“Simple & Easy Installation
Integrated Security – Access Control”

Web Powered Security

Usage

Once the quick setup is completed users are provided with the complete list of Inception arming options as well as detailed arming and disarming progress information.

From the room page or home page of the Crestron Home Interface the user clicks on the Inception Alarm UI tile

The user is presented with the current status of the alarm system and options to Disarm, Quick Arm or select from one of the Advanced Arming options

Advanced arming options include

  • Arm Full Area
  • Arm Perimeter Mode
  • Arm Night Mode

Advanced delayed arming options include

  • Delay Arm Full Area
  • Delay Arm Perimeter Mode
  • Delay Arm Night Mode

While arming and disarming the Inception alarm system users are shown detailed information of the progress

Inner Range Inception Drivers

Our suite of Inner Range Inception drivers allow you to make the most of this powerful Security and Access Controller. The Inner Range Inception Alarm UI Extension can be used as a standalone driver or in conjunction with any of the Inner Range Inception suite of drivers.

  • Inception Events & Actions Driver – Allows control and monitoring of 20 Inception security areas through the Crestron Home Actions and Events systems.
  • Inception Access Doors Driver – Allows control and monitoring of 200 Inception doors through the Crestron Home Actions and Events systems and a setup UI tile.
  • Inception Interface Outputs Driver – Allows control and monitoring of 200 Inception outputs through the Crestron Home Actions and Events systems and a setup UI tile.
  • Inception Interface Inputs Driver – Allows control and monitoring of 200 Inception inputs through the Crestron Home Actions and Events systems and a setup UI tile.
  • Inception Alarm UI Extension Driver – Allows control and monitoring of Inception Areas a simple extension user interface.
  • Inception Security Core Driver – Allows control and monitoring of Inception Areas using the Crestron Home native security user interfaces.

The Inception drivers can be used in any combination or as standalone drivers, except for the Inception Security Core driver. The Security Core driver must be purchased and used with the Inception Events & Actions driver as we do not provide any Actions and Events in the core module.

Inception User Permissions

The Inception Alarm UI Extension driver and additional Inception drivers connect to the Inception alarm as a standard user. The best practice is to create a user just for the Crestron Home system and set the web page profile to “REST Web Api User”. It is up to you if you share a single user (recommended) or create a user per driver. The user must be added the relevant permissions for the Areas, Doors, Inputs and Outputs that you wish to control and monitor.

Alarm actions that require a PIN to be entered will be associated with the the users PIN set in Inception. The user associated with the PIN will be the user that performs the action, with their permissions checked and their name logged in the review event history.

Any control requests of areas, outputs or doors that don’t require a PIN will be performed by the api user and must have the appropriate permissions set on all devices.

Here is an example of a user that is setup with access to the arm and disarm multiple security areas, control doors and monitor input status.

In addition, any of the security areas you wish to control should have the Multi-Mode Arming setting checked as shown in this screenshot.

Add the Driver

You can add the Inception alarm extension driver to any room you like using the Crestron Home Setup application

Follow the installation settings prompts and enter the connection details for the Inception Alarm

  • IP Id – the IP address of the Inception Alarm System
  • Username – the username of the Inception api user (see user permissions above)
  • Password – the password of the Inception api user (see user permissions above)

Once you have added the driver to the room, look for the UI tile in the Crestron Home application or on a TSW touchscreen to continue the setup

Inception Alarm Connection Settings

The main page will show you if the Inception alarm is not connected

You can update the IP address and user account details in the installer settings of the Crestron Home Setup App, or here in the Crestron Home UI.

To modify the Device connection details in the Crestron Home UI:

  • Press the Settings button
  • If prompted enter the Advanced User Password
  • Press the Device Setttings button

Connect to the Inception Alarm

  • Enter the IP Address of the Inception Alarm System
  • Enter the username of the user you set for API access
  • Enter the password of the user you set for API access
  • Press the Connect Device button

The connection status window will inform you of a successful connection or of any errors

Select the Inception Area

Once connected to the Inception Alarm, you will need to select the correct Area ID for the Inception security area that you would like to associate with this driver for status and control.

  • Press the Select Area
  • Select the Inception Area that you would like to associate
  • Return to the settings page

The Selected Area status window on the settings page informs you of which area you have selected

User Pins Settings

The user PIN is optional for arming and disarming opperations.

  • Arming and disarming operations with a PIN will be associated to the inception user with matching PIN for permissions and logging. Ensure you set the individual user permissions as required.
  • Arming and disarming operations without a PIN will use the permissions and logging of the API user. Ensure you set the API users permissions as required.

On the settings page you can turn the PIN requirement on and off for each of the following three functions:

  • Pin required to Disarm the system
  • Pin required to Quick Arm the system
  • Pin required to Advanced Arm the system

Alarm Clock User Manual

lamine benbada on June 4, 2022

User Configurable Timers and Alarms for Crestron Home

Our Alarm Clock Driver allows you to enable the home owner to setup their own times and controls of their system putting them in control. A number of user controllable events can be exposed to the users which they can trigger using timers and daily alarms.

End User Usage

Once the quick setup is completed users are able to add new timers and alarms with just a few clicks!

The main page of the driver shows two options at the top of Timers and Alarms.

Users can select the type of control they wish to add.

Exsisting Timers and Alarms are shown below and can be reused or edited.

Timers

Press Edit to edit the values of the time

Press Play/Restart to Restart the timer.

Alarms

Exsisting Alarms are shown along with their current status

Click on the Alarm to edit the current settings.

Timer Details

Timers can be setup with a range of from a few seconds up to 24 hrs.

  1. Set the Time ,in Hours Minutes and Seconds, that the timer shoul expire.
  2. Set the Event or Events ( this is the event you want to happen when the timer expires)
  3. Test the Event Directly from the event page ( v 4.3)
  4. Start the timer running.

When the timer is complete the selected event is triggered.

NB: Timers do not persist a system reboot.

Alarm Details

Alarms can be setup to trigger once per day and up to seven days a week.

  1. Set the Time ,in Hours Minutes , that the alarm should trigger.
  2. Set the Event or Events ( this is the event you want to happen when the alarm triggers)
  3. Test the Event Directly from the event page ( v 4.3)
  4. Enable the timer.

Each day at the selected time if the day of the week is enabled the the selected event is triggered.

NB: Alarms Persist reboots.

Dealer Setup

Currently when setting up timers and alarms the event which the users can select are a list of ten Crestron Home Events.

These Crestron Home Events are Setup in the Crestron Home Setup App.

However in addition to this we have enabled the possibility to name these events to a friendly neam that your user will understand. Click on Event Settings to setup the Event Names.

We suggest you set these names first in the driver setup in the UI as this will make it easier to reference them in the setup app.

Adding Crestron Panels

In the setup app the ten events are shown with the names which you have setup in the Settings Pages of the driver.

Connect each of the required events to the appropriate Actions:

Sequence, Actions or Quick Actions.

Media Scene, Lighting Scenes

Videos

SONOS CHIMES user Manual

lamine benbada on June 4, 2022

  • Allows you to play Chimes and Spoken Messages through your Sonos System
  • Sonos Chimes can be triggered from Crestron Home Actions & Events or from the Room Tile
  • Supports multiple Sonos V2 Devices
  • Supports up to 6 Chimes in total
  • Supports a single Chime Tile Action
  • The Chimes provided match those provided in our NAX Chimes driver

Sonos Chimes Driver

Room Tile

The Sonos Chimes Room Tile provides a simple point for the homeowner to action one of the chimes as well as access the chime settings.

You could locate the Sonos Chimes driver in a visible room like the kitchen and enable the Tile Action to play a chime like “Dinners Ready”

The Room Tile more button allows the homeowner access to the Sonos Chime settings where they can change the chimes and messages that are played.

Actions and Events

Each of the 6 configurable chimes can be linked to a Crestron Home Action and Event.

Using Actions and Events you could link one of the buttons on a Crestron keypad at the front door to play a doorbell chime throughout the house

Chime Options

The Chime Settings for each of the 6 chimes allows you to:

  • Setup the Sonos zones that will play the chime
  • Select from one of our pre recorded chimes
  • Create your own custom message using the Text To Speech chime

Setup the driver

Add the driver

You can find the SONOS Chime driver in the Drivers section of the Crestron Home Setup App under:

Drivers -> Audio Processor -> SONOS Chime

Add the SONOS Chime driver to your desired room

Once you have added the driver to the room, look for the UI tile in the Crestron Home application

Link to Sonos

When you first install the Sonos Chimes driver it will need to be linked with your Sonos account

Open a web browser connected to the network and navigate to the LCD Webapp using the IP address of the Crestron home processor

http://<IPADDRESS>/LCD/Index.html

Locate the Sonos Chimes driver in the list of installed drivers

Click the “Manage” button and open the authentication tab

Click the “Authenticate” button to start the linking process

Continue the Sonos user account sign in process

When the Authentication process is complete you will see the Authenticated Status on the Sonos Device Settings page on any Crestron Home UI

Setup the Chimes

Find the Sonos Chimes driver on any Crestron Home UI and enter the settings page.

Select one of the chimes you would like to modify

Zone

The Sonos zones that will play the chime when it is triggered

Press the “Change Zones” button to add or remove Sonos zones from this chime

Chime

Select the Chime option to play one of the pre recorded chimes when triggered

Press the “Change Chimes” button to select which chime you would to be played

Repeat ( new in version 4.1)

When enabled the chime will support repeat.

The chime will be played the number of times set in the number of times to repeat field. If this field is set to zero the chime will repeat until stopped.

Set the delay between repeats in seconds that should used. NB: That if you set a delay less than the length of the selected clip then the clip may not play in full

Text To Speech

Select the Text To Speech option to play a custom voice message when triggered

Enter the text for the message you would like to be played

Press the “Change Voice” button to select which voice you would like to use for this message

Playing and Stopping chimes from the UI

The Sonos Chimes can be triggered from the UI when the patricular chime is enabled in the settings. Once enabled the Play and (if the chime is set to repeat) Stop buttons are shown.

Setup the Triggers

The Sonos Chimes can be triggered from the Room Tile button or any Crestron Home Actions and Events sequence

Room Tile Action – (Not Currently Supported)

One of the chimes can be triggered by pressing the room tile button.

Press the “Change Tile Action” button

Set the text that you would like to appear on the Tile Action button

Select the Chime setting you would like to use for the tile action

Trigger Chimes From Actions and Events

Actions:

Trigger Chime <X>

where X is chime 1 – 6

Example of a Quick action to trigger Chime 1

Stop Repeating Chimes From Actions and Events

Actions:

Stop Chime <X>

where X is chime 1 – 6

Example of a Quick action to trigger Chime 1

CHNAX Trigger

admin on March 15, 2022

  • Allows you to trigger NAX Chimes on a Crestron Home System.
  • Works with Crestron Home devices that support Actions & Events
  • Supports upt to 4 NAX Devices
  • Supports up to 6 Chimes in total
  • Supports a single Chime Tile Action

Room Tile

The roomtile provides a simple UI tile which allows you to access the main UI pages.

If you want you can locate the driver in a visible room and enable the Tile Action in the settings (see below)

The Tile action can be setup to allow the user to trigger a chime or chimes

Main Page Actions

The home page tile navigates you straight to the main user interface of the driver.

This page displays a list of any enabled chimes and touching the Chime button will trigger the chime in the enabled zones.

Settings Page

The Settings page allows you to

  • Setup NAX Device connections
  • Setup Chimes
    • Enable Which Zones to Play Chime
    • Select the Chime
  • Setup Tile Action
    • Select Chime or Chimes
    • Set Text to display on tile

ss

NAX Device Connections

Up to 4 seperate NAX devices can be connected to the driver allowing you to trigger a chime across multiple devices.

For each NAX Device you wish to connect click ont he NAZ Device to setup the connection settings:

Enter the IP address or host name of the NAX Device.

Username and Password

Pressing Reconnect will allow you to test the credentials

NB: Crestron Hardware comes setup from the factory with a lock out based on too many incorrect login attempts.

Your Crestron Home Processor is just like a user and if you send the wring credentials you will block the control.

Enable Chimes

First Select a Chime to enable

If a Chime is Enabled it will show on the button.

(Change Zone(s))

Select the Zones that you wish the Chime to play in.

(Change Chime))

Then Select the Chime you want to play.

Lastly Enable the Chime

Trigger the Enable Chime

Once enabled the Chime can be triggered :

  • Main Page Buttons ( See above)
  • Actions
  • Tile Action

Events and Actions

Actions:

Trigger Chime <X>

where X is chime 1 – 6

Example Connection of s Quick action to trigger switch one to release the door contact.

Intercom Features Explained

admin on March 15, 2022

  • SIP Extensions
    • This allows you to add non crestron Extensions to the intercom system.
    • Use this to add Intercoms such as 2N and Doorbird
    • Tested to support Yealink Dect SIP Phones W56H
  • Group Calling
    • This Allows you to call from one panel to Many
    • Groups are configurable from any added extensions
    • Whole House Group can be enabled and disabled.
    • Group calling calls all members of the group
    • A call is established with the first member of the group to answer the call.
  • Paging
    • Paging is peer to peer.
    • When Page Call is placed the device you are calling is told to auto answer the call meaning that no user needs to answer the call at the panel.
    • Once the panel Auto Answers you can talk imediately to the far end panel.

Email Notifications

admin on March 10, 2022

This driver allows you to send email notifications from your Crestron Home System.

All you need is a supported smtp account. We currently support smtp2go and sendinblue

NB: Gmail’s policies have changed and this makes gmail no longer supported.

Room Page Tile

The room page tile is the main entry point to the driver. The Driver is designed to allow users to enable and disable their own alerts once they have been setup using the Settings pages. The Home page and Room Tiles allow the user to access the driver user interface.

Main Page

Showing the five available alerts and allowing the users to enable and disable at an:

  • Alert Level (on this page)

  • User Level ( on the alert page)

  • Global Level (on this page)

Pressing the three dots allows you to edit the alert message on the Alert Page.

NB: The current Version Supports 10 Alerts!

Alert Pages

  • Alert Details

    • Users can edit per alert

      • Title

      • Message

      • Link Title

      • Link NB: A Link title must be entered if a link is added.

  • Enable Alert Per User

    • Enable or disable this alert per user.

    • The User Name can be edited on the Settings page

Driver Specific Settings

  • Setup Users

    • Label ( Displayed on the Main Page)

    • Email Address

    • ( the users email address)

continued below

Setting Page

  • SMTP Details

    • Hostname

    • Port

    • Username

    • Password

  • Test Connection

    • Press to send a test email to all users ( with valid email addresses)

  • Email Status

    • Shows the result of the test email

Connecting Up Your Alert Actions.

Trigger the Alert

Alerts can be triggered by anything that supports a sequence in Crestron Home.

In the example here we have created a Quick Action Called Trigger Alert 1.

Trigger the Quick Action

In turn we have triggered the quick action from a simple contact closure added to the system from a doorbell.

It is of course possible to trigger from other drivers that expose events.

Setting Up Your smtp Account.

Setup a smtp2go account

Once you have setup an account you want to

navigate to setting/smtp_users

Here you will find the details for your connection:

Commonly:

SMTP Server:  mail.smtp2go.com

SMTP Port: 587

Username: emailaddress

Password: *****

Upgrading Drivers

admin on March 3, 2022

It is important to maintain your systems with firmware and driver updates from time to time and we can support you best if you have the latest versions running.

See the Crestron Docs Here

Reasons to Upgrade Drivers

  • Security Patches / Known Issues
  • Improved Features or performance
  • Manufacturer API Changes

Challenges when upgrading drivers

  • System must be rebooted
  • Actions and Events must be reprogrammed
  • Licence Keys Must be re-entered

The Future

  • The team at Crestron are working to make this process easier
  • The team LCD are also working on tools to make this easier.
  • LCD Webapp on some drivers provides tools to export and import your settings making upgrades easier.

The Current Process

see this article and this article for some of the more detailed Steps

  1. To upgrade a driver the following steps must be followed:
  2. Remove the Driver from the room.
  3. Reboot the processor using the Setup app or Console Command (gracefulreboot)
  4. Download or Sideload the new Driver and reinstall into the room
  5. Verify the new version is loaded
  6. Reconnect any Events and Actions / Apply any required settings and configuration.

Ref

Some reference to show you what the Setup app Icons mean

This Cloud icon allows you to download the cloud version when you have a sideloaded version already in place. This will replace the sideloaded version with the latest from drivers.crestron.io
NB: If you have a sideloaded version loaded you must remove otherwise all subsequent drivers loaded will be the the older version despite the setup app reporting the newer version

The Version of a driver loaded to a room can be found in the Settings of the driver by pressing on the cog on the driver in the room. However this can be misleading so use with caution if you have multiple drivers on your system of the same type.

V1.1 Upgrade

admin on February 12, 2022

We want to make sure that you are alway getting the best experiance from our software which is why we want to make upgrading to our latest software as easy a possble.

If we think that you need an upgrade then we will warn you by a alert in the webapp.

All v4 Drivers bring a new LC Core library to the Crestron Home System

Clicking on the alert will take you to our new library page!

This page shows you which LCD drivers you have running on your system and what upgrades are currently available.

For now Driver updates are up to you!! We will just advise to update if we have a newer version to offer. however the process of updrading is still up to you.

We describe the process here

LCCore Update

The reason for our LC Core updater is to resolve some issues we have seen in larger systems when the number of LCD Drivers on the system.

Its a one time upgrade and we have made it super easy for you to do using our LCD Webapp.

The webapp library page will guide you through the process and reboot your processor.

Removing Drivers from Crestron Home

admin on January 20, 2022

Removing Ghost Drivers from Crestron Home

A “Ghost Driver” is by our definition when a driver doesnt appear on the Crestron home setup app but does still appear on the user interface. This “shoudn’t” happen however we see it from time to time and sometimes we need to intervene to get things back in order.

The options are limited to the following

  • Rollback to a previous configuration – Using the myCrestron RMS Service
  • Contact Creston Support and get them to help ( ultimately this is a bug!)
  • Edit the configuration file and reboot the system

Processor wont restart (reboot cycle) due to a driver you have just installed

If you have picked up a “dodgy driver” from somewhere then its possible that when it crashed the system initially loading it sufficiently installed itself into the system that when the system comes back on line it will attempt to reload the bad driver hence crashing the system again and hcne the processor can get into a cycle of reboots from wich it wont recover.

The options are limited to the following

  • It is possible to remove the driver dll from the /user/Data/UsedThirdPartyDrivers folder
    • All loaded drivers are contained withint sub-folders in this root folder and are identified by their driver name.
    • If you catch the correct period in the reboot cycle it is possible to delete the relevant folder fomr the file system,
    • This will if succesful mean that you should manage to escape the reboot cycle
  • Factory reset

Deleting a Side-Loaded Driver from the “Drivers” List

Occasionally you might want to remove a side loaded driver from the drivers list. To do this follow the steps below:

  • Connect to the Crestron Home Processor using FTP or the File manager in toolbox
  • Navigate to the \User\ThirdPartyDrivers\Storage\Rad directory
  • Delete the Driver from the directory
  • Restart the Crestron Home Processor.

Disclaimer

The above strategies should only be employes if you are potentially happy to potentially factory reset your Crestron Home proecssor in the worst case.

If you prefer not to take on the challange you can drop us a support ticket and we can setup a remote session for you.

Crestron Webapp

admin on November 21, 2021

When using our drivers or tools on a Crestron System a we provide a small self-contained webapp which allows you a dashboard for managing the drivers on your system.

You can reach the Webapp by navigating to http://<IPADDRESS>/LCD

Alternatively once you have a driver loaded to a room you can click on the link in the installer settings of the any LCD driver from the Crestron Home Setup App.

Using the WebApp you can:

  • Activate and Deactivate drivers licensing
  • Update Licence Keys
  • Find Documentation
  • Find Version Information
  • Update Authentication Information for the Driver

Authentication

You can browse the driver on a system without authentication but to do the good stuff you wil need to login using your Crestron Home Processor Credentials. This can any user account with User rights or above including the AdvancedUser that is configurable from the Crestron Home Setup App.

You will be prompted to login if you attempt to do anything that requires authentication . If you want to use the advanceduser account then use advanceduser as your username and the password as configured in the setup app.

Video Demo

Add

Passthru Events Logic

admin on November 4, 2021

A number of our drivers provide a pair of an Action and Event which are controlled by logic in the driver. The logic in the driver provides a buffer between the action and the event.

For example our Vacation Recorder Driver provides a Passthru Pair for “Away”.

This pair are enabled when the user sets the driver to “Away Mode”.

An Example use case might be a Security PIR input ( the Action) which triggers a Security Light (the Event) but only when the home owner is Away (the condition)

Chaining Logic (AND)

Drivers that Feature Passthru Logic

Single Instance Drivers

admin on November 2, 2021

Some of our drivers only support loading od a single instance per system. This is usually due to a technical reason or indeed that it makes no sense to have multiples loaded which would use more memory and processing unncessesarily.

We cant stop you loading a driver twice in Crestron Home but we do Discourage you!! When you attempt to add a 2nd and subsequent drivers to a driver which only supports single instance we show this warning during the loading.

Single Instance Warning.

We recommend that you press cancel at this stage which will stop the driver being loaded to your system.

Vacation Recorder for Crestron Lighting

admin on October 27, 2021

Features

Provides extra security by giving the impression of an occupied house

This driver records your lighting changes throughout the day and stores them for future playback. This way the lighting can be set to an away or Vacation mode so that the apperance of an occupied house can be given.

Records Lighting Usage for recorded playback

Configuration settings allow you to exclude rooms from the playback to reduce energy consumption.

Provides Logic control for actions and events

The driver allows for controls via Actions and provides passthru events for enabling and disabling other logic based on a Home or Away Status.

Provides Daily Random events for Audio Visual Media Scenes

In addition to Lighting events to create a real impressions of an occupied house two sets of paired events are provided to drive media Scenes. These are randomised automatically on a daily basis to stop them from looking automated. One set of events is provided for Morning and one for evening to recreat the impression of normal house usage. These can trigger audio visual equipment or media scenes to be recalled.

Setup

Technology

This driver leverages the Crestron Home Web API.

Before loading the driver make a note of your API Authentication Token.

We have a “how to” article and video here

Dynamic Configuration

Other than entering the token above there is no other configuration to do on the driver.

The UI shown is based on the current Crestron Lighting Areas Scenes.

Setup New V4.2.0.0 Onwards

From verson 4.2 we have simplified and automated the connection and you simply load the driver to you system and add your licence key using the setup app, Web App or User Interface.

Mode: At Home

When the driver is in At Home mode the software will record the state of your crestron lighting every 5 minutes. You can see this data building up in the settings section of the driver and verify that everything is working correctly.

The stored data page shows

Total Percentage of Stored States

Daily Percentage of Stored States

The time the last save was done

The Number of states saved today.

The Connection Status of the Pyng Connection.

The driver records lighting in real time so to build up a full picture it records all the time even once it has a full record of data. To enable the driver to be used for “Away Mode” before a full weeks worth of data has been captured we will copy data from a full day to any days that dont have enough data.

Hence the minimum requirement is 80% on one day of the week. Once this has been captured you will be able to enable away mode.

When Away mode is active the System does not record current lighting states and this is indicated on the stored data page.

Mode: Away

When set to Away Mode the driver will recall the pre-recorded lighting scenes in all rooms which have not been disabled in settings. The driver will recall lighting scenes every five minutes to make the lighting changes as per the states recorded during the previous 7 days.

Exclude Rooms

In settings you can disable certain rooms. When a room is disabled its lighting wont be changed based on the recorded states.

Actions and Events

Actions (Connect other events and keypad presses in your system to control the driver)


ActionDescriptionParameterValueNotes
SetHomeSets the Current Mode to Home
SetAwaySets the Current Mode to Away ( if sufficient state data is recorded)
Toggle Home AwayToggles the current Home/Away State
AwayPassthruTriggers the Button Passthru Away State event when the current mode is Away
HomePassthruTriggers the Button Passthru Away State event when the current mode is Home

Events (Connect other functionality based on an event in the driver)


EventDescriptionNotes
AV Event AM StartThis event fires at a randomised daily time in the morning.These Events are randomised daily and are intended to control AV Scenes to give the impression of an occupied house.
AV Event AM EndThis event fires at a randomised daily time in the morning after the Start Event.These Events are randomised daily and are intended to control AV Scenes to give the impression of an occupied house.
AV Event PM StartThis event fires at a randomised daily time in the afternoonThese Events are randomised daily and are intended to control AV Scenes to give the impression of an occupied house.
AV Event PM EndThis event fires at a randomised daily time in the afternoon after the Start Event.These Events are randomised daily and are intended to control AV Scenes to give the impression of an occupied house.
Home Pass EventThis event fires whenever the Home Passthru action is triggered and the current mode is Home
Away Pass EventThis event fires whenever the Away Passthru action is triggered and the current mode is Away

Intercom for Crestron Home

admin on October 23, 2021

Panel to panel intercom for Crestron Home

No additional hardware required!

Panel to Panel intercom between supported Crestron touchpanels is now achievable with our Intercom Extension.

Usage

Once the quick setup is completed users are able to dial from one Crestron Panel to another within the property with just a few clicks!

From the room page on the TSW Panel the user clicks on the Intercom tile to open the dialer.

The User is presented with a list of Extensions to call.

Simple click the desired extension to place a call.

The Call Flow for a normal panel to panel call is as Follows:

User A uses the User interface above to call Panel B.

Panel B Rings and a User B must answer the call.

Panel A then Rings and the User A must answer the callback.

At this point the point to point call is establblished and is ended by either user pressing the end call button.

System Setup

Once you have added the Main Intercom Driver to a room you will see the controller UI tile in the room that you added the driver:

The Main page will show a button prompting you to add extensions.

Click the button to go straight to the settings page.

On the Settings page you can add Crestron Rava Extensions using device discovery.

Or you can choose to add extensions manually.

Adding Extensions

The Main Settings Page Shows

  • List of Existing extensions.
    • (Clickable to edit)
  • Options to add Extentions
    • Crestron (using Discovery)
    • Manual.

Adding Crestron Panels

When you first connect and after adding new Rava devices you will need to press Discover devices.

This will discover all Crestron Rava Devices on the LAN.

The process takes approximately 30 seconds to complete and once finished you will see a list of Rava SIP panels ready to add to your system.

Add the extensions that you want to use to the system one by one.

(You can return to the list to add more by pressing the Button)

NB: We recommend that Crestron panels are setup with a fixed IP or a Statically assigned IP addess by DHCP.

After adding an extension you will go back to the main settings page.

The Extension Showing up in the List of Extensions with the default information (Model-IPAddress)

From the main settings page you can return to add more extensions or continue to complete the setup of your added extensions.

Clicking on the newly added extension allows you to edit the Name of the extension which is presented to the user.

The name brought in from the system discovery is the Model name followed by the IP Address of the panel.

If you want to confirm that you have the correct panel before naming it then simply use the “Dial Panel to Identify ” button. This places a call to ring the panel allowing you to confirm which panel is which.

Adding non crestron Extensions

Extensions can be added manually to the system using the “Add Extensions” button on settings page of the central controller driver.

Non Crestron Sip phones can be added to be dialled from the system.

For example a 2N intercom can be added to the extension list or a concierge SIP Phone on the local area network.

It is possible with the correct NAT translation or by using a STUN Server to setup cross subnet calls in an MDU environment.

For more information or to discuss this capability for an MDU project please contact us.

Adding Addition Extensions After First Setup

Adding extensions to a system follows the same pattern as above. When an extension is added to the central controller all of the endpoint drivers are updated with the new extensions information and hence it is added to the list of available extensions to call.

Removing Extensions After First Setup

Extensions can be removed from the system on the setup page of the central controller driver. Click on the extension to remove

Extensions can be removed from the system on the setup page of the central controller driver. Click on the extension to remove to see that extensions detail page and then click the remove button to remove the extension from the system.

The Associated Intercom endpoint driver will need to be removed from the system using the setup app or associated with a different extension.

Adding Endpoint Drivers

We recommend adding an endpoint driver for each rava panel into the room where that panel is located. If the room has multiple panels you can either decide to only use one for intercom or put two endpoint drivers in the room making it obvious by naming which is which.

Once configured each driver will be paired to a panel.

The Endpoint Drivers have a very simple setup where the driver’s needs to be paired to its panel.

When first loaded to the system the driver main page will prompt you to set an extension.

On the Settings page Click Change Extension to assign an Extension to this driver.

A list of all extensions ( setup using the Main Intercom Driver) will be shown.

Select the Extension that you want this driver to be associated with.

When you exit settings and return to the driver main page you will see options to call the other extensions in the system.

NB: These endpoint tiles are designed to be used only on the Rava Panel which they are assigned to.

Integrators are advised to consider hiding other rooms on the Rava Panels Crestron Home Application using the show rooms function in advanced settings.

Settings to achieve this can be found here

Mobile Devices and Non Rava Panels.

The drivers added to the System can be hidden easily on Rava Panels but on Mobile devices which are configured by users its more complicated to manage this. Calls can be controlled by the drivers running on mobile applications or non rava panels but the flow will not work as described unless a user is ready to accept an incoming call at both of the ends of the intercom call established.

Crestron Rava Panel (Zero)Configuration

Each Panel in your crestron home system should be setup with unique SIP extension number. Crestron Panels Self configure by doing a broadcast handshake on the network so you shouldn’t normally need to set your extension numbers manually.

If you want to make the experiance really slick for your users then Each Panel should also have a unique SIP Name for example “Lounge Door Panel” this means users will see information on who is calling them before choosing to answer a call.

This can be achieved by using the SIPLOCALNAME cmd at the panels console.

TSW-1060>SIPLOCALNAME GAMES ROOM
Success: New parameter has been set

TSW-1060>

UI Tile – Home Control – Crestron Shades

admin on May 25, 2021

“Control Crestron Shades from the Home Page”

Interface Updates Dynamically based on your Crestron Home Setup.

Home Page Tile Actions

The home page navigates you straight to the user interface of the driver.

See if shades are closed on in the property at a glance using the Home Page tile.

NB: this driver does not show a room page tile.

Crestron Shade control

Main User Interface

  • Whole House
    • Recall All Open and All Close
  • Individual Areas (Dynamic)
    • Recall All Open and All Close for room
    • Hide/Show Shades in room
    • Navigate to Area Page for all area scenes (Pressing Sliders)

  • Shades
    • Name of Shade
    • Status / Position

Room Scenes / Whole House Scenes

  • Default Scenes
    • All On
    • All Off
  • User Scenes
    • Recall Custom Scenes

shade scenes

Driver Specific Settings

  • Licence
    • Launch Licence Settings
  • Hardware
    • Hardware page

Common Settings

Display On Home Page

Common Driver Features

Licence Settings

See here for Licencing Document

Hardware Settings

See here for Hardware Setting

Technology

This driver leverages the Crestron Home Web API.

Before loading the driver make a note of your API Authentication Token.

We have a “how to” article and video here

Dynamic

Other than entering the token above there is no other configuration to do on the driver.

The UI shown is based on the current Crestron shades and shade Scenes.

Feedback is based on the scene state of the real shades and shade scenes.

Rooms are only shown if there is a shade element in the room.

Changes are made dynamically and there is no need to update or restart the driver following a change. e.g. adding a scene or a room with shades

Finding your Crestron Home API Key

admin on May 25, 2021

A number of our drivers require you to enter the Crestron Home API Token to allow the driver to control native Lighting and Shades components within your Crestron home.

To find your Crestron Home API Key you need to enter the setup app using your administrator credentials.

To view the Web API Settings screen, select Settings  > System Control Options > Web API Settings.

.

UI Tile – Home Control – Crestron Lighting

admin on May 11, 2021

“Control Crestron Lighting at a glance from the Home Page”

Interface Updates Dynamically based on your Crestron Home Setup.

Home Page Tile Actions

The home page navigates you straight to the user interface of the driver.

See if lights are turned on in the property at a glance using the Home Page tile.

Crestron Home Lighting Control Tile

Main User Interface

  • Whole House
    • Toggle Recall All On and All Off
    • Navigate to Area Page
  • Individual Areas (Dynamic)
    • Toggle Recall All On and All Off
    • Navigate to Area Page

Room Scenes

  • Default Scenes
    • All On
    • All Off
  • User Scenes
    • Recall Scenes

Driver Specific Settings

  • Auto Lock
    • Enable
    • Disable
    • Time (in seconds, min 10 – max 600)
  • Display on home page (tick box)
    • Enable
    • Disable
  • Licence
    • Launch Licence Settings

Common Settings

Display On Home Page

Common Driver Features

Licence Settings

See here for Licencing Document

Hardware Settings

See here for Hardware Setting

Technology

This driver leverages the Crestron Home Web API.

Before loading the driver make a note of your API Authentication Token.

We have a “how to” article and video here

Dynamic Configuration

Other than entering the token above there is no other configuration to do on the driver.

The UI shown is based on the current Crestron Lighting Loads and Scenes.

Feedback is based on the scene state of the real lighting scenes.

Rooms are only shown if there is a lighting element in the room.

Changes are made dynamically and there is no need to update or restart the driver following a change. e.g. adding a scene or a room with lighting

Technical Updates / Known Issues

admin on March 24, 2021

Ongoing Issues

Crestrons Help page with Crestron Home Known Issues (requires Login)

LCD Driver Issue

CHTWONHW Events for Relay and Output are not working on the current production version. This will be fixed in an upcoming release. The other events are all functional.

Resolved Issues for Reference Below this line

Issues with Extension Drivers in Crestron Home 3.17

On Systems with Locale settings not set to en-US extension user interface elements are not appearing.

We hoped this was going to be fixed in the App Update

Crestron Home on App Store “Hotfix for missing tiles when Crestron Home Extensions are used in conjunction with non-US English language selection.”

However out testing subsequently confirmed by Crestron confirms that this is still an ongoing issue. ( Native tiles such as Sonos and Lighting are resolved but not Extensions)

We have raised this as an issue with Crestron but they have indicated that the fix on this issue will not come as a hotfix but in the 3.18 release date TBC

This same issue also affects sequences / Actions in some extensions from not working. Although we are still investigating this.

Workaround Options:

Rollback Crestron Home to 3.16

Change Local of device to en-US

NB: we understand this issue also affects android in a similar way and a fix is not before 3.18

______________________________________________________________

Actions with Parameters not working

Our testing team has picked up on an issue on Crestron home 3.15 where Actions (in sequences) that have a parameter are not working correctly.

  • Couldn’t get quick actions to trigger chimes
  • When I set the parameter in a quick action, it would always default back to 1

This has been observerd in CHPUSH and CHSONOSCHIME but is not exclusive to these two drivers

We have raised this as an issue with Crestron.

Drivers requiring relicensing after reboot

We have experianced an issue since Crestron home 3.10 where the loading of drivers after a reboot causes a concurrency issue in our LCCore Library.

This manifests as a driver loading and showing Check Licence, failing to load or loading but with incorrect persistant settings .

All v4 Drivers bring an option to update this Library to v1.1 which resolves this issue. For more details see this page here

CHTWONHW v3.0.1.0

This version has a bug causing the Switch 2 Action via a sequence not to function, Please update to v3.0.2.0 or greater released 14.01.2022

Central Lights and Central Shades

Users have reported this driver showing offline after a system reboot. The workaround is to refresh the driver in the setup app either by a subsequent reboot ot by r-entering the licence or api key in the setup app. The Version 4 issue of these drivers brings a resolution to this issue and we would recommend upgrading to this version.

Crestron Home app 1.20.13 and pre-3.12 Affecting Extensions

Crestron Home App Crashing and going black / Connecting to home despite the processor not crashing. This is affecting touchpanels and Android phone Crestron Home apps that have updated to the latest version 1.20.13 (can be confirmed with “ver -v” in text console). 

This only occurs in combination with the latest app version and Crestron Home processor firmware that has not yet updated to 3.12, which was also recently released. We are seeing this behaviour with extension tiles only. 

Updating system to 3.12 is the solution that has been advised to us by tech support .

Pushover Notifications – User Manual

admin on March 21, 2021

UPDATED Version v4.1 now supports Priority and Sound Alert Selection

This driver allows you to send push notifications from your Crestron Home System to your iOS or Android device using an application called Pushover.

If you haven’t already setup the driver for use and setup a Pushover account and Application then you will need to create an account and download the pushover app. See details below.

Room Page Tile

The room page tile is the main entry point to the driver. The driver is designed to allow users to enable and disable their own alerts once they have been setup using the Settings pages. The Home page and Room Tiles allow the user to access the driver user interface.

Main Page

Showing the ten available alerts and allowing the users to enable and disable at an:

  • Alert Level (on this page)
  • User Level (on the alert page)
  • Global Level (on this page)

Pressing the three dots allows you to edit the alert message on the Alert page.

Alert Pages

  • Users can edit per alert
    • Title
    • Message
    • Link Title
    • Link NB: A Link Title must be entered if a link is added
    • Selected Sound for the alert
    • Selected Priority for the alert

Alert Pages Continued

  • Test Alert
    • Press Send Now to test the selected alert
    • Status of the alert will be displayed after testing
    • Shows the messages remaining in your monthly allowance
  • Enable Alert Per User
    • Enable or disable this alert per user
    • The User Name can be edited on the Settings page

Alert Sound

  • Select the sound to play when the alert is triggered
  • “None” is an option if you don’t want a sound to play for that alert

Alert Priority

  • Select the priority for the alert when triggered

Driver Specific Settings

  • Setup users
    • Label (displayed on the Main page)
    • Key (the users Pushover User Key)

continued below

Driver Specific Settings Continued

  • Pushover Application Key
    • Enter your own API Token/Key for the project (See below for details)

  • Test Connection
    • Press to send a test message to all users (with valid keys)
  • Pushover Status
    • Shows the result of the test notification
    • Shows the messages remaining in your monthly allowance
  • Choose whether to display a Pushover tile on the Home page

Connecting Up Your Alert Actions.

Trigger the Alert

Alerts can be triggered by anything that supports a sequence in Crestron Home.

In the example here we have created a Quick Action Called Trigger Alert 1.

Trigger the Quick Action

In turn we have triggered the quick action from a simple contact closure added to the system from a doorbell.

It is of course possible to trigger from other drivers that expose events.

Setting Up Your Pushover Account.

Download the App

  • Setup an Application ( Only on a single user account per driver)
  • Clone our pre-built application
  • Or Create your own
  • NB: A single application can push messages to multiple pushover accounts.

Additional Users can download the app and add their user keys without needing to create an application.

Pricing

As noted above a Normal Induvidual account is all that is required for both the Application and for the induvidual users. The cost is based on using the Pushover app on the device recieving the notifications which costs st a $5 USD one-time purchase on each platform. Currently Pushover offer a 30 day trial.

PINLOCK – User Manual

admin on March 19, 2021

Room Page Tile

The room page tile is the main entry point to the driver. Pressing on the tile will toggle the lock state. The lock will latch open unless auto-lock is enabled where it will lock after the preset auto-lock delay.

Home Page Tile Actions

The home page navigates you straight to the user interface of the driver.

Driver User Interface

  • Manual Control
    • Lock
    • Unlock ( this is still affected by auto-lock if enabled)
    • Activity Feed ( Shows information about recent actions)
  • Driver Settings
    • Launch Settings (password protected)

Driver Specific Settings

  • Auto Lock
    • Enable
    • Disable
    • Time (in seconds, min 10 – max 600)
  • Display on home page (tick box)
    • Enable
    • Disable
  • Licence
    • Launch Licence Settings

Common Settings

Display On Home Page

Common Driver Features

Licence Settings

See here for Licencing Document

Hardware Settings

See here for Hardware Setting

Connecting a UI Tile to events and actions

admin on February 25, 2021

Fundamental to our idea of UI Tiles is that you decide how to use them by connecting them up to other elements within your Crestron Home System.

This document aims to explain that by presenting three use cases.

Introduction

Events are the Driver telling Crestron Home OS Something has Happened. The Driver Presents a number of events to the system

Actions are the opposite where you want to tell the driver that something has changed or tat you want something to change.

Example 1 – UI Tile connected to a Hardware Interface

In this Scenario we feature one of our most popular drivers the 2N Hardware interface along with a Electric Gate System connected to the 2N Relay and IO input.

The User has a 2N Door Station Located on a post at the Gate and needs to open the Gate when a caller calls using the intercom.

We are going to add a Gate Controller and a 2N Hardware Interface to the system.

The Gate actuator will be connected to the Relay (Controlled by Switch 1 on the 2N) A Sensor which is closed when the gate is fully closed and open when the gate is open is attached to the IO input on the 2N.

We will Create a whole house Quick action that will be used to open the gate when a call is recieved from the 2N Doorstation

Example 2 – UI Tile Connected to Native Hardware

In this Scenario we have Crestron Lighting installed in the property and we want to add an extract fan with a run on timer to the system.

Example 3 – Connection to a Notification alert.

For More Information take a look at the Crestron Home Manual Pages here:

https://docs.crestron.com/en-us/8525/Content/CP4R/Installer-Config/Configure-Extension-Devices.htm (Opens in a new Tab)

UI Tiles Switching – User Manual

admin on December 17, 2020

This is a generic datasheet showing the common functionality of our UI Tiles that provide a Switcher function. All of the control functions are common to the whole range of these UI Tiles. This datasheet uses the FireSwitch as an example of the functionality.

Room Page Tile

The room page tile is the main entry point to the driver. Pressing on the tile will toggle the fire state. The fire will turn off if currently on and and on if currently off.

If any timers are currently running then the fire cannot be turned on or the timer cancelled from the tile.

Instead use the top right of the tile to navigate to the main Driver user interface.

Home Page Tile Actions

The home page tile navigates you straight to the user interface of the driver.

Driver User Interface

  • Status
    • This shows the status as per the tiles
  • Controls
    • Fire On
    • Fire Off
  • Time Delay Off
    • Time Delay Off Buttons
    • Configurable in settings
    • Hide if not required
  • Driver Settings
    • Launch Settings (password protected)

Dependant upon which switch type driver tile is purchased the icon and the name of the item being switched is changed appropriately.

For example, if a SprinklerSwitch had been installed then a sprinkler icon would be shown and within the UI “Sprinkler” would appear instead of Fire.

Driver Specific Settings

  • Time Delay Button Configuration
    • Press to edit or hide a Button
    • Shows time options
    • (see below)

Common Settings

Common Driver Features more…

Display on home page (tick box)

  • Enable
  • Disable

Licence Settings

See here for Licencing Document

Hardware Settings

See here for Hardware Setting

Time Selection Page

Time Delay Options are available in 5 min increments from 5 to 120 Mins.

Clear Delay Disables this buttons action and hides it from the driver main page.

Door and Lock – User Manual

admin on December 17, 2020

This is a generic datasheet showing the common functionality of our UI Tiles that provide a Lock or Door function. All of the control functions are common to the whole range of these UI Tiles. This datasheet uses the Lock as an example of this functionality.

Find all Locks and Door Ui Tiles in the following category:
Door Access ->> Various 

Room Page Tile

The room page tile is the main entry point to the driver. Pressing on the tile will toggle the lock state. The lock will latch open unless auto-lock is enabled where it will lock after the preset auto-lock delay.

Home Page Tile Actions

The home page navigates you straight to the user interface of the driver.

Driver User Interface

  • Manual Control
    • Lock
    • Unlock (this is still affected by auto-lock if enabled)
    • Activity Feed (shows information about recent actions)
  • Driver Settings
    • Launch Settings (password protected)

Driver Specific Settings

  • Auto Lock
    • Enable
    • Disable
    • Time (in seconds, min 10 – max 600)
  • Open Close Delay
    • Time (in seconds, min 2 – max 10)
    • This defines how long the Lock or door takes to close and open.
  • Display on home page (tick box)
    • Enable
    • Disable
  • Licence
    • Launch Licence Settings

Actions and Events

These drivers feature a range of Actions and Events to allow you to connect up to hardware or other drivers.

The Events you need to use will be highly dependant on your required hardware setup.


SettingsParameterValueParameter 2ValueDescription
Auto CloseSwitchWhen the Auto Close feature is turned on the driver fires the Do Close Door event after the door has been open for the duration set in Auto Close Time
Auto Close TimeSecondsThe duration to leave the door open before sending the Do Close Door event if the Auto Close feature is turned on
Set Time For Open and Close FunctionSecondsUsually used with motorised gates and doors, this is the duration to show the door as opening or closing
Display on home pageCheckbox
Settings Password ControlCheckbox


ActionsParameterValueParameter 2ValueDescription
CloseTriggers the Do Close Door event and shows the door as closed
Close With DelayDelay (s)0 - 600 secondsWaits for the delay time then triggers the Do Close Door event and shows the door as closed
Disable Auto CloseTurns off the Auto Close feature
Door Closed SensorChanges the door state to Closed. If the previous door state was Door Opened (forced) then the Do Close Door event will also be triggered
Door Open SensorChanges the door state to Door Opened (forced) if the previous door state was closed
Enable Auto CloseTurns on the Auto Close feature
OpenTriggers the Do Open Door event and shows the door as open
Open Door With Auto RelockAuto Close Time (s)0 - 600 secondsTriggers the Do Open Door event and shows the door as open. Waits for the delay time then triggers the Do Close Door event and shows the door as closed. Note: This action is separate to the Auto Close Feature
Set Auto Close TimeAuto Close Time (s)0 - 600 secondsSets the duration to leave the door open before sending the Do Close Door event if the Auto Close feature is turned on


EventsParameterValueParameter 2ValueDescription
Do Close DoorThis event fires whenever the door is set to the closed state from the user interface, the close door actions or the auto close feature
Do Open DoorThis event fires whenever the door is set to the open state from the user interface or the open door actions
Close Button PressedThis event fires whenever the close button is pressed on the user interface
Open Button PressedThis event fires whenever the open button is pressed on the user interface
Tile Button PressedThis event fires whenever the room tile is pressed on the user interface

Normal Events
Event Locked / Closed Event fires when state is updated to locked / closed
Event Unlocked / Opened Event fires when state is updated to Unlocked / Opened
Button Presses
Event Lock/Close Button Pressed Event triggered when any command button is pressed
e.g. Tile button, Lock Button , Open Button
( Use this event to trigger a momentary release)
Event UnLock/Open Button Pressed Use to trigger a momentary release.
Event Tile Button Pressed Suggested use: Use to trigger a momentary release.
NB: The UITile State will toggle.
Control Sensor Actions
Action Control Sensor Opened If Locked the this causes the UI to show a “forced open” message
Action Control Sensor Closed If the previous state (before a forced open) was Locked then the
door sensor closing will cause the Lock state to be changed to locked
NB: A Locked / Closed Event will be triggered.
Function Actions NB: All Function Actions will trigger Normal Events above
Action Unlock / Open Unlock / Close from an Action
Action Lock / Close Lock / Open from an Action
Action Unlock / Open
with Auto Re-lock /Re-Close		 This Action allows the installer to set a custom delay before relocking
/ reclosing
Configure Settings Actions
Action Disable Auto Lock / Close Disable the Auto Lock / Close Feature
Action Enable Auto Lock / Close Enable the Auto Lock / Close Feature

Common Settings

Display On Home Page

Common Driver Features

Licence Settings

See here for Licencing Document

Locks and Doors Tiles

Locks and Doors Tiles


Shop now


UI Driver Hardware Page

admin on December 16, 2020

Driver Hardware

Current Hardware

Displays the Current Device Type for the Driver.

Hardware Debug Enable/Disable

This should be disabled (unchecked during normal use) the setting can be enabled to show information on the current hardware communication at the processor console.

NB: Not currently implemented on production drivers.

Loading Drivers

Drivers Admin on November 25, 2020

Please also check the Crestron Documentation (Opens in a new window).

This document is aimed at Crestron Home Installers.

When you purchase a Driver from our store or download a driver to try you will be able to download a zip file which contains the driver package file.

This package file should be side loaded into the control system running Crestron Home prior to adding the corresponding devices to the system.

Custom drivers can be loaded using secure file transfer.

Load Using FTP (Side Loading)

  1. Connect to the Crestron Home processor over FTP or by using the File Manager tool in Crestron Toolbox.
  2. Upload the custom driver package file or IR file into the Crestron Home processor’s \User\ThirdPartyDrivers\Import directory.
  3. Navigate to the driver using the Third Party Devices menu in the Pair Devices screen. The screen refreshes automatically to display the driver after it has been loaded into the system.

See Detailed Example using filezilla

Re-import a New Driver

If you make changes to your driver and want to reimport the new driver, you must first follow these steps to erase the old driver:

  1. Remove all instances of the old driver from Crestron Home
    • Do this by pressing the back Arrow on the driver in the room
    • You must do this on all rooms that contain this driver.
  2. Reboot the control system by either
    • Using the Setup All Installer Settings – > System Config -> Reboot ( hold for 3 seconds)
    • Using the Console command “GRACEFULREBOOT”
  3. Verify all instances have been removed ( reboot a 2nd time if not!)
    • You can verify by
      • Checking that the drivers dont appear in the rooms in both setup app and UI
      • Checking the “UsedThirdPartyDrivers” does not contain a reference to the driver
      • Checking by using the CCDINFO command ( advanced but reliable)
  4. Side Load the new driver as described above.

Deleting a Side-Loaded Driver from the “Drivers” List

Occasionally you might want to remove a side loaded driver from the drivers list. To do this follow the steps below:

  • Connect to the Crestron Home Processor using FTP or the File manager in toolbox
  • Navigate to the \User\ThirdPartyDrivers\Storage\Rad directory
  • Delete the Driver from the directory
  • Restart the Crestron Home Processor.

Follow these links for more information about

Common features in our drivers

Drivers Admin on November 25, 2020

Password Protected Settings Page

Many of our drivers feature a settings page in the Crestron Home App which allows some driver settings to be changed. These settings allow the user to configure the driver functionality and to show or hide controls and rooms in the user interface. 

By default the Advanced User password is required to access these options. However this can be turned off (see common settings below) 

Enter your Advanced User Password

Access driver settings by entering your advanced user password in the text field.

Once the correct password is entered an “Access Settings” button will appear to allow you to navigate to the Driver Settings Page.

Press Access Settings to navigate to the Driver Settings

The advanced user password is setup in the Crestron Home Setup App.

Common Settings found in all drivers


Setting NameDescription
Display on home pageEnable or disable the home page tile
Settings Password ControlRequire Password to Access Settings.

Rack room and Hidden Drivers

All drivers have a UI tile but some are not designed to be displayed to the client. These Drivers have tiles with no user UI only configuration.

These drivers are generally placed in a Rack room where they are used for configuration or maintenance.

Load Crestron Driver Using Filezilla FTP

admin on November 15, 2020

Download and install Filezilla from the filezilla website.

  • Add a new site using the Filezilla File manager.
  • Protocol is SFTP
  • Host: the IP Address of your crestron home processor
  • User: admin
  • Password: < your admin password>
  • Click Connect to Connect to the site

  • On first time connection you will see this banner.
  • Click Ok to accept and connect.

Upload the custom driver package file or IR file into the Crestron Home processor’s \User\ThirdPartyDrivers\Import directory.

Either

  • Navigate in the left hand (Local Site) to your package file and right click Upload
  • Drag your package file into the import directory from a windows file manager window.

Navigate to the driver using the Third Party Devices menu in the Pair Devices screen. The screen refreshes automatically to display the driver after it has been loaded into the system.

  • Selecting Third Party loads any files in the import folder.
  • Navigate to the new driver.

Select currency
GBP Pound sterling
USD United States (US) dollar