InnerRange Inception Security SIMPL Windows Module User Manual

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

  • 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

Dynamic Button User Manual

  • Customisable UI Tile
  • Single two state button
  • Customise Icons and State Text on Button
  • Customise and enable tile Icon
  • Extensive flexibility of usage through events and actions.
  • Passthru Logic Functions for each button state

Build your own custom Button 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

Dynalite Area Controller

Control 3rd party lighting with a common simple interface, One controller per room allowing scene control.

The Lighting tile shows a simple Light icon and provides access to the drivers main control page.

The main page allows you to control your lighting using up to eight preset Buttons.

The labels of these scenes can be setup in the settings page of the driver by your installer.

First Installation

On first use the user interface will display a shortcut button taking you to the settings page.

From here the first thing to do is to setup your device entering the ip address and connection information for the device.

Setup Dynalite

Once connection to the device has been verified the setup is very quick and simple.

Select the Area you want to control.

Name the Presets with user firendly names.

Check the box to make the preset visible on the main page or Uncheck to hide this preset from the user.

Actions and Events

This driver supports actions and events allowing you to connect up to other drivers and system controls to provide a more integrated system for your users.

Actions

ActionDescriptionParameterValueValue
Preset Recall Triggers the Button Passthru Off State event or Button Passthru On State event depending on the buttons stateButton1-8 Attempts to recall the Preset on the lighting system. If this suceeds and a confirm is recieved the button feedback on the user interface is set and the preset event Set by action will fire.

Events

EventDescriptionNotes
Preset Pressed This event fires when preset X button is pressed.*x is the index of the preset from 1 - 8
Preset Set by ActionThis event fires when the preset is set by the Preset Recall Action *Events only fire if the Lighting System Responds with an success response.
Preset Set by Action Or PressThis event fires (once) when the preset is set by the Preset Recall Action or by its button press.**This fires even if the preset was already selected.
Room Tile PressedThis event fires whenever the room tile is pressed on the user interface
Any Preset Button PressedThis event fires when any preset button is pressed

Mode Area Controller User Manual

  • This solution allows you to fully integrate your 3rd party Lighting into your Crestron home system.
  • Local One way control of up to 8 Scenes.
  • Select Scenes in the client UI
  • Mode Lighting using NPU.
  • Configuration options for fade time
  • Dali and Mains dim and switched Circuits supported.
  • Site wide license allows you to integrate the whole home.
  • Suggested to use alongside our lighting scheduler !
  • Works with Crestron Home devices that support Actions & Events

User Interface

Control 3rd party lighting with a common simple interface, One controller per room allowing scene control.

The Lighting tile shows a simple Light icon and provides access to the drivers main control page.

The main page allows you to control your lighting using up to eight preset Buttons.

The labels of these scenes can be setup in the settings page of the driver by your installer.

First Installation

On first use the user interface will display a shortcut button taking you to the settings page.

From here the first thing to do is to setup your device entering the ip address and connection information for the device.

Setting Up Mode Scenes

Once the device connection has been verified you can select the area you wish to focus on.

The Scene information is gathered from the mode lighting system and the list of available scenes show for each preset is filtered based on the selected area.

If no Area is selected then all scenes will be shown on the Change Scene page.

NB: If your scene or area information changes then to refresh the information simply go to Device Connection and re-test the connection without changing any information. This rec-connect will updated the area and scene name information.

A fade time in seconds can be set as a global setting affecting all presets.

Per preset that you wish to use you need to:

Select a Scene – Change Scene from a list of Scenes.

Show the Preset – this shows the preset on the user main page.

Either

Set a Custom Scene name

Use the Mode Scene Name

Mode Hardware Setup

Our integration with mode lighting uses both Http and TCP communications to allow us to control and gather feedback from a Mode lighting Network Processor Unit NPU. In this way we support the full range of Mode lighting controllers and load types.

Currently we require a minimum firmware / software version of 2.4.1.44. To get the latest firmware visit mode lighting’s website

Best Practice

Setup a Static IP Address

Find the IP Address using the display on the fron of the NPU

Actions and Events

This driver supports actions and events allowing you to connect up to other drivers and system controls to provide a more integrated system for your users.

Actions

ActionDescriptionParameterValueValue
Preset Recall Triggers the Button Passthru Off State event or Button Passthru On State event depending on the buttons stateButton1-8 Attempts to recall the Preset on the lighting system. If this suceeds and a confirm is recieved the button feedback on the user interface is set and the preset event Set by action will fire.

Events

EventDescriptionNotes
Preset Pressed This event fires when preset X button is pressed.*x is the index of the preset from 1 - 8
Preset Set by ActionThis event fires when the preset is set by the Preset Recall Action *Events only fire if the Lighting System Responds with an success response.
Preset Set by Action Or PressThis event fires (once) when the preset is set by the Preset Recall Action or by its button press.**This fires even if the preset was already selected.
Room Tile PressedThis event fires whenever the room tile is pressed on the user interface
Any Preset Button PressedThis event fires when any preset button is pressed

Sprinkler Scheduler User Manual

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

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

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

Temperature and Humidity Monitor

“In the Pool or the Spa or the Sauna!”

Monitor Temperature and Humidity in your Crestron Home Setup.

Home Page Tile Actions

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

The Tile shows the Current temperature of the monitoring sensor.

Crestron Home Driver Homepage
Crestron Home Wine Sensor

Main User Interface

  • Temperature
    • Current Temperature
    • Daily High and Low
  • Humidity
    • Current Humidity
    • Daily High and Low

Driver Specific Settings

  • Temperature Unit Selection
    • Celsius (Default)
    • Farenheit
  • Thresholds
    • Enable Disable Alerts
    • Max / Min

Common Settings

Display On Home Page

Licence Settings

Hardware Settings

Wine Settings Crestron Home Driver

Technology

This driver connects over the network to a.

Micro Environment Monitoring System, Integrated
Temp/Humidity Sensor, POE

The specific product code :

E-MICRO-TRHP .

This hardware can be purchased from:

EMEA ITM Components 

http://www.itm-components.co.uk

Actions and Events

Temperature Threshold Passed

