Interface Complete

This cluster supports all EnergyPreference features. It may support illegal feature combinations.

If you use this cluster you must manually specify which features are active and ensure the set of active features is legal per the Matter specification.

interface Complete {
    attributes: Merge<{
        currentEnergyBalance: WritableAttribute<number, any> & {
            isConditional: true;
            mandatoryIf: [] | [{
                energyBalance: boolean;
            }];
            optional: true;
            optionalIf: [] | ConditionalFeatureList<BitSchema>;
        };
        currentLowPowerModeSensitivity: WritableAttribute<number, any> & {
            isConditional: true;
            mandatoryIf: [] | [{
                lowPowerModeSensitivity: boolean;
            }];
            optional: true;
            optionalIf: [] | ConditionalFeatureList<BitSchema>;
        };
        energyBalances: FixedAttribute<TypeFromFields<{
            label: OptionalFieldType<string>;
            step: FieldType<number>;
        }>[], any> & {
            isConditional: true;
            mandatoryIf: [] | [{
                energyBalance: boolean;
            }];
            optional: true;
            optionalIf: [] | ConditionalFeatureList<BitSchema>;
        };
        energyPriorities: FixedAttribute<EnergyPreference.EnergyPriority[], any> & {
            isConditional: true;
            mandatoryIf: [] | [{
                energyBalance: boolean;
            }];
            optional: true;
            optionalIf: [] | ConditionalFeatureList<BitSchema>;
        };
        lowPowerModeSensitivities: FixedAttribute<TypeFromFields<{
            label: OptionalFieldType<string>;
            step: FieldType<number>;
        }>[], any> & {
            isConditional: true;
            mandatoryIf: [] | [{
                lowPowerModeSensitivity: boolean;
            }];
            optional: true;
            optionalIf: [] | ConditionalFeatureList<BitSchema>;
        };
    }, GlobalAttributes<{
        energyBalance: BitFlag;
        lowPowerModeSensitivity: BitFlag;
    }>>;
    base: undefined;
    commands: {};
    events: {};
    extensions: undefined;
    features: {
        energyBalance: BitFlag;
        lowPowerModeSensitivity: BitFlag;
    };
    id: Branded<155, "ClusterId">;
    name: "EnergyPreference";
    revision: 1;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        attributes: {
            currentEnergyBalance: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            currentLowPowerModeSensitivity: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyBalances: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyPriorities: FixedAttribute<EnergyPreference.EnergyPriority[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            lowPowerModeSensitivities: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        features: {
            energyBalance: BitFlag;
            lowPowerModeSensitivity: BitFlag;
        };
        id: 155;
        name: "EnergyPreference";
        revision: 1;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        attributes: {
            currentEnergyBalance: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            currentLowPowerModeSensitivity: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyBalances: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyPriorities: FixedAttribute<EnergyPreference.EnergyPriority[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            lowPowerModeSensitivities: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        features: {
            energyBalance: BitFlag;
            lowPowerModeSensitivity: BitFlag;
        };
        id: 155;
        name: "EnergyPreference";
        revision: 1;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        attributes: {
            currentEnergyBalance: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            currentLowPowerModeSensitivity: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyBalances: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyPriorities: FixedAttribute<EnergyPreference.EnergyPriority[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            lowPowerModeSensitivities: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        features: {
            energyBalance: BitFlag;
            lowPowerModeSensitivity: BitFlag;
        };
        id: 155;
        name: "EnergyPreference";
        revision: 1;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        attributes: {
            currentEnergyBalance: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            currentLowPowerModeSensitivity: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyBalances: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyPriorities: FixedAttribute<EnergyPreference.EnergyPriority[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            lowPowerModeSensitivities: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        features: {
            energyBalance: BitFlag;
            lowPowerModeSensitivity: BitFlag;
        };
        id: 155;
        name: "EnergyPreference";
        revision: 1;
    }>, SelectionT>;
}

Hierarchy (view full)

Properties

attributes base commands events extensions features id name revision supportedFeatures unknown

Methods

alter enable set with

Properties

attributes

attributes: Merge<{
    currentEnergyBalance: WritableAttribute<number, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            energyBalance: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    };
    currentLowPowerModeSensitivity: WritableAttribute<number, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            lowPowerModeSensitivity: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    };
    energyBalances: FixedAttribute<TypeFromFields<{
        label: OptionalFieldType<string>;
        step: FieldType<number>;
    }>[], any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            energyBalance: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    };
    energyPriorities: FixedAttribute<EnergyPreference.EnergyPriority[], any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            energyBalance: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    };
    lowPowerModeSensitivities: FixedAttribute<TypeFromFields<{
        label: OptionalFieldType<string>;
        step: FieldType<number>;
    }>[], any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            lowPowerModeSensitivity: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    };
}, GlobalAttributes<{
    energyBalance: BitFlag;
    lowPowerModeSensitivity: BitFlag;
}>>

base

base: undefined

commands

commands: {}

events

events: {}

extensions

extensions: undefined

features

features: {
    energyBalance: BitFlag;
    lowPowerModeSensitivity: BitFlag;
}

Type declaration

  • ReadonlyenergyBalance: BitFlag

    EnergyBalance

    This feature allows a user to select from a list of energy balances with associated descriptions of which strategies a device will use to target the specified balance.

    See

    MatterSpecification.v13.Cluster § 9.5.4.1

  • ReadonlylowPowerModeSensitivity: BitFlag

    LowPowerModeSensitivity

    This feature allows the user to select a condition or set of conditions which will cause the device to switch to a mode using less power. For example, a device might provide a scale of durations that must elapse without user interaction before it goes to sleep.

    See

    MatterSpecification.v13.Cluster § 9.5.4.2

id

id: Branded<155, "ClusterId">

name

name

revision

revision

supportedFeatures

supportedFeatures: {}

unknown

unknown

Methods

alter

  • alter<const AlterationsT>(alterations): WithAlterations<Of<{
        attributes: {
            currentEnergyBalance: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            currentLowPowerModeSensitivity: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyBalances: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyPriorities: FixedAttribute<EnergyPreference.EnergyPriority[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            lowPowerModeSensitivities: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        features: {
            energyBalance: BitFlag;
            lowPowerModeSensitivity: BitFlag;
        };
        id: 155;
        name: "EnergyPreference";
        revision: 1;
    }>, AlterationsT>

  • Modify elements using ElementModifier.alter.

    Type Parameters

    • const AlterationsT extends Alterations<Of<{
          attributes: {
              currentEnergyBalance: WritableAttribute<number, any> & {
                  isConditional: true;
                  mandatoryIf: [] | [{
                      energyBalance: boolean;
                  }];
                  optional: true;
                  optionalIf: [] | ConditionalFeatureList<BitSchema>;
              };
              currentLowPowerModeSensitivity: WritableAttribute<number, any> & {
                  isConditional: true;
                  mandatoryIf: [] | [{
                      lowPowerModeSensitivity: boolean;
                  }];
                  optional: true;
                  optionalIf: [] | ConditionalFeatureList<BitSchema>;
              };
              energyBalances: FixedAttribute<TypeFromFields<{
                  label: OptionalFieldType<string>;
                  step: FieldType<number>;
              }>[], any> & {
                  isConditional: true;
                  mandatoryIf: [] | [{
                      energyBalance: boolean;
                  }];
                  optional: true;
                  optionalIf: [] | ConditionalFeatureList<BitSchema>;
              };
              energyPriorities: FixedAttribute<EnergyPreference.EnergyPriority[], any> & {
                  isConditional: true;
                  mandatoryIf: [] | [{
                      energyBalance: boolean;
                  }];
                  optional: true;
                  optionalIf: [] | ConditionalFeatureList<BitSchema>;
              };
              lowPowerModeSensitivities: FixedAttribute<TypeFromFields<{
                  label: OptionalFieldType<string>;
                  step: FieldType<number>;
              }>[], any> & {
                  isConditional: true;
                  mandatoryIf: [] | [{
                      lowPowerModeSensitivity: boolean;
                  }];
                  optional: true;
                  optionalIf: [] | ConditionalFeatureList<BitSchema>;
              };
          };
          features: {
              energyBalance: BitFlag;
              lowPowerModeSensitivity: BitFlag;
          };
          id: 155;
          name: "EnergyPreference";
          revision: 1;
      }>>

    Parameters

    Returns WithAlterations<Of<{
        attributes: {
            currentEnergyBalance: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            currentLowPowerModeSensitivity: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyBalances: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyPriorities: FixedAttribute<EnergyPreference.EnergyPriority[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            lowPowerModeSensitivities: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        features: {
            energyBalance: BitFlag;
            lowPowerModeSensitivity: BitFlag;
        };
        id: 155;
        name: "EnergyPreference";
        revision: 1;
    }>, AlterationsT>

enable

  • enable<const FlagsT>(flags): WithFlags<Of<{
        attributes: {
            currentEnergyBalance: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            currentLowPowerModeSensitivity: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyBalances: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyPriorities: FixedAttribute<EnergyPreference.EnergyPriority[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            lowPowerModeSensitivities: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        features: {
            energyBalance: BitFlag;
            lowPowerModeSensitivity: BitFlag;
        };
        id: 155;
        name: "EnergyPreference";
        revision: 1;
    }>, FlagsT>

  • Modify elements using ElementModifier.enable.

    Type Parameters

    • const FlagsT extends ElementFlags<Of<{
          attributes: {
              currentEnergyBalance: WritableAttribute<number, any> & {
                  isConditional: true;
                  mandatoryIf: [] | [{
                      energyBalance: boolean;
                  }];
                  optional: true;
                  optionalIf: [] | ConditionalFeatureList<BitSchema>;
              };
              currentLowPowerModeSensitivity: WritableAttribute<number, any> & {
                  isConditional: true;
                  mandatoryIf: [] | [{
                      lowPowerModeSensitivity: boolean;
                  }];
                  optional: true;
                  optionalIf: [] | ConditionalFeatureList<BitSchema>;
              };
              energyBalances: FixedAttribute<TypeFromFields<{
                  label: OptionalFieldType<string>;
                  step: FieldType<number>;
              }>[], any> & {
                  isConditional: true;
                  mandatoryIf: [] | [{
                      energyBalance: boolean;
                  }];
                  optional: true;
                  optionalIf: [] | ConditionalFeatureList<BitSchema>;
              };
              energyPriorities: FixedAttribute<EnergyPreference.EnergyPriority[], any> & {
                  isConditional: true;
                  mandatoryIf: [] | [{
                      energyBalance: boolean;
                  }];
                  optional: true;
                  optionalIf: [] | ConditionalFeatureList<BitSchema>;
              };
              lowPowerModeSensitivities: FixedAttribute<TypeFromFields<{
                  label: OptionalFieldType<string>;
                  step: FieldType<number>;
              }>[], any> & {
                  isConditional: true;
                  mandatoryIf: [] | [{
                      lowPowerModeSensitivity: boolean;
                  }];
                  optional: true;
                  optionalIf: [] | ConditionalFeatureList<BitSchema>;
              };
          };
          features: {
              energyBalance: BitFlag;
              lowPowerModeSensitivity: BitFlag;
          };
          id: 155;
          name: "EnergyPreference";
          revision: 1;
      }>>

    Parameters

    Returns WithFlags<Of<{
        attributes: {
            currentEnergyBalance: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            currentLowPowerModeSensitivity: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyBalances: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyPriorities: FixedAttribute<EnergyPreference.EnergyPriority[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            lowPowerModeSensitivities: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        features: {
            energyBalance: BitFlag;
            lowPowerModeSensitivity: BitFlag;
        };
        id: 155;
        name: "EnergyPreference";
        revision: 1;
    }>, FlagsT>

set

  • set<const ValuesT>(values): WithValues<Of<{
        attributes: {
            currentEnergyBalance: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            currentLowPowerModeSensitivity: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyBalances: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyPriorities: FixedAttribute<EnergyPreference.EnergyPriority[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            lowPowerModeSensitivities: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        features: {
            energyBalance: BitFlag;
            lowPowerModeSensitivity: BitFlag;
        };
        id: 155;
        name: "EnergyPreference";
        revision: 1;
    }>, ValuesT>

  • Modify elements using ElementModifier.set.

    Type Parameters

    • const ValuesT extends {
          currentEnergyBalance?: number;
          currentLowPowerModeSensitivity?: number;
          energyBalances?: {
              label?: string;
              step: number;
          }[];
          energyPriorities?: number[];
          lowPowerModeSensitivities?: {
              label?: string;
              step: number;
          }[];
      }

    Parameters

    Returns WithValues<Of<{
        attributes: {
            currentEnergyBalance: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            currentLowPowerModeSensitivity: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyBalances: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyPriorities: FixedAttribute<EnergyPreference.EnergyPriority[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            lowPowerModeSensitivities: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        features: {
            energyBalance: BitFlag;
            lowPowerModeSensitivity: BitFlag;
        };
        id: 155;
        name: "EnergyPreference";
        revision: 1;
    }>, ValuesT>

with

  • with<const SelectionT>(...selection): Of<Of<{
        attributes: {
            currentEnergyBalance: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            currentLowPowerModeSensitivity: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyBalances: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyPriorities: FixedAttribute<EnergyPreference.EnergyPriority[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            lowPowerModeSensitivities: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        features: {
            energyBalance: BitFlag;
            lowPowerModeSensitivity: BitFlag;
        };
        id: 155;
        name: "EnergyPreference";
        revision: 1;
    }>, SelectionT>

  • Select features using ClusterComposer.compose.

    Type Parameters

    • const SelectionT extends FeatureSelection<Of<{
          attributes: {
              currentEnergyBalance: WritableAttribute<number, any> & {
                  isConditional: true;
                  mandatoryIf: [] | [{
                      energyBalance: boolean;
                  }];
                  optional: true;
                  optionalIf: [] | ConditionalFeatureList<BitSchema>;
              };
              currentLowPowerModeSensitivity: WritableAttribute<number, any> & {
                  isConditional: true;
                  mandatoryIf: [] | [{
                      lowPowerModeSensitivity: boolean;
                  }];
                  optional: true;
                  optionalIf: [] | ConditionalFeatureList<BitSchema>;
              };
              energyBalances: FixedAttribute<TypeFromFields<{
                  label: OptionalFieldType<string>;
                  step: FieldType<number>;
              }>[], any> & {
                  isConditional: true;
                  mandatoryIf: [] | [{
                      energyBalance: boolean;
                  }];
                  optional: true;
                  optionalIf: [] | ConditionalFeatureList<BitSchema>;
              };
              energyPriorities: FixedAttribute<EnergyPreference.EnergyPriority[], any> & {
                  isConditional: true;
                  mandatoryIf: [] | [{
                      energyBalance: boolean;
                  }];
                  optional: true;
                  optionalIf: [] | ConditionalFeatureList<BitSchema>;
              };
              lowPowerModeSensitivities: FixedAttribute<TypeFromFields<{
                  label: OptionalFieldType<string>;
                  step: FieldType<number>;
              }>[], any> & {
                  isConditional: true;
                  mandatoryIf: [] | [{
                      lowPowerModeSensitivity: boolean;
                  }];
                  optional: true;
                  optionalIf: [] | ConditionalFeatureList<BitSchema>;
              };
          };
          features: {
              energyBalance: BitFlag;
              lowPowerModeSensitivity: BitFlag;
          };
          id: 155;
          name: "EnergyPreference";
          revision: 1;
      }>>

    Parameters

    Returns Of<Of<{
        attributes: {
            currentEnergyBalance: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            currentLowPowerModeSensitivity: WritableAttribute<number, any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyBalances: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            energyPriorities: FixedAttribute<EnergyPreference.EnergyPriority[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    energyBalance: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
            lowPowerModeSensitivities: FixedAttribute<TypeFromFields<{
                label: OptionalFieldType<string>;
                step: FieldType<number>;
            }>[], any> & {
                isConditional: true;
                mandatoryIf: [] | [{
                    lowPowerModeSensitivity: boolean;
                }];
                optional: true;
                optionalIf: [] | ConditionalFeatureList<BitSchema>;
            };
        };
        features: {
            energyBalance: BitFlag;
            lowPowerModeSensitivity: BitFlag;
        };
        id: 155;
        name: "EnergyPreference";
        revision: 1;
    }>, SelectionT>

Settings

Member Visibility

On This Page

Properties
Methods