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
      {