dm-utils

Utility classes for ioBroker adapters to support ioBroker.device-manager.

How to use

Add in your io-package.json the property deviceManager: true to common.supportedMessages. Note: If you don't have a common.supportedMessages property yet, you have to add it. Also, if you have a common.messagebox property for the adapter-specific messages, you can remove it and add common.supportedMessages.custom: true. (see https://github.com/ioBroker/ioBroker.js-controller/blob/274f9e8f84dbdaaba9830a6cc00ddf083e989090/schemas/io-package.json#L754C104-L754C178)

In your ioBroker adapter, add a subclass of DeviceManagement and override the methods you need (see next chapters):

Example:

Create a subclass:

class MyAdapterDeviceManagement extends DeviceManagement<MyAdapter> {
    // contents see in the next chapters
}

Instantiate the subclass in your adapter class constructor:

class MyAdapter extends utils.Adapter {
    private readonly deviceManagement: MyAdapterDeviceManagement;

    public constructor(options: Partial<utils.AdapterOptions> = {}) {
        super({
            ...options,
            name: 'my-adapter',
        });
        this.deviceManagement = new DmTestDeviceManagement(this);

        // ... more code here
    }
}

Core concepts

Structure

In the UI, there are three levels of information:

In the top level, a list of all adapter instances is shown (only containing adapter instances that support device management).
Inside the adapter instance (when expanded), a list of devices is shown.
Devices may contain additional details, which are shown when the row of the device is expanded.

Actions

The device manager tab allows the user to interact with the adapter instance in two ways:

Actions per instance are shown above the list and should contain actions like "Search devices" or "Pair new device".
Actions per device are shown in the device list inside an instance and should contain actions like "Edit settings" or "Remove".

When the user clicks on an action (i.e., a button in the UI), the DeviceManagement implementation's handleXxxAction() is called, and the adapter can perform arbitrary actions (see below for details).

Controls

The device manager tab allows the user to control devices too. If devices are controllable, the device manager tab shows the control elements in the device card.

When the user clicks on a control (i.e., a button in the UI), the DeviceManagement implementation's handleXxxAction() is called, and the adapter can perform arbitrary actions (see below for details).

Communication

The communication between the ioBroker.device-manager tab and the adapter happens through sendTo.

IMPORTANT: make sure your adapter doesn't handle sendTo messages starting with dm:, otherwise the communication will not work.

Use, for example, this on the top of your onMessage Methode:

if (obj.command?.startsWith('dm:')) {
    // Handled by Device Manager class itself, so ignored here
    return;
}

Access adapter methods

You can access all adapter methods like getState() or getStateAsync() via this.adapter.
Example: this.getState() -> this.adapter.getState()

Error Codes

Code	Description
101	Instance action ${actionId} was called before getInstanceInfo() was called. This could happen if the instance has restarted.
102	Instance action ${actionId} is unknown.
103	Instance action ${actionId} is disabled because it has no handler.
201	Device action ${actionId} was called before loadDevices() was called. This could happen if the instance has restarted.
202	Device action ${actionId} was called on unknown device: ${deviceId}.
203	Device action ${actionId} doesn't exist on device ${deviceId}.
204	Device action ${actionId} on ${deviceId} is disabled because it has no handler.

Examples

To get an idea of how to use dm-utils, please have a look at:

`DeviceManagement` methods to override

All methods can either return an object of the defined value or a Promise resolving to the object.

This allows you to implement the method synchronously or asynchronously, depending on your implementation.

`loadDevices(context: DeviceLoadContext)`

This method must always be overridden (as it is abstract in the base class).

You must fill the context with information about all devices of this adapter's instance.

You may call context.setTotalDevices(count: number) as soon as possible to let the GUI know how many devices in total will be loaded. This allows the GUI to show the loading progress.

This method is called when the user expands an instance in the list.

In most cases, you will get all states of your instance and fill the context with the relevant information.

Every item is an object of type DeviceInfo which has the following properties:

