docs » TimeMachineProgress

Show Time Machine backup progress in a menubar indicator.

If no backup is in progress, the indicator disappears. When a backup is in preparation of in progress, the indicator is shown, indicating current state/progress of the backup.

Download: https://github.com/Hammerspoon/Spoons/raw/master/Spoons/TimeMachineProgress.spoon.zip

API Overview

API Documentation

Variables

backupIcon
Signature TimeMachineProgress.backupIcon
Type Variable
Description

Image to use for the menubar icon. Defaults to the default macOS Time Machine menubar icon stored in /System/Library/CoreServices/Menu Extras/TimeMachine.menu/Contents/Resources/TMBackingUp.pdf. If this fails, it defaults to the Time Machine application icon, obtained as hs.image.imageFromAppBundle('com.apple.backup.launcher'):setSize({w=18,h=18}).

Source Source/TimeMachineProgress.spoon/init.lua
logger
Signature TimeMachineProgress.logger
Type Variable
Description

Logger object used within the Spoon. Can be accessed to set the default log level for the messages coming from the Spoon.

Source Source/TimeMachineProgress.spoon/init.lua
refresh_interval
Signature TimeMachineProgress.refresh_interval
Type Variable
Description

Integer specifying how often the indicator should be refreshed. Defaults to 5 seconds.

Source Source/TimeMachineProgress.spoon/init.lua

Methods

refresh
Signature TimeMachineProgress:refresh()
Type Method
Description

Update the indicator and menu according to the current backup status.

Parameters:

  • None
Source Source/TimeMachineProgress.spoon/init.lua
start
Signature TimeMachineProgress:start()
Type Method
Description

Starts the indicator

Parameters:

  • None

Returns:

  • The TimeMachineProgress object
Source Source/TimeMachineProgress.spoon/init.lua
stop
Signature TimeMachineProgress:stop()
Type Method
Description

Stops the indicator

Parameters:

  • None

Returns:

  • The TimeMachineProgress object
Source Source/TimeMachineProgress.spoon/init.lua