Skip to content

Commit

Permalink
Add "Placeholder" complication (#1284)
Browse files Browse the repository at this point in the history 
Since we only offer complications for configured versions, we don't have a quick "launch the app" complication available without creating one, and you cannot create one that's just the HA logo.

Rather than adding a new template configuration for the app icon, this adds a complication to all places we support which show some variant of "Home Assistant", "HA" and the app icon without any kind of "this is an error!" state.

Fixes #1281. Fixes #525.
  • Loading branch information
@zacwest
zacwest committed Nov 19, 2020
1 parent 466ae58 commit 1c780c5
Show file tree
Hide file tree
Showing 4 changed files with 108 additions and 36 deletions.
1 change: 1 addition & 0 deletions Sources/App/Resources/en.lproj/Localizable.strings
View file
Expand Up @@ -903,3 +903,4 @@ Tags will work on any device with Home Assistant installed which has hardware su
"watch.configurator.list.learn_more" = "Learn More";
"watch.configurator.rows.display_name.title" = "Display Name";
"watch.configurator.rows.is_public.title" = "Show When Locked";
"watch.placeholder_complication_name" = "Placeholder";
19 changes: 16 additions & 3 deletions Sources/Extensions/Watch/ComplicationController.swift
View file
Expand Up @@ -78,8 +78,15 @@ class ComplicationController: NSObject, CLKComplicationDataSource {
if let fromComplication = self.template(for: complication) {
template = fromComplication
} else {
Current.Log.error("failed to get template, providing error")
template = ComplicationGroupMember(family: complication.family).errorTemplate
Current.Log.info("no configured template, providing placeholder")

if #available(watchOS 7, *) {
template = ComplicationGroupMember(family: complication.family)
.fallbackTemplate(for: complication.identifier)
} else {
template = ComplicationGroupMember(family: complication.family)
.fallbackTemplate(for: nil)
}
}

let date = Date().encodedForComplication(family: complication.family) ?? Date()
Expand All @@ -99,7 +106,13 @@ class ComplicationController: NSObject, CLKComplicationDataSource {

@available(watchOS 7.0, *)
func getComplicationDescriptors(handler: @escaping ([CLKComplicationDescriptor]) -> Void) {
handler(Current.realm().objects(WatchComplication.self).map(\.complicationDescriptor))
let configured = Current.realm().objects(WatchComplication.self)
.map(\.complicationDescriptor)

let placeholders = ComplicationGroupMember.allCases
.map(\.placeholderComplicationDescriptor)

handler(configured + placeholders)
}
}

Expand Down
122 changes: 89 additions & 33 deletions Sources/Shared/Common/Extensions/CLKComplication+Strings.swift
View file
Expand Up @@ -179,6 +179,16 @@ public enum ComplicationGroupMember: String, Comparable {
return .utilitarianSmallFlat
}
}

@available(watchOS 7.0, *)
public var placeholderComplicationDescriptor: CLKComplicationDescriptor {
CLKComplicationDescriptor(
identifier: "placeholder-" + rawValue,
displayName: L10n.Watch.placeholderComplicationName,
supportedFamilies: [ family ]
)
}

#endif

// #if os(iOS)
Expand Down Expand Up @@ -340,10 +350,12 @@ public enum ComplicationGroupMember: String, Comparable {
}