id (JSON object): a unique identifier of the device (it must be unique for your adapter instance only)
identifier (optional): a human-readable identifier of the device
name (string or translations): the human-readable name of this device
status (optional): the current status of the device, which has to be an object containing:
- connection (string): allowed values are: "connected" / "disconnected"
- rssi (number): rssi value of the connection
- battery (boolean / number): if boolean: false - the battery is empty. If number: the battery level of the device (shows also a battery symbol on the card)
- warning (boolean / string): if boolean: true indicates a warning. If a string: shows also the warning with mouseover
update (object, optional): firmware/software update information. If an update is available, an update indicator is shown on the card and the device can be filtered by "update available" in the GUI:
- available (boolean): true if an update is available for the device. Can be a literal value or read live from a state ({ stateId: 'my.0.device.updateAvailable' })
- version (string, optional): the currently installed version
- newVersion (string, optional): the version that is offered for installation (shown in the tooltip)
- To make the update indicator clickable (e.g. to start the update), add a device action with the reserved id update (see reserved action names)
actions (array, optional): an array of actions that can be performed on the device; each object contains:
- id (string): unique identifier to recognize an action (never shown to the user)
- icon (string): an icon shown on the button (see below for details)
- description (string, optional): a text that will be shown as a tooltip on the button
- handler (function, optional): function that will be called when the user clicks on the button; if not given, the button will be disabled in the UI
hasDetails (boolean, optional): if set to true, the row of the device can be expanded and details are shown below

Possible strings for device icons are here: TYPE ICONS
Possible strings for action icons are here: ACTION NAMES
Possible strings for configuration icons are here: CONFIGURATION TYPES

`getInstanceInfo()`

This method allows the device manager tab to gather some general information about the instance. It is called when the user opens the tab.

If you override this method, the returned object must contain:

apiVersion (string): the supported API version; must be "v3"
actions (array, optional): an array of actions that can be performed on the instance; each object contains:
- id (string): unique identifier to recognize an action (never shown to the user)
- icon (string): an icon shown on the button (see below for details)
- title (string): the title shown next to the icon on the button
- description (string, optional): a text that will be shown as a tooltip on the button
- handler (function, optional): function that will be called when the user clicks on the button; if not given, the button will be disabled in the UI
communicationStateId (string, optional): the ID of the state that is used by backend for communication with front-end
identifierLabel (string or translations, optional): the human-readable label next to the identifier

`getDeviceDetails(id: DeviceId)`

This method is called if a device's hasDetails is set to true and the user clicks on the expander.

The returned object must contain:

id (JSON object): the id given as parameter to the method call
schema (Custom JSON form schema): the schema of the Custom JSON form to show below the device information
data (object, optional): the data used to populate the Custom JSON form

For more details about the schema, see here.

Please keep in mind that there is no "Save" button, so in most cases, the form shouldn't contain editable fields, but you may use sendTo<xxx> objects to send data to the adapter.

`DeviceManagement` handlers

InstanceInfo action handlers

These functions are called when the user clicks on an action (i.e., button) for an adapter instance.

The parameters of this function are:

context (object): object containing helper methods that can be used when executing the action
options (object): object containing the action value (if given)

The returned object must contain:

refresh (boolean): set this to true if you want the list to be reloaded after this action

This method can be implemented asynchronously and can take a lot of time to complete.

See below for how to interact with the user.

DeviceInfo action handlers

These functions are called when the user clicks on an action (i.e., button) for an adapter instance.

The parameters of this function are:

deviceId (JSON object): the id of the device
context (object): object containing helper methods that can be used when executing the action
options (object): object containing the action value (if given)

The returned object must contain:

refresh (string / boolean): the following values are allowed: - "device": if you want the device details to be reloaded after this action - "instance": if you want the entire device list to be reloaded after this action - false: if you don't want anything to be refreshed (important: this is a boolean, not a string!) or
url (string) This URL must be opened
target (string) Target window for url (_blank is default)

This method can be implemented asynchronously and can take a lot of time to complete.

See below for how to interact with the user.

DeviceInfo control handlers

These functions are called when the user clicks on a control (i.e., slider) in the device card.

The parameters of this method are:

deviceId (JSON object): the id that was given in loadDevices() --> [].id
controlId (string): the id that was given in loadDevices() --> [].controls[].id. There are some reserved control names, you can find the list below.
newState (string | number | boolean): new state for the control, that will be sent to a real device
context (object): object containing helper methods that can be used when executing the action

The returned object must be an ioBroker state object.

