Type alias DeviceRefObj

DeviceRefObj: {
    deviceAddress?: number | null;
    devicePosition?: number | null;
    deviceSerialNumber?: string | null;
}

Request methods for a specific device, such as getDeviceParameterInfo, accept the type of request message as the first parameter, as defined in the proto file. For getDeviceParameterInfo, this is MotionMasterMessage.Request.IGetDeviceParameterInfo.

This type is extended through type intersection with DeviceRefObj to support multiple ways of referencing a device.

Motion Master only supports device addresses, which are re-generated for each device after a power cycle. Since device addresses can change, it's preferable for scripts and applications to use a device reference that remains constant. The device serial number, found in the hardware description file, is a unique identifier that does not change. This serial number is added to each request message.

Before sending the request to Motion Master, the device address is resolved and added to the request message. Devices can be referenced not only by their device address or serial number but also by their position (i.e., their sequence number in the network chain).

Type declaration

  • Optional deviceAddress?: number | null
  • Optional devicePosition?: number | null
  • Optional deviceSerialNumber?: string | null

Settings

Member Visibility

Theme

Generated using TypeDoc