nomos system Controller API 0.3.20

This is the documentation of the nomos system AG Controller API. There are two communication protocols available:

Sorting

A lot of API functions are supporting sort order definitions. For Example:

socket.emit('getEvents', {sortBy: ['name', 'created']}, function(result) {
  // Result sorted by name and created Timestamp
  console.debug(result);
});
socket.emit('getEvents', {sortBy: ['-created', 'name']}, function(result) {
  // Result sorted by created Timestamp ('-' means reverse sort order) and name
  console.debug(result);
});

Servers

  • ws://{host}:{port}/api/v1wssocket.io API

    Example #1

    function socketInitialization() {
  socket.emit('init', {uagent: navigator.userAgent, language: 'en'}, function() {
    // ready
  });
}
var socket = io('http://{host}:{port}/api/v1');
socket.on('connect', function() {
  // TODO: Show authentication dialog or fetch credentials
  var username = 'USERNAME';
  var password = 'PASSWORD';
  socket.emit('auth', {username: username, password: password, persistent: false}, function(auth) {
    if(auth.sessionID) {
      // successful
      socketInitialization();
    }
    else {
      // not successful
    }
  });
});

    Example #2

    var socket = io('http://{host}:{port}/api/v1', {
  query: {
    'x-nomos-sid': 'SESSION-ID'
  }
});
socket.on('connect', function() {
  socket.emit('init', {uagent: navigator.userAgent, language: 'en'}, function() {
    // ready
  });
});
    object
    host
    required
    string

    Hostname or IP address

    port
    required
    string

    Secure connection (TLS) is available through port 443.

    Default value:"80"
      Allowed values:
    • "80"
    • "443"
    Security:
    • User/Password

      Use auth function to authenticate on the API with user credentials.

    • HTTP API key
      • Name: x-nomos-sid
      • In: query

      Provide your session id and skip the username and password.

  • http://{host}:{port}/api/v1/{function}httphttp REST API

    Example #1

    curl --header "auth-username: USERNAME" --header "auth-password: PASSWORD" --header "auth-persistent: false" --header "accept-language: en" http://{host}:{port}/api/v1/getVersion

    Example #2

    curl --header "x-nomos-sid: 1234567890123456789012345678901234567890" --header "accept-language: en" http://{host}:{port}/api/v1/getVersion
    object
    host
    required
    string

    Hostname or IP address

    port
    required
    string

    Secure connection (TLS) is available through port 443.

    Default value:"80"
      Allowed values:
    • "80"
    • "443"
    function
    required
    string

    Function/Operation Name

    Security:
    • User/Password

      Provide user credentials auth-username and auth-password in HTTP header to authenticate on the API.

    • HTTP API key
      • Name: x-nomos-sid
      • In: header

      Provide your session id and skip the username and password.

    object

Operations

  • EMIT Upload-Addon-Profile

    SocketIOFileUpload Upload Addon (.csv, .json) Profile File with the Help of SocketIOFileUpload Library (see SocketIOFileUpload for more Information)
    (Version 0.2.19 | admin User Permission needed)

    Operation IDUpload-Addon-Profile

    Available only on servers:

    • #Addons

    Accepts the following message:

    Message IDUpload-Addon-ProfilePayload

    Payload: Upload Addon (.csv, .json) Profile File with the Help of SocketIOFileUpload Library (see SocketIOFileUpload for more Information)

    object

    Examples

    • #1 Example
      var uploader = new SocketIOFileUpload(socket);