This method can be implemented asynchronously and can take a lot of time to complete.

DeviceInfo getState handlers

These functions are called when GUI requests the update of the state.

The parameters of this method are:

deviceId (JSON object): the id that was given in loadDevices() --> [].id
controlId (string): the id that was given in loadDevices() --> [].controls[].id
context (object): object containing helper methods that can be used when executing the action

The returned object must be an ioBroker state object.

This method can be implemented asynchronously and can take a lot of time to complete.

Action sequences

To allow your adapter to interact with the user, you can use "actions".

As described above, there are actions on the instance and on devices. The behavior of both methods is similar.

Inside an action method (handleInstanceAction() or handleDeviceAction()) you can perform arbitrary actions, like talking to a device or API, and you can interact with the user. For interactions, there are methods you can call on context:

Reserved action names

There are some reserved action names, you can find the list below:

status - This action is called when the user clicks on the status icon. So to implement the "click-on-status" functionality, the developer has to implement this action.
disable - This action will be called when the user clicks on the enabled icon. disable and enable actions cannot be together.
enable - This action will be called when the user clicks on the disabled icon. disable and enable actions cannot be together.
update - This action will be called when the user clicks on the update indicator (shown when DeviceInfo.update.available is true). Use it to start the firmware/software update of the device.

`showMessage(text: ioBroker.StringOrTranslated)`

Shows a message to the user.

The method has the following parameter:

text (string or translation): the text to show to the user

This asynchronous method returns (or rather: the Promise is resolved) once the user has clicked on "OK".

`showConfirmation(text: ioBroker.StringOrTranslated)`

Lets the user confirm an action by showing a message with an "OK" and "Cancel" button.

The method has the following parameter:

text (string or translation): the text to show to the user

This asynchronous method returns (or rather: the Promise is resolved) once the user has clicked a button in the dialog:

true if the user clicked "OK"
false if the user clicked "Cancel"

`showForm(schema: JsonFormSchema, options?: { data?: JsonFormData; title?: string; ignoreApplyDisabled?: boolean })`

Shows a dialog with a Custom JSON form that can be edited by the user.

The method has the following parameters:

schema (Custom JSON form schema): the schema of the Custom JSON form to show in the dialog
options (object, optional): options to configure the dialog further
- data (object, optional): the data used to populate the Custom JSON form
- title (string, optional): the dialog title
- ignoreApplyDisabled (boolean, optional): set to true to always enable the "OK" button even if the form is unchanged

This asynchronous method returns (or rather: the Promise is resolved) once the user has clicked a button in the dialog:

the form data, if the user clicked "OK"
undefined, if the user clicked "Cancel"

`openProgress(title: string, options?: {indeterminate?: boolean, value?: number, label?: string})`

Shows a dialog with a linear progress bar to the user. There is no way for the user to dismiss this dialog.

The method has the following parameters:

title (string): the dialog title
options (object, optional): options to configure the dialog further
- indeterminate (boolean, optional): set to true to visualize an unspecified wait time
- value (number, optional): the progress value to show to the user (if set, it must be a value between 0 and 100)
- label (string, optional): the label to show to the right of the progress bar; you may show the progress value in a human-readable way (e.g. "42%") or show the current step in multi-step progress (e.g. "Logging in...")

This method returns a promise that resolves to a ProgressDialog object.

Important: you must always call close() on the returned object before you may open any other dialog.

ProgressDialog has two methods:

update(update: { title?: string; indeterminate?: boolean; value?:number; label?: string; })
- Updates the progress dialog with new values
- The method has the following parameter:
  - update (object): what to update in the dialog
    - title (string, optional): change the dialog title
    - indeterminate (boolean, optional): change whether the progress is indeterminate
    - value (number, optional): change the progress value (if set, it must be a value between 0 and 100)
    - label (string, optional): change the label to the right of the progress bar
close()
- Closes the progress dialog (and allows you to open other dialogs)

`sendCommandToGui(command: BackendToGuiCommand)`

Sends command to GUI to add/update/delete devices or to update the status of a device.

It is suggested to use the state's ID directly in the DeviceInfo structure instead of sending the command every time to GUI on status update.

See the example below:

