Interface Parameter

Represents a generic parameter with required properties: index, subindex, name, value, typeValueKey.

Hierarchy

Properties

disabledValue? error? floatValue? group? id index intValue? max? min? name options? rawValue? readAccess? stringValue? subindex success? typeValueKey? uintValue? unit? value valueType? writeAccess?

Properties

Optional disabledValue

disabledValue?: number

Value of the parameter that is considered disabled.

Optional error

error?: null | MotionMasterMessage.Status.DeviceParameterValues.ParameterValue.IError

Optional floatValue

floatValue?: null | number

Optional group

group?: null | string

id

id: string

Uniquely identifies this parameter. For example, if this is a device parameter, the parameter ID could be "0x1080:02.8602-01-0000755-2243".

index

index: number

Index from the object dictionary or invented one for the virtual parameter.

Optional intValue

intValue?: null | number

Optional max

max?: null | number

Optional min

min?: null | number

name

name: string

The 'name' property is mandatory.

Optional options

options?: {
    [key: string]: number;
}

Textual representation of numerical value options for a parameter.

Type declaration

  • [key: string]: number

Optional rawValue

rawValue?: null | Uint8Array

Optional readAccess

readAccess?: null | boolean

Optional stringValue

stringValue?: null | string

subindex

subindex: number

Subindex from the object dictionary or invented one for the virtual parameter.

Optional success

success?: null | MotionMasterMessage.Status.DeviceParameterValues.ParameterValue.ISuccess

Optional typeValueKey

typeValueKey?: "intValue" | "uintValue" | "floatValue" | "stringValue" | "rawValue"

The 'typeValueKey' property represents the 'oneof type_value' from the proto file. It is used when parameter values are set on the device.

Optional uintValue

uintValue?: null | number

Optional unit

unit?: null | string

value

value: ParameterValueType

The 'value' property can be a string, number, or buffer.

Optional valueType

valueType?: null | ValueType

Optional writeAccess

writeAccess?: null | boolean

Settings

Member Visibility

Theme

Generated using TypeDoc