Ethernet Intersystem Communications Export (Crestron)

Last modified by Mark Kohlmann on 2024/11/19 23:23

Note: For AV Integration EISCs, any changes to load or shade/shade group quantity, ExtendedSceneExport, or ExtendedLoadExport settings will require a regeneration of the EISC and will result in signal changes. When importing a new or updated RSD file to the A/V program, ensure the appropriate options are selected:

  • "Disconnect signal from Ethernet ISC symbol in program."
  • "Change Locally: Update signal name in EISC ISC symbol only." 

MicrosoftTeams-image.png

Chief Integrations does not recommend using the 3-Series TCP/IP Ethernet Intersystem Communications (ThreeSeriesEisc).  We have reports of this type locking up SIMPL Windows programs attempting to integrate with showrunner™ on 4-series processors.  3-Series EISCs try to negotiate who is the server and who is the client.  Use the table below for recommendations on EISC types.

ShowRunnerCLC™ provides Ethernet Intersystem Communications interfaces for integration with 3rd party Crestron systems.

  • EISCs may be Classic, 3-Series, or Server/Client types
  • EISCs can have their IP-ID and IP Address of the remote changed at run-time without a program restart
  • An RSD file will be built for each EISC and a URL will be displayed on the touchscreen to retrieve it
  • There are 2 EISC modes and only one mode is supported on an EISC definition, multiple EISCs may be defined
    • AV Integration
      • Provides a standardized interface for controlling areas
      • Area selection may be changed at run-time
      • AV Integration Demo
      • Signals Provided per Area (signals vary by Area settings/configuration):
        • Area Name
        • Occupied
        • Occupancy Enable/Disable
        • Color Temp Auto
        • Color Temp Manual Set and Feedback
        • Area Master Raise/Lower
        • Save Current Scene
        • Recall Scene # and Current Scene Feedback
        • Extended Scene Export option set
          • Scene Count
          • Scene Names
        • Load Count
        • Load Level Analogs
        • Load Names
        • Extended Load Export option set
          • CCT Load type: Color Temp
          • RGB[A|W]: Individual Color Channels
        • Shade Count
        • All Shade Open/Close
        • Shade Name
        • Shade Open/Close/Stop
        • Ignore Fade Times option set
          • Fade Times are not sent out, only final value.  Reduces traffic.
    • Device Export
      • Exports devices with specific signals for each device type
        • Occupancy Sensor
          • Occupied
          • Online Feedback
        • Keyswitch
          • Active Feedback
        • Partition Sensor
          • Combined Feedback
        • Keypad
          • Enable/Disable w/ Feedback
          • Button Press Event
          • Button Feedback Setting
          • Extended Keypad Export option set
            • Button Tap/Double Tap/Held Events
        • Global Actions
          • Activate
        • Shade
          • Open/Close/Stop
        • Load
          • Level Set and Feedback
        • Photocell
          • Sensor Reading
        • Area
          • Scene Set and Feedback
      • Devices to be exported are defined in the configuration and are not changeable at run-time.

Creating Remote Connections through the UI

  • Open the Setting (Gear icon in upper right corner) screen from the main page
  • Select Crestron Integration
  • To add and edit a new connection:
    • press the + Add at the bottom left corner of the page
    • In the left column select the connection you want to edit
    • In the middle column enter:
      • Connection label
      • IP Address of the AV Processor
      • IP ID
    • Additional features can be selected:
      • Ignore Fade Times
      • Extended Load Export
      • Extended Scene Export
    • EISC Type:
      • Classic (2-Series Compatible)
      • 3-series TCP EISC
    • In the right column select all areas needed
    • Save by clicking on the Check mark that appears to the right or "Settings:" in the middle column
    • Saving will generate an RSD File URL at the bottom of the middle column
      • http://10.0.0.10/ShowRunner/RSDs/IP-ID0xF1Lighting_Interface.rsd
      • 10.0.0.10 = Lighting system Processor IP Address
      • IP-ID0xF1 = Lighting system Processor IP Table entry for AV integration
    • RSD file can also be retrieved from the Toolbox File Manager app
      • Open File Manager
      • Select Internal Flash/HTML/ShowRunner/RSDs
      • all generated RSD files will be available in this folder

Processors with Control Subnets

When integrating a 3-Series EISC with a processor that has both a LAN port and a Control Subnet using a connection over the LAN, there are some additional settings that need to be enabled in order for the integration to work correctly. It is necessary to either set up CWS users and enable a secure (SCIP on port 41796) EISC or run the following commands:

  • securegateway default
    • Enables non-secure connections (CIP on port 41794) from the LAN side
  • isolatenetworks off
    • Enables communications between the LAN and the Control Subnet, where the actual control processor is located

VC-4 Specific Notes