class MyAdapterDeviceManagement extends DeviceManagement<MyAdapter> {
    protected loadDevices(context: DeviceLoadContext<string>): void {
        const deviceInfo: DeviceInfo = {
            id: 'uniqieID',
            name: 'My device',
            icon: 'node', // find possible icons here: https://github.com/ioBroker/adapter-react-v5/blob/main/src/Components/DeviceType/DeviceTypeIcon.tsx#L68
            manufacturer: { objectId: 'uniqieID', property: 'native.manufacturer' },
            model: { objectId: 'uniqieID', property: 'native.model' },
            status: {
                battery: { stateId: 'uniqieID.DevicePower0.BatteryPercent' },
                connection: { stateId: 'uniqieID.online', mapping: { true: 'connected', false: 'disconnected' } },
                rssi: { stateId: 'uniqieID.rssi' },
            },
            hasDetails: true,
        };
        context.addDevice(deviceInfo);
    }
}

Device updates

If a device supports firmware/software updates, you can let the GUI show an update indicator on the device card and offer the user a way to start the update.

1. Declare the update on the device

Add the optional update property to the DeviceInfo you create in loadDevices():

const deviceInfo: DeviceInfo = {
    id: 'myDevice',
    name: 'My device',
    update: {
        // true if an update is available -> shows the update indicator on the card
        available: true,
        version: '1.2.0', // currently installed version (optional)
        newVersion: '1.3.0', // version offered for installation, shown in the tooltip (optional)
    },
    // ... other properties
};
context.addDevice(deviceInfo);

available (boolean, required): if true, the GUI shows an update indicator. As soon as at least one device has available: true, the user can also filter the list by "update available" in the GUI (since 3.1.1).
version (string, optional): the currently installed version.
newVersion (string, optional): the version that is offered for installation (shown in the tooltip).

All three fields can be a literal value or read live from a state/object, so you don't have to push updates manually whenever the value changes:

update: {
    available: { stateId: 'my-adapter.0.myDevice.updateAvailable' },
    version: { stateId: 'my-adapter.0.myDevice.fwVersion' },
    newVersion: { objectId: 'my-adapter.0.myDevice', property: 'native.latestVersion' },
},

2. Make the indicator clickable (start the update)

By itself the indicator is only informational. To let the user start the update by clicking on it, add a device action with the reserved id update (use the ACTIONS.UPDATE constant). Its handler is called when the user clicks the indicator:

import { ACTIONS } from '@iobroker/dm-utils';

const deviceInfo: DeviceInfo = {
    id: 'myDevice',
    name: 'My device',
    update: { available: true, version: '1.2.0', newVersion: '1.3.0' },
    actions: [
        {
            id: ACTIONS.UPDATE, // === 'update'
            icon: 'update',
            description: 'Update firmware',
            handler: async (deviceId, context) => {
                const confirmed = await context.showConfirmation(`Update ${deviceId} to 1.3.0?`);
                if (!confirmed) {
                    return { refresh: 'none' };
                }

                const progress = await context.openProgress('Updating...', { indeterminate: true });
                try {
                    await this.startFirmwareUpdate(deviceId); // your own update logic
                } finally {
                    await progress.close();
                }

                // reload the device list so the new version / cleared indicator is shown
                return { refresh: 'devices' };
            },
        },
    ],
};

The handler follows the same rules as any other device action handler (see DeviceInfo action handlers): it may run asynchronously and returns a refresh response (e.g. { refresh: 'devices' }) to reload the list once the update has finished.

Clickable battery indicator

If the device status contains a battery property, the GUI shows a battery indicator on the device card. By itself this indicator is only informational.

To let the user click on it (e.g. to open your own dialog with the battery history or the battery type), add a device action with the reserved id battery (use the ACTIONS.BATTERY constant):

import { ACTIONS } from '@iobroker/dm-utils';

const deviceInfo: DeviceInfo = {
    id: 'myDevice',
    name: 'My device',
    status: { battery: 42 },
    actions: [
        {
            id: ACTIONS.BATTERY, // === 'battery'
            description: 'Show battery details',
            handler: async (deviceId, context) => {
                await context.showMessage(`The battery of ${deviceId} was changed on 2026-01-15`);
                return { refresh: 'none' };
            },
        },
    ],
};

