Skip to Content
Last modified by Alexander Mott on 2023/07/07 15:17
From version 14.1
edited by Craig Lewis
on 2021/10/26 17:39
Change comment: There is no comment for this version
To version 32.1
edited by Alexander Mott
on 2023/07/07 15:17
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.craig\.lewis@chiefintegrations\.com
1 +XWiki.alexander\.mott@chiefintegrations\.com
Content
... ... @@ -1,39 +1,84 @@
1 -(% class="wikigeneratedid" %)
2 -===== __**Use showrunner version 3.010 or newer.**__ =====
1 +===== Use ShowRunnerCLC™ version 3.010 or later =====
3 3  
4 -(% class="wikigeneratedid" %)
5 -===== =====
3 +Terminology:
6 6  
7 -===== Host processor (LWAPI Server) Setup (DIN-AP3 @ 10.44.5.91) =====
5 +* Client Processor - Processor that will interact with hardware attached to the host processor.
6 +* CWS - Crestron Web Server, the processor's internal web server
7 +* Host Processor (Server) - Processor that hosts the physical hardware
8 +* LWAPI - Lightweight API (CoAP)
9 +* 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).
8 8  
11 +Steps:
12 +
13 +1. [[Setup Host Processor>>WebHome||anchor="Host processor (LWAPI Server) Setup (DIN-AP3 @ 10.44.5.91)"]]
14 +11. Verify processor configuration
15 +11. Verify LWAPI is enabled
16 +11. Create API User
17 +11. Create CWS User (if necessary)
18 +11. Save the configuration
19 +1. [[Setup Client Processor>>WebHome||anchor="Client processor (LWAPI Client) Setup (DIN-AP4) Version 3.011 or newer"]]
20 +11. Define the remote system
21 +11. Setup auth for the remote system
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 +
27 +===== Host processor (LWAPI Server) Setup (e.g. DIN-AP3 @ 10.44.5.91) =====
28 +
9 9  Steps 1-3 and 5 always needed.
10 10  
11 11  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.
12 -1. Enable LWAPI In Config (@ root level):
32 +1. Enable LWAPI
33 +From Console (v 3.011 or later; processor will automatically restart):
34 +## sr lwapi enable true##
35 +In Config (@ root level; reloading the configuration is required):
13 13  ## "LwApiEnable": true,
14 14   "LwApiSecurityLevel": "Auth",##
15 -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:
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:
16 16  ##DIN-AP3>sradmin add api user "Central Control" "Lightweight API Users"
17 17  API User Central Control generated with Group permissions Lightweight API Users and Key: (% style="color:blue" %)**YTd2pQn7sjwiOWD9NqCIWw**(%%) Secret: (% style="color:orange" %)**OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI**(%%)##
18 -
19 -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.
41 +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.
20 20  ##DIN-AP3>adduser -N:(% style="color:purple" %)**lwapi**(%%) -P:(% style="color:darkgoldenrod" %)**dMFN9pJJXjWLGd7t**(%%)
21 21  User account was successfully created.
22 -DIN-AP3>addusertogroup -N:lwapi -G:Connects
23 -'lwapi' was successfully added to group 'Connects'.##
44 +DIN-AP3>addusertogroup -N:lwapi -G:Users
45 +'lwapi' was successfully added to group 'Users'.##
24 24  1. Save the configuration
25 25  
26 -===== Client processor (LWAPI Client) Setup (DIN-AP4) =====
48 +===== Client processor (LWAPI Client) Setup (e.g. DIN-AP4) Version 3.011 or newer =====
27 27  
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).
51 +
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 + ],##
61 +1. Add Users :
62 +if CWS User is not needed:
63 +##DIN-AP4>sr remote system auth (% style="color:darkcyan" %)**1**(%%) (% style="color:blue" %)**YTd2pQn7sjwiOWD9NqCIWw**(%%) (% style="color:orange" %)**OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI**(%%)##
64 +if CWS User is needed:
65 +##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(%%)**
66 +Success##
67 +1. Save the configuration
68 +
69 +===== Client processor (LWAPI Client) Setup (e.g. DIN-AP4) Version 3.010 or earlier =====
70 +
28 28  Steps 1-3 and 6 always needed.
29 29  
30 30  1. Define remote system in the config:
31 -## {
32 - "SystemId": (% style="color:darkcyan" %)1(%%),
33 - "IpAddressOrHostname": "10.44.5.91",
34 - "Label": "HUB-1-1",
35 - "ConnectionType": "LWAPI"
36 - },##
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 + ],##
37 37  1. Add remote user for LWAPI (this is the key and secret created on the host):
38 38  ##DIN-AP4>sradmin add remote user HUB-1 (% style="color:blue" %)**YTd2pQn7sjwiOWD9NqCIWw**(%%) (% style="color:orange" %)**OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI**(%%)
39 39  Remote User HUB-1 ((% style="color:green" %)//**1a920b8b-3ab8-44bd-bc7b-0fc77abf0a13**//(%%)) added with Group permissions Remote Connection##