Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/12/02 18:48

From 91.8 to 91.9

From version 91.9

edited by Alexander Mott
on 2023/12/18 23:07

Change comment: (Autosaved)

To version 98.1

edited by Alexander Mott
on 2024/12/02 18:48

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Attachments (0 modified, 1 added, 0 removed)
- local-remote search.png

Details

Page properties

Content

@@ -28,7 +28,7 @@
  = Connecting to Devices =
--In order to connect to any lighting devices, your computer must be physically connected to the lighting device or the lighting network. Typically, this is achieved via TCP (i.e. Ethernet or WiFi) or USB (usually a USB-A to USB-B cable), though some older devices may require an RS-232 serial connection or a different USB cable.
++In order to connect to any lighting devices, your computer must be physically connected to the lighting device or the lighting network. Typically, this is achieved via TCP (i.e. Ethernet or WiFi) or USB (usually a USB-A to USB-B cable), though some older devices may require an RS-232 serial connection or a different USB cable. Devices with authentication enabled (such as any 4-Series processor, RF/Zūm Wireless Gateway, etc.) will require credentials to be configured upon initially connecting to the device and then those credentials will be required when connecting in the future. **It is imperative that the Crestron Agent or Field Tech saves these credentials. Chief Integrations cannot assist without being able to connect to the device. 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. **
  Any Toolbox tool which requires connecting to a device has several buttons and fields at the lower left which relate to device connection:
@@ -167,6 +167,22 @@
 . Discover Devices button - press this to restart the discovery process
 . Export... button - use this button to export discovered devices to either a Device Summary or Address Book (covered in more detail below)
++=== Local vs Remote Search ===
++
++When using your laptop to do a Device Discovery, the default option for where to search for Crestron devices is "Local Search". This means that you will only be able to detect devices that are directly on same network as your laptop, even if communication between your laptop and the device is allowed in the network configuration. In these cases it can be useful to do a "Remote Search", which allows the Device Discovery to be performed from a Crestron device that is on a separate network from your laptop. Remote Search can also be done when connected to a device via USB, which makes it useful in situations where there are no open Ethernet ports or where the technician's laptop is not authorized to connect to the LAN.
++
++To do a remote search:
++
++1. Open Device Discovery Tool as normal
++1. Wait for the initial Local Search to conclude
++1. Press the button at the bottom of Device Discovery Tool window to select Remote Search
++1. In the connection bar that should appear at the bottom of the Device Discovery Tool window, use the pencil icon to input the details of the device you want to use for the search
++1*. Any 3-Series and 4-Series processor can be used to perform a remote search, but some devices (such as CEN-GWEXERs and DIN-CENCN-2s) will not work
++1. Wait for the Remote Search to conclude
++
++The below screenshot compares the results of a Local Search from a laptop that is on a 10.44.2.0/24 VLAN to the results of a remote search performed by a processor that is on a 10.44.5.0/24 LAN. Even though the network is configured to allow the laptop on the 10.44.2.0/24 network to connect directly to the processor at 10.44.5.45 on the 10.44.5.0/24 network, we are not able to discover any of the devices on that network when performing a Local Search (left window). When we use the processor for the Remote Search (right window), we are able to discover all 35 devices on t he 10.44.5.0/24 network.
++[[image:local-remote search.png||height="513" width="1121"]]
++
  === Export to Address Book ===
  Address Books [[image:1702589379487-339.png]] provide a convenient way to easily connect to different devices without memorizing all the different IP addresses and credentials for devices on your network. When an Address Book has been created for a job, you are able to connect to specific devices using the dropdown menu on the lower left of the tool instead of manually inputting the IP address or hostname using the Pencil menu. Note that when exporting devices to the Address Book, it is possible to add devices by either Hostname or by IP Address, and if the device settings are modified then it may be necessary to update your Address Book or create a new one.
@@ -281,15 +281,8 @@
  == Network Device Tree View ==
--(% class="box warningmessage" %)
--(((
--This section is under construction: please check back at a later date for more information
--)))
++Network Device Tree View [[image:1663622313939-259.png]] is a useful tool for addressing devices and resolving certain issues with networked hardware. Below are just some general tips for using the tool; see our [[device addressing>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Device Addressing.Addressing Devices from Toolbox.WebHome||anchor="HNetworkDeviceTreeView"]] page for specific instructions on how to use the Network Device Tree View for device addressing. The below are some general tips and recommended settings for Network Device Tree View:
--Network Device Tree View [[image:1663622313939-259.png]] is a useful tool for addressing devices and resolving certain issues with networked hardware. Below are just some general tips for using the tool; see our [[device addressing>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Device Addressing.Addressing Devices from Toolbox.WebHome||anchor="HNetworkDeviceTreeView"]] page for specific instructions on how to use the Network Device Tree View for device addressing.
--
--Initial configuration:
--
  * When connecting to a device for the first time in Network Device Tree View, we recommend making certain changes to the type of information displayed by right-clicking and selecting the "Show Configuration Dialog" option:
  ** Displaying the Serial Number and TSID is useful for easily identifying devices and determining whether specific devices are online or not
  ** Displaying the Network ID is useful for easily identifying whether devices have been addressed or not