The indicator becomes a button for all battery representations (percentage, voltage, 'charging' and boolean). The action itself is not shown as a normal action button on the card, exactly like the reserved status and update actions. The description is appended to the tooltip of the indicator.

Custom status indicators

Besides the built-in indicators (connection, RSSI, battery, warning, update, enabled), you can add your own entries to the status line of a device card and to the toolbar of the instance.

Actions in the status line

Any action can be moved from the button row at the bottom of the card into the status line with placement: 'status'. It keeps all its features (icon, color, title, confirmation, inputBefore, url, …) and is not rendered a second time in the footer:

const actions = [{ id: 'openLog', icon: 'lines', placement: 'status', handler: openLogHandler }];

Indicators

DeviceInfo.indicators (device card) and InstanceDetails.indicators (toolbar) describe indicators whose appearance follows a state or object value live. Every visual property accepts either a literal value or a { stateId } / { objectId, property } reference, so the GUI updates without any interaction of the adapter:

const deviceInfo: DeviceInfo = {
    id: 'sensor-1',
    name: 'Window sensor kitchen',
    actions: [{ id: 'openLog', icon: 'lines', description: 'Open device log', handler: openLogHandler }],
    indicators: [
        {
            id: 'linkQuality',
            value: { stateId: 'zigbee.0.abc.link_quality' },
            icon: 'fa-wifi',
            showValue: true,
            unit: 'lqi',
            tooltip: { en: 'Link quality', de: 'Verbindungsqualität' },
            // the first matching level wins and overrides icon, color and text
            levels: [{ max: 50, color: 'error' }, { max: 100, color: 'warning' }, { color: 'ok' }],
            // a click triggers the action 'openLog' - it is not shown as a button anymore
            actionId: 'openLog',
        },
        {
            id: 'tamper',
            value: { stateId: 'zigbee.0.abc.tamper' },
            icon: 'fa-eye',
            colorOn: 'error',
            tooltip: 'Tamper contact triggered',
            // hidden as long as the value is falsy (default of hideIfEmpty)
        },
    ],
};

Colors may be an explicit CSS color, primary, secondary or one of the semantic tokens ok, warning, error, info and inactive. The tokens are resolved against the current theme, so your indicators look the same as the built-in ones in the light and in the dark theme.

If actionId is given, the click runs through the normal action flow, including confirmation, inputBefore, url, the progress dialog and the refresh handling.

Indicators the user can switch off

An indicator marked with configurable: true can be shown or hidden by the user in the toolbar. The choice is stored in the browser per instance and never reaches the adapter. Use defaultVisible: false for rarely needed information, so it does not clutter the cards of everybody:

const indicator: StatusIndicator = {
    id: 'tamper',
    value: { stateId: 'zigbee.0.abc.tamper' },
    icon: 'fa-eye',
    colorOn: 'error',
    label: { en: 'Tamper contact', de: 'Sabotagekontakt' },
    configurable: true,
    defaultVisible: false,
};

Indicators with the same id — typically the same indicator on many devices — are configured together, so use stable IDs. If a hidden indicator references an action, that action is hidden as well.

Text buttons instead of icons

Every action (instance action as well as device action) can be rendered as a text button instead of an icon button. Just set a title; then no icon is required and no "question mark" fallback icon is shown:

actions: [
    {
        id: 'reboot',
        title: 'Reboot', // rendered as a text button
        variant: 'outlined', // 'text' (default), 'outlined' or 'contained'
        description: 'Reboot the device', // shown as tooltip
        handler: async deviceId => {
            await this.reboot(deviceId);
            return { refresh: 'none' };
        },
    },
],

title and description may also be translated objects ({ en: 'Reboot', de: 'Neustart' }). If you provide both title and icon, the icon is shown in front of the text.

Migration from 1.x/2.x to 3.x

Between versions 1.x/2.x and 3.x, there are some breaking changes. Please also have a look at the changelog below for more information.

API version

This one is easy to miss: you must bump the apiVersion returned from getInstanceInfo() from 'v1' (used in 1.x and 2.x) to 'v3'.

protected getInstanceInfo(): RetVal<InstanceDetails> {
    return {
        apiVersion: 'v3', // was 'v1' in 1.x/2.x
        // ...
    };
}

