Skip to Content

CoAP ShowRunner to ShowRunner Setup Instructions

Version 17.1 by Craig Lewis on 2021/10/26 17:43
Us NEWEST version of showrunner.
Host processor (LWAPI Server) Setup (DIN-AP3 @ 10.44.5.91)

Steps 1-3 and 5 always needed.

  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.
  2. Enable LWAPI In Config (@ root level):
      "LwApiEnable": true,
      "LwApiSecurityLevel": "Auth",
  3. 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:
    DIN-AP3>sradmin add api user "Central Control" "Lightweight API Users"
    API User Central Control generated with Group permissions Lightweight API Users and Key: YTd2pQn7sjwiOWD9NqCIWw Secret: OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI
     
  4. 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.
    DIN-AP3>adduser -N:lwapi -P:dMFN9pJJXjWLGd7t
    User account was successfully created.
    DIN-AP3>addusertogroup -N:lwapi -G:Connects
    'lwapi' was successfully added to group 'Connects'.
  5. Save the configuration
Client processor (LWAPI Client) Setup (DIN-AP4)

Steps 1-3 and 6 always needed.

  1. Define remote system in the config:
        {
          "SystemId": 1,
          "IpAddressOrHostname": "10.44.5.91",
          "Label": "HUB-1-1",
          "ConnectionType": "LWAPI"
        },
  2. Add remote user for LWAPI (this is the key and secret created on the host):
    DIN-AP4>sradmin add remote user HUB-1 YTd2pQn7sjwiOWD9NqCIWw OeiQEFo_-EDfc7sQe_qRpeQzSkZjylV2roa76utpJLI
    Remote User HUB-1 (1a920b8b-3ab8-44bd-bc7b-0fc77abf0a13) added with Group permissions Remote Connection
  3. Assign users to the remote connection, System ID in this example is 1.  API user is to authenticate with the API.  CWS user is to authenticate with the Crestron Web Server before authenticating with the ShowRunner REST API:
    DIN-AP4>sradmin assign remote user API 1 1a920b8b-3ab8-44bd-bc7b-0fc77abf0a13
    User HUB-1 assigned to remote system 1:HUB-1-1 for API Authorization
     
  4. 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.
    DIN-AP4>sradmin add remote user HUB-1_CWS lwapi dMFN9pJJXjWLGd7t
    Remote User HUB-1_CWS (d7c88ecb-7212-4e8b-8749-ddca759c6a62) added with Group permissions Remote Connectio
  5. If Necessary:
    DIN-AP4>sradmin assign remote user CWS 1 d7c88ecb-7212-4e8b-8749-ddca759c6a62
    User HUB-1_CWS assigned to remote system 1:HUB-1-1 for API Authorization
  6. Save the configuration and restart ShowRunner™