Options
All
  • Public
  • Public/Protected
  • All
Menu

External module Components

Index

External modules

Embeds Classes

Measurement Classes

Other Classes

Peripherals Classes

Protocol Classes

Interfaces

Type aliases

Type aliases

AnimationStatus

AnimationStatus: "loop" | "registrate" | "pause" | "resume"

Animation Status

  • loop : loop animation. It start immediately.
  • registrate : Loop animation. Just registration
  • pause : Pause current running animation.
  • resume : Resume paused or just registered animation.

BitType

BitType: 5 | 6 | 7 | 8

DirectiveAnimationFrameFunction

DirectiveAnimationFrameFunction: (index: number) => void

Type declaration

    • (index: number): void

    • Parameters

      • index: number

      Returns void

DriveType

DriveType: "5v" | "3v" | "open-drain"
  • "5v" Push-pull 5v mode.
  • "3v" Push-pull 3v mode.
  • "Open-drain" Open-drain mode.

EventHandler

EventHandler: (...args: any) => any

Type declaration

    • (...args: any): any

    • Parameters

      • Rest ...args: any

      Returns any

FlowControlType

FlowControlType: "off" | "rts" | "cts" | "rts-cts"

GrovePinOption

GrovePinOption: "default" | "secondaryOnly"

I2CMode

I2CMode: "master" | "slave"

ObnizMeasureResultArray

ObnizMeasureResultArray: [ObnizMeasureResult, ObnizMeasureResult]

ObnizSwitchCallback

ObnizSwitchCallback: (result: ObnizSwitchState) => void

Type declaration

ObnizSwitchState

ObnizSwitchState: "none" | "push" | "left" | "right"

switch state

PWMModulateType

PWMModulateType: "am"

Modulate type.

Currently only "am" are supported

ParityType

ParityType: "off" | "odd" | "even"

PeripheralGroveType

PeripheralGroveType: "digital" | "analog" | "analog-digital" | "i2c" | "uart" | "pwm"

PluginReceiveCallbackFunction

PluginReceiveCallbackFunction: (data: number[], str: string | null) => void

Type declaration

    • (data: number[], str: string | null): void

    • Parameters

      • data: number[]

        received data

      • str: string | null

      Returns void

PullType

PullType: "5v" | "3v" | "0v" | null

IO pull type

  • null (default)
  • "5v" pull up to 5v
  • "3v" pull up to 3v
  • "0v" pull down to gnd

StopBitType

StopBitType: 1 | 1.5 | 2

TCPConnectionCallbackFunction

TCPConnectionCallbackFunction: (connected: boolean) => void

Type declaration

    • (connected: boolean): void

    • Parameters

      • connected: boolean
        • True : Connect
        • False : Disconnect

      Returns void

TCPErrorCallbackFunction

TCPErrorCallbackFunction: (error: any) => void

Type declaration

    • (error: any): void

    • Parameters

      • error: any

        Error object

      Returns void

TCPReceiveCallbackFunction

TCPReceiveCallbackFunction: (data: number[]) => void

Type declaration

    • (data: number[]): void

    • Parameters

      • data: number[]

        received data

      Returns void

Generated using TypeDoc