NuBryte Support Center

    Crestron Driver User Guide

    Follow

     


    1. Introduction
    This driver has been designed to provide control of the NuBryte 1-Gang and 2-Gang lighting systems.
    2. Installation
    Add the module in to your Crestron Simpl Windows program and copy the following files to the location where your project is stored:

    • NuBryte_[version].ush
    • NuBryte _[version].usp NuBryteSimplSharp_[version]sharp.clz NuBryte_Touch_1Gang_[version].umc NuBryte_Touch_2Gang_[version].umc NuBryte_Link_[version].umc
    • NuBryte_LinkSub_[version].umc
    • Note that the package includes a demonstration smw file and an accompanying vtp file.
    • These are not required for integration, but can be used to test or confirm the compatibility of the module.
    • Click Tools -> Reload Device and Symbol Libraries from disk and select the module from the Symbol Library. 

    3. Commands
    3.1 NuBryte_Comms
    The module has the following commands available to input:

    • Name Type Explanation
    • INITIALISE DIGITAL Initialises the module, initiating discovery of the devices.

    The module has the following output:

    • Name Type Explanation
      COMMS_INITIALISE DIGITAL Sends a command to all other modules that discovery has begun and that they should initialise. This signal should be connected to all COMMS_INITIALISE inputs on your other devices
      • 1-Gang (Bedroom)
      • 2-Gang (Lounge)
      • Link (NuBryte Link)

    The following parameter must be defined for the UMC.

    Name Type Explanation

    • USER_EMAIL_ADDRESS STRING The e-mail address you used to set up the NuBryte system.
      PING_PERIOD TIME Should be set to a value in seconds. This is the interval that each device uses to check if there have been any changes. Note that if you have 20 light switches in your installation and you set this value to 60s, that means on average the driver will be making one HTTP call to check the status of a light every 3 seconds, which may cause the network to lock up occasionally.
    • It is recommended that you set it to a large number, e.g. 300s.
    • This feature is only needed for the Crestron driver to update the status of the lighting system when NuBryte touch panels or the light switches are used to change the lighting. If all lighting is controlled via Crestron, this feature can be turned off by setting the parameter to 0s.
    • 3.2 1-Gang, 2-Gang and LinkSubThese modules are identical except that the 2-gang will control two lights. LinkSub is used to connect a device that communicates via a NuBryte Link (e.g. a wall mounted light switch) but otherwise works in exactly the same way as a 1-gang.
    • The module has the following commands available to input:
      • COMMS_INITIALISE DIGITAL A signal which should be connected to the COMMS module
      • SWITCH_ON/SWITCH_OFF DIGITAL Switches the light on/off. Note that after a switch the device may not respond for a few seconds in order to prevent the user from rapidly switching a light on and off.
      • SET_LEVEL ANALOG Sets the brightness level and will also turn the light on if it is off. This ranges from 0 to 100.
      • RAMP_UP/DOWN DIGITAL Ramps the brightness up in steps of 5%. Should take 5 seconds to reach full brightness.

    The module has the following output:

    1. DISCOVERED DIGITAL An indicator saying whether discovery of the device has been successful. This will only go high if the Comms module’s INITIALISE has been pressed and the device is then found on the network.
    2. SWITCH_STATUS DIGITAL Whether the light is on or off.
    3. LIGHT_LEVEL ANALOG The current light level.
    4. The following parameter must be defined for the UMC.
    5. ROOM_NAME STRING This must correspond exactly to the room name you used in the device’s wizard when setting up the NuBryte system.3.3 Link
    6. The module has the following commands available to input:
      1. COMMS_INITIALISE DIGITAL A signal which should be connected to the COMMS module The module has the following output:DISCOVERED DIGITAL An indicator saying whether discovery of the device has been successful. This will only go high if the Comms module’s INITIALISE has been pressed and the device is then found on the network.The module has the following output:
        ROOM_NAME STRING This must correspond exactly to the room name you used in the device’s wizard when setting up the NuBryte system.
    7. You must add one NuBryte_Link device for each physical NuBryte Link device in your installation.When the Link device is discovered on the network, it will attempt to find a NuBryte_LinkSub (sub device) in your Crestron installation for each device it has been set up to communicate with. If it finds a device that isn’t in the installation it will print the following message to the console:
      1. Couldn't find device in SMW matching room name=<Room Name>, id=<id>, Link name=<Link name>
      2. If you get this message, you need to add a NuBryte_LinkSub with room name equal to <Room Name>.


    Was this article helpful?
    0 out of 0 found this helpful

    Comments