Skip to Content
Last modified by Alexander Mott on 2025/06/13 15:26
From version 18.1
edited by Mark Kohlmann
on 2021/10/27 02:00
Change comment: There is no comment for this version
To version 33.1
edited by Alexander Mott
on 2025/06/13 15:26
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -CoAP ShowRunner to ShowRunner Setup Instructions
1 +CoAP ShowRunner to ShowRunnerCLC™ Setup Instructions
Parent
... ... @@ -1,1 +1,1 @@
1 -SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Appendix.Integration Options.CoAP with Crestron S# Library and Modules.WebHome
1 +SHOWRUNNER™ Integrations Guide.Integration Options.CoAP with Crestron S# Library and Modules.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.mark\.kohlmann@chiefintegrations\.com
1 +XWiki.alexander\.mott@chiefintegrations\.com
Content
... ... @@ -1,15 +1,44 @@
1 -===== Use ShowRunner version 3.010 or later =====
1 +(% class="box warningmessage" id="HUseShowRunnerCLC2122version3.010orlater" %)
2 +(((
3 +Use ShowRunnerCLC™ version 3.010 or later.
4 +)))
2 2  
6 +Terminology:
3 3  
4 -===== Host processor (LWAPI Server) Setup (DIN-AP3 @ 10.44.5.91) =====
8 +* Client Processor - Processor that will interact with hardware attached to the host processor.
9 +* CWS - Crestron Web Server, the processor's internal web server
10 +* Host Processor (Server) - Processor that hosts the physical hardware
11 +* LWAPI - Lightweight API (CoAP)
12 +* User Page Auth - Requires a username and password to access the internal web server (CWS) on the processor.  3-series always has this enabled if authentication is activated.  4-series processors have an option to have user page auth on or not (default is off).
5 5  
14 +Steps:
15 +
16 +1. [[Setup Host Processor>>WebHome||anchor="Host processor (LWAPI Server) Setup (DIN-AP3 @ 10.44.5.91)"]]
17 +11. Verify processor configuration
18 +11. Verify LWAPI is enabled
19 +11. Create API User
20 +11. Create CWS User (if necessary)
21 +11. Save the configuration
22 +1. [[Setup Client Processor>>WebHome||anchor="Client processor (LWAPI Client) Setup (DIN-AP4) Version 3.011 or newer"]]
23 +11. Define the remote system
24 +11. Setup auth for the remote system
25 +11. Save the configuration
26 +1. Verify successful communications with the following commands:
27 +11. On host, verify the client shows up as a web session: ##sr sh lwapi serv cli##
28 +11. On client, verify the session with the host: ##sr sh lwapi cli br##
29 +
30 +=== Host processor (LWAPI Server) Setup (e.g. DIN-AP3 @ 10.44.5.91) ===
31 +
6 6  Steps 1-3 and 5 always needed.
7 7  
8 8  1. If 3-series, Enable Authentication [##authentication on##] or SSL [##ssl self##] if not already enabled.  4-Series have authentication enabled by default.  User Page Auth should be turned off on 4-series.
9 -1. Enable LWAPI In Config (@ root level):
35 +1. Enable LWAPI
36 +From Console (v 3.011 or later; processor will automatically restart):
37 +## sr lwapi enable true##
38 +In Config (@ root level; reloading the configuration is required):
10 10  ## "LwApiEnable": true,
11 11   "LwApiSecurityLevel": "Auth",##
12 -1. Create an API User and record the Key and Secret.  User group must have //LWAPI //role and //Execute //permissions.  //Lightweight API Users// group has been created for this purpose:
41 +1. Create an API User and record the Key and Secret.  User group must have //LWAPI //role and //Execute //permissions.  This allows the  //Lightweight API Users// group has been created for this purpose:
13 13  ##DIN-AP3>sradmin add api user "Central Control" "Lightweight API Users"
14 14  API User Central Control generated with Group permissions Lightweight API Users and Key: (% style="color:blue" %)**YTd2pQn7sjwiOWD9NqCIWw**(%%) Secret: (% style="color:orange" %)**OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI**(%%)##
15 15  1. If 3-series w/ auth enabled or 4-series with user page auth enabled then add a remote user with permissions to connect to the control system.  This is done by adding a local user to the system with user privileges.  Sample values shown, do not re-use these.
... ... @@ -19,36 +19,42 @@
19 19  'lwapi' was successfully added to group 'Users'.##
20 20  1. Save the configuration
21 21  
22 -===== Client processor (LWAPI Client) Setup (DIN-AP4) Version 3.011 or newer =====
51 +=== Client processor (LWAPI Client) Setup (e.g. DIN-AP4) ===
23 23  
24 -Steps 1-3 and 6 always needed.
53 +==== ShowRunnerCLC™ 3.011 or newer ====
25 25  
55 +Steps 1-3 always needed. **Note:** host and client processors must be able to communicate with each other to use this method (i.e. the network must be configured and both processors must have SHOWRUNNER™ program and configuration loaded).
56 +
26 26  1. Define remote system in the config:
27 -## {
28 - "SystemId": (% style="color:darkcyan" %)1(%%),
29 - "IpAddressOrHostname": "10.44.5.91",
30 - "Label": "HUB-1-1",
31 - "ConnectionType": "LWAPI"
32 - },##
58 +## "RemoteSystems": [
59 + {
60 + "SystemId": (% style="color:darkcyan" %)1(%%),
61 + "IpAddressOrHostname": "10.44.5.91",
62 + "Label": "HUB-1-1",
63 + "ConnectionType": "LWAPI"
64 + },
65 + ],##
33 33  1. Add Users :
34 34  if CWS User is not needed:
35 35  ##DIN-AP4>sr remote system auth (% style="color:darkcyan" %)**1**(%%) (% style="color:blue" %)**YTd2pQn7sjwiOWD9NqCIWw**(%%) (% style="color:orange" %)**OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI**(%%)##
36 36  if CWS User is needed:
37 -##DIN-AP4>sr remote system auth (% style="color:darkcyan" %)**1**(%%) (% style="color:blue" %)**YTd2pQn7sjwiOWD9NqCIWw**(%%) (% style="color:orange" %)**OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI **(% style="color:purple" %)**lwapi**(%%)** (% style="color:darkgoldenrod" %)dMFN9pJJXjWLGd7t(%%)
38 -Success**##
70 +##DIN-AP4>sr remote system auth (% style="color:darkcyan" %)**1**(%%) (% style="color:blue" %)**YTd2pQn7sjwiOWD9NqCIWw**(%%) (% style="color:orange" %)**OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI **(% style="color:purple" %)**lwapi**(%%)** (% style="color:darkgoldenrod" %)dMFN9pJJXjWLGd7t(%%)**
71 +Success##
39 39  1. Save the configuration
40 40  
41 -===== Client processor (LWAPI Client) Setup (DIN-AP4) Version 3.010 or earlier =====
74 +==== ShowRunnerCLC™ v3.010 or earlier ====
42 42  
43 43  Steps 1-3 and 6 always needed.
44 44  
45 45  1. Define remote system in the config:
46 -## {
47 - "SystemId": (% style="color:darkcyan" %)1(%%),
48 - "IpAddressOrHostname": "10.44.5.91",
49 - "Label": "HUB-1-1",
50 - "ConnectionType": "LWAPI"
51 - },##
79 +## "RemoteSystems": [
80 + {
81 + "SystemId": (% style="color:darkcyan" %)1(%%),
82 + "IpAddressOrHostname": "10.44.5.91",
83 + "Label": "HUB-1-1",
84 + "ConnectionType": "LWAPI"
85 + },
86 + ],##
52 52  1. Add remote user for LWAPI (this is the key and secret created on the host):
53 53  ##DIN-AP4>sradmin add remote user HUB-1 (% style="color:blue" %)**YTd2pQn7sjwiOWD9NqCIWw**(%%) (% style="color:orange" %)**OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI**(%%)
54 54  Remote User HUB-1 ((% style="color:green" %)//**1a920b8b-3ab8-44bd-bc7b-0fc77abf0a13**//(%%)) added with Group permissions Remote Connection##