@@ -298,11 +298,30 @@
  [[image:ndtv_settings.png||height="317" width="565"]]
  * In addition to the above settings, **it is generally recommended to right-click and ensure that "Show by Device Connection" is checked**
  ** "Show by Device Connection" will group devices by their connection to the host device (e.g., Cresnet devices on a DIN-CENCN-2 will be sorted by the Net that they are connected to, Zūm Wireless devices will be sorted by the ZUM-NETBRIDGE they are connected to, etc.)
--** "Show by Category" can be useful in some situations, particularly when looking at devices on a processor where all of the devices are necessarily on the same net, but it can be confusing since you are not able to tell at a glance how a device is connected (i.e. whether it is on Net 1 or Net 2 of a DIN-CENCN-2) and may result in accidentally misaddressing devices
++[[image:ndtv_by connection.png||height="436" width="344"]]
++** "Show by Category" can be useful in some situations, particularly when looking at devices on a processor where all of the devices are necessarily on the same net, but it can be confusing since you are not able to tell at a glance how a device is connected (i.e. whether it is on Net 1 or Net 2 of a DIN-CENCN-2) and may result in accidentally misaddressing devices; notice how in the below example there appear to be duplicate network IDs (e.g. a keypad and a GLXP-DIMFLV8 both at ID: 04) that aren't being flagged as duplicates because the devices are actually on different Nets, a detail that is only visible when "Show by Device Connection" is enabled as shown above.
++[[image:ndtv_by category.png||height="442" width="349"]]
  * These configuration changes are saved per device type, so once they are made they will not need to be made again unless you are connecting to a new type of device for the first time (e.g. changes made while connected to a DIN-AP4 will apply to all DIN-AP4s, but will not apply to any DIN-CENCN-2s you may connect to later)
++* If Network Device Tree View has been configured as recommended above, then the interface will look similar to the below for a fully-addressed system with no issues:
++** Since all of the devices have been addressed and there are no issues, the Network Device Tree View shows a yellow circle next to each device indicating an "OK" status
++[[image:ndtv_by connection.png||height="436" width="344"]]
++** A new system where all devices are online but have not been re-addressed may look more like the following example, with a red exclamation point indicating duplicate Network IDs
++[[image:ndtv_all loops.png||height="423" width="339"]]
++** Other types of status indicator may include a black circle for "Invalid Network ID" or "Invalid/duplicate TSID or Serial Number"
++* Right-clicking on an individual device will give many options to resolve common issues, as well as allow for identifying a specific device:
++** "Refresh All" use to refresh the list of actively connected devices, necessary e.g. if a Cresnet cable has been connected/disconnected from the device
++*** F5 is the keyboard shortcut for this function, though in both cases it may be more reliable to completely close and reopen Network Device Tree View to ensure all devices are refreshed
++** "Change Network ID..." use to change the Network ID (CID) of a specific device (see our [[device addressing page>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Device Addressing.Addressing Devices from Toolbox.WebHome||anchor="HNetworkDeviceTreeView"]] for more information)
++*** F2 is the keyboard shortcut for this function
++** "Identify This Device..." will put a specific device into "Identify" mode, the specific behavior for which depends on the individual device:
++*** Note that entering identify mode may stop the ShowRunnerCLC™ program and restart it when exiting identify mode: **to avoid losing progress and placing strain on the processor**, it is recommended to either identify and address all hardware prior to loading the ShowRunnerCLC™ program, or temporarily suspend the program with the console command ##stopprog -p:01## and then resume the program once done identifying all devices with the command ##progreset##
++*** Some devices will flash an LED (Cresnet keypads, GLS-SIMs, et al.)
++*** Some devices will flash an LED and make a noise (Cresnet occupancy sensors, most room controllers, et al.)
++*** Load controllers will typically flash all connected loads
++** "Change Serial Number..." is used to change the device's Serial Number (and thus its TSID); this is rarely required and is only necessary in cases where a device reports an invalid or duplicate SN/TSID, or where the reported SN does not match the SN physically printed on the device
++** "Open Text Console..." will open a Text Console window directly to the specific selected Cresnet/RFID device (//not// to the host device you are connected to in Network Device Tree View); only recommended for advanced users
++[[image:ndtv_rc on device.png]]
--If the
--
  == Script Manager ==
  The Script Manager [[image:1663622272369-417.png]] is where Load Scripts can be opened and specific sets of commands executed. Load Scripts are .txt files that allow you to automate certain tasks by connecting to a device and executing a predetermined sequence of commands, and are a powerful tool to save time on-site when you need to run the same or similar set of commands on many devices.

local-remote search.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.alexander\.mott@chiefintegrations\.com

Size

...	...	@@ -1,0 +1,1 @@
	1	+108.5 KB

Content