manual.txt 2.1 KB

1234567891011121314151617181920212223242526272829
  1. # Inteface Overview
  2. The timer shows hours, minutes and seconds from left to right. You can set the time by clicking on the section of the timer and typing in the numbers.
  3. On the right side there are three buttons:
  4. 1. Top button, starts the timer counting up.
  5. 2. Bottom button, starts the timer counting down.
  6. 3. Middle button pauses the timer, or if long pressed rests to the value that was set before the countdown started.
  7. When the timer reaches zero it plays a sound. Unless specified otherwise it would be the melno.wav file in the "current directory". In this alarm state all controls are disabled except the middle button which will stop the sound and reset the timer when pressed.
  8. There a usual concept of focus that works with mouse and keyboard controls for it. Tab and Shift+Tab keys will move the focus between the controls. When focused on a section of time display you can input a number. When focused on a button you can press it with the Space key (long press would also work).
  9. Note that you can start several instances of the application at the same time, they don't remember any state and should not interfere with each other.
  10. # Special secret dangerous command line parameters
  11. When starting the application from command line there are 8 positional parameters that you can specify:
  12. 1. The name of the audio file to be played when timer reaches 0 (default: ./melno.wav). Currently only WAV format is supported. You can specify an empty string to disable sound.
  13. 2. The hours to set the timer to (default: 0).
  14. 3. The minutes to set the timer to (default: 0).
  15. 4. The seconds to set the timer to (default: 0).
  16. 5. The primary/foreground color of the UI, specified as a number/code. (default: 0x009dff).
  17. 6. The secondary/background color of the UI, specified as a number/code. (default: 0x000000).
  18. 7. The frame time in milliseconds (default: 33).
  19. 8. The frame time when the application is minimized, in milliseconds (default: 256)
  20. Any invalid input (non existent files, wrong file formats, wrong number formats, etc.) will gracefully crash the application.
  21. The audio file is loaded into memory in its entirety when the application starts, so be careful with large files.