Interface EncoderConfigurationUsage

Represents the usage of encoder configurations across different firmware versions and products.

This interface defines which subitems are available for each supported encoder type, and specifies whether each subitem is set by the user, the firmware, or both. It also maps these configurations to the relevant products and ports.

The structure originates from the following documents:

  • Encoder Configuration Types Supported
  • Encoder configuration 0x2110/0x2112 subindex usage (default)
  • Encoder configuration 0x2110/0x2112 subindex usage (exceptions)

Hierarchy

  • EncoderConfigurationUsage

Indexable

[key: string]: {
    encoderConfiguration: {
        encoderType: {
            [key: number]: {
                subitem: {
                    [key: number]: {
                        setBy: EncoderConfigurationSubitemSetBy;
                    };
                };
            };
        };
        exceptions: { [ key in EncoderConfigurationExceptionCase]: {
            subitem: {
                [key: number]: {
                    setBy: EncoderConfigurationSubitemSetBy;
                };
            };
        } };
    };
    product: {
        [key: string]: {
            port: {
                [key: number]: {
                    allowedEncoderTypes: number[];
                };
            };
        };
    };
}
  • encoderConfiguration: {
        encoderType: {
            [key: number]: {
                subitem: {
                    [key: number]: {
                        setBy: EncoderConfigurationSubitemSetBy;
                    };
                };
            };
        };
        exceptions: { [ key in EncoderConfigurationExceptionCase]: {
            subitem: {
                [key: number]: {
                    setBy: EncoderConfigurationSubitemSetBy;
                };
            };
        } };
    }
  • product: {
        [key: string]: {
            port: {
                [key: number]: {
                    allowedEncoderTypes: number[];
                };
            };
        };
    }
    • [key: string]: {
          port: {
              [key: number]: {
                  allowedEncoderTypes: number[];
              };
          };
      }
      • port: {
            [key: number]: {
                allowedEncoderTypes: number[];
            };
        }
        • [key: number]: {
              allowedEncoderTypes: number[];
          }
          • allowedEncoderTypes: number[]

Settings

Member Visibility

Theme

Generated using TypeDoc