Changes for page Custom Logo

Last modified by Alexander Mott on 2025/03/18 19:40

From version 8.2
edited by Alexander Mott
on 2021/12/21 22:32
Change comment: There is no comment for this version
To version 12.1
edited by Alexander Mott
on 2021/12/22 17:37
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,38 +1,45 @@
1 -To use a custom logo in your ShowRunner project, you must first create a custom logo.
1 +=== Custom Logo Guidelines ===
2 2  
3 -Logos should be in .png format and have a resolution of 1280x800 for compatibility with the widest range of of touch screens.
3 +To use a custom logo in your ShowRunner project, you should first create a custom logo per the following guidelines.
4 4  
5 +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 +
5 5  * TSW-770 and TSW-1060 screens have an aspect ratio of 16:10 and a native resolution of 1280x800.
6 6  * TSW-1070 screens have an aspect ratio of 16:10 and a native resolution 1920x1080.
7 -* TSW-760 screens have an aspect ratio of 17:10 and a native resolution of 1024x600. If a logo
9 +* TSW-760 screens have an aspect ratio of 17:10 and a native resolution of 1024x600.
8 8  
9 -Most touch screens have an aspect ratio of 16x10. A 1280x800 resolution image will work natively for TSW-1060 and TSW-770 screens, and will be scaled up for TSW-1070 screens. TSW-760 has a resolution of 1024x600 and an aspect ratio of
11 +=== Loading a Custom Logo to the Processor ===
10 10  
13 +Once a custom logo has been created, it must be loaded to the processor (not to the touchscreen itself).
11 11  
12 -(% id="cke_bm_176S" style="display:none" %) (%%)png file will be saved to the main HTML folder
15 +* Start Crestron Toolbox and open the File Manager tool
16 +* Connect to the lighting control processor that the TSW touch screen is pointed at
17 +* Select "Internal Flash" from the list on the left
18 +* Select "HTML" from the list on the left
19 +* Right-click in an empty area on the right and select "Copy File(s) From..."
20 +* Select your custom logo .png file and load it to the processor
13 13  
14 -* 1280x800 png file with white background
15 -* Open File Manager app in Toolbox
16 -* Select Internal Flash
17 -* Select HTML folder
18 -* Right-click and Copy File(s) From...
19 -* Select png file
20 -
21 21  [[image:1591724546339-953.png]]
22 22  
24 +=== Updating the Lighting Configuration File ===
23 23  
24 -Change the "CustomLogoFile" in "CiLightingConfig.json" file provided by Chief Integrations.
26 +Once the logo has been loaded to the processor, it is necessary to update the lighting configuration file.
25 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]].