Skip to Content
Last modified by Alexander Mott on 2023/07/07 15:17
From version 21.1
edited by Mark Kohlmann
on 2021/10/27 02:21
Change comment: There is no comment for this version
To version 17.1
edited by Craig Lewis
on 2021/10/26 17:43
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.mark\.kohlmann@chiefintegrations\.com
1 +XWiki.craig\.lewis@chiefintegrations\.com
Content
... ... @@ -1,48 +1,27 @@
1 -===== Use ShowRunner version 3.010 or later =====
1 +===== __**Us [[NEWEST >>https://files.chiefintegrations.com/index.php/s/WHNzXrrZbB5jC3E]]version of showrunner.**__ =====
2 2  
3 -Terminology:
3 +===== =====
4 4  
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).
10 -
11 -Steps:
12 -
13 -1. [[Setup Host Processor>>||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>>||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 24  ===== Host processor (LWAPI Server) Setup (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 -1. Enable LWAPI
30 -From Console (v 3.011 or later):
31 -## sr lwapi enable true##
32 -In Config (@ root level):
10 +1. Enable LWAPI In Config (@ root level):
33 33  ## "LwApiEnable": true,
34 34   "LwApiSecurityLevel": "Auth",##
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 +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:
36 36  ##DIN-AP3>sradmin add api user "Central Control" "Lightweight API Users"
37 37  API User Central Control generated with Group permissions Lightweight API Users and Key: (% style="color:blue" %)**YTd2pQn7sjwiOWD9NqCIWw**(%%) Secret: (% style="color:orange" %)**OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI**(%%)##
38 -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.
16 +
17 +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.
39 39  ##DIN-AP3>adduser -N:(% style="color:purple" %)**lwapi**(%%) -P:(% style="color:darkgoldenrod" %)**dMFN9pJJXjWLGd7t**(%%)
40 40  User account was successfully created.
41 -DIN-AP3>addusertogroup -N:lwapi -G:Users
42 -'lwapi' was successfully added to group 'Users'.##
20 +DIN-AP3>addusertogroup -N:lwapi -G:Connects
21 +'lwapi' was successfully added to group 'Connects'.##
43 43  1. Save the configuration
44 44  
45 -===== Client processor (LWAPI Client) Setup (DIN-AP4) Version 3.011 or newer =====
24 +===== Client processor (LWAPI Client) Setup (DIN-AP4) =====
46 46  
47 47  Steps 1-3 and 6 always needed.
48 48  
... ... @@ -53,25 +53,6 @@
53 53   "Label": "HUB-1-1",
54 54   "ConnectionType": "LWAPI"
55 55   },##
56 -1. Add Users :
57 -if CWS User is not needed:
58 -##DIN-AP4>sr remote system auth (% style="color:darkcyan" %)**1**(%%) (% style="color:blue" %)**YTd2pQn7sjwiOWD9NqCIWw**(%%) (% style="color:orange" %)**OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI**(%%)##
59 -if CWS User is needed:
60 -##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(%%)**
61 -Success##
62 -1. Save the configuration
63 -
64 -===== Client processor (LWAPI Client) Setup (DIN-AP4) Version 3.010 or earlier =====
65 -
66 -Steps 1-3 and 6 always needed.
67 -
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 - },##
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##