Clock Qwidget - AudacySpace/quindar-ux GitHub Wiki

Description

The purpose of this qwidget is to show one or more time displays of clock type or timer type.Time is shown in the format of "days.hour:min:sec" where days is the day in the year(e.g. 32 is February 1st).The clocks are driven by the proxy time source.

The qwidget layout has three views:

  • Main View (Default view)
  • Delete Menu
  • Settings Menu

Main View

On opening the qwidget, this view is displayed.This viewing window has the following main element

  • Table of all the clock(selected from settings menu) and timers(set from settings menu)

Clocks and Timers Table

  • Each row is either a clock or a timer in the table.
  • The default row in the table is a UTC time of the streamed data.
  • Clocks show specific time zone time, selected by the user.
  • Timers show the delta from a specific moment in time, selectable by the user.In the most basic form, the user can set a specific time as the reference point(e.g. 024.12.32.10) like setting an alarm on a calendar.
  • Timer starts counting up when it hits zero.
  • Timer changes its color to #FFC400 when under 60 seconds.
  • Timer changes its color to #FF0000 when under 10 seconds.
  • A quindar tone is played when timer hits zero.
  • There is a trash icon at the end of each row in the table. Clicking on the trash icon will delete the row.In case or zero rows, the user has to go to the settings menu and add Clock or Timer.

Delete Menu

This menu can be viewed by clicking the trash icon on the qwidget header.It has yes and no buttons.This menu is used to delete the qwidget from the dashboard.

Settings Menu

This menu can be viewed by clicking the settings button(cog icon) on the qwidget header.This menu is used to select clock or set a timer.This menu has the following main elements.

  • A select type dropdown with options ‘Clock’ and ‘Timer’ to select.
  • A select timezone dropdown to select timezone of the clock to be displayed. (this element is displayed only when ‘Clock’ is selected)
  • An Input field to enter the name of the timer(this element is displayed only when ‘Timer’ is selected)
  • A Data -Time selector (this element is displayed only when ‘Timer’ is selected)
  • Add and Close buttons

Clock Selection The following section explains how to select clock and add it to the qwidget main layout.

  • From Select Type dropdown, select clock. This will show the dropdown to select the time zone.
  • From Select Timezone dropdown, select a time zone. The available time zones to select are UTC, San Francisco, Luxembourg and Singapore.This selection is required to add the clock to the main layout table.

Timer Selection The following section explains how to select timer and add it to the qwidget main layo ut.

  1. From Select Type dropdown, select timer. This will show an input field and a date - time selector..
  2. Enter the name for the timer in the input field. The maximum length of the name is 20 characters.
  3. Select the time from the date-time selector.
  4. Both step 2 and 3 are required to add the timer to the main layout table.

Add

  • This is used to add the selected clock or timer data to the qwidget. On successful addition, the qwidget layout changes from settings menu to main view layout displaying the newly added clock or timer.

Close

  • This is used to close the settings menu and view the main layout. Any changes made before close are lost if not added before.