Crestron Components Lib - Showcase App

ch5-select: methods and feedbackMode = 'submit'

Emulator Scenario (click to expand)
    {
  "cues": [
    {
      "type": "number",
      "event": "volume_select",
      "trigger": "&change",
      "actions": [
        {
          "state": "volume_selected",
          "type": "number",
          "logic": "link"
        }
      ]
    },
    {
      "type": "boolean",
      "event": "volume_select_1_on_click",
      "trigger": true,
      "actions": [
        {
          "state": "volume_selected_after_click",
          "type": "number",
          "logic": "set",
          "value": 1
        }
      ]
    },
    {
      "type": "boolean",
      "event": "volume_select_2_on_click",
      "trigger": true,
      "actions": [
        {
          "state": "volume_selected_after_click",
          "type": "number",
          "logic": "set",
          "value": 2
        }
      ]
    },
    {
      "type": "boolean",
      "event": "volume_select_3_on_click",
      "trigger": true,
      "actions": [
        {
          "state": "volume_selected_after_click",
          "type": "number",
          "logic": "set",
          "value": 3
        }
      ]
    },
    {
      "type": "boolean",
      "event": "volume_select_4_on_click",
      "trigger": true,
      "actions": [
        {
          "state": "volume_selected_after_click",
          "type": "number",
          "logic": "set",
          "value": 4
        }
      ]
    },
    {
      "type": "boolean",
      "event": "item_0_on_click",
      "trigger": true,
      "actions": [
        {
          "state": "item_0_selected",
          "type": "boolean",
          "trigger": true,
          "logic": "toggle"
        }
      ]
    },
    {
      "type": "boolean",
      "event": "item_1_on_click",
      "trigger": true,
      "actions": [
        {
          "state": "item_1_selected",
          "type": "boolean",
          "trigger": true,
          "logic": "toggle"
        }
      ]
    },
    {
      "type": "boolean",
      "event": "item_2_on_click",
      "trigger": true,
      "actions": [
        {
          "state": "item_2_selected",
          "type": "boolean",
          "trigger": true,
          "logic": "toggle"
        }
      ]
    },
    {
      "type": "boolean",
      "event": "item_3_on_click",
      "trigger": true,
      "actions": [
        {
          "state": "item_3_selected",
          "type": "boolean",
          "trigger": true,
          "logic": "toggle"
        }
      ]
    },
    {
      "type": "boolean",
      "event": "item_4_on_click",
      "trigger": true,
      "actions": [
        {
          "state": "item_4_selected",
          "type": "boolean",
          "trigger": true,
          "logic": "toggle"
        }
      ]
    },
    {
      "type": "boolean",
      "event": "multi_select_opt_0_on_click",
      "trigger": true,
      "actions": [
        {
          "state": "multi_select_opt_0_selected",
          "type": "boolean",
          "trigger": true,
          "logic": "toggle"
        }
      ]
    },
    {
      "type": "boolean",
      "event": "multi_select_opt_1_on_click",
      "trigger": true,
      "actions": [
        {
          "state": "multi_select_opt_1_selected",
          "type": "boolean",
          "trigger": true,
          "logic": "toggle"
        }
      ]
    },
    {
      "type": "boolean",
      "event": "multi_select_opt_2_on_click",
      "trigger": true,
      "actions": [
        {
          "state": "multi_select_opt_2_selected",
          "type": "boolean",
          "trigger": true,
          "logic": "toggle"
        }
      ]
    },
    {
      "type": "boolean",
      "event": "multi_select_opt_3_on_click",
      "trigger": true,
      "actions": []
    },
    {
      "type": "boolean",
      "event": "multi_select_opt_4_on_click",
      "trigger": true,
      "actions": [
        {
          "state": "multi_select_opt_4_selected",
          "type": "boolean",
          "trigger": true,
          "logic": "toggle"
        }
      ]
    }

  ],
  "onStart": [
    {
      "type": "b",
      "state": "item_0_selected",
      "value": false
    },
    {
      "type": "b",
      "state": "item_1_selected",
      "value": false
    },
    {
      "type": "b",
      "state": "item_2_selected",
      "value": false
    },
    {
      "type": "b",
      "state": "item_3_selected",
      "value": false
    },
    {
      "type": "b",
      "state": "item_4_selected",
      "value": false
    },
    {
      "type": "b",
      "state": "multi_select_opt_1_selected",
      "value": false
    },
    {
      "type": "b",
      "state": "multi_select_opt_2_selected",
      "value": false
    },
    {
      "type": "b",
      "state": "multi_select_opt_3_selected",
      "value": false
    },
    {
      "type": "b",
      "state": "multi_select_opt_4_selected",
      "value": false
    },
    {
      "type": "string",
      "state": "label_signal_0",
      "logic": "set",
      "value": "Option 0"
    },
    {
      "type": "string",
      "state": "label_signal_1",
      "logic": "set",
      "value": "Option 1"
    },
    {
      "type": "string",
      "state": "label_signal_2",
      "logic": "set",
      "value": "Option 2"
    },
    {
      "type": "string",
      "state": "label_signal_3",
      "logic": "set",
      "value": "Option 3"
    },
    {
      "type": "string",
      "state": "label_signal_4",
      "logic": "set",
      "value": "Option 4"
    }
  ]
}

