LogoLogo
OverviewDemos and ResourcesContact
  • What is Engine?
  • Key Concepts
    • Drivers
    • Modules
    • Systems
    • Zones
    • Settings
    • Interfaces
    • Triggers
  • Security
  • Deployment
    • System Architecture
    • Single Sign-On
      • Configuring Engine for SAML2
      • SAML2 with Azure AD
      • SAML2 with ADFS
      • SAML2 with Auth0
      • SAML2 with GSuite
      • OAuth2
  • Integrations
    • Supported Integrations
    • Directory Services
      • Microsoft Office365
    • IoT
      • Device Drivers
      • Node-RED
      • Azure IOT Hub
    • Location Services
      • Locating Users on a Network
      • SVG Map Creation
      • Cisco CMX
      • Cisco Meraki RTLS
      • Desk Sensors
  • Administration
    • Backoffice
      • Systems
      • Devices
      • Drivers
      • Zones
      • Triggers
      • Metrics
      • Users
      • Domains
        • Applications
  • Developer Guide
    • Development Environment
    • Building Drivers
      • Discovery and Metadata
      • State
      • Scheduling Actions
      • Response Tokenisation
      • Device Drivers
      • SSH Drivers
      • Service Drivers
      • Logic Drivers
      • Testing
      • Live Monitoring
      • Logging
      • Security
      • Utilities and Helpers
    • User Interfaces
      • Composer
      • Virtual Systems
      • Widgets
      • Settings.json
  • API
    • Authentication
    • Control
      • Systems
      • Modules
      • Dependencies
      • Zones
      • Websocket
        • Commands
          • bind
          • unbind
          • exec
          • debug
          • ignore
        • Heartbeat
        • Errors
  • Support
    • Service Desk
Powered by GitBook
On this page

Was this helpful?

  1. API
  2. Control
  3. Websocket
  4. Commands

exec

The exec command performs an action on a module within the system. It is a remote procedure call.

{
    "id": 3,                 // tracking id
    "cmd": "exec",           // request type
    "sys": "sys-YNQ8ucvndO", // system id
    "mod": "Display",        // module name
    "index": 2,              // module index in the system
    "name": "switch_to",     // the driver function to call
    "args": ["hdmi"]         // The function arguments (if required)
}

The return value of the function is returned in the response, assuming it can be serialised into JSON.

{
    "id": 3,
    "type": "success",
    "value": ["hdmi"]
}

If an error was raised, the error message is returned.

{
    "id": 3,
    "type": "error",
    "code": 3,
    "msg": "ZeroDivisionError: divided by 0"
}
PreviousunbindNextdebug

Last updated 5 years ago

Was this helpful?