diff --git a/source/_dashboards/clock.markdown b/source/_dashboards/clock.markdown index cf201a7625d7..3300a73107ef 100644 --- a/source/_dashboards/clock.markdown +++ b/source/_dashboards/clock.markdown @@ -19,23 +19,78 @@ Screenshot of the clock card All options for this card can be configured via the user interface. - ## Card settings -{% configuration_basic %} -Title: +{% configuration %} +title: description: Adds a title to the top of the card -Clock Size: + type: string + required: false +clock_style: + description: Allows the clock to be displayed in a digital or analog style. Defaults to digital. + type: list + required: false + default: digital + keys: + digital: + description: Digital clock style. + analog: + description: Analog clock style. +clock_size: description: Adjusts the size of the text allowing a wider range of use with different types of dashboards. Defaults to small. -Display Seconds: + type: list + required: false + default: small + keys: + small: + description: Small clock size. + medium: + description: Medium clock size. + large: + description: Large clock size. +show_seconds: description: Shows seconds alongside the clock, providing the time format is in a 12-hour format. -No Background: + type: boolean + required: false + default: false +no_background: description: Removes the background of the clock card. -Time Format: + type: boolean + required: false + default: false +time_format: description: Allows the time format to be changed on a per-card level. Defaults to the user profile setting. -Time Zone: + type: string + required: false +time_zone: description: Change the timezone used for the time on a per-card level. Defaults to the user profile setting. -{% endconfiguration_basic %} + type: string + required: false +analog_options: + description: When using the analog clock style, this allows the user to configure the appearance of the clock. + type: map + required: false + keys: + border: + description: Shows a border around the clock face. Defaults to false. + type: boolean + required: false + default: false + ticks: + description: Shows ticks (indices) on the clock face. Defaults to hour. + type: list + required: false + default: hour + keys: + none: + description: No ticks are shown. + quarter: + description: Quarter hour ticks are shown. + hour: + description: Hour ticks are shown. + minute: + description: Minute ticks are shown. +{% endconfiguration %} ### Examples @@ -50,7 +105,6 @@ type: clock Screenshot of the basic clock card

- Example of a larger clock card for tablet dashboards: ```yaml @@ -109,3 +163,54 @@ title: New York 🦅 Screenshot of a medium sized, 12 hour clock showing am/pm and seconds based in New York along with a title Screenshot of a medium sized, 12 hour clock showing am/pm and seconds based in New York along with a title

+ +Analog clock with no border and hour ticks: + +```yaml +type: clock +clock_style: analog +clock_size: medium +analog_options: + border: false + ticks: hour +``` + +

+Screenshot of a medium sized, analog clock and hour ticks +Screenshot of a medium sized, analog clock and hour ticks +

+ +Analog clock with border and minute ticks showing seconds: + +```yaml +type: clock +clock_style: analog +clock_size: medium +show_seconds: true +analog_options: + border: true + ticks: minute +``` + +

+Screenshot of a medium sized, analog clock and minute ticks showing seconds +Screenshot of a medium sized, analog clock and minute ticks showing seconds +

+ +Analog clock with a title, no ticks and border with seconds: + +```yaml +type: clock +clock_style: analog +clock_size: medium +show_seconds: true +analog_options: + border: true + ticks: none +title: Mountain Time +``` + +

+Screenshot of a medium sized, analog clock with a title, no ticks and border showing seconds +Screenshot of a medium sized, analog clock with a title, no ticks and border showing seconds +

diff --git a/source/images/dashboards/clock_card_analog_hour_ticks.png b/source/images/dashboards/clock_card_analog_hour_ticks.png new file mode 100644 index 000000000000..1eeaa17106f0 Binary files /dev/null and b/source/images/dashboards/clock_card_analog_hour_ticks.png differ diff --git a/source/images/dashboards/clock_card_analog_minute_ticks_border.png b/source/images/dashboards/clock_card_analog_minute_ticks_border.png new file mode 100644 index 000000000000..4479ff5830d2 Binary files /dev/null and b/source/images/dashboards/clock_card_analog_minute_ticks_border.png differ diff --git a/source/images/dashboards/clock_card_analog_no_ticks_border_title_mountain_time.png b/source/images/dashboards/clock_card_analog_no_ticks_border_title_mountain_time.png new file mode 100644 index 000000000000..6148361bcbd6 Binary files /dev/null and b/source/images/dashboards/clock_card_analog_no_ticks_border_title_mountain_time.png differ