Skip to Content
Last modified by Alexander Mott on 2025/10/30 17:24
From version 8.1
edited by Alexander Mott
on 2024/03/19 21:51
Change comment: There is no comment for this version
To version 10.1
edited by Alexander Mott
on 2025/10/30 17:24
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,36 +1,58 @@
1 -= Crestron Information Gathering Tool =
1 +(% class="box warningmessage" %)
2 +(((
3 +The built-in Command Lists for certain device models are missing important information. For these models, please use our Custom Command lists:
2 2  
3 -In the event that a Crestron processor or ShowRunnerCLC™ installation behaves unexpectedly, Chief Integrations may ask for detailed logs in order to analyze and report to Crestron. The easiest way to collect this information is to use the Crestron Information Gathering Tool.
5 +* [[ZUMNET-JBOX-* / ZUMNET-DIN-* (all models)>>https://files.chiefintegrations.com/s/6qsd7TRzXMcizFa]]
6 +* [[3- or 4-Series processors>>https://files.chiefintegrations.com/s/76TKszP4QamjQdm]]
7 +* [[CEN-GWEXER or ZUMNET-GATEWAY wireless gateways>>https://files.chiefintegrations.com/s/wGcHbTLo7LHktA5]]
8 +)))
4 4  
10 +The Crestron Information Gathering Tool is a valuable standalone piece of software that allows for easily recording current job-site status, such as online devices, their serial numbers, and their firmware versions. It is good practice to run this tool at the end of project start-up in order to document the project status.
11 +
12 +In the event that a Crestron processor or ShowRunnerCLC™ installation behaves unexpectedly, Chief Integrations may ask for detailed logs from the Crestron Information Gathering Tool in order to analyze any issues and report them to Crestron if appropriate.
13 +
5 5  == Steps ==
6 6  
7 7  1. Download and install the Crestron Information Gathering Tool
8 8  1*. The tool is available to download from the Resources tab on the [[SW-INFOTOOL Product Page>>url:https://www.crestron.com/Products/Control-Hardware-Software/Software/Development-Software/SW-INFOTOOL]]
9 -1*. Alternatively, the tool can be downloaded and installed through the Crestron MasterInstaller by running the MasterInstaller and selecting the "Information Gathering Tool" option.
10 -1. Connect to the lighting network via Ethernet cable. 
11 -1*. Ensure that the connecting computer's Ethernet settings are set to Static and the IPv4 address does not conflict with any devices already on the network.
12 -1. Run the Crestron Information Gathering Tool
18 +1*. Alternatively, the tool can be downloaded and installed through the Crestron MasterInstaller by running the MasterInstaller and selecting the "Information Gathering Tool" option
19 +1. Connect to the lighting network via Ethernet cable
20 +1*. Ensure that the connecting computer's Ethernet settings are set to Static and the IPv4 address does not conflict with any devices already on the network
21 +1. Open Crestron Information Gathering Tool
13 13  1. If gathering information for only one device:
14 14  11. Input the IP address and login credentials for the device
15 -11*. If no login credentials are necessary, leave the "Username" field as "crestron" and the "Password" field blank.
24 +11*. If no login credentials are necessary, leave username and password at default
16 16  11. Select the desired output folder for the results
17 17  11*. Default location is "C:\Users\YourName\Documents\Crestron\InformationTool\Results"
18 -11. Select the appropriate Command List using the dropdown menu
19 -11*. For most ShowRunnerCLC™ installations, this will be "3-Series Processors without RF"
27 +11. Select the appropriate Command List using the dropdown menu or use a custom command list by clicking "Select" and locating the command list file
20 20  11. Ensure the PLOGs box is checked if collecting information for a processor (it should be checked by default)
21 21  11. Press the Start button. It may take a couple of minutes for all the commands to finish running
22 22  1. If gathering information for multiple devices:
23 -11. Press the "Autodiscover" button to discover all networked devices.
24 -11*. If no devices are discovered, proceed to the Batch Mode menu by pressing the "Batch Mode" button at the top of the window
25 -11. At the bottom of the window, press the "Batch Devices" button or select "Batch Mode" on the top tool bar
26 -11*. If devices were not autodiscovered, it may be possible to use [[Device Discovery Tool>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Toolbox Basics.WebHome||anchor="HLocalvsRemoteSearch"]] to perform a Remote Search and generate an [[Address Book>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Toolbox Basics.WebHome||anchor="HExporttoAddressBook"]]
27 -11*. Once an Address Book has been generated, it can be imported into the Information Tool BatchDevices menu using the Devices > Import... drop down menu
28 -11. Press the "Model Name" column heading to sort by device model
29 -11. Check the box in the "Enable" column to select which devices to gather information on
30 -11. Once all desired devices are selected, press "Start Selected" in the lower right to begin collecting information on those devices.
31 -1. Once the tool is finished running the commands, the "Uploader" option at the top of the window will be bolded
32 -1. Press this to open the Uploader dialog box
33 -1. Ensure all files are selected with a checkbox in the "Enable" column
34 -1. Check the "I agree to the Uploader Terms of Service" box
35 -1. Press "Send to Uploader"
36 -1. Once the files are finished uploading, a URL will appear in the "Your download link:" field. Copy and paste this link to share the logs with CI or Crestron support.
31 +11. Click the "Batch Mode" button at the top of the window to open the Batch Mode window
32 +11. At the top of window, use the Devices > Autodiscover drop down menu to automatically add all discovered devices
33 +11*. If not all devices are discovered (e.g. if there are devices that are only reachable through a router), then devices can be added from an Address Book
34 +11*. If you do not already have an Address Book for the job, use [[Device Discovery Tool>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Toolbox Basics.WebHome||anchor="HLocalvsRemoteSearch"]] to perform a Local Search and generate an [[Address Book>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Toolbox Basics.WebHome||anchor="HExporttoAddressBook"]]
35 +11*. Then, use Device Discovery to perform a Remote Search and export the results to the same Address Book
36 +11**. Alternatively, directly edit the Address Book .xadr file in a text editor to manually add any missing devices
37 +11*. In the Batch Mode window, use the Devices > Import... drop down menu and locate the Address Book .xadr file to import the devices
38 +11. Press the "Model Name" column heading to sort devices by model
39 +11. For each model of device:
40 +111. Input the device credentials or leave the default values if authentication is not enabled for the device
41 +111. If the device is a ZUMNET-JBOX or ZUMNET-DIN, make sure the "PLOGs" box is unchecked and the "Connect Type" is set to CTP
42 +111. Select the appropriate Command List by clicking the "..." button in the Command List column, clicking "Select", and then locating the Command List file
43 +111. Right click anywhere on the device row and select "Copy to Same Model Devices" to apply these settings to all devices with the same model
44 +111*. Be sure to update the credentials if different credentials were used for different, same-model devices
45 +11. Check the box in the "Enable" column to include it when gathering information
46 +11*. Multiple devices can be enabled at once by ctrl+click, shift+click, or ctrl+A selecting multiple devices and then clicking "Enable Selected" from the right-click menu
47 +11. Once all desired devices are selected, press "Start Selected" in the lower right to begin collecting information on those devices
48 +1. Once the tool is finished running the commands, double check that no devices failed due to correctable issues (e.g. incorrect credentials) and re-run the tool for those devices if the issues are resolved
49 +1. If you have an Internet connection:
50 +11. Open the Uploader window by clicking the "Uploader" button at the top of the window
51 +11. Ensure all files are selected with a checkbox in the "Enable" column
52 +11. Check the "I agree to the Uploader Terms of Service" boxd
53 +11. Press "Send to Uploader"
54 +11. Share the URL in the "Your download link:" field with Chief Integrations or Crestron support for analysis
55 +1. If you do not have an internet connection:
56 +11. Navigate to the output folder in File Explorer
57 +11. Select all files and add to a .zip file using a tool such as [[7-Zip>>https://www.7-zip.org/]]
58 +11. Send this .zip file to Chief Integrations or Crestron support for analysis