Press the Load button to load the scenario.

Press the Run button to run the scenario. You only need to do this if the scenario (the json) has an onStart key.

The Emulator Scenario JSON contains an array of cues and an optional array onStart A cue is defined by: type:string, signal:string, trigger:boolean|string|number, actions:array. An action is defined by: type:string, signal:string, logic:string ... plus other fields ( depending on type)

type for cue or for action can be the string:

  • b or boolean - for a boolean signal
  • n or number or numeric - for a number signal
  • s or string - for a string signal
  • o or object - for an object signal

signal for cue or for action is a string representing the name of the signal:

trigger can be either a fixed value of the same type as the signal, or the string "&change". If it is a fixed value then, when the emulator detects that the signal has changed to the value given in trigger then it also executes the actions for that signal. If the value is the string "&change", regardless of signal type, then the actions are executed on any change in the value of the signal.

logic can be:

  • link - passes the value received on the incoming join through to the outgoing join. Using this between incompatible join types will attempt to cast the value. In the event of a cast failure the value will be set to false, 0 or "" (empty string)
  • set - assigns a specific value to the join. This requires a 5th key of 'value' and the specific value to assign. ie. {"signal":"light_level", "type":"n", "logic": "set","value":5}. If the 5th key is omitted, the default value will be sent (false, 0, "" or {})
  • toggle - (boolean Only) reads the current state and changes it to the opposite state
  • pulse - (boolean Only) value goes high and then low.
  • increment - (Numeric Only) reads the current value of the analog and adds an offset. This logic accepts an optional 5th key of 'offset which determines how many to incrementby. ie. {"signal":"volume_level","type":"n", "logic":"increment","offset":5}. If this 5th key is omitted, the default offset of 1 will be applied.
  • decrement - (Numeric Only) reads the current value of the analog and subtracts an offset. This logic accepts an optional 5th key of 'offset which determines how many to decrement by. ie. {"signal":"volume_level","type":"n", "logic":"decrement","offset":5}. If this 5th key is omitted, the default offset of 1 will be applied.

RCB logic can be accomplished by defining an action containing an object signal of RCB type:
{ "rcb":{ "value": numeric_value, "time": duration_in_ms } }
Scenario example:


    {
      "cues": [
        {
          "type": "boolean",
          "signal": "trigger",
          "trigger": true,
          "actions": [
            {
              "signal": "action1",
              "type": "boolean",
              "logic": "toggle"
            },
            {
                "signal": "rcb_signal",
                "type": "object",
                "logic": "set",
                "value": {
                    "rcb":{
                        "value": 101,
                        "time": 1500
                    }
                }
            }
          ]
        }
      ],
      "onStart": [
      ]
    }
    

