Module Properties

After a new user module is created, you should configure its properties such as module category, scope, encryption used, etc.

Properties set at the module level are used in Crestron Studio®, for the purposes of:

• Documentation

• Proper display of the module in Crestron Studio®

• Programming the module

• Obtaining info for proper automatic program generation

• Use in connectivity and programming commands

To set/edit user module properties:

1. Create/Open a new user SIMPL/SIMPL+ module

2. Access the Module Properties dialog by selecting Project in the main Crestron Studio® toolbar and clicking Properties.
   
   
   
   

3. Module Properties dialog opens:
   
   
   

The Module Properties dialog comprises of 4 sections listed in the pane on the left:

• General

  

  • Location - Indicates if the module is a central or project specific module. Note that this property cannot be changed in the Module Properties Dialog.

  • Initialization method - Select this option to replace all instances of the signal name "//" with 0s (zeros) at compile time. If the option is not checked, the signal name "//" will be replaced with reserved signal names, which can result in using more memory than necessary. Replacing instances of "//" with 0s removes the reserved signals from the program and saves memory.

  • Module Encryption - click this check box to denote that the module will be password protected. Encrypted modules can be used by others in their programs without need to supply the password. However, they will not be able to open and edit the module without the password.

  • Encryption Password - specify a password for your module. A password can contain any combination of letters, numerals, spaces, and symbols, and it can be up to 16 characters long. The password is case sensitive. Note that in order to type in this text field the Module Encryption check box above has to be selected.

  • Last Opened - Indicates the last date and time when the module was opened.

  • Last Saved - Indicates the last date and time when the module was saved.

  • Created On - Indicates the date and time when the module was created.

  • Version - specifies the module version (not implemented at this time)

  • Character Encoding - Specifies if the character encoding for the module represents ASCII or Unicode characters. Note that if any of the choices for the Control System Series includes a 2-Series System, the only available option for Character Encoding will be ASCII.
    
    For 3 -Series Systems available options are:

  • • ASCII - Uses ASCII as the encoding method. ASCII encoding is traditionally used for characters based on the English alphabet.

    • UTF-16 (Unicode Encoding) - (Available only if 3-Series control system series is selected) Uses UTF-16 as the encoding method. All characters in the Basic Multilingual Plane (includes Latin characters and symbols, Greek and Cyrillic letters, Chinese, Japanese and Korean ideographs) saved in double-byte format are supported.

    • Inherit Program - Specifies that the module will use the character encoding set in the program. If the module is embedded in another module, the other module's encoding settings are ignored.

    • Inherit Parent (default)- Specifies that the module will use the character encoding set by it's parent.
      For example, if the module is incorporated in the program, it uses the program’s settings, and allows for a chain of modules in a program to use the program’s setting.
      If the module is incorporated into another module, it uses that module's settings.

  • Description -Type a short description of the module's purpose, which will be displayed in the Description field of the Start Page.

  • Control System Series - Choose the type of control system(s) the module can run on. This determines which symbols will be available when programming the module. Note that the module MUST be compatible with all selected control system series. If you don't specify a control system series the module must work on ANY Crestron control system (some 2-Series logic symbols may not be available)

  • Symbol Library Category - Choose a category from a list of Symbol Library Categories. The module will be saved in this subfolder, under the User category of the Symbol Library.

• Customer Information – Fill in customer specific information (the information in this section is the same as the information specified in the Project Properties)

  

  Fill in customer specific information (the information in this section is the same as the information specified in the Project Properties).

• Dealer Information - Fill in any relevant dealer specific information

  

  Fill in any relevant dealer specific information.

• Help

  

   

  Help File: If you've generated documentation for the module in PDF format, you can specify the name of the PDF file to be used with the module. To locate the help file type the PDF filename in the text field, or click Browse.

  When the module is selected and you press F1, the supplied PDF file will open.

  Notes: As an alternative to a PDF file, you can document the module by entering plain text in the Notes field. When the user selects the module and presses F1, the help information will be displayed in a help viewer.

  IMPORTANT: If you supply PDF help file and plain text help (either entered in the Notes filed or specified in the Help block of a SIMPL+ modules), Crestron Studio® will ignore the plain help text and will use the PDF file.

  For SIMPL+ modules text entered in the Help block takes precedence over text supplied in the Notes filed.

  The order in which Crestron Studio® will look for help is as follows:

  1. PDF help

  2. text supplied in the Help block (SIMPL+ modules only)

  3. text entered in the Notes filed

  To ensure that the module will be useful and that you remember its functionality it's always a good idea to document your module as completely as possible, as this will also make it easier for others to test and use the module in their programs.