Getting Started

The following sections describe how to get started with Python on 4-Series using SIMPL or SIMPL# Pro, including basic installation and setup procedures.

Prerequisites and Assumptions

Crestron has the following prerequisites and assumptions for individuals using Python on 4-Series:

  • Intermediate or higher understanding of Crestron control systems, including how to program them using SIMPL or SIMPL# Pro.
  • Intermediate or higher understanding of programming with Python on other platforms.

Python scripts that are to be used on a Crestron control system are not created with software tools like SIMPL or the SIMPL+® Editor, but rather are created with widely available third-party software tools like PyCharm or Visual Studio Code.

System Requirements

The following must be installed onto your control system prior to programming with Python. All files can be downloaded from www.crestron.com/Support/Resource‑Library unless specified otherwise.

  • 4-Series firmware version 2.7000.0031 (or greater)
  • Include4.dat file version 2.17.073 (or greater)

The following must be installed onto your workstation if programming with SIMPL.

  • SIMPL version 4.1700.03.01 (or greater)
  • Crestron Database version 208.00.001.00 (or greater)
  • Device Database version 200.120.003.00 (or greater)
  • SIMPL+ Editor
    • SimplPlusPythonAdapter.clz file

      • NOTE: This file is currently supplied via the Crestron Database to be used as a CRESTRON_SIMPLSHARP_LIBRARY.

The following must be installed if programming with SIMPL# Pro.

  • SIMPL# Pro
    • NuGet Package version 2.17.73 (or greater)

Setup

To ensure that your Python script runs on your control system, a crestron_main entry point must be specified in your Python script.

  • The sample SIMPL Python script defines this entry point on line 7. Refer to the following image from the sample program.

  • The sample SIMPL# Pro Python script defines this entry point on line 71. Refer to the following image from the sample program.