Class PeripheralGrove

Hierarchy

ComponentAbstract
- PeripheralGrove

Index

Constructors

Properties

Obniz no timeout used prefixed

Constructors

constructor

new PeripheralGrove(obniz, no, params): PeripheralGrove
Parameters
- obniz: Obniz
- no: number
- params: PeripheralGroveParams
Returns PeripheralGrove
Overrides ComponentAbstract.constructor
- Defined in src/obniz/libs/io_peripherals/grove.ts:45

Properties

Obniz

Obniz: Obniz

obniz to be used

no

no: number

timeout

timeout: number = ...

Rsponse waiting timeout in milliseconds

used

used: boolean = false

`Static` prefixed

prefixed: string | boolean

Methods

addListener

addListener(event, fn, context?): PeripheralGrove
Parameters
- event: string
- fn: ListenerFn
- Optional context: any
Returns PeripheralGrove
Inherited from ComponentAbstract.addListener
- Defined in node_modules/eventemitter3/index.d.ts:33

emit

emit(event, ...args): boolean
Calls each of the listeners registered for a given event.
Parameters
- event: string
- Rest ...args: any[]
Returns boolean
Inherited from ComponentAbstract.emit
- Defined in node_modules/eventemitter3/index.d.ts:27

end

end(): void
Returns void
- Defined in src/obniz/libs/io_peripherals/grove.ts:184

eventNames

eventNames(): string[]
Return an array listing the events for which the emitter has registered listeners.

Returns string[]
Inherited from ComponentAbstract.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:12

fastValidate

fastValidate(commandUri, json): boolean
Parameters
- commandUri: any
- json: any
Returns boolean
Inherited from ComponentAbstract.fastValidate
- Defined in src/obniz/libs/ComponentAbstact.ts:91

getAnalog

getAnalog(drive?, pinOption?): {
primary?: PeripheralAD;
secondary?: PeripheralAD;
}
Parameters
- drive: DriveType = '5v'
- pinOption: GrovePinOption = 'default'
Returns {
primary?: PeripheralAD;
secondary?: PeripheralAD;
}
- Optional primary?: PeripheralAD
- Optional secondary?: PeripheralAD
- Defined in src/obniz/libs/io_peripherals/grove.ts:86

getAnalogDigital

getAnalogDigital(drive?): {
analog: PeripheralAD;
digital: PeripheralIO;
}
Parameters
- drive: DriveType = '5v'
Returns {
analog: PeripheralAD;
digital: PeripheralIO;
}
- analog: PeripheralAD
- digital: PeripheralIO
- Defined in src/obniz/libs/io_peripherals/grove.ts:113

getDigital

getDigital(drive?, pinOption?): {
primary: PeripheralIO;
secondary?: PeripheralIO;
}
Parameters
- drive: DriveType = '5v'
- pinOption: GrovePinOption = 'default'
Returns {
primary: PeripheralIO;
secondary?: PeripheralIO;
}
- primary: PeripheralIO
- Optional secondary?: PeripheralIO
- Defined in src/obniz/libs/io_peripherals/grove.ts:52

getI2c

getI2c(frequency, drive?): PeripheralI2C
Parameters
- frequency: number
- drive: DriveType = '5v'
Returns PeripheralI2C
- Defined in src/obniz/libs/io_peripherals/grove.ts:143

getPwm

getPwm(drive?): PeripheralPWM
Parameters
- drive: DriveType = '5v'
Returns PeripheralPWM
- Defined in src/obniz/libs/io_peripherals/grove.ts:168

getUart

getUart(baud, drive?): PeripheralUART
Parameters
- baud: number
- drive: DriveType = '5v'
Returns PeripheralUART
- Defined in src/obniz/libs/io_peripherals/grove.ts:156

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: string
Returns number
Inherited from ComponentAbstract.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:22

listeners

listeners(event): ListenerFn[]
Return the listeners registered for a given event.
Parameters
- event: string
Returns ListenerFn[]
Inherited from ComponentAbstract.listeners
- Defined in node_modules/eventemitter3/index.d.ts:17

notifyFromObniz

notifyFromObniz(json): void
Parameters
- json: any
Returns void
Inherited from ComponentAbstract.notifyFromObniz
- Defined in src/obniz/libs/ComponentAbstact.ts:53

off

off(event, fn?, context?, once?): PeripheralGrove
Parameters
- event: string
- Optional fn: ListenerFn
- Optional context: any
- Optional once: boolean
Returns PeripheralGrove
Inherited from ComponentAbstract.off
- Defined in node_modules/eventemitter3/index.d.ts:44

on

on(event, fn, context?): PeripheralGrove
Add a listener for a given event.
Parameters
- event: string
- fn: ListenerFn
- Optional context: any
Returns PeripheralGrove
Inherited from ComponentAbstract.on
- Defined in node_modules/eventemitter3/index.d.ts:32

once

once(event, fn, context?): PeripheralGrove
Add a one-time listener for a given event.
Parameters
- event: string
- fn: ListenerFn
- Optional context: any
Returns PeripheralGrove
Inherited from ComponentAbstract.once
- Defined in node_modules/eventemitter3/index.d.ts:38

removeAllListeners

removeAllListeners(event?): PeripheralGrove
Remove all listeners, or those of the specified event.
Parameters
- Optional event: string
Returns PeripheralGrove
Inherited from ComponentAbstract.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:49

removeListener

removeListener(event, fn?, context?, once?): PeripheralGrove
Remove the listeners of a given event.
Parameters
- event: string
- Optional fn: ListenerFn
- Optional context: any
- Optional once: boolean
Returns PeripheralGrove
Inherited from ComponentAbstract.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:43

schemaBasePath

schemaBasePath(): null
Returns null
Overrides ComponentAbstract.schemaBasePath
- Defined in src/obniz/libs/io_peripherals/grove.ts:218

validate

validate(commandUri, json): MultiResult
Parameters
- commandUri: any
- json: any
Returns MultiResult
Inherited from ComponentAbstract.validate
- Defined in src/obniz/libs/ComponentAbstact.ts:86

Generated using TypeDoc