Class PeripheralGrove<EventTypes>

Type parameters

EventTypes: string

Hierarchy

ComponentAbstract
- PeripheralGrove

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PeripheralGrove(obniz: Obniz, no: number, params: PeripheralGroveParams): PeripheralGrove

Overrides ComponentAbstract.constructor
- Defined in src/obniz/libs/io_peripherals/grove.ts:43
Parameters
- obniz: Obniz
- no: number
- params: PeripheralGroveParams
Returns PeripheralGrove

Properties

Obniz

Obniz: Obniz

obniz to be used

no

no: number

timeout

timeout: number = 30 * 1000

Rsponse waiting timeout in milliseconds

used

used: boolean = false

Static prefixed

prefixed: string | boolean

Methods

addListener

addListener(event: EventTypes, fn: ListenerFn, context?: any): this

Inherited from ObnizConnection.addListener
- Defined in node_modules/eventemitter3/index.d.ts:33
Parameters
- event: EventTypes
- fn: ListenerFn
- Optional context: any
Returns this

emit

emit(event: EventTypes, ...args: Array<any>): boolean

Inherited from ObnizConnection.emit
- Defined in node_modules/eventemitter3/index.d.ts:27
Calls each of the listeners registered for a given event.

Parameters
- event: EventTypes
- Rest ...args: Array<any>
Returns boolean

end

end(): void

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

eventNames

eventNames(): Array<EventTypes>

Inherited from ObnizConnection.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:12
Return an array listing the events for which the emitter has registered listeners.

Returns Array<EventTypes>

fastValidate

fastValidate(commandUri: any, json: any): boolean

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

getAnalog

getAnalog(drive?: DriveType, pinOption?: GrovePinOption): { primary?: PeripheralAD; secondary?: PeripheralAD }

- Defined in src/obniz/libs/io_peripherals/grove.ts:86
Parameters
- Default value drive: DriveType = "5v"
- Default value pinOption: GrovePinOption = "default"
Returns { primary?: PeripheralAD; secondary?: PeripheralAD }
- Optional primary?: PeripheralAD
- Optional secondary?: PeripheralAD

getAnalogDigital

getAnalogDigital(drive?: DriveType): { analog: PeripheralAD; digital: PeripheralIO }

- Defined in src/obniz/libs/io_peripherals/grove.ts:113
Parameters
- Default value drive: DriveType = "5v"
Returns { analog: PeripheralAD; digital: PeripheralIO }
- analog: PeripheralAD
- digital: PeripheralIO

getDigital

getDigital(drive?: DriveType, pinOption?: GrovePinOption): { primary: PeripheralIO; secondary?: PeripheralIO }

- Defined in src/obniz/libs/io_peripherals/grove.ts:52
Parameters
- Default value drive: DriveType = "5v"
- Default value pinOption: GrovePinOption = "default"
Returns { primary: PeripheralIO; secondary?: PeripheralIO }
- primary: PeripheralIO
- Optional secondary?: PeripheralIO

getI2c

getI2c(frequency: number, drive?: DriveType): PeripheralI2C

- Defined in src/obniz/libs/io_peripherals/grove.ts:143
Parameters
- frequency: number
- Default value drive: DriveType = "5v"
Returns PeripheralI2C

getPwm

getPwm(drive?: DriveType): PeripheralPWM

- Defined in src/obniz/libs/io_peripherals/grove.ts:168
Parameters
- Default value drive: DriveType = "5v"
Returns PeripheralPWM

getUart

getUart(baud: number, drive?: DriveType): PeripheralUART

- Defined in src/obniz/libs/io_peripherals/grove.ts:156
Parameters
- baud: number
- Default value drive: DriveType = "5v"
Returns PeripheralUART

listenerCount

listenerCount(event: EventTypes): number

Inherited from ObnizConnection.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:22
Return the number of listeners listening to a given event.

Parameters
- event: EventTypes
Returns number

listeners

listeners(event: EventTypes): Array<ListenerFn>

Inherited from ObnizConnection.listeners
- Defined in node_modules/eventemitter3/index.d.ts:17
Return the listeners registered for a given event.

Parameters
- event: EventTypes
Returns Array<ListenerFn>

notifyFromObniz

notifyFromObniz(json: any): void

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

off

off(event: EventTypes, fn?: EventEmitter.ListenerFn, context?: any, once?: undefined | false | true): this

Inherited from ObnizConnection.off
- Defined in node_modules/eventemitter3/index.d.ts:44
Parameters
- event: EventTypes
- Optional fn: EventEmitter.ListenerFn
- Optional context: any
- Optional once: undefined | false | true
Returns this

on

on(event: EventTypes, fn: ListenerFn, context?: any): this

Inherited from ObnizConnection.on
- Defined in node_modules/eventemitter3/index.d.ts:32
Add a listener for a given event.

Parameters
- event: EventTypes
- fn: ListenerFn
- Optional context: any
Returns this

once

once(event: EventTypes, fn: ListenerFn, context?: any): this

Inherited from ObnizConnection.once
- Defined in node_modules/eventemitter3/index.d.ts:38
Add a one-time listener for a given event.

Parameters
- event: EventTypes
- fn: ListenerFn
- Optional context: any
Returns this

removeAllListeners

removeAllListeners(event?: EventTypes): this

Inherited from ObnizConnection.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:49
Remove all listeners, or those of the specified event.

Parameters
- Optional event: EventTypes
Returns this

removeListener

removeListener(event: EventTypes, fn?: EventEmitter.ListenerFn, context?: any, once?: undefined | false | true): this

Inherited from ObnizConnection.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:43
Remove the listeners of a given event.

Parameters
- event: EventTypes
- Optional fn: EventEmitter.ListenerFn
- Optional context: any
- Optional once: undefined | false | true
Returns this

schemaBasePath

schemaBasePath(): null

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

validate

validate(commandUri: any, json: any): WSSchema.MultiResult

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

Generated using TypeDoc