Class FixedAttributeServer<T>

constructor

• new FixedAttributeServer<T>(id, name, readAcl, writeAcl, schema, isWritable, isSubscribable, requiresTimedInteraction, initValue, defaultValue, datasource, getter?): FixedAttributeServer<T>

• Type Parameters

  • T

  Parameters

  • id: AttributeId
  • name: string
  • readAcl: undefined | AccessLevel
  • writeAcl: undefined | AccessLevel
  • schema: TlvSchema<T>
  • isWritable: boolean
  • isSubscribable: boolean
  • requiresTimedInteraction: boolean
  • initValue: T
  • defaultValue: undefined | T
  • datasource: ClusterDatasource<any>
  • Optionalgetter: ((session?: Session, endpoint?: EndpointInterface, isFabricFiltered?: boolean, message?: Message) => T)

    Optional getter function to handle special requirements or the data are stored in different places.

    • • (session?, endpoint?, isFabricFiltered?, message?): T

      • Parameters

        • Optionalsession: Session

          the session that is requesting the value (if any)
        • Optionalendpoint: EndpointInterface

          the endpoint the cluster server of this attribute is assigned to
        • OptionalisFabricFiltered: boolean

          whether the read request is fabric scoped or not
        • Optionalmessage: Message

          the wire message that initiated the request (if any)

        Returns T

  Returns FixedAttributeServer<T>

ReadonlyisFixed

addValueChangeListener

• addValueChangeListener(_listener): void

• Add an internal listener that is called when the value of the attribute changes. The listener is called with the new value and the version number.

  Parameters

  • _listener: ((value: T, version: number) => void)
    • • (value, version): void

      • Parameters

        • value: T
        • version: number

        Returns void

  Returns void

addValueSetListener

• addValueSetListener(_listener): void

• Add an external listener that is called when the value of the attribute changes. The listener is called with the new value and the old value.

  Parameters

  • _listener: ((newValue: T, oldValue: T) => void)
    • • (newValue, oldValue): void

      • Parameters

        • newValue: T
        • oldValue: T

        Returns void

  Returns void

get

• get(session, isFabricFiltered, message?): T

• Get the value of the attribute. This method is used by the Interaction model to read the value of the attribute and includes the ACL check. It should not be used locally in the code!

  If a getter is defined the value is determined by that getter method.

  Parameters

  • session: Session
  • isFabricFiltered: boolean
  • Optionalmessage: Message

  Returns T

getLocal

• getLocal(): T

• Get the value of the attribute locally. This method should be used locally in the code and does not include the ACL check. If a getter is defined the value is determined by that getter method.

  Returns T

getWithVersion

• getWithVersion(session, isFabricFiltered, message?): {
      value: T;
      version: number;
  }

• Get the value of the attribute including the version number. This method is used by the Interaction model to read the value of the attribute and includes the ACL check. It should not be used locally in the code!

  If a getter is defined the value is determined by that getter method. The version number is always 0 for fixed attributes.

  Parameters

  • session: Session
  • isFabricFiltered: boolean
  • Optionalmessage: Message

  Returns {
      value: T;
      version: number;
  }

  • value: T

  • version: number

init

• init(value): void

• Initialize the value of the attribute, used when a persisted value is set initially or when values needs to be adjusted before the Device gets announced. Do not use this method to change values when the device is in use! If a getter or setter is defined the value must be undefined The version number must also be undefined.

  Parameters

  • value: undefined | T

  Returns void

removeValueChangeListener

• removeValueChangeListener(_listener): void

• Remove an internal listener.

  Parameters

  • _listener: ((value: T, version: number) => void)
    • • (value, version): void

      • Parameters

        • value: T
        • version: number

        Returns void

  Returns void

removeValueSetListener

• removeValueSetListener(_listener): void

• Remove an external listener.

  Parameters

  • _listener: ((newValue: T, oldValue: T) => void)
    • • (newValue, oldValue): void

      • Parameters

        • newValue: T
        • oldValue: T

        Returns void

  Returns void

subscribe

• subscribe(_listener): void

• Add an external listener that is called when the value of the attribute changes. The listener is called with the new value and the old value. This method is a convenient alias for addValueSetListener.

  Parameters

  • _listener: ((newValue: T, oldValue: T) => void)
    • • (newValue, oldValue): void

      • Parameters

        • newValue: T
        • oldValue: T

        Returns void

  Returns void