Skip to Content
Last modified by Alexander Mott on 2023/07/07 15:17
From version 25.1
edited by Alexander Mott
on 2022/05/23 12:04
Change comment: There is no comment for this version
To version 31.1
edited by Scott Kohlmann
on 2023/04/20 21:34
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
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
1 +XWiki.scott\.kohlmann@chiefintegrations\.com
Content
... ... @@ -1,8 +1,8 @@
1 -===== Use ShowRunner version 3.010 or later =====
1 +===== Use ShowRunnerCLC™ 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 procesor.
5 +* 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,6 +20,9 @@
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##
23 23  
24 24  ===== Host processor (LWAPI Server) Setup (e.g. DIN-AP3 @ 10.44.5.91) =====
25 25  
... ... @@ -27,9 +27,9 @@
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):
33 +From Console (v 3.011 or later; processor will automatically restart):
31 31  ## sr lwapi enable true##
32 -In Config (@ root level):
35 +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:
... ... @@ -44,7 +44,7 @@
44 44  
45 45  ===== Client processor (LWAPI Client) Setup (e.g. DIN-AP4) Version 3.011 or newer =====
46 46  
47 -Steps 1-3 always needed.
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).
48 48  
49 49  1. Define remote system in the config:
50 50  ## {