uploader.listenOnInput(document.getElementById("addonUploadInput"));
uploader.maxFileSize = 2000000;
uploader.addEventListener('error', function(data) {
    if(data.code === 1) {
        console.log("File size error");
    }
});
uploader.addEventListener('progress', function(event) {
    console.log(parseInt(event.bytesLoaded / event.file.size * 100) + '%');
});
uploader.addEventListener('complete', function(event) {
    if(event.detail.error === false) {
        // Success
        window.location.reload();
    } else {
        // Error
    }
});
uploader.addEventListener('start', function(event) {
    event.file.meta.type = 'addonprofile';
});
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: Upload-Addon-Profile

  • EMIT addAddonDevice

    Add an Addon Device/Component
    (Version 0.2.58 | admin User Permission needed)

    Operation IDaddAddonDevice

    Available only on servers:

    • #Addons

    Accepts the following message:

    Message IDaddAddonDevicePayload

    Payload: Add an Addon Device/Component

    object

    Examples

    • #1 Example
      {
  "name": "My Addon",
  "profile": "test-addon",
  "configOverrides": {
    "SERVERIP": "192.168.76.1"
  }
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addAddonDevice

  • EMIT addAddonProfile

    Add/import an Addon Profile
    (Version 0.2.71 | admin User Permission needed)

    Operation IDaddAddonProfile

    Available only on servers:

    • #Addons

    Accepts the following message:

    Message IDaddAddonProfilePayload

    Payload: Add/import an Addon Profile

    object

    Examples

    • #1 Example
      {
  "profile": "test-addon",
  "content": {}
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addAddonProfile

  • EMIT getAddonLimit

    Get Addon Limit
    (Version 0.2.39 | admin User Permission needed)

    Operation IDgetAddonLimit

    Available only on servers:

    • #Addons

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getAddonLimit

  • EMIT getAddonProfile

    Get imported/added Addon Profile
    (Version 0.2.40 | admin User Permission needed)

    Operation IDgetAddonProfile

    Available only on servers:

    • #Addons

    Accepts the following message:

    Message IDgetAddonProfilePayload

    Payload: Get imported/added Addon Profile

    object

    Examples

    • #1 Example
      {
  "id": 5
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getAddonProfile

  • EMIT getAddonProfiles

    Get imported/added Addon Profiles
    (Version 0.2.40 | admin User Permission needed)

    Operation IDgetAddonProfiles

    Available only on servers:

    • #Addons

    Accepts the following message:

    Message IDgetAddonProfilesPayload

    Payload: Get imported/added Addon Profiles

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getAddonProfiles

  • EMIT getOnlineLibraryProfiles

    Get available Online Library Profiles
    (Version 0.2.40 | admin User Permission needed)

    Operation IDgetOnlineLibraryProfiles

    Available only on servers:

    • #Addons

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getOnlineLibraryProfiles

  • EMIT importOnlineLibraryProfile

    Add/import a Online Library Profile
    (Version 0.2.71 | admin User Permission needed)

    Operation IDimportOnlineLibraryProfile

    Available only on servers:

    • #Addons

    Accepts the following message:

    Message IDimportOnlineLibraryProfilePayload

    Payload: Add/import a Online Library Profile

    object

    Examples

    • #1 Example
      {
  "type": "Miscellaneous",
  "profile": "test-addon"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: importOnlineLibraryProfile

  • EVENT onAddonProfileAdded

    Event Update when a new Addon Profile has been added
    (Version 0.2.19 | admin User Permission needed)

    Operation IDonAddonProfileAdded

    Available only on servers:

    • #Addons

    Accepts the following message:

    Message IDonAddonProfileAddedEvent

    Event Update when a new Addon Profile has been added

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1,
  "name": "Test Addon"
}

  • EVENT onAddonProfileRemoved

    Event Update when an Addon Profile has been removed
    (Version 0.2.19 | admin User Permission needed)

    Operation IDonAddonProfileRemoved

    Available only on servers:

    • #Addons

    Accepts the following message:

    Message IDonAddonProfileRemovedEvent

    Event Update when an Addon Profile has been removed

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 5
}

  • EMIT removeAddonProfileById

    Remove an Addon Profile by Id
    (Version 0.2.19 | admin User Permission needed)

    Operation IDremoveAddonProfileById

    Available only on servers:

    • #Addons

    Accepts the following message:

    Message IDremoveAddonProfileByIdPayload

    Payload: Remove an Addon Profile by Id

    object

    Examples

    • #1 Example
      {
  "id": 5
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeAddonProfileById

  • EMIT removeAddonProfileByName

    Remove an Addon Profile by Name
    (Version 0.2.19 | admin User Permission needed)

    Operation IDremoveAddonProfileByName

    Available only on servers:

    • #Addons

    Accepts the following message:

    Message IDremoveAddonProfileByNamePayload

    Payload: Remove an Addon Profile by Name

    object

    Examples

    • #1 Example
      {
  "name": "test-addon"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeAddonProfileByName

  • EMIT setAddonDevice

    Set/update an Addon Device/Component
    (Version 0.2.39 | admin User Permission needed)

    Operation IDsetAddonDevice

    Available only on servers:

    • #Addons

    Accepts the following message:

    Message IDsetAddonDevicePayload

    Payload: Set/update an Addon Device/Component

    object

    Examples

    • #1 Example
      {
  "cid": "C3",
  "name": "My Addon",
  "configOverrides": {
    "SERVERIP": "192.168.76.2"
  }
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setAddonDevice

  • EMIT addRemoteDevice

    Add a "remote" Apple iTunes/Music/AppleTV Device/Component
    (Version 0.2.71 | admin User Permission needed)

    Operation IDaddRemoteDevice

    Available only on servers:

    • #Apple-Remote

    Accepts the following message:

    Message IDaddRemoteDevicePayload

    Payload: Add a "remote" Apple iTunes/Music/AppleTV Device/Component

    object

    Examples

    • #1 Example
      {
  "model": "iTunes",
  "name": "MacBookPro iTunes",
  "host": "192.168.1.99",
  "lid": "remote.itunes",
  "profile": "itunes",
  "capabilities": []
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addRemoteDevice

  • EMIT getRemoteDevices

    Get (autodetected) "remote" Apple iTunes/Music/AppleTV Devices/Components
    (Version 0.2.71 | admin User Permission needed)

    Operation IDgetRemoteDevices

    Available only on servers:

    • #Apple-Remote

    Accepts the following message:

    Message IDgetRemoteDevicesPayload

    Payload: Get (autodetected) "remote" Apple iTunes/Music/AppleTV Devices/Components

    object

    Examples

    • #1 Example
      {
  "model": "Music"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getRemoteDevices

  • EVENT remoteStateChange

    Event Update when "remote" Apple Status Event is triggered
    (Version 0.2.71 | admin User Permission needed)

    Operation IDremoteStateChange

    Available only on servers:

    • #Apple-Remote

    Accepts the following message:

    Message IDremoteStateChangeEvent

    Event Update when "remote" Apple Status Event is triggered

    object

    Examples

    • #1 Example - Response
      {
  "name": "Livingroom",
  "model": "AppleTV",
  "host": "192.168.1.99",
  "uuid": "12345678-90C2-4D0D-BA26-4B9EABC2F8B3",
  "status": "detected",
  "paired": false
}

  • EMIT sendRemotePairingCode

    Send "remote" Apple Pairing PIN Code
    (Version 0.2.70 | admin User Permission needed)

    Operation IDsendRemotePairingCode

    Available only on servers:

    • #Apple-Remote

    Accepts the following message:

    Message IDsendRemotePairingCodePayload

    Payload: Send "remote" Apple Pairing PIN Code

    object

    Examples

    • #1 Example
      {
  "code": 1234
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: sendRemotePairingCode

  • EMIT startRemotePairing

    Start "remote" Apple Pairing Mode
    (Version 0.2.70 | admin User Permission needed)

    Operation IDstartRemotePairing

    Available only on servers:

    • #Apple-Remote

    Accepts the following message:

    Message IDstartRemotePairingPayload

    Payload: Start "remote" Apple Pairing Mode

    object

    Examples

    • #1 Example
      {
  "uuid": "12345678-90C2-4D0D-BA26-4B9EABC2F8B3"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: startRemotePairing

  • EMIT stopRemotePairing

    Stop "remote" Apple Pairing Mode
    (Version 0.2.25 | admin User Permission needed)

    Operation IDstopRemotePairing

    Available only on servers:

    • #Apple-Remote

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: stopRemotePairing

  • EMIT /backup/v1/upload

    HTTP POST Upload a Backup
    (Version 0.3.10 | admin User Permission needed)

    Operation IDBackupUpload

    Available only on servers:

    • #BackupRestore

    Accepts the following message:

    Message IDBackupUploadPayload

    Payload: Upload a Backup

    object

    Examples

    {
  "file": "string"
}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: /backup/v1/upload

  • EMIT Upload-Backup

    SocketIOFileUpload Upload Backup File with the Help of SocketIOFileUpload Library (see SocketIOFileUpload for more Information)
    (Version 0.2.4 | admin User Permission needed)

    Operation IDUpload-Backup

    Available only on servers:

    • #BackupRestore

    Accepts the following message:

    Message IDUpload-BackupPayload

    Payload: Upload Backup File with the Help of SocketIOFileUpload Library (see SocketIOFileUpload for more Information)

    object

    Examples

    • #1 Example
      var uploader = new SocketIOFileUpload(socket);
uploader.listenOnInput(document.getElementById("backupUploadInput"));
uploader.addEventListener('error', function(data) {
  if(data.code === 1) {
    console.log("File size error");
  }
});
uploader.addEventListener('progress', function(event) {
  console.log(parseInt(event.bytesLoaded / event.file.size * 100) + '%');
});
uploader.addEventListener('complete', function(event) {
  if(event.detail.error === false) {
    // Success
    window.location.reload();
  } else {
    // Error
  }
});
uploader.addEventListener('start', function(event) {
  event.file.meta.type = 'backup';
});
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: Upload-Backup

  • EMIT createBackup

    Create a Backup
    (Version 0.2.4 | admin User Permission needed)

    Operation IDcreateBackup

    Available only on servers:

    • #BackupRestore

    Accepts the following message:

    Message IDcreateBackupPayload

    Payload: Create a Backup

    object

    Examples

    • #1 Example
      {
  "name": "Test-Backup"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: createBackup

  • EMIT downloadBackup

    Download a Backup
    (Version 0.2.4 | admin User Permission needed)

    Operation IDdownloadBackup

    Available only on servers:

    • #BackupRestore

    Accepts the following message:

    Message IDdownloadBackupPayload

    Payload: Download a Backup

    object

    Examples

    {
  "name": "string"
}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: downloadBackup

  • EMIT getBackups

    Get Backups
    (Version 0.2.4 | admin User Permission needed)

    Operation IDgetBackups

    Available only on servers:

    • #BackupRestore

    Accepts the following message:

    Message IDgetBackupsPayload

    Payload: Get Backups

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getBackups

  • EMIT removeBackup

    Remove a Backup
    (Version 0.2.4 | admin User Permission needed)

    Operation IDremoveBackup

    Available only on servers:

    • #BackupRestore

    Accepts the following message:

    Message IDremoveBackupPayload

    Payload: Remove a Backup

    object

    Examples

    {
  "source": "local",
  "name": "string"
}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeBackup

  • EMIT restoreBackup

    Restore a Backup (on Success, System will reboot automatically)
    (Version 0.2.49 | admin User Permission needed)

    Operation IDrestoreBackup

    Available only on servers:

    • #BackupRestore

    Accepts the following message:

    Message IDrestoreBackupPayload

    Payload: Restore a Backup (on Success, System will reboot automatically)

    object

    Examples

    • #1 Example
      {
  "name": "Test-Backup"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: restoreBackup

  • EMIT addCamera

    Add a Camera
    (Version 0.3.3 | admin User Permission needed)

    Operation IDaddCamera

    Available only on servers:

    • #Cameras

    Accepts the following message:

    Message IDaddCameraPayload

    Payload: Add a Camera

    object

    Examples

    • #1 Example
      {
  "name": "Kitchen Cam",
  "rooms": [
    1
  ],
  "url": "http://192.168.1.2/cam.jpeg",
  "type": "snapshot",
  "refreshRate": 150
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addCamera

  • EMIT getCamera

    Get Camera by ID
    (Version 0.3.3 | admin User Permission needed)

    Operation IDgetCamera

    Available only on servers:

    • #Cameras

    Accepts the following message:

    Message IDgetCameraPayload

    Payload: Get Camera by ID

    object

    Examples

    • #1 Example
      {
  "id": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getCamera

  • EMIT getCameraError

    Get last Camera Error
    (Version 0.2.50 | admin User Permission needed)

    Operation IDgetCameraError

    Available only on servers:

    • #Cameras

    Accepts the following message:

    Message IDgetCameraErrorPayload

    Payload: Get last Camera Error

    object

    Examples

    • #1 Example
      {
  "id": 3
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getCameraError

  • EMIT getCameraName

    Get Camera Name
    (Version 0.2.46 | admin User Permission needed)

    Operation IDgetCameraName

    Available only on servers:

    • #Cameras

    Accepts the following message:

    Message IDgetCameraNamePayload

    Payload: Get Camera Name

    object

    Examples

    • #1 Example
      {
  "id": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getCameraName

  • EMIT getCameras

    Get Cameras
    (Version 0.3.3)

    Operation IDgetCameras

    Available only on servers:

    • #Cameras

    Accepts the following message:

    Message IDgetCamerasPayload

    Payload: Get Cameras

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getCameras

  • EMIT getJanusConfiguration

    Get Janus Configuration Settings
    (Version 0.3.2)

    Operation IDgetJanusConfiguration

    Available only on servers:

    • #Cameras

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getJanusConfiguration

  • EMIT getJanusOneTimeToken

    Get One-time Token for Janus WebSocket Service
    (Version 0.3.2)

    Operation IDgetJanusOneTimeToken

    Available only on servers:

    • #Cameras

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getJanusOneTimeToken

  • EVENT onCameraAdded

    Event Update when a new Camera was added
    (Version 0.2.47 | admin User Permission needed)

    Operation IDonCameraAdded

    Available only on servers:

    • #Cameras

    Accepts the following message:

    Message IDonCameraAddedEvent

    Event Update when a new Camera was added

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1,
  "cid": "C1",
  "name": "Kitchen Cam"
}

  • EVENT onCameraNameChange

    Event Update when a Camera Name has been changed
    (Version 0.2.3 | admin User Permission needed)

    Operation IDonCameraNameChange

    Available only on servers:

    • #Cameras

    Accepts the following message:

    Message IDonCameraNameChangeEvent

    Event Update when a Camera Name has been changed

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1,
  "name": "Livingroom WebCam"
}

  • EVENT onCameraRemoved

    Event Update when a Camera was removed
    (Version 0.2.3 | admin User Permission needed)

    Operation IDonCameraRemoved

    Available only on servers:

    • #Cameras

    Accepts the following message:

    Message IDonCameraRemovedEvent

    Event Update when a Camera was removed

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1
}

  • EVENT onCameraUpdated

    Event Update when a Camera has been updated
    (Version 0.2.47 | admin User Permission needed)

    Operation IDonCameraUpdated

    Available only on servers:

    • #Cameras

    Accepts the following message:

    Message IDonCameraUpdatedEvent

    Event Update when a Camera has been updated

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1
}

  • EMIT removeCamera

    Remove a Camera
    (Version 0.2.47 | admin User Permission needed)

    Operation IDremoveCamera

    Available only on servers:

    • #Cameras

    Accepts the following message:

    Message IDremoveCameraPayload

    Payload: Remove a Camera

    object

    Examples

    • #1 Example
      {
  "id": 3
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeCamera

  • EMIT setCamera

    Set/Update a Camera
    (Version 0.3.3 | admin User Permission needed)

    Operation IDsetCamera

    Available only on servers:

    • #Cameras

    Accepts the following message:

    Message IDsetCameraPayload

    Payload: Set/Update a Camera

    object

    Examples

    • #1 Example
      {
  "id": 1,
  "name": "Kitchen Cam",
  "rooms": [
    1
  ],
  "url": "http://192.168.1.2/cam.jpeg",
  "type": "snapshot",
  "refreshRate": 150
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setCamera

  • EMIT setCameraName

    Set Camera Name
    (Version 0.2.3 | admin User Permission needed)

    Operation IDsetCameraName

    Available only on servers:

    • #Cameras

    Accepts the following message:

    Message IDsetCameraNamePayload

    Payload: Set Camera Name

    object

    Examples

    • #1 Example
      {
  "id": 1,
  "name": "Kitchen Cam"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setCameraName

  • EMIT startCameraStream

    Start a Camera Stream
    (Version 0.3.2)

    Operation IDstartCameraStream

    Available only on servers:

    • #Cameras

    Accepts the following message:

    Message IDstartCameraStreamPayload

    Payload: Start a Camera Stream

    object

    Examples

    • #1 Example
      {
  "id": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: startCameraStream

  • EMIT getClients

    Get (App) Client List
    (Version 0.2.26 | admin User Permission needed)

    Operation IDgetClients

    Available only on servers:

    • #Clients

    Accepts the following message:

    Message IDgetClientsPayload

    Payload: Get (App) Client List

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "appVersion"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getClients

  • EMIT registerClient

    HTTP POST Allows devices to register for push notifications, without being authenticated.
    (Version 0.2.33)

    Operation IDregisterClient

    Available only on servers:

    • #Clients

    Accepts the following message:

    Message IDregisterClientPayload

    Payload: Allows devices to register for push notifications, without being authenticated.

    object

    Examples

    • #1 Example
      {
  "did": "1E4F8745-BBBB-40DA-1F7A-2CDAC92BBBBB",
  "token": "098765432109876543210987654321098765432109876543210987654321",
  "appId": "com.nomos-system.testapp",
  "appVersion": "1.0.1",
  "appName": "nomos TestApp",
  "osVersion": "17.6.1",
  "platform": "iOS",
  "model": "iPhone6,1",
  "name": "My iPhone",
  "language": "en"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: registerClient

  • EMIT removeAllClients

    Remove all (App) Clients
    (Version 0.2.75 | admin User Permission needed)

    Operation IDremoveAllClients

    Available only on servers:

    • #Clients

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeAllClients

  • EMIT removeClient

    Remove an (App) Client
    (Version 0.1.8 | admin User Permission needed)

    Operation IDremoveClient

    Available only on servers:

    • #Clients

    Accepts the following message:

    Message IDremoveClientPayload

    Payload: Remove an (App) Client

    object

    Examples

    • #1 Example
      {
  "did": "1E4F8745-BBBB-40DA-1F7A-2CDAC92BBBBB",
  "appId": "com.nomos-system.testapp"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeClient

  • EMIT renameClient

    Rename an (App) Client
    (Version 0.2.38 | admin User Permission needed)

    Operation IDrenameClient

    Available only on servers:

    • #Clients

    Accepts the following message:

    Message IDrenameClientPayload

    Payload: Rename an (App) Client

    object

    Examples

    • #1 Example - Example rename
      {
  "did": "1E4F8745-BBBB-40DA-1F7A-2CDAC92BBBBB",
  "appId": "com.nomos-system.testapp",
  "name": "New Name"
}
    • #2 Example - Example reset
      {
  "did": "1E4F8745-BBBB-40DA-1F7A-2CDAC92BBBBB",
  "appId": "com.nomos-system.testapp",
  "name": null
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: renameClient

  • EMIT disableCloud

    Disable Cloud
    (Version 0.2.66 | admin User Permission needed)

    Operation IDdisableCloud

    Available only on servers:

    • #Cloud

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: disableCloud

  • EMIT disableCloudSync

    Disable Cloud Controller Synchronization
    (Version 0.2.66 | admin User Permission needed)

    Operation IDdisableCloudSync

    Available only on servers:

    • #Cloud

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: disableCloudSync

  • EMIT enableCloud

    Enable Cloud
    (Version 0.2.66 | admin User Permission needed)

    Operation IDenableCloud

    Available only on servers:

    • #Cloud

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: enableCloud

  • EMIT enableCloudSync

    Enable Cloud Controller Synchronization
    (Version 0.2.66 | admin User Permission needed)

    Operation IDenableCloudSync

    Available only on servers:

    • #Cloud

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: enableCloudSync

  • EMIT getCloudStatus

    Get Cloud Status Information/Configuration
    (Version 0.3.7)

    Operation IDgetCloudStatus

    Available only on servers:

    • #Cloud

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getCloudStatus

  • EMIT registerCloud

    Register to Cloud
    (Version 0.2.65 | admin User Permission needed)

    Operation IDregisterCloud

    Available only on servers:

    • #Cloud

    Accepts the following message:

    Message IDregisterCloudPayload

    Payload: Register to Cloud

    object

    Examples

    {
  "username": "string",
  "password": "string"
}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: registerCloud

  • EMIT resetCloud

    Reset Cloud Connection and Credentials
    (Version 0.2.66 | admin User Permission needed)

    Operation IDresetCloud

    Available only on servers:

    • #Cloud

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: resetCloud

  • EMIT unregisterCloud

    Unregister from Cloud
    (Version 0.2.66 | admin User Permission needed)

    Operation IDunregisterCloud

    Available only on servers:

    • #Cloud

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: unregisterCloud

  • EMIT addComponentTag

    Add a Component Tag or multiple Tags
    (Version 0.2.40 | admin User Permission needed)

    Operation IDaddComponentTag

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDaddComponentTagPayload

    Payload: Add a Component Tag or multiple Tags

    object

    Examples

    • #1 Example
      {
  "cid": "C10",
  "tags": [
    "Tag1",
    "Tag2"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addComponentTag

  • EMIT attachComponent

    Attach a Component to a Room
    (Version 0.1.8 | admin User Permission needed)

    Operation IDattachComponent

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDattachComponentPayload

    Payload: Attach a Component to a Room

    object

    Examples

    • #1 Example
      {
  "cid": "C10",
  "room": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: attachComponent

  • EVENT autoDetectionChange

    Event Update when new Components are getting detected by the system
    (Version 0.2.71 | admin User Permission needed)

    Operation IDautoDetectionChange

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDautoDetectionChangeEvent

    Event Update when new Components are getting detected by the system

    object

    Examples

    • #1 Example - Response
      {
  "type": "sonos"
}

  • EMIT componentUpdate

    Do a Property Update on one or multiple Component(s)
    (Version 0.2.60)

    Operation IDcomponentUpdate

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDcomponentUpdatePayload

    Payload: Do a Property Update on one or multiple Component(s)

    object

    Examples

    • #1 Example - Example 1
      {
  "cid": "C10",
  "property": "switchon"
}
    • #2 Example - Example 2
      {
  "cid": "C10",
  "property": "level",
  "value": "100"
}
    • #3 Example - Example 3 (Incrementation)
      {
  "cid": "C10",
  "property": "level",
  "value": "+=10"
}
    • #4 Example - Floor Example
      {
  "floor": 1,
  "property": "switchoff",
  "filterType": "Lightbulb"
}
    • #5 Example - Room Example
      {
  "room": [
    1,
    2
  ],
  "property": "switchoff",
  "filterCategory": "Lighting"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: componentUpdate

  • EMIT detachComponent

    Detach a Component from a Room
    (Version 0.1.8 | admin User Permission needed)

    Operation IDdetachComponent

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDdetachComponentPayload

    Payload: Detach a Component from a Room

    object

    Examples

    • #1 Example
      {
  "cid": "C10",
  "room": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: detachComponent

  • EMIT getAllComponents

    Get All Components
    (Version 0.2.73)

    Operation IDgetAllComponents

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDgetAllComponentsPayload

    Payload: Get All Components

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getAllComponents

  • EMIT getComponentAssociations

    Get Components Associations
    (Version 0.2.47 | admin User Permission needed)

    Operation IDgetComponentAssociations

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDgetComponentAssociationsPayload

    Payload: Get Components Associations

    object

    Examples

    • #1 Example
      {
  "cid": "C10"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getComponentAssociations

  • EMIT getComponentData

    Get Component Data/Value for specific Component ID
    (Version 0.2.11)

    Operation IDgetComponentData

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDgetComponentDataPayload

    Payload: Get Component Data/Value for specific Component ID

    object

    Examples

    • #1 Example - Example 1
      {
  "cid": "C1",
  "property": "album"
}
    • #2 Example - Example 2
      {
  "cid": "C2",
  "property": "power"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getComponentData

  • EMIT getComponentInitData

    Get Component Init Data/Values for specific Component ID's
    (Version 0.2.20)

    Operation IDgetComponentInitData

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDgetComponentInitDataPayload

    Payload: Get Component Init Data/Values for specific Component ID's

    array<string>

    Array with Component ID's to get initialization data for

    Examples

    • #1 Example - Example 1

      C1

    • #2 Example - Example 2
      [
  "C1",
  "C2"
]
    • #3 Example - Example 3
      {
  "cid": "C1"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getComponentInitData

  • EMIT getComponentsByAttributes

    Get Component(s) by Attribute(s)
    (Version 0.2.82)

    Operation IDgetComponentsByAttributes

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDgetComponentsByAttributesPayload

    Payload: Get Component(s) by Attribute(s)

    object

    Examples

    • #1 Example
      {
  "attributes": {
    "id": "1",
    "engineType": "ZWAVE"
  }
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getComponentsByAttributes

  • EMIT getComponentsById

    Get Component(s) by Id
    (Version 0.2.73)

    Operation IDgetComponentsById

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDgetComponentsByIdPayload

    Payload: Get Component(s) by Id

    object

    Examples

    • #1 Example
      {
  "cid": "C1"
}
    • #2 Example - Multi Example
      {
  "cid": [
    "C1",
    "C2"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getComponentsById

  • EMIT getComponentsByProfile

    Filter components that start with a specific profile name
    (Version 0.2.73)

    Operation IDgetComponentsByProfile

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDgetComponentsByProfilePayload

    Payload: Filter components that start with a specific profile name

    object

    Examples

    • #1 Example
      {
  "profile": "sonos"
}
    • #2 Example - Sorting
      {
  "profile": "sonos",
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getComponentsByProfile

  • EMIT getComponentsByRoom

    Get Components by Room
    (Version 0.2.73)

    Operation IDgetComponentsByRoom

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDgetComponentsByRoomPayload

    Payload: Get Components by Room

    object

    Examples

    • #1 Example
      {
  "room": 1
}
    • #2 Example - Sorting
      {
  "room": 1,
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getComponentsByRoom

  • EMIT getComponentsByTag

    Get Components by Tag(s)
    (Version 0.2.73)

    Operation IDgetComponentsByTag

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDgetComponentsByTagPayload

    Payload: Get Components by Tag(s)

    object

    Examples

    • #1 Example
      {
  "tags": "TestTag"
}
    • #2 Example - Sorting
      {
  "tags": "TestTag",
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getComponentsByTag

  • EMIT getEverything

    Get Components, Floors, Rooms, Cameras, SIP Clients and Scenes
    (Version 0.2.80)

    Operation IDgetEverything

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDgetEverythingPayload

    Payload: Get Components, Floors, Rooms, Cameras, SIP Clients and Scenes

    object

    Examples

    • #1 Example
      {
  "components": {},
  "floors": {},
  "rooms": {},
  "cameras": {},
  "scenes": {},
  "links": {},
  "sips": {}
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getEverything

  • EVENT onComponentAdded

    Event Update when a new Component has been added
    (Version 0.1.8 | admin User Permission needed)

    Operation IDonComponentAdded

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDonComponentAddedEvent

    Event Update when a new Component has been added

    object

    Examples

    • #1 Example - Success-Response
      {
  "cid": "C10"
}

  • EVENT onComponentAttached

    Event Update when a Component has been attached to a Room
    (Version 0.1.8 | admin User Permission needed)

    Operation IDonComponentAttached

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDonComponentAttachedEvent

    Event Update when a Component has been attached to a Room

    object

    Examples

    • #1 Example - Success-Response
      {
  "cid": "C10",
  "room": 1
}

  • EVENT onComponentChange

    Event Update when a Component has been updated
    (Version 0.2.70 | admin User Permission needed)

    Operation IDonComponentChange

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDonComponentChangeEvent

    Event Update when a Component has been updated

    object

    Examples

    • #1 Example - Success-Response
      {
  "cid": "C10"
}

  • EVENT onComponentDetached

    Event Update when a Component has been detached from a Room
    (Version 0.1.8 | admin User Permission needed)

    Operation IDonComponentDetached

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDonComponentDetachedEvent

    Event Update when a Component has been detached from a Room

    object

    Examples

    • #1 Example - Success-Response
      {
  "cid": "C10",
  "room": 1
}

  • EVENT onComponentMetaChange

    Event Update when Component Meta has been changed
    (Version 0.2.60 | admin User Permission needed)

    Operation IDonComponentMetaChange

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDonComponentMetaChangeEvent

    Event Update when Component Meta has been changed

    object

    Examples

    • #1 Example - Success-Response
      {
  "cid": "C10",
  "meta": {}
}

  • EVENT onComponentNameChange

    Event Update when a Component Name has been changed
    (Version 0.2.0 | admin User Permission needed)

    Operation IDonComponentNameChange

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDonComponentNameChangeEvent

    Event Update when a Component Name has been changed

    object

    Examples

    • #1 Example - Success-Response
      {
  "cid": "C10",
  "name": "Test"
}

  • EVENT onComponentRemoved

    Event Update when a Component has been removed
    (Version 0.2.14 | admin User Permission needed)

    Operation IDonComponentRemoved

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDonComponentRemovedEvent

    Event Update when a Component has been removed

    object

    Examples

    • #1 Example - Success-Response
      {
  "cid": "C10"
}

  • EVENT onComponentTagsChange

    Event Update when Component Tags has been changed
    (Version 0.2.40 | admin User Permission needed)

    Operation IDonComponentTagsChange

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDonComponentTagsChangeEvent

    Event Update when Component Tags has been changed

    object

    Examples

    • #1 Example - Success-Response
      {
  "cid": "C10",
  "tags": [
    "Test"
  ]
}

  • EVENT onComponentUpdate

    Event Update when a Component has been updated
    (Version 0.2.11 | admin User Permission needed)

    Operation IDonComponentUpdate

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDonComponentUpdateEvent

    Event Update when a Component has been updated

    array<any>

    Component Update Objects

    Examples

    • #1 Example - Success-Response Example 1
      [
  {
    "cid": "C3",
    "property": "artist",
    "content": "AC/DC"
  }
]
    • #2 Example - Success-Response Example 2
      [
  {
    "cid": "C5",
    "property": "power",
    "content": "55.52 W",
    "value": 55.52,
    "unit": "W"
  }
]

  • EMIT removeComponent

    Remove a Component
    (Version 0.2.18 | admin User Permission needed)

    Operation IDremoveComponent

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDremoveComponentPayload

    Payload: Remove a Component

    object

    Examples

    • #1 Example
      {
  "cid": "C10"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeComponent

  • EMIT removeComponentTag

    Remove a Component Tag or multiple Tags
    (Version 0.2.40 | admin User Permission needed)

    Operation IDremoveComponentTag

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDremoveComponentTagPayload

    Payload: Remove a Component Tag or multiple Tags

    object

    Examples

    • #1 Example
      {
  "cid": "C10",
  "tags": [
    "Tag1",
    "Tag2"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeComponentTag

  • EMIT setComponent

    Set/Update a Component
    (Version 0.2.46 | admin User Permission needed)

    Operation IDsetComponent

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDsetComponentPayload

    Payload: Set/Update a Component

    object

    Examples

    • #1 Example
      {
  "cid": "C10",
  "name": "Test"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setComponent

  • EMIT setComponentName

    Set a new Component Name
    (Version 0.1.8 | admin User Permission needed)

    Operation IDsetComponentName

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDsetComponentNamePayload

    Payload: Set a new Component Name

    object

    Examples

    • #1 Example
      {
  "cid": "C10",
  "name": "Test"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setComponentName

  • EMIT startBatchMode

    Start Configuration Batch Mode. After calling this function all component configuration updates will NOT restart the engine.
    (Version 0.1.8 | admin User Permission needed)

    Operation IDstartBatchMode

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: startBatchMode

  • EMIT stopBatchMode

    Stops Configuration Batch Mode. Will restart the engine(s) for new configuration takes effect.
    (Version 0.1.8 | admin User Permission needed)

    Operation IDstopBatchMode

    Available only on servers:

    • #Components

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: stopBatchMode

  • EMIT getEngineConfiguration

    Get Engine Configuration Parameters
    (Version 0.3.4 | admin User Permission needed)

    Operation IDgetEngineConfiguration

    Available only on servers:

    • #Engine

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getEngineConfiguration

  • EMIT getEngineProjects

    Get Engine Projects List
    (Version 0.1.8 | admin User Permission needed)

    Operation IDgetEngineProjects

    Available only on servers:

    • #Engine

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getEngineProjects

  • EMIT getEngineStartLog

    Get Engine/Daemon Start Log
    (Version 0.1.8 | admin User Permission needed)

    Operation IDgetEngineStartLog

    Available only on servers:

    • #Engine

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getEngineStartLog

  • EMIT setEngineConfiguration

    Set/Replace Engine Configuration Parameters, a "null" value would delete a configuration parameter
    (Version 0.3.4 | admin User Permission needed)

    Operation IDsetEngineConfiguration

    Available only on servers:

    • #Engine

    Accepts the following message:

    Message IDsetEngineConfigurationPayload

    Payload: Set/Replace Engine Configuration Parameters, a "null" value would delete a configuration parameter

    object

    Examples

    • #1 Example
      {
  "PROJECT": "Test"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setEngineConfiguration

  • EMIT addEvent

    Add an Event
    (Version 0.2.60 | admin User Permission needed)

    Operation IDaddEvent

    Available only on servers:

    • #Events

    Accepts the following message:

    Message IDaddEventPayload

    Payload: Add an Event

    object

    Examples

    • #1 Example - Example 1
      {
  "name": "TestEvent",
  "triggers": [
    {
      "cid": "C1",
      "mapping": "playerstate",
      "value": "PLAYING"
    }
  ],
  "positiveActions": [
    {
      "cid": "C2",
      "property": "switchon"
    }
  ]
}
    • #2 Example - Example 2
      {
  "name": "TestEvent",
  "triggers": [
    {
      "cid": "C1",
      "mapping": "playerstate",
      "value": "STOPPED"
    },
    "||",
    {
      "cid": "C1",
      "mapping": "playerstate",
      "value": "PAUSED"
    }
  ],
  "conditions": [
    {
      "cid": "C2",
      "mapping": "switch",
      "value": 1
    }
  ],
  "positiveActions": [
    {
      "cid": "C2",
      "property": "switchoff"
    },
    {
      "cid": "C3",
      "property": "switchoff"
    }
  ],
  "negativeActions": [
    {
      "cid": "C2",
      "property": "switchon"
    },
    {
      "cid": "C3",
      "property": "switchon"
    }
  ]
}
    • #3 Example - Example 3
      {
  "name": "TestEvent",
  "enabled": false,
  "triggers": [
    [
      {
        "cid": "C1",
        "mapping": "playerstate",
        "value": "STOPPED"
      },
      "||",
      {
        "cid": "C1",
        "mapping": "playerstate",
        "value": "PAUSED"
      }
    ],
    "&&",
    {
      "cid": "C1",
      "mapping": "volume",
      "operator": ">=",
      "value": 75
    }
  ],
  "positiveActions": [
    {
      "cid": "C1",
      "property": "volume",
      "value": 30
    }
  ]
}
    • #4 Example - Example 4 (with Time Trigger)
      {
  "name": "TestEvent",
  "enabled": true,
  "triggers": [
    {
      "timer": {
        "time": "SUNRISE",
        "weekdays": [
          "MONDAY",
          "TUESDAY",
          "WEDNESDAY",
          "THURSDAY",
          "FRIDAY"
        ]
      }
    },
    "&&",
    {
      "cid": "C2",
      "mapping": "state",
      "value": 1
    }
  ],
  "positiveActions": [
    {
      "cid": "C2",
      "property": "state",
      "value": 0
    }
  ]
}
    • #5 Example - Example 5 (with Time Condition)
      {
  "name": "TestEvent",
  "enabled": true,
  "triggers": [
    {
      "cid": "C2",
      "mapping": "state",
      "value": 1
    }
  ],
  "conditions": [
    {
      "timer": {
        "operator": "<=",
        "time": "SUNRISE",
        "weekdays": [
          "SATURDAY",
          "SUNDAY"
        ]
      }
    }
  ],
  "positiveActions": [
    {
      "cid": "C2",
      "property": "state",
      "value": 0
    }
  ]
}
    • #6 Example - Example 6 (with Timerange condition)
      {
  "name": "TestEvent",
  "enabled": true,
  "triggers": [
    {
      "cid": "C2",
      "mapping": "state",
      "value": 1
    }
  ],
  "conditions": [
    {
      "timerange": {
        "start": "SUNRISE",
        "end": "SUNSET+00:15:00"
      }
    }
  ],
  "positiveActions": [
    {
      "cid": "C2",
      "property": "state",
      "value": 0
    }
  ]
}
    • #7 Example - Example 7 (Interval Timer)
      {
  "name": "TestInterval",
  "triggers": [
    {
      "timer": {
        "interval": 60
      }
    }
  ],
  "positiveActions": [
    {
      "cid": "C2",
      "property": "switchon"
    }
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addEvent

  • EMIT addSpecialEvent

    Add a Special Event (see Examples)
    (Version 0.2.51 | admin User Permission needed)

    Operation IDaddSpecialEvent

    Available only on servers:

    • #Events

    Accepts the following message:

    Message IDaddSpecialEventPayload

    Payload: Add a Special Event (see Examples)

    object

    Examples

    • #1 Example - knx.volume.link.4bit Example
      {
  "name": "Linking KNX Dim Up/Down with Component Volume Property",
  "id": "knx.volume.link.4bit",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C2"
    }
  ]
}
    • #2 Example - knx.volume.link.8bit Example
      {
  "name": "Linking KNX 1 Byte with Component Volume Property",
  "id": "knx.volume.link.8bit",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C2"
    }
  ]
}
    • #3 Example - knx.level.link.4bit Example
      {
  "name": "Linking KNX Dim Up/Down with Component Level Property",
  "id": "knx.level.link.4bit",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C2"
    }
  ]
}
    • #4 Example - knx.lutronlevel.link.4bit Example
      {
  "name": "Linking KNX Dim Up/Down with Lutron Component",
  "id": "knx.lutronlevel.link.4bit",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C2"
    }
  ]
}
    • #5 Example - knx.link.8bit Example
      {
  "name": "Linking KNX 1 Byte unsigned with Component Property",
  "id": "knx.link.8bit",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C2",
      "property": "level"
    }
  ]
}
    • #6 Example - knx.text.scrolling Example
      {
  "name": "KNX Text Scrolling",
  "id": "knx.text.scrolling",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C2",
      "property": "title"
    }
  ]
}
    • #7 Example - knx.playerinfo.scrolling Example
      {
  "name": "KNX Sonos Information Scrolling",
  "id": "knx.playerinfo.scrolling",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C2",
      "property": ""
    }
  ]
}
    • #8 Example - knx.property.push Example
      {
  "name": "Property/Value to KNX Push",
  "id": "knx.property.push",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C2",
      "property": "volume"
    }
  ]
}
    • #9 Example - property.push Example
      {
  "name": "Property/Value Push",
  "id": "property.push",
  "data": [
    {
      "cid": "C1",
      "property": "level"
    },
    {
      "cid": "C2",
      "property": "volume"
    }
  ]
}
    • #10 Example - property.sync Example
      {
  "name": "Property/Value Synchronization",
  "id": "property.sync",
  "data": [
    {
      "cid": "C1",
      "property": "volume"
    },
    {
      "cid": "C2",
      "property": "volume"
    }
  ]
}
    • #11 Example - hue.colorloop Example
      {
  "name": "HUE ColorLoop",
  "id": "hue.colorloop",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C3"
    },
    [
      [
        255,
        0,
        0
      ],
      [
        0,
        255,
        0
      ],
      [
        0,
        0,
        255
      ]
    ]
  ]
}
    • #12 Example - knx.rgbloop Example
      {
  "name": "KNX RGBLoop",
  "id": "knx.rgbloop",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C3"
    },
    [
      [
        255,
        0,
        0
      ],
      [
        0,
        255,
        0
      ],
      [
        0,
        0,
        255
      ]
    ]
  ]
}
    • #13 Example - inputloop Example
      {
  "name": "InputLoop",
  "id": "inputloop",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C3",
      "property": "value"
    },
    [
      "Value/Input 1",
      "Value/Input 2",
      "Value/Input 3"
    ]
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addSpecialEvent

  • EMIT cloneEvent

    Clone/duplicate an Event
    (Version 0.1.8 | admin User Permission needed)

    Operation IDcloneEvent

    Available only on servers:

    • #Events

    Accepts the following message:

    Message IDcloneEventPayload

    Payload: Clone/duplicate an Event

    object

    Examples

    • #1 Example
      {
  "eid": "E10"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: cloneEvent

  • EMIT disableEvent

    Disable an Event
    (Version 0.1.8 | admin User Permission needed)

    Operation IDdisableEvent

    Available only on servers:

    • #Events

    Accepts the following message:

    Message IDdisableEventPayload

    Payload: Disable an Event

    object

    Examples

    • #1 Example
      {
  "eid": "E10"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: disableEvent

  • EMIT enableEvent

    Enable an Event
    (Version 0.1.8 | admin User Permission needed)

    Operation IDenableEvent

    Available only on servers:

    • #Events

    Accepts the following message:

    Message IDenableEventPayload

    Payload: Enable an Event

    object

    Examples

    • #1 Example
      {
  "eid": "E10"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: enableEvent

  • EMIT getEvent

    Get Event
    (Version 0.2.45 | admin User Permission needed)

    Operation IDgetEvent

    Available only on servers:

    • #Events

    Accepts the following message:

    Message IDgetEventPayload

    Payload: Get Event

    object

    Examples

    • #1 Example
      {
  "eid": "E10"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getEvent

  • EMIT getEvents

    Get All Events
    (Version 0.2.45 | admin User Permission needed)

    Operation IDgetEvents

    Available only on servers:

    • #Events

    Accepts the following message:

    Message IDgetEventsPayload

    Payload: Get All Events

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getEvents

  • EMIT getEventsByTag

    Get Events by Tag(s)
    (Version 0.2.45 | admin User Permission needed)

    Operation IDgetEventsByTag

    Available only on servers:

    • #Events

    Accepts the following message:

    Message IDgetEventsByTagPayload

    Payload: Get Events by Tag(s)

    object

    Examples

    • #1 Example
      {
  "tags": "TestTag"
}
    • #2 Example - Sorting
      {
  "tags": "TestTag",
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getEventsByTag

  • EMIT lockEvent

    Lock Event to prevent unwanted changes
    (Version 0.2.45 | admin User Permission needed)

    Operation IDlockEvent

    Available only on servers:

    • #Events

    Accepts the following message:

    Message IDlockEventPayload

    Payload: Lock Event to prevent unwanted changes

    object

    Examples

    • #1 Example
      {
  "eid": "E10"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: lockEvent

  • EVENT onEventTriggered

    Event Update when an Event got triggered
    (Version 0.2.41 | admin User Permission needed)

    Operation IDonEventTriggered

    Available only on servers:

    • #Events

    Accepts the following message:

    Message IDonEventTriggeredEvent

    Event Update when an Event got triggered

    object

    Examples

    • #1 Example - Success-Response
      {
  "eid": "E10",
  "trigger": "positive",
  "stats": {
    "minute": 1,
    "hour": 2,
    "day": 3,
    "week": 3,
    "month": 3,
    "year": 3
  }
}

  • EMIT removeEvent

    Remove an Event
    (Version 0.2.45 | admin User Permission needed)

    Operation IDremoveEvent

    Available only on servers:

    • #Events

    Accepts the following message:

    Message IDremoveEventPayload

    Payload: Remove an Event

    object

    Examples

    • #1 Example
      {
  "eid": "E10"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeEvent

  • EMIT setEvent

    Set/Update an Event
    (Version 0.2.57 | admin User Permission needed)

    Operation IDsetEvent

    Available only on servers:

    • #Events

    Accepts the following message:

    Message IDsetEventPayload

    Payload: Set/Update an Event

    object

    Examples

    • #1 Example
      {
  "eid": "E10",
  "name": "TestEvent",
  "enabled": false,
  "onChange": false,
  "triggers": [
    {
      "cid": "C1",
      "mapping": "playerstate",
      "value": "PLAYING"
    }
  ],
  "positiveActions": [
    {
      "cid": "C2",
      "property": "switchon"
    }
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setEvent

  • EMIT setEventName

    Set a new Event Name
    (Version 0.2.45 | admin User Permission needed)

    Operation IDsetEventName

    Available only on servers:

    • #Events

    Accepts the following message:

    Message IDsetEventNamePayload

    Payload: Set a new Event Name

    object

    Examples

    • #1 Example
      {
  "eid": "E10",
  "name": "Test-Event"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setEventName

  • EMIT setSpecialEvent

    Set/Update a Special Event (see Examples)
    (Version 0.2.51 | admin User Permission needed)

    Operation IDsetSpecialEvent

    Available only on servers:

    • #Events

    Accepts the following message:

    Message IDsetSpecialEventPayload

    Payload: Set/Update a Special Event (see Examples)

    object

    Examples

    • #1 Example - knx.volume.link.4bit Example
      {
  "name": "Linking KNX Dim Up/Down with Component Volume Property",
  "id": "knx.volume.link.4bit",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C2"
    }
  ]
}
    • #2 Example - knx.volume.link.8bit Example
      {
  "name": "Linking KNX 1 Byte with Component Volume Property",
  "id": "knx.volume.link.8bit",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C2"
    }
  ]
}
    • #3 Example - knx.level.link.4bit Example
      {
  "name": "Linking KNX Dim Up/Down with Component Level Property",
  "id": "knx.level.link.4bit",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C2"
    }
  ]
}
    • #4 Example - knx.lutronlevel.link.4bit Example
      {
  "name": "Linking KNX Dim Up/Down with Lutron Component",
  "id": "knx.lutronlevel.link.4bit",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C2"
    }
  ]
}
    • #5 Example - knx.link.8bit Example
      {
  "name": "Linking KNX 1 Byte unsigned with Component Property",
  "id": "knx.link.8bit",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C2",
      "property": "level"
    }
  ]
}
    • #6 Example - knx.text.scrolling Example
      {
  "name": "KNX Text Scrolling",
  "id": "knx.text.scrolling",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C2",
      "property": "title"
    }
  ]
}
    • #7 Example - knx.playerinfo.scrolling Example
      {
  "name": "KNX Sonos Information Scrolling",
  "id": "knx.playerinfo.scrolling",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C2",
      "property": ""
    }
  ]
}
    • #8 Example - knx.property.push Example
      {
  "name": "Property/Value to KNX Push",
  "id": "knx.property.push",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C2",
      "property": "volume"
    }
  ]
}
    • #9 Example - property.push Example
      {
  "name": "Property/Value Push",
  "id": "property.push",
  "data": [
    {
      "cid": "C1",
      "property": "level"
    },
    {
      "cid": "C2",
      "property": "volume"
    }
  ]
}
    • #10 Example - property.sync Example
      {
  "name": "Property/Value Synchronization",
  "id": "property.sync",
  "data": [
    {
      "cid": "C1",
      "property": "volume"
    },
    {
      "cid": "C2",
      "property": "volume"
    }
  ]
}
    • #11 Example - hue.colorloop Example
      {
  "name": "HUE ColorLoop",
  "id": "hue.colorloop",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C3"
    },
    [
      [
        255,
        0,
        0
      ],
      [
        0,
        255,
        0
      ],
      [
        0,
        0,
        255
      ]
    ]
  ]
}
    • #12 Example - knx.rgbloop Example
      {
  "name": "KNX RGBLoop",
  "id": "knx.rgbloop",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C3"
    },
    [
      [
        255,
        0,
        0
      ],
      [
        0,
        255,
        0
      ],
      [
        0,
        0,
        255
      ]
    ]
  ]
}
    • #13 Example - inputloop Example
      {
  "name": "InputLoop",
  "id": "inputloop",
  "data": [
    {
      "cid": "C1",
      "property": "value"
    },
    {
      "cid": "C3",
      "property": "value"
    },
    [
      "Value/Input 1",
      "Value/Input 2",
      "Value/Input 3"
    ]
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setSpecialEvent

  • EMIT unlockEvent

    Unlock Event
    (Version 0.2.45 | admin User Permission needed)

    Operation IDunlockEvent

    Available only on servers:

    • #Events

    Accepts the following message:

    Message IDunlockEventPayload

    Payload: Unlock Event

    object

    Examples

    • #1 Example
      {
  "eid": "E10"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: unlockEvent

  • EMIT disableExternalAccess

    Disable Remote Access
    (Version 0.2.33 | admin User Permission needed)

    Operation IDdisableExternalAccess

    Available only on servers:

    • #ExternalAccess

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: disableExternalAccess

  • EMIT enableExternalAccess

    Enable Remote Access
    (Version 0.2.33 | admin User Permission needed)

    Operation IDenableExternalAccess

    Available only on servers:

    • #ExternalAccess

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: enableExternalAccess

  • EMIT getExternalAccessClientToken

    Get/Generate Remote Access Client Token
    (Version 0.2.33)

    Operation IDgetExternalAccessClientToken

    Available only on servers:

    • #ExternalAccess

    Accepts the following message:

    Message IDgetExternalAccessClientTokenPayload

    Payload: Get/Generate Remote Access Client Token

    object

    Examples

    • #1 Example
      {
  "jwtid": "E4F8745-BBBB-40DA-1F7A-2CDAC92BBBBB"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getExternalAccessClientToken

  • EMIT getExternalAccessStatus

    Get Remote Access Status Information
    (Version 0.2.33)

    Operation IDgetExternalAccessStatus

    Available only on servers:

    • #ExternalAccess

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getExternalAccessStatus

  • EMIT revokeExternalAccessClientToken

    Revoke Remote Access Client Token
    (Version 0.2.33)

    Operation IDrevokeExternalAccessClientToken

    Available only on servers:

    • #ExternalAccess

    Accepts the following message:

    Message IDrevokeExternalAccessClientTokenPayload

    Payload: Revoke Remote Access Client Token

    object

    Examples

    • #1 Example
      {
  "jwt": "eyJhbGciOiJIUzUxiIsInR5cCI6IkpXVCJ9.eyJwYXlkMSI6IlhYWFhYIiwicGF5bG9hZDIiOiJ4eHh4eHgiLCJpYXQiOj1ZCI6InVybjpub21vcyIsInN1YiI6IllZWSJ9.aQs9j7w9-OFxq0ZqzwTK3oCxfE"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: revokeExternalAccessClientToken

  • EMIT revokeExternalAccessClientTokens

    Revoke All Remote Access Client Tokens
    (Version 0.2.33 | admin User Permission needed)

    Operation IDrevokeExternalAccessClientTokens

    Available only on servers:

    • #ExternalAccess

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: revokeExternalAccessClientTokens

  • EMIT Import-Floor-Image

    SocketIOFileUpload Import Floor Image with the Help of SocketIOFileUpload Library (see SocketIOFileUpload for more Information)
    (Version 0.3.8 | admin User Permission needed)

    Operation IDImport-Floor-Image

    Available only on servers:

    • #Floors

    Accepts the following message:

    Message IDImport-Floor-ImagePayload

    Payload: Import Floor Image with the Help of SocketIOFileUpload Library (see SocketIOFileUpload for more Information)

    object

    Examples

    • #1 Example
      var uploader = new SocketIOFileUpload(socket);
uploader.listenOnInput(document.getElementById("imageImportInput"));
uploader.addEventListener('error', function(data) {
  if(data.code === 1) {
    console.log("File size error");
  }
});
uploader.addEventListener('progress', function(event) {
  console.log(parseInt(event.bytesLoaded / event.file.size * 100) + '%');
});
uploader.addEventListener('complete', function(event) {
  if(event.detail.error === false) {
    // Success
    window.location.reload();
  } else {
    // Error
  }
});
uploader.addEventListener('start', function(event) {
  event.file.meta.id = floor.id;
  event.file.meta.subid = 'test'; // optional
  event.file.meta.type = 'floorimage';
});
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: Import-Floor-Image

  • EMIT addFloor

    Add a Floor
    (Version 0.2.71 | admin User Permission needed)

    Operation IDaddFloor

    Available only on servers:

    • #Floors

    Accepts the following message:

    Message IDaddFloorPayload

    Payload: Add a Floor

    object

    Examples

    • #1 Example
      {
  "name": "Third Floor",
  "position": 3
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addFloor

  • EMIT getFloorImage

    Get Floor Image
    (Version 0.3.8)

    Operation IDgetFloorImage

    Available only on servers:

    • #Floors

    Accepts the following message:

    Message IDgetFloorImagePayload

    Payload: Get Floor Image

    object

    Examples

    • #1 Example
      {
  "id": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getFloorImage

  • EMIT getFloorName

    Get Floor Name
    (Version 0.2.60)

    Operation IDgetFloorName

    Available only on servers:

    • #Floors

    Accepts the following message:

    Message IDgetFloorNamePayload

    Payload: Get Floor Name

    object

    Examples

    • #1 Example
      {
  "id": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getFloorName

  • EMIT getFloors

    Get Floors
    (Version 0.3.8)

    Operation IDgetFloors

    Available only on servers:

    • #Floors

    Accepts the following message:

    Message IDgetFloorsPayload

    Payload: Get Floors

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getFloors

  • EVENT onFloorAdded

    Event Update when a new Floor has been added
    (Version 0.2.71 | admin User Permission needed)

    Operation IDonFloorAdded

    Available only on servers:

    • #Floors

    Accepts the following message:

    Message IDonFloorAddedEvent

    Event Update when a new Floor has been added

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1,
  "name": "Third Floor",
  "position": 3,
  "readonly": false
}

  • EVENT onFloorImageUpload

    Event Update when a Floor Image has been uploaded
    (Version 0.3.8 | admin User Permission needed)

    Operation IDonFloorImageUpload

    Available only on servers:

    • #Floors

    Accepts the following message:

    Message IDonFloorImageUploadEvent

    Event Update when a Floor Image has been uploaded

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1,
  "subid": "default"
}

  • EVENT onFloorNameChange

    Event Update when a Floor Name has been changed
    (Version 0.1.8 | admin User Permission needed)

    Operation IDonFloorNameChange

    Available only on servers:

    • #Floors

    Accepts the following message:

    Message IDonFloorNameChangeEvent

    Event Update when a Floor Name has been changed

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1,
  "name": "Third Floor"
}

  • EVENT onFloorRemoved

    Event Update when a Floor has been removed
    (Version 0.1.8 | admin User Permission needed)

    Operation IDonFloorRemoved

    Available only on servers:

    • #Floors

    Accepts the following message:

    Message IDonFloorRemovedEvent

    Event Update when a Floor has been removed

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1
}

  • EVENT onFloorUpdate

    Event Update when a Floor has been updated
    (Version 0.2.71 | admin User Permission needed)

    Operation IDonFloorUpdate

    Available only on servers:

    • #Floors

    Accepts the following message:

    Message IDonFloorUpdateEvent

    Event Update when a Floor has been updated

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1
}

  • EMIT removeFloor

    Remove a Floor
    (Version 0.2.3 | admin User Permission needed)

    Operation IDremoveFloor

    Available only on servers:

    • #Floors

    Accepts the following message:

    Message IDremoveFloorPayload

    Payload: Remove a Floor

    object

    Examples

    • #1 Example
      {
  "id": 3
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeFloor

  • EMIT removeFloorImage

    Remove a Floor image
    (Version 0.3.8 | admin User Permission needed)

    Operation IDremoveFloorImage

    Available only on servers:

    • #Floors

    Accepts the following message:

    Message IDremoveFloorImagePayload

    Payload: Remove a Floor image

    object

    Examples

    • #1 Example
      {
  "id": 3
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeFloorImage

  • EMIT setFloor

    Set/Update a Floor
    (Version 0.2.71 | admin User Permission needed)

    Operation IDsetFloor

    Available only on servers:

    • #Floors

    Accepts the following message:

    Message IDsetFloorPayload

    Payload: Set/Update a Floor

    object

    Examples

    • #1 Example
      {
  "id": 1,
  "name": "Third Floor",
  "position": 3
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setFloor

  • EMIT setFloorName

    Set Floor Name
    (Version 0.2.0 | admin User Permission needed)

    Operation IDsetFloorName

    Available only on servers:

    • #Floors

    Accepts the following message:

    Message IDsetFloorNamePayload

    Payload: Set Floor Name

    object

    Examples

    • #1 Example
      {
  "id": 1,
  "name": "Third Floor"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setFloorName

  • EMIT addFreeAtHomeAPVirtualDevice

    Add free@home virtual device
    (Version 0.2.59 | admin User Permission needed)

    Operation IDaddFreeAtHomeAPVirtualDevice

    Available only on servers:

    • #FreeAtHome

    Accepts the following message:

    Message IDaddFreeAtHomeAPVirtualDevicePayload

    Payload: Add free@home virtual device

    object

    Examples

    • #1 Example
      {
  "cid": "C1",
  "mac": "00:00:00:00:00:00"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addFreeAtHomeAPVirtualDevice

  • EMIT addFreeAtHomeDevice

    Add a free@home device as component
    (Version 0.2.54 | admin User Permission needed)

    Operation IDaddFreeAtHomeDevice

    Available only on servers:

    • #FreeAtHome

    Accepts the following message:

    Message IDaddFreeAtHomeDevicePayload

    Payload: Add a free@home device as component

    object

    Examples

    • #1 Example
      {
  "name": "Light",
  "apmac": "00:00:00:00:00:00",
  "apuuid": "00000-000000-0000000",
  "id": "1234567890",
  "lid": "freeathome.0012",
  "profile": "freeathome_0012",
  "model": "1234567890",
  "capabilities": []
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addFreeAtHomeDevice

  • EMIT authorizeFreeAtHomeAP

    undefined
    (Version 0.2.54 | admin User Permission needed)

    Operation IDauthorizeFreeAtHomeAP

    Available only on servers:

    • #FreeAtHome

    Accepts the following message:

    Message IDauthorizeFreeAtHomeAPPayload

    Payload: undefined

    object

    Examples

    • #1 Example
      {
  "ip": "192.168.0.74",
  "mac": "00:00:00:00:00:00",
  "username": "installer",
  "password": "myPassword1234"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: authorizeFreeAtHomeAP

  • EMIT getFreeAtHomeAPVirtualDevices

    Get free@home virtual devices
    (Version 0.2.59 | admin User Permission needed)

    Operation IDgetFreeAtHomeAPVirtualDevices

    Available only on servers:

    • #FreeAtHome

    Accepts the following message:

    Message IDgetFreeAtHomeAPVirtualDevicesPayload

    Payload: Get free@home virtual devices

    object

    Examples

    • #1 Example
      {
  "mac": "00:00:00:00:00:00"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getFreeAtHomeAPVirtualDevices

  • EMIT getFreeAtHomeAPs

    Get available free@home SysAP's
    (Version 0.2.54 | admin User Permission needed)

    Operation IDgetFreeAtHomeAPs

    Available only on servers:

    • #FreeAtHome

    Accepts the following message:

    Message IDgetFreeAtHomeAPsPayload

    Payload: Get available free@home SysAP's

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getFreeAtHomeAPs

  • EMIT getFreeAtHomeDevices

    Get available free@home devices
    (Version 0.2.54 | admin User Permission needed)

    Operation IDgetFreeAtHomeDevices

    Available only on servers:

    • #FreeAtHome

    Accepts the following message:

    Message IDgetFreeAtHomeDevicesPayload

    Payload: Get available free@home devices

    object

    Examples

    • #1 Example
      {
  "mac": "00:00:00:00:00:00"
}
    • #2 Example - Sorting
      {
  "mac": "00:00:00:00:00:00",
  "sortBy": [
    "name"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getFreeAtHomeDevices

  • EMIT removeFreeAtHomeAP

    undefined
    (Version 0.2.54 | admin User Permission needed)

    Operation IDremoveFreeAtHomeAP

    Available only on servers:

    • #FreeAtHome

    Accepts the following message:

    Message IDremoveFreeAtHomeAPPayload

    Payload: undefined

    object

    Examples

    • #1 Example
      {
  "mac": "00:00:00:00:00:00"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeFreeAtHomeAP

  • EMIT removeFreeAtHomeAPVirtualDevice

    Remove free@home virtual device
    (Version 0.2.54 | admin User Permission needed)

    Operation IDremoveFreeAtHomeAPVirtualDevice

    Available only on servers:

    • #FreeAtHome

    Accepts the following message:

    Message IDremoveFreeAtHomeAPVirtualDevicePayload

    Payload: Remove free@home virtual device

    object

    Examples

    • #1 Example
      {
  "cid": "C1",
  "mac": "00:00:00:00:00:00"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeFreeAtHomeAPVirtualDevice

  • EMIT getHAPLastError

    Get HAP Last Error Message
    (Version 0.2.47 | admin User Permission needed)

    Operation IDgetHAPLastError

    Available only on servers:

    • #HAP

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getHAPLastError

  • EMIT getHAPSettings

    Get HAP Settings
    (Version 0.2.50 | admin User Permission needed)

    Operation IDgetHAPSettings

    Available only on servers:

    • #HAP

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getHAPSettings

  • EMIT getHAPStatus

    Get HAP Last Status Information
    (Version 0.2.50 | admin User Permission needed)

    Operation IDgetHAPStatus

    Available only on servers:

    • #HAP

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getHAPStatus

  • EMIT resetHAP

    Reset HAP
    (Version 0.2.50 | admin User Permission needed)

    Operation IDresetHAP

    Available only on servers:

    • #HAP

    Accepts the following message:

    Message IDresetHAPPayload

    Payload: Reset HAP

    object

    Examples

    {
  "numberOfProcesses": 1
}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: resetHAP

  • EMIT addHomeConnectDevice

    Add a Home Connect device as component
    (Version 0.2.76 | admin User Permission needed)

    Operation IDaddHomeConnectDevice

    Available only on servers:

    • #HomeConnect

    Accepts the following message:

    Message IDaddHomeConnectDevicePayload

    Payload: Add a Home Connect device as component

    object

    Examples

    • #1 Example
      {
  "name": "FridgeFreezer Simulator",
  "id": "SIEMENS-HCS05FRF1-FD713F7FF636",
  "hcType": "FridgeFreezer",
  "lid": "homeconnect.fridge",
  "profile": "homeconnect_fridge",
  "manufacturer": "SIEMENS",
  "model": "HCS05FRF1",
  "ident": "HCS05FRF1/03",
  "capabilities": [
    "homeconnect_states_door",
    "homeconnect_settings_power",
    "homeconnect_settings_temperatureunit",
    "homeconnect_settings_childlock",
    "homeconnect_settings_setpoint_refrigerator",
    "homeconnect_settings_setpoint_freezer",
    "homeconnect_settings_setpoint_bottlecooler",
    "homeconnect_settings_setpoint_chiller",
    "homeconnect_settings_supermode_refrigerator",
    "homeconnect_settings_supermode_freezer"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addHomeConnectDevice

  • EMIT getHomeConnectDevicePrograms

    Get Home Connect device programs
    (Version 0.2.76)

    Operation IDgetHomeConnectDevicePrograms

    Available only on servers:

    • #HomeConnect

    Accepts the following message:

    Message IDgetHomeConnectDeviceProgramsPayload

    Payload: Get Home Connect device programs

    object

    Examples

    • #1 Example
      {
  "cid": "C10"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getHomeConnectDevicePrograms

  • EMIT getHomeConnectDevices

    Get HomeConnect devices
    (Version 0.2.76 | admin User Permission needed)

    Operation IDgetHomeConnectDevices

    Available only on servers:

    • #HomeConnect

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getHomeConnectDevices

  • EMIT initHomeConnectAuthorization

    Initialize HomeConnect Authorization
    (Version 0.2.76 | admin User Permission needed)

    Operation IDinitHomeConnectAuthorization

    Available only on servers:

    • #HomeConnect

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: initHomeConnectAuthorization

  • EVENT onHomeConnectAuthorization

    Event on HomeConnect Authorization
    (Version 0.2.76 | admin User Permission needed)

    Operation IDonHomeConnectAuthorization

    Available only on servers:

    • #HomeConnect

    Accepts the following message:

    Message IDonHomeConnectAuthorizationEvent

    Event Update on HomeConnect Authorization

    Payload
    boolean

    Examples

    • #1 Example

      true

  • EMIT addHusqvarnaDevice

    Add a Husqvarna device as component
    (Version 0.2.71 | admin User Permission needed)

    Operation IDaddHusqvarnaDevice

    Available only on servers:

    • #Husqvarna

    Accepts the following message:

    Message IDaddHusqvarnaDevicePayload

    Payload: Add a Husqvarna device as component

    object

    Examples

    • #1 Example
      {
  "name": "My Mower",
  "id": "1234567890",
  "husqvarnaType": "MOWER",
  "lid": "gardena.mower",
  "profile": "gardena_mower",
  "capabilities": [
    "gardena_status",
    "gardena_operatinghours",
    "gardena_battery",
    "gardena_link"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addHusqvarnaDevice

  • EMIT getHusqvarnaDevices

    Get Husqvarna locations/devices that are reported by the cloud
    (Version 0.2.59 | admin User Permission needed)

    Operation IDgetHusqvarnaDevices

    Available only on servers:

    • #Husqvarna

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getHusqvarnaDevices

  • EMIT initHusqvarnaAuthorization

    Initialize Husqvarna Authorization
    (Version 0.2.59 | admin User Permission needed)

    Operation IDinitHusqvarnaAuthorization

    Available only on servers:

    • #Husqvarna

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: initHusqvarnaAuthorization

  • EVENT onHusqvarnaAuthorization

    Event on Husqvarna Authorization
    (Version 0.2.59 | admin User Permission needed)

    Operation IDonHusqvarnaAuthorization

    Available only on servers:

    • #Husqvarna

    Accepts the following message:

    Message IDonHusqvarnaAuthorizationEvent

    Event Update on Husqvarna Authorization

    Payload
    boolean

    Examples

    • #1 Example

      true

  • EMIT Import-KNX-File

    SocketIOFileUpload Import KNX Project/Group Address File with the Help of SocketIOFileUpload Library (see SocketIOFileUpload for more Information)
    (Version 0.2.83 | admin User Permission needed)

    Operation IDImport-KNX-File

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDImport-KNX-FilePayload

    Payload: Import KNX Project/Group Address File with the Help of SocketIOFileUpload Library (see SocketIOFileUpload for more Information)

    object

    Examples

    • #1 Example
      var uploader = new SocketIOFileUpload(socket);
uploader.listenOnInput(document.getElementById("knxImportInput"));
uploader.addEventListener('error', function(data) {
  if(data.code === 1) {
    console.log("File size error");
  }
});
uploader.addEventListener('progress', function(event) {
  console.log(parseInt(event.bytesLoaded / event.file.size * 100) + '%');
});
uploader.addEventListener('complete', function(event) {
  if(event.detail.error === false) {
    // Success
    window.location.reload();
  } else {
    // Error
  }
});
uploader.addEventListener('start', function(event) {
  event.file.meta.password = ''; // optional
  event.file.meta.type = 'knxfile';
});
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: Import-KNX-File

  • EMIT addKNXDevice

    Add a KNX Device/Component
    (Version 0.2.71 | admin User Permission needed)

    Operation IDaddKNXDevice

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDaddKNXDevicePayload

    Payload: Add a KNX Device/Component

    object

    Examples

    • #1 Example
      {
  "name": "Livingroom",
  "lid": "knx.dimmer",
  "profile": "knx_switch",
  "propertiesAddresses": {
    "switchon": "1/1/1",
    "switchoff": "1/1/1",
    "level": "1/1/10"
  },
  "mappingsAddresses": {
    "switch": "1/7/1",
    "level": "1/7/10"
  },
  "capabilities": [
    "knx_level"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addKNXDevice

  • EMIT addKNXGroupAddress

    Add a user-defined KNX Group Address
    (Version 0.2.8 | admin User Permission needed)

    Operation IDaddKNXGroupAddress

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDaddKNXGroupAddressPayload

    Payload: Add a user-defined KNX Group Address

    object

    Examples

    • #1 Example
      {
  "addr": "2/1/36",
  "name": "FirstFloor_Kitchen_Wall_Dimmer",
  "type": "DPT_1.001",
  "description": "Kitchen Wall Dimmer",
  "readOnInit": false
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addKNXGroupAddress

  • EMIT downloadKNXProject

    Download a KNX Project
    (Version 0.2.19 | admin User Permission needed)

    Operation IDdownloadKNXProject

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDdownloadKNXProjectPayload

    Payload: Download a KNX Project

    object

    Examples

    • #1 Example
      {
  "name": "MyHome.esf"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: downloadKNXProject

  • EMIT getKNXAddressTypes

    Get an Object of KNX Addresses with their DPT
    (Version 0.2.15 | admin User Permission needed)

    Operation IDgetKNXAddressTypes

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getKNXAddressTypes

  • EMIT getKNXDataPointTypes

    Get a List of KNX Datapoint Types (DPT's)
    (Version 0.1.8 | admin User Permission needed)

    Operation IDgetKNXDataPointTypes

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getKNXDataPointTypes

  • EMIT getKNXGateways

    Get/find all KNX Gateways in local network
    (Version 0.2.71 | admin User Permission needed)

    Operation IDgetKNXGateways

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getKNXGateways

  • EMIT getKNXGroupAddresses

    Get KNX Project Group Addresses
    (Version 0.2.13 | admin User Permission needed)

    Operation IDgetKNXGroupAddresses

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDgetKNXGroupAddressesPayload

    Payload: Get KNX Project Group Addresses

    object

    Examples

    • #1 Example
      {
  "name": "MyHome.esf"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getKNXGroupAddresses

  • EMIT getKNXGroupAddressesUsedInDevices

    Get all KNX Group Addresses used in Devices
    (Version 0.2.82 | admin User Permission needed)

    Operation IDgetKNXGroupAddressesUsedInDevices

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getKNXGroupAddressesUsedInDevices

  • EMIT getKNXMainGroups

    Get KNX Project Main Group Address Information
    (Version 0.1.8 | admin User Permission needed)

    Operation IDgetKNXMainGroups

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDgetKNXMainGroupsPayload

    Payload: Get KNX Project Main Group Address Information

    object

    Examples

    • #1 Example
      {
  "name": "MyHome.esf"
}
    • #2 Example - Sorting
      {
  "name": "MyHome.esf",
  "sortBy": [
    "-addr"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getKNXMainGroups

  • EMIT getKNXMiddleGroups

    Get KNX Project Middle Group Address Information
    (Version 0.1.8 | admin User Permission needed)

    Operation IDgetKNXMiddleGroups

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDgetKNXMiddleGroupsPayload

    Payload: Get KNX Project Middle Group Address Information

    object

    Examples

    • #1 Example
      {
  "name": "MyHome.esf"
}
    • #2 Example - Sorting
      {
  "name": "MyHome.esf",
  "sortBy": [
    "name"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getKNXMiddleGroups

  • EMIT getKNXProjects

    Get KNX Projects List and Meta Information
    (Version 0.1.8 | admin User Permission needed)

    Operation IDgetKNXProjects

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDgetKNXProjectsPayload

    Payload: Get KNX Projects List and Meta Information

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getKNXProjects

  • EMIT isKNXGroupAddressUsed

    Is a KNX Group Address Used
    (Version 0.2.82 | admin User Permission needed)

    Operation IDisKNXGroupAddressUsed

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDisKNXGroupAddressUsedPayload

    Payload: Is a KNX Group Address Used

    object

    Examples

    • #1 Example
      {
  "addr": "2/1/36"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: isKNXGroupAddressUsed

  • EVENT knxImportError

    Event Update when Error occurs on KNX File Import
    (Version 0.1.8 | admin User Permission needed)

    Operation IDknxImportError

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDknxImportErrorEvent

    Event Update when Error occurs on KNX File Import

    object

    Examples

    • #1 Example - Error-Response
      {
  "errorText": "Unable to detect or wrong KNX file format!"
}

  • EVENT knxImportFinished

    Event Update when KNX File Import finished
    (Version 0.2.0 | admin User Permission needed)

    Operation IDknxImportFinished

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDknxImportFinishedEvent

    Event Update when KNX File Import finished

    object

    Result Object

    Examples

    • #1 Example - Response
      {
  "addresses": [
    {
      "addr": "2/1/36",
      "name": "FirstFloor_Kitchen_Wall_Dimmer",
      "type": "DPT_1.001",
      "description": "Kitchen Wall Dimmer"
    }
  ],
  "duplicates": [
    "1/1/1",
    "1/1/2"
  ],
  "devices": [
    {
      "id": "628494305",
      "name": "TXA663A - 1 - 3",
      "description": "",
      "type": "DimmableLight",
      "meta": {},
      "addresses": {
        "TargetAddress": "2/4/29"
      }
    }
  ]
}

  • EVENT knxImportProgress

    Event Update when Progress of KNX Import File Parsing is changing
    (Version 0.1.8 | admin User Permission needed)

    Operation IDknxImportProgress

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDknxImportProgressEvent

    Event Update when Progress of KNX Import File Parsing is changing

    object

    Examples

    • #1 Example
      {
  "percent": 75
}

  • EVENT knxRemoveProgress

    Event Update when Progress of KNX Project File Remove is changing
    (Version 0.1.9 | admin User Permission needed)

    Operation IDknxRemoveProgress

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDknxRemoveProgressEvent

    Event Update when Progress of KNX Project File Remove is changing

    object

    Examples

    • #1 Example
      {
  "percent": 75
}

  • EVENT knxStateChange

    Event Update when KNX Status Change is triggered
    (Version 0.2.71 | admin User Permission needed)

    Operation IDknxStateChange

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDknxStateChangeEvent

    Event Update when KNX Status Event is triggered

    object

    Examples

    • #1 Example - Idle Response
      {
  "status": "connected"
}

  • EMIT removeKNXGroupAddress

    Remove a KNX Group Address
    (Version 0.2.18 | admin User Permission needed)

    Operation IDremoveKNXGroupAddress

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDremoveKNXGroupAddressPayload

    Payload: Remove a KNX Group Address

    object

    Examples

    • #1 Example
      {
  "addr": "2/1/36"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeKNXGroupAddress

  • EMIT removeKNXProject

    Remove a KNX Project
    (Version 0.2.18 | admin User Permission needed)

    Operation IDremoveKNXProject

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDremoveKNXProjectPayload

    Payload: Remove a KNX Project

    object

    Examples

    • #1 Example
      {
  "name": "MyHome.esf"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeKNXProject

  • EMIT setKNXDevice

    Set/Update a KNX Device/Component
    (Version 0.2.71 | admin User Permission needed)

    Operation IDsetKNXDevice

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDsetKNXDevicePayload

    Payload: Set/Update a KNX Device/Component

    object

    Examples

    • #1 Example
      {
  "cid": "C6",
  "name": "Livingroom",
  "lid": "knx.dimmer",
  "profile": "knx_switch",
  "propertiesAddresses": {
    "switchon": "1/1/1",
    "switchoff": "1/1/1",
    "level": "1/1/10"
  },
  "mappingsAddresses": {
    "switch": "1/7/1",
    "level": "1/7/10"
  },
  "capabilities": [
    "knx_level"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setKNXDevice

  • EMIT setKNXGroupAddress

    Set/Update a KNX Group Address
    (Version 0.2.50 | admin User Permission needed)

    Operation IDsetKNXGroupAddress

    Available only on servers:

    • #KNX

    Accepts the following message:

    Message IDsetKNXGroupAddressPayload

    Payload: Set/Update a KNX Group Address

    object

    Examples

    • #1 Example
      {
  "addr": "2/1/36",
  "name": "Kitchen Wall Dimmer",
  "description": "Kitchen Wall Dimmer",
  "readOnInit": true
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setKNXGroupAddress

  • EMIT getLibraryByID

    Get Profile Data/Information out of the Library
    (Version 0.2.19 | admin User Permission needed)

    Operation IDgetLibraryByID

    Available only on servers:

    • #Library

    Accepts the following message:

    Message IDgetLibraryByIDPayload

    Payload: Get Profile Data/Information out of the Library

    object

    Examples

    • #1 Example - Example KNX Dimmer
      {
  "lid": "knx.dimmer"
}
    • #2 Example - Example Sonos
      {
  "lid": "sonos.default"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getLibraryByID

  • EMIT getLibraryByProfile

    Get Profile Data/Information out of the Library
    (Version 0.2.19 | admin User Permission needed)

    Operation IDgetLibraryByProfile

    Available only on servers:

    • #Library

    Accepts the following message:

    Message IDgetLibraryByProfilePayload

    Payload: Get Profile Data/Information out of the Library

    object

    Examples

    • #1 Example - Example KNX Dimmer
      {
  "name": "knx_switch",
  "capabilities": [
    "knx_level"
  ]
}
    • #2 Example - Example Sonos
      {
  "name": "sonos"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getLibraryByProfile

  • EMIT getLibraryIndex

    Get Library Index Data/Information
    (Version 0.1.8 | admin User Permission needed)

    Operation IDgetLibraryIndex

    Available only on servers:

    • #Library

    Accepts the following message:

    Message IDgetLibraryIndexPayload

    Payload: Get Library Index Data/Information

    object

    Examples

    • #1 Example
      {
  "name": "KNX"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getLibraryIndex

  • EMIT Upload-License-Key

    SocketIOFileUpload Set/Upload License Key File with the Help of SocketIOFileUpload Library (see SocketIOFileUpload for more Information)
    (Version 0.1.8 | admin User Permission needed)

    Operation IDUpload-License-Key

    Available only on servers:

    • #Licensing

    Accepts the following message:

    Message IDUpload-License-KeyPayload

    Payload: Set/Upload License Key File with the Help of SocketIOFileUpload Library (see SocketIOFileUpload for more Information)

    object

    Examples

    • #1 Example
      var uploader = new SocketIOFileUpload(socket);
uploader.listenOnInput(document.getElementById("licenseUploadInput"));
uploader.maxFileSize = 706;
uploader.addEventListener('error', function(data) {
  if(data.code === 1) {
    console.log("File size error");
  }
});
uploader.addEventListener('progress', function(event) {
  console.log(parseInt(event.bytesLoaded / event.file.size * 100) + '%');
});
uploader.addEventListener('complete', function(event) {
  if(event.detail.error === false) {
    // Success
    window.location.reload();
  } else {
    // Error
  }
});
uploader.addEventListener('start', function(event) {
  event.file.meta.type = 'keyfile';
});
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: Upload-License-Key

  • EMIT getLicenseConfig

    Get License Configuration/Information
    (Version 0.2.19)

    Operation IDgetLicenseConfig

    Available only on servers:

    • #Licensing

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getLicenseConfig

  • EVENT onLinkAdded

    Event Update when a new Link has been added
    (Version 0.2.56 | admin User Permission needed)

    Operation IDonLinkAdded

    Available only on servers:

    • #Links

    Accepts the following message:

    Message IDonLinkAddedEvent

    Event Update when a new Link has been added

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 3,
  "name": "Third Link",
  "url": "http://www.example-link3.com",
  "icon": "bookmark",
  "forceFullscreen": true
}

  • EVENT onLinkRemoved

    Event Update when a Link has been removed
    (Version 0.2.56 | admin User Permission needed)

    Operation IDonLinkRemoved

    Available only on servers:

    • #Links

    Accepts the following message:

    Message IDonLinkRemovedEvent

    Event Update when a Link has been removed

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1
}

  • EVENT onLinkUpdated

    Event Update when a Link has been updated
    (Version 0.2.56 | admin User Permission needed)

    Operation IDonLinkUpdated

    Available only on servers:

    • #Links

    Accepts the following message:

    Message IDonLinkUpdatedEvent

    Event Update when a Link has been updated

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1
}

  • EMIT disableLogging

    Disabling Data Logging for a particular Component Property
    (Version 0.2.5 | admin User Permission needed)

    Operation IDdisableLogging

    Available only on servers:

    • #Logging

    Accepts the following message:

    Message IDdisableLoggingPayload

    Payload: Disabling Data Logging for a particular Component Property

    object

    Examples

    • #1 Example
      {
  "cid": "C10",
  "property": "state"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: disableLogging

  • EMIT enableLogging

    Enabling Data Logging for a particular Component Property
    (Version 0.2.47 | admin User Permission needed)

    Operation IDenableLogging

    Available only on servers:

    • #Logging

    Accepts the following message:

    Message IDenableLoggingPayload

    Payload: Enabling Data Logging for a particular Component Property

    object

    Examples

    • #1 Example
      {
  "cid": "C10",
  "property": "state",
  "samplingRate": 5,
  "color": "237,33,84"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: enableLogging

  • EMIT getAllLoggingSettings

    Get Logging Settings for all enabled Components
    (Version 0.2.47)

    Operation IDgetAllLoggingSettings

    Available only on servers:

    • #Logging

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getAllLoggingSettings

  • EMIT getLoggingData

    Get Data Log for a particular Component Property
    (Version 0.2.84)

    Operation IDgetLoggingData

    Available only on servers:

    • #Logging

    Accepts the following message:

    Message IDgetLoggingDataPayload

    Payload: Get Data Log for a particular Component Property

    object

    Examples

    • #1 Example - Example 1 (get all data)
      {
  "cid": "C10",
  "property": "state"
}
    • #2 Example - Example 2
      {
  "cid": "C10",
  "property": "state",
  "aggregation": "daily",
  "from": 1469431719634
}
    • #3 Example - Example 3
      {
  "cid": "C10",
  "property": "state",
  "aggregation": "monthly",
  "from": "Mon Jul 25 2016 09:28:39 GMT+0200 (CEST)"
}
    • #4 Example - Example 4
      {
  "cid": "C10",
  "property": "state",
  "from": "Mon Jul 25 2015 00:00:00 GMT+0200 (CEST)",
  "to": "Mon Jul 25 2016 23:59:59 GMT+0200 (CEST)",
  "limit": 10000
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getLoggingData

  • EMIT getLoggingSettings

    Get Logging enabled Component Settings
    (Version 0.2.47)

    Operation IDgetLoggingSettings

    Available only on servers:

    • #Logging

    Accepts the following message:

    Message IDgetLoggingSettingsPayload

    Payload: Get Logging enabled Component Settings

    object

    Examples

    • #1 Example
      {
  "cid": "C10"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getLoggingSettings

  • EMIT resetLogging

    Completely delete/reset Data Log for a particular Component Property
    (Version 0.2.5 | admin User Permission needed)

    Operation IDresetLogging

    Available only on servers:

    • #Logging

    Accepts the following message:

    Message IDresetLoggingPayload

    Payload: Completely delete/reset Data Log for a particular Component Property

    object

    Examples

    • #1 Example
      {
  "cid": "C10",
  "property": "state"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: resetLogging

  • EMIT Import-Lutron-File

    SocketIOFileUpload Import Lutron Project File with the Help of SocketIOFileUpload Library (see SocketIOFileUpload for more Information)
    (Version 0.2.38 | admin User Permission needed)

    Operation IDImport-Lutron-File

    Available only on servers:

    • #Lutron

    Accepts the following message:

    Message IDImport-Lutron-FilePayload

    Payload: Import Lutron Project File with the Help of SocketIOFileUpload Library (see SocketIOFileUpload for more Information)

    object

    Examples

    • #1 Example
      var uploader = new SocketIOFileUpload(socket);
uploader.listenOnInput(document.getElementById("lutronImportInput"));
uploader.addEventListener('error', function(data) {
    if(data.code === 1) {
        console.log("File size error");
    }
});
uploader.addEventListener('progress', function(event) {
    console.log(parseInt(event.bytesLoaded / event.file.size * 100) + '%');
});
uploader.addEventListener('complete', function(event) {
    if(event.detail.error === false) {
        // Success
        window.location.reload();
    } else {
        // Error
    }
});
uploader.addEventListener('start', function(event) {
    event.file.meta.type = 'lutron';
    event.file.meta.host = '192.168.1.200';
    event.file.meta.username = 'lutron';
    event.file.meta.password = 'integration';
});
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: Import-Lutron-File

  • EMIT downloadLutronProject

    Download a Lutron Project
    (Version 0.2.38 | admin User Permission needed)

    Operation IDdownloadLutronProject

    Available only on servers:

    • #Lutron

    Accepts the following message:

    Message IDdownloadLutronProjectPayload

    Payload: Download a Lutron Project

    object

    Examples

    • #1 Example
      {
  "name": "123456789012345678901234567890"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: downloadLutronProject

  • EMIT getLutronProjects

    Get Lutron Projects List and Meta Information
    (Version 0.2.39 | admin User Permission needed)

    Operation IDgetLutronProjects

    Available only on servers:

    • #Lutron

    Accepts the following message:

    Message IDgetLutronProjectsPayload

    Payload: Get Lutron Projects List and Meta Information

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getLutronProjects

  • EMIT importRemoteLutronProject

    Import a remote Lutron Project from IP/Host
    (Version 0.2.39 | admin User Permission needed)

    Operation IDimportRemoteLutronProject

    Available only on servers:

    • #Lutron

    Accepts the following message:

    Message IDimportRemoteLutronProjectPayload

    Payload: Import a remote Lutron Project from IP/Host

    object

    Examples

    • #1 Example
      {
  "host": "192.168.1.200",
  "username": "lutron",
  "password": "integration"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: importRemoteLutronProject

  • EVENT lutronImportError

    Event Update when Error occurs on Lutron File Import
    (Version 0.2.38 | admin User Permission needed)

    Operation IDlutronImportError

    Available only on servers:

    • #Lutron

    Accepts the following message:

    Message IDlutronImportErrorEvent

    Event Update when Error occurs on Lutron File Import

    object

    Examples

    • #1 Example - Error-Response
      {
  "errorText": "Unable to detect or wrong Lutron file format!"
}

  • EVENT lutronImportFinished

    Event Update when Lutron File Import finished
    (Version 0.2.38 | admin User Permission needed)

    Operation IDlutronImportFinished

    Available only on servers:

    • #Lutron

    Accepts the following message:

    Message IDlutronImportFinishedEvent

    Event Update when Lutron File Import finished

    object

    Result Object

    Examples

    • #1 Example - Response
      {
  "devices": [
    {
      "name": "Lamp 1",
      "type": "BUTTON",
      "category": "device"
    }
  ]
}

  • EVENT lutronImportProgress

    Event Update when Progress of Lutron Import File Parsing is changing
    (Version 0.2.38 | admin User Permission needed)

    Operation IDlutronImportProgress

    Available only on servers:

    • #Lutron

    Accepts the following message:

    Message IDlutronImportProgressEvent

    Event Update when Progress of Lutron Import File Parsing is changing

    object

    Examples

    • #1 Example
      {
  "percent": 75
}

  • EMIT removeLutronProject

    Remove a Lutron Project
    (Version 0.2.38 | admin User Permission needed)

    Operation IDremoveLutronProject

    Available only on servers:

    • #Lutron

    Accepts the following message:

    Message IDremoveLutronProjectPayload

    Payload: Remove a Lutron Project

    object

    Examples

    • #1 Example
      {
  "name": "123456789012345678901234567890"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeLutronProject

  • EMIT setLutronProject

    Set/Update Lutron Project IP/Host and Credentials
    (Version 0.2.39 | admin User Permission needed)

    Operation IDsetLutronProject

    Available only on servers:

    • #Lutron

    Accepts the following message:

    Message IDsetLutronProjectPayload

    Payload: Set/Update Lutron Project IP/Host and Credentials

    object

    Examples

    • #1 Example
      {
  "name": "123456789012345678901234567890",
  "host": "192.168.1.201",
  "username": "test",
  "password": "test"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setLutronProject

  • EMIT setLutronProjectCredentials

    Set/Update Lutron Project Credentials
    (Version 0.2.39 | admin User Permission needed)

    Operation IDsetLutronProjectCredentials

    Available only on servers:

    • #Lutron

    Accepts the following message:

    Message IDsetLutronProjectCredentialsPayload

    Payload: Set/Update Lutron Project Credentials

    object

    Examples

    • #1 Example
      {
  "name": "123456789012345678901234567890",
  "username": "test",
  "password": "test"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setLutronProjectCredentials

  • EMIT setLutronProjectHost

    Set/Update Lutron Project IP/Host
    (Version 0.2.38 | admin User Permission needed)

    Operation IDsetLutronProjectHost

    Available only on servers:

    • #Lutron

    Accepts the following message:

    Message IDsetLutronProjectHostPayload

    Payload: Set/Update Lutron Project IP/Host

    object

    Examples

    • #1 Example
      {
  "name": "123456789012345678901234567890",
  "host": "192.168.1.201"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setLutronProjectHost

  • EMIT getMQTTStatus

    Get MQTT Status Information
    (Version 0.2.46)

    Operation IDgetMQTTStatus

    Available only on servers:

    • #MQTT

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getMQTTStatus

  • EMIT confirmManagementPairing

    Confirm Management Master Pairing
    (Version 0.2.71 | admin User Permission needed)

    Operation IDconfirmManagementPairing

    Available only on servers:

    • #ManagementClient

    Accepts the following message:

    Message IDconfirmManagementPairingPayload

    Payload: Confirm Management Master Pairing

    object

    Examples

    • #1 Example
      {
  "sid": "NS123456789"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: confirmManagementPairing

  • EMIT disableManagementPairing

    Disable Management Master Pairing
    (Version 0.2.71 | admin User Permission needed)

    Operation IDdisableManagementPairing

    Available only on servers:

    • #ManagementClient

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: disableManagementPairing

  • EMIT enableManagementPairing

    Enable Management Master Pairing
    (Version 0.2.71 | admin User Permission needed)

    Operation IDenableManagementPairing

    Available only on servers:

    • #ManagementClient

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: enableManagementPairing

  • EMIT getManagementMasters

    Get all paired Management Masters
    (Version 0.2.71 | admin User Permission needed)

    Operation IDgetManagementMasters

    Available only on servers:

    • #ManagementClient

    Accepts the following message:

    Message IDgetManagementMastersPayload

    Payload: Get all paired Management Masters

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getManagementMasters

  • EMIT getManagementPairing

    Get Management Master Pairing Enabled State
    (Version 0.2.71 | admin User Permission needed)

    Operation IDgetManagementPairing

    Available only on servers:

    • #ManagementClient

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getManagementPairing

  • EVENT onManagementMasterPairing

    Event on Management Master Pairing
    (Version 0.2.71 | admin User Permission needed)

    Operation IDonManagementMasterPairing

    Available only on servers:

    • #ManagementClient

    Accepts the following message:

    Message IDonManagementMasterPairingEvent

    Event Update on Management Master Pairing

    object

    Examples

    • #1 Example
      {
  "name": "Master System",
  "sid": "NS123456789"
}

  • EMIT pairManagementMaster

    Pair a Management Master
    (Version 0.2.71 | admin User Permission needed)

    Operation IDpairManagementMaster

    Available only on servers:

    • #ManagementClient

    Accepts the following message:

    Message IDpairManagementMasterPayload

    Payload: Pair a Management Master

    object

    Examples

    • #1 Example
      {
  "sid": "NS123456789",
  "name": "Master System",
  "id": "12345678901234567890",
  "ipAddress": "172.16.17.1",
  "serverIP": "192.168.1.50",
  "serverPort": 51123,
  "serverPublicKey": "serverpublickey"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: pairManagementMaster

  • EMIT unpairManagementMaster

    Unpair a Management Master
    (Version 0.2.71 | admin User Permission needed)

    Operation IDunpairManagementMaster

    Available only on servers:

    • #ManagementClient

    Accepts the following message:

    Message IDunpairManagementMasterPayload

    Payload: Unpair a Management Master

    object

    Examples

    • #1 Example
      {
  "id": "12345678901234567890"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: unpairManagementMaster

  • EMIT downloadManagementClientDocument

    Download Management Client Reset Document
    (Version 0.2.75 | admin User Permission needed)

    Operation IDdownloadManagementClientDocument

    Available only on servers:

    • #ManagementMaster

    Accepts the following message:

    Message IDdownloadManagementClientDocumentPayload

    Payload: Download Management Client Reset Document

    object

    Examples

    • #1 Example
      {
  "id": "12345678901234567890"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: downloadManagementClientDocument

  • EMIT emailManagementClientDocument

    E-Mail Management Client Reset Document
    (Version 0.2.75 | admin User Permission needed)

    Operation IDemailManagementClientDocument

    Available only on servers:

    • #ManagementMaster

    Accepts the following message:

    Message IDemailManagementClientDocumentPayload

    Payload: E-Mail Management Client Reset Document

    object

    Examples

    • #1 Example
      {
  "id": "12345678901234567890",
  "receiver": "test@nomos-system.com"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: emailManagementClientDocument

  • EMIT emitManagementClientAPI

    Emit a Management Client API
    (Version 0.2.74 | admin User Permission needed)

    Operation IDemitManagementClientAPI

    Available only on servers:

    • #ManagementMaster

    Accepts the following message:

    Message IDemitManagementClientAPIPayload

    Payload: Emit a Management Client API

    object

    Examples

    • #1 Example
      {
  "id": "12345678901234567890",
  "api": "getVersion",
  "params": {}
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: emitManagementClientAPI

  • EMIT getAvailableManagementClients

    Get all available Management Clients
    (Version 0.2.71 | admin User Permission needed)

    Operation IDgetAvailableManagementClients

    Available only on servers:

    • #ManagementMaster

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getAvailableManagementClients

  • EMIT getManagementClients

    Get paired Management Clients
    (Version 0.2.74 | admin User Permission needed)

    Operation IDgetManagementClients

    Available only on servers:

    • #ManagementMaster

    Accepts the following message:

    Message IDgetManagementClientsPayload

    Payload: Get paired Management Clients

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getManagementClients

  • EMIT getManagementMasterSettings

    Get Management Master Settings
    (Version 0.2.71 | admin User Permission needed)

    Operation IDgetManagementMasterSettings

    Available only on servers:

    • #ManagementMaster

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getManagementMasterSettings

  • EMIT pairManagementClient

    Pair a Management Client
    (Version 0.2.71 | admin User Permission needed)

    Operation IDpairManagementClient

    Available only on servers:

    • #ManagementMaster

    Accepts the following message:

    Message IDpairManagementClientPayload

    Payload: Pair a Management Client

    object

    Examples

    • #1 Example
      {
  "host": "192.168.1.50",
  "username": "admin",
  "password": "admin"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: pairManagementClient

  • EMIT setManagementMasterSettings

    Set Management Master Settings
    (Version 0.2.71 | admin User Permission needed)

    Operation IDsetManagementMasterSettings

    Available only on servers:

    • #ManagementMaster

    Accepts the following message:

    Message IDsetManagementMasterSettingsPayload

    Payload: Set Management Master Settings

    object

    Examples

    • #1 Example
      {
  "serverIP": "192.168.1.50",
  "cidr": "172.16.17.1/24"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setManagementMasterSettings

  • EMIT softResetManagementClient

    Soft Reset Management Client System
    (Version 0.2.75 | admin User Permission needed)

    Operation IDsoftResetManagementClient

    Available only on servers:

    • #ManagementMaster

    Accepts the following message:

    Message IDsoftResetManagementClientPayload

    Payload: Soft Reset Management Client System

    object

    Examples

    • #1 Example
      {
  "id": "12345678901234567890",
  "adminPassword": "newPassword",
  "numberOfUsers": 3,
  "numberOfAdmins": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: softResetManagementClient

  • EMIT unpairManagementClient

    Unpair a Management Client
    (Version 0.2.71 | admin User Permission needed)

    Operation IDunpairManagementClient

    Available only on servers:

    • #ManagementMaster

    Accepts the following message:

    Message IDunpairManagementClientPayload

    Payload: Unpair a Management Client

    object

    Examples

    • #1 Example
      {
  "id": "12345678901234567890"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: unpairManagementClient

  • EMIT busMessage

    Emit a Bus Message
    (Version 0.2.4 | admin User Permission needed)

    Operation IDbusMessage

    Available only on servers:

    • #MessageBus

    Accepts the following message:

    Message IDbusMessagePayload

    Payload: Emit a Bus Message

    object

    Examples

    • #1 Example - mremote Example
      {
  "eventName": "ID.NS123456789.mremote.daemon.NS123456789",
  "data": {
    "method": "mremote",
    "joins": {
      "d1": 1
    }
  }
}
    • #2 Example - Daemon Script Run Example
      {
  "eventName": "ID.NS123456789.cmd.daemon.NS123456789",
  "data": {
    "method": "command",
    "class": "SCRIPT",
    "command": {
      "name": "RUN",
      "value": "SCRIPTNAME.myh"
    }
  }
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: busMessage

  • EVENT onBusMessage

    Is getting fired on Message Bus Events (you have to emit startMessageBusLog before)
    (Version 0.2.70 | admin User Permission needed)

    Operation IDonBusMessage

    Available only on servers:

    • #MessageBus

    Accepts the following message:

    Message IDonBusMessageEvent

    Event: Is getting fired on Message Bus Events (you have to emit startMessageBusLog before)

    object

    Examples

    • #1 Example
      {
  "eventName": "D.ID.NS123456789.mremote.daemon.NS123456789",
  "data": {
    "method": "mremote",
    "joins": {
      "d1": 1
    }
  }
}

  • EMIT startMessageBusLog

    Start Message Bus Logging
    (Version 0.2.4 | admin User Permission needed)

    Operation IDstartMessageBusLog

    Available only on servers:

    • #MessageBus

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: startMessageBusLog

  • EMIT stopMessageBusLog

    Stop Message Bus Logging
    (Version 0.2.4 | admin User Permission needed)

    Operation IDstopMessageBusLog

    Available only on servers:

    • #MessageBus

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: stopMessageBusLog

  • EMIT addMieleDevice

    Add a Miele device as component
    (Version 0.2.71 | admin User Permission needed)

    Operation IDaddMieleDevice

    Available only on servers:

    • #Miele

    Accepts the following message:

    Message IDaddMieleDevicePayload

    Payload: Add a Miele device as component

    object

    Examples

    • #1 Example
      {
  "name": "Oven",
  "id": "1234567890",
  "mieleType": 12,
  "lid": "miele.oven",
  "profile": "miele_oven",
  "capabilities": [
    "miele_map_status",
    "miele_map_programid",
    "miele_map_programtype",
    "miele_map_programphase",
    "miele_map_targettemperature",
    "miele_map_temperature",
    "miele_map_remainingtime",
    "miele_map_starttime",
    "miele_map_elapsedtime",
    "miele_map_signalinfo",
    "miele_map_signalfailure",
    "miele_map_signaldoor",
    "miele_map_remoteenable"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addMieleDevice

  • EMIT getMieleDevicePrograms

    Get Miele device programs
    (Version 0.2.69)

    Operation IDgetMieleDevicePrograms

    Available only on servers:

    • #Miele

    Accepts the following message:

    Message IDgetMieleDeviceProgramsPayload

    Payload: Get Miele device programs

    object

    Examples

    • #1 Example
      {
  "cid": "C10"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getMieleDevicePrograms

  • EMIT getMieleDevices

    Get Miele devices
    (Version 0.2.53 | admin User Permission needed)

    Operation IDgetMieleDevices

    Available only on servers:

    • #Miele

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getMieleDevices

  • EMIT initMieleAuthorization

    Initialize Miele Authorization
    (Version 0.2.52 | admin User Permission needed)

    Operation IDinitMieleAuthorization

    Available only on servers:

    • #Miele

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: initMieleAuthorization

  • EVENT onMieleAuthorization

    Event on Miele Authorization
    (Version 0.2.52 | admin User Permission needed)

    Operation IDonMieleAuthorization

    Available only on servers:

    • #Miele

    Accepts the following message:

    Message IDonMieleAuthorizationEvent

    Event Update on Miele Authorization

    Payload
    boolean

    Examples

    • #1 Example

      true

  • EMIT auth

    If User Password Authorization is enabled, this function has to be used to authorize the Client.
    (Version 0.2.76)

    Operation IDauth

    Available only on servers:

    • #Miscellaneous

    Accepts the following message:

    Message IDauthPayload

    Payload: If User Password Authorization is enabled, this function has to be used to authorize the Client.

    object

    Examples

    • #1 Example
      {
  "username": "Test",
  "password": "password1234"
}
    • #2 Example - Example (Persistent)
      {
  "username": "Test",
  "password": "password1234",
  "persistent": true
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: auth

  • EMIT getProductProfile

    Get Product Profile of the System
    (Version 0.3.11)

    Operation IDgetProductProfile

    Available only on servers:

    • #Miscellaneous

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getProductProfile

  • EMIT getVersion

    Get Version Information
    (Version 0.1.8)

    Operation IDgetVersion

    Available only on servers:

    • #Miscellaneous

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getVersion

  • EMIT init

    Client/Socket Initialization Function
    (Version 0.2.21)

    Operation IDinit

    Available only on servers:

    • #Miscellaneous

    Accepts the following message:

    Message IDinitPayload

    Payload: Client/Socket Initialization Function

    object

    Examples

    • #1 Example - Browser Example
      {
  "language": "en",
  "uagent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) AppleWebKit/600.8.9 (KHTML, like Gecko) Version/8.0.8 Safari/600.8.9"
}
    • #2 Example - App Example
      {
  "language": "en",
  "appVersion": "1.0.1",
  "appId": "com.nomos-system.testapp",
  "appName": "nomos TestApp",
  "osVersion": "17.6.1",
  "platform": "iOS",
  "model": "iPhone6,1",
  "name": "My iPhone",
  "did": "1E4F8745-BBBB-40DA-1F7A-2CDAC92BBBBB",
  "token": "098765432109876543210987654321098765432109876543210987654321"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: init

  • EMIT logout

    If Authorization is enabled, this function can be used to destroy the session.
    (Version 0.2.0)

    Operation IDlogout

    Available only on servers:

    • #Miscellaneous

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: logout

  • EMIT addMonitoring

    Add a Monitoring
    (Version 0.3.10 | admin User Permission needed)

    Operation IDaddMonitoring

    Available only on servers:

    • #Monitoring

    Accepts the following message:

    Message IDaddMonitoringPayload

    Payload: Add a Monitoring

    object

    Examples

    • #1 Example
      {
  "name": "First Monitoring",
  "enabled": true,
  "timespan": 5,
  "timespanType": "m",
  "includedComponents": [
    "--ALL--"
  ],
  "excludedComponents": [
    "C1"
  ],
  "emails": [
    "test@nomos-system.com"
  ],
  "pushs": []
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addMonitoring

  • EMIT getMonitoringLog

    Get Data Log for a particular Monitoring
    (Version 0.3.10 | admin User Permission needed)

    Operation IDgetMonitoringLog

    Available only on servers:

    • #Monitoring

    Accepts the following message:

    Message IDgetMonitoringLogPayload

    Payload: Get Data Log for a particular Monitoring

    object

    Examples

    • #1 Example
      {
  "id": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getMonitoringLog

  • EMIT getMonitorings

    Get Monitorings
    (Version 0.3.10 | admin User Permission needed)

    Operation IDgetMonitorings

    Available only on servers:

    • #Monitoring

    Accepts the following message:

    Message IDgetMonitoringsPayload

    Payload: Get Monitorings

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getMonitorings

  • EVENT onMonitoringAdded

    Event Update when a new Monitoring has been added
    (Version 0.3.10 | admin User Permission needed)

    Operation IDonMonitoringAdded

    Available only on servers:

    • #Monitoring

    Accepts the following message:

    Message IDonMonitoringAddedEvent

    Event Update when a new Monitoring has been added

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1,
  "name": "First Monitoring",
  "enabled": true,
  "timespan": 5,
  "timespanType": "m",
  "includedComponents": [
    "--ALL--"
  ],
  "excludedComponents": [
    "C1"
  ],
  "emails": [
    "test@nomos-system.com"
  ],
  "pushs": []
}

  • EVENT onMonitoringRemoved

    Event Update when a Monitoring has been removed
    (Version 0.3.10 | admin User Permission needed)

    Operation IDonMonitoringRemoved

    Available only on servers:

    • #Monitoring

    Accepts the following message:

    Message IDonMonitoringRemovedEvent

    Event Update when a Monitoring has been removed

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1
}

  • EVENT onMonitoringUpdate

    Event Update when a Monitoring has been updated
    (Version 0.3.10 | admin User Permission needed)

    Operation IDonMonitoringUpdate

    Available only on servers:

    • #Monitoring

    Accepts the following message:

    Message IDonMonitoringUpdateEvent

    Event Update when a Monitoring has been updated

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1
}

  • EMIT removeMonitoring

    Remove a Monitoring
    (Version 0.3.10 | admin User Permission needed)

    Operation IDremoveMonitoring

    Available only on servers:

    • #Monitoring

    Accepts the following message:

    Message IDremoveMonitoringPayload

    Payload: Remove a Monitoring

    object

    Examples

    • #1 Example
      {
  "id": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeMonitoring

  • EMIT setMonitoring

    Set/Update a Monitoring
    (Version 0.3.10 | admin User Permission needed)

    Operation IDsetMonitoring

    Available only on servers:

    • #Monitoring

    Accepts the following message:

    Message IDsetMonitoringPayload

    Payload: Set/Update a Monitoring

    object

    Examples

    • #1 Example
      {
  "id": 1,
  "name": "First Monitoring",
  "enabled": true,
  "timespan": 5,
  "timespanType": "m",
  "includedComponents": [
    "--ALL--"
  ],
  "excludedComponents": [
    "C1"
  ],
  "emails": [
    "test@nomos-system.com"
  ],
  "pushs": []
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setMonitoring

  • EMIT addNetatmoDevice

    Add a Netatmo module as component
    (Version 0.2.71 | admin User Permission needed)

    Operation IDaddNetatmoDevice

    Available only on servers:

    • #Netatmo

    Accepts the following message:

    Message IDaddNetatmoDevicePayload

    Payload: Add a Netatmo module as component

    object

    Examples

    • #1 Example
      {
  "name": "Weatherstation",
  "id": "70:ee:e2:e2:e2:e2",
  "type": "NAMain",
  "lid": "netatmo.NAMain",
  "profile": "netatmo_NAMain",
  "capabilities": []
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addNetatmoDevice

  • EMIT getNetatmoDevices

    Get Netatmo devices
    (Version 0.2.4 | admin User Permission needed)

    Operation IDgetNetatmoDevices

    Available only on servers:

    • #Netatmo

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getNetatmoDevices

  • EMIT getNetatmoUser

    Get Netatmo user
    (Version 0.2.4 | admin User Permission needed)

    Operation IDgetNetatmoUser

    Available only on servers:

    • #Netatmo

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getNetatmoUser

  • EMIT initNetatmoAuthorization

    Initialize Netatmo Authorization
    (Version 0.2.68 | admin User Permission needed)

    Operation IDinitNetatmoAuthorization

    Available only on servers:

    • #Netatmo

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: initNetatmoAuthorization

  • EVENT onNetatmoAuthorization

    Event on Netatmo Authorization
    (Version 0.2.68 | admin User Permission needed)

    Operation IDonNetatmoAuthorization

    Available only on servers:

    • #Netatmo

    Accepts the following message:

    Message IDonNetatmoAuthorizationEvent

    Event Update on Netatmo Authorization

    Payload
    boolean

    Examples

    • #1 Example

      true

  • EMIT getNetworkConfig

    Get Network Configuration
    (Version 0.3.11 | admin User Permission needed)

    Operation IDgetNetworkConfig

    Available only on servers:

    • #Network

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getNetworkConfig

  • EMIT getSSIDs

    Get SSID's List
    (Version 0.1.8 | admin User Permission needed)

    Operation IDgetSSIDs

    Available only on servers:

    • #Network

    Accepts the following message:

    Message IDgetSSIDsPayload

    Payload: Get SSID's List

    object

    Examples

    • #1 Example
      {
  "interface": "wlan0"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSSIDs

  • EMIT getSecurityBridgeProfiles

    Get Security Bridge Profiles
    (Version 0.3.11 | admin User Permission needed)

    Operation IDgetSecurityBridgeProfiles

    Available only on servers:

    • #Network

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSecurityBridgeProfiles

  • EMIT setNetworkConfig

    Set Network Configuration (system does reboot)
    (Version 0.3.11 | admin User Permission needed)

    Operation IDsetNetworkConfig

    Available only on servers:

    • #Network

    Accepts the following message:

    Message IDsetNetworkConfigPayload

    Payload: Set Network Configuration (system does reboot)

    object

    Examples

    • #1 Example - DHCP Example
      {
  "interfaces": [
    {
      "interface": "eth0",
      "dhcp": true
    }
  ],
  "hostname": "nomos",
  "nameserver": [
    "127.0.0.1",
    "192.168.1.1"
  ]
}
    • #2 Example - Static IP Example
      {
  "interfaces": [
    {
      "interface": "eth0",
      "ipv4_address": "192.168.1.112",
      "ipv4_subnet_mask": "255.255.255.0",
      "ipv4_gateway": "192.168.1.1",
      "dhcp": false
    }
  ],
  "hostname": "nomos",
  "nameserver": [
    "127.0.0.1",
    "192.168.1.1"
  ]
}
    • #3 Example - Bridge Example
      {
  "interfaces": [
    {
      "interface": "eth0",
      "dhcp": true
    },
    {
      "interface": "eth1",
      "dhcp": true
    }
  ],
  "bridge": {
    "enabled": true,
    "dhcp": true,
    "profiles": [
      "universal"
    ]
  },
  "hostname": "nomos",
  "nameserver": [
    "127.0.0.1",
    "192.168.1.1"
  ]
}
    • #4 Example - Wireless Example
      {
  "interfaces": [
    {
      "interface": "wlan0",
      "ssid": "HOME_WLAN",
      "psk": "MyPresharedKey",
      "dhcp": true
    }
  ],
  "hostname": "nomos",
  "nameserver": [
    "127.0.0.1",
    "192.168.1.1"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setNetworkConfig

  • EMIT setNetworkHostname

    Set Network Hostname
    (Version 0.2.11 | admin User Permission needed)

    Operation IDsetNetworkHostname

    Available only on servers:

    • #Network

    Accepts the following message:

    Message IDsetNetworkHostnamePayload

    Payload: Set Network Hostname

    object

    Examples

    • #1 Example
      {
  "name": "nomos"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setNetworkHostname

  • EMIT testInternetConnection

    Test Network/Internet Connection
    (Version 0.2.51 | admin User Permission needed)

    Operation IDtestInternetConnection

    Available only on servers:

    • #Network

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: testInternetConnection

  • EMIT resetNodeRed

    Resets Node-RED configuration
    (Version 0.2.64 | admin User Permission needed)

    Operation IDresetNodeRed

    Available only on servers:

    • #NodeRED

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: resetNodeRed

  • EMIT restartNodeRed

    Restart Node-RED service
    DEPRECATED use restartService instead)
    (Version 0.2.64 | admin User Permission needed)

    Operation IDrestartNodeRed

    Available only on servers:

    • #NodeRED

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: restartNodeRed

  • EMIT addNotificationProfile

    Add a Notification Profile
    (Version 0.2.75 | admin User Permission needed)

    Operation IDaddNotificationProfile

    Available only on servers:

    • #NotificationProfile

    Accepts the following message:

    Message IDaddNotificationProfilePayload

    Payload: Add a Notification Profile

    object

    Examples

    • #1 Example
      {
  "name": "Motion Alarm",
  "description": "Motion Alarm",
  "alertType": "motion",
  "enabled": false,
  "internal": {
    "text": "Motion Alarm in %1"
  },
  "push": {
    "text": "Motion Alarm in %1",
    "sound": "beep-02",
    "badge": 1
  },
  "email": {
    "subject": "Motion Alarm in %1",
    "text": "Motion Alarm in %1",
    "receiver": [
      "test@nomos-system.com"
    ]
  },
  "position": 5
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addNotificationProfile

  • EMIT disableNotificationProfile

    Disable a Notification Profile
    (Version 0.1.8 | admin User Permission needed)

    Operation IDdisableNotificationProfile

    Available only on servers:

    • #NotificationProfile

    Accepts the following message:

    Message IDdisableNotificationProfilePayload

    Payload: Disable a Notification Profile

    object

    Examples

    • #1 Example
      {
  "name": "test"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: disableNotificationProfile

  • EMIT enableNotificationProfile

    Enable a Notification Profile
    (Version 0.1.8 | admin User Permission needed)

    Operation IDenableNotificationProfile

    Available only on servers:

    • #NotificationProfile

    Accepts the following message:

    Message IDenableNotificationProfilePayload

    Payload: Enable a Notification Profile

    object

    Examples

    • #1 Example
      {
  "name": "test"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: enableNotificationProfile

  • EMIT getNotificationProfiles

    Get all Notification Profiles
    (Version 0.2.75 | admin User Permission needed)

    Operation IDgetNotificationProfiles

    Available only on servers:

    • #NotificationProfile

    Accepts the following message:

    Message IDgetNotificationProfilesPayload

    Payload: Get all Notification Profiles

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getNotificationProfiles

  • EMIT removeNotificationProfile

    Remove a Notification Profile
    (Version 0.1.9 | admin User Permission needed)

    Operation IDremoveNotificationProfile

    Available only on servers:

    • #NotificationProfile

    Accepts the following message:

    Message IDremoveNotificationProfilePayload

    Payload: Remove a Notification Profile

    object

    Examples

    • #1 Example
      {
  "name": "test"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeNotificationProfile

  • EMIT resetSystemNotificationProfiles

    Reset all System Notification Profiles to Factory Default
    (Version 0.1.8 | admin User Permission needed)

    Operation IDresetSystemNotificationProfiles

    Available only on servers:

    • #NotificationProfile

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: resetSystemNotificationProfiles

  • EMIT setNotificationPosition

    Set a new Notification Position. To avoid weird sorting it is best to update all notifications as once.
    (Version 0.2.13 | admin User Permission needed)

    Operation IDsetNotificationPosition

    Available only on servers:

    • #NotificationProfile

    Accepts the following message:

    Message IDsetNotificationPositionPayload

    Payload: Set a new Notification Position. To avoid weird sorting it is best to update all notifications as once.

    object

    Examples

    • #1 Example
      {
  "name": "d93c0b30-b7aa-4d7a-e9d5-c45c4f0974c5",
  "position": 7
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setNotificationPosition

  • EMIT setNotificationProfile

    Set/Update a Notification Profile
    (Version 0.2.75 | admin User Permission needed)

    Operation IDsetNotificationProfile

    Available only on servers:

    • #NotificationProfile

    Accepts the following message:

    Message IDsetNotificationProfilePayload

    Payload: Set/Update a Notification Profile

    object

    Examples

    • #1 Example
      {
  "name": "Motion Alarm",
  "description": "Motion Alarm",
  "alertType": "motion",
  "enabled": false,
  "position": 5,
  "internal": {
    "text": "Motion Alarm in %1"
  },
  "push": {
    "text": "Motion Alarm in %1",
    "sound": "beep-02",
    "badge": 1
  },
  "email": {
    "subject": "Motion Alarm in %1",
    "text": "Motion Alarm in %1",
    "receiver": [
      "test@nomos-system.com"
    ]
  }
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setNotificationProfile

  • EMIT confirmNotification

    Confirm a (internal) Notification out of the List/History
    (Version 0.2.79 | admin User Permission needed)

    Operation IDconfirmNotification

    Available only on servers:

    • #Notification

    Accepts the following message:

    Message IDconfirmNotificationPayload

    Payload: Confirm a (internal) Notification out of the List/History

    object

    Examples

    • #1 Example
      {
  "id": "c0f1db78f6036eff9911b388564fc481"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: confirmNotification

  • EMIT getNotificationContent

    Get a Notification Image/Video Content
    (Version 0.3.8 | admin User Permission needed)

    Operation IDgetNotificationContent

    Available only on servers:

    • #Notification

    Accepts the following message:

    Message IDgetNotificationContentPayload

    Payload: Get a Notification Image/Video Content

    object

    Examples

    • #1 Example
      {
  "name": "c0f1db78f6036eff9911b388564fc481.jpeg"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getNotificationContent

  • EMIT getNotifications

    Get (internal) Notification List/History. When no range start or stop parameters are submitted the result is all notifications.
    (Version 0.3.8)

    Operation IDgetNotifications

    Available only on servers:

    • #Notification

    Accepts the following message:

    Message IDgetNotificationsPayload

    Payload: Get (internal) Notification List/History. When no range start or stop parameters are submitted the result is all notifications.

    object

    Examples

    • #1 Example - Example 1
      {
  "rangeStop": 10
}
    • #2 Example - Example 2
      {
  "rangeStart": 10,
  "rangeStop": 20
}
    • #3 Example - Example 3
      {
  "priority": 1
}
    • #4 Example - Sorting
      {
  "sortBy": [
    "-timestamp",
    "priority"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getNotifications

  • EVENT onNotification

    Event Update when a new Log Notification arrives
    (Version 0.3.3 | admin User Permission needed)

    Operation IDonNotification

    Available only on servers:

    • #Notification

    Accepts the following message:

    Message IDonNotificationEvent

    Event Update when a new Log Notification arrives

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": "c0f1db78f6036eff9911b388564fc481",
  "timestamp": "Wed Sep 23 2015 13:08:13 GMT+0200 (CEST)",
  "name": "Example!",
  "text": "Notification Example!",
  "priority": 1,
  "profile": "default",
  "link": {}
}

  • EVENT onNotificationConfirmed

    Event Update when a new Log Notification has been confirmed
    (Version 0.2.79 | admin User Permission needed)

    Operation IDonNotificationConfirmed

    Available only on servers:

    • #Notification

    Accepts the following message:

    Message IDonNotificationConfirmedEvent

    Event Update when a new Log Notification has been confirmed

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": "c0f1db78f6036eff9911b388564fc481"
}

  • EVENT onNotificationRemoved

    Event Update when a new Log Notification has been removed
    (Version 0.2.79 | admin User Permission needed)

    Operation IDonNotificationRemoved

    Available only on servers:

    • #Notification

    Accepts the following message:

    Message IDonNotificationRemovedEvent

    Event Update when a new Log Notification has been removed

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": "c0f1db78f6036eff9911b388564fc481"
}

  • EMIT removeAllNotifications

    Remove/clear (internal) Notifications List/History
    (Version 0.1.8)

    Operation IDremoveAllNotifications

    Available only on servers:

    • #Notification

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeAllNotifications

  • EMIT removeNotification

    Remove a (internal) Notification out of the List/History
    (Version 0.1.8)

    Operation IDremoveNotification

    Available only on servers:

    • #Notification

    Accepts the following message:

    Message IDremoveNotificationPayload

    Payload: Remove a (internal) Notification out of the List/History

    object

    Examples

    • #1 Example
      {
  "id": "c0f1db78f6036eff9911b388564fc481"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeNotification

  • EMIT sendNotification

    Send a Notification
    (Version 0.2.78 | admin User Permission needed)

    Operation IDsendNotification

    Available only on servers:

    • #Notification

    Accepts the following message:

    Message IDsendNotificationPayload

    Payload: Send a Notification

    object

    Examples

    • #1 Example - Profile Example 1
      {
  "profile": "battery"
}
    • #2 Example - Profile Example 2
      {
  "profile": [
    "battery"
  ],
  "variables": [
    "MultiSensor"
  ]
}
    • #3 Example - Complex Example
      {
  "internal": {
    "text": "The Temperature is %1",
    "priority": 2
  },
  "email": {
    "subject": "The Temperature is %1",
    "text": "The Temperature is %1",
    "receiver": "test@nomos-system.com",
    "attachment": "http://192.168.1.3/videostream.cgi?user=&pwd="
  },
  "push": {
    "text": "The Temperature is %1",
    "sound": "sound-02",
    "badge": 36,
    "channel": "ch3"
  },
  "variables": [
    "36.4 Degrees"
  ]
}
    • #4 Example - Log Example with Linkage
      {
  "internal": {
    "text": "The Temperature is too high",
    "priority": 3,
    "link": {
      "cid": "C1"
    }
  }
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: sendNotification

  • EMIT addNukiDevice

    Add a Nuki Device/Component
    (Version 0.2.71 | admin User Permission needed)

    Operation IDaddNukiDevice

    Available only on servers:

    • #Nuki

    Accepts the following message:

    Message IDaddNukiDevicePayload

    Payload: Add a Nuki Device/Component

    object

    Examples

    • #1 Example
      {
  "name": "Nuki",
  "id": "123456789",
  "lid": "nuki.bridge",
  "profile": "nuki_bridge",
  "capabilities": []
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addNukiDevice

  • EMIT authenticateNukiBridge

    Authenticate a Nuki Bridge
    (Version 0.2.71 | admin User Permission needed)

    Operation IDauthenticateNukiBridge

    Available only on servers:

    • #Nuki

    Accepts the following message:

    Message IDauthenticateNukiBridgePayload

    Payload: Authenticate a Nuki Bridge

    object

    Examples

    • #1 Example
      {
  "id": "123456789"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: authenticateNukiBridge

  • EMIT getNukiDevices

    Get (autodetected) Nuki Devices/Components
    (Version 0.2.71 | admin User Permission needed)

    Operation IDgetNukiDevices

    Available only on servers:

    • #Nuki

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getNukiDevices

  • EMIT getUserGroupPermission

    Get User Group Permission
    (Version 0.2.64)

    Operation IDgetUserGroupPermission

    Available only on servers:

    • #Permissions

    Accepts the following message:

    Message IDgetUserGroupPermissionPayload

    Payload: Get User Group Permission

    object

    Examples

    • #1 Example
      {
  "usergroup": "user"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getUserGroupPermission

  • EMIT getUserPermission

    Get User Permission
    (Version 0.2.64)

    Operation IDgetUserPermission

    Available only on servers:

    • #Permissions

    Accepts the following message:

    Message IDgetUserPermissionPayload

    Payload: Get User Permission

    object

    Examples

    • #1 Example
      {
  "uid": 3
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getUserPermission

  • EMIT setUserGroupPermission

    Set/Update User Group Permission
    (Version 0.2.64 | admin User Permission needed)

    Operation IDsetUserGroupPermission

    Available only on servers:

    • #Permissions

    Accepts the following message:

    Message IDsetUserGroupPermissionPayload

    Payload: Set/Update User Group Permission

    object

    Examples

    • #1 Example - Example (Add)
      {
  "usergroup": "user",
  "name": "pushNotification",
  "value": "full"
}
    • #2 Example - Example (Remove)
      {
  "usergroup": "user",
  "name": "pushNotification",
  "value": null
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setUserGroupPermission

  • EMIT setUserPermission

    Set/Update User Permission
    (Version 0.2.64 | admin User Permission needed)

    Operation IDsetUserPermission

    Available only on servers:

    • #Permissions

    Accepts the following message:

    Message IDsetUserPermissionPayload

    Payload: Set/Update User Permission

    object

    Examples

    • #1 Example - Example (Add)
      {
  "uid": 3,
  "name": "pushNotification",
  "value": "full"
}
    • #2 Example - Example (Remove)
      {
  "uid": 3,
  "name": "pushNotification",
  "value": null
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setUserPermission

  • EMIT addHUELight

    Add a HUE Light or Group
    (Version 0.2.71 | admin User Permission needed)

    Operation IDaddHUELight

    Available only on servers:

    • #PhilipsHUE

    Accepts the following message:

    Message IDaddHUELightPayload

    Payload: Add a HUE Light or Group

    object

    Examples

    • #1 Example - Example (Light)
      {
  "name": "Kitchen Light",
  "id": 1,
  "lid": "hue.light",
  "profile": "philips_hue",
  "capabilities": []
}
    • #2 Example - Example (Group)
      {
  "name": "Kitchen",
  "id": "G_1",
  "lid": "hue.group",
  "profile": "philips_hue_group",
  "capabilities": []
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addHUELight

  • EMIT createHUEGroup

    Create a HUE Light Group
    (Version 0.2.71 | admin User Permission needed)

    Operation IDcreateHUEGroup

    Available only on servers:

    • #PhilipsHUE

    Accepts the following message:

    Message IDcreateHUEGroupPayload

    Payload: Create a HUE Light Group

    object

    Examples

    • #1 Example
      {
  "name": "G1",
  "light-ids": [
    1,
    2
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: createHUEGroup

  • EMIT getHUEDevices

    Get (autodetected) HUE Devices/Controllers/Bridges with Pairing State
    (Version 0.2.71 | admin User Permission needed)

    Operation IDgetHUEDevices

    Available only on servers:

    • #PhilipsHUE

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getHUEDevices

  • EMIT getHUEGroups

    Get (autodetected) HUE Light Groups
    (Version 0.2.71 | admin User Permission needed)

    Operation IDgetHUEGroups

    Available only on servers:

    • #PhilipsHUE

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getHUEGroups

  • EMIT getHUELights

    Get (autodetected) HUE Lights
    (Version 0.2.71 | admin User Permission needed)

    Operation IDgetHUELights

    Available only on servers:

    • #PhilipsHUE

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getHUELights

  • EVENT hueStateChange

    Event Update when Philips Hue Status Change is triggered
    (Version 0.2.71 | admin User Permission needed)

    Operation IDhueStateChange

    Available only on servers:

    • #PhilipsHUE

    Accepts the following message:

    Message IDhueStateChangeEvent

    Event Update when Philips Hue Status Event is triggered

    object

    Examples

    • #1 Example - Response
      {
  "name": "Philips hue bridge 2012",
  "serial": "001788123456",
  "status": "active",
  "ip": "192.168.1.108"
}

  • EMIT identifyHUE

    Identify a HUE Light
    (Version 0.2.71 | admin User Permission needed)

    Operation IDidentifyHUE

    Available only on servers:

    • #PhilipsHUE

    Accepts the following message:

    Message IDidentifyHUEPayload

    Payload: Identify a HUE Light

    object

    Examples

    • #1 Example
      {
  "id": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: identifyHUE

  • EMIT removeHUEGroup

    Removes a HUE Light Group
    (Version 0.2.71 | admin User Permission needed)

    Operation IDremoveHUEGroup

    Available only on servers:

    • #PhilipsHUE

    Accepts the following message:

    Message IDremoveHUEGroupPayload

    Payload: Removes a HUE Light Group

    object

    Examples

    • #1 Example
      {
  "name": "G1"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeHUEGroup

  • EMIT addPingDevice

    Add a Ping device as component
    (Version 0.2.55 | admin User Permission needed)

    Operation IDaddPingDevice

    Available only on servers:

    • #Ping

    Accepts the following message:

    Message IDaddPingDevicePayload

    Payload: Add a Ping device as component

    object

    Examples

    • #1 Example
      {
  "name": "Router",
  "pingHost": "192.168.0.1",
  "pingInterval": 15,
  "pingTimeout": 200
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addPingDevice

  • EMIT removePingDevice

    Remove/unlink a Ping device
    (Version 0.2.55 | admin User Permission needed)

    Operation IDremovePingDevice

    Available only on servers:

    • #Ping

    Accepts the following message:

    Message IDremovePingDevicePayload

    Payload: Remove/unlink a Ping device

    object

    Examples

    • #1 Example
      {
  "cid": "C2"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removePingDevice

  • EMIT setPingDevice

    Set/update a Ping device or link Ping with existing component
    (Version 0.2.55 | admin User Permission needed)

    Operation IDsetPingDevice

    Available only on servers:

    • #Ping

    Accepts the following message:

    Message IDsetPingDevicePayload

    Payload: Set/update a Ping device or link Ping with existing component

    object

    Examples

    • #1 Example
      {
  "cid": "C2",
  "name": "Router",
  "pingHost": "192.168.0.1",
  "pingInterval": 15,
  "pingTimeout": 200
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setPingDevice

  • EMIT disableProfile

    Disable a Profile
    (Version 0.2.76 | admin User Permission needed)

    Operation IDdisableProfile

    Available only on servers:

    • #Profiles

    Accepts the following message:

    Message IDdisableProfilePayload

    Payload: Disable a Profile

    object

    Examples

    • #1 Example
      {
  "name": "sonos"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: disableProfile

  • EMIT enableProfile

    Enable a Profile
    (Version 0.2.76 | admin User Permission needed)

    Operation IDenableProfile

    Available only on servers:

    • #Profiles

    Accepts the following message:

    Message IDenableProfilePayload

    Payload: Enable a Profile

    object

    Examples

    • #1 Example
      {
  "name": "sonos"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: enableProfile

  • EMIT getProfileMeta

    Get Profile Meta Data
    (Version 0.2.76)

    Operation IDgetProfileMeta

    Available only on servers:

    • #Profiles

    Accepts the following message:

    Message IDgetProfileMetaPayload

    Payload: Get Profile Meta Data

    object

    Examples

    • #1 Example
      {
  "name": "sonos"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getProfileMeta

  • EMIT setProfileMeta

    Set Profile Meta Data
    (Version 0.2.76 | admin User Permission needed)

    Operation IDsetProfileMeta

    Available only on servers:

    • #Profiles

    Accepts the following message:

    Message IDsetProfileMetaPayload

    Payload: Set Profile Meta Data

    object

    Examples

    • #1 Example - Example (Sonos)
      {
  "name": "sonos",
  "enabled": true,
  "debug": true
}
    • #2 Example - Example (Hue)
      {
  "name": "hue",
  "enabled": true
}
    • #3 Example - Example (KNX)
      {
  "name": "knx",
  "connectionType": "ROUTING",
  "multicast_ip": "AUTO",
  "physaddr": "1.1.254",
  "addrForm": 3,
  "enabled": true
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setProfileMeta

  • EMIT getProperty

    Get Property Information
    (Version 0.1.9)

    Operation IDgetProperty

    Available only on servers:

    • #Property

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getProperty

  • EMIT getPropertyName

    Get Property Name
    (Version 0.1.8)

    Operation IDgetPropertyName

    Available only on servers:

    • #Property

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getPropertyName

  • EVENT onPropertyNameChange

    Event Update when Property Name has been changed
    (Version 0.1.8 | admin User Permission needed)

    Operation IDonPropertyNameChange

    Available only on servers:

    • #Property

    Accepts the following message:

    Message IDonPropertyNameChangeEvent

    Event Update when Property Name has been changed

    Payload
    string

    Examples

    • #1 Example

      My Home

  • EMIT setProperty

    Set/Update Property
    (Version 0.1.9 | admin User Permission needed)

    Operation IDsetProperty

    Available only on servers:

    • #Property

    Accepts the following message:

    Message IDsetPropertyPayload

    Payload: Set/Update Property

    object

    Examples

    • #1 Example
      {
  "name": "My Home",
  "country": "CH"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setProperty

  • EMIT setPropertyName

    Set Property Name
    (Version 0.1.8 | admin User Permission needed)

    Operation IDsetPropertyName

    Available only on servers:

    • #Property

    Accepts the following message:

    Message IDsetPropertyNamePayload

    Payload: Set Property Name

    object

    Examples

    • #1 Example
      {
  "name": "My Home"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setPropertyName

  • EMIT Import-Room-Image

    SocketIOFileUpload Import Room Image with the Help of SocketIOFileUpload Library (see SocketIOFileUpload for more Information)
    (Version 0.3.8 | admin User Permission needed)

    Operation IDImport-Room-Image

    Available only on servers:

    • #Rooms

    Accepts the following message:

    Message IDImport-Room-ImagePayload

    Payload: Import Room Image with the Help of SocketIOFileUpload Library (see SocketIOFileUpload for more Information)

    object

    Examples

    • #1 Example
      var uploader = new SocketIOFileUpload(socket);
uploader.listenOnInput(document.getElementById("imageImportInput"));
uploader.addEventListener('error', function(data) {
  if(data.code === 1) {
    console.log("File size error");
  }
});
uploader.addEventListener('progress', function(event) {
  console.log(parseInt(event.bytesLoaded / event.file.size * 100) + '%');
});
uploader.addEventListener('complete', function(event) {
  if(event.detail.error === false) {
    // Success
    window.location.reload();
  } else {
    // Error
  }
});
uploader.addEventListener('start', function(event) {
  event.file.meta.id = room.id;
  event.file.meta.subid = 'test'; // optional
  event.file.meta.type = 'roomimage';
});
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: Import-Room-Image

  • EMIT addRoom

    Add a Room
    (Version 0.2.71 | admin User Permission needed)

    Operation IDaddRoom

    Available only on servers:

    • #Rooms

    Accepts the following message:

    Message IDaddRoomPayload

    Payload: Add a Room

    object

    Examples

    • #1 Example
      {
  "name": "Bath Room",
  "position": 3
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addRoom

  • EMIT attachRoom

    Attach a Room to a Floor
    (Version 0.2.60 | admin User Permission needed)

    Operation IDattachRoom

    Available only on servers:

    • #Rooms

    Accepts the following message:

    Message IDattachRoomPayload

    Payload: Attach a Room to a Floor

    object

    Examples

    • #1 Example
      {
  "id": 5,
  "floor": 1,
  "meta": {
    "x": 234,
    "y": 567
  }
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: attachRoom

  • EMIT detachRoom

    Detach a Room from a Floor
    (Version 0.1.8 | admin User Permission needed)

    Operation IDdetachRoom

    Available only on servers:

    • #Rooms

    Accepts the following message:

    Message IDdetachRoomPayload

    Payload: Detach a Room from a Floor

    object

    Examples

    • #1 Example
      {
  "id": 5,
  "floor": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: detachRoom

  • EMIT getRoomImage

    Get Room Image
    (Version 0.3.8)

    Operation IDgetRoomImage

    Available only on servers:

    • #Rooms

    Accepts the following message:

    Message IDgetRoomImagePayload

    Payload: Get Room Image

    object

    Examples

    • #1 Example
      {
  "id": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getRoomImage

  • EMIT getRoomName

    Get Room Name
    (Version 0.2.60)

    Operation IDgetRoomName

    Available only on servers:

    • #Rooms

    Accepts the following message:

    Message IDgetRoomNamePayload

    Payload: Get Room Name

    object

    Examples

    • #1 Example
      {
  "id": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getRoomName

  • EMIT getRooms

    Get Rooms
    (Version 0.3.8)

    Operation IDgetRooms

    Available only on servers:

    • #Rooms

    Accepts the following message:

    Message IDgetRoomsPayload

    Payload: Get Rooms

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getRooms

  • EVENT onRoomAdded

    Event Update when a new Room has been added
    (Version 0.2.71 | admin User Permission needed)

    Operation IDonRoomAdded

    Available only on servers:

    • #Rooms

    Accepts the following message:

    Message IDonRoomAddedEvent

    Event Update when a new Room has been added

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 5,
  "name": "Bath Room",
  "position": 3,
  "readonly": false
}

  • EVENT onRoomAttached

    Event Update when a Room has been attached to a Floor
    (Version 0.1.8 | admin User Permission needed)

    Operation IDonRoomAttached

    Available only on servers:

    • #Rooms

    Accepts the following message:

    Message IDonRoomAttachedEvent

    Event Update when a Room has been attached to a Floor

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1,
  "floor": 2
}

  • EVENT onRoomDetached

    Event Update when a Room has been detached from a Floor
    (Version 0.1.8 | admin User Permission needed)

    Operation IDonRoomDetached

    Available only on servers:

    • #Rooms

    Accepts the following message:

    Message IDonRoomAttachedEvent

    Event Update when a Room has been detached from a Floor

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1,
  "floor": 2
}

  • EVENT onRoomImageUpload

    Event Update when a Room Image has been uploaded
    (Version 0.3.8 | admin User Permission needed)

    Operation IDonRoomImageUpload

    Available only on servers:

    • #Rooms

    Accepts the following message:

    Message IDonRoomImageUploadEvent

    Event Update when a Room Image has been uploaded

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1,
  "subid": "default"
}

  • EVENT onRoomNameChange

    Event Update when a Room Name has been changed
    (Version 0.1.8 | admin User Permission needed)

    Operation IDonRoomNameChange

    Available only on servers:

    • #Rooms

    Accepts the following message:

    Message IDonRoomNameChangeEvent

    Event Update when a Room Name has been changed

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1,
  "name": "Living Room"
}

  • EVENT onRoomRemoved

    Event Update when a Room has been removed
    (Version 0.1.8 | admin User Permission needed)

    Operation IDonRoomRemoved

    Available only on servers:

    • #Rooms

    Accepts the following message:

    Message IDonRoomRemovedEvent

    Event Update when a Room has been removed

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 5
}

  • EVENT onRoomUpdate

    Event Update when a Room has been updated
    (Version 0.2.71 | admin User Permission needed)

    Operation IDonRoomUpdate

    Available only on servers:

    • #Rooms

    Accepts the following message:

    Message IDonRoomUpdateEvent

    Event Update when a Room has been updated

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1
}

  • EMIT removeRoom

    Remove a Room
    (Version 0.2.3 | admin User Permission needed)

    Operation IDremoveRoom

    Available only on servers:

    • #Rooms

    Accepts the following message:

    Message IDremoveRoomPayload

    Payload: Remove a Room

    object

    Examples

    • #1 Example
      {
  "id": 5
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeRoom

  • EMIT removeRoomImage

    Remove a Room image
    (Version 0.3.8 | admin User Permission needed)

    Operation IDremoveRoomImage

    Available only on servers:

    • #Rooms

    Accepts the following message:

    Message IDremoveRoomImagePayload

    Payload: Remove a Room image

    object

    Examples

    • #1 Example
      {
  "id": 3
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeRoomImage

  • EMIT setRoom

    Set/Update a Room
    (Version 0.2.71 | admin User Permission needed)

    Operation IDsetRoom

    Available only on servers:

    • #Rooms

    Accepts the following message:

    Message IDsetRoomPayload

    Payload: Set/Update a Room

    object

    Examples

    • #1 Example
      {
  "id": 1,
  "name": "Living Room",
  "position": 5
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setRoom

  • EMIT setRoomName

    Set Room Name
    (Version 0.2.0 | admin User Permission needed)

    Operation IDsetRoomName

    Available only on servers:

    • #Rooms

    Accepts the following message:

    Message IDsetRoomNamePayload

    Payload: Set Room Name

    object

    Examples

    • #1 Example
      {
  "id": 1,
  "name": "Living Room"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setRoomName

  • EMIT addSIPClient

    Add a SIP Client
    (Version 0.2.80 | admin User Permission needed)

    Operation IDaddSIPClient

    Available only on servers:

    • #SIP

    Accepts the following message:

    Message IDaddSIPClientPayload

    Payload: Add a SIP Client

    object

    Examples

    • #1 Example
      {
  "name": "Test",
  "server": "wss://sip.example.com",
  "aor": "sip:alice@example.com",
  "userAgentOptions": {
    "authorizationUsername": "username",
    "authorizationPassword": "passwd"
  },
  "cid": [
    "C1"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addSIPClient

  • EMIT getSIPClients

    Get SIP Client List
    (Version 0.2.80)

    Operation IDgetSIPClients

    Available only on servers:

    • #SIP

    Accepts the following message:

    Message IDgetSIPClientsPayload

    Payload: Get SIP Client List

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSIPClients

  • EMIT getSIPClientsByUser

    Get SIP Client List by User ID
    (Version 0.2.80 | admin User Permission needed)

    Operation IDgetSIPClientsByUser

    Available only on servers:

    • #SIP

    Accepts the following message:

    Message IDgetSIPClientsByUserPayload

    Payload: Get SIP Client List by User ID

    object

    Examples

    • #1 Example
      {
  "uid": 1
}
    • #2 Example - Sorting
      {
  "uid": 1,
  "sortBy": [
    "name"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSIPClientsByUser

  • EVENT onSIPClientAdded

    Event Update when a new SIP Client has been added
    (Version 0.2.80 | admin User Permission needed)

    Operation IDonSIPClientAdded

    Available only on servers:

    • #SIP

    Accepts the following message:

    Message IDonSIPClientAddedEvent

    Event Update when a new SIP Client has been added

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1,
  "enabled": true,
  "uid": 0,
  "name": "Test",
  "server": "wss://sip.example.com",
  "aor": "sip:alice@example.com"
}

  • EVENT onSIPClientRemoved

    Event Update when a SIP Client has been removed
    (Version 0.2.80 | admin User Permission needed)

    Operation IDonSIPClientRemoved

    Available only on servers:

    • #SIP

    Accepts the following message:

    Message IDonSIPClientRemovedEvent

    Event Update when a SIP Client has been removed

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1
}

  • EVENT onSIPClientUpdated

    Event Update when a SIP Client has been updated
    (Version 0.2.80 | admin User Permission needed)

    Operation IDonSIPClientUpdated

    Available only on servers:

    • #SIP

    Accepts the following message:

    Message IDonSIPClientUpdatedEvent

    Event Update when a SIP Client has been updated

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1
}

  • EMIT removeSIPClient

    Remove a SIP Client
    (Version 0.2.80 | admin User Permission needed)

    Operation IDremoveSIPClient

    Available only on servers:

    • #SIP

    Accepts the following message:

    Message IDremoveSIPClientPayload

    Payload: Remove a SIP Client

    object

    Examples

    • #1 Example
      {
  "id": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeSIPClient

  • EMIT setSIPClient

    Set/Update a SIP Client
    (Version 0.2.80 | admin User Permission needed)

    Operation IDsetSIPClient

    Available only on servers:

    • #SIP

    Accepts the following message:

    Message IDsetSIPClientPayload

    Payload: Set/Update a SIP Client

    object

    Examples

    • #1 Example
      {
  "id": 1,
  "uid": 1,
  "enabled": true,
  "name": "Test",
  "server": "wss://sip.example.com",
  "aor": "sip:alice@example.com",
  "userAgentOptions": {
    "authorizationUsername": "username",
    "authorizationPassword": "passwd"
  },
  "cid": [
    "C1"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setSIPClient

  • EMIT addScene

    Add a Scene
    (Version 0.2.47 | admin User Permission needed)

    Operation IDaddScene

    Available only on servers:

    • #Scenes

    Accepts the following message:

    Message IDaddScenePayload

    Payload: Add a Scene

    object

    Examples

    • #1 Example
      {
  "name": "Coming Home",
  "enabled": true,
  "hapEnabled": true,
  "hidden": false,
  "position": 4,
  "actions": [
    {
      "cid": "C2",
      "property": "switchon"
    },
    {
      "cid": "C3",
      "property": "level",
      "value": "50"
    }
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addScene

  • EMIT cloneScene

    Clone/duplicate a Scene
    (Version 0.2.43 | admin User Permission needed)

    Operation IDcloneScene

    Available only on servers:

    • #Scenes

    Accepts the following message:

    Message IDcloneScenePayload

    Payload: Clone/duplicate a Scene

    object

    Examples

    • #1 Example
      {
  "id": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: cloneScene

  • EMIT disableScene

    Disable a Scene
    (Version 0.1.9 | admin User Permission needed)

    Operation IDdisableScene

    Available only on servers:

    • #Scenes

    Accepts the following message:

    Message IDdisableScenePayload

    Payload: Disable a Scene

    object

    Examples

    • #1 Example
      {
  "id": 2
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: disableScene

  • EMIT enableScene

    Enable a Scene
    (Version 0.1.9 | admin User Permission needed)

    Operation IDenableScene

    Available only on servers:

    • #Scenes

    Accepts the following message:

    Message IDenableScenePayload

    Payload: Enable a Scene

    object

    Examples

    • #1 Example
      {
  "id": 2
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: enableScene

  • EMIT executeScene

    Execute a Scene. The callback is returning when the complete scene is finished. This can take a while.
    (Version 0.1.8)

    Operation IDexecuteScene

    Available only on servers:

    • #Scenes

    Accepts the following message:

    Message IDexecuteScenePayload

    Payload: Execute a Scene. The callback is returning when the complete scene is finished. This can take a while.

    object

    Examples

    • #1 Example
      {
  "id": 4
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: executeScene

  • EMIT getScene

    Get a Scene
    (Version 0.2.65 | admin User Permission needed)

    Operation IDgetScene

    Available only on servers:

    • #Scenes

    Accepts the following message:

    Message IDgetScenePayload

    Payload: Get a Scene

    object

    Examples

    • #1 Example
      {
  "id": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getScene

  • EMIT getScenes

    Get All Scenes
    (Version 0.2.47)

    Operation IDgetScenes

    Available only on servers:

    • #Scenes

    Accepts the following message:

    Message IDgetScenesPayload

    Payload: Get All Scenes

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getScenes

  • EMIT hideScene

    Hide a Scene
    (Version 0.2.41 | admin User Permission needed)

    Operation IDhideScene

    Available only on servers:

    • #Scenes

    Accepts the following message:

    Message IDhideScenePayload

    Payload: Hide a Scene

    object

    Examples

    • #1 Example
      {
  "id": 2,
  "hidden": true
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: hideScene

  • EMIT lockScene

    Lock Scene to prevent unwanted changes
    (Version 0.2.45 | admin User Permission needed)

    Operation IDlockScene

    Available only on servers:

    • #Scenes

    Accepts the following message:

    Message IDlockScenePayload

    Payload: Lock Scene to prevent unwanted changes

    object

    Examples

    • #1 Example
      {
  "id": 3
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: lockScene

  • EVENT onSceneAdded

    Event Update when a new Scene has been added
    (Version 0.1.8 | admin User Permission needed)

    Operation IDonSceneAdded

    Available only on servers:

    • #Scenes

    Accepts the following message:

    Message IDonSceneAddedEvent

    Event Update when a new Scene has been added

    object

    Examples

    • #1 Example
      {
  "id": 3,
  "name": "Coming Home"
}

  • EVENT onSceneFinished

    Event Update when a Scene has been finished
    (Version 0.2.56 | admin User Permission needed)

    Operation IDonSceneFinished

    Available only on servers:

    • #Scenes

    Accepts the following message:

    Message IDonSceneFinishedEvent

    Event Update when a Scene has been finished

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1
}

  • EVENT onSceneNameChange

    Event Update when a Scene Name has been changed
    (Version 0.2.0 | admin User Permission needed)

    Operation IDonSceneNameChange

    Available only on servers:

    • #Scenes

    Accepts the following message:

    Message IDonSceneNameChangeEvent

    Event Update when a Scene Name has been changed

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 3,
  "name": "Test-Scene"
}

  • EVENT onScenePositionChange

    Event Update when a Scene Position has been changed
    (Version 0.2.46 | admin User Permission needed)

    Operation IDonScenePositionChange

    Available only on servers:

    • #Scenes

    Accepts the following message:

    Message IDonScenePositionChangeEvent

    Event Update when a Scene Position has been changed

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 3,
  "position": 10
}

  • EVENT onSceneRemoved

    Event Update when a Scene has been removed
    (Version 0.1.8 | admin User Permission needed)

    Operation IDonSceneRemoved

    Available only on servers:

    • #Scenes

    Accepts the following message:

    Message IDonSceneRemovedEvent

    Event Update when a Scene has been removed

    object

    Examples

    • #1 Example
      {
  "id": 2
}

  • EVENT onSceneTriggered

    Event Update when a Scene got triggered
    (Version 0.2.41 | admin User Permission needed)

    Operation IDonSceneTriggered

    Available only on servers:

    • #Scenes

    Accepts the following message:

    Message IDonSceneTriggeredEvent

    Event Update when a Scene got triggered

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 1,
  "stats": {
    "minute": 1,
    "hour": 2,
    "day": 3,
    "week": 3,
    "month": 3,
    "year": 3
  }
}

  • EVENT onSceneUpdated

    Event Update when a Scene has been updated
    (Version 0.2.47 | admin User Permission needed)

    Operation IDonSceneUpdated

    Available only on servers:

    • #Scenes

    Accepts the following message:

    Message IDonSceneUpdatedEvent

    Event Update when a Scene has been updated

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": 3
}

  • EMIT removeScene

    Remove a Scene
    (Version 0.2.45 | admin User Permission needed)

    Operation IDremoveScene

    Available only on servers:

    • #Scenes

    Accepts the following message:

    Message IDremoveScenePayload

    Payload: Remove a Scene

    object

    Examples

    • #1 Example
      {
  "id": 2
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeScene

  • EMIT setScene

    Set/Update a Scene
    (Version 0.2.47 | admin User Permission needed)

    Operation IDsetScene

    Available only on servers:

    • #Scenes

    Accepts the following message:

    Message IDsetScenePayload

    Payload: Set/Update a Scene

    object

    Examples

    • #1 Example
      {
  "id": 3,
  "name": "Coming Home",
  "enabled": false,
  "hapEnabled": false,
  "hidden": false,
  "position": 4,
  "actions": [
    {
      "cid": "C2",
      "property": "switchon"
    },
    {
      "cid": "C3",
      "property": "level",
      "value": "50"
    }
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setScene

  • EMIT setSceneName

    Set a new Scene Name
    (Version 0.2.45 | admin User Permission needed)

    Operation IDsetSceneName

    Available only on servers:

    • #Scenes

    Accepts the following message:

    Message IDsetSceneNamePayload

    Payload: Set a new Scene Name

    object

    Examples

    • #1 Example
      {
  "id": 3,
  "name": "Test-Scene"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setSceneName

  • EMIT setScenePosition

    Set a new Scene Position. To avoid weird sorting it is best to update all scenes as once.
    (Version 0.2.13 | admin User Permission needed)

    Operation IDsetScenePosition

    Available only on servers:

    • #Scenes

    Accepts the following message:

    Message IDsetScenePositionPayload

    Payload: Set a new Scene Position. To avoid weird sorting it is best to update all scenes as once.

    object

    Examples

    • #1 Example
      {
  "id": 3,
  "position": 7
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setScenePosition

  • EMIT unlockScene

    Unlock Scene
    (Version 0.2.45 | admin User Permission needed)

    Operation IDunlockScene

    Available only on servers:

    • #Scenes

    Accepts the following message:

    Message IDunlockScenePayload

    Payload: Unlock Scene

    object

    Examples

    • #1 Example
      {
  "id": 3
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: unlockScene

  • EVENT engineLogUpdate

    Event Update when new Engine/Daemon Log Entries are coming in
    (Version 0.1.8 | admin User Permission needed)

    Operation IDengineLogUpdate

    Available only on servers:

    • #Scripting

    Accepts the following message:

    Message IDengineLogUpdateEvent

    Event Update when new Engine/Daemon Log Entries are coming in

    Payload
    string

    Log

    Examples

    • #1 Example - Response

      07:02:47.932 - system: reading path: /root/nomos/projects/nomos/misc

  • EMIT executeEngineCommand

    Execute Daemon/Engine Command
    (Version 0.1.8 | admin User Permission needed)

    Operation IDexecuteEngineCommand

    Available only on servers:

    • #Scripting

    Accepts the following message:

    Message IDexecuteEngineCommandPayload

    Payload: Execute Daemon/Engine Command

    object

    Examples

    • #1 Example
      {
  "syntax": "<SYS><HELLO></SYS>"
}
    • #2 Example - Example (Multiple)
      {
  "syntax": [
    "<SYS><HELLO></SYS>",
    "<KNX><SETVALUE=1/1/1,0></KNX>"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: executeEngineCommand

  • EMIT flushExecuteCommandsHistory

    Flush complete Engine/Daemon Bookmark/History
    (Version 0.1.8 | admin User Permission needed)

    Operation IDflushExecuteCommandsHistory

    Available only on servers:

    • #Scripting

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: flushExecuteCommandsHistory

  • EMIT getExecuteCommandsHistory

    Get Engine/Daemon Executed Bookmark/History
    (Version 0.1.8 | admin User Permission needed)

    Operation IDgetExecuteCommandsHistory

    Available only on servers:

    • #Scripting

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getExecuteCommandsHistory

  • EMIT removeExecuteCommandsHistoryEntry

    Remove a Command Entry out of Engine/Daemon Bookmark/History
    (Version 0.1.8 | admin User Permission needed)

    Operation IDremoveExecuteCommandsHistoryEntry

    Available only on servers:

    • #Scripting

    Accepts the following message:

    Message IDremoveExecuteCommandsHistoryEntryPayload

    Payload: Remove a Command Entry out of Engine/Daemon Bookmark/History

    object

    Examples

    • #1 Example
      {
  "syntax": "<SYS><HELLO></SYS>"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeExecuteCommandsHistoryEntry

  • EMIT startEngineLogging

    Start Engine/Daemon Logging
    (Version 0.1.8 | admin User Permission needed)

    Operation IDstartEngineLogging

    Available only on servers:

    • #Scripting

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: startEngineLogging

  • EMIT stopEngineLogging

    Stop Engine/Daemon Logging
    (Version 0.1.8 | admin User Permission needed)

    Operation IDstopEngineLogging

    Available only on servers:

    • #Scripting

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: stopEngineLogging

  • EMIT getSecurityAutoReport

    Get System Security Auto Report Settings
    (Version 0.3.10 | admin User Permission needed)

    Operation IDgetSecurityAutoReport

    Available only on servers:

    • #Security

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSecurityAutoReport

  • EMIT getSecurityIssues

    Get System Security Issues
    (Version 0.3.10 | admin User Permission needed)

    Operation IDgetSecurityIssues

    Available only on servers:

    • #Security

    Accepts the following message:

    Message IDgetSecurityIssuesPayload

    Payload: Get System Security Issues

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "id"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSecurityIssues

  • EMIT setSecurityAutoReport

    Set System Security Auto Report Settings
    (Version 0.3.10 | admin User Permission needed)

    Operation IDsetSecurityAutoReport

    Available only on servers:

    • #Security

    Accepts the following message:

    Message IDsetSecurityAutoReportPayload

    Payload: Set System Security Auto Report Settings

    object

    Examples

    • #1 Example
      {
  "enabled": true,
  "interval": "w",
  "weekdays": [
    6
  ],
  "day": 1,
  "time": "2:00",
  "emails": [
    "test@nomos-system.com"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setSecurityAutoReport

  • EMIT setSomfyRegion

    Set Somfy Region
    (Version 0.3.12 | admin User Permission needed)

    Operation IDsetSomfyRegion

    Available only on servers:

    • #Somfy

    Accepts the following message:

    Message IDsetSomfyRegionPayload

    Payload: Set Somfy Region

    object

    Examples

    • #1 Example - Europe, Middle East and Africa
      {
  "region": 0
}
    • #2 Example - Asia and Pacific
      {
  "region": 1
}
    • #3 Example - North America
      {
  "region": 2
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setSomfyRegion

  • EMIT getSomfyRegion

    Get Somfy Region
    (Version 0.3.12 | admin User Permission needed)

    Operation IDgetSomfyRegion

    Available only on servers:

    • #Somfy

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSomfyRegion

  • EMIT authorizeSomfyGateway

    Authorize a Somfy Gateway
    (Version 0.3.12 | admin User Permission needed)

    Operation IDauthorizeSomfyGateway

    Available only on servers:

    • #Somfy

    Accepts the following message:

    Message IDauthorizeSomfyGatewayPayload

    Payload: Authorize a Somfy Gateway

    object

    Examples

    • #1 Example
      {
  "username": "test@nomos-system.com",
  "password": "password",
  "id": "1234-1234-1234"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: authorizeSomfyGateway

  • EMIT detectSomfyGateways

    Get/find all Somfy Gateway Devices in local network
    (Version 0.3.12 | admin User Permission needed)

    Operation IDdetectSomfyGateways

    Available only on servers:

    • #Somfy

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: detectSomfyGateways

  • EMIT getSomfyGateways

    Get added Somfy Gateway(s)
    (Version 0.3.12 | admin User Permission needed)

    Operation IDgetSomfyGateways

    Available only on servers:

    • #Somfy

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSomfyGateways

  • EMIT removeSomfyGateway

    Remove a Somfy Gateway
    (Version 0.3.12 | admin User Permission needed)

    Operation IDremoveSomfyGateway

    Available only on servers:

    • #Somfy

    Accepts the following message:

    Message IDremoveSomfyGatewayPayload

    Payload: Remove a Somfy Gateway

    object

    Examples

    • #1 Example
      {
  "id": "1234-1234-1234"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeSomfyGateway

  • EMIT getSomfyDevices

    Get available Somfy Devices of a Gateway
    (Version 0.3.12 | admin User Permission needed)

    Operation IDgetSomfyDevices

    Available only on servers:

    • #Somfy

    Accepts the following message:

    Message IDgetSomfyDevicesPayload

    Payload: Get available Somfy Devices of a Gateway

    object

    Examples

    • #1 Example
      {
  "id": "1234-1234-1234"
}
    • #2 Example - Sorting
      {
  "id": "1234-1234-1234",
  "sortBy": [
    "name"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSomfyDevices

  • EMIT addSomfyDevice

    Add a Somfy device as component
    (Version 0.2.71 | admin User Permission needed)

    Operation IDaddSomfyDevice

    Available only on servers:

    • #Somfy

    Accepts the following message:

    Message IDaddSomfyDevicePayload

    Payload: Add a Somfy device as component

    object

    Examples

    • #1 Example
      {
  "name": "LED",
  "id": "io://1234-1234-1234/12345678",
  "gateway": "1234-1234-1234",
  "lid": "somfy.light",
  "profile": "somfy_light",
  "capabilities": [
    "somfy_base",
    "somfy_get_onoff",
    "somfy_set_onoff"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addSomfyDevice

  • EMIT identifySomfyDevice

    Identify/Ping Somfy Device
    (Version 0.3.12 | admin User Permission needed)

    Operation IDidentifySomfyDevice

    Available only on servers:

    • #Somfy

    Accepts the following message:

    Message IDidentifySomfyDevicePayload

    Payload: Identify/Ping Somfy Device

    object

    Examples

    • #1 Example - Example
      {
  "id": "io://1234-1234-1234/12345678",
  "gateway": "1234-1234-1234"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: identifySomfyDevice

  • EMIT addSonosDevice

    Add a Sonos Device/Component
    (Version 0.2.71 | admin User Permission needed)

    Operation IDaddSonosDevice

    Available only on servers:

    • #Sonos

    Accepts the following message:

    Message IDaddSonosDevicePayload

    Payload: Add a Sonos Device/Component

    object

    Examples

    • #1 Example
      {
  "name": "Sonos Office",
  "host": "192.168.1.72",
  "uuid": "uuid-xxxxxxyyyyyyyyzzzzz",
  "lid": "sonos.default",
  "profile": "sonos",
  "model": "Sonos PLAY:3",
  "capabilities": []
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addSonosDevice

  • EMIT getSonosDevices

    Get (autodetected) Sonos Devices/Components
    (Version 0.2.71 | admin User Permission needed)

    Operation IDgetSonosDevices

    Available only on servers:

    • #Sonos

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSonosDevices

  • EMIT addSpotifyDevice

    Add a Spotify device as component
    (Version 0.2.71 | admin User Permission needed)

    Operation IDaddSpotifyDevice

    Available only on servers:

    • #Spotify

    Accepts the following message:

    Message IDaddSpotifyDevicePayload

    Payload: Add a Spotify device as component

    object

    Examples

    • #1 Example
      {
  "id": "123456789012345678901234567890",
  "name": "Living Room",
  "lid": "spotify.device",
  "profile": "spotify_device",
  "capabilities": []
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addSpotifyDevice

  • EMIT getSpotifyDevices

    Get Spotify devices
    (Version 0.2.70 | admin User Permission needed)

    Operation IDgetSpotifyDevices

    Available only on servers:

    • #Spotify

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSpotifyDevices

  • EMIT initSpotifyAuthorization

    Initialize Spotify Authorization
    (Version 0.2.70 | admin User Permission needed)

    Operation IDinitSpotifyAuthorization

    Available only on servers:

    • #Spotify

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: initSpotifyAuthorization

  • EVENT onSpotifyAuthorization

    Event on Spotify Authorization
    (Version 0.2.70 | admin User Permission needed)

    Operation IDonSpotifyAuthorization

    Available only on servers:

    • #Spotify

    Accepts the following message:

    Message IDonSpotifyAuthorizationEvent

    Event Update on Spotify Authorization

    Payload
    boolean

    Examples

    • #1 Example

      true

  • EMIT storageDel

    Delete a userdefined value from system's database
    (Version 0.1.8)

    Operation IDstorageDel

    Available only on servers:

    • #Storage

    Accepts the following message:

    Message IDstorageDelPayload

    Payload: Delete a userdefined value from system's database

    object

    Examples

    • #1 Example
      {
  "key": "testKey"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: storageDel

  • EMIT storageGet

    Get a userdefined value from system's database
    (Version 0.1.8)

    Operation IDstorageGet

    Available only on servers:

    • #Storage

    Accepts the following message:

    Message IDstorageGetPayload

    Payload: Get a userdefined value from system's database

    object

    Examples

    • #1 Example
      {
  "key": "testKey"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: storageGet

  • EMIT storageSet

    Store userdefined value(s) in system's database
    (Version 0.1.8)

    Operation IDstorageSet

    Available only on servers:

    • #Storage

    Accepts the following message:

    Message IDstorageSetPayload

    Payload: Store userdefined value(s) in system's database

    object

    Examples

    • #1 Example
      {
  "key": "testKey",
  "value": "testValue"
}
    • #2 Example - Example (Multiple Values)
      {
  "key": "testKey",
  "value": {
    "value1": "testValue1",
    "value2": "testValue2"
  }
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: storageSet

  • EMIT addPortForwarding

    Add a Port Forwarding Rule
    (Version 0.3.6 | admin User Permission needed)

    Operation IDaddPortForwarding

    Available only on servers:

    • #Support_VPN

    Accepts the following message:

    Message IDaddPortForwardingPayload

    Payload: Add a Port Forwarding Rule

    object

    Examples

    • #1 Example
      {
  "name": "HTTP Forwarding Rule",
  "type": "TCP",
  "localPort": 8088,
  "remoteHost": "192.168.1.200",
  "remotePort": 80
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addPortForwarding

  • EMIT disableSupportVPN

    Disable Support VPN
    (Version 0.1.8 | admin User Permission needed)

    Operation IDdisableSupportVPN

    Available only on servers:

    • #Support_VPN

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: disableSupportVPN

  • EMIT enableSupportVPN

    Enable Support VPN
    (Version 0.1.8 | admin User Permission needed)

    Operation IDenableSupportVPN

    Available only on servers:

    • #Support_VPN

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: enableSupportVPN

  • EMIT getPortForwardings

    Get Support Port Forwardings
    (Version 0.3.6 | admin User Permission needed)

    Operation IDgetPortForwardings

    Available only on servers:

    • #Support_VPN

    Accepts the following message:

    Message IDgetPortForwardingsPayload

    Payload: Get Support Port Forwardings

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getPortForwardings

  • EMIT getSupportVPNInfo

    Get Support VPN Information/Configuration
    (Version 0.2.47)

    Operation IDgetSupportVPNInfo

    Available only on servers:

    • #Support_VPN

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSupportVPNInfo

  • EMIT removePortForwarding

    Remove a Port Forwarding Rule
    (Version 0.2.37 | admin User Permission needed)

    Operation IDremovePortForwarding

    Available only on servers:

    • #Support_VPN

    Accepts the following message:

    Message IDremovePortForwardingPayload

    Payload: Remove a Port Forwarding Rule

    object

    Examples

    • #1 Example
      {
  "id": 2
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removePortForwarding

  • EMIT setPortForwarding

    Set/Update a Port Forwarding Rule
    (Version 0.3.6 | admin User Permission needed)

    Operation IDsetPortForwarding

    Available only on servers:

    • #Support_VPN

    Accepts the following message:

    Message IDsetPortForwardingPayload

    Payload: Set/Update a Port Forwarding Rule

    object

    Examples

    • #1 Example
      {
  "id": 2,
  "name": "Disabled HTTP Forwarding Rule",
  "enabled": false
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setPortForwarding

  • EMIT enableSystemDebug

    Enable System Debug Logging
    (Version 0.3.14 | admin User Permission needed)

    Operation IDenableSystemDebug

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: enableSystemDebug

  • EMIT disableSystemDebug

    Disable System Debug Logging
    (Version 0.3.14 | admin User Permission needed)

    Operation IDdisableSystemDebug

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: disableSystemDebug

  • EMIT getSystemDebugLog

    Get System Debug Log
    (Version 0.3.14 | admin User Permission needed)

    Operation IDgetSystemDebugLog

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDgetSystemDebugLogPayload

    Payload: Get System Debug Log

    object

    Examples

    • #1 Example
      {
  "filter": [
    "app",
    "system"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSystemDebugLog

  • EMIT Upload-Update

    SocketIOFileUpload Upload a Update with the Help of SocketIOFileUpload Library (see SocketIOFileUpload for more Information)
    (Version 0.2.40 | admin User Permission needed)

    Operation IDUpload-Update

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDUpload-UpdatePayload

    Payload: Upload a Update with the Help of SocketIOFileUpload Library (see SocketIOFileUpload for more Information)

    object

    Examples

    • #1 Example
      var uploader = new SocketIOFileUpload(socket);
uploader.listenOnInput(document.getElementById("logoUploadInput"));
uploader.addEventListener('error', function(data) {
  if(data.code === 1) {
    console.log("File size error");
  }
});
uploader.addEventListener('progress', function(event) {
  console.log(parseInt(event.bytesLoaded / event.file.size * 100) + '%');
});
uploader.addEventListener('complete', function(event) {
  if(event.detail.error === false) {
    // Success
    window.location.reload();
  } else {
    // Error
  }
});
uploader.addEventListener('start', function(event) {
  event.file.meta.type = 'update';
});
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: Upload-Update

  • EMIT addSystemVariable

    Set a System Variable
    (Version 0.2.84 | admin User Permission needed)

    Operation IDaddSystemVariable

    Available only on servers:

    • #SystemVariables

    Accepts the following message:

    Message IDaddSystemVariablePayload

    Payload: Set a System Variable

    object

    Examples

    • #1 Example
      {
  "name": "myName",
  "category": "myCategory",
  "value": "myValue",
  "defaultValue": "myDefaultValue",
  "type": "string"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addSystemVariable

  • EMIT getSystemVariable

    Get System Variable
    (Version 0.2.84 | admin User Permission needed)

    Operation IDgetSystemVariable

    Available only on servers:

    • #SystemVariables

    Accepts the following message:

    Message IDgetSystemVariablePayload

    Payload: Get System Variable

    object

    Examples

    • #1 Example
      {
  "id": "VARIABLE_2"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSystemVariable

  • EMIT getSystemVariableValue

    Get current System Variable Value
    (Version 0.2.51 | admin User Permission needed)

    Operation IDgetSystemVariableValue

    Available only on servers:

    • #SystemVariables

    Accepts the following message:

    Message IDgetSystemVariableValuePayload

    Payload: Get current System Variable Value

    object

    Examples

    • #1 Example
      {
  "id": "VARIABLE_2"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSystemVariableValue

  • EMIT getSystemVariables

    Get System Variables
    (Version 0.2.84 | admin User Permission needed)

    Operation IDgetSystemVariables

    Available only on servers:

    • #SystemVariables

    Accepts the following message:

    Message IDgetSystemVariablesPayload

    Payload: Get System Variables

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSystemVariables

  • EVENT onSystemVariableAdded

    Event Update when a new System Variable has been added
    (Version 0.2.84 | admin User Permission needed)

    Operation IDonSystemVariableAdded

    Available only on servers:

    • #SystemVariables

    Accepts the following message:

    Message IDonSystemVariableAddedEvent

    Event Update when a new System Variable has been added

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": "VARIABLE_2",
  "name": "myNewName",
  "category": "myCategory",
  "editable": false,
  "defaultValue": "myValue",
  "type": "string"
}

  • EVENT onSystemVariableNameChange

    Event Update when a System Variable Name has been changed
    (Version 0.2.35 | admin User Permission needed)

    Operation IDonSystemVariableNameChange

    Available only on servers:

    • #SystemVariables

    Accepts the following message:

    Message IDonSystemVariableNameChangeEvent

    Event Update when a System Variable Name has been changed

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": "VARIABLE_2",
  "name": "myNewName"
}

  • EVENT onSystemVariableRemoved

    Event Update when a System Variable has been removed
    (Version 0.2.35 | admin User Permission needed)

    Operation IDonSystemVariableRemoved

    Available only on servers:

    • #SystemVariables

    Accepts the following message:

    Message IDonSystemVariableRemovedEvent

    Event Update when a System Variable has been removed

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": "VARIABLE_2"
}

  • EVENT onSystemVariableUpdated

    Event Update when a System Variable has been updated
    (Version 0.2.51 | admin User Permission needed)

    Operation IDonSystemVariableUpdated

    Available only on servers:

    • #SystemVariables

    Accepts the following message:

    Message IDonSystemVariableUpdatedEvent

    Event Update when a System Variable has been updated

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": "VARIABLE_2"
}

  • EMIT removeSystemVariable

    Remove a System Variable
    (Version 0.2.81 | admin User Permission needed)

    Operation IDremoveSystemVariable

    Available only on servers:

    • #SystemVariables

    Accepts the following message:

    Message IDremoveSystemVariablePayload

    Payload: Remove a System Variable

    object

    Examples

    • #1 Example
      {
  "id": "VARIABLE_2"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeSystemVariable

  • EMIT setSystemVariable

    Set/Update a System Variable
    (Version 0.2.84 | admin User Permission needed)

    Operation IDsetSystemVariable

    Available only on servers:

    • #SystemVariables

    Accepts the following message:

    Message IDsetSystemVariablePayload

    Payload: Set/Update a System Variable

    object

    Examples

    • #1 Example
      {
  "id": "VARIABLE_2",
  "name": "myNewName",
  "value": "myNewValue",
  "defaultValue": "myNewDefaultValue"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setSystemVariable

  • EMIT callImportedUpdate

    Call/Execute imported Update
    (Version 0.2.40 | admin User Permission needed)

    Operation IDcallImportedUpdate

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: callImportedUpdate

  • EMIT disableAutoSoftwareUpdate

    Disable Automatic Software Updates
    (Version 0.2.56 | admin User Permission needed)

    Operation IDdisableAutoSoftwareUpdate

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: disableAutoSoftwareUpdate

  • EMIT disableEmergencyMode

    Disable Emergency Mode
    (Version 0.3.4 | admin User Permission needed)

    Operation IDdisableEmergencyMode

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: disableEmergencyMode

  • EMIT downloadSoftResetDocument

    Download Soft Reset Document
    (Version 0.2.75 | admin User Permission needed)

    Operation IDdownloadSoftResetDocument

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: downloadSoftResetDocument

  • EMIT emailSoftResetDocument

    E-Mail Soft Reset Document
    (Version 0.2.75 | admin User Permission needed)

    Operation IDemailSoftResetDocument

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemailSoftResetDocumentPayload

    Payload: E-Mail Soft Reset Document

    object

    Examples

    • #1 Example
      {
  "receiver": "test@nomos-system.com"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: emailSoftResetDocument

  • EMIT enableAutoSoftwareUpdate

    Enable Automatic Software Updates
    (Version 0.2.59 | admin User Permission needed)

    Operation IDenableAutoSoftwareUpdate

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDenableAutoSoftwareUpdatePayload

    Payload: Enable Automatic Software Updates

    object

    Examples

    {
  "weekday": "(0) Sunday",
  "start": "2:00",
  "end": "4:00"
}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: enableAutoSoftwareUpdate

  • EMIT factoryReset

    Reset System to factory settings
    (Version 0.2.32 | admin User Permission needed)

    Operation IDfactoryReset

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: factoryReset

  • EMIT getAutoSoftwareUpdateInfo

    Get Automatic Software Updates Info/Status
    (Version 0.2.59 | admin User Permission needed)

    Operation IDgetAutoSoftwareUpdateInfo

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getAutoSoftwareUpdateInfo

  • EMIT getCountries

    Get Countries
    (Version 0.2.3)

    Operation IDgetCountries

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getCountries

  • EMIT getFeatureFlag

    Get a System Feature Flag
    (Version 0.2.19)

    Operation IDgetFeatureFlag

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDgetFeatureFlagPayload

    Payload: Get a System Feature Flag

    object

    Examples

    • #1 Example
      {
  "name": "MyFeature"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getFeatureFlag

  • EMIT getImportedUpdateDetails

    Get Details of imported Update
    (Version 0.2.40 | admin User Permission needed)

    Operation IDgetImportedUpdateDetails

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getImportedUpdateDetails

  • EMIT getIntegratorInfo

    Get Integrator Contact Information
    (Version 0.2.68)

    Operation IDgetIntegratorInfo

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getIntegratorInfo

  • EMIT getOperatingSystemInfos

    Get Operating System Information
    (Version 0.1.8)

    Operation IDgetOperatingSystemInfos

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getOperatingSystemInfos

  • EMIT getOperatingSystemLoad

    Get Operating System Load
    (Version 0.2.51)

    Operation IDgetOperatingSystemLoad

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getOperatingSystemLoad

  • EMIT getSystemConfigured

    Check if the system is configured. Configured means the admin did the first time setup and provided country, timezone, etc.
    (Version 0.2.33)

    Operation IDgetSystemConfigured

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSystemConfigured

  • EMIT getSystemDateTime

    Get System Date and Time
    (Version 0.2.2)

    Operation IDgetSystemDateTime

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSystemDateTime

  • EMIT getSystemDetails

    HTTP GET Get System Details
    (Version 0.3.7)

    Operation IDgetSystemDetails

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSystemDetails

  • EMIT getSystemDiagnostic

    Get system diagnostic settings
    (Version 0.2.49)

    Operation IDgetSystemDiagnostic

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSystemDiagnostic

  • EMIT getSystemLanguage

    Get the system language. Which is used as default language.
    (Version 0.2.33)

    Operation IDgetSystemLanguage

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSystemLanguage

  • EMIT getSystemName

    Get System Name
    (Version 0.2.8)

    Operation IDgetSystemName

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSystemName

  • EMIT getSystemSerialPorts

    Get System Serial Ports
    (Version 0.2.19)

    Operation IDgetSystemSerialPorts

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSystemSerialPorts

  • EMIT getSystemTemperatures

    Get System Temperatures
    (Version 0.2.51)

    Operation IDgetSystemTemperatures

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSystemTemperatures

  • EMIT getSystemUnits

    Get System Units
    (Version 0.2.80)

    Operation IDgetSystemUnits

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSystemUnits

  • EMIT getSystemWeekStart

    Get System Week Start
    (Version 0.2.81 | admin User Permission needed)

    Operation IDgetSystemWeekStart

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSystemWeekStart

  • EMIT getSystemsList

    Get/find all other neighbour systems in local network
    (Version 0.2.48)

    Operation IDgetSystemsList

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDgetSystemsListPayload

    Payload: Get/find all other neighbour systems in local network

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getSystemsList

  • EMIT getTextTemplates

    Get Text Templates
    (Version 0.2.75 | admin User Permission needed)

    Operation IDgetTextTemplates

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getTextTemplates

  • EMIT getTimeZoneConfig

    Get Time Zone Configuration
    (Version 0.1.8)

    Operation IDgetTimeZoneConfig

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getTimeZoneConfig

  • EMIT installSoftwareUpdates

    Install Software Updates
    (Version 0.2.16 | admin User Permission needed)

    Operation IDinstallSoftwareUpdates

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: installSoftwareUpdates

  • EMIT isInEmergencyMode

    Is System in Emergency Mode
    (Version 0.3.4)

    Operation IDisInEmergencyMode

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: isInEmergencyMode

  • EMIT licenseUpdateCheck

    Check for License Updates
    (Version 0.2.47 | admin User Permission needed)

    Operation IDlicenseUpdateCheck

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: licenseUpdateCheck

  • EMIT migrateSystem

    Migrate system
    (Version 0.2.48 | admin User Permission needed)

    Operation IDmigrateSystem

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDmigrateSystemPayload

    Payload: Migrate system

    object

    Examples

    • #1 Example
      {
  "source": "192.168.1.30",
  "username": "admin",
  "password": "admin"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: migrateSystem

  • EMIT resetEmergencyMode

    Reset and restore to the settings before Emergency Mode
    (Version 0.3.4 | admin User Permission needed)

    Operation IDresetEmergencyMode

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: resetEmergencyMode

  • EMIT resetSystem

    Resets some of the configurations made by the user
    (Version 0.2.32 | admin User Permission needed)

    Operation IDresetSystem

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: resetSystem

  • EMIT restartService

    Restart System Service
    (Version 0.3.11 | admin User Permission needed)

    Operation IDrestartService

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDrestartServicePayload

    Payload: Restart System Service

    object

    Examples

    • #1 Example
      {
  "name": "backend"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: restartService

  • EMIT restartSystem

    Restart System
    (Version 0.2.6 | admin User Permission needed)

    Operation IDrestartSystem

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: restartSystem

  • EMIT setFeatureFlag

    Set/Update a System Feature Flag
    (Version 0.2.19 | admin User Permission needed)

    Operation IDsetFeatureFlag

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDsetFeatureFlagPayload

    Payload: Set/Update a System Feature Flag

    object

    Examples

    • #1 Example
      {
  "name": "MyFeature",
  "state": true
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setFeatureFlag

  • EMIT setIntegratorInfo

    Set Integrator Contact Information
    (Version 0.2.68 | admin User Permission needed)

    Operation IDsetIntegratorInfo

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDsetIntegratorInfoPayload

    Payload: Set Integrator Contact Information

    object

    Examples

    • #1 Example
      {
  "contact": "nomos system AG",
  "email": "example@example.com",
  "phone": "+41..."
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setIntegratorInfo

  • EMIT setSystemConfigured

    Set/Update if the system is configured
    (Version 0.2.33 | admin User Permission needed)

    Operation IDsetSystemConfigured

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDsetSystemConfiguredPayload

    Payload: Set/Update if the system is configured

    object

    Examples

    • #1 Example
      {
  "configured": true
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setSystemConfigured

  • EMIT setSystemDateTime

    Set System Date and Time
    (Version 0.2.51 | admin User Permission needed)

    Operation IDsetSystemDateTime

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDsetSystemDateTimePayload

    Payload: Set System Date and Time

    object

    Examples

    • #1 Example
      {
  "date": "2020-02-01",
  "time": "01:02:03"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setSystemDateTime

  • EMIT setSystemDiagnostic

    Set/Update system diagnostic settings
    (Version 0.2.49 | admin User Permission needed)

    Operation IDsetSystemDiagnostic

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDsetSystemDiagnosticPayload

    Payload: Set/Update system diagnostic settings

    object

    Examples

    • #1 Example
      {
  "usage": true,
  "crashReports": true
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setSystemDiagnostic

  • EMIT setSystemLanguage

    Set/Update the system language. Which is used as default language.
    (Version 0.2.33 | admin User Permission needed)

    Operation IDsetSystemLanguage

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDsetSystemLanguagePayload

    Payload: Set/Update the system language. Which is used as default language.

    object

    Examples

    • #1 Example
      {
  "language": "de"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setSystemLanguage

  • EMIT setSystemName

    Set/Update System Name
    (Version 0.2.8 | admin User Permission needed)

    Operation IDsetSystemName

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDsetSystemNamePayload

    Payload: Set/Update System Name

    object

    Examples

    • #1 Example
      {
  "name": "My System"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setSystemName

  • EMIT setSystemUnits

    Set/Update System Units
    (Version 0.2.80 | admin User Permission needed)

    Operation IDsetSystemUnits

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDsetSystemUnitsPayload

    Payload: Set/Update System Units

    object

    Examples

    • #1 Example
      {
  "metric": 0,
  "temperature": 0,
  "windspeed": 2,
  "pressure": 1,
  "currency": "CHF"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setSystemUnits

  • EMIT setSystemWeekStart

    Set System Week Start
    (Version 0.2.81 | admin User Permission needed)

    Operation IDsetSystemWeekStart

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDsetSystemWeekStartPayload

    Payload: Set System Week Start

    object

    Examples

    • #1 Example
      {
  "day": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setSystemWeekStart

  • EMIT setTextTemplates

    Set Text Templates
    (Version 0.2.75 | admin User Permission needed)

    Operation IDsetTextTemplates

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDsetTextTemplatesPayload

    Payload: Set Text Templates

    object

    Examples

    • #1 Example
      {
  "test": "Test Text Block"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setTextTemplates

  • EMIT setTimeZoneConfig

    Set Time Zone Configuration
    (Version 0.2.33 | admin User Permission needed)

    Operation IDsetTimeZoneConfig

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDsetTimeZoneConfigPayload

    Payload: Set Time Zone Configuration

    object

    Examples

    • #1 Example
      {
  "zone": "Europe/Vienna"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setTimeZoneConfig

  • EMIT softReset

    Soft Reset System
    (Version 0.3.0 | admin User Permission needed)

    Operation IDsoftReset

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDsoftResetPayload

    Payload: Soft Reset System

    object

    Examples

    • #1 Example
      {
  "adminPassword": "newPassword",
  "numberOfUsers": 3,
  "numberOfAdmins": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: softReset

  • EMIT softwareUpdateCheck

    Check for Software Updates
    (Version 0.2.42)

    Operation IDsoftwareUpdateCheck

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDsoftwareUpdateCheckPayload

    Payload: Check for Software Updates

    object

    Examples

    {
  "force": false
}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: softwareUpdateCheck

  • EVENT softwareUpdateProgress

    Event Update when Progress of System Update is changing
    (Version 0.1.8 | admin User Permission needed)

    Operation IDsoftwareUpdateProgress

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDsoftwareUpdateProgressEvent

    Event Update when Progress of System Update is changing

    object

    Examples

    • #1 Example
      {
  "part": "download",
  "text": "Downloading Package...",
  "percent": 75
}

  • EVENT stateChange

    Event on System/Engine Status Updates. Filter the updates by System ID before showing it to the UI.

    Parts:

    - app Application
    - cloud Cloud
    - engine Backend/Daemon
    - system System/Controller

    States:

    - Authorization needed for API: Password protection is turned on
    - User Authorization needed: User authentication is turned on
    - connected: Part is connected
    - disconnected: Part is disconnected
    - shutdown: Part is stopped
    - ready: Part is started and ready
    - reboot: System is rebooting

    (Version 0.2.71 | admin User Permission needed)

    Operation IDstateChange

    Available only on servers:

    • #System

    Accepts the following message:

    Message IDstateChangeEvent

    Event Update on System/Engine Status Updates. Filter the updates by System ID before showing it to the UI.

    object

    Examples

    • #1 Example - System Reboot Example
      {
  "part": "system",
  "state": "reboot"
}
    • #2 Example - System Hardware Switch Example
      {
  "part": "system/upper switch",
  "state": "1"
}
    • #3 Example - Engine Ready Example
      {
  "part": "engine",
  "state": "ready"
}
    • #4 Example - Cloud Connected Example
      {
  "part": "cloud",
  "state": "connected"
}
    • #5 Example - Password Auth needed Example
      {
  "part": "app",
  "state": "Authorization needed for API"
}
    • #6 Example - User Auth needed Example
      {
  "part": "app",
  "state": "User Authorization needed"
}

  • EMIT addTadoDevice

    Add a tado° zone as component
    (Version 0.2.71 | admin User Permission needed)

    Operation IDaddTadoDevice

    Available only on servers:

    • #Tado

    Accepts the following message:

    Message IDaddTadoDevicePayload

    Payload: Add a tado° zone as component

    object

    Examples

    • #1 Example
      {
  "name": "Bed Room",
  "homeId": 1234,
  "zoneId": 1,
  "type": "HEATING",
  "lid": "tado.heating",
  "profile": "tado_heating",
  "capabilities": []
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addTadoDevice

  • EMIT getTadoDevices

    Get tado° devices
    (Version 0.2.47 | admin User Permission needed)

    Operation IDgetTadoDevices

    Available only on servers:

    • #Tado

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getTadoDevices

  • EMIT initTadoAuthorization

    Initialize tado° Authorization
    (Version 0.2.29 | admin User Permission needed)

    Operation IDinitTadoAuthorization

    Available only on servers:

    • #Tado

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: initTadoAuthorization

  • EVENT onTadoAuthorization

    Event on tado° Authorization
    (Version 0.2.29 | admin User Permission needed)

    Operation IDonTadoAuthorization

    Available only on servers:

    • #Tado

    Accepts the following message:

    Message IDonTadoAuthorizationEvent

    Event Update on tado° Authorization

    Payload
    boolean

    Examples

    • #1 Example

      true

  • EMIT addTimer

    Add a Timer
    (Version 0.2.2 | admin User Permission needed)

    Operation IDaddTimer

    Available only on servers:

    • #Timers

    Accepts the following message:

    Message IDaddTimerPayload

    Payload: Add a Timer

    object

    Examples

    • #1 Example - Example 1
      {
  "name": "New Timer",
  "enabled": true,
  "position": 4,
  "timer": {
    "time": "11:30",
    "weekdays": [
      "MONDAY",
      "WEDNESDAY"
    ]
  },
  "actions": [
    {
      "cid": "C2",
      "property": "switchon"
    },
    {
      "cid": "C3",
      "property": "level",
      "value": "50"
    }
  ]
}
    • #2 Example - Example 2 (+/- 30min. Variance)
      {
  "name": "New Timer",
  "enabled": true,
  "timer": {
    "time": "20:30~00:30:00"
  },
  "actions": [
    {
      "cid": "C2",
      "property": "switchon"
    },
    {
      "cid": "C3",
      "property": "level",
      "value": "50"
    }
  ]
}
    • #3 Example - Example 3 (Sunrise + 30min.)
      {
  "name": "New Timer",
  "enabled": true,
  "timer": {
    "time": "SUNRISE+00:30:00",
    "weekdays": [
      "SUNDAY"
    ]
  },
  "actions": [
    {
      "cid": "C2",
      "property": "switchon"
    },
    {
      "cid": "C3",
      "property": "level",
      "value": "50"
    }
  ]
}
    • #4 Example - Example 4 (with Date)
      {
  "name": "New Timer",
  "enabled": true,
  "timer": {
    "date": "24.12.",
    "time": "SUNSET"
  },
  "actions": [
    {
      "cid": "C2",
      "property": "switchon"
    },
    {
      "cid": "C3",
      "property": "level",
      "value": "50"
    }
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addTimer

  • EMIT disableTimer

    Disable a Timer
    (Version 0.2.2 | admin User Permission needed)

    Operation IDdisableTimer

    Available only on servers:

    • #Timers

    Accepts the following message:

    Message IDdisableTimerPayload

    Payload: Disable a Timer

    object

    Examples

    • #1 Example
      {
  "id": "T2"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: disableTimer

  • EMIT enableTimer

    Enable a Timer
    (Version 0.2.2 | admin User Permission needed)

    Operation IDenableTimer

    Available only on servers:

    • #Timers

    Accepts the following message:

    Message IDenableTimerPayload

    Payload: Enable a Timer

    object

    Examples

    • #1 Example
      {
  "id": "T2"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: enableTimer

  • EMIT getTimers

    Get All Timers
    (Version 0.2.41 | admin User Permission needed)

    Operation IDgetTimers

    Available only on servers:

    • #Timers

    Accepts the following message:

    Message IDgetTimersPayload

    Payload: Get All Timers

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getTimers

  • EVENT onTimerTriggered

    Event Update when a Timer got triggered
    (Version 0.2.41 | admin User Permission needed)

    Operation IDonTimerTriggered

    Available only on servers:

    • #Timers

    Accepts the following message:

    Message IDonTimerTriggeredEvent

    Event Update when a Timer got triggered

    object

    Examples

    • #1 Example - Success-Response
      {
  "id": "T1",
  "stats": {
    "minute": 1,
    "hour": 2,
    "day": 3,
    "week": 3,
    "month": 3,
    "year": 3
  }
}

  • EMIT removeTimer

    Remove a Timer
    (Version 0.2.2 | admin User Permission needed)

    Operation IDremoveTimer

    Available only on servers:

    • #Timers

    Accepts the following message:

    Message IDremoveTimerPayload

    Payload: Remove a Timer

    object

    Examples

    • #1 Example
      {
  "id": "T2"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeTimer

  • EMIT setTimer

    Set/Update a Timer
    (Version 0.2.2 | admin User Permission needed)

    Operation IDsetTimer

    Available only on servers:

    • #Timers

    Accepts the following message:

    Message IDsetTimerPayload

    Payload: Set/Update a Timer

    object

    Examples

    • #1 Example
      {
  "id": "T3",
  "name": "Christmas Eve",
  "enabled": true,
  "timer": {
    "date": "24.12.",
    "time": "18:00"
  },
  "actions": [
    {
      "cid": "C2",
      "property": "switchon"
    },
    {
      "cid": "C3",
      "property": "level",
      "value": "50"
    }
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setTimer

  • EMIT setTimerName

    Set a new Timer Name
    (Version 0.2.2 | admin User Permission needed)

    Operation IDsetTimerName

    Available only on servers:

    • #Timers

    Accepts the following message:

    Message IDsetTimerNamePayload

    Payload: Set a new Timer Name

    object

    Examples

    • #1 Example
      {
  "id": "T3",
  "name": "Test-Timer"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setTimerName

  • EMIT setTimerPosition

    Set a new Timer Position. To avoid weird sorting it is best to update all timers as once.
    (Version 0.2.13 | admin User Permission needed)

    Operation IDsetTimerPosition

    Available only on servers:

    • #Timers

    Accepts the following message:

    Message IDsetTimerPositionPayload

    Payload: Set a new Timer Position. To avoid weird sorting it is best to update all timers as once.

    object

    Examples

    • #1 Example
      {
  "id": "T3",
  "position": 7
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setTimerPosition

  • EMIT addUser

    Add a User
    (Version 0.2.10 | admin User Permission needed)

    Operation IDaddUser

    Available only on servers:

    • #Users

    Accepts the following message:

    Message IDaddUserPayload

    Payload: Add a User

    object

    Examples

    • #1 Example
      {
  "name": "Test User",
  "username": "Test",
  "password": "password1234",
  "enabled": true,
  "usergroup": "user"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addUser

  • EMIT disableUserAuth

    Disable User Authentication
    (Version 0.1.8 | admin User Permission needed)

    Operation IDdisableUserAuth

    Available only on servers:

    • #Users

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: disableUserAuth

  • EMIT enableUserAuth

    Enable User Authentication
    (Version 0.1.8 | admin User Permission needed)

    Operation IDenableUserAuth

    Available only on servers:

    • #Users

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: enableUserAuth

  • EMIT getCurrentUser

    Get Current User Data/Information
    (Version 0.2.64)

    Operation IDgetCurrentUser

    Available only on servers:

    • #Users

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getCurrentUser

  • EMIT getUser

    Get User Data/Information
    (Version 0.2.64 | admin User Permission needed)

    Operation IDgetUser

    Available only on servers:

    • #Users

    Accepts the following message:

    Message IDgetUserPayload

    Payload: Get User Data/Information

    object

    Examples

    • #1 Example
      {
  "uid": 11
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getUser

  • EMIT getUserAuth

    Get User Authentication Enabled State
    (Version 0.1.8)

    Operation IDgetUserAuth

    Available only on servers:

    • #Users

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getUserAuth

  • EMIT getUserGroups

    Get all User Groups
    (Version 0.1.8)

    Operation IDgetUserGroups

    Available only on servers:

    • #Users

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getUserGroups

  • EMIT getUsers

    Get all Users
    (Version 0.1.8 | admin User Permission needed)

    Operation IDgetUsers

    Available only on servers:

    • #Users

    Accepts the following message:

    Message IDgetUsersPayload

    Payload: Get all Users

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getUsers

  • EMIT removeUser

    Remove a User
    (Version 0.1.8 | admin User Permission needed)

    Operation IDremoveUser

    Available only on servers:

    • #Users

    Accepts the following message:

    Message IDremoveUserPayload

    Payload: Remove a User

    object

    Examples

    • #1 Example
      {
  "uid": 11
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeUser

  • EMIT setUser

    Set User Data/Information
    (Version 0.1.8 | admin User Permission needed)

    Operation IDsetUser

    Available only on servers:

    • #Users

    Accepts the following message:

    Message IDsetUserPayload

    Payload: Set User Data/Information

    object

    Examples

    • #1 Example - Enabling Example
      {
  "uid": 11,
  "enabled": false
}
    • #2 Example - Password Example
      {
  "uid": 11,
  "oldPassword": "password1234",
  "newPassword": "password5678"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setUser

  • EMIT addVPNClient

    Add a VPN Client
    (Version 0.3.9 | admin User Permission needed)

    Operation IDaddVPNClient

    Available only on servers:

    • #VPN

    Accepts the following message:

    Message IDaddVPNClientPayload

    Payload: Add a VPN Client

    object

    Examples

    • #1 Example
      {
  "name": "Richard's iPhone"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addVPNClient

  • EMIT disableVPN

    Disable VPN
    (Version 0.3.9 | admin User Permission needed)

    Operation IDdisableVPN

    Available only on servers:

    • #VPN

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: disableVPN

  • EMIT enableVPN

    Enable VPN
    (Version 0.3.9 | admin User Permission needed)

    Operation IDenableVPN

    Available only on servers:

    • #VPN

    Accepts the following message:

    Message IDenableVPNPayload

    Payload: Enable VPN

    object

    Examples

    • #1 Example
      {
  "partnerName": "nomos"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: enableVPN

  • EMIT getVPNClientConfig

    Get a VPN Client Configuration
    (Version 0.3.9 | admin User Permission needed)

    Operation IDgetVPNClientConfig

    Available only on servers:

    • #VPN

    Accepts the following message:

    Message IDgetVPNClientConfigPayload

    Payload: Get a VPN Client Configuration

    object

    Examples

    • #1 Example
      {
  "id": 11
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getVPNClientConfig

  • EMIT getVPNClients

    Get VPN Clients
    (Version 0.3.9 | admin User Permission needed)

    Operation IDgetVPNClients

    Available only on servers:

    • #VPN

    Accepts the following message:

    Message IDgetVPNClientsPayload

    Payload: Get VPN Clients

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getVPNClients

  • EMIT getVPNInfo

    Get VPN Information/Configuration
    (Version 0.3.9 | admin User Permission needed)

    Operation IDgetVPNInfo

    Available only on servers:

    • #VPN

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getVPNInfo

  • EMIT removeVPNClient

    Remove a VPN Client
    (Version 0.3.9 | admin User Permission needed)

    Operation IDremoveVPNClient

    Available only on servers:

    • #VPN

    Accepts the following message:

    Message IDremoveVPNClientPayload

    Payload: Remove a VPN Client

    object

    Examples

    • #1 Example
      {
  "id": 11
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeVPNClient

  • EMIT revokeVPNClientConfig

    Revoke a VPN Client Configuration
    (Version 0.3.9 | admin User Permission needed)

    Operation IDrevokeVPNClientConfig

    Available only on servers:

    • #VPN

    Accepts the following message:

    Message IDrevokeVPNClientConfigPayload

    Payload: Revoke a VPN Client Configuration

    object

    Examples

    • #1 Example
      {
  "id": 11
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: revokeVPNClientConfig

  • EMIT addWebHook

    Add a Webhook. Your callback url will be called as HTTP GET with query parameters.
    (Version 0.2.4 | admin User Permission needed)

    Operation IDaddWebHook

    Available only on servers:

    • #WebHooks

    Accepts the following message:

    Message IDaddWebHookPayload

    Payload: Add a Webhook. Your callback url will be called as HTTP GET with query parameters.

    object

    Examples

    • #1 Example - Component Update Example
      {
  "type": "component",
  "cid": "C1",
  "property": "artist",
  "url": "https://yourwebhook.com/test"
}
    • #2 Example - mremote Update Example
      {
  "type": "join",
  "join": "d1",
  "url": "https://yourwebhook.com/test"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addWebHook

  • EMIT disableWebHook

    Disable a Webhook
    (Version 0.2.4 | admin User Permission needed)

    Operation IDdisableWebHook

    Available only on servers:

    • #WebHooks

    Accepts the following message:

    Message IDdisableWebHookPayload

    Payload: Disable a Webhook

    object

    Examples

    • #1 Example
      {
  "id": 2
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: disableWebHook

  • EMIT enableWebHook

    Enable a Webhook
    (Version 0.2.4 | admin User Permission needed)

    Operation IDenableWebHook

    Available only on servers:

    • #WebHooks

    Accepts the following message:

    Message IDenableWebHookPayload

    Payload: Enable a Webhook

    object

    Examples

    • #1 Example
      {
  "id": 2
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: enableWebHook

  • EMIT getWebHooks

    Get Webhooks
    (Version 0.2.4 | admin User Permission needed)

    Operation IDgetWebHooks

    Available only on servers:

    • #WebHooks

    Accepts the following message:

    Message IDgetWebHooksPayload

    Payload: Get Webhooks

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getWebHooks

  • EMIT removeWebHook

    Remove a Webhook
    (Version 0.2.4 | admin User Permission needed)

    Operation IDremoveWebHook

    Available only on servers:

    • #WebHooks

    Accepts the following message:

    Message IDremoveWebHookPayload

    Payload: Remove a Webhook

    object

    Examples

    • #1 Example
      {
  "id": 3
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeWebHook

  • EMIT addWireGuardClient

    Add a WireGuard Client
    (Version 0.3.9 | admin User Permission needed)

    Operation IDaddWireGuardClient

    Available only on servers:

    • #WireGuard

    Accepts the following message:

    Message IDaddWireGuardClientPayload

    Payload: Add a WireGuard Client

    object

    Examples

    • #1 Example
      {
  "id": 1,
  "name": "WireGuard Client",
  "ipAddress": "10.0.0.10",
  "serverAddress": "192.168.0.1",
  "serverPort": 51110,
  "serverPublicKey": "nqXTHMXb9M+MmiN/16JNEJGUOD3rWP1KI2fJzgMjFQo="
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addWireGuardClient

  • EMIT addWireGuardServer

    Add a WireGuard Server Interface
    (Version 0.3.9 | admin User Permission needed)

    Operation IDaddWireGuardServer

    Available only on servers:

    • #WireGuard

    Accepts the following message:

    Message IDaddWireGuardServerPayload

    Payload: Add a WireGuard Server Interface

    object

    Examples

    • #1 Example
      {
  "id": 0,
  "name": "WireGuard Server Interface"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addWireGuardServer

  • EMIT addWireGuardServerPeer

    Add a WireGuard Server Peer Client
    (Version 0.2.69 | admin User Permission needed)

    Operation IDaddWireGuardServerPeer

    Available only on servers:

    • #WireGuard

    Accepts the following message:

    Message IDaddWireGuardServerPeerPayload

    Payload: Add a WireGuard Server Peer Client

    object

    Examples

    • #1 Example
      {
  "serverId": 0,
  "name": "WireGuard Peer Client",
  "ipAddress": "10.0.0.10",
  "peerPublicKey": "nqXTHMXb9M+MmiN/16JNEJGUOD3rWP1KI2fJzgMjFQo=",
  "peerPreSharedKey": "tUlI0+UPQ9nKaBPfvY+feAjCZDEVQvBzOeCfFgW8x+g="
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addWireGuardServerPeer

  • EMIT getWireGuardClients

    Get WireGuard Clients
    (Version 0.3.9 | admin User Permission needed)

    Operation IDgetWireGuardClients

    Available only on servers:

    • #WireGuard

    Accepts the following message:

    Message IDgetWireGuardClientsPayload

    Payload: Get WireGuard Clients

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getWireGuardClients

  • EMIT getWireGuardServerPeers

    Get WireGuard Server Peer Clients
    (Version 0.2.69 | admin User Permission needed)

    Operation IDgetWireGuardServerPeers

    Available only on servers:

    • #WireGuard

    Accepts the following message:

    Message IDgetWireGuardServerPeersPayload

    Payload: Get WireGuard Server Peer Clients

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getWireGuardServerPeers

  • EMIT getWireGuardServers

    Get WireGuard Server Interfaces
    (Version 0.3.9 | admin User Permission needed)

    Operation IDgetWireGuardServers

    Available only on servers:

    • #WireGuard

    Accepts the following message:

    Message IDgetWireGuardServersPayload

    Payload: Get WireGuard Server Interfaces

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name",
    "created"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getWireGuardServers

  • EMIT removeWireGuardClient

    Remove a WireGuard Client
    (Version 0.2.69 | admin User Permission needed)

    Operation IDremoveWireGuardClient

    Available only on servers:

    • #WireGuard

    Accepts the following message:

    Message IDremoveWireGuardClientPayload

    Payload: Remove a WireGuard Client

    object

    Examples

    • #1 Example
      {
  "id": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeWireGuardClient

  • EMIT removeWireGuardServer

    Remove a WireGuard Server Interface
    (Version 0.2.69 | admin User Permission needed)

    Operation IDremoveWireGuardServer

    Available only on servers:

    • #WireGuard

    Accepts the following message:

    Message IDremoveWireGuardServerPayload

    Payload: Remove a WireGuard Server Interface

    object

    Examples

    • #1 Example
      {
  "id": 0
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeWireGuardServer

  • EMIT removeWireGuardServerPeer

    Remove a WireGuard Server Peer Client
    (Version 0.2.69 | admin User Permission needed)

    Operation IDremoveWireGuardServerPeer

    Available only on servers:

    • #WireGuard

    Accepts the following message:

    Message IDremoveWireGuardServerPeerPayload

    Payload: Remove a WireGuard Server Peer Client

    object

    Examples

    • #1 Example
      {
  "id": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeWireGuardServerPeer

  • EMIT addWiserDevice

    Add a Wiser Device/Component
    (Version 0.3.11 | admin User Permission needed)

    Operation IDaddWiserDevice

    Available only on servers:

    • #Wiser

    Accepts the following message:

    Message IDaddWiserDevicePayload

    Payload: Add a Wiser Device/Component

    object

    Examples

    • #1 Example
      {
  "name": "Test Device Channel 1",
  "gateway": 1,
  "id": 1,
  "device": "0000273c_0",
  "channel": 0,
  "lid": "wiser.switch",
  "profile": "wiser_switch",
  "capabilities": [
    "wiser_base"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addWiserDevice

  • EMIT addWiserGateway

    Add a Wiser Gateway
    (Version 0.2.64 | admin User Permission needed)

    Operation IDaddWiserGateway

    Available only on servers:

    • #Wiser

    Accepts the following message:

    Message IDaddWiserGatewayPayload

    Payload: Add a Wiser Gateway

    object

    Examples

    • #1 Example
      {
  "host": "192.168.88.113"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addWiserGateway

  • EMIT addWiserSmartButton

    Add a Wiser SmartButton
    (Version 0.2.71 | admin User Permission needed)

    Operation IDaddWiserSmartButton

    Available only on servers:

    • #Wiser

    Accepts the following message:

    Message IDaddWiserSmartButtonPayload

    Payload: Add a Wiser SmartButton

    object

    Examples

    • #1 Example
      {
  "name": "SmartButton #1",
  "gateway": 1,
  "id": 18
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addWiserSmartButton

  • EMIT detectWiserGateways

    Get/find all Wiser Gateway Devices in local network
    (Version 0.3.0 | admin User Permission needed)

    Operation IDdetectWiserGateways

    Available only on servers:

    • #Wiser

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: detectWiserGateways

  • EMIT getWiserDevices

    Get available Wiser Devices of a Gateway
    (Version 0.3.11 | admin User Permission needed)

    Operation IDgetWiserDevices

    Available only on servers:

    • #Wiser

    Accepts the following message:

    Message IDgetWiserDevicesPayload

    Payload: Get available Wiser Devices of a Gateway

    object

    Examples

    • #1 Example
      {
  "id": 1
}
    • #2 Example - Sorting
      {
  "id": 1,
  "sortBy": [
    "name"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getWiserDevices

  • EMIT getWiserGateways

    Get added Wiser Gateway(s)
    (Version 0.3.0 | admin User Permission needed)

    Operation IDgetWiserGateways

    Available only on servers:

    • #Wiser

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getWiserGateways

  • EMIT identifyWiserDevice

    Identify/Ping Wiser Device
    (Version 0.3.11 | admin User Permission needed)

    Operation IDidentifyWiserDevice

    Available only on servers:

    • #Wiser

    Accepts the following message:

    Message IDidentifyWiserDevicePayload

    Payload: Identify/Ping Wiser Device

    object

    Examples

    • #1 Example - Example by Device
      {
  "id": 1,
  "device": "00001c5a"
}
    • #2 Example - Example by Device ID
      {
  "id": 1,
  "deviceId": 2
}
    • #3 Example - Example by Component ID
      {
  "id": 1,
  "cid": "C1"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: identifyWiserDevice

  • EMIT identifyWiserSmartButton

    Get/identify Wiser SmartButton
    (Version 0.2.64 | admin User Permission needed)

    Operation IDidentifyWiserSmartButton

    Available only on servers:

    • #Wiser

    Accepts the following message:

    Message IDidentifyWiserSmartButtonPayload

    Payload: Get/identify Wiser SmartButton

    object

    Examples

    • #1 Example
      {
  "id": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: identifyWiserSmartButton

  • EMIT rebootWiserGateway

    Reboot Wiser Gateway
    (Version 0.3.0 | admin User Permission needed)

    Operation IDrebootWiserGateway

    Available only on servers:

    • #Wiser

    Accepts the following message:

    Message IDrebootWiserGatewayPayload

    Payload: Reboot Wiser Gateway

    object

    Examples

    • #1 Example
      {
  "id": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: rebootWiserGateway

  • EMIT removeWiserGateway

    Remove a Wiser Gateway
    (Version 0.2.64 | admin User Permission needed)

    Operation IDremoveWiserGateway

    Available only on servers:

    • #Wiser

    Accepts the following message:

    Message IDremoveWiserGatewayPayload

    Payload: Remove a Wiser Gateway

    object

    Examples

    • #1 Example
      {
  "id": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeWiserGateway

  • EMIT setWiserGateway

    Set/update a Wiser Gateway
    (Version 0.2.64 | admin User Permission needed)

    Operation IDsetWiserGateway

    Available only on servers:

    • #Wiser

    Accepts the following message:

    Message IDsetWiserGatewayPayload

    Payload: Set/update a Wiser Gateway

    object

    Examples

    • #1 Example
      {
  "id": 1,
  "host": "192.168.88.112"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setWiserGateway

  • EMIT startWiserIdentify

    Start Wiser Identify/Find me
    (Version 0.2.64 | admin User Permission needed)

    Operation IDstartWiserIdentify

    Available only on servers:

    • #Wiser

    Accepts the following message:

    Message IDstartWiserIdentifyPayload

    Payload: Start Wiser Identify/Find me

    object

    Examples

    • #1 Example
      {
  "id": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: startWiserIdentify

  • EMIT stopWiserIdentify

    Stop Wiser Identify/Find me
    (Version 0.2.64 | admin User Permission needed)

    Operation IDstopWiserIdentify

    Available only on servers:

    • #Wiser

    Accepts the following message:

    Message IDstopWiserIdentifyPayload

    Payload: Stop Wiser Identify/Find me

    object

    Examples

    • #1 Example
      {
  "id": 1
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: stopWiserIdentify

  • EVENT wiserIdentify

    Event Update when Wiser device identified
    (Version 0.2.64 | admin User Permission needed)

    Operation IDwiserIdentify

    Available only on servers:

    • #Wiser

    Accepts the following message:

    Message IDwiserIdentifyEvent

    Event Update when Wiser device identified

    number

    Examples

    • #1 Example - Success-Response
      4

  • EMIT addZeptrionDevice

    Add a Zeptrion Device/Component
    (Version 0.2.71 | admin User Permission needed)

    Operation IDaddZeptrionDevice

    Available only on servers:

    • #Zeptrion

    Accepts the following message:

    Message IDaddZeptrionDevicePayload

    Payload: Add a Zeptrion Device/Component

    object

    Examples

    • #1 Example
      {
  "name": "Test Device Channel 1",
  "id": "zapp-19060083_ch1",
  "host": "zapp-19060083.local",
  "lid": "zeptrion.switch",
  "profile": "zeptrion_switch",
  "capabilities": [
    "zeptrion_base"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addZeptrionDevice

  • EMIT getZeptrionDevices

    Get/find all Zeptrion Devices in local network
    (Version 0.2.50 | admin User Permission needed)

    Operation IDgetZeptrionDevices

    Available only on servers:

    • #Zeptrion

    Accepts the following message:

    Message IDgetZeptrionDevicesPayload

    Payload: Get/find all Zeptrion Devices in local network

    object

    Examples

    • #1 Example - Sorting
      {
  "sortBy": [
    "name"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getZeptrionDevices

  • EMIT setZeptrionSmartButton

    Configure/Set Zeptrion Smartfront Button
    (Version 0.2.50 | admin User Permission needed)

    Operation IDsetZeptrionSmartButton

    Available only on servers:

    • #Zeptrion

    Accepts the following message:

    Message IDsetZeptrionSmartButtonPayload

    Payload: Configure/Set Zeptrion Smartfront Button

    object

    Examples

    • #1 Example
      {
  "host": "zapp-19060083.local",
  "cid": "C10"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setZeptrionSmartButton

  • EMIT addZigBeeDevice

    Add a ZigBee Device/Component
    (Version 0.2.73 | admin User Permission needed)

    Operation IDaddZigBeeDevice

    Available only on servers:

    • #ZigBee

    Accepts the following message:

    Message IDaddZigBeeDevicePayload

    Payload: Add a ZigBee Device/Component

    object

    Examples

    • #1 Example
      {
  "name": "Switch",
  "id": 2,
  "ieeeAddr": "0x00124b0024cb242b",
  "lid": "zigbee.switch",
  "profile": "zigbee_switch",
  "capabilities": [
    "zigbee_get_switch",
    "zigbee_set_switch",
    "zigbee_get_state",
    "zigbee_get_switch_state",
    "zigbee_set_state",
    "zigbee_set_switch_state",
    "zigbee_get_linkquality"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addZigBeeDevice

  • EMIT checkZigBeeDeviceUpdate

    Check for ZigBee Device (Firmware) Update
    (Version 0.2.73 | admin User Permission needed)

    Operation IDcheckZigBeeDeviceUpdate

    Available only on servers:

    • #ZigBee

    Accepts the following message:

    Message IDcheckZigBeeDeviceUpdatePayload

    Payload: Check for ZigBee Device (Firmware) Update

    object

    Examples

    • #1 Example
      {
  "cid": "C8"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: checkZigBeeDeviceUpdate

  • EMIT getZigBeeConfigParams

    Get ZigBee Device Config Parameters
    (Version 0.2.73 | admin User Permission needed)

    Operation IDgetZigBeeConfigParams

    Available only on servers:

    • #ZigBee

    Accepts the following message:

    Message IDgetZigBeeConfigParamsPayload

    Payload: Get ZigBee Device Config Parameters

    object

    Examples

    • #1 Example
      {
  "cid": "C8"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getZigBeeConfigParams

  • EMIT getZigBeeDevices

    Get ZigBee Devices
    (Version 0.2.74 | admin User Permission needed)

    Operation IDgetZigBeeDevices

    Available only on servers:

    • #ZigBee

    Accepts the following message:

    Message IDgetZigBeeDevicesPayload

    Payload: Get ZigBee Devices

    object

    Examples

    • #1 Example
      {
  "sortBy": [
    "name",
    "created"
  ],
  "includeCoordinator": false
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getZigBeeDevices

  • EMIT getZigBeeNetwork

    Get ZigBee Network Map
    (Version 0.2.73 | admin User Permission needed)

    Operation IDgetZigBeeNetwork

    Available only on servers:

    • #ZigBee

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getZigBeeNetwork

  • EMIT getZigBeeSettings

    Get ZigBee Settings
    (Version 0.2.73 | admin User Permission needed)

    Operation IDgetZigBeeSettings

    Available only on servers:

    • #ZigBee

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getZigBeeSettings

  • EMIT getZigBeeStatus

    Get ZigBee Settings
    (Version 0.2.73 | admin User Permission needed)

    Operation IDgetZigBeeStatus

    Available only on servers:

    • #ZigBee

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getZigBeeStatus

  • EMIT installZigBeeDeviceUpdate

    Install ZigBee Device (Firmware) Update
    (Version 0.2.73 | admin User Permission needed)

    Operation IDinstallZigBeeDeviceUpdate

    Available only on servers:

    • #ZigBee

    Accepts the following message:

    Message IDinstallZigBeeDeviceUpdatePayload

    Payload: Install ZigBee Device (Firmware) Update

    object

    Examples

    • #1 Example
      {
  "cid": "C8"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: installZigBeeDeviceUpdate

  • EMIT removeZigBeeDevice

    Remove a ZigBee Device/Node from Controller
    (Version 0.2.73 | admin User Permission needed)

    Operation IDremoveZigBeeDevice

    Available only on servers:

    • #ZigBee

    Accepts the following message:

    Message IDremoveZigBeeDevicePayload

    Payload: Remove a ZigBee Device/Node from Controller

    object

    Examples

    • #1 Example
      {
  "ieeeAddr": "0x00158d000836f7d9"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeZigBeeDevice

  • EMIT resetZigBeeController

    Reset the ZigBee Controller
    (Version 0.2.73 | admin User Permission needed)

    Operation IDresetZigBeeController

    Available only on servers:

    • #ZigBee

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: resetZigBeeController

  • EMIT setZigBeeConfigParams

    Set ZigBee Device Config Parameters
    (Version 0.2.73 | admin User Permission needed)

    Operation IDsetZigBeeConfigParams

    Available only on servers:

    • #ZigBee

    Accepts the following message:

    Message IDsetZigBeeConfigParamsPayload

    Payload: Set ZigBee Device Config Parameters

    object

    Examples

    • #1 Example
      {
  "cid": "C8",
  "params": {}
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setZigBeeConfigParams

  • EMIT setZigBeeSettings

    Set ZigBee Settings
    (Version 0.2.73 | admin User Permission needed)

    Operation IDsetZigBeeSettings

    Available only on servers:

    • #ZigBee

    Accepts the following message:

    Message IDsetZigBeeSettingsPayload

    Payload: Set ZigBee Settings

    object

    Examples

    • #1 Example
      {
  "blockList": [],
  "debug": true,
  "disabledLED": true,
  "channel": 25,
  "port": "auto"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setZigBeeSettings

  • EMIT startZigBeeIncludeMode

    Start ZigBee Include/Learning Mode
    (Version 0.2.73 | admin User Permission needed)

    Operation IDstartZigBeeIncludeMode

    Available only on servers:

    • #ZigBee

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: startZigBeeIncludeMode

  • EMIT stopZigBeeIncludeMode

    Stop ZigBee Include/Learning Mode
    (Version 0.2.73 | admin User Permission needed)

    Operation IDstopZigBeeIncludeMode

    Available only on servers:

    • #ZigBee

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: stopZigBeeIncludeMode

  • EVENT zigbeeDeviceUpdate

    Event Update when ZigBee Device Update is triggered
    (Version 0.2.73 | admin User Permission needed)

    Operation IDzigbeeDeviceUpdate

    Available only on servers:

    • #ZigBee

    Accepts the following message:

    Message IDzigbeeDeviceUpdateEvent

    Event Update when ZigBee Device Update is triggered

    object

    Examples

    • #1 Example - Response
      {
  "cid": "C1",
  "state": "start",
  "progress": 10,
  "remaining": 300
}

  • EVENT zigbeeStateChange

    Event Update when ZigBee Status Event is triggered
    (Version 0.2.73 | admin User Permission needed)

    Operation IDzigbeeStateChange

    Available only on servers:

    • #ZigBee

    Accepts the following message:

    Message IDzigbeeStateChangeEvent

    Event Update when ZigBee Status Event is triggered

    object

    Examples

    • #1 Example - Response
      {
  "state": "ready",
  "supportsLED": false,
  "permitJoin": false,
  "permitJoinTimeout": 0,
  "coordinator": {
    "meta": {},
    "type": "zStack3x0"
  },
  "network": {
    "channel": 25,
    "extendedPanID": "0x00884b00261234f4",
    "panID": 65112
  }
}

  • EMIT addZwaveAssociation

    Add one or multiple Node ID's to a specific Zwave Device Association Group of a Component
    (Version 0.1.8 | admin User Permission needed)

    Operation IDaddZwaveAssociation

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDaddZwaveAssociationPayload

    Payload: Add one or multiple Node ID's to a specific Zwave Device Association Group of a Component

    object

    Examples

    • #1 Example
      {
  "cid": "C8",
  "associations": [
    {
      "number": 1,
      "id": 3
    },
    {
      "number": 1,
      "id": 4
    }
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addZwaveAssociation

  • EMIT addZwaveDevice

    Add a Zwave Device/Component
    (Version 0.2.71 | admin User Permission needed)

    Operation IDaddZwaveDevice

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDaddZwaveDevicePayload

    Payload: Add a Zwave Device/Component

    object

    Examples

    • #1 Example
      {
  "name": "Multilevel Switch",
  "id": 2,
  "file": "43-0086-0003-000d-06-02-4e-01-18.xml",
  "lid": "zwave.switchmultilevel",
  "profile": "zwave_switchmultilevel",
  "capabilities": [
    "zwave_basic",
    "zwave_association",
    "zwave_switch_multilevel",
    "zwave_switch_all",
    "zwave_meter_v2",
    "zwave_configuration",
    "zwave_sensor_multilevel_v3",
    "zwave_manufacturer_specific",
    "zwave_version"
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: addZwaveDevice

  • EMIT getZwaveAssocGroups

    Get Zwave Device Association Groups (per Component ID or Node ID)
    (Version 0.2.3 | admin User Permission needed)

    Operation IDgetZwaveAssocGroups

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDgetZwaveAssocGroupsPayload

    Payload: Get Zwave Device Association Groups (per Component ID or Node ID)

    object

    Examples

    • #1 Example - Example 1
      {
  "cid": "C8"
}
    • #2 Example - Example 2
      {
  "id": 2
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getZwaveAssocGroups

  • EMIT getZwaveConfigParams

    Get Configuration Parameters of a Zwave Device (per Component ID or Node ID)
    (Version 0.2.3 | admin User Permission needed)

    Operation IDgetZwaveConfigParams

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDgetZwaveConfigParamsPayload

    Payload: Get Configuration Parameters of a Zwave Device (per Component ID or Node ID)

    object

    Examples

    • #1 Example - Example 1
      {
  "cid": "C8"
}
    • #2 Example - Example 2
      {
  "id": 2
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getZwaveConfigParams

  • EMIT getZwaveConfigXMLs

    Get a index/list of all available Config XML files
    (Version 0.2.2 | admin User Permission needed)

    Operation IDgetZwaveConfigXMLs

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getZwaveConfigXMLs

  • EMIT getZwaveControllerFrequencies

    Get all the supported Controller Frequencies
    (Version 0.2.13 | admin User Permission needed)

    Operation IDgetZwaveControllerFrequencies

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getZwaveControllerFrequencies

  • EMIT getZwaveControllerFrequency

    Get the Controller Frequency
    (Version 0.2.13 | admin User Permission needed)

    Operation IDgetZwaveControllerFrequency

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getZwaveControllerFrequency

  • EMIT getZwaveDeviceInfos

    Get detailed Zwave Device Information (per Component ID or File)
    (Version 0.1.8 | admin User Permission needed)

    Operation IDgetZwaveDeviceInfos

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDgetZwaveDeviceInfosPayload

    Payload: Get detailed Zwave Device Information (per Component ID or File)

    object

    Examples

    • #1 Example - Example per cid
      {
  "cid": "C8"
}
    • #2 Example - Example per file
      {
  "file": "43-0086-0003-000d-06-02-4e-01-18.xml"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getZwaveDeviceInfos

  • EMIT getZwaveDevices

    Get (autodetected) Zwave Devices/Components
    (Version 0.2.74 | admin User Permission needed)

    Operation IDgetZwaveDevices

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getZwaveDevices

  • EMIT getZwaveWakeUpInterval

    Provides for a Node Wakeup Interval Information (per Component ID or Node ID)
    (Version 0.2.2 | admin User Permission needed)

    Operation IDgetZwaveWakeUpInterval

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDgetZwaveWakeUpIntervalPayload

    Payload: Provides for a Node Wakeup Interval Information (per Component ID or Node ID)

    object

    Examples

    • #1 Example - Example 1
      {
  "id": 2
}
    • #2 Example - Example 2
      {
  "cid": "C2"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: getZwaveWakeUpInterval

  • EMIT interviewZwaveNode

    Interviews a Node again (takes place automatically with Include) (per Component ID or Node ID)
    (Version 0.2.2 | admin User Permission needed)

    Operation IDinterviewZwaveNode

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDinterviewZwaveNodePayload

    Payload: Interviews a Node again (takes place automatically with Include) (per Component ID or Node ID)

    object

    Examples

    • #1 Example - Example 1
      {
  "id": 2
}
    • #2 Example - Example 2
      {
  "cid": "C2"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: interviewZwaveNode

  • EMIT loadZwaveConfigXML

    Takes on another Z-Wave XML from the Library for a Node (per Component ID or Node ID)
    (Version 0.2.2 | admin User Permission needed)

    Operation IDloadZwaveConfigXML

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDloadZwaveConfigXMLPayload

    Payload: Takes on another Z-Wave XML from the Library for a Node (per Component ID or Node ID)

    object

    Examples

    • #1 Example - Example 1
      {
  "id": 2,
  "file": "43-0086-0003-000d-06-02-4e-01-18.xml"
}
    • #2 Example - Example 2
      {
  "cid": "C2",
  "file": "43-0086-0003-000d-06-02-4e-01-18.xml"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: loadZwaveConfigXML

  • EMIT removeZwaveAssociation

    Remove one or multiple Node ID's from a specific Zwave Device Association Group of a Component
    (Version 0.1.8 | admin User Permission needed)

    Operation IDremoveZwaveAssociation

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDremoveZwaveAssociationPayload

    Payload: Remove one or multiple Node ID's from a specific Zwave Device Association Group of a Component

    object

    Examples

    • #1 Example
      {
  "cid": "C8",
  "associations": [
    {
      "number": 1,
      "id": 3
    },
    {
      "number": 1,
      "id": 4
    }
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeZwaveAssociation

  • EMIT removeZwaveNode

    Removes a Node with "force" override (e.g., when the device is defective and can no longer be excluded) (per Component ID or Node ID)
    (Version 0.2.2 | admin User Permission needed)

    Operation IDremoveZwaveNode

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDremoveZwaveNodePayload

    Payload: Removes a Node with "force" override (e.g., when the device is defective and can no longer be excluded) (per Component ID or Node ID)

    object

    Examples

    • #1 Example - Example 1
      {
  "id": 2
}
    • #2 Example - Example 2
      {
  "cid": "C2"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: removeZwaveNode

  • EMIT resetZwaveAlarm

    Resets all Alarm reports for a Node (per Component ID or Node ID)
    (Version 0.2.2 | admin User Permission needed)

    Operation IDresetZwaveAlarm

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDresetZwaveAlarmPayload

    Payload: Resets all Alarm reports for a Node (per Component ID or Node ID)

    object

    Examples

    • #1 Example - Example 1
      {
  "id": 2
}
    • #2 Example - Example 2
      {
  "cid": "C2"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: resetZwaveAlarm

  • EMIT resetZwaveController

    Reset the Zwave Controller
    (Version 0.1.8 | admin User Permission needed)

    Operation IDresetZwaveController

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: resetZwaveController

  • EMIT setZwaveConfigParams

    Set one or mulitple Zwave Device Configuration Parameter(s) of a Component to specific Value(s)
    (Version 0.1.8 | admin User Permission needed)

    Operation IDsetZwaveConfigParams

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDsetZwaveConfigParamsPayload

    Payload: Set one or mulitple Zwave Device Configuration Parameter(s) of a Component to specific Value(s)

    object

    Examples

    • #1 Example
      {
  "cid": "C8",
  "params": [
    {
      "number": 1,
      "value": "01"
    }
  ]
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setZwaveConfigParams

  • EMIT setZwaveControllerFrequency

    Set the Controller Frequency
    (Version 0.2.13 | admin User Permission needed)

    Operation IDsetZwaveControllerFrequency

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDsetZwaveControllerFrequencyPayload

    Payload: Set the Controller Frequency

    object

    Examples

    • #1 Example
      {
  "code": "EU"
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setZwaveControllerFrequency

  • EMIT setZwaveWakeUpInterval

    Sets the Wakeup Interval for a Node (per Component ID or Node ID)
    (Version 0.2.2 | admin User Permission needed)

    Operation IDsetZwaveWakeUpInterval

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDsetZwaveWakeUpIntervalPayload

    Payload: Sets the Wakeup Interval for a Node (per Component ID or Node ID)

    object

    Examples

    • #1 Example - Example 1
      {
  "id": 2,
  "interval": 3600
}
    • #2 Example - Example 2
      {
  "cid": "C2",
  "interval": 3600
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: setZwaveWakeUpInterval

  • EMIT startZwaveExcludeMode

    Start Zwave Exclude/Learning Mode
    (Version 0.2.60 | admin User Permission needed)

    Operation IDstartZwaveExcludeMode

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDstartZwaveExcludeModePayload

    Payload: Start Zwave Exclude/Learning Mode

    object

    Examples

    • #1 Example
      {
  "timeout": 30
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: startZwaveExcludeMode

  • EMIT startZwaveIncludeMode

    Start Zwave Include/Learning Mode
    (Version 0.2.60 | admin User Permission needed)

    Operation IDstartZwaveIncludeMode

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDstartZwaveIncludeModePayload

    Payload: Start Zwave Include/Learning Mode

    object

    Examples

    • #1 Example
      {
  "timeout": 30
}
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: startZwaveIncludeMode

  • EMIT stopZwaveExcludeMode

    Stop Zwave Exclude/Learning Mode
    (Version 0.1.8 | admin User Permission needed)

    Operation IDstopZwaveExcludeMode

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: stopZwaveExcludeMode

  • EMIT stopZwaveIncludeMode

    Stop Zwave Include/Learning Mode
    (Version 0.1.8 | admin User Permission needed)

    Operation IDstopZwaveIncludeMode

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: stopZwaveIncludeMode

  • EMIT updateZwaveNetwork

    Update the Zwave Network
    (Version 0.1.8 | admin User Permission needed)

    Operation IDupdateZwaveNetwork

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDemptyMessage

    Empty message

    object

    Examples

    {}
    This example has been generated automatically.
    REPLY INFORMATION

    REPLY CHANNEL INFORMATION

    Reply will be provided via this designated address: updateZwaveNetwork

  • EVENT zwaveStateChange

    Event Update when Zwave Status Change is triggered
    (Version 0.2.71 | admin User Permission needed)

    Operation IDzwaveStateChange

    Available only on servers:

    • #Zwave

    Accepts the following message:

    Message IDzwaveStateChangeEvent

    Event Update when Zwave Status Event is triggered

    object

    Examples

    • #1 Example - Idle Response
      {
  "status": "Idle"
}
    • #2 Example - Response (detected Device)
      {
  "status": "detected",
  "file": "11-0064-3001-0000-06-02-33-01-00.xml",
  "device": "6"
}