2022.2 EN DE

    Show / Hide Table of Contents

    Room Control Settings

    Description

    Room Control allows X-Creator to send commands to defined destinations. You can create Direct Controls for manually triggering commands or Presets which can be saved and loaded with Slides. Both will be available in the X-Creator Sidebar.

    Environment Configuration

    Presets

    Category Name
    The name of the category the presets are grouped by

    Presets
    The commands for this preset category

    • Command Type The protocol used to send this command (REST, TCP, UDP)
    • Name The name of the command
    • Content Content to be sent in the request
    • Method Method used to send the REST command (GET, PUT, POST, DELETE) (only visible when command type is REST)
    • URL The URL of the REST command (only visible when command type is REST)
    • Content Type Type of content to be sent in REST command (text/plain, JSON) (only when visible command type is REST)
    • Authorization No Auth when the REST command should be sent without authorization or Bearer Token to send it with authorization (only visible when command type is REST)
    • Token Bearer Token for the authorization of the REST command (only visible when command type is REST and Authorization is Bearer Token)
    • Server IP IP address of the device the command is send to (only when visible command type is TCP or UDP)
    • PortPort of the device the command is send to (only when visible command type is TCP or UDP)

    Direct Controls

    Method
    Method used to send the REST command (GET, PUT, POST, DELETE)

    Name
    The name of the control

    Icon
    The icon to use for the control. If Custom Icon is selected the name of an icon from this site can be entered: https://fonts.google.com/icons?selected=Material+Icons

    Content
    Content to be sent in body of request

    URL (only visible when command type is REST)
    The URL to send for the control

    Content Type (only visible when command type is REST)
    Type of content to be sent in REST command (text/plain, JSON)

    Authorization (only visible when command type is REST)
    No Auth when the REST command should be sent without authorization or Bearer Token to send it with authorization

    Token (only visible when command type is REST and Authorization is Bearer Token)
    Bearer Token for the authorization of the REST command

    Server IP
    IP address of the device the command is send to (only when visible command type is TCP or UDP)

    Port
    Port of the device the command is send to (only when visible command type is TCP or UDP)

    X-Creator Configuration

    The number of Direct Controls that are directly added to the X-Creator Sidebar can be configured in the X-Creator Sidebar settings.

    Samples

    Send a GET HTTP request to IP 192.168.0.1, port 9696 and route scene1: http://192.168.0.1:9696/scene1

    
    ☀
    ☾
    Back to top
    Generated by DocFX
    ☀
    ☾