Wiki source code of Ethernet Intersystem Communications Export (Crestron)

Version 21.1 by Mark Kohlmann on 2024/08/22 20:58

version	line-number	content
6.1	1	(% class="box warningmessage" %)
	2	(((
21.1	3	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:
13.1	4
	5	* "Disconnect signal from Etherenet ISC symbol in program."
	6	* "Change Locally: Update signal name in EISC ISC symbol only."
	7
20.1	8	[[image:MicrosoftTeams-image.png\|\|queryString="width=394&height=413" height="413" width="394"]]
6.1	9	)))
	10
9.1	11	ShowRunnerCLC™ provides Ethernet Intersystem Communications interfaces for integration with 3rd party Crestron systems.
1.1	12
	13	* EISCs may be Classic, 3-Series, or Server/Client (VC-4) types
	14	* EISCs can have their IP-ID and IP Address of the remote changed at run-time without a program restart
	15	* An RSD file will be built for each EISC and a URL will be displayed on the touchscreen to retrieve it
	16	* There are 2 EISC modes and only one mode is supported on an EISC definition, multiple EISCs may be defined
	17	** AV Integration
	18	*** Provides a standardized interface for controlling areas
2.1	19	*** Area selection may be changed at run-time
	20	*** [[AV Integration Demo>>url:https://files.chiefintegrations.com/s/Di4aypEKX7APn8n]]
3.1	21	*** Signals Provided per Area (signals vary by Area settings/configuration):
	22	**** Area Name
	23	**** Occupied
	24	**** Occupancy Enable/Disable
	25	**** Color Temp Auto
	26	**** Color Temp Manual Set and Feedback
	27	**** Area Master Raise/Lower
	28	**** Save Current Scene
	29	**** Recall Scene # and Current Scene Feedback
	30	**** Extended Scene Export option set
	31	***** Scene Count
	32	***** Scene Names
	33	**** Load Count
	34	**** Load Level Analogs
	35	**** Load Names
	36	**** Extended Load Export option set
	37	***** CCT Load type: Color Temp
	38	***** RGB[A\|W]: Individual Color Channels
	39	**** Shade Count
	40	**** All Shade Open/Close
	41	**** Shade Name
	42	**** Shade Open/Close/Stop
5.1	43	**** Ignore Fade Times option set
	44	***** Fade Times are not sent out, only final value. Reduces traffic.
1.1	45	** Device Export
3.1	46	*** Exports devices with specific signals for each device type
	47	**** Occupancy Sensor
	48	***** Occupied
	49	***** Online Feedback
	50	**** Keyswitch
	51	***** Active Feedback
	52	**** Partition Sensor
	53	***** Combined Feedback
	54	**** Keypad
	55	***** Enable/Disable w/ Feedback
	56	***** Button Press Event
	57	***** Button Feedback Setting
	58	***** Extended Keypad Export option set
	59	****** Button Tap/Double Tap/Held Events
	60	**** Global Actions
	61	***** Activate
	62	**** Shade
	63	***** Open/Close/Stop
	64	**** Load
	65	***** Level Set and Feedback
	66	**** Photocell
	67	***** Sensor Reading
	68	**** Area
	69	***** Scene Set and Feedback
6.1	70	*** Devices to be exported are defined in the configuration and are not changeable at run-time.
8.1	71
15.1	72	==== Creating Remote Connections through the UI ====
	73
	74	* Open the Setting (Gear icon in upper right corner) screen from the main page
	75	* Select Crestron Integration
	76	* To add and edit a new connection:
	77	** press the + Add at the bottom left corner of the page
	78	** In the left column select the connection you want to edit
	79	** In the middle column enter:
	80	*** Connection label
	81	*** IP Address of the AV Processor
	82	*** IP ID
	83	** Additional features can be selected:
	84	*** Ignore Fade Times
	85	*** Extended Load Export
	86	*** Extended Scene Export
	87	** EISC Type:
	88	*** Classic (2-Series Compatible)
	89	*** 3-series TCP EISC
	90	** In the right column select all areas needed
	91	** Save by clicking on the Check mark that appears to the right or "Settings:" in the middle column
	92	** Saving will generate an RSD File URL at the bottom of the middle column
	93	*** http:~/~/10.0.0.10/ShowRunner/RSDs/IP-ID0xF1Lighting_Interface.rsd
	94	*** 10.0.0.10 = Lighting system Processor IP Address
	95	*** IP-ID0xF1 = Lighting system Processor IP Table entry for AV integration
	96	** RSD file can also be retrieved from the Toolbox File Manager app
	97	*** Open File Manager
	98	*** Select Internal Flash/HTML/ShowRunner/RSDs
	99	*** all generated RSD files will be available in this folder
	100
10.1	101	==== Processors with Control Subnets ====
	102
11.1	103	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:
10.1	104
	105	* ##securegateway default##
11.1	106	** Enables non-secure connections (CIP on port 41794) from the LAN side
10.1	107	* ##isolatenetworks off##
	108	** Enables communications between the LAN and the Control Subnet, where the actual control processor is located
	109
8.1	110	==== VC-4 Specific Notes ====
	111
	112	===== Prerequisites =====
	113
	114	* VC-4 server installed
	115	* Recommended VC-4 server hardened per [[Crestron>>https://support.crestron.com/app/answers/detail/a_id/1001249/kw/harden%20VC-4]]
9.1	116	** Will require SETCSAUTHENTICATION command on processor
8.1	117	** VC-4 installer will need to provide username and password for processor to connect, this is used with SETCSAUTHENTICATION
9.1	118	* ShowRunnerCLC™ running on a processor
	119	* EISC created in the ShowRunnerCLC™ config
8.1	120	* AV program running on VC-4, AV programmer will need to provide the ROOM ID from VC-4
	121
15.2	122	===== ShowRunnerCLC™ Config Settings (Exporting from a ShowRunnerCLC™ VC-4) =====
8.1	123
15.2	124	* Define EiscType in config: ##"EiscType": "EiscServer"##
	125	* Everything else defined as normal
17.1	126	* RSD file will be available in "/opt/crestron/virtualcontrol/RunningPrograms/[ROOMID]/Html/ShowRunner/RSDs/"
19.1	127	* When importing the RSD to the AV program, the following steps need to be taken:
	128	** In the configuration tab, right-click the imported EISC and select "Replace"
	129	** Replace the imported RSD with a "VC-4 EISC Client"
	130	** 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
15.2	131
18.1	132	===== ShowRunnerCLC™ Config Settings (Importing from a third-party VC-4, ShowRunnerCLC™ on Processor) =====
15.2	133
8.1	134	* Define EiscType in config: ##"EiscType": "VirtualControlEiscClient"##
20.1	135	* Define Vc4RoomId in config: ##"Vc4RoomId": "VC4ROOMID"##
18.1	136	* IpAddressOrHostname will not be used, instead VCSERVERADDR console command will be used instead
8.1	137
	138	===== Processor Settings =====
	139
20.1	140	* 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##
	141	* 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##
8.1	142	* Reboot after entering the above settings
	143
	144	(% class="box warningmessage" %)
	145	(((
19.1	146	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.
8.1	147	)))
	148
	149	(% class="box warningmessage" %)
	150	(((
20.1	151	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.
8.1	152	)))
20.1	153
	154	(% class="box errormessage" %)
	155	(((
	156	Crestron Processors cannot use the VirtualControlEiscClient to multiple different VC-4 instances, firmware limitation of VCSERVERADDR command
	157	)))
	158
	159	(% class="box errormessage" %)
	160	(((
	161	Crestron Processors cannot use multiple Control System Authentication (setcsauthentication) settings, firmware limitation of SETCSAUTHENTICATION command
	162	)))
	163
	164	==== EISC Settings by Topology ====
	165
	166	The following table defines the EISC types to use between ShowRunnerCLC™ and an AV program when they are connecting to each other.
	167
	168	IP Address Requirements:
	169	//EISC Packed// and //3-Series TCP/IP EISC// need both processors to know each other's IP Address.
	170	//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.
	171
	172	\|=EISC Created By\|=ShowRunner Host Type\|=ShowRunner EISC Type\|=AV Processor Host Type\|=AV EISC Type
	173	\|ShowRunner\|Processor\|(((
	174	EiscPacked* ~~~~
	175
	176	ThreeSeriesEisc*
	177
	178	EiscServer
	179	)))\|Processor\|(((
	180	SR Setting //EiscPacked//:
	181	Ethernet Intersystem Communications* ~~~~
	182	Ethernet Intersystem Communications (Packed)* ~~~~
	183	\\SR Setting //ThreeSeriesEisc//:
	184	3-Series TCP/IP Ethernet Intersystem Communications*
	185
	186	SR Settings //EiscServer//:
	187	EISC Client*
	188	)))
	189	\|ShowRunner\|Processor\|EiscServer\|VC-4 Room\|EISC Client*
	190	\|ShowRunner\|VC-4 Room\|EiscServer\|Processor\|VC-4 EISC Client* ~~
	191	\|ShowRunner\|VC-4 Room\|EiscServer\|VC-4 Room\|VC-4 EISC Client* ~~
	192	\|AV Program\|Processor\|(((
	193	EiscPacked* ~~~~
	194
	195	ThreeSeriesEisc*
	196
	197	EiscServer
	198	)))\|Processor\|(((
	199	SR Setting //EiscPacked//:
	200	Ethernet Intersystem Communications* ~~~~
	201	Ethernet Intersystem Communications (Packed)* ~~~~
	202	\\SR Setting //ThreeSeriesEisc//:
	203	3-Series TCP/IP Ethernet Intersystem Communications*
	204
	205	SR Settings //EiscServer//:
	206	EISC Client*
	207	)))
	208	\|AV Program\|Processor\|VirtualControlEiscClient* ~~*\|VC-4 Room\|EiscServer
	209	\|AV Program\|VC-4 Room\|EiscClient*\|Processor\|EiscServer
	210	\|AV Program\|VC-4 Room\|VirtualControlEiscClient* ~~*\|VC-4 Room\|EiscServer
	211
	212	Notes:
	213	~* Must configure IP Address of Remote Processor
	214	~** Must configure VC-4 RoomID for connection in symbol definition
	215	~~~* Must configure "Vc4RoomId" property in SR Config set to the ROOMID of the remote VC-4 instance
	216	~~~** 2-Series processor compatible