Skip to Content
Last modified by Alexander Mott on 2025/06/13 15:26
From version 33.1
edited by Alexander Mott
on 2025/06/13 15:26
Change comment: There is no comment for this version
To version 12.1
edited by Craig Lewis
on 2021/09/22 14:51
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -CoAP ShowRunner to ShowRunnerCLC™ Setup Instructions
1 +CoAP ShowRunner to ShowRunner Setup Instructions
Parent
... ... @@ -1,1 +1,1 @@
1 -SHOWRUNNER™ Integrations Guide.Integration Options.CoAP with Crestron S# Library and Modules.WebHome
1 +SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Appendix.Integration Options.CoAP with Crestron S# Library and Modules.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
1 +XWiki.craig\.lewis@chiefintegrations\.com
Content
... ... @@ -1,89 +1,33 @@
1 -(% class="box warningmessage" id="HUseShowRunnerCLC2122version3.010orlater" %)
2 -(((
3 -Use ShowRunnerCLC™ version 3.010 or later.
4 -)))
1 +===== Host processor (LWAPI Server) Setup (DIN-AP3 @ 10.44.5.91) =====
5 5  
6 -Terminology:
7 -
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).
13 -
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 -
32 32  Steps 1-3 and 5 always needed.
33 33  
34 34  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.
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):
6 +1. Enable LWAPI In Config (@ root level):
39 39  ## "LwApiEnable": true,
40 40   "LwApiSecurityLevel": "Auth",##
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:
9 +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:
42 42  ##DIN-AP3>sradmin add api user "Central Control" "Lightweight API Users"
43 43  API User Central Control generated with Group permissions Lightweight API Users and Key: (% style="color:blue" %)**YTd2pQn7sjwiOWD9NqCIWw**(%%) Secret: (% style="color:orange" %)**OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI**(%%)##
44 -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.
12 +
13 +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 connect privileges.  Sample values shown, do not re-use these.
45 45  ##DIN-AP3>adduser -N:(% style="color:purple" %)**lwapi**(%%) -P:(% style="color:darkgoldenrod" %)**dMFN9pJJXjWLGd7t**(%%)
46 46  User account was successfully created.
47 -DIN-AP3>addusertogroup -N:lwapi -G:Users
48 -'lwapi' was successfully added to group 'Users'.##
49 -1. Save the configuration
16 +DIN-AP3>addusertogroup -N:lwapi -G:Connects
17 +'lwapi' was successfully added to group 'Connects'.##
18 +1. Save the configuration and restart ShowRunner™
50 50  
51 -=== Client processor (LWAPI Client) Setup (e.g. DIN-AP4) ===
20 +===== Client processor (LWAPI Client) Setup (DIN-AP4) =====
52 52  
53 -==== ShowRunnerCLC™ 3.011 or newer ====
54 -
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 -
57 -1. Define remote system in the config:
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 - ],##
66 -1. Add Users :
67 -if CWS User is not needed:
68 -##DIN-AP4>sr remote system auth (% style="color:darkcyan" %)**1**(%%) (% style="color:blue" %)**YTd2pQn7sjwiOWD9NqCIWw**(%%) (% style="color:orange" %)**OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI**(%%)##
69 -if CWS User is needed:
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##
72 -1. Save the configuration
73 -
74 -==== ShowRunnerCLC™ v3.010 or earlier ====
75 -
76 76  Steps 1-3 and 6 always needed.
77 77  
78 78  1. Define remote system in the config:
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 - ],##
25 +## {
26 + "SystemId": (% style="color:darkcyan" %)1(%%),
27 + "IpAddressOrHostname": "10.44.5.91",
28 + "Label": "HUB-1-1",
29 + "ConnectionType": "LWAPI"
30 + },##
87 87  1. Add remote user for LWAPI (this is the key and secret created on the host):
88 88  ##DIN-AP4>sradmin add remote user HUB-1 (% style="color:blue" %)**YTd2pQn7sjwiOWD9NqCIWw**(%%) (% style="color:orange" %)**OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI**(%%)
89 89  Remote User HUB-1 ((% style="color:green" %)//**1a920b8b-3ab8-44bd-bc7b-0fc77abf0a13**//(%%)) added with Group permissions Remote Connection##