Crestron Components Lib - Showcase App

Utility function subscribeStateScript

Emulator Scenario (click to expand) (click to collapse)
{
  "cues": [
    {
      "type": "b",
      "event": "trig1",
      "trigger": true,
      "actions": [
        {
          "state": "city",
          "type": "string",
          "logic": "set",
          "value": "Las Vegas"
        }
      ]
    },
    {
      "type": "b",
      "event": "trig2",
      "trigger": true,
      "actions": [
        {
          "state": "city",
          "type": "string",
          "logic": "set",
          "value": "New York"
        }
      ]
    },
    {
      "type": "b",
      "event": "trig3",
      "trigger": true,
      "actions": [
        {
          "state": "sig_n",
          "type": "n",
          "logic": "decrement",
          "offset": 3
        }
      ]
    },
    {
      "type": "b",
      "event": "trig4",
      "trigger": true,
      "actions": [
        {
          "state": "sig_n",
          "type": "n",
          "logic": "increment",
          "offset": 5
        }
      ]
    }

  ],
  "onStart": [
    {
      "type": "s",
      "state": "city",
      "value": "Hong Kong"
    },
    {
      "type": "n",
      "state": "sig_n",
      "value": 0
    }
  ]
}
Emulator actions

Press the Load button to load the scenario. This will also reload all of the existing examples on the page.

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

Events and states

The Emulator Scenario JSON contains an array of cues and an optional array onStart.

→ A cue is defined by: type:string, event:string, trigger:boolean|string|number, actions:array
→ An action is defined by: type:string, state:string, logic:string ... plus other fields ( depending on type)

The value of the state or event for a cue or for an action is a string which represents the name of that state or action.

Type field

The type for cue or for action can be the string:

  • b or boolean - for a boolean state or event
  • n or number or numeric - for a number state or event
  • s or string - for a string state or event
  • o or object - for an object state or event
Trigger field

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

Logic Field

The 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. {"state":"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 times to increment by. ie. {"event":"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 times to decrement by. ie. {"event":"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 state or event of RCB type. A 5th key is expected as the amount of time in milliseconds to reach the level. {"signal":"light_level", "type":"n", "logic": "rcb","value":65535, "time":2000}
    { "rcb":{ "value": numeric_value, "time": duration_in_ms } }
Scenario example:

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

Utility function: subscribeStateScript

subscribeStateScript(signalScript:string, callback:Function, default:string):string

signalScript is a string containing JS code. It can contain tokens in the form {{ signalType.signalName }}, where signalType can be b(for boolean), s(for string), and n(for number), and signalName is the name of the signal. These tokens will be replaced with the corresponding signal value.

callback is a function that receives one parameter (the updated and parsed signalScript). It is called each time one of the signals (from the signalScript tokens) changes

default if present, it is the default value returned if there are signals that have not been initialized.

See the JS tab for the code and browser console for messages

Click this button to change the value of the sig_string signal to "Las Vegas"

Click this button to change the value of the sig_string signal to "New York"

Click this button to decrement the value of the sig_n with 3

Click this button to increment the value of the sig_n signal by 5

The red bordered element contains the value of the subscribeStateScript function for the following template string "\" City: {{s.city}}; Number: {{ n.sig_n}}; Number*3: \"+{{ n.sig_n }}*3 " {#You will need to change both sig_n and sig_string in order for the value to change from the default one.#}

<p>See the JS tab for the code and browser console for messages</p>

<p>
    Click this button to change the value of the <b>sig_string</b> signal to "Las Vegas"
    <ch5-button label="Btn1" sendEventOnClick="trig1"></ch5-button>
</p>
<p>
    Click this button to change the value of the <b>sig_string</b> signal to "New York"
    <ch5-button label="Btn2" sendEventOnClick="trig2"></ch5-button>
</p>
<p>
    Click this button to decrement the value of the <b>sig_n</b> with 3
    <ch5-button label="Btn3" sendEventOnClick="trig3"></ch5-button>
</p>
<p>
    Click this button to increment the value of the <b>sig_n</b> signal by 5
    <ch5-button label="Btn4" sendEventOnClick="trig4"></ch5-button>
</p>

<p>
    The red bordered element contains the value of the subscribeStateScript function for the following template string
    <code>"\" City: {{s.city}}; Number: {{ n.sig_n}}; Number*3: \"+{{ n.sig_n }}*3 "</code>
    {#You will need to change both <b>sig_n</b> and <b>sig_string</b> in order for the value to change from the default one.#}
</p>

<div id="updated-element"></div>