Skip to Content

Changes for page Custom Logo

Last modified by Alexander Mott on 2025/03/18 19:40
From version 8.3
edited by Alexander Mott
on 2021/12/21 22:43
Change comment: There is no comment for this version
To version 14.2
edited by Alexander Mott
on 2022/06/09 17:02
Change comment: Update document after refactoring.

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,1 @@
1 -SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Installation Guide.WebHome
1 +SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.WebHome
Hidden
... ... @@ -1,1 +1,1 @@
1 -true
1 +false
Content
... ... @@ -1,3 +1,5 @@
1 +=== Custom Logo Guidelines ===
2 +
1 1  To use a custom logo in your ShowRunner project, you should first create a custom logo per the following guidelines.
2 2  
3 3  Custom logos should have a white background and be in .png format with a resolution of 1280x800 for compatibility with the widest range of of touch screens.
... ... @@ -6,6 +6,7 @@
6 6  * TSW-1070 screens have an aspect ratio of 16:10 and a native resolution 1920x1080.
7 7  * TSW-760 screens have an aspect ratio of 17:10 and a native resolution of 1024x600.
8 8  
11 +=== Loading a Custom Logo to the Processor ===
9 9  
10 10  Once a custom logo has been created, it must be loaded to the processor (not to the touchscreen itself).
11 11  
... ... @@ -13,26 +13,30 @@
13 13  * Connect to the lighting control processor that the TSW touch screen is pointed at
14 14  * Select "Internal Flash" from the list on the left
15 15  * Select "HTML" from the list on the left
16 -* Right-click in an empty area on the and select "Copy File(s) From..."
19 +* Right-click in an empty area on the right and select "Copy File(s) From..."
17 17  * Select your custom logo .png file and load it to the processor
18 18  
19 19  [[image:1591724546339-953.png]]
20 20  
24 +=== Updating the Lighting Configuration File ===
21 21  
22 22  Once the logo has been loaded to the processor, it is necessary to update the lighting configuration file.
23 23  
24 -Change the "CustomLogoFile" in "CiLightingConfig.json" file provided by Chief Integrations.
25 -
26 -* "null" will be changed to the file name .png
27 -
28 +* First, pull the configuration file using either ShowRunner's File Management page (recommended), or pull it directly from the processor using Toolbox's File Manager tool. 
29 +** If using Toolbox's File Manager tool, the config will be located in one of two places:
30 +"NVRAM/sr/default/SrConfig.json" for ShowRunner versions 3.011 and newer
31 +"NVRAM/CiLightingConfig.json" for ShowRunner versions 3.010 and older
32 +* Open the configuration file in a text editor and the locate the "CustomLogoFile" line towards the bottom of the config:
28 28  [[image:1591724611629-257.png]]
29 -
34 +* Change the value ##null ##to the name of your custom logo file:
30 30  [[image:1591724595422-172.png]]
36 +* Save the updated configuration file
37 +* Load the updated configuration file to your processor using either ShowRunner's File Management page or using Toolbox
38 +** If using Toolbox, navigate to either:
39 +"NVRAM/sr/default" for ShowRunner versions 3.011 and newer
40 +"NVRAM" for ShowRunner versions 3.010 and older
41 +** Open Text Console and connect to the processor and type the## progreset## command and then press enter to restart the processor and finish loading the config
31 31  
32 -* Save updated config file
33 -* Open File Manager app in Toolbox
34 -* Select NVRAM folder
35 -* Right-click and Copy File(s) From...
36 -* Select "CiLightingConfig.json"
43 +=== Custom Logos on Processors with Authentication Enabled ===
37 37  
38 -
45 +If your project is running on a 3-series with authentication enabled or a 4-series with user page authentication enabled, you will need to follow [[these additional steps>>doc:SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Appendix.Resolving Custom Logo Not Loading on Touchscreens with Authentication on processor Enabled.WebHome]].