Component Configuration (click to expand)
{
  "templatevariables": {
    "id": {
      "volume1": [
          {"label":"Down", "fa-icon": "volume-down"},
          {"label":"Up", "fa-icon": "volume-up"},
          {"label":"Mute", "fa-icon": "volume-off"},
          {"label":"Speaker", "fa-icon": "phone-volume"}
        ],
      "volume2": [
          {"label":"Down", "fa-icon": "volume-down"},
          {"label":"Up", "fa-icon": "volume-up"},
          {"label":"Mute", "fa-icon": "volume-off"},
          {"label":"Speaker", "fa-icon": "phone-volume"}
        ],
      "multiselect_ex": [
          {"label":"Option 0"},
          {"label":"Option 1"},
          {"label":"Option 2"},
          {"label":"option 3"},
          {"label":"option 4"}
        ]
    }
  }
}

Press the Load button to load the configuration.

Ch5 components can be preconfigured with default values for attributes and for templatevariables. The configuration can be done using Ch5Config and its methods:

  • loadConfig(config:TCh5Config) loads a new configuration and overrides the existing one.
  • setAttributeForId(elementId:string, attributeName:string, attributeValue:string) sets an attributeValue for an attributeName of the specified HTML elementId
  • setAttributeForComponent(componentName:string, attributeName:string, attributeValue:string) sets an attributeValue for an attributeName of the specified ch5 component (componentName)
  • setTemplateVarsForId(elementId:string, tempVarsItems:any[]) sets the template variables for the ch5 component having the specified elementId
  • getConfig() returns the current configuration object
  • getAttributesForId(elementId:string):TCh5ConfigAttributes returns the configrued attributes for the component having the specified elementId
  • getAttributesForComponent(componentName:string):TCh5ConfigAttributes returns all configured attributes for the component specified in componentName ( for example 'ch5-button')
  • getTemplateVarsForElementById(elementId:string):TCh5ConfigTemplateVars[] returns the configured template variables for the component having the specified elementId
  • getAttributesForElement(cr:Ch5Common):TCh5ConfigAttributes returns all configured attributes for a ch5 component
  • getTemplateVarsForElement(cr:Ch5Common):TCh5ConfigTemplateVars[] returns all configured templatevariables for a ch5 component


type TCh5ConfigAttributes={
    [attrName:string]: string
}
type TCh5ConfigTemplateVars={
    [varName:string]: string
}
type TCh5Config={
    "attributes": {
        "id": {
            [id:string]:TCh5ConfigAttributes
        },
        "component": {
            [component:string]:TCh5ConfigAttributes
        }
    },
    "templatevariables": {
        "id": {
            [id:string]:TCh5ConfigTemplateVars[]
        }
    }
}

ch5-select: Methods

  • - submit()
  • - reset()
  • - getDirty()
  • - getValue()
  • - setValue(). This method will always set clean values (dirty is automatically set to false)

feedbackMode = 'submit' is required for submit, reset and getDirty methods

In this mode, the signal defined by sendEventOnChange attribute, and ch5- select-option.sendEventOnClick attribute will not be sent until the submit() method is called and the signal will only be sent if the visual state of the component is different than that of the actual state of the component.

feedbackMode = 'direct' is default value used in all the other examples from showcase app

Example 1: using sendEventOnChange & receiveStateValue

Dirty:
Selected:

Example 2: using ch5-select-option.sendEventOnClick & receiveStateValue

Dirty:
Selected:

Example 3: using ch5-select-option.sendEventOnClick & ch5-select-option.receiveStateSelected

Dirty:
Selected:

Example 3 multiselect, ch5-select-option.sendEventOnClick & ch5-select-option.receiveStateSelected

Note: Option 3 select/unselect will never be confirmed by receiveStateSelected.

Dirty:
Selected:

