Class GPIOInputLine

Hierarchy

GPIOLineReservation
- GPIOInputLine

Index

Constructors

Properties

emitter interval? line releaseCallback

Methods

addListener checkReservation createDebouncer getValue once propagateEvent readEvents release removeListener wait

Constructors

constructor

new GPIOInputLine(line, pollingInterval, releaseCallback): GPIOInputLine
Parameters
- line: unknown
- pollingInterval: undefined | number
- releaseCallback: (() => void)
  - - (): void
    - Returns void
Returns GPIOInputLine
Overrides GPIOLineReservation.constructor
- Defined in src/gpio-input-line.ts:12

Properties

`Private` emitter

emitter: EventEmitter

`Private` `Optional` interval

interval?: Timer

`Protected` line

line: unknown

`Protected` `Readonly` releaseCallback

releaseCallback: (() => void)

Type declaration

- (): void
- Returns void

Methods

addListener

addListener(eventName, listener): void
Parameters
- eventName: GPIOEventType
- listener: EventListener<LineEvent>
Returns void
- Defined in src/gpio-input-line.ts:48

`Protected` checkReservation

checkReservation(): void
Returns void
Inherited from GPIOLineReservation.checkReservation
- Defined in src/gpio-line-reservation.ts:8

createDebouncer

createDebouncer(timeout, pressValue?, holdTimes?): Debouncer
Parameters
- timeout: number
- Optional pressValue: BitValue
- Optional holdTimes: number[]
Returns Debouncer
- Defined in src/gpio-input-line.ts:103

getValue

getValue(): BitValue
Returns BitValue
- Defined in src/gpio-input-line.ts:91

once

once(eventName, listener): void
Parameters
- eventName: GPIOEventType
- listener: EventListener<LineEvent>
Returns void
- Defined in src/gpio-input-line.ts:56

`Private` propagateEvent

propagateEvent(event): void
Parameters
- event: Event
Returns void
- Defined in src/gpio-input-line.ts:24

readEvents

readEvents(): void
Instantly poll kernel's events queue

Returns void
- Defined in src/gpio-input-line.ts:37

release

release(): void
Returns void
Overrides GPIOLineReservation.release
- Defined in src/gpio-input-line.ts:107

removeListener

removeListener(eventName, listener): void
Parameters
- eventName: GPIOEventType
- listener: EventListener<LineEvent>
Returns void
- Defined in src/gpio-input-line.ts:52

wait

wait(uSec, capture?): null | Event
Wait for a new line event. This method will poll the queue and propagate any previous events and wait for new one.
Parameters
- uSec: number
  
  maximum number of micro seconds to wait for an event
- capture: boolean = false
  
  if true, the event will not be propagated to listeners
Returns null | Event
- Defined in src/gpio-input-line.ts:66

Generated using TypeDoc