Creates a new Z-Bus DimmerDevice
{ DimmerDevice } = require('@z-bus/api');
//Dims address 0 to 50%
new DimmerDevice(0).dim(0.5);
Addresses the Z-Bus device is linked to. The device will react when receiving a corresponding DeviceEvent and change its state accordingly.
Current brightness of the Z-Bus DimmerDevice as a number between 0.0 and 1.0 in %
0.0 is off0.5 is 50% brightness1.0 is 100% onUnique id that identifies the Z-Bus device in the database
Last known brightness of the Z-Bus DimmerDevice as a number between 0.0 and 1.0 in %
0.0 was off0.5 was 50% brightness1.0 was 100% onDisplay name of the Z-Bus device
Display profile for the Z-Bus device (determines state descriptions and symbols), e.g.:
Current state the Z-Bus device is in, e.g.:
'undefined''on''off''up''down''stop'Identifies the different types of Z-Bus devices:
'switch' for SwitchingDevice'dimmer' for DimmerDevice'directional' for DirectionalDeviceDims the Z-Bus DimmerDevice
Brightness of the DimmerDevice between 0.0 and 1.0 %
Duration of a full dimming ramp (from 0 to 100%) between 0.04 and 160 seconds
Switches the Z-Bus DimmerDevice off
Switches the Z-Bus DimmerDevice on
Toggles the Z-Bus DimmerDevice. The device will alternate
off to on, oron to offControls the Z-Bus DimmerDevice
Command used to control the DimmerDevice between 0 and 255)
Brightness of the DimmerDevice between 0.0 and 1.0 %
Duration of a full dimming ramp (from 0 to 100%) between 0.04 and 160 seconds
Creates an event to control a Z-Bus DimmerDevice
{ DimmerDevice } = require('@z-bus/api');
//Event to dim address 0 to 50%
const event = DimmerDevice.createEvent(0, 'on', {brightness: 0.5, duration: 8, direction: 0});
Address of the controlled DimmerDevice between 0 and 242
Command used to control the DimmerDevice between 0 and 255
may contain brightness and duration of the dimming ramp
the new event
Generated using TypeDoc
Z-Bus dimmer device which adjusts brightness of a light