Skip to Content

Changes for page Debug Program Logic

Last modified by Scott Kohlmann on 2024/01/05 18:55
From version 3.1
edited by Alexander Mott
on 2022/10/13 23:17
Change comment: There is no comment for this version
To version 7.1
edited by Scott Kohlmann
on 2023/04/21 14:18
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
1 +XWiki.scott\.kohlmann@chiefintegrations\.com
Content
... ... @@ -4,11 +4,10 @@
4 4  
5 5  (% class="row" %)
6 6  (((
7 +The ShowRunnerCLC™ program has several powerful command-line tools that can be used in order to determine whether or not the program is configured correctly. Knowledge of how to use these tools can help with on-site troubleshooting and narrow down issues with programming or installation.
7 7  
8 -The showrunner™ program has several powerful command-line tools that can be used in order to determine whether or not the program is configured correctly. Knowledge of how to use these tools can help with on-site troubleshooting and narrow down issues with programming or installation.
9 +All of these tools are unique to the ShowRunnerCLC™ program, requiring that ShowRunnerCLC™ be loaded to the processor with a valid license. In addition to ShowRunnerCLC™ being loaded, a valid SrConfig.json file must also be loaded.
9 9  
10 -All of these tools are unique to the showrunner™ program, requiring that showrunner™ be loaded to the processor with a valid license. In addition to showrunner™ being loaded, a valid SrConfig.json file must also be loaded.
11 -
12 12  When using these troubleshooting tools, it is advisable to have Text Console be maximized on the screen. Many of these commands will return tables of information in Text Console, and if the window is too small the tables will be broken up and difficult to read.
13 13  
14 14  These commands do not need to be used individually, and in fact it is often useful to combine the use of these tools for effective troubleshooting. For example, if lights are not installed or a piece of control hardware is offline or physically defective, the program logic can still be verified by enabling area debug messages and then simulating keypad presses or occupancy sensor state changes. The debug messages will enable confirmation that the configuration file is correct and that once the fixtures are installed/devices brought online, they will begin functioning correctly.
... ... @@ -20,6 +20,7 @@
20 20  The ##sr show## command can take a number of different arguments in order to see different types of defined hardware. A list of all possible commands can be displayed in the text console by running the command "##sr show ?##", however the most frequently used are given below:
21 21  
22 22  |=(% style="width: 154px;" %)Command|=(% style="width: 828px;" %)Result
22 +|(% style="width:154px" %)##sr show global ids##|(% style="width:828px" %)Returns a table of all objects in the configuration sorted by their Global ID and displaying their Type and Name.
23 23  |(% style="width:154px" %)##sr show load##|(% style="width:828px" %)(((
24 24  Returns a table of load controllers and loads. Each row in the table is either a load controller or a load, and load controllers are always followed by all of their loads. The table includes the Global ID for each load and load controller, as well as current online status for the load controller and current level for the load.
25 25  
... ... @@ -52,11 +52,12 @@
52 52  
53 53  (% class="box warningmessage" %)
54 54  (((
55 -As of version 3.020, debug messages print to the event log instead of the console.
55 +As of version 3.020, debug messages print to the event log instead of the console. If the program is reset, "debug logic" commands will need to be run again upon restart but "eventlog" settings will persist and do not need to be run again.
56 56  To enable debug messages to print to the console in version 3.020 and newer, run the following commands:
57 -##sr eventlog true
58 -sr eventlog console true
59 -sr eventlog level trace##
57 +
58 +* ##sr eventlog true##
59 +* ##sr eventlog console true##
60 +* ##sr eventlog level trace##
60 60  )))
61 61  
62 62  The ##sr debug logic## command is used to enable or disable debug messages in the Text Console. Some devices are more chatty than others when it comes to the number of debug messages sent, so there are several categories of debug messages available that can be toggled independently. A list of all possible debug commands can be displayed in the text console by running the command "##sr debug logic ?##", however the most frequently used are given below: