Interface Parameter

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

Hierarchy

Properties

bitSize? canBeMappedAsRxPdo? canBeMappedAsTxPdo? defaultData? description? disabledValue? error? esiExtensionError? esiType? fieldName? floatValue? group? id index inputType? intValue? interfaceUnit? isBeta? isSmm? mandatory? max? min? name options? originalOptions? originalUnit? plot? radix? rawValue? readAccess? recordDescription? stringValue? strlen? subindex success? typeValue? typeValueKey? uintValue? unit? unitConverterId? value valueType? writeAccess?

Properties

Optional bitSize

bitSize?: number

Size of the parameter in bits.

Optional canBeMappedAsRxPdo

canBeMappedAsRxPdo?: boolean

Indicates if the parameter can be mapped as an RxPDO.

Optional canBeMappedAsTxPdo

canBeMappedAsTxPdo?: boolean

Indicates if the parameter can be mapped as a TxPDO.

Optional defaultData

defaultData?: number

Default numeric value for the parameter, if defined.

Optional description

description?: string

Human-readable description of the parameter or subitem.

Optional disabledValue

disabledValue?: number

Value of the parameter that is considered disabled.

Optional error

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

Optional esiExtensionError

esiExtensionError?: Error

Error when extending this parameter with ESI: unit, min/max, documentation and options. Typically the error means there is no object in ESI that matches this parameter index and subindex.

Optional esiType

esiType?: string

Raw ESI data type string (e.g., "UINT16", "STRING(50)").

Optional fieldName

fieldName?: string

For parameters that correspond to motion master proto fields the fieldName should be camelCase proto field name, otherwise the value is arbitrary.

Optional floatValue

floatValue?: null | number

Optional group

group?: null | string

Group or category name for the parameter.

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 inputType

inputType?: ParameterInputType

Suggested HTML form input type for the parameter.

Optional intValue

intValue?: null | number

Optional interfaceUnit

interfaceUnit?: string

Interface unit value preserved for reference or restoration.

Optional isBeta

isBeta?: boolean

Indicates if this parameter is considered a beta feature, which may be subject to change or removal in future releases. This flag can be used to conditionally display or hide the parameter in user interfaces, or to provide warnings about its stability.

Optional isSmm

isSmm?: boolean

Is this parameter defined in SMM module.

Optional mandatory

mandatory?: boolean

Indicates if the parameter is mandatory (true) or optional (false/undefined).

Optional max

max?: null | number

Maximum allowed numeric value for the parameter, if applicable.

Optional min

min?: null | number

Minimum allowed numeric value for the parameter, if applicable.

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 originalOptions

originalOptions?: Record<string, any>

Original options preserved for reference or restoration.

Optional originalUnit

originalUnit?: string

Original unit value preserved for reference or restoration.

Optional plot

plot?: ParameterPlot

Optional plot configuration used for visualization on charts.

Optional radix

radix?: 2 | 10 | 16

Radix: binary, decimal or hexadecimal. Used for parseInt and input display format.

Optional rawValue

rawValue?: null | Uint8Array

Optional readAccess

readAccess?: null | boolean

Optional recordDescription

recordDescription?: string

Description specifically for record data types, if applicable.

Optional stringValue

stringValue?: null | string

Optional strlen

strlen?: number

Maximum length allowed for STRING type parameters, adjusted to accommodate firmware-specific constraints.

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 typeValue

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

Optional type value string representing the parameter data type.

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

Unit symbol associated with the parameter (empty string if none).

Optional unitConverterId

unitConverterId?: keyof UnitConverters

Sets a special unit type on this parameter that allows users to switch the unit. Each unit type comes with multiple options and parser and formatter functions. For example 'position' unit type has options 'inc', 'deg' and 'rad'.

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