<div class="row">
    <p><strong>Example 1: </strong> using sendEventOnChange & receiveStateValue</p>
    
        <ch5-select id="volume1"
                     size="5" indexId="Idx"
                     sendEventOnChange="volume_select"
                     receiveStateValue="volume_selected"
                     feedbackMode="submit"
                     noneSelectedPrompt="Select">
             <template>
                <ch5-select-option>
                    <i class="fas fa-{{fa-icon}}"></i>
                    <span>{{label}}</span>
                </ch5-select-option>
             </template>
        </ch5-select>
    
    <p style="margin-top: 24px;">
        Dirty: <span id="dirty-select-1"></span><br>
        Selected: <span id="selected-1"></span><br>
        <ch5-button id="submit-btn-1" label="Submit"></ch5-button>
        <ch5-button id="reset-btn-1" label="Reset"></ch5-button>
        <ch5-button id="set-btn-1" label="Set value: 3"></ch5-button>
    </p>
</div>

<div class="row">
    <p><strong>Example 2: </strong> using ch5-select-option.sendEventOnClick & receiveStateValue</p>
    
        <ch5-select id="volume2"
                     size="5" indexId="Idx"
                     receiveStateValue="volume_selected_after_click"
                     feedbackMode="submit"
                     noneSelectedPrompt="Select"
                     mode="panel">
             <template>
                <ch5-select-option sendEventOnClick="volume_select_{{Idx}}_on_click">
                    <i class="fas fa-{{fa-icon}}"></i>
                    <span>{{label}}</span>
                </ch5-select-option>
             </template>
        </ch5-select>
    
    <p style="margin-top: 24px;">
        Dirty: <span id="dirty-select-2"></span><br>
        Selected: <span id="selected-2"></span><br>
        <ch5-button id="submit-btn-2" label="Submit"></ch5-button>
        <ch5-button id="reset-btn-2" label="Reset"></ch5-button>
        <ch5-button id="set-btn-2" label="Set value: 2"></ch5-button>
    </p>
</div>

<div class="row">
    <p><strong>Example 3: </strong> using ch5-select-option.sendEventOnClick & ch5-select-option.receiveStateSelected</p>
    
        <ch5-select id="selectWithReceiveSignalSelected" size="4" indexId="Idx"
            mode="panel" feedbackMode="submit" noneSelectedPrompt="Select">
            <template>
                <ch5-select-option sendEventOnClick="item_{{Idx}}_on_click"
                                    receiveStateSelected="item_{{Idx}}_selected">
                    <span>Item {{Idx}}</span>
                </ch5-select-option>
            </template>
        </ch5-select>
    
    <p style="margin-top: 24px;">
        Dirty: <span id="dirty-select-3"></span><br>
        Selected: <span id="selected-3"></span><br>
        <ch5-button id="submit-btn-3" label="Submit"></ch5-button>
        <ch5-button id="reset-btn-3" label="Reset"></ch5-button>
        <ch5-button id="set-btn-3" label="Set value: 4"></ch5-button>
    </p>
</div>

<div class="row">
    <p><strong>Example 3 </strong> multiselect, ch5-select-option.sendEventOnClick & ch5-select-option.receiveStateSelected</p>
    <p>
        <strong>Note:</strong> Option 3 select/unselect will never be confirmed by receiveStateSelected.
    </p>
    
    <ch5-select id="multiselect_ex" size="5" indexId="Idx"
        multiselect mode="panel" feedbackMode="submit" noneSelectedPrompt="Select">
        <template>
            <ch5-select-option receiveStateSelected="multi_select_opt_{{Idx}}_selected"
                                sendEventOnClick="multi_select_opt_{{Idx}}_on_click"
                                receiveStateLabel="label_signal_{{Idx}}">
                <span>{{label}}</span>
            </ch5-select-option>
        </template>
    </ch5-select>
    
    <p style="margin-top: 24px;">
        Dirty: <span id="dirty-select-4"></span><br>
        Selected: <span id="selected-4"></span>
        <ch5-button id="update-selection" label="Refresh"></ch5-button><br>
    </p>
    <p style="margin-top: 24px;">
        <ch5-button id="submit-btn-4" label="Submit"></ch5-button>
        <ch5-button id="reset-btn-4" label="Reset"></ch5-button>
        <ch5-button id="set-btn-4" label="Set value: [ 2, 4]"></ch5-button>
    </p>
</div>