Humidity Threshold Passed

Digital In 1 Closed / Open

Digital In 2 Closed / Open

Example Usages:

Temperature Thresholds can be connected up to alerts or monitoring tools to ensure users are notified and remedial action can be taken.

The digital inputs might be used to monitor the cellar door which might be crucial in ensuring temperature and humidity of the space.

Device Configuration and Settings

The device supports Poe or Local 5.5VDC power supply. Once on the network the device can be located using a device discovery tool which can be found here (Opens in a new window).

The username and password can be changed from the defaults in the web interface of the device.

The unit defaults to :

User: root

Password: nti

Network Settings can also be configured using the web interface. The device needs to be routable to your crestron home processor. The IP address of the device is required for the driver settings.

The device username,password and IP Address need to be entered into the driver settings page in the Crestron Home setup app.

Nuki Smart Lock User Manual

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
EventLocked Event fires when state is updated to locked / closed
EventUnlockedEvent fires when state is updated to Unlocked / Opened
Function ActionsNB: All Function Actions will trigger Normal Events above
ActionUnlock Unlock from an Action
ActionLock Lock from an Action
ActionLock and GoSee Nuki Documentation for more details
ActionUnlatchSee Nuki Documentation for more details
Action LatchSee Nuki Documentation for more details

Inner Range Inception Alarm UI Extension

“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

AJAX Power User Manual

Control and monitor the power consumption of AJAX Socket Automation modules

Connects to the homeowners AJAX account!

For cloud connected AJAX sockets, control the output (on/off) and monitor the power consumption.

Usage

Once the quick setup is completed users are able to monitor and control the sockets with just a few clicks!

From the room page on the Crestron Home user interface the user clicks on the AJAX Power tile to open the overview page.

The user is presented with a list of all the connected AJAX Sockets

Simple click the desired socket switch to toggle the socket between on and off

For more detailed information about an individual socket click the socket detail navigation button.

Here you can see detailed information for the AJAX Socket

use the refresh information button to get the latest energy usage information and socket status

Add the Driver

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

Drivers -> Security System -> AJAX

Add the AJAX Power driver to your desired room

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

AJAX Power Settings

The main page will show the current connection status to the homeowners AJAX account and AJAX hub.

When you are setting up the driver for the first time you will need to add the homeowners AJAX account details:

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

Add the homeowners AJAX account details

  • Enter the AJAX account username
  • Enter the AJAX account password
  • Press the Connect button

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

Note: It is preferable to setup a unique AJAX user account for the Crestron Home system. In this way the homeowner can see the events and allow/deny access to the Crestron home system separately to the main user account.

To do this the homeowner would need to use the Send Invites process inside the Active Users page of the AJAX system

Select the homeowners AJAX hub

Once connected to the homeowners AJAX account you will need to select the correct AJAX hub

  • Press the Select AJAX Hub button
  • Select the AJAX hub that you would like to associate with this alarm driver
  • Return to the settings page

The selected hub status window on the settings page informs you of which hub you have selected

Crestron Home Actions and Events

Actions available in Crestron Home include:

  • Switch On
  • Switch Off

The Switch On and Switch Off actions require two parameters

  • Room Name
  • Socket Name

Please make sure the parameters match the room name and device name setup in the AJAX settings

AJAX Power Socket Overview

Once you have finished the AJAX account and hub setup you can navigate back to the AJAX power overview page where you will see a list of all AJAX Sockets connected to the AJAX hub

Press the refresh button to retrieve the latest list of connected plugs and up to date status

Alarm Clock User Manual

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

  • 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

AJAX Alarm Product Manual

Control and monitor your AJAX alarm system from Crestron Home

Connects to the homeowners AJAX account!

Arm and Disarm your cloud connected AJAX Alarm System with our AJAX Alarm Extension Driver.

Usage

Once the quick setup is completed users are able to Arm and Disarm the AJAX alarm system from any Crestron Home user interface!

From the home page of the Crestron Home Interface the user clicks on the AJAX alarm tile .

The user is presented with the current status of the alarm and options to Arm or Night Arm the AJAX alarm system

Simply click the alarm mode you would like to activate.

If a pin number is required to arm or disarm the system you will be prompted to enter the pin number now.

Enter your pin number and click the Done button

Add the Driver

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

Drivers -> Security System -> AJAX

Add the AJAX Alarm driver to your desired room

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

AJAX Alarm Settings

The main page will show the current connection status to the homeowners AJAX account and AJAX hub.

When you are setting up the driver for the first time you will need to add the homeowners AJAX account details:

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

Add the homeowners AJAX account details

  • Enter the AJAX account username
  • Enter the AJAX account password
  • Press the Connect button

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

Note: It is preferable to setup a unique AJAX user account for the Crestron Home system. In this way the homeowner can see the events and allow/deny access to the Crestron home system separately to the main user account.

To do this the homeowner would need to use the Send Invites process inside the Active Users page of the AJAX system

Select the homeowners AJAX hub

Once connected to the homeowners AJAX account you will need to select the correct AJAX hub

  • Press the Select AJAX Hub button
  • Select the AJAX hub that you would like to associate with this alarm driver
  • Return to the settings page

The selected hub status window on the settings page informs you of which hub you have selected

Add User Pins

You can set a number of user pins that the user will be required to enter before Disarming or Arming the AJAX alarm system from inside the Crestron Home application or a TSW touchscreen.

The user pin feature is optional. On the settings page you can turn the feature on and off for each of the following three functions:

  • Pin required to Disarm the system
  • Pin required to Arm the system
  • Pin required to Night Arm the system

To set the user pin details:

  • Press the Set Pin button on the settings page
  • Enter a name for the user
  • Enter a pin number for the user (minimum 4 digits)

You can add more users and pins by pressing the Add User Pin button

AJAX Panic Button

The panic button can be hidden from the end user by deselecting the show panic button toggle

Crestron Home Actions and Events

Actions available in Crestron Home include:

  • Disarm
  • Arm
  • Night Arm
  • Get Alarm State

Note: The Get Alarm State action can be used up to 15 times a day. Subsequent triggers of the action will be blocked from communicating with the AJAX cloud services.

