Skip to Content
Last modified by Alexander Mott on 2023/07/07 15:17
From version 20.1
edited by Mark Kohlmann
on 2021/10/27 02:00
Change comment: There is no comment for this version
To version 27.1
edited by Alexander Mott
on 2022/10/06 21:04
Change comment: There is no comment for this version

Summary

Details

Page properties
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.mark\.kohlmann@chiefintegrations\.com
1 +XWiki.alexander\.mott@chiefintegrations\.com
Content
... ... @@ -1,15 +1,38 @@
1 1  ===== Use ShowRunner version 3.010 or later =====
2 2  
3 +Terminology:
3 3  
4 -===== Host processor (LWAPI Server) Setup (DIN-AP3 @ 10.44.5.91) =====
5 +* Client Processor - Processor that will interact with hardware attached to the host procesor.
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).
5 5  
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 +
24 +===== Host processor (LWAPI Server) Setup (e.g. DIN-AP3 @ 10.44.5.91) =====
25 +
6 6  Steps 1-3 and 5 always needed.
7 7  
8 8  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.
9 -1. Enable LWAPI In Config (@ root level):
29 +1. Enable LWAPI
30 +From Console (v 3.011 or later):
31 +## sr lwapi enable true##
32 +In Config (@ root level):
10 10  ## "LwApiEnable": true,
11 11   "LwApiSecurityLevel": "Auth",##
12 -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:
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:
13 13  ##DIN-AP3>sradmin add api user "Central Control" "Lightweight API Users"
14 14  API User Central Control generated with Group permissions Lightweight API Users and Key: (% style="color:blue" %)**YTd2pQn7sjwiOWD9NqCIWw**(%%) Secret: (% style="color:orange" %)**OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI**(%%)##
15 15  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.
... ... @@ -19,9 +19,9 @@
19 19  'lwapi' was successfully added to group 'Users'.##
20 20  1. Save the configuration
21 21  
22 -===== Client processor (LWAPI Client) Setup (DIN-AP4) Version 3.011 or newer =====
45 +===== Client processor (LWAPI Client) Setup (e.g. DIN-AP4) Version 3.011 or newer =====
23 23  
24 -Steps 1-3 and 6 always needed.
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).
25 25  
26 26  1. Define remote system in the config:
27 27  ## {
... ... @@ -38,7 +38,7 @@
38 38  Success##
39 39  1. Save the configuration
40 40  
41 -===== Client processor (LWAPI Client) Setup (DIN-AP4) Version 3.010 or earlier =====
64 +===== Client processor (LWAPI Client) Setup (e.g. DIN-AP4) Version 3.010 or earlier =====
42 42  
43 43  Steps 1-3 and 6 always needed.
44 44