#if os(watchOS)
public var errorTemplate: CLKComplicationTemplate {
// swiftlint:disable:next function_body_length
public func fallbackTemplate(for identifier: String?) -> CLKComplicationTemplate {
let logoImage = UIImage(named: "RoundLogo")!
let templateImage = UIImage(named: "TemplateLogo")!
let hassColor = Constants.tintColor
let isPlaceholder = identifier?.starts(with: "placeholder") == true

switch self {
case .circularSmall:
Expand All @@ -361,7 +373,7 @@ public enum ComplicationGroupMember: String, Comparable {
let imageTemplate = CLKComplicationTemplateGraphicCircularImage()
imageTemplate.imageProvider = CLKFullColorImageProvider(fullColorImage: logoImage)
template.circularTemplate = imageTemplate
template.textProvider = CLKSimpleTextProvider(text: "??")
template.textProvider = CLKSimpleTextProvider(text: isPlaceholder ? "HA" : "??")
return template
case .graphicCircular:
let template = CLKComplicationTemplateGraphicCircularImage()
Expand All @@ -372,46 +384,90 @@ public enum ComplicationGroupMember: String, Comparable {
template.imageProvider = CLKFullColorImageProvider(fullColorImage: logoImage)
return template
case .graphicRectangular:
let template = CLKComplicationTemplateGraphicRectangularStandardBody()
template.headerImageProvider = CLKFullColorImageProvider(fullColorImage: logoImage)
template.headerTextProvider = CLKSimpleTextProvider(text: "Not configured")
let desc = ComplicationTemplate.GraphicRectangularStandardBody.description
template.body1TextProvider = CLKSimpleTextProvider(text: desc)
template.body2TextProvider = CLKSimpleTextProvider(text: "has not been configured")
return template
if isPlaceholder {
if #available(watchOS 7, *) {
let template = CLKComplicationTemplateGraphicRectangularFullImage()
template.imageProvider = CLKFullColorImageProvider(fullColorImage: logoImage)
return template
} else {
let template = CLKComplicationTemplateGraphicRectangularLargeImage()
template.textProvider = CLKSimpleTextProvider(text: "Home Assistant")
template.imageProvider = CLKFullColorImageProvider(fullColorImage: logoImage)
return template
}
} else {
let template = CLKComplicationTemplateGraphicRectangularStandardBody()
template.headerImageProvider = CLKFullColorImageProvider(fullColorImage: logoImage)
template.headerTextProvider = CLKSimpleTextProvider(text: "Not configured")
let desc = ComplicationTemplate.GraphicRectangularStandardBody.description
template.body1TextProvider = CLKSimpleTextProvider(text: desc)
template.body2TextProvider = CLKSimpleTextProvider(text: "has not been configured")
return template
}
case .modularLarge:
let template = CLKComplicationTemplateModularLargeTallBody()
template.headerTextProvider = CLKSimpleTextProvider(text: "Not configured")
let desc = ComplicationTemplate.GraphicRectangularStandardBody.description
template.bodyTextProvider = CLKSimpleTextProvider(text: "\(desc) has not been configured in the app")
template.tintColor = hassColor
return template
if isPlaceholder {
let template = CLKComplicationTemplateModularLargeStandardBody()
template.headerTextProvider = CLKSimpleTextProvider(text: "Home Assistant")
template.body1TextProvider = CLKSimpleTextProvider(text: "Home Assistant")
template.tintColor = hassColor
return template
} else {
let template = CLKComplicationTemplateModularLargeTallBody()
template.headerTextProvider = CLKSimpleTextProvider(text: "Not configured")
let desc = ComplicationTemplate.GraphicRectangularStandardBody.description
template.bodyTextProvider = CLKSimpleTextProvider(text: "\(desc) has not been configured in the app")
template.tintColor = hassColor
return template
}
case .modularSmall:
let template = CLKComplicationTemplateModularSmallStackImage()
template.line1ImageProvider = CLKImageProvider(onePieceImage: templateImage)
let desc = ComplicationTemplate.ModularSmallStackImage.description
template.line2TextProvider = CLKSimpleTextProvider(text: "\(desc) has not been configured in the app")
template.tintColor = hassColor
return template
if isPlaceholder {
let template = CLKComplicationTemplateModularSmallSimpleImage()
template.imageProvider = CLKImageProvider(onePieceImage: templateImage)
template.tintColor = hassColor
return template
} else {
let template = CLKComplicationTemplateModularSmallStackImage()
template.line1ImageProvider = CLKImageProvider(onePieceImage: templateImage)
let desc = ComplicationTemplate.ModularSmallStackImage.description
template.line2TextProvider = CLKSimpleTextProvider(text: "\(desc) has not been configured in the app")
template.tintColor = hassColor
return template
}
case .utilitarianLarge:
let template = CLKComplicationTemplateUtilitarianLargeFlat()
template.imageProvider = CLKImageProvider(onePieceImage: templateImage)
let desc = ComplicationTemplate.UtilitarianLargeFlat.description
template.textProvider = CLKSimpleTextProvider(text: "\(desc) has not been configured in the app")
template.tintColor = hassColor
return template
if isPlaceholder {
let template = CLKComplicationTemplateUtilitarianLargeFlat()
template.imageProvider = CLKImageProvider(onePieceImage: templateImage)
template.textProvider = CLKSimpleTextProvider(text: "Home Assistant")
template.tintColor = hassColor
return template
} else {
let template = CLKComplicationTemplateUtilitarianLargeFlat()
template.imageProvider = CLKImageProvider(onePieceImage: templateImage)
let desc = ComplicationTemplate.UtilitarianLargeFlat.description
template.textProvider = CLKSimpleTextProvider(text: "\(desc) has not been configured in the app")
template.tintColor = hassColor
return template
}
case .utilitarianSmall:
let template = CLKComplicationTemplateUtilitarianSmallSquare()
template.imageProvider = CLKImageProvider(onePieceImage: templateImage)
template.tintColor = hassColor
return template
case .utilitarianSmallFlat:
let template = CLKComplicationTemplateUtilitarianSmallFlat()
template.imageProvider = CLKImageProvider(onePieceImage: templateImage)
let desc = ComplicationTemplate.UtilitarianSmallFlat.description
template.textProvider = CLKSimpleTextProvider(text: "\(desc) has not been configured in the app")
template.tintColor = hassColor
return template
if isPlaceholder {
let template = CLKComplicationTemplateUtilitarianSmallFlat()
template.imageProvider = CLKImageProvider(onePieceImage: templateImage)
template.textProvider = CLKSimpleTextProvider(text: "HA")
template.tintColor = hassColor
return template
} else {
let template = CLKComplicationTemplateUtilitarianSmallFlat()
template.imageProvider = CLKImageProvider(onePieceImage: templateImage)
let desc = ComplicationTemplate.UtilitarianSmallFlat.description
template.textProvider = CLKSimpleTextProvider(text: "\(desc) has not been configured in the app")
template.tintColor = hassColor
return template
}
}
}
#endif
Expand Down
2 changes: 2 additions & 0 deletions Sources/Shared/Resources/Swiftgen/Strings.swift
View file
Expand Up @@ -2223,6 +2223,8 @@ public enum L10n {
}

public enum Watch {
/// Placeholder
public static var placeholderComplicationName: String { return L10n.tr("Localizable", "watch.placeholder_complication_name") }
public enum Configurator {
public enum Delete {
/// Delete Complication
Expand Down

0 comments on commit 1c780c5

Please sign in to comment.