CHNAX Trigger

  • 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.

Email Notifications

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: *****

Dynamic Buttons – Pre v 4.1.0.0

  • Customisable UI Tile
  • Up to 10 two state buttons
  • Customise Icons and State Text
  • Passthru Functions for each button state
  • Customisable Tile Icon

Build your own UI with custom Buttons with feedback.

Like Quick Actions but so much more!

Usage

This Dynamic button driver is a flexible tool allowing you to achieve a number of different things with a single site Licence. You might setup a single button in a room to control a s Fire or a A Set of Buttons to control your Garden Sprinklers.

You can choose if the button appears on the Home page or just in the room and you can customise the Icon used on the Tile to make it appropriate to the usage.

BMS Example

For Example you might somply 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

Setup

Using the Setup pages of the driver you can add and remove buttons and setup the naming and icons for each of the buttons you require.

The setup of the buttons is stored persistantly meaning once you setup a driver the settings will persist a reboot of the driver.

NB: Its also best practice to store a Gold cloud configuration when you are happy with your crestron home configuration and before and after making any changes.

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 and Delete

The Edit Button (Sliders) allows you to change the Name and for each state the icon and text.

Add Actions

This button allows you to add a new button and start editing.

Change Tile Icon

Click to set the Tile Icon. (Used in home and room Tile)

Disable/Enable on home 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

For each button four actions are exposed.

  • State 1 (button State goes to 1)
  • State 0 (button State goes to 0)
  • S1 Passthru
  • S0 Passthru

To see more about passthru events and Actions look at this article

Actions are available for

  • Toggle
  • Set State
  • Passthru

Passthru

The Button Name is used to identify which button to control. This is as per the Index (Shown on the Settings Page in the UI)

State 1 or 0 to set the Button or which passthru connection to make.

Intercom for Crestron Home

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>

2N Simpl Windows Module

User manual for the 2N Simpl Windows Module.

  • Allows you to control your 2N Doorstation directly from Simpl Windows
  • Relay and IO both exposed in Simpl Windows

This hardware interface is intended to simplify the connection of your Crestron Custom system to the popular 2N range of doorstation hardware.
The Switch controls and IO input can be used in tandem with the SIP call functionality to allow a complete solution. In addition we offer a range of Door and Lock UI Tiles which can be used to give a user interface to the hardware.

Module

The software is delivered as a Simpl+ Module which can be used within a Simpl Windows Custom Program.

Parameters including

Licence Key and Network Configuration are all required.

The Switch INputs are controlled by Pulsing the

Inputs.

State Outputs are Latching Outputs including :

DeviceOnlineFb

SwitchState1 and SwitchState2

Input, Output and Relay States.

NB: Only the first Relay,INput and Output Supported.

All other digital outputs are pulses representing events.

The Response from the licensing call is reported to a serial string.

NB: The processor must be connected to the internet for initial activation.

2N Device Setup and Connection

To make use of the Switch and I/O API you will need to apply a 2N Enhanced Integration Licence.

We suggest when first connection you set authentication to None.

The Driver requires a TCP Connection Type and can support Digest , Basic or no Authentication.

If Authentication is used a user must be created and given control and monitoring on I/O Access and control privileges on Switch Access .

You need to create a user and give that user the privileges:

NB: the user is not the same as the user that you use to get into the web Interface.You have to add and enable one of the accounts on the HTTP API Page.

The function applied to Switch 1 or Switch 2 are configured in the 2N web interface.

NB: Relays and Outputs are not controlled directly by the module.

The Module controls the Swithes which in turn control the relay or Output.

Sample Program and Xpanel

A Sample Program and Xpanel are included in the download.

NB: You will need to update the licence key in the program to a valid licence key to use the sample program, there is currently no grace period on use.

The AIR Xpanel need to be setup with connection details of the processor and IP-ID-03.

This Xpanel is provided to Allow Initial familiarization with the Module.

Adding the Module to a new or exsisting Project

The Download comes with three zip Files within the SIMPL Folder:

  • 2NHardwareInterfaceModuleFiles.zip
  • 2NSampleLCDControlSystems_MC4_archive.zip
  • 2NSampleLCDControlSystems_CP4_archive.zip

The First Package contains all of the files required to use the module within your own program or in a new Simpl Windows Program.

Extract the files to the root of your project. ( same level as you *.smw file). Then reopen the SMW file or use Project->ReSync Project for these to appear in your Project Modules.

The Download also contains a VTPRO Folder with the Xpanel files which are for use with the sample programs:

Innerange Inception Crestron Home Setup Guide

“Simple & Easy Installation
Integrated Security – Access Control”

Web Powered Security

User Experience

Our InnerRange is a suite of drivers to allow you to make the most of this powerful Security and Access Controller. The Core Driver is only available in a package along with the Events and Actions Driver ( this is as we don’t support Core Events). All the other companion drivers can be used standalone on a system allowing you to use the subsystems of the Inception independently.

Hardware Configuration

The core and additional drivers connect 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”. Its 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.

Core Alarm actions require a user pin to be entered and the userassociated with that PIN in Inception
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 permissions on all devices.

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

Adding drivers to the system

Drivers are all located in Security System Type under the manufacturer “Inner Range”

Core Alarm Driver

This is a native Crestron home Security System Driver and only appears on the Home page and not in the room in which the driver is loaded. We suggest you add the core driver and supplementary drivers to a Rack room hidden from the client.

Home Page

The home page tile is the access point for users into the security sytem.

Alarm Areas

  • Area are added dynamically to the system
  • Area Names are pulled in from the Alarm system.
  • Main Arm and Disarm Functions can be controlled directly from this page.

Known Issue:

  • If an area is removed from the alarm it will remain visible until a Crestron Home Reboot.

Area Page

  • The induvidual Area Page shows area status and all available area controls.

Swiping right takes you to the Global System Page

Global Alarm Control

  • Global Status Text
    • Alarm Status
    • Door Command Status
    • Panic Status
    • Licence Status
  • Global Function buttons
    • Lock All Doors
    • Close All Outputs
    • Panic Alarm

User Pin