If you don't override getInstanceInfo(), the base class already returns 'v3' for you and there is nothing to do. But if you do override it and forget to update this value, the GUI will not communicate with your instance correctly.

Incremental loading of devices

In versions 1.x and 2.x, the listDevices() method had to return the full list of devices. In version 3.x, this method was replaced by loadDevices(context: DeviceLoadContext) that allows incremental loading of devices.

Instead of creating and returning an array of DeviceInfo objects, you have to call context.addDevice(deviceInfo) for each device you want to add to the list.

You may also call context.setTotalDevices(count: number) as soon as possible to let the GUI know how many devices in total will be loaded.

Refresh response of device actions

In version 3.x, the refresh response of device actions has changed.

Version 1.x/2.x	Version 3.x	Description
`true`	`'all'`	the instance information as well as the entire device list will be reloaded
`false`	`'none'`	nothing will be reloaded
`'device'`	`'devices'`	the entire device list will be reloaded
`'instance'`	`'instance'`	(unchanged) only the instance information will be reloaded

Icon names

You can use the following icon names for actions and controls. Icons are resolved by the action/control id or by the icon property. You can also provide a data:image/... base64 string for custom icons.

Action and control icons (by name)

Name(s)	MUI Icon	Description
`edit`, `rename`	Edit	Edit or rename an item
`delete`	Delete	Delete an item
`refresh`	Refresh	Refresh / reload
`newDevice`, `new`, `add`	Add	Add or create a new item
`discover`, `search`	Search	Discover or search for devices
`unpairDevice`, `unpair`	LinkOff	Unpair / unlink a device
`pairDevice`, `pair`	Link	Pair / link a device
`identify`	NotListedLocation	Identify / locate a device
`play`	PlayArrow	Start playback
`stop`	Stop	Stop playback
`pause`	Pause	Pause playback
`forward`, `next`	FastForward	Skip forward / next track
`rewind`, `previous`	FastRewind	Skip backward / previous track
`lamp`, `light`	Lightbulb	Light / lamp control
`backlight`	Fluorescent	Backlight control
`dimmer`	WbIncandescent	Dimmer control
`socket`	Power	Power socket control
`settings`	Settings	Settings / configuration
`users`, `group`	Group	User group
`user`	Person	Single user
`update`	Upgrade	Update / upgrade
`qrcode`	QrCode	QR code
`info`	Info	Information
`lines`	Article	Text lines / log
`web`	Launch	Open web link
`battery`	BatteryFull	Battery
`batteryLow`	BatteryAlert	Empty / low battery
`batteryAlert`	BatteryAlert	Empty / low battery
`batteryCharging`	BatteryChargingFull	Charging battery

Any unrecognized name renders a QuestionMark icon as fallback, except if the action has a title (see Text buttons instead of icons) — in that case no icon is shown at all.

Legacy Font Awesome icons

These names are supported for backward compatibility. Prefer the names from the table above.

Name(s)	MUI Icon	Description
`fa-trash-can`, `fa-trash`	Delete	Delete
`fa-pen`	Edit	Edit
`fa-redo-alt`	Refresh	Refresh / redo
`fa-plus`	Add	Add
`fa-qrcode`, `qrcode`	QrCode	QR code
`fa-wifi`	Wifi	Wi-Fi enabled
`fa-wifi-slash`	WifiOff	Wi-Fi disabled
`fa-bluetooth`	Bluetooth	Bluetooth enabled
`fa-bluetooth-slash`	BluetoothDisabled	Bluetooth disabled
`fa-eye`	Visibility	View / visible
`fa-search`	Search	Search
`fa-unlink`	LinkOff	Unlink
`fa-link`	Link	Link
`fa-search-location`	NotListedLocation	Search location / identify
`fa-play`	PlayArrow	Play
`fa-stop`	Stop	Stop
`fa-pause`	Pause	Pause

Changelog

3.2.0 (2026-07-26)

(@GermanBluefox) Added placement: 'status' to render an action in the status line
(@GermanBluefox) Added custom status indicators for devices (DeviceInfo.indicators) and instances (InstanceDetails.indicators)
(@GermanBluefox) Added user-configurable visibility of indicators

3.1.4 (2026-07-25)

