Bpod Finite-State Machine

Definition of a Bpod Finite-State Machine

Type object
File match *.bpod-fsm.json *.bpod-fsm.yaml *.bpod-fsm.yml bpod-fsm.json bpod-fsm.yaml bpod-fsm.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/bpod-finite-state-machine/latest.json
Source https://raw.githubusercontent.com/int-brain-lab/bpod-core/main/.schema/statemachine.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Definition of a Bpod finite-state machine.

Properties

name string

The name of the state machine

Default: "State Machine"
minLength=1
states object

A collection of states.

global_timers object

A collection of global timers.

global_counters object

A collection of global counters.

conditions object

A collection of conditions.

Definitions

Actions Record<string, integer>

A collection of actions.

Condition object

A condition in the state machine.

channel string required

The channel or global timer attached to the condition

minLength=1
value boolean required

The value of the condition channel if the condition is met

Conditions object

A collection of conditions.

GlobalCounter object

A global counter in the state machine.

event string required

A state machine event

minLength=1
threshold integer required

The count threshold to generate an event

min=0max=4294967295
GlobalCounters object

A collection of global counters.

GlobalTimer object

A global timer in the state machine.

duration number required

The duration of the global timer in seconds

min=0.0
onset_delay number

The onset delay of the global timer in seconds

Default: 0.0
min=0.0
channel string | null
Default: null
value_on integer

The value a channel is set to

Default: 0
min=0max=255
value_off integer

The value a channel is set to

Default: 0
min=0max=255
send_events boolean

Whether the global timer is sending events

Default: true
loop integer

Whether the global timer is looping or not

Default: 0
min=0max=255
loop_interval number

The interval in seconds that the global timer is looping

Default: 0.0
min=0.0
onset_trigger integer

An integer whose bits indicate other global timers to trigger

Default: 0
min=0
GlobalTimers object

A collection of global timers.

State object

A state in the state machine.

timer number

The state's timer in seconds

Default: 0.0
min=0.0
transitions Record<string, string | string>

A collection of state transitions.

actions Record<string, integer>

A collection of actions.

comment string | null
Default: null
States object

A collection of states.

Transitions Record<string, string | string>

A collection of state transitions.