Create a SIMPL Module

A SIMPL module is a SIMPL program that interacts with the control system by sending and receiving signals and is represented by a symbol in Crestron Studio®. A unit of programming that exposes its interface via a SIMPL or SIMPL+ symbol, and itself contains an internal program. You can import and use ready-made SIMPL modules, modify existing SIMPL modules or create brand new ones.

You can create a new SIMPL module right from the Start Page or by following the instructions below.

1. Create a new SIMPL module
   
   A dialog indicating that your module is created appears briefly and Program Designer opens in a new tab of Crestron Studio®

   To create a new SIMPL module:

   1. Go to the File menu and click New
      
      -or-
      
      Press .

   2. Click on a project type and choose a User SIMPL Module in the New Project Dialog.
      
      
      

   3. The Name field is pre-populated with a generic name Module, followed by a numeral. If desired, you can click in the Name field and write a custom name for your SIMPL Module. Note that the fully qualified SIMPL Module name has to be less than 250 characters long and cannot contain the following characters: <, >, ~, |, /, \, ?, *, :, ".
      

   4. Press New.

2. Edit the Module Properties

3. Open the Argument Definition in a Symbol Editor and expand the symbol to add the required number of inputs, outputs and parameters. Press to add one input, output or parameter or press to add multiple inputs, outputs or parameters.

4. Define the signal cues.

   To name the inputs and outputs click each signal to highlight it and type the name in the signal field.

   The signal NAMES you type become the signal CUES of the module's symbol.

   • For clarity it is best to arrange the signals by type: digitals, analogs, and serials.

   • Signal cues can consist of letters, numbers or characters, except the comma character (,) and colon character (:). Additionally, signal cues cannot begin with a number.

   You can create a visual space between signal cues by using the special signal name [~UNUSED~].

   Although the [~UNUSED~] qualifier results in a blank space or a gap between the signals in the module's symbol, there is technically still a signal associated with that gap.

5. Define the parameters.

   To define a parameter

   Name the parameter field in the Argument Definition.

   Create a reference to the parameter field by defining a parameter in the associated logic symbol; prefix the parameter name with the pound character (no space between the pound character and the first letter of the parameter name).

   The pound character signifies that the parameter name is a placeholder for the actual parameter value the user will enter when they use the module in a program. (It is not recommended to use the pound character itself as part of the parameter name, as this will lead to unexpected results.)

   The parameter name is case-sensitive; if the case does not match, the parameter substitution will not work.

6. Set optional properties, for example default values or status bar hints, for signals and parameters.

7. Program the logic

   1. Add the required logic symbols or modules to Logic Explorer.
   2. Define the signals and parameters and connect them to their driving sources and destinations.
   3. Connect the signals and parameters in the logic symbols to the associated inputs, outputs and parameters of the Argument Definition.
   4. Any signals that will reference the signal cues in the Argument Definition must have the same signal name as the signal cue defined in the Argument Definition.
   5. Input signals on logic symbols must be connected to the input side of the Argument Definition; outputs must be connected to the output side.
   6. Parameters that reference the parameter fields in the Argument Definition must have the same parameter name, preceded by the pound (#) character. The parameter names are case sensitive—see Define Parameters. For example, if the Argument Definition has a parameter field called Ramp Time, then the logic symbol should have a parameter named #Ramp Time (no space between the pound character and the first letter of the parameter name).
   7. Once you connect an input or output in the Argument Definition to signals in the module, the signal color will change from green (ambiguous) to the color representing the signal type: blue (digital), red (analog) or black (serial).

8. Save your module

   To save any changes to your newly created SIMPL Module:

   1. Go to the File menu and click Save your_module_name
      
      -or-
      
      Press .
      
      -or-
      
      Select Save As... on the File menu and type a new module name in the Save As... dialog:
      
      
      

More:

User Module Properties

Importing User Modules in Crestron Studio®