ioBroker Trigger icon

ioBroker Trigger

ioBroker Input Trigger

Overview

This node acts as a trigger for ioBroker events, allowing workflows in n8n to start based on changes or new entries within an ioBroker instance. It supports three main trigger types:

  • State: Triggers when a specific state changes.
  • Object: Triggers when a specific object changes.
  • Logs: Triggers when a new log entry is created.

Typical use cases include monitoring device states, reacting to configuration changes, or processing log messages from ioBroker adapters. For example, you could trigger a workflow whenever a temperature sensor's state updates or when an error log entry appears in the system logs.

Properties

Name Meaning
Type The type of event to trigger on. Options: State (trigger on state change), Object (trigger on object change), Logs (trigger on new log entry).
Object ID The ioBroker object ID to monitor (e.g., javascript.0.myObject). Required if Type is state or object.
File Name The file name or pattern to monitor (e.g., main/vis-views.JSON). Shown only if Type is file.
With Content Boolean flag indicating whether to include file content. Shown only if Type is file.
Log Level Filter for log entries by severity level. Options: Any, Debug, Error, Info, Warning. Shown only if Type is log.
Log Instance Name or ID Filter logs by instance name or ID (e.g., javascript.0). Can be selected from a list or specified via expression. Shown only if Type is log.

Output

The node outputs JSON objects representing the triggered event data:

  • For State triggers: Outputs the full state object containing details such as value, acknowledgment status, timestamps, etc.
  • For Object triggers: Outputs the full object that changed.
  • For Logs triggers: Outputs parsed log entry details including severity level, timestamp, message, instance, and process information.

Binary data output is not applicable for this node.

Dependencies

  • Requires connection credentials to an ioBroker instance, including host and port.
  • Uses WebSocket communication with ioBroker's AdminConnection and SocketClient libraries.
  • The node depends on the ioBroker API being accessible and properly configured to allow subscriptions and queries.
  • No additional environment variables are required beyond the provided credentials.

Troubleshooting

  • Connection errors: If the node cannot connect to ioBroker, verify the host and port settings and ensure network accessibility.
  • Permission issues: Insufficient permissions in ioBroker may prevent subscription or data retrieval; ensure the API user has appropriate rights.
  • No events triggered: Confirm that the specified Object ID or log filters match existing entities and that events actually occur.
  • Log filtering: If no logs appear, check that the log level and instance filters are correctly set.
  • Manual trigger issues: When manually triggering, ensure the node parameters are valid and the ioBroker connection is active.

Common error messages relate to connection timeouts, permission denials, or invalid object IDs. Resolving these typically involves checking credentials, network access, and ioBroker configuration.

Links and References

Discussion