Skip to Content

Wiki source code of Crestron RF Gateway Setup

Last modified by Alexander Mott on 2025/03/12 17:16
Show last authors
1 {{error}}
2 All RF Gateways require authentication to be configured to connect to the device as well as credentials to be configured for SSL connection with the processor: **the Crestron Agent or Field Tech are responsible for recording these credentials. Chief Integrations cannot provide assistance unless the admin credentials are known. The only way to connect to a device for which the credentials have been lost is to factory reset the device. (% style="color:red" %)All previously acquired devices will need to be re-acquired if the gateway is factory reset.(%%)**​​​​
3 {{/error}}
4
5 {{box cssClass="floatinginfobox" title="**CONTENTS**"}}
6 {{toc/}}
7 {{/box}}
8
9 Crestron RF Gateways are a two-way radiofrequency (RF) transceivers that allow Crestron Zūm Wireless (ZUMMESH), infinetEX, or Extended Range wireless devices to communicate with the control processor over Ethernet. They are for Crestron wireless systems what [[DIN-CENCN-2s>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.DIN-CENCN-2 Setup.WebHome]] are for wired Cresnet systems.
10
11 Installations using infinetEX or Extended Range devices require the CEN-GWEXER gateway, while Zūm Wireless installations require the ZUMNET-GATEWAY. Throughout this article, "CEN-GWEXER" and "infinetEX" will be used to refer to the gateway and the wireless devices respectively.
12
13 For SHOWRUNNER™ installations, the IP address of the CEN-GWEXER does not matter as long as it is in the same range as the processor and does not conflict with any other devices on the network. Instead, CEN-GWEXERs are identified to the processor via their IP-ID. Note that which infinetEX devices are landed at which CEN-GWEXER matters, and if devices are moved between CEN-GWEXERs then the configuration will need to be updated (see below). Chief Integrations typically provides an SRTakeoff.xlsx spreadsheet with an IP Table tab that lists all the CEN-GWEXER IP-IDs in the program. If no takeoff is provided, then the processor's IP table can be checked by running the ##ipt -t ##command from the processor after the configuration is loaded. CEN-GWEXERs will typically have IP-IDs in the "##Cx##" range. For Zūm Wireless jobs using the [[Zūm Discovery process>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Program Configuration.Zūm Discovery.WebHome]], the IP table portion of the IP Configuration should be skipped as the ZUMNET-GATEWAY IP table will be assigned and consumed at the time of discovery.
14
15 = IP Configuration =
16
17 Typically, each CEN-GWEXER will need to be initially configured via USB (microUSB) unless their MAC addresses are already known and the lighting network has a DHCP server. If the DHCP server on the network is temporary (e.g. DHCP server software running on your computer or a processor utilizing the [[ShowRunner™ DHCP Server>>doc:SHOWRUNNER™ Setup Guide.Troubleshooting Guide.Advanced Tools.DHCP Server.WebHome]]), then static IP addresses must be configured. If the DHCP server is permanent (such as a CP4N or ZUM-HUB4 Control Subnet), then only the IP table needs to be configured for the devices.
18
19 When connecting to a CEN-GWEXER for the first time, it may be necessary to manually change the connection type from "Auto" to "SSL/TLS". It is also necessary to manually edit the CEN-GWEXER's address book entry so that the connection protocol is "SSL/TLS" when a CEN-GWEXER is added to the address book using Device Discovery tool export.
20
21 == SSL Setup ==
22
23 Crestron devices that support SSL require the use of a secure connection between the processor and the device. In order to establish this secure connection, the processor must have authentication enabled and there must be a user on the processor with "Connects" group permissions. The device connecting to the processor must be configured to use these credentials before the processor is added to the IP table, otherwise the device's IP address will be blocked by the processor (see [[our FAQ on how to resolve this>>attach:https://wiki.chiefintegrations.com/FAQ/I%20can%27t%20connect%20to%20my%20processor%20via%20Ethernet]]). **The Crestron Agent or Field Tech are responsible for recording these credentials. **If these Credentials are lost but the admin credentials to the device are known, then new SSL credentials can be set up. **Chief Integrations cannot provide assistance if the credentials are not known. The only way to connect to a device for which the credentials have been lost is to factory reset the device, which may require redoing the start-up from scratch. **
24
25 Configure the Connects user on the processor:
26
27 * Ensure the processor has [[its IP configured and authentication enabled>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome||anchor="HIPConfiguration"]]
28 ** Verify the processor has authentication enabled by running the command: ##auth## without any parameters
29 * Create a user by running the following commands, replacing the "username" and "password" with your desired credentials
30 ** ##adduser -N:username -P:password##
31 ** ##addusertogroup -N:username -G:Connects##
32 * Verify that the user has been created by running the command: ##listusers##
33 * This process only needs to be performed once per processor on the jobsite
34
35 Configure the CS authentication on the CEN-GWEXER:
36
37 * Run the following command, replacing the "username" and "password" with the credentials of the Connects user from the previous step
38 ** ##setcsauth -N:username -P:password##
39 * Repeat this process for every CEN-GWEXER on the jobsite
40
41 == DHCP Configuration ==
42
43 (% class="box warningmessage" %)
44 (((
45 Be sure to complete the above SSL Setup prior to setting the IP table
46 )))
47
48 If the lighting network has a permanent DHCP server, then CEN-GWEXERs only require their IP table to be configured, though it is good practice to also record or update their hostname. If the MAC addresses for the CEN-GWEXERs are not known, then the best way to update their configuration is via USB (microUSB). If you are able to identify the CEN-GWEXERs by MAC address, then it is possible to configure these settings via Ethernet using Text Console. Whether connected to the CEN-GWEXER via USB or Ethernet, the process to configure the IP table and hostname is the same:
49
50 * Open Text Console in Toolbox and connect to the CEN-GWEXER
51 ** Note that you may need to manually select "SSL" connection type, as "Auto" might not always redirect
52 * Run the following commands to configure the CEN-GWEXER's IP table and hostname (example is for an IP-ID of (% style="color:olive" %)**C1**(%%), and a target processor IP address of (% style="color:orange" %)**172.22.0.1**(%%), and a device hostname of (% style="color:purple" %)**GWEXER-L1**(%%))
53 ** Update IP table: ##addm (% style="color:olive" %)**C1**(%%) (% style="color:orange" %)**172.22.0.1**(%%)##
54 *** Skip for [[Zūm Discovery jobs>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Program Configuration.Zūm Discovery.WebHome]]: IP table is automatically assigned at time of discovery
55 ** Set hostname: ##host (% style="color:purple" %)**GWEXER-L1**(%%)##
56 ** Reboot the CEN-GWEXER: ##reboot##
57 * At this point, it is a good idea to [[update the device firmware>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Updating Firmware.WebHome]]
58 * Repeat for all CEN-GWEXERs on the job
59
60 If setup has been done correctly and the ShowRunnerCLC™ program and configuration have already been loaded to the processor, then you should see the CEN-GWEXER's IP-ID reporting online when you run the ##ipt## command on both the CEN-IO and the processor.
61
62 == Static Configuration ==
63
64 (% class="box warningmessage" %)
65 (((
66 Be sure to complete the above SSL Setup prior to setting the IP table
67 )))
68
69 If there is no permanent DHCP server on the lighting network, then CEN-GWEXERs should be configured with static IP addresses via USB (micro USB). If a temporary DHCP server is connected to the lighting network and you are able to identify CEN-GWEXERs by MAC address, then it is possible to configure these settings via Ethernet using Text Console. Whether connected via USB or Ethernet, the process to configure the static IP addresses is the same:
70
71 * Open Text Console in Toolbox and connect to the CEN-GWEXER
72 ** Note that you may need to manually select "SSL" connection type, as "Auto" might not always redirect
73 * Run the following commands to configure the CEN-GWEXER's static IP settings (example is for a **10.0.0.0(% style="color:darkgoldenrod" %)/24(%%)** subnet, with a static IP address of (% style="color:blue" %)**10.0.0.12**(%%), an IP-ID of (% style="color:olive" %)**C1**(%%), and a target processor IP address of (% style="color:orange" %)**10.0.0.10**(%%), and a device hostname of (% style="color:purple" %)**GWEXER-L1**(%%))
74 ** Set IP address: ##ipa 0 (% style="color:blue" %)**10.0.0.12**(%%)##
75 ** Set IP subnet mask: ##ipm 0 (% style="color:darkgoldenrod" %)**255.255.255.0**(%%)##
76 ** Set default gateway: ##defr 0 **10.0.0.1**##
77 ** Disable DHCP: ##dhcp off##
78 ** Update IP table: ##addm (% style="color:olive" %)**C1**(%%) (% style="color:orange" %)**10.0.0.10**(%%)##
79 ** Set hostname: ##host (% style="color:purple" %)**GWEXER-L1**(%%)##
80 ** Reboot the CEN-GWEXER: ##reboot##
81 * At this point, it is a good idea to [[update the device firmware>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Updating Firmware.WebHome]]
82 * Repeat for all CEN-GWEXERs on the job
83
84 If setup has been done correctly and the ShowRunnerCLC™ program and configuration have already been loaded to the processor, then you should see the CEN-GWEXER's IP-ID reporting online when you run the ##ipt## command on both the CEN-IO and the processor.
85
86 = RF Channel =
87
88 Crestron wireless devices have 16 non-overlapping channels numbered 11-26 to prevent and avoid RF interference either from other appliances in the building (such as microwaves or Wi-Fi routers) or from other Crestron devices that are attempting to communicate with different CEN-GWEXERs.
89
90 By default, all CEN-GWEXERs will ship with the same RF channel, so for jobs where interference may be an issue it is necessary to manually change the RF channel of the CEN-GWEXERs. When selecting which RF channel to use for each CEN-GWEXER, it is best to avoid using the same RF channel for any CEN-GWEXERs that are adjacent to each other (whether they are adjacent on the same floor or whether they are adjacent on top of/below each other by virtue of being installed in the same location on different floors). See Crestron's [[RF Products Best Practices guide>>https://www.crestron.com/getmedia/3b3588d1-9356-4d4b-a2df-b3ac1c6fff14/mg_bp_installation_setup_crestron_rf_products]] for more details on RF channel selection.
91
92 * If using Text Console, run the command: ##rfchannel [#]##
93 ** Replace "[#]" with the desired RF channel
94 * If using the Gateway Configuration tool:
95 ** Connect to the CEN-GWEXER in another tool such as Text Console
96 ** Navigate to Functions > Gateway Configuration... to open the tool
97 ** At the top left, under "RF Channel", ensure "Fixed" is selected and then choose a channel
98 ** The Gateway Configuration window will become nonresponsive while the RF channel is being applied to the gateway
99 ** Close the tool once the change has been applied
100 * Once the RF channel has been updated, verify it by running the command: ##rfchannel## without any parameters
101
102 = Acquiring and Addressing Devices =
103
104 (% class="box warningmessage" %)
105 (((
106 **When acquiring wireless hardware on jobs with multiple CEN-GWEXERs, it is very important that only one gateway is in acquire mode at a time.** 
107 Once you are done acquiring devices to one gateway, ensure that you take the gateway out of acquire mode before you begin acquiring devices to the next gateway.
108 Attempting to acquire devices while multiple gateways are actively in acquire mode may result in wireless hardware being acquired to the incorrect gateway.
109 )))
110
111 Unlike wired Cresnet devices such as DIN-CENCN-2s or processors which can poll the connected Cresnet and report all devices that are currently connected, CEN-GWEXERs and other wireless gateways must first acquire the wireless Crestron devices. Acquiring wireless Crestron devices involves putting the gateway into acquire mode and then performing a physical button press sequence on each of the wireless devices to be acquired. This process is described in detail below:
112
113 * Put the CEN-GWEXER into acquire mode using one of the methods below:
114 ** If using Text Console, run the command: ##acquire start##
115 *** Devices will indicate their TSID in the Text Console window as they are acquired
116 ** If using the Gateway Configuration tool:
117 *** Connect to the CEN-GWEXER in another tool such as Text Console
118 *** Navigate to Functions > Gateway Configuration... to open the tool
119 *** At the bottom left, click "Start Acquire"
120 *** [[image:1701720163760-996.png||height="271" width="316"]]
121 *** Wait for the confirmation dialog and click "OK" to close the confirmation dialog
122 *** Previously acquired devices will be displayed with black text, while newly acquired devices will populate with blue text
123 *** Using the Gateway Configuration tool to acquire hardware may be preferable to using Text Console as acquired devices will report their Serial Number as they are acquired instead of just their TSID
124 * The process for acquiring a wireless device to a gateway varies for each model, but generally the procedure is as follows:
125 ** Press the "setup" button (top button for keypads) in the sequence press-press-press-hold
126 ** Do not release the button until the setup LED (top feedback LED for keypads) begins blinking slowly
127 *** If the setup LED turns steady, then the device was acquired successfully
128 *** If the setup LED begins to rapidly blink, then the acquire failed
129 **** Press the "setup" button again to cancel acquire
130 **** Attempt to acquire the device again
131 **** If the device fails to acquire a second time: verify that the correct gateway is in acquire mode, verify that no other gateways are in acquire mode, verify that the desired gateway is close enough to the device that it should be able to acquire, and verify that there are no other sources of RF interference that may be preventing acquisition.
132 ** Repeat for all wireless devices that need to be acquired to the gateway
133 * Once all devices have been acquired, take the CEN-GWEXER out of acquire mode:
134 ** If using Text Console, run the command: ##acquire stop##
135 ** If using the Gateway Configuration tool, click the "STOP Acquire" button in the lower left
136 * Address devices as indicated in the SHOWRUNNER™ takeoff by either:
137 ** Use Text Console to run the command: ##setrfidbytsid [CID] [TSID]##
138 *** Replace "[CID]" with the connection ID as indicated in the takeoff
139 *** Replace "[TSID]" with the 4-byte, hexadecimal TSID of the device to be addressed
140 ** Use Network Device Tree View to select each device and address them individually
141 * Verify all devices have been acquired and addressed correctly using Network Device Tree View or with the Text Console command: ##reportnetdev##
142
143 = Moving/Removing Devices (Unacquiring Devices) =
144
145 When a wireless Crestron device is acquired to a new gateway using the typical acquiring process described above, it will automatically forget the previously connected gateway. The gateway itself, however, must manually "forget" the previously connected device before a newly acquired and addressed device will function correctly. This is necessary whether the originally connected device is moved or if the originally corrected device has failed and is being replaced.
146
147 To unacquire a device from a gateway, it is necessary to run the below commands, replacing "[TSID]" with either the 4-byte hexadecimal TSID of a single device or "all" to forget all previously acquired devices. Devices do not need to be online in order to be acquired (e.g., a failed device can still be unacquired using this method). While only one of these commands needs to be run per device, it is not documented which command (ending in "0" or "1") is required for each model, so it is generally advisable to run both commands for each device to be unacquired:
148
149 * ##unacquirebytsid [TSID] 0##
150 * ##unacquirebytsid [TSID] 1##
151
152 Once all of the necessary TSIDs have been unacquired, use the ##reboot## command to reboot the gateway and complete the unacquire process.