Prerequisites
  • VC-4 server installed
  • Recommended VC-4 server hardened per Crestron
    • Will require SETCSAUTHENTICATION command on processor
    • VC-4 installer will need to provide username and password for processor to connect, this is used with SETCSAUTHENTICATION
  • ShowRunnerCLC™ running on a processor
  • EISC created in the ShowRunnerCLC™ config
  • AV program running on VC-4, AV programmer will need to provide the ROOM ID from VC-4
ShowRunnerCLC™ Config Settings (Exporting from a ShowRunnerCLC™ VC-4)
  • Define EiscType in config: "EiscType": "EiscServer"
  • Everything else defined as normal
  • RSD file will be available in "/opt/crestron/virtualcontrol/RunningPrograms/[ROOMID]/Html/ShowRunner/RSDs/"
  • When importing the RSD to the AV program, the following steps need to be taken:
    • In the configuration tab, right-click the imported EISC and select "Replace"
    • Replace the imported RSD with a "VC-4 EISC Client"
    • In the device settings for the VC-4 EISC Client, under the IP Net Address tab, add the Room ID for the ShowRunnerCLC™ program on the VC-4
ShowRunnerCLC™ Config Settings (Importing from a third-party VC-4, ShowRunnerCLC™ on Processor)
  • Define EiscType in config: "EiscType": "VirtualControlEiscClient"
  • Define Vc4RoomId in config: "Vc4RoomId": "VC4ROOMID"
  • IpAddressOrHostname will not be used, instead VCSERVERADDR console command will be used instead
Processor Settings
  • Use console command VCSERVERADDR (or processor configuration pages) to add the VC-4 server IP address or hostname. Example: VCSERVERADDR my-vc-4-server.mycorpnet.com
  • If security (hardening) is enabled use console command SETCSAUTHENTICATION to enroll the credentials used to login to VC-4. Example: SETCSAUTHENTICATION -n:vc4user -p:vc4password
  • Reboot after entering the above settings

ShowRunnerCLC™ will generate the RSD file as an EISC type, the SIMPL Windows programmer will need to convert the symbol to the correct type. At the time of this writing, Crestron does not allow import/export of RSD files for EISC Client, EISC Server, and VC-4 EISC Client types.

ShowRunnerCLC™ uses analog join 4001 on normal EISCs to confirm the logic is fully online.  Join 4001 is not available on EISC Client, EISC Server, and Virtual Control EISC Client types so 4000 is used instead. 

Crestron Processors cannot use the VirtualControlEiscClient to multiple different VC-4 instances, firmware limitation of VCSERVERADDR command

Crestron Processors cannot use multiple Control System Authentication (setcsauthentication) settings, firmware limitation of SETCSAUTHENTICATION command

EISC Settings by Topology

The following table defines the EISC types to use between ShowRunnerCLC™ and an AV program when they are connecting to each other.

IP Address Requirements:
EISC Packed and 3-Series TCP/IP EISC need both processors to know each other's IP Address.
EISC Server accepts EISC connections from an EISC Client or a VC-4 EISC Client.  Only the EISC Client side must know the IP address of the EISC Server.

EISC Created ByShowRunner Host TypeShowRunner EISC TypeAV Processor Host TypeAV EISC Type
ShowRunnerProcessor

EiscPacked* ****

ThreeSeriesEisc*

EiscServer

Processor

SR Setting EiscPacked:
Ethernet Intersystem Communications* ****
Ethernet Intersystem Communications (Packed)* ****

SR Setting ThreeSeriesEisc:
3-Series TCP/IP Ethernet Intersystem Communications*

SR Settings EiscServer:
EISC Client*

ShowRunnerProcessorEiscServerVC-4 RoomEISC Client*
ShowRunnerVC-4 RoomEiscServerProcessorVC-4 EISC Client* **
ShowRunnerVC-4 RoomEiscServerVC-4 RoomVC-4 EISC Client* **
AV ProgramProcessor

EiscPacked* ****

ThreeSeriesEisc*

EiscServer

Processor

SR Setting EiscPacked:
Ethernet Intersystem Communications* ****
Ethernet Intersystem Communications (Packed)* ****

SR Setting ThreeSeriesEisc:
3-Series TCP/IP Ethernet Intersystem Communications*

SR Settings EiscServer:
EISC Client*

AV ProgramProcessorVirtualControlEiscClient* ***VC-4 RoomEiscServer
AV ProgramVC-4 RoomEiscClient*ProcessorEiscServer
AV ProgramVC-4 RoomVirtualControlEiscClient* ***VC-4 RoomEiscServer

Notes:
* Must configure IP Address of Remote Processor
** Must configure VC-4 RoomID for connection in symbol definition
*** Must configure "Vc4RoomId" property in SR Config set to the ROOMID of the remote VC-4 instance
**** 2-Series processor compatible