Console

Starter 

protocol Starter : NodeWithOutput

Base protocol for all Starters in the automation graph.

  • The unique entity for the HomeDevice or Structure entity associated with the Starter.

    entity will be nil if the implementing class’s init(entityExpression: …) was used and the entityExpression is not a Constant to a HomeObject.

    Declaration

    Swift

    var entity: (any HomeObject)? { get }

  • An expression that selects an entity or a list of entities associated with the Starter at runtime.

    When entityExpression represents a single entity, entityExpression will be Constant(value: AnyAutomationEntity). Otherwise, entityExpression is an Expression capable of resolving to any number of entities.

    Declaration

    Swift

    var entityExpression: any Expression { get }

  • The identifier for the DeviceType associated with the Starter, if the entity is a device.

    deviceType will be nil if entity is nil or not a device, such as a Structure or Room.

    Declaration

    Swift

    var deviceType: (any DeviceType.Type)? { get }

  • The string-based identifier for the DeviceType. If deviceType is UnknownDeviceType it will refer to the original deviceTypeID provided.

    deviceTypeID will be nil if entity is nil or not a device, such as a Structure or Room.

    Declaration

    Swift

    var deviceTypeID: String? { get }