Sensors

nodekit.sensors.KeySensor pydantic-model

Fields:

• duration_msec (TimeDurationMsec | None)
• sensor_type (Literal['KeySensor'])
• keys (list[PressableKey])

Validators:

• canonicalize_keys → keys

keys pydantic-field

keys: list[PressableKey]

The keys that triggers the Sensor when pressed down.

nodekit.sensors.WaitSensor pydantic-model

A Sensor that triggers when the specified time has elapsed since the start of the Node.

Fields:

• sensor_type (Literal['WaitSensor'])
• duration_msec (TimeDurationMsec)

duration_msec pydantic-field

duration_msec: TimeDurationMsec

The number of milliseconds from the start of the Node when the Sensor triggers.

nodekit.sensors.SelectSensor pydantic-model

Fields:

• duration_msec (TimeDurationMsec | None)
• sensor_type (Literal['SelectSensor'])
• choices (dict[str, Card])

nodekit.sensors.MultiSelectSensor pydantic-model

Fields:

• duration_msec (TimeDurationMsec | None)
• sensor_type (Literal['MultiSelectSensor'])
• choices (dict[str, Card])
• min_selections (int)
• max_selections (int | None)
• confirm_button (Card)

Validators:

• validate_selections_vals

max_selections pydantic-field

max_selections: int | None = None

If None, the selection can contain up to the number of available Cards.

min_selections pydantic-field

min_selections: int

The minimum number of Cards before the Sensor fires.

nodekit.sensors.SliderSensor pydantic-model

Fields:

• duration_msec (TimeDurationMsec | None)
• sensor_type (Literal['SliderSensor'])
• num_bins (int)
• initial_bin_index (int)
• show_bin_markers (bool)
• orientation (Literal['horizontal', 'vertical'])
• region (Region)
• confirm_button (Card | None)

confirm_button pydantic-field

confirm_button: Card | None = None

If provided, the agent must click this button to confirm their slider selection.

nodekit.sensors.TextEntrySensor pydantic-model

Fields:

• duration_msec (TimeDurationMsec | None)
• sensor_type (Literal['TextEntrySensor'])
• prompt (str)
• font_size (PixelSize)
• min_length (int)
• max_length (int | None)
• region (Region)

font_size pydantic-field

font_size: PixelSize = 20

The height of the em-box, in Board units.

max_length pydantic-field

max_length: int | None = None

The maximum number of characters the user can enter. If None, no limit.

min_length pydantic-field

min_length: int = 1

The minimum number of characters the user must enter before the Sensor fires.

prompt pydantic-field

prompt: str = ''

The initial placeholder text shown in the free text response box. It disappears when the user selects the element.

nodekit.sensors.ProductSensor pydantic-model

Fields:

• duration_msec (TimeDurationMsec | None)
• sensor_type (Literal['ProductSensor'])
• children (dict[str, Sensor])

nodekit.sensors.SumSensor pydantic-model

Fields:

• duration_msec (TimeDurationMsec | None)
• sensor_type (Literal['SumSensor'])
• children (dict[str, Sensor])