ComfyUI Node: Unified Notification

Unified Notification:

The Notif-UnifiedNotification node is designed to provide a comprehensive notification system within the ComfyUI framework. It allows you to configure and trigger notifications based on specific conditions, enhancing the user experience by ensuring important events are communicated effectively. This node is particularly useful for scenarios where you need to be alerted about certain actions or states within your workflow, such as when a queue is empty or when a specific event occurs. By integrating system notifications, sound alerts, and customizable messages, the UnifiedNotification node offers a versatile solution for keeping you informed and engaged with your processes.

Unified Notification Input Parameters:

any

This parameter accepts any type of input, serving as a placeholder to ensure compatibility with various data types. It does not directly impact the notification process but is required for the node's operation.

mode

The mode parameter determines when the notification should be triggered. It offers two options: "always" and "on empty queue". Selecting "always" will trigger the notification regardless of the queue state, while "on empty queue" will only trigger the notification when the queue is empty. This allows for flexible notification strategies based on your specific needs.

system_notification

This boolean parameter controls whether a system notification should be displayed. By default, it is set to True, meaning that a system notification will be shown when the node is triggered. This feature is useful for receiving visual alerts directly on your system.

notification_text

The notification_text parameter allows you to customize the message that will be displayed when the notification is triggered. By default, it is set to "Your notification has triggered." This text can be tailored to provide specific information relevant to the event or condition being monitored.

play_sound

This boolean parameter determines whether a sound should be played when the notification is triggered. It is set to True by default, enabling audio alerts to accompany the notification. This can be particularly useful in environments where visual notifications might be missed.

volume

The volume parameter controls the loudness of the sound played during the notification. It accepts a float value ranging from 0 to 1, with a default value of 0.5. This allows you to adjust the sound level to suit your environment and preferences.

file

This parameter specifies the audio file to be played when the notification is triggered. By default, it is set to "notify.mp3". You can change this to any valid audio file path to customize the sound associated with the notification.

Unified Notification Output Parameters:

ui

The ui output parameter provides a dictionary containing the configuration and state of the notification, including the notification text and other settings. This output is primarily used for debugging and ensuring that the notification settings are correctly applied.

result

The result output parameter returns a tuple, typically containing a single integer value (0). This output is used to indicate the successful execution of the node, confirming that the notification process has been completed.

Unified Notification Usage Tips:

• Customize the notification_text to provide clear and specific information about the event or condition being monitored, ensuring that the notification is meaningful and actionable.
• Adjust the volume parameter to ensure that audio notifications are audible in your environment, but not disruptive. Test different levels to find the optimal setting.
• Use the mode parameter strategically to avoid unnecessary notifications. For example, setting it to "on empty queue" can help reduce notification fatigue by only alerting you when specific conditions are met.

Unified Notification Common Errors and Solutions:

Notification not triggering

• Explanation: The notification might not trigger if the mode is set to "on empty queue" and the queue is not empty.
• Solution: Ensure that the queue is indeed empty or change the mode to "always" to trigger notifications regardless of the queue state.

Sound not playing

• Explanation: The specified audio file might be missing or incorrectly referenced.
• Solution: Verify that the file parameter points to a valid audio file path and that the file exists in the specified location.

System notification not appearing

• Explanation: System notifications might be disabled or blocked by your operating system settings.
• Solution: Check your system's notification settings to ensure that notifications from ComfyUI are allowed and not blocked.