When you first attempt an alarm action you will be prompted to enter your inception user pin.

You can choose to store the pin on the user device by ticking the box.

Once a pin has been saved you will no longer be prompted for a user pin.

Customisation

  • Per UI Customisation
    • Security Areas can be hidden per panel in the Advanced Settings section of the panel.

  • Global Customisation
    • Using the setup app areas can be hidden globally
    • Friendly names can also be changed from the set names in the security System.

More Customisation

  • Alarm Functions can be Globally Enabled and Disabled.

Function Buttons

  • Enable Disable
  • Rename
  • Change Label

Actions and Events (Core Driver)

Security System Types Provide Events based on Alarm States.

However we do not support these events in our Core Driver and instead:

We advise loading and using the Events and Actions provided in our Dedicated Module

CHINNEREVENTS

(See Below)

ALARM EVENTS

Events and Actions for Alarm Zones (companion to core)

A Seperate extension driver is provided to expose Actions and Events.

This driver must be loaded to your crestron home system ( there is no Extension UI). Once loaded and setup as described here you will see events and Actions allowing you to control your alarm System.

The User account used in the hardware setup should have permissions on all areas you want to control/monitor.

Events

Events listed below are supported for up to 20 Areas per System.

  • Alarm
  • ArmAway
  • StayArm
  • Disarmed

These events are triggered once on the initial change of state.

The Areas are Referenced using the Area ReportingID (See more detail below)

Actions

Actions are supported for up to 20 Areas per System

The Areas are Referenced using the Area ReportingID (See more detail below)

Please note that this method of control allows you to potentially control the the Alarm directly without user passwords.

This functionality should be used with caution if you are to maintain the validity of your alarm system security.

Inception Access

Events and Actions for Doors

A Seperate extension driver is provided to expose Actions and Events for Doors as defined in the .

This driver must be loaded to your crestron home system and provides a basic UI for verification of the connection and permissions.

NB: Generally this driver would be placed in a room hidden to the client and all access be via events and actions.

The User account used in the hardware setup should have permissions on all doors you want to control/monitor.

On the main page of the driver you see a list of all the doors in your system

Doors which you dont have permission will be shown bu greyed out.

Clicking a door will show you the detail page for the door which shows the status of the door.

NB: Open and Close Status is only shown when a reed switch is connected and correctly configered.

Events

Events listed below are supported for up to 20 Doors per System.

  • Unlocked
  • Locked
  • Opened
  • Closed
  • Forced
  • Held Open

These events are triggered once on the initial change of state.

The Doors are Referenced using the ReportingID

Actions

Actions are supported for up to 20 Doors per System

The Doors are Referenced using the ReportingID

Inception Inputs

Events and Actions for Inputs

A Seperate extension driver is provided to expose Actions and Events for Inputs as defined in the .

This driver must be loaded to your crestron home system and provides a basic UI for verification of the connection and permissions.

NB: Generally this driver would be placed in a room hidden to the client and all access be via events and actions.

The User account used in the hardware setup should have permissions on all inputs you want to control/monitor.

On the main page of the driver you see a list of all the inputs in your system

Inputs which you dont have permission will be shown but greyed out.

Clicking an input will show you the detail page for the door which shows the status of the input.

Actons of Isolate and De-Isolate are also available.

Events

Events listed below are supported for up to 20 inputs.

  • Inactive
  • Active
  • Low Battery
  • Poll Failed

These events are triggered once on the initial change of state.

The Inputs are Referenced using the ReportingID

Actions

Actions are supported for up to 20 Inputs per System

The Doors are Referenced using the ReportingID

Inception Outputs

Events and Actions for Outputs

A Seperate extension driver is provided to expose Actions and Events for Inputs as defined in the .

This driver must be loaded to your crestron home system and provides a basic UI for verification of the connection and permissions.

NB: Generally this driver would be placed in a room hidden to the client and all access be via events and actions.

The User account used in the hardware setup should have permissions on all outputs you want to control/monitor.

On the main page of the driver you see a list of all the ouputs in your system

Outputs which you dont have permission will be shown but greyed out.

Clicking an output will show you the detail page for the door which shows the status of the output.

Actions allow you to test control of the output.

Events

Events listed below are supported for up to 20 inputs.

  • Inactive
  • Active
  • Low Battery
  • Poll Failed

These events are triggered once on the initial change of state.

The Outputs are Referenced using the ReportingID

Actions

Actions are supported for up to 20 Outputs per System

The Doors are Referenced using the ReportingID

FAQ

Can we use more than 20 inputs,outputs,Doors

We will be providing a free upgrade soon that will support more than 20.

IFTTT (Webhooks) User Manual

This driver allows you to trigger an IFTTT action using the IFTTT Webhooks


Room Page Tile

The Room Tile give access to the Main UI

NB: This UI is intended for Testing rather than end user facing.

To customize the user experience consider using a quick action or a UI Tile Driver.

Driver User Interface

  • Main Page
    • Test Events 1 – 10. Up to 10 test Events are supported per driver
    • Each Events sends a webrequest build with the IFTTT Key and Command and displays the response to the user

Driver Settings

  • IFTTT Key
    • Allows a user to set their Key
    • Click the link below when logeed into yout IFTTT Account
    • https://ifttt.com/maker_webhooks
    • Then Click “Documentation” to find your Key
  • Event Name
    • Allows the user to set the Event Name
    • This Must Match the Event Name set in yout IFTTT Applet.

Common Settings

Licence Settings

Hardware Settings

Actions and Events

Updated v4.0.3beta.0

Added New Action to recall events using the IFTTT Event Name Directly in the Parameter

Updated Original Action to use the Integer of the Event Number used in the UI

Action 1

Trigger Event by IFTTT EventName

Accepts a string.

The Action will send the request to IFTTT using the parameter as the eventname.

Action 2

Trigger Event by Event Button Number

Accepts an Argument of 1 – 10

The Action will send the request to IFTTT of the event name entered in the driver UI

 v4.0.2.0

The driver will normally be used via Actions.

Enter a Text String of the Event Number from 1-10

The Event name String is entered on the UI as a argument to the sequence step.

