Method
|
Return Value
|
Parameters
|
Parameter Description
|
KNXConfig/importProject
|
OK on success, error string on failure
|
- file: multi-part form data
|
- file: multi-part form data - The actual ETS4 project data.
|
KNXConfig/getStep
|
Returns the current step of the KNX Config Wizzard. Number.
|
-
|
-
|
KNXConfig/prevStep
|
Go back one step in the KNX Config Wizzard. Returns the new step number.
|
-
|
-
|
KNXConfig/nextStep
|
Go ahead one step in the KNX Config Wizzard. Returns the new step number.
|
-
|
-
|
KNXConfig/getStatus
|
OK on success, error/warning string
|
|
- deviceId: string - Check configuration status for the given device ID, or if missing, the whole KNX configuration.
|
KNXConfig/updateDataPointType
|
OK on success, error/warning string
|
- deviceId: string
- dataPointId: string
- dataPointType: string
|
- deviceId: string - Device ID
- dataPointId: string - Data point ID
- dataPointType: string - New data point type.
|
KNXConfig/listDevices
|
KNXDevice[]. List of KNX devices.
|
-
|
-
|
KNXConfig/updateDevice
|
OK on success, error string on failure
|
- deviceId: string
- props: object
|
- deviceId: string - Device id that will be updated
- props: object - A set of key-value pairs for the device to be updated.
|
KNXConfig/skipDeviceHDM
|
OK on success, error string on failure
|
- deviceId: string
- hdmSkip: boolean
|
- deviceId: string - Device id that will be updated
- hdmSkip: boolean - Flag indicating if the device should not be exported as HDM device.
|
KNXConfig/addChildDevice
|
Parent device (KNXDevice) with the new child added to its children.
|
- deviceId: string
- dataPoints: DataPoint[]
|
- deviceId: string - Device id that will be the parent.
- dataPoints: DataPoint[] - A subset of the data points in the parent device that will be handled by the child device.
|
KNXConfig/removeChildDevice
|
Parent device (KNXDevice) with the child removed from its childen.
|
|
- deviceId: string - Device id of the child that will be removed.
|
KNXConfig/getAvailableDeviceClasses
|
A list of device class types that can be added to the given device.
|
- deviceId: string
- dataPoints: DataPoint[]
|
- deviceId: string - Device id that will hold the device class.
- dataPoints: DataPoint[] - A subset of the data points in the device that will be handled by the device class object.
|
KNXConfig/addDeviceClass
|
KNXDevice with the device class added.
|
- deviceId: string
- dataPoints: DataPoint[]
- deviceClassType
|
- deviceId: string - Device id that will hold the device class.
- dataPoints: DataPoint[] - A subset of the data points in the device that will be handled by the device class object.
- deviceClassType - Device class type
|
KNXConfig/removeDeviceClass
|
KNXDevice with the device class removed.
|
- deviceId: string
- deviceClassType: string
|
- deviceId: string - Device ID
- deviceClassType: string - Device class type
|
KNXConfig/setDeviceClassConfig
|
KNXDevice with the device class updated.
|
- deviceId: string
- deviceClassType: string
- props: object
|
- deviceId: string - Device ID
- deviceClassType: string - Device class type
- props: object - A set of key-value pairs for the device class configuration (See device class templates for possible options).
|
