Setup

To set up the Crestron Template Project programming environment:

NOTE: As of the CH5 2.0 release, the Crestron template project will no longer be provided as a zipped file package. The ch5-shell-cli create:project commands must be used instead as described in the following procedure.

  1. Install the required software components:
    1. Install the CH5 development tools as described in Install CH5 Developer Tools.
    2. Install the Contract Editor software (if using) as described in Contract Editor.
  2. Open Visual Studio Code.
  3. Open a new terminal window (Terminal > New Terminal).
  4. Issue the one of the following commands depending on the desired project creation method: 
    • Issue ch5-shell-cli create:project --projectName "[projectname]" to create a new template project using the default project configuration JSON file, where [projectname] is the desired project name.
    • Issue ch5-shell-cli create:project --config [./directory/sample-config.json] to create a new template project using a custom project configuration JSON file, where [./directory/sample-config.json] is the directory and file name of the desired JSON file.
    • Issue ch5-shell-cli create:project --projectName "[projectname]" --projectType "zoomroomcontrol" to create a new Crestron Control for Zoom Rooms® Software project using the standard project template.
  5. Open the template directory in Visual Studio Code.
  6. Issue the npm install command. This command will copy libraries used by the project onto your workstation and into the ./node_modules directory.

A new Crestron Template Project created using the projectName argument will have one empty page. A new Crestron Template Project created using a custom configuration JSON file will create pages based on the instructions in the configuration file.

Additional setup is required if using the HTML5 Web XPanel functionality to deploy template projects. Fore more information, refer to Control System Configuration and Add or Remove HTML5 Web XPanel Support.