IFTTT Configuration

Setup your IFTTT Applet trigger to accept the webhook service.

At the same time you need to note your webhook key which can be found in the documentation.

Use the link below ( when logged into your IFTTT Account)

https://ifttt.com/maker_webhooks

This webhook API Key is used to authenticate the driver to your IFTTT applet.

For each applet you can define a unique Event Name this event name is used by the driver to define which applet you want to trigger.

Then

After that the possibilities are endless!

https://ifttt.com/explore

QSYS Snapshot Controller

“QSYS Snapshots from Crestron Home”

Recall QSYS Snapshots From Crestron Home sequences.

crestron homepage qsys

Room Page Tile

This driver is one pof our hardware interface drivers and the User interface is designed with test and configuration in mind only.

Generally this tile would be placed in a hidden room such as a rack room or a commissioning room.

The Room Tile give access to the Main UI

Driver User Interface

  • Presets
    • Recall Snapshot 1 – 10.
  • Command Feedback
QSYS Snapshots on Crestron Home

qsys snapshot settings

Driver Settings

  • Snapshot name
    • This must match the Snapshot Bank Name in your Qsys Design
    • Global or User-Defined snapshots are supported.
    • User-Defined snapshot names are set in the Design Elements section of the Designer software.
  • Ramp Time
    • This setting specifies the ramp time used when loading the selected snapshot and is applied to all controlled snapshots.

Common Settings

Licence Settings

Hardware Settings

Actions and Events

Recall Snapshot (bank)

Bank Number between 1 and 10

Sequences recall snapshot

Multiple Drivers / Snapshot Banks

MultiSpeed Fan Controller

“Simple Relay Connected Fan Control!”

Control Multi Speed Fans in Crestron Home Setup.

Room Page Tile

The room page tile is the main entry point to the driver. Pressing on the tile will move the Fan state to its next state.

The Order of the states are as follows:

High,Medium,Low,Off

If any timers are currently running then the fan 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.

The tile shows the current state of the Fan.

As default the Home Page tile is not shown.

Crestron Home Fan Driver
Crestron Home Fan Time Delay

Driver User Interface

  • Status
    • This shows the fan status as per the room page tile.
  • Controls
    • Fire High
    • Fire Medium
    • Fire Medium
    • Fire Off
  • Time Delay Off
    • Time Delay Off Buttons ( if configured)
    • Configurable in settings
    • Hide if not required
    • Time Delay Cancel ( Cancel pending time off delays)

Actions and Events

SwitchedOnHigh

SwitchedOnMedium

SwitchedOnLow

SwitchedOff

Connecting fans to relay in crestron home

Driver Specific Settings

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

Common Settings

Display on home page (tick box)

  • Enable
  • Disable

Licence Settings

Hardware Settings

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.

Wine Cellar Monitor

“Life is too short for warm Wine!”

Monitor Temperature and Humidity in your Crestron Home Setup.

The process of maturation of the wine bottles and barrels in cellars requires carefully protected climatic conditions that are stable over time. It is especially important to control the temperature and humidity of the environment, creating an ideal microclimate for bottles and barrels.

Optimal temperature conditions should be between 12 and 16 °C for red wines and between 10 and 12 °C for white wines. In particular, it is important to avoid sudden changes in temperature and temperatures that are too high or too low.

Humidity should be kept constantly between 70-80 %rh. Very low humidity air is harmful to wine because it favors uncontrolled evaporation and oxidation. This driver and hardware combination allows you to ensure your investment is protected in an ideal environment.

Home Page Tile Actions

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

The Time shows the Current temperature of the monitoring sensor.

Crestron Home Driver Homepage
Crestron Home Wine Sensor

Main User Interface

  • Temperature
    • Current Temperature
    • Daily High and Low
  • Humidity
    • Current Humidity
    • Daily High and Low

Driver Specific Settings

  • Temperature Unit Selection
    • Celsius (Default)
    • Farenheit
  • Thresholds
    • Enable Disable Alerts
    • Max / Min

Common Settings

Display On Home Page

Licence Settings

Hardware Settings

Wine Settings Crestron Home Driver

Technology

This driver connects over the network to a.

Micro Environment Monitoring System, Integrated
Temp/Humidity Sensor, POE

The specific product code :

E-MICRO-TRHP .

This hardware can be purchased from:

EMEA ITM Components 

http://www.itm-components.co.uk

Actions and Events

Temperature Threshold Passed

Humidity Threshold Passed

Digital In 1 Closed / Open

Digital In 2 Closed / Open

Example Usages:

Temperature Thresholds can be connected up to alerts or monitoring tools to ensure users are notified and remedial action can be taken.

The digital inputs might be used to monitor the cellar door which might be crucial in ensuring temperature and humidity of the space.

Device Configuration and Settings

The device supports Poe or Local 5.5VDC power supply. Once on the network the device can be located using a device discovery tool which can be found here (Opens in a new window).

The username and password can be changed from the defaults in the web interface of the device.

The unit defaults to :

User: root

Password: nti

Network Settings can also be configured using the web interface. The device needs to be routable to your crestron home processor. The IP address of the device is required for the driver settings.

The device username,password and IP Address need to be entered into the driver settings page in the Crestron Home setup app.

UI Tile – Home Control – Crestron Shades

“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

Licence Settings

Hardware Settings

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

UI Tile – Home Control – Crestron Lighting

“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

Licence Settings

Hardware Settings

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

WebRelay Hardware Interface Manual

Crestron Home Setup

The information below details the specific configuration to allow the hardware to work with the associated Crestron Home Driver.

WebRelay Module

Our recommendations:

  • Static IP address on the same Subnet

WebRelay Series Modules

Click here for the manufacturers WebRelay configuration manual.

Hardware Covered

  • X-WR-1R12-1I-I
  • X-WR-1R12-1I-E
  • X-WR-1R12-1I5-I
  • X-WR-1R12-1I24-I
  • X-WR-1R12-1I5-E

Hardware Connections

