Console

CookTrait 

struct CookTrait

This trait belongs to devices that can cook food according to various food presets and supported cooking modes.

  • Returns a Boolean value indicating whether two values are equal.

    Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

    Declaration

    Swift

    static func == (lhs: Google.CookTrait, rhs: Google.CookTrait) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

  • Attributes for the CookTrait.

    Declaration

    Swift

    struct Attributes

  • The current cooking mode.

    Declaration

    Swift

    enum CookingMode

  • Internal name of the food preset. This name can be non-user-friendly, and is shared across all languages.

    Declaration

    Swift

    struct FoodPreset

  • Available food synonyms for a language.

    Declaration

    Swift

    struct FoodSynonym

  • The available Units.

    Declaration

    Swift

    enum Unit

  • List of attributes for the CookTrait.

    Declaration

    Swift

    let attributes: Google.CookTrait.Attributes

  • Start or stop cooking.

    Declaration

    Swift

    func cook(start: Bool, cookingMode: Google.CookTrait.CookingMode, foodPreset: String, quantity: Float32, unit: Google.CookTrait.Unit) async throws -> Google.CookTrait.CookCommandResponse

    Parameters

    start

    If set to true, start cooking, if false, stop current cooking mode.
    cookingMode

    Cooking mode for the device, as indicated by the currentCookingMode attribute.
    foodPreset

    The food preset requested by the user, as indicated by the currentFoodPreset attribute.
    quantity

    Quantity of the food requested by the user.
    unit

    Unit associated with the quantity, as indicated by the currentFoodUnit attribute.

  • The batchable version of cook command above.

    See also

    cook

    Declaration

    Swift

    func cookBatchable(start: Bool, cookingMode: Google.CookTrait.CookingMode, foodPreset: String, quantity: Float32, unit: Google.CookTrait.Unit) throws -> BatchableCommand<Google.CookTrait.CookCommandResponse>

  • Writes this object to the given TraitEncoder. Throws HomeError.encodingFailed if the data could not be encoded.

    Declaration

    Swift

    func encode(with encoder: TraitEncoder) throws

  • This API provides the ability to invalidate state retrieved through subscriptions to the target device in the cases where state is not being reported correctly, either intentionally (e.g attributes in Matter traits with the “C” quality) or unintentionally due to poor implementations.

    When successful, this API will result in a forced read of the convening scope as specified by the sub-class and return the result through existing Trait subscriptions if present and active.

    This API is to be used sparingly as it can impact the performance and battery life of the target device. As such, this API may be throttled by the platform. Callers SHALL be prepared to deal with HomeErrors thrown by this call.

    Declaration

    Swift

    func forceRead() async throws

  • Hashes the essential components of this value by feeding them into the given hasher.

    Implement this method to conform to the Hashable protocol. The components used for hashing must be the same as the components compared in your type’s == operator implementation. Call hasher.combine(_:) with each of these components.

    Important

    In your implementation of hash(into:), don’t call finalize() on the hasher instance provided, or replace it with a different instance. Doing so may become a compile-time error in the future.

    Declaration

    Swift

    func hash(into hasher: inout Hasher)

  • The trait identifier.

    Declaration

    Swift

    static let identifier: String

  • Creates a new Trait instance using data read from the given TraitDecoder.

    Throws

    HomeError.parseError when parsing fails.

    Declaration

    Swift

    init(decoder: TraitDecoder, interactionProxy: (any InteractionProxy)?, metadata: TraitMetadata) throws

    Parameters

    decoder

    The raw data representing this Trait.
    interactionProxy

    Proxy to the Interaction Client.
    metadata

    Metadata about this Trait.

  • Metadata about this Trait.

    Declaration

    Swift

    let metadata: TraitMetadata

  • List of the commands that are supported by CookTrait.

    Declaration

    Swift

    static let supportedCommandTypes: [any Command.Type]

  • No supported events for CookTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • Whether the device supports the cook command for this trait.

    Declaration

    Swift

    var supportsCookCommand: Bool { get }