Skip to Content
Last modified by Alexander Mott on 2023/07/07 15:17
From version 32.1
edited by Alexander Mott
on 2023/07/07 15:17
Change comment: There is no comment for this version
To version 22.2
edited by Scott Kohlmann
on 2021/12/08 21:05
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -CoAP ShowRunner to ShowRunnerCLC™ Setup Instructions
1 +CoAP ShowRunner to ShowRunner Setup Instructions
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
1 +XWiki.scott\.kohlmann@chiefintegrations\.com
Content
... ... @@ -1,8 +1,8 @@
1 -===== Use ShowRunnerCLC™ version 3.010 or later =====
1 +===== Use ShowRunner version 3.010 or later =====
2 2  
3 3  Terminology:
4 4  
5 -* Client Processor - Processor that will interact with hardware attached to the host processor.
5 +* Client Processor - Processor that will interact with hardware attached to the host procesor.
6 6  * CWS - Crestron Web Server, the processor's internal web server
7 7  * Host Processor (Server) - Processor that hosts the physical hardware
8 8  * LWAPI - Lightweight API (CoAP)
... ... @@ -10,29 +10,26 @@
10 10  
11 11  Steps:
12 12  
13 -1. [[Setup Host Processor>>WebHome||anchor="Host processor (LWAPI Server) Setup (DIN-AP3 @ 10.44.5.91)"]]
13 +1. [[Setup Host Processor>>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Appendix.Integration Options.CoAP with Crestron S# Library and Modules.CoAP ShowRunner to ShowRunner Setup Instructions.WebHome||anchor="Host processor (LWAPI Server) Setup (DIN-AP3 @ 10.44.5.91)"]]
14 14  11. Verify processor configuration
15 15  11. Verify LWAPI is enabled
16 16  11. Create API User
17 17  11. Create CWS User (if necessary)
18 18  11. Save the configuration
19 -1. [[Setup Client Processor>>WebHome||anchor="Client processor (LWAPI Client) Setup (DIN-AP4) Version 3.011 or newer"]]
19 +1. [[Setup Client Processor>>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Appendix.Integration Options.CoAP with Crestron S# Library and Modules.CoAP ShowRunner to ShowRunner Setup Instructions.WebHome||anchor="Client processor (LWAPI Client) Setup (DIN-AP4) Version 3.011 or newer"]]
20 20  11. Define the remote system
21 21  11. Setup auth for the remote system
22 22  11. Save the configuration
23 -1. Verify successful communications with the following commands:
24 -11. On host, verify the client shows up as a web session: ##sr sh lwapi serv cli##
25 -11. On client, verify the session with the host: ##sr sh lwapi cli br##
26 26  
27 -===== Host processor (LWAPI Server) Setup (e.g. DIN-AP3 @ 10.44.5.91) =====
24 +===== Host processor (LWAPI Server) Setup (DIN-AP3 @ 10.44.5.91) =====
28 28  
29 29  Steps 1-3 and 5 always needed.
30 30  
31 31  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.
32 32  1. Enable LWAPI
33 -From Console (v 3.011 or later; processor will automatically restart):
30 +From Console (v 3.011 or later):
34 34  ## sr lwapi enable true##
35 -In Config (@ root level; reloading the configuration is required):
32 +In Config (@ root level):
36 36  ## "LwApiEnable": true,
37 37   "LwApiSecurityLevel": "Auth",##
38 38  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:
... ... @@ -45,19 +45,17 @@
45 45  'lwapi' was successfully added to group 'Users'.##
46 46  1. Save the configuration
47 47  
48 -===== Client processor (LWAPI Client) Setup (e.g. DIN-AP4) Version 3.011 or newer =====
45 +===== Client processor (LWAPI Client) Setup (DIN-AP4) Version 3.011 or newer =====
49 49  
50 -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).
47 +Steps 1-3 and 6 always needed.
51 51  
52 52  1. Define remote system in the config:
53 -## "RemoteSystems": [
54 - {
55 - "SystemId": (% style="color:darkcyan" %)1(%%),
56 - "IpAddressOrHostname": "10.44.5.91",
57 - "Label": "HUB-1-1",
58 - "ConnectionType": "LWAPI"
59 - },
60 - ],##
50 +## {
51 + "SystemId": (% style="color:darkcyan" %)1(%%),
52 + "IpAddressOrHostname": "10.44.5.91",
53 + "Label": "HUB-1-1",
54 + "ConnectionType": "LWAPI"
55 + },##
61 61  1. Add Users :
62 62  if CWS User is not needed:
63 63  ##DIN-AP4>sr remote system auth (% style="color:darkcyan" %)**1**(%%) (% style="color:blue" %)**YTd2pQn7sjwiOWD9NqCIWw**(%%) (% style="color:orange" %)**OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI**(%%)##
... ... @@ -66,19 +66,17 @@
66 66  Success##
67 67  1. Save the configuration
68 68  
69 -===== Client processor (LWAPI Client) Setup (e.g. DIN-AP4) Version 3.010 or earlier =====
64 +===== Client processor (LWAPI Client) Setup (DIN-AP4) Version 3.010 or earlier =====
70 70  
71 71  Steps 1-3 and 6 always needed.
72 72  
73 73  1. Define remote system in the config:
74 -## "RemoteSystems": [
75 - {
76 - "SystemId": (% style="color:darkcyan" %)1(%%),
77 - "IpAddressOrHostname": "10.44.5.91",
78 - "Label": "HUB-1-1",
79 - "ConnectionType": "LWAPI"
80 - },
81 - ],##
69 +## {
70 + "SystemId": (% style="color:darkcyan" %)1(%%),
71 + "IpAddressOrHostname": "10.44.5.91",
72 + "Label": "HUB-1-1",
73 + "ConnectionType": "LWAPI"
74 + },##
82 82  1. Add remote user for LWAPI (this is the key and secret created on the host):
83 83  ##DIN-AP4>sradmin add remote user HUB-1 (% style="color:blue" %)**YTd2pQn7sjwiOWD9NqCIWw**(%%) (% style="color:orange" %)**OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI**(%%)
84 84  Remote User HUB-1 ((% style="color:green" %)//**1a920b8b-3ab8-44bd-bc7b-0fc77abf0a13**//(%%)) added with Group permissions Remote Connection##