Class EStop

An emergency stop that latches until a person resets it.

Index

Constructors

Accessors

Methods

engage gate reset

Constructors

constructor

new EStop(): kit.EStop
Creates an e-stop that is not engaged.

Returns kit.EStop
- Defined in native/index.d.ts:662

Accessors

isEngaged

get isEngaged(): boolean
Whether the stop is engaged.

Returns boolean
- Defined in native/index.d.ts:668

Methods

engage

engage(): void
Engages the stop; it holds until reset.

Returns void
- Defined in native/index.d.ts:664

gate

gate(desired: kit.Twist): kit.Twist
Returns desired while clear, or a zero twist while engaged.
Parameters
- desired: kit.Twist
Returns kit.Twist
- Defined in native/index.d.ts:670

reset

reset(): void
Clears the stop.

Returns void
- Defined in native/index.d.ts:666