IP / LAN Settings

  1. Power the module and connect to network.
  2. Set IP address on computer to be on the same network as
    the module. (Example: Set computer to 192.168.1.50)
  3. To configure the module, open a web browser and enter:
    http://192.168.1.2/setup.html
  4. Assign permanent IP address to module, then restart module.
  5. Restore computer’s IP address, if necessary, and access the
    module at its new IP address to finish setup.

Remember the new password well or write it down just in case, if you forget the password, you will have to reset the intercom to default values (refer to the Installation Manual of your intercom model) and lose all your current configuration changes.

IP Address: 192.168.1.2
Subnet Mask: 255.255.255.0
Control Page Web Address: http://192.168.1.2
Control Password: (no password set)
Setup Page Web Address: http://192.168.1.2/setup.html
Setup Username: admin
Setup Password: webrelay (all lower case)

Network port usage

ServicePort / ProtocolDetail
Control80 (TCP)TCP Port 80 is the default control port but this can be changed.
Web Server80The port used to display the control and configuration web pages.
Modbus502Modbus is a messaging structure protocol used in the industrial, manufacturing, control and automation industries. It is an open protocol and offers interoperability with software and devices from other manufacturers. If Modbus is not used, this setting can be ignored. Modbus communications are disabled whenever the control password is enabled.

WebRelay Switching Settings

ATEN PDU – User Manual

Hardware Setup

ATEN Setup via Web Browser

  • Enable Telnet Server
  • Set Name
  • Set Password
  • Save

Compatibility List

Note1 : only PE6/8/9 has outlets switching capability and are hence compatible.

Note2: please make sure to use latest firmware (below is the minimum requirements)

Note3: all driver testing has been on a PE8324G

Add the Driver

You can add the ATEN driver to any room you like using the Crestron Home Setup application. The driver can be found under Power in the driver categories.

Enter in the IP Address, name, password and number of outlets of the ATEN PDU.

Room Page Tile

The room page tile is the main entry point to the driver. The Home page and Room Tiles allow the user to access the driver user interface.

Home Page Tile Actions

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

