Class Directive

Hierarchy

ComponentAbstract
- Directive

Index

Constructors

Properties

Methods

addListener animation emit eventNames fastValidate listenerCount listeners notifyFromObniz off on once removeAllListeners removeListener repeatWait schemaBasePath validate

Constructors

constructor

new Directive(obniz, id): Directive
Parameters
- obniz: Obniz
- id: number
Returns Directive
Overrides ComponentAbstract.constructor
- Defined in src/obniz/libs/io_peripherals/directive.ts:33

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

animation

animation(name, status, animations?, repeat?): void
io animation is used when you wish to accelerate the serial sequence change of io.

"Loop" animation can be used. io changes repeatedly in a sequential manner according to json array. io and pwm json commands can only be used.

obnizOS ver >= 2.0.0 required.
```
//javascript
// Javascript Example
obniz.io.animation("animation-1", "loop", [
 {
  duration: 10,
  state: function(index){ // index = 0
    obniz.io0.output(false)
    obniz.io1.output(true)
  }
 },{
   duration: 10,
   state: function(index){ // index = 1
     obniz.io0.output(true)
     obniz.io1.output(false)
   }
 }
])
```
It will generate signals likes below
- Remove animation
```
obniz.io.animation("animation-1", "loop")
```
- Pause animation
```
obniz.io.animation("animation-1", "pause")
```
- Resume paused animation
```
obniz.io.animation("animation-1", "resume")
```
Parameters
- name: string
  
  name of animation
- status: AnimationStatus
  
  status of animation
- Optional animations: DirectiveAnimationFrame[]
  
  instructions. This is optional when status is pause``resume.
- Optional repeat: number
  
  The number of repeat count of animation. If not specified, it repeat endless.
Returns void
- Defined in src/obniz/libs/io_peripherals/directive.ts:107

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

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

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

on

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

once

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

removeAllListeners

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

removeListener

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

repeatWait

repeatWait(animations, repeat): Promise<unknown>

It start io aniomation with limited repeat count. And It wait until done.

// Javascript Example
await obniz.io.repeatWait([
  {
    duration: 1000,
    state: function(index){
      obniz.io0.output(true)
    }
  },{
    duration: 1000,
    state: function(index){
      obniz.io0.output(false)
   }
  }
], 4)

Parameters

animations: DirectiveAnimationFrame[]

instructions
repeat: number

The number of repeat count of animation.

Returns Promise<unknown>

schemaBasePath

schemaBasePath(): string
Returns string
Overrides ComponentAbstract.schemaBasePath
- Defined in src/obniz/libs/io_peripherals/directive.ts:199

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 Directive

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

obniz: Obniz

id: number

Returns Directive

Properties

Obniz

timeout

Static prefixed

Methods

addListener

Parameters

event: string

fn: ListenerFn

Optional context: any

Returns Directive

animation

Parameters

name: string

status: AnimationStatus

Optional animations: DirectiveAnimationFrame[]

Optional repeat: number

Returns void

emit

Parameters

event: string

Rest ...args: any[]

Returns boolean

eventNames

Returns string[]

fastValidate

Parameters

commandUri: any

json: any

Returns 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 Directive

on

Parameters

event: string

fn: ListenerFn

Optional context: any

Returns Directive

once

Parameters

event: string

fn: ListenerFn

Optional context: any

Returns Directive

removeAllListeners

Parameters

Optional event: string

Returns Directive

removeListener

Parameters

event: string

`Static` prefixed

`Optional` context: any

`Optional` animations: DirectiveAnimationFrame[]

`Optional` repeat: number

`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