Overview
This node allows reading various types of data from an ioBroker instance via its WebSocket API. It supports fetching states, objects, files, logs, rooms, functions, and devices. This is useful for workflows that need to integrate with ioBroker to monitor or retrieve configuration and runtime information.
Common scenarios include:
- Reading the current value or metadata of a specific state or object.
- Fetching log entries filtered by level or instance.
- Retrieving file contents stored in ioBroker.
- Listing rooms, functions, or devices with optional language localization and icon inclusion.
Example use cases:
- Automating monitoring by reading sensor states.
- Extracting logs for error analysis.
- Accessing configuration files or enumerations for further processing.
Properties
| Name | Meaning |
|---|---|
| Type | The type of data to read. Options: Devices, File, Functions, Logs, Object, Rooms, State |
| Object ID (oid) | The ioBroker object ID to read (required for types: state, object, file). Example: javascript.0.myObject |
| File Name | The file name or pattern to read (required for type: file). Example: main/vis-views.JSON |
| Number of Logs | Number of log entries to fetch (for type: log). Default 10 |
| Log Level | Filter logs by level (for type: log). Options: Any, Debug, Error, Info, Warning |
| Log Instance Name or ID | Filter logs by instance adapter (for type: log). Select from list or specify ID via expression |
| Language | Language code for localized names (for types: rooms, functions, devices). Options include de, en, es, fr, it, pl, pt, ru, uk, zh-cn |
| With Icons | Whether to include icons in the returned objects (for types: rooms, functions) |
| Ignore Empty Items | Whether to ignore rooms or functions without items (for types: rooms, functions) |
Output
The node outputs an array of items, each corresponding to one input item processed. Each output item contains:
- For state: JSON object with the requested state ID as key and its state data as value. If not found, returns
{error: "State not found"}. - For object: JSON object with the requested object ID as key and its object data as value. If not found, returns
{error: "Object not found"}. - For file: JSON object containing
fileName,mimeType, andcontent(string if text). If binary, the file content is also provided in the binary property. - For log: JSON object with a
logsarray containing log entries matching filters. - For rooms, functions, devices: JSON object with an
enumsordevicesarray listing the respective entities, optionally filtered by language, icons, and empty items.
Binary data output is supported for file reads when the file content is binary.
Dependencies
- Requires an active connection to an ioBroker instance via WebSocket.
- Needs credentials providing host and port of the ioBroker server.
- Uses an internal ioBroker WebSocket client library to communicate with the server.
- The node expects the ioBroker API to be accessible and properly configured.
Troubleshooting
- Connection errors: If the node cannot connect, verify the host and port are correct and the ioBroker server is reachable.
- Permission issues: Ensure the credentials used have sufficient permissions to read the requested data.
- Object or state not found: Check that the specified object ID or state ID exists in ioBroker.
- Log retrieval issues: Filtering by instance requires valid instance IDs; ensure the instance exists.
- File read errors: Verify the file path and name are correct and accessible.
- Timeouts or disconnects: Network instability or server overload can cause timeouts; retry or check server health.
Error messages typically indicate connection problems or missing data and suggest checking configuration or permissions.