Crestron Components Lib - Showcase App

ch5-form: custom submit/cancel, using the emulator to keep the submitted value

Emulator Scenario (click to expand) (click to collapse)
{
  "cues": [
    {
      "type": "boolean",
      "event": "form.toggle_event",
      "trigger": true,
      "actions": [
        {
          "state": "form.toggle_state",
          "type": "boolean",
          "logic": "toggle"
        }
      ]
    },
    {
      "type": "string",
      "event": "form.text_event",
      "trigger": "&change",
      "actions": [
        {
          "state": "form.text_state",
          "type": "s",
          "logic": "link"
        }
      ]
    },
    {
      "type": "n",
      "event": "form.number_event",
      "trigger": "&change",
      "actions": [
        {
          "state": "form.number_state",
          "type": "n",
          "logic": "link"
        }
      ]
    }
  ]
}
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": [
      ]
    }
    

ch5-forms with ch5-elements controllable from outside the forms

No Form

Same events are used in all examples, changing the value of the toggle, slider of textinput here will reflect everywhere.





text value: ''

Form with supplied buttons

Only after submitting the form will the new values of the toggle, slider or textinput will be reflected.





text value: ''

Form without supplied buttons

Same as the previous example, but custom buttons are used, which use a similar style to the default ch5-form buttons.





text value: ''
<div>
    <h2>No Form</h2>
    <p>Same events are used in all examples, changing the value of the toggle, slider of textinput here will reflect
        everywhere.</p>

    <ch5-toggle
            labelOn="On"
            labelOff="Off"
            receiveStateValue="form.toggle_state"
            sendEventOnClick="form.toggle_event">
    </ch5-toggle>

    <br><br>

    <ch5-slider
            receiveStateValue="form.number_state"
            sendEventOnChange="form.number_event">
    </ch5-slider>

    <br><br>

    <ch5-textinput
            receiveStateValue="form.text_state"
            sendEventOnChange="form.text_event"></ch5-textinput>
    <h5>text value: '<span data-ch5-textcontent="form.text_state"></span>'</h5>

</div>

<hr>

<div>

    <ch5-form
            submitbuttonlabel="Submit"
            submitbuttonicon="fa fa-play"
            submitbuttontype="success"
            submitbuttonstyle="border: 1px solid blue"
            cancelbuttonlabel="Cancel"
            cancelbuttonicon="fa fa-times"
            cancelbuttontype="danger"
            cancelbuttonstyle="border: 1px solid red">

        <h2>Form with supplied buttons</h2>
        <p>Only after submitting the form will the new values of the toggle, slider or textinput will be reflected.</p>
        <ch5-toggle feedbackmode="submit"
                    labelOn="On"
                    labelOff="Off"
                    receiveStateValue="form.toggle_state"
                    sendEventOnClick="form.toggle_event">
        </ch5-toggle>

        <br><br>

        <ch5-slider feedbackmode="submit"
                    receiveStateValue="form.number_state"
                    sendEventOnChange="form.number_event">
        </ch5-slider>

        <br><br>

        <ch5-textinput feedbackmode="submit"
                       receiveStateValue="form.text_state"
                       sendEventOnChange="form.text_event"></ch5-textinput>
        <h5>text value: '<span data-ch5-textcontent="form.text_state"></span>'</h5>
    </ch5-form>
</div>

<hr>


<div>

    <ch5-form
            hidesubmitbutton="true"
            hidecancelbutton="true"
            submitId="externalFormSubmit"
            cancelId="externalFormCancel">

        <h2>Form without supplied buttons</h2>
        <p>Same as the previous example, but custom buttons are used, which use a similar style to the default ch5-form
            buttons.</p>
        <ch5-toggle feedbackmode="submit"
                    labelOn="On"
                    labelOff="Off"
                    receiveStateValue="form.toggle_state"
                    sendEventOnClick="form.toggle_event">
        </ch5-toggle>

        <br><br>

        <ch5-slider feedbackmode="submit"
                    receiveStateValue="form.number_state"
                    sendEventOnChange="form.number_event">
        </ch5-slider>

        <br><br>

        <ch5-textinput feedbackmode="submit"
                       receiveStateValue="form.text_state"
                       sendEventOnChange="form.text_event"></ch5-textinput>
        <h5>text value: '<span data-ch5-textcontent="form.text_state"></span>'</h5>
    </ch5-form>

    <ch5-button
            id="externalFormSubmit"
            label="Submit"
            iconclass="fa fa-play"
            type="success">
    </ch5-button>
    <ch5-button
            id="externalFormCancel"
            label="Cancel"
            iconclass="fa fa-times"
            type="danger">
    </ch5-button>

</div>