Class PeripheralIO

General purpose IO This is available on each io (for obniz Board series, it's io0 to io11)

Hierarchy

ComponentAbstract
- PeripheralIO

Index

Constructors

constructor

new PeripheralIO(obniz, id): PeripheralIO
Parameters
- obniz: Obniz
- id: number
Returns PeripheralIO
Overrides ComponentAbstract.constructor
- Defined in src/obniz/libs/io_peripherals/io.ts:21

Properties

Obniz

Obniz: Obniz

obniz to be used

timeout

timeout: number = ...

Rsponse waiting timeout in milliseconds

`Static` prefixed

prefixed: string | boolean

Methods

addListener

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

drive

drive(drive): void

This allows you to change output drive method. By default, it is set as push-pull 5v.

// Javascript Example
obniz.io0.output(true); // output push-pull 5v

obniz.io1.drive("3v");
obniz.io1.output(true); // output push-pull 3v

obniz.io2.pull("5v");
obniz.io2.drive("open-drain");
obniz.io2.output(true); // output open-drain with 5v pull-up

Parameters

drive: DriveType

Returns void

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
This ends output/input on ioX.

This function is effective only when using ioX.output() or ioX.input(). This won't be called when AD/UART/etc are used. Pull-up down also will not affected.
```
// Javascript Example
obniz.io0.output(true)
obniz.io0.end();
```
Returns void
- Defined in src/obniz/libs/io_peripherals/io.ts:210

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

input

input(callback): boolean
Make ioX to input mode. Callback function will be called when io changes its input value.
Parameters
- callback: ((value) => void)
  - - (value): void
    - Parameters
      
      value: boolean
      
      Returns void
Returns boolean
- Defined in src/obniz/libs/io_peripherals/io.ts:162

inputWait

inputWait(): Promise<boolean>
Make ioX to input mode.

And this will return the current input value. It pauses the process until the value is returned.
```
// Javascript Example
var value = await obniz.io0.inputWait();
console.log(value);
```
Returns Promise<boolean>
- Defined in src/obniz/libs/io_peripherals/io.ts:185

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?): PeripheralIO
Parameters
- event: string
- Optional fn: ListenerFn
- Optional context: any
- Optional once: boolean
Returns PeripheralIO
Inherited from ComponentAbstract.off
- Defined in node_modules/eventemitter3/index.d.ts:44

on

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

once

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

output

output(value): void

Make ioX to output mode and put out 1 or 0.

// Javascript Example
obniz.io1.output(true); // io1 is 5v
obniz.io2.output(1); //  io2 is 5v
obniz.io3.drive("3v");
obniz.io3.output(1); // io3 is around 3v.

Parameters

value: boolean | 0 | 1

output value

Returns void

pull

pull(updown): void
This enables/disables internal weak pull up/down resistors.
```
// Javascript Example
obniz.io0.pull("3v");
obniz.io0.drive("open-drain"); // output open-drain
obniz.io0.output(false);
```
Parameters
- updown: PullType
Returns void
- Defined in src/obniz/libs/io_peripherals/io.ts:126

removeAllListeners

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

removeListener

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

validate

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

Class PeripheralIO

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

obniz: Obniz

id: number

Returns PeripheralIO

Properties

Obniz

timeout

Static prefixed

Methods

addListener

Parameters

event: string

fn: ListenerFn

Optional context: any

Returns PeripheralIO

drive

Parameters

drive: DriveType

Returns void

emit

Parameters

event: string

Rest ...args: any[]

Returns boolean

end

Returns void

eventNames

Returns string[]

fastValidate

Parameters

commandUri: any

json: any

Returns boolean

input

Parameters

callback: ((value) => void)

Parameters

value: boolean

Returns void

Returns boolean

inputWait

Returns Promise<boolean>

listenerCount

Parameters

event: string

Returns number

listeners

Parameters

event: string

Returns ListenerFn[]

notifyFromObniz

Parameters

json: any

Returns void

off

Parameters

event: string

Optional fn: ListenerFn

Optional context: any

Optional once: boolean

Returns PeripheralIO

on

Parameters

event: string

fn: ListenerFn

Optional context: any

Returns PeripheralIO

once

Parameters

event: string

fn: ListenerFn

Optional context: any

`Static` prefixed

`Optional` context: any

`Rest` ...args: any[]

`Optional` fn: ListenerFn

`Optional` context: any

`Optional` once: boolean

`Optional` context: any

`Optional` context: any

`Optional` event: string

`Optional` fn: ListenerFn

`Optional` context: any

`Optional` once: boolean