Class GW_MODE_SEND_REQ

Hierarchy (view full)

GW_FRAME_COMMAND_REQ
- GW_MODE_SEND_REQ

Index

Constructors

Properties

BufferSize Command CommandOriginator LockTime ModeNumber ModeParameter Nodes PriorityLevel PriorityLevelLock PriorityLevels SessionID offset

Accessors

Methods

Constructors

constructor

new GW_MODE_SEND_REQ(Nodes, ModeNumber?, ModeParameter?, PriorityLevel?, CommandOriginator?, PriorityLevelLock?, PriorityLevels?, LockTime?): GW_MODE_SEND_REQ
Parameters
- Nodes: number | number[]
- ModeNumber: number = 0
- ModeParameter: ParameterActive = 0
- PriorityLevel: PriorityLevel = 3
- CommandOriginator: CommandOriginator = 1
- PriorityLevelLock: PriorityLevelLock = 0
- PriorityLevels: PriorityLevelInformation[] = []
- LockTime: number = Infinity
Returns GW_MODE_SEND_REQ
Overrides GW_FRAME_COMMAND_REQ.constructor
- Defined in KLF200-API/GW_MODE_SEND_REQ.ts:15

Properties

`Readonly`BufferSize

BufferSize: number

The size of the buffer (only pure data, without protocol and command bytes)

`Readonly`Command

Command: GW_MODE_SEND_REQ

`Readonly`CommandOriginator

CommandOriginator: CommandOriginator = 1

`Readonly`LockTime

LockTime: number = Infinity

`Readonly`ModeNumber

ModeNumber: number = 0

`Readonly`ModeParameter

ModeParameter: ParameterActive = 0

`Readonly`Nodes

Nodes: number | number[]

`Readonly`PriorityLevel

PriorityLevel: PriorityLevel = 3

`Readonly`PriorityLevelLock

PriorityLevelLock: PriorityLevelLock = 0

`Readonly`PriorityLevels

PriorityLevels: PriorityLevelInformation[] = []

`Readonly`SessionID

SessionID: number

`Protected` `Readonly`offset

offset: number = ...

Accessors

Data

get Data(): Buffer
Returns Buffer
Inherited from GW_FRAME_COMMAND_REQ.Data
- Defined in KLF200-API/common.ts:407

Methods

`Protected`AllocBuffer

AllocBuffer(BufferSize, CopyData?): void
Protected
Allocates a buffer in the right size for the frame. The first byte contains the buffer length. The next two bytes of the buffer are used for the command. The remaining bytes are for the data.

A size of 0 means that the command has no further data.
Parameters
- BufferSize: number
  Size for the buffer for the data part without length and command.
- CopyData: boolean = true
  Set to true to copy the data in case of reallocating the buffer. Default is true.
Returns void
Inherited from GW_FRAME_COMMAND_REQ.AllocBuffer
- Defined in KLF200-API/common.ts:391