Skip to content

← diagnostics package

NoDataAlert

Alert if no data is present.

Checks that data is coming through the pipeline, and gives a user alert using a popup window or log message in cases where either no data (Packets are either None or contain no data), has come through for a configurable amount of time. Verbose mode also writes a log message once per second indicating whether data is being received or not. A 'no-data' or 'data-ok' message is sent once per second to the notifs output port in the form of a marker stream (which could be, for example, connected to an LSLOutput node to notify a remote application). Version 1.1.1

Ports/Properties

data

Data to process.

verbose name
Data
default value
None
port type
DataPort
value type
Packet (can be None)
data direction
INOUT

notifs

Notifications/alerts as markers in a marker stream

verbose name
Notifs
default value
None
port type
DataPort
value type
Packet (can be None)
data direction
OUT

allowed_gap

Amount of time, in seconds, for which there can be no data before an alert is sounded (at any time when the pipeline is running). Set both this param and markers_allowed_gap to 0 to skip checking for data.

verbose name
Allowed Gap
default value
3
port type
IntPort
value type
int (can be None)

allowed_startup_delay

Time, in seconds, by which to delay starting to check for no data when the pipeline is first launched (ie., to give the device time to connect, or start an LSL stream, etc.)

verbose name
Allowed Startup Delay
default value
15
port type
IntPort
value type
int (can be None)

markers_allowed_gap

Specify a separate allowed interval for any marker streams (since they may emit data at greater intervals). Setting this to 0 will not check any marker streams for data.

verbose name
Markers Allowed Gap
default value
0
port type
IntPort
value type
int (can be None)

exclude_streams

A list of streams to exclude from the data check. Leaving this empty (None) will sound the alert if any stream in the data packet does not have data for the specified period of time.

verbose name
Exclude Streams
default value
[]
port type
ListPort
value type
list (can be None)

Pop up a notification window when no data is found after the number of seconds in the allowed_gap parameter. When set to false a message is printed to the log stream only.

verbose name
Popup Window
default value
False
port type
BoolPort
value type
bool (can be None)

verbose

Print a log message once a second indicating whether data is being received or not (after the startup delay). If false, log messages are only printed if data is not being received.

verbose name
Verbose
default value
False
port type
BoolPort
value type
bool (can be None)

notif_frequency

Frequency, in seconds, at which to send notifications and print log messages.

verbose name
Notif Frequency
default value
1
port type
IntPort
value type
int (can be None)

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

verbose name
Set Breakpoint (Debug Only)
default value
False
port type
BoolPort
value type
bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

verbose name
Metadata
default value
{}
port type
DictPort
value type
dict (can be None)