(@GermanBluefox) Added reserved action ACTIONS.BATTERY to make the battery indicator clickable
(@GermanBluefox) Allowed title and variant for device actions to render them as text buttons
(@GermanBluefox) Added battery icon names

3.1.3 (2026-07-06)

(@GermanBluefox) Catch serialization errors by sendTo

3.1.1 (2026-06-19)

(@GermanBluefox) Added possibility to filter the devices with updates available
(@GermanBluefox) Updated packages

3.0.19 (2026-04-09)

(@GermanBluefox) Updated Json-Config types

3.0.17 (2026-03-31)

(@UncleSamSwiss) Fixed type of log property in DeviceManagement class

3.0.16 (2026-03-31)

(@UncleSamSwiss) Fixed export of ACTIONS constants
(@UncleSamSwiss) Added exports for refresh response types

3.0.15 (2026-03-30)

(@GermanBluefox) Made the title of the progress dialog multi-language

3.0.14 (2026-03-30)

(@GermanBluefox) Updated JsonConfig
(@GermanBluefox) Added divider, header and group to controls

3.0.9 (2026-03-28)

(@GermanBluefox) Added description of icons and the possibility to show information directly on the card
(@GermanBluefox) Added style property for action and control buttons

3.0.3 (2026-03-26)

(@UncleSamSwiss) Enabled incremental loading of devices
(@UncleSamSwiss) Removed direct access to DeviceManagement.handleXxx() methods (use handler and similar properties instead)
(@UncleSamSwiss) Added identifier property to DeviceInfo for human-readable identifiers
(@UncleSamSwiss) Device refresh responses can no longer be a boolean and 'device' was renamed to 'devices'.
(@UncleSamSwiss) Added info icon and possibility for actions to be a link (by providing a url property instead of a handler function)

2.0.2 (2026-01-28)

(@GermanBluefox) BREAKING: Admin/GUI must have version 9 (or higher) of dm-gui-components
(@GermanBluefox) Added types to update the status of a device directly from the state
(@GermanBluefox) Added backend to GUI communication possibility
(@GermanBluefox) Added dm:deviceInfo command
(@GermanBluefox) Added dm:deviceStatus command

1.0.16 (2026-01-02)

(@GermanBluefox) Added ignoreApplyDisabled flag
(@GermanBluefox) Added update icon

1.0.13 (2025-10-21)

(@GermanBluefox) Updated packages

1.0.10 (2025-05-05)

(@GermanBluefox) Added timeout property to actions
(@GermanBluefox) Updated packages

1.0.9 (2025-01-25)

(@GermanBluefox) Added copyToClipboard dialog button

1.0.8 (2025-01-24)

(@GermanBluefox) Removed headerTextColor to device info

1.0.6 (2025-01-14)

(@GermanBluefox) Added the connection type indication

1.0.5 (2025-01-11)

(@GermanBluefox) Added action ENABLE_DISABLE and enabled status

1.0.0 (2025-01-08)

(@GermanBluefox) Added disabled options for a device
(@GermanBluefox) Major release just because it is good enough. No breaking changes.

0.6.11 (2024-12-11)

(@GermanBluefox) Do not close handler for progress

0.6.10 (2024-12-10)

(@GermanBluefox) Export BackEndCommandJsonFormOptions type

0.6.9 (2024-11-22)

(@GermanBluefox) Added a max-width option for form

0.6.8 (2024-11-22)

(@GermanBluefox) Allowed grouping of devices

0.6.7 (2024-11-20)

(@GermanBluefox) Updated types

0.6.6 (2024-11-18)

(@GermanBluefox) Added configurable buttons for form

0.6.0 (2024-11-17)

(@GermanBluefox) used new ioBroker/eslint-config lib and changed prettifier settings
(@GermanBluefox) updated JsonConfig types

0.5.0 (2024-08-30)

(bluefox) Migrated to eslint 9

0.4.0 (2024-08-30)

(bluefox) Added state type for JSON config

0.3.1 (2024-07-18)

(bluefox) Added qrCode type for JSON config

0.3.0 (2024-07-17)

(bluefox) packages updated
(bluefox) Updated JSON config types

0.2.2 (2024-06-26)

(bluefox) packages updated

0.2.0 (2024-05-29)

(bluefox) enhanced type exports
(bluefox) added confirmation and input text options

