Class ObnizSwitch

The embedded switch on obniz Board.

Hierarchy

ComponentAbstract
- ObnizSwitch

Index

Constructors

constructor

new ObnizSwitch(obniz, info): ObnizSwitch
Parameters
- obniz: any
- info: any
Returns ObnizSwitch
Overrides ComponentAbstract.constructor
- Defined in src/obniz/libs/embeds/switch.ts:43

Properties

Obniz

Obniz: Obniz

obniz to be used

`Optional` onchange

onchange?: ObnizSwitchCallback

When the switch state changes, this callback function will be called. If you press and release a switch, it callbacks twice ("push" and "none").

// Javascript Example
obniz.display.clear();
obniz.switch.onchange = function(state) {
  if (state === "push") {
    obniz.display.print("Pushing");
  } else {
    obniz.display.clear();
  }
}

state

state: ObnizSwitchState

current switch state

timeout

timeout: number = ...

Rsponse waiting timeout in milliseconds

`Static` prefixed

prefixed: string | boolean

Methods

addListener

addListener(event, fn, context?): ObnizSwitch
Parameters
- event: string
- fn: ListenerFn
- Optional context: any
Returns ObnizSwitch
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

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

getWait

getWait(): Promise<ObnizSwitchState>

This determines the current status of the switch.

// Javascript Example
obniz.display.clear();
var state = await obniz.switch.getWait();
if (state === "push") {
  obniz.display.print("Now Pressed");
}

Returns Promise<ObnizSwitchState>

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

on

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

once

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

removeAllListeners

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

removeListener

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

schemaBasePath

schemaBasePath(): string
Returns string
Overrides ComponentAbstract.schemaBasePath
- Defined in src/obniz/libs/embeds/switch.ts:105

stateWait

stateWait(state): Promise<void>

With this you wait until the switch status changes to state.

// Javascript Example
await obniz.switch.stateWait("push");
console.log("switch pushed");

await obniz.switch.stateWait("left");
console.log("switch left");

await obniz.switch.stateWait("right");
console.log("switch right");

await obniz.switch.stateWait("none");
console.log("switch none");

Parameters

state: ObnizSwitchState

state for wait

Returns Promise<void>

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 ObnizSwitch

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

obniz: any

info: any

Returns ObnizSwitch

Properties

Obniz

Optional onchange

state

timeout

Static prefixed

Methods

addListener

Parameters

event: string

fn: ListenerFn

Optional context: any

Returns ObnizSwitch

emit

Parameters

event: string

Rest ...args: any[]

Returns boolean

eventNames

Returns string[]

fastValidate

Parameters

commandUri: any

json: any

Returns boolean

getWait

Returns Promise<ObnizSwitchState>

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 ObnizSwitch

on

Parameters

event: string

fn: ListenerFn

Optional context: any

Returns ObnizSwitch

once

Parameters

event: string

fn: ListenerFn

Optional context: any

Returns ObnizSwitch

removeAllListeners

Parameters

Optional event: string

Returns ObnizSwitch

removeListener

Parameters

event: string

Optional fn: ListenerFn

Optional context: any

Optional once: boolean

`Optional` onchange

`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