Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KiirooCmd

Hierarchy

Index

Constructors

constructor

  • new KiirooCmd(Command?: string, DeviceIndex?: number, Id?: number): KiirooCmd
  • Parameters

    • Default value Command: string = "0"
    • Default value DeviceIndex: number = -1
    • Default value Id: number = 1

    Returns KiirooCmd

Properties

Command

Command: string

DeviceIndex

DeviceIndex: number

Id

Id: number

Accessors

SchemaVersion

  • get SchemaVersion(): number

Type

  • get Type(): string
  • Returns the message type name

    Usually, the message type name will be the same as the message class constructor, so the constructor name is used by default. However, in instances where a message has different versions (i.e. DeviceAddedVersion0 and DeviceAddedVersion1), we will need to override this to set the message name.

    Returns string

Methods

DowngradeMessage

GetPosition

  • GetPosition(): number
  • Returns number

SetPosition

  • SetPosition(aPos: number): void
  • Parameters

    • aPos: number

    Returns void

getType

  • getType(): string
  • [DEPRECATED] Function version of the this.Type getter

    Returns string

toJSON

  • toJSON(): string

toProtocolFormat

  • toProtocolFormat(): object

Generated using TypeDoc