0.1.9 (2023-12-25)

(foxriver76) enhanced type exports

0.1.8 (2023-12-17)

(bluefox) corrected control error

0.1.7 (2023-12-17)

(bluefox) added channel info

0.1.5 (2023-12-16)

(bluefox) extended controls with unit and new control types

0.1.4 (2023-12-13)

(bluefox) added error codes

0.1.3 (2023-12-10)

(bluefox) added some fields to DeviceInfo interface
(bluefox) added control possibilities

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Name		Name	Last commit message	Last commit date
Latest commit History 264 Commits
.github		.github
.vscode		.vscode
build		build
examples		examples
src		src
.gitignore		.gitignore
.releaseconfig.json		.releaseconfig.json
CLAUDE.md		CLAUDE.md
LICENSE		LICENSE
README.md		README.md
eslint.config.mjs		eslint.config.mjs
package-lock.json		package-lock.json
package.json		package.json
prettier.config.mjs		prettier.config.mjs
tasks.ts		tasks.ts
tsconfig.json		tsconfig.json

Uh oh!

Folders and files

Latest commit

History

Repository files navigation

dm-utils

How to use

Core concepts

Structure

Actions

Controls

Communication

Access adapter methods

Error Codes

Examples

DeviceManagement methods to override

loadDevices(context: DeviceLoadContext)

getInstanceInfo()

getDeviceDetails(id: DeviceId)

DeviceManagement handlers

InstanceInfo action handlers

DeviceInfo action handlers

DeviceInfo control handlers

DeviceInfo getState handlers

Action sequences

Reserved action names

showMessage(text: ioBroker.StringOrTranslated)

showConfirmation(text: ioBroker.StringOrTranslated)

showForm(schema: JsonFormSchema, options?: { data?: JsonFormData; title?: string; ignoreApplyDisabled?: boolean })

openProgress(title: string, options?: {indeterminate?: boolean, value?: number, label?: string})

sendCommandToGui(command: BackendToGuiCommand)

Device updates

1. Declare the update on the device

2. Make the indicator clickable (start the update)

Clickable battery indicator

Custom status indicators

Actions in the status line

Indicators

Indicators the user can switch off

Text buttons instead of icons

Migration from 1.x/2.x to 3.x

API version

Incremental loading of devices

Refresh response of device actions

Icon names

Action and control icons (by name)

Legacy Font Awesome icons

Changelog

3.2.0 (2026-07-26)

3.1.4 (2026-07-25)

3.1.3 (2026-07-06)

3.1.1 (2026-06-19)

3.0.19 (2026-04-09)

3.0.17 (2026-03-31)

3.0.16 (2026-03-31)

3.0.15 (2026-03-30)

3.0.14 (2026-03-30)

3.0.9 (2026-03-28)

3.0.3 (2026-03-26)

2.0.2 (2026-01-28)

1.0.16 (2026-01-02)

1.0.13 (2025-10-21)

1.0.10 (2025-05-05)

1.0.9 (2025-01-25)

1.0.8 (2025-01-24)

1.0.6 (2025-01-14)

1.0.5 (2025-01-11)

1.0.0 (2025-01-08)

0.6.11 (2024-12-11)

0.6.10 (2024-12-10)

0.6.9 (2024-11-22)

0.6.8 (2024-11-22)

0.6.7 (2024-11-20)

0.6.6 (2024-11-18)

0.6.0 (2024-11-17)

0.5.0 (2024-08-30)

0.4.0 (2024-08-30)

0.3.1 (2024-07-18)

0.3.0 (2024-07-17)

0.2.2 (2024-06-26)

`DeviceManagement` methods to override

`loadDevices(context: DeviceLoadContext)`

`getInstanceInfo()`

`getDeviceDetails(id: DeviceId)`

`DeviceManagement` handlers

`showMessage(text: ioBroker.StringOrTranslated)`

`showConfirmation(text: ioBroker.StringOrTranslated)`

`showForm(schema: JsonFormSchema, options?: { data?: JsonFormData; title?: string; ignoreApplyDisabled?: boolean })`

`openProgress(title: string, options?: {indeterminate?: boolean, value?: number, label?: string})`

`sendCommandToGui(command: BackendToGuiCommand)`