@iobroker/dm-utils 3.0.3 → 3.0.5

package/README.md

@@ -388,12 +388,75 @@ In version 3.x, the refresh response of device actions has changed.
 | `'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                        |
+
+Any unrecognized name renders a **QuestionMark** icon as fallback.
+
+### 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
 
 <!--
 	Placeholder for the next version (at the beginning of the line):
 	### **WORK IN PROGRESS**
 -->
+### 3.0.5 (2026-03-27)
+- (@GermanBluefox) Added description of icons and the possibility to show an information directly on the card
+
 ### 3.0.3 (2026-03-26)
 
 - (@UncleSamSwiss) Enabled incremental loading of devices

package/build/types/base.d.ts

@@ -1,4 +1,4 @@
-import type { ActionContext, ConfigConnectionType, ErrorResponse, MessageContext, ValueOrObject, ValueOrState, ValueOrStateOrObject } from '..';
+import type { ActionContext, ConfigConnectionType, DeviceDetails, ErrorResponse, MessageContext, ValueOrObject, ValueOrState, ValueOrStateOrObject } from '..';
 import type { ApiVersion, DeviceId, DeviceStatus, RetVal } from './common';
 type ActionType = 'api' | 'adapter';
 export type Color = 'primary' | 'secondary' | (string & {});
@@ -142,6 +142,8 @@ export interface DeviceInfo<T extends ActionType = 'api', TId extends DeviceId =
     controls?: DeviceControl<T, TId>[];
     /** If true, the button `more` will be shown on the card and called `dm:deviceDetails` action to get the details  */
     hasDetails?: ValueOrStateOrObject<boolean>;
+    /** Following optional information will be shown on the card directly. Do not try to show a table or other big objects on a card. It is suggested to use "state" components */
+    customInfo?: DeviceDetails<TId>;
     /** Device type for grouping */
     group?: {
         key: string;

package/build/types/common.d.ts

@@ -925,6 +925,7 @@ export type ActionButton = {
     /** Name of the attribute in data that should be copied to clipboard */
     copyToClipboardAttr?: string;
 };
+export type JsonFormData = Record<string, any>;
 export type BackEndCommandJsonFormOptions = {
     /** Data for the form */
     data?: JsonFormData;
@@ -936,13 +937,12 @@ export type BackEndCommandJsonFormOptions = {
     maxWidth?: 'xs' | 'sm' | 'md' | 'lg' | 'xl';
     /** Minimal width of the dialog */
     minWidth?: number;
-    /** Do not translate title */
+    /** Do not translate a title */
     noTranslation?: boolean;
     /** Always allow the apply button. Even when nothing was changed */
     ignoreApplyDisabled?: boolean;
 };
 export type JsonFormSchema = ConfigItemPanel | ConfigItemTabs;
-export type JsonFormData = Record<string, any>;
 export interface DeviceDetails<TId extends DeviceId = DeviceId> {
     id: TId;
     schema: JsonFormSchema;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/dm-utils",
-  "version": "3.0.3",
+  "version": "3.0.5",
   "description": "ioBroker Device Manager utilities for backend",
   "main": "build/index.js",
   "publishConfig": {