Driver User Interface

  • Output Selection
    • Launch Output Selection page
    • NB: If all outlets are hidden then the Output Selection button is also hidden. (however if this is the case we would recommend putting the driver in a hidden room.
  • Driver Settings
    • Launch Settings (password protected)

Output Selection

Select the Outlet you wish to control. This will present a new page to control the respective outlet.

NB: Using the Settings pages you can decide which of the PDU outlets to show and hide in this list.

That way you can select a small subset of pdu outlets to leave visible to your users.

Outlet Control

  • Output Controls
    • Outlet On
    • Outlet Off
    • Outlet Reset
  • Outlet Status
    • Current Status (On or Off)
    • Voltage Level
    • Amperage Level

Driver Specific Settings

  • Output Selection (Settings See Below)
  • All Outputs On ( user must confirm action)
  • All Outputs Off ( user must confirm action)

Common Settings

Display On Home Page

Licence Settings

Hardware Settings

Output Selection (Settings)

Select the Outlet you wish to control. This will present a new page to control the respective outlet.

NB: In this settings list all outlets are always displayed.

Outlet Control (Settings)

  • Output Controls
    • Outlet On
    • Outlet Off
    • Outlet Reset
  • Outlet Status
    • Current Status (On or Off)
    • Voltage Level
    • Current Level

  • Outlet Set Name
  • Display Outlet on Public View
    • When the checkbox is unchecked this outlet will no longer be visible in the (non password protected) output Selection page.

Pushover Notifications – User Manual

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

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

Licence Settings

Hardware Settings

PIN Lock Datasheet

Overview:

This UI Tile provides a locking function with a PIN protected Unlock function.

Function Type:

Locking / Closing

Device Type (Driver appears under this heading in Crestron Home):

UI Tiles

Functionality:

  • Adds a tile and an intuitive user interface for locking
  • Configurable auto lock control
  • Configurable Master Pin Code
  • Exposes Events to the Crestron Home OS
  • Consumes Actions from the Crestron Home OS
  • To see detailed functionality, see product user guide

Ideas for use:

  • Control Access to Wine Cellar
  • Control Access to Gun Room
  • Control Access to restricted content or functionality.

Features:

  • Modular Design
  • Simple Deployment and Integration
  • Designed with future Crestron Home developments in mind
  • Clean Minimalist Interface
  • Intuitive Control
  • Straightforward hardware interface driver integration and configuration

Events and Actions:

Events

  • Do Lock / Do Close
  • Do Unlock / Do Open

Actions

  • Lock / Close
  • Lock With Delay / Close with Delay
  • Unlock / Open
  • Unlock with auto Relock / Open with auto close
  • Enable/disable Auto Lock / Enable/Disable Auto Close

Actions (Controlling Feedback)

  • Door Open Sensor
  • Door Closed Sensor

Driver Associated 3rd Party Hardware:

  • Does not directly support any 3rd party hardware
  • Works with Crestron Home devices that support Actions & Events 
  • Can be connected to a 3rd party hardware interface driver.

Global Cache Datasheet

Overview:

We have a range of UI Tiles that provide a switching function. The functions of these drivers are described below.

Function Type:

Switching

Device Type (Driver appears under this heading in Crestron Home):

UI Tiles

Functionality:

  • Consumes Actions from the Crestron Home OS
  • To see detailed functionality, see product user guide
  • Extension tile provided for testing and commissioning

Features:

  • Modular Design
  • Simple Deployment and Integration
  • Designed with future Crestron Home developments in mind
  • Clean Minimalist Interface
  • Intuitive Control
  • Straightforward hardware interface driver integration and configuration

Events and Actions:

Actions

  • Relay 1 Open
  • Relay 1 Close
  • Relay 2 Open
  • Relay 2 Close
  • Relay 3 Open
  • Relay 3 Close

Driver Associated 3rd Party Hardware:

  • IP2CC
  • IP2CC-P

Webrelay Driver Datasheet

Overview:

This is a hardware interface Extension Driver

Function Type:

Hardware interface

Device Type (Driver appears under this heading in Crestron Home):

Relay

Functionality:

  • Exposes Events to the Crestron Home OS
  • Consumes Actions from the Crestron Home OS
  • Extension tile provided for testing and commissioning

Features:

  • Modular Design
  • Simple Deployment and Integration
  • Designed with future Crestron Home developments in mind
  • Clean Minimalist Interface
  • Intuitive Control
  • Straightforward hardware interface driver integration and configuration

Events and Actions:

Events

  • Input Closed
  • Input Opened

Actions

  • Relay Open
  • Relay Close

Driver Associated 3rd Party Hardware:

  • Webrelay

Overview Switching Driver Datasheet

Overview:

We have a range of UI Tiles that provide a switching function. The functions of these drivers are described below.

Function Type:

Switching

Device Type (Driver appears under this heading in Crestron Home):

UI Tiles

Functionality:

  • Adds a tile and an intuitive user interface for switching
  • Configurable timer control
  • Exposes Events to the Crestron Home OS
  • Consumes Actions from the Crestron Home OS
  • To see detailed functionality, see product user guide

Features:

  • Modular Design
  • Simple Deployment and Integration
  • Designed with future Crestron Home developments in mind
  • Clean Minimalist Interface
  • Intuitive Control
  • Straightforward hardware interface driver integration and configuration

Events and Actions:

Events

  • Switched On
  • Switched Off

Actions

  • Switch On
  • Switch On With Delay ( Delay in Mins up to 120 mins)
  • Switch Off
  • Cancel Timer

Driver Associated 3rd Party Hardware:

  • Does not directly support any 3rd party hardware
  • Works with Crestron Home devices that support Actions & Events 
  • Can be connected to a 3rd party hardware interface driver.

UI Tiles Switching – User Manual

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

Display on home page (tick box)

  • Enable
  • Disable

Licence Settings

Hardware Settings

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

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
EventLocked / ClosedEvent fires when state is updated to locked / closed
EventUnlocked / OpenedEvent fires when state is updated to Unlocked / Opened
Button Presses
EventLock/Close Button PressedEvent triggered when any command button is pressed
e.g. Tile button, Lock Button , Open Button
( Use this event to trigger a momentary release)
EventUnLock/Open Button PressedUse to trigger a momentary release.
EventTile Button PressedSuggested use: Use to trigger a momentary release.
NB: The UITile State will toggle.
Control Sensor Actions
ActionControl Sensor OpenedIf Locked the this causes the UI to show a “forced open” message
ActionControl Sensor ClosedIf 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 ActionsNB: All Function Actions will trigger Normal Events above
ActionUnlock / OpenUnlock / Close from an Action
ActionLock / CloseLock / Open from an Action
ActionUnlock / 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 / CloseDisable the Auto Lock / Close Feature
ActionEnable Auto Lock / CloseEnable the Auto Lock / Close Feature

Common Settings

Display On Home Page

Licence Settings

Global Cache – User Manual

iTach IP to Contact Closure Modules

Crestron Home Setup

The information below details the specific configuration to allow the hardware to work with the associated Crestron Home Driver.

Our recommendations:

  • Static IP address on the same Subnet

Global Cache IP to Contact Closure (IP2CC) Modules

Click here for the manufacturers Global Cache Configuration manual.

Hardware Covered

  • IP2CC
  • IP2CC-P
  • WF2CC

IP / LAN Settings

If you have the WF2IR then please read here for specific setup info.

Global Caché network-connected products currently support network connectivity through Ethernet or WiFi, depending on product line and model. By default, all devices are configured to automatically acquire their IP configuration via DHCP. However, if a DHCP server is not available, devices will assume a default static IP address as specified in each device’s documentation. Configuration of a device’s network and I/O settings can be managed through the product’s configuration web pages, or via API commands if supported by the product Global Caché Unified TCP API (see here).

For detailed information about configuration and operation of the various products from a user perspective, please refer to each product’s Quick Start or User Guide here.

Connect both an RJ45 (Ethernet) network cable and power supply to your iTach unit. If the iTach is PoE (Power over Ethernet) enabled, connecting a power supply is not necessary.

In its default configuration, the iTach TCP/IP models use DHCP to automatically obtain an IP address from your router. To determine the iTach’s IP address, download the iHelp application here.

Run iHelp on a Windows PC connected to your network. iHelp listens for Global Caché multicast beacons and displays the iTach IP address and other details within one minute. If a DHCP server is not present, defaulted iTach units will reside at IP 192.168.1.70.

Troubleshooting

iTach configuration can be reset to factory defaults by inserting a large metal paper clip into the small opening located to the right of the power connector. Only insert the paper clip approximately 1/8” (3mm) in. The LEDs on the front of the iTach will rapidly blink in unison, indicating a reset. Use a light touch when resetting your iTach, as force may damage your iTach hardware irreparably.

Network Port Usage

ServicePort / ProtocolDetail
Control4998 (TCP)Control Port
Discovery Service9131 (UDP)The beacon is a UDP packet sent to the multicast IP address 239.255.250.250 on UDP port
number 9131. Any system listening to this address and port will receive the periodic beacon message.
The message is sent 3 seconds after power on and then at random intervals of 10 to 60 seconds
thereafter.
Web Server80The port used to display the control and configuration web
pages

Network Capacity: Notes on Simultaneous TCP Connections
The iTach Series of devices supports 8 simultaneous open TCP software connections.

Firmware

The Global Cache Firmware is accessible through Global Cache support portal here.

2N DoorStation – User Manual

Updated for V3 Features Scroll down to see!

User manual for the 2N hardware interface module.

  • Allows you to control your 2N Doorstation directly from Crestron Home
  • Relay and IO both exposed in Crestron home
  • Supports the Crestron Actions & Events
  • Compatible with any native controls or connect to one of our tile drivers.

This hardware interface is intended to simplify the connection of your Crestron Home system to the popular 2N range of doorstation hardware.
The Switch controls and IO input can be used in tandem with the SIP call functionality to allow a complete solution. In addition we offer a range of Door and Lock UI Tiles which can be used to give a user interface to the hardware.
NB: the UI Tile and pages associated with this tile are not intended to be “customer facing”

When a 2N Intercom is used in a crestron System for Calling the user is presented with a Call page as seen below.

Supported Devices

This driver supports the API on the following devices 2N IP intercoms, 2N® SIP Audio Converter, 2N Access Unit 1.0, 2.0, M

2N Licence Requirements

Licensing on 2N has changed and for most of the functionality of our driver you now dont need any additional license.

The only additional license available is the Gold Licence and you will still need this if you want to use the motion detection parts of our driver.

Read more about this change to licensing from our Friends at Aldous Systems !

Rack Room Tile

This Hardware interface driver provides a simple UI intended for use by the integrator to verify the operation of the hardware.

The driver would generally not be client facing and would loaded to a “hidden” room in the system such as a rack room.

All hardware interface have a generic image showing two adjacent rings.

Main Page Actions

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

This pages allows you to test the function of the controls and see monitoring of the IO via the Crestron Home App.

Actions and Events

Actions

ActionDescriptionNotes
Switch 1 OnActivates Switch 1
Switch 1 OffDeactivates Switch 1
Switch 2 OnActivates Switch 2This can be used to end all an incoming call when the open gate button is pressed.
Swithc 2 OffDeactivates Switch 2
Dial PanelsMakes a call from the 2N Intercom to the rava:CRESTRON call group.
End Dial PanelsEnds the call make using the "Dial Panels " command.
End All Sip CallsEnds all active calls on the 2N Intercom deviceSupported from v4.2.0.0

Events

EventDescriptionNotes
Input 1 ClosedEvent called when Input 1 closed
Input 1 OpenedEvent called when Input 1 closed
Relay 1 ActivatedEvent called when Relay 1 activated
Relay 1 DeactivatedEvent called when Relay 1 Deactivated
Output 1 ActivatedEvent called when Output 1 activated
Output 1 DeactivatedEvent called when Output 1 Deactivated
Switch 1 ActivatedEvent called when Switch 1 activated
Switch 1 DeactivatedEvent called when Switch 1 Deactivated
Switch 2 ActivatedEvent called when Switch 2 activated
Switch 2 DeactivatedEvent called when Switch 2 Deactivated
Motiton DetectedMotion Detected based on video detection area and sensitivity threshold setting.
Noise DetectedNoise Detected based on noise detection level threshold.
Call Button PressedCall button on intercom presses ( Commonly used to trigger a doorbell using our Sonos Chime driver)

SIP Call Flow ( This functionality is not dependent on the driver)

We include and explanation here as the setup and usage is very common when using 2N in Crestron home.

When a guest or visitor presses the call button in a crestron home system configured for a 2N intercom the Crestron Rava Panels in the system ring with the incoming call from the intercom. This is done by setting up the dialer in the intercom

When the Crestron Home user presses the Actions button on this page a subsequent page showing all whole house quick actions is shown.

A common setup is to make a “whole house quick action” which opens the Gate using the 2N Switch Action

See more on setting up the call flow here

For the Quick Action to appear on the Call Screen you must tick the checkbox in the Settings Section of the call Action

More info here


2N Device Setup and Connection

To make use of the Switch and I/O API you dont need any additional license on the 2N.

We suggest when first connection you set authentication to None.

The Driver requires a TCP Connection Type and can support Digest , Basic or no Authentication.

If Authentication is used a user must be created and given control and monitoring on I/O Access and control privileges on Switch Access .

You need to create a user and give that user the privileges:

NB: the user is not the same as the user that you use to get into the web Interface.You have to add and enable one of the accounts on the HTTP API Page.

The function applied to Switch 1 or Switch 2 are configured in the 2N web interface.

2N Doorstation Setup Video

New Features v3

Summary

In the version 3 upgrade to our drivers we added a number of features to the standard 2N Module.

We exposed the State of the Relay in addition to the State of the “Switches”. This means if these are controlled by other systems you can keep everything in state.

We also added a couple of new monitored items to the events list.

With the Audio Licence on your 2N Intercom you can enable noise detection. Motion Detection is enabled on the internal intercom camera with the Video Licence. To read more about what licenses allow what on 2n follow this link.

In the version 3 module these events are brought into Crestron home as an Events. See a deomstration on our youtube channel here

Call Control

This new function allows basic control of the SIP calling on the 2N Intercom. When the call button is pressed on a 2N intercom setup for crestron home the intercom Dials “rava:CRESTRON” which initiates a call to all touchscreens in this default ring group.

NOTE: CRESTRON is the default ring groups for all shipping TSW‑x60 / 70 touch screens. This driver only supports this standard default CRESTRON call group.

Actions

(In addition to previously supported features)

  • Dial Panels ( Calls the Rava Dial Group CRESTRON)
  • End SIP Call Ends the call made by the Dial Panels Action ( Will not end a cll made from the call button)

Events

(In addition to previously supported features)

  • Switch Actions ( Activated / Deactivated)
  • Relay
  • Motion Detected

Some More From 2N

2N IP Series intercoms:

Doorlock Sensor Crestron Home Driver Datasheet

Driver Functionality:

The 2N Driver Series allows sophisticated control of the 2N Intercom systems. Along with standard intercom functionality between the intercom panel and the gate/door control there is now the ability to lock/unlock, detect states of lock/unlock and set AutoLock functionality.

In addition to control from the Tile and UI this driver has Sequencing actions that can be used via a quick action that can be selected from the actions button when a SIP Call is received from the front gate station.

Door Lock Function:

We control Lock/Unlock state of the door lock.

Implementation:

We control either Switch 1 or Switch 2 in the 2N Relay. This is configurable in the admin setup along with the IP address of the 2N device.

The Driver calls on the 2N rest API to activate the Switch on the unit.

On the unit the Switch must be configured to control the desired output device.

Door Sense Function

Door sense functionality updates the status of the tile feedback when the door is opened without the lock being released by an action from the driver. It will also indicate if the door is opened when the lock is enabled. See Feedback states above.

Driver Type:

Extension Driver

Driver Category:

Access Control

Driver Associated 3rd Party Hardware:

  • 2N IP Verso
  • 2N IP Solo
  • 2N IP Base
  • 2N IP Force
  • 2N IP Vario
  • WebRelay
  • WebRelay-POE

Select currency
GBP Pound sterling