Repository navigation
Releases
Releases · geodox/ps5-wh-widgets
26.11.20 beta
26.11.20 beta
New in Welcome Hub Settings
- Telemetry: choose Hide custom widgets (the default) or Off.
- Hide custom widgets: the Welcome Hub reports as usual, without your custom widgets.
- Off: no telemetry is sent from the console's interface code.
- The setting covers the whole console and takes effect immediately in the Welcome Hub. Sign out and back in to apply it everywhere.
- Widget Data: shows what each widget has saved for you, with its size and whether the widget is still installed. You can delete one widget's data, or the data of every widget you've removed.
Widgets
- Home Assistant:
- Your entities are now cards showing an icon, the state and the name.
- Cards of entities that are on, open, unlocked, playing or heating are brighter.
- Cards per row in Options: 1, 2 or 3. An XL tile shows twice as many.
- When there are more cards than fit, the title shows the range, such as
1-9 of 18. Inside the tile, Down on the last row and Up on the first scroll to the rest.
- Payload Launcher: payload pages are now cards, with Cards per row set to 1 or 2. It scrolls the same way as Home Assistant.
- Payload Monitor: a long list turns pages by itself every few seconds. L1 / R1 page it while the tile is focused.
Fixes and polish
- Moving inside a widget no longer plays the "can't move" sound on every press. You hear the move sound, and the "can't move" sound only at an edge.
- Closing a widget's page returns focus to that widget, on the same item if you opened it from inside.
- The key guide bar drawn inside a focused tile is gone by default. The hub's own Options hint below the tile stays.
For widget makers
wh.usePages(total, perPage, {interval, pause})pages a long list on a tile you can't enter, with automatic turning plus L1 / R1.wh.Focusablehas a newautoSelectprop for scrolling a window of items. See Input and focus.wh.register(Component, {keyGuide}): the key guide bar inside the tile is now off by default.trueshows the loader's hints.- An object changes or adds labels.
- A function chooses the hints itself.
Install
Payload Manager (custom source):
- Open Payload Manager, then Settings (gear icon) > Manage Sources.
- Choose Add Source, paste
https://raw.githubusercontent.com/geodox/ps5-wh-widgets/main/repo.json, and press Add. - Install or update Welcome Hub Bridge (source "Welcome Hub").
Manual: send wh_bridge.elf with your payload loader.
Then sign out and back in. To update a widget, unzip it into /data/wh-widgets/.
Supported firmware: 13.20, 13.40, 13.60.
26.11.19beta
26.11.19 beta
Firmware
- 13.40 is supported. The payload now works on 13.20, 13.40 and 13.60, verified on a console running each. Thanks to @pm5krj for the 13.40 hub dump and for testing it.
New widget
- Weather. Current weather and a forecast for the places you save, anywhere in the world. Search by city or postal code on the full-screen page; place names come in the console's language. Switch places with L1 / R1. The tile shows the place's local time, using the console's 12/24-hour setting, and a background photo for the current weather. LARGE adds a 5-day forecast; FULL adds humidity, wind, rain chance and the next 6 hours. Options set temperature and wind units (or follow the console's region) and turn the photos off. Ported from VintendoPower's Weather widget; data from Open-Meteo, no account needed.
Fixes
- Home Assistant no longer freezes the hub when the server is off. Opening a connection to a server that doesn't answer froze all input for about a minute and could crash the console's home screen. The widget now checks the server first and shows "Can't reach …, retrying" within 6 seconds. Download the new
home-assistant.zipand keep yourconfig.json. - Widgets start with their saved settings. A widget with settings briefly showed its defaults before switching to your saved values. It now waits for your settings, at most 1.5 seconds.
For widget makers
- Images removed while they are still loading can crash the console's home screen about 15 seconds later. Draw no images in edit mode, where the hub remounts tiles, and don't empty and refill a tile that shows images. See Glyphs and images in the SDK docs.
- Never open a
WebSocketto a server that may not answer: it blocks the hub for about 75 seconds. Check the server withfetchfirst. See the API reference.
Credits
- VintendoPower joins as co-author.
- @pm5krj: FW 13.40 hub dump and testing.
Install
- Payload Manager. Add
https://raw.githubusercontent.com/geodox/ps5-wh-widgets/main/repo.jsonas a custom source (Settings > Manage Sources > Add Source), then install or update Welcome Hub Bridge. - Manual. Send
wh_bridge.elfwith your payload loader.
Unzip the widgets you want into /data/wh-widgets/, then sign out and back in.
26.11.18beta
26.11.18 beta
New widgets
- Console Stats. Shows CPU and SoC temperature, fan speed, free space, and uptime, and warns when the console reports a thermal alert. At the larger sizes it adds a usage bar for each drive (console storage, M.2, USB). Options switch between °C and °F and set the refresh rate.
- Home Assistant. Shows and controls your Home Assistant entities with live state: lights, switches, sensors, climate, covers, locks, media players and more. Press X on an entity to toggle or run it. The full-screen page adds brightness, speed, position and volume sliders, target temperature and mode for climate, and an entity chooser with search. Unlocking a lock or opening a garage door asks first. It needs your server's address and an access token in its
config.json; see its README for setup.
New for widget developers
- Full-screen pages. Register a page with
wh.registerPage(Page)and open it withprops.openPage(params). It slides in over the hub like the stock Settings screen, and Circle closes it.docs/sdk/pages.mdalso lists the stock page layout to copy. - Lists.
wh.Listis the console's own scrolling list, the one Settings uses. Fill it withwh.MenuListItemPSrows (button, switch, dropdown, selectable) to build a Settings-style page. - Text input. Pages can use
wh.TextInput. Pressing X on the field opens the system keyboard, and the page gets the text as you type and when you press Done. - Hub state.
props.hubVisibleis false while a page, Settings or the screensaver covers the tiles. Use it to pause polling.props.hubFocusedis false while the user is on the game row, or the Control Center or keyboard is open.- Pages can read the same state with
wh.useHubState().
- Locale.
wh.useLocale()returns the console's language, 12/24-hour setting and date format. It updates when the setting changes. - Sounds.
wh.playSound(name)plays stock UI sounds:enter,back,error,switchOn, dialog and toast sounds, and more. - Storage.
props.storage.get / set / removekeeps small values per widget. They're stored per user and survive reboots, even without the payload. - Notifications.
wh.notify(text)shows a system notification. - Dialogs.
wh.AlertDialogPSis the stock alert dialog, with a title, positive and negative buttons, and Circle to dismiss. - MINI widgets can hide themselves. Call
props.setVisible(false)while there's nothing to show, or add"visible": falseinconfig.jsonto start hidden. A hidden MINI takes no space and can't be focused. - Settings use the stock options menu. Pressing Options on a widget with settings opens the same menu the stock widgets use.
- Stock icon ids.
docs/sdk/icons.mdlists the 1089iconIds the console accepts.wh.IconPS.iconIdslets a widget check an id at runtime. - Launching games.
wh.launch('psgm:play?id=<titleId>')starts a game, andpsgamehub:main?titleId=<titleId>opens its game hub.
Improvements
- Custom placements survive a boot without the payload. Booting without the payload, then saving the layout, used to drop your custom tiles for good. The payload now keeps a backup of your layout and puts the tiles back the next time it loads.
- Privacy. Custom widget ids are no longer included in the hub's startup telemetry.
- Stock look. Tiles use the hub's own background, the same as the stock tiles. The sample widgets no longer draw a second one.
- Smaller bridge patch. The bridge now patches 8 hub functions instead of 12, which makes new firmware easier to support.
Samples
- Hello Hub has a settings menu: clock format, which follows the console's 12/24-hour setting by default, and seconds. Its "Full screen" chip opens a large clock page.
- Payload Monitor and Payload Launcher pause polling while the tiles are covered.
Notes
- Tested on FW 13.20. FW 13.60 is supported, but these features haven't been tested on it yet.
- Install through Payload Manager with the custom source
https://raw.githubusercontent.com/geodox/ps5-wh-widgets/main/repo.json, or manually. See the README.
26.11.17 beta
26.11.17 beta
Highlights
- FW 13.60 support (#2). The payload now carries a bridge for each supported firmware and picks the right one at install. Verified on 13.20 and 13.60. On any other firmware it shows
WHBridge failed: FW x.yy not supported yetand installs nothing, instead of failing silently. - MINI widgets. Set
"size": 0inconfig.jsonto put a widget in the hub's MINI row (Temporary Widgets), next to stock tiles like PS Plus. The row follows Welcome Hub Settings > Temporary Widgets Position (above or below the tiles). MINI tiles shrink to fit their content like the stock ones. Sizes0.1and0.2grow to that size when focused. wh.launch(uri). Widgets can now ask the console to launch a URI, for examplehttp://127.0.0.1:<port>/to open a page in the console's browser. Launches are limited to 6 per minute. Users should only install widgets they trust.- Install from Payload Manager. Add
https://raw.githubusercontent.com/geodox/ps5-wh-widgets/main/repo.jsonas a custom source (Settings > Manage Sources > Add Source), then install Welcome Hub Bridge.
New sample widgets
- Payload Launcher lists the payload web pages running on the console: Payload Manager, PKG Manager, PS5Upload, ShadowMount+, Welcome Hub Activator and others. Press X on one to open it in the console's browser.
- Hello Mini is a reference MINI widget: an icon and a live clock in the MINI row.
- XL size: widgets can be double-wide (
6, 1032 × 504).
Improvements
- Live widget updates: the payload notices
config.jsonandwidget.jschanges within seconds and rebuilds its loader in place, with no payload reinstall and no shell restart. Sign out and back in to see the changes in the hub. - Clearer support status: the README and docs now list supported firmware, and there's a guide for adding a new one.
- Project layout: samples moved to
sample-widgets/. New developer tools:whctlto deploy widgets, install the payload and read logs.wh_kill, a recovery tool for a stuck shell.scripts/dump_hub.py, to dump the hub so new firmware can be supported.
Notes
- After installing, sign out and back in once to load the new build.
- MINI widgets have been tested on 13.20 only.
- Want your firmware supported? Run
scripts/dump_hub.pyand share the dump privately, as described in the README. Hub dumps are Sony code, so please don't post them publicly.
26.11.13beta
26.11.12beta
PS5 Welcome Hub Widgets 26.11.12 beta
- pass all config.json fields to props.config; "settings" schema -> props.settings
- settings menu (stock OptionsMenuPS) + key-guide hints; persist to .settings.json
- render widgets through hub frame (module 106) + header (77)
- wh.Button/onPressed/Focusable; X enters tile, arrows navigate, Circle exits
- ship bridge as a delta rebuilt in ShellUI: 3.77MB -> 557KB
- payload-manager repo
- payload-monitor improvements
- hello-hub rebuilt with new features
Known issues:
- Resizing XL tile produces unexpected behavior
26.11.11beta
Beta release.
Tested on 13.20, use at your own risk.
Drop widgets into /data/wh-widgets/