Skip to content
Pocket Homelab
Get the app

Widgets and Shortcuts

Home Screen and Lock Screen widgets, a Notes widget, an AdGuard switch for Control Center, Shortcuts actions for Siri and the Action Button, and pockethomelab links.

iPhone
On this page

A few things work without opening the app: three widgets, a Control Center switch, a set of actions in the Shortcuts app, and links that open a screen or an action. None of them need Pro: they follow your services, so the free plan’s three get all of them.

Widgets

  1. Touch and hold the Home Screen (or the Lock Screen), then tap Edit.
  2. Tap Add Widget and look for Pocket Homelab.
  3. Pick Right Now or Notes for the Home Screen, or Downloads for the Lock Screen.
Widget Sizes Shows A tap opens
Right Now Home Screen, small and medium Server, NAS, downloads and monitors, one row each, with a green tick or an orange warning and how old the numbers are. Medium adds what waits to sync (“all synced”, “2 to sync”), what is playing, and “AdGuard paused”. Home. On medium, each row opens its own screen: Server, NAS, Downloads, Monitors, Podcasts.
Downloads Lock Screen: rectangular, circular, inline Active downloads and their total speed, “Downloads idle”, or “No download client”. Downloads
Notes Home Screen, small, medium and large Today’s note and your pinned note, the favourite you edited last, with their first lines. Small shows today’s note; medium puts the two side by side; large gives each more lines. Today’s note, made when there is none yet. On medium and large, the pinned half opens Notes.

With none of those services set up, Right Now says “Add a server, downloads or Uptime Kuma to see them here.” The Notes widget needs Nextcloud Notes; with no daily note yet it says “Tap to start today’s note”, and with no favourite “Mark a note as favourite to pin it here”.

AdGuard in Control Center

AdGuard Protection is a control you can add to Control Center (and, like any control, to the Lock Screen or the Action Button). It is a switch labelled AdGuard that reads Protecting or Paused: switching it off pauses AdGuard Home for 30 minutes, switching it on turns protection back on.

The switch itself runs in the app, which asks AdGuard for the current state before it changes anything. What the control shows comes from the snapshot; when nothing is known yet it shows Protecting, AdGuard’s resting state.

Shortcuts, Siri and the Action Button

Ten shortcuts exist without any setup, for Siri, Spotlight, the Shortcuts app’s gallery and the Action Button (Settings → Action Button → Shortcut). Five more are in the Shortcuts app’s action list: Open Quick Action, Set AdGuard Protection, Sync Pending Changes, Append to Today’s Note and New Quick Note.

These open the app

Action What it does Needs
Add Transaction Opens the Firefly assistant with the keyboard up. Firefly III
New Task Opens quick add for a Nextcloud task. Nextcloud
Add Fuel Opens a new LubeLogger fuel-up. LubeLogger
New Deck Card Opens quick add for a Nextcloud Deck card. Nextcloud
Search Homelab Opens the search for screens, actions, your library and your files. always
Resume Watching Plays the first item in Jellyfin’s Continue Watching. Jellyfin
New Podcast Note Opens a note at the current position of the podcast or audiobook that is loaded. something loaded
Open Quick Action Opens any quick action you pick as its Action parameter, such as “Open Add to daily note”. that action’s service
New Quick Note Opens a new note in your Quick Notes folder, with the Text you give it already in it. Nextcloud Notes

Open Quick Action offers every quick action except AdGuard, which has actions of its own, and your own screen shortcuts. New Podcast Note needs something loaded in a player while the app is running; otherwise it says “Nothing is loaded. Start a podcast or an audiobook in Pocket Homelab first.”

These answer without opening the app

Action What it does Returns
Toggle AdGuard Protection Pauses AdGuard Home for 30 minutes, or resumes it if it is paused. Whether protection is on
Set AdGuard Protection Turns protection on, or pauses it for 30 minutes, from its Protection parameter. Nothing
Play or Pause Plays or pauses the podcast, audiobook or music loaded in Pocket Homelab. Nothing
Sync Pending Changes Sends the changes and playback positions saved while a server could not be reached. How many still wait
Append to Today’s Note Adds its Text to the end of today’s note in Nextcloud Notes. It says “Added to today’s note.”, or, with the server out of reach, that the line is saved on the iPhone and sent later. Nothing
Homelab Status Says how many downloads are active and how fast, which monitors are down, and how many changes wait to sync. The sentence

Homelab Status reads the widget snapshot when it is less than two minutes old, and otherwise asks your servers first, for up to ten seconds. It also mentions a degraded NAS pool or paused AdGuard, and how old the numbers are when they are more than five minutes old.

Some Siri phrases: “Add a transaction in Pocket Homelab”, “New task in Pocket Homelab”, “Search Pocket Homelab”, “Pocket Homelab status”, “Pause Pocket Homelab”.

Two kinds of link open the app, from a widget, a web page, a note or another app:

  • pockethomelab://tab/<tab> opens a screen: as its tab when the tab is in your tab bar, as a sheet when it is not, and Home when that service is not available.
  • pockethomelab://action/<action> runs a quick action, the same ones Open Quick Action offers.

Because any page or app can open such a link, a link only ever shows something: AdGuard cannot be switched by a link. An action whose service is missing shows ““…” is not available”.

Most tab names are the screen’s title in lower case: downloads, monitors, notes, tasks and so on. These differ:

Tab link Screen
now Home
badge Notifications
listen Podcasts
stats Server
memories Photos
jellystat Stats
nextcloud Cloud
forgejo Code
paperless Docs
calibre Books

Action links use these names: addTransaction, addFuel, addVehicleExpense, newTask, newDeckCard, spotlight (search), resumeWatching, sendToMetube, searchDiscover, searchPhotos, searchWeb, cloudSearch, searchIndexers, requestMusic, nudgeSubtitles, serverStats, watchStats, alerts, badge, code, documents, mediaCalendar, ebooks, music, audiobooks, listen (Podcasts), contacts, deck, tasks, dailyNote and appendDailyNote. For example, pockethomelab://action/newTask opens quick add for a task.