Skip to Content
Last modified by Alexander Mott on 2025/06/13 15:26
From version 27.1
edited by Alexander Mott
on 2022/10/06 21:04
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
Content
... ... @@ -1,8 +1,11 @@
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  
3 3  Terminology:
4 4  
5 -* Client Processor - Processor that will interact with hardware attached to the host procesor.
8 +* Client Processor - Processor that will interact with hardware attached to the host processor.
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)
... ... @@ -20,16 +20,19 @@
20 20  11. Define the remote system
21 21  11. Setup auth for the remote system
22 22  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##
23 23  
24 -===== Host processor (LWAPI Server) Setup (e.g. DIN-AP3 @ 10.44.5.91) =====
30 +=== Host processor (LWAPI Server) Setup (e.g. DIN-AP3 @ 10.44.5.91) ===
25 25  
26 26  Steps 1-3 and 5 always needed.
27 27  
28 28  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.
29 29  1. Enable LWAPI
30 -From Console (v 3.011 or later):
36 +From Console (v 3.011 or later; processor will automatically restart):
31 31  ## sr lwapi enable true##
32 -In Config (@ root level):
38 +In Config (@ root level; reloading the configuration is required):
33 33  ## "LwApiEnable": true,
34 34   "LwApiSecurityLevel": "Auth",##
35 35  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:
... ... @@ -42,17 +42,21 @@
42 42  'lwapi' was successfully added to group 'Users'.##
43 43  1. Save the configuration
44 44  
45 -===== Client processor (LWAPI Client) Setup (e.g. DIN-AP4) Version 3.011 or newer =====
51 +=== Client processor (LWAPI Client) Setup (e.g. DIN-AP4) ===
46 46  
53 +==== ShowRunnerCLC™ 3.011 or newer ====
54 +
47 47  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).
48 48  
49 49  1. Define remote system in the config:
50 -## {
51 - "SystemId": (% style="color:darkcyan" %)1(%%),
52 - "IpAddressOrHostname": "10.44.5.91",
53 - "Label": "HUB-1-1",
54 - "ConnectionType": "LWAPI"
55 - },##
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 + ],##
56 56  1. Add Users :
57 57  if CWS User is not needed:
58 58  ##DIN-AP4>sr remote system auth (% style="color:darkcyan" %)**1**(%%) (% style="color:blue" %)**YTd2pQn7sjwiOWD9NqCIWw**(%%) (% style="color:orange" %)**OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI**(%%)##
... ... @@ -61,17 +61,19 @@
61 61  Success##
62 62  1. Save the configuration
63 63  
64 -===== Client processor (LWAPI Client) Setup (e.g. DIN-AP4) Version 3.010 or earlier =====
74 +==== ShowRunnerCLC™ v3.010 or earlier ====
65 65  
66 66  Steps 1-3 and 6 always needed.
67 67  
68 68  1. Define remote system in the config:
69 -## {
70 - "SystemId": (% style="color:darkcyan" %)1(%%),
71 - "IpAddressOrHostname": "10.44.5.91",
72 - "Label": "HUB-1-1",
73 - "ConnectionType": "LWAPI"
74 - },##
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 + ],##
75 75  1. Add remote user for LWAPI (this is the key and secret created on the host):
76 76  ##DIN-AP4>sradmin add remote user HUB-1 (% style="color:blue" %)**YTd2pQn7sjwiOWD9NqCIWw**(%%) (% style="color:orange" %)**OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI**(%%)
77 77  Remote User HUB-1 ((% style="color:green" %)//**1a920b8b-3ab8-44bd-bc7b-0fc77abf0a13**//(%%)) added with Group permissions Remote Connection##