Display your Sense usage plot in a Scriptable Widget! (iOS 14+)
Sense-Scriptable is a script for the Scriptable app that generates a medium-sized widget for use on your iOS homescreen, and displays your energy usage as reported by Sense for the prior hour/day/week/month/year.
Sense-Scriptable uses the unofficial Sense API to pull power usage data, and will be updated automatically by iOS (when the widget is refreshed). Both a light mode and a dark mode style are provided, although unfortunately Scriptable/iOS doesn't support switching automatically at this time.
-
First, install the Scriptable app if you don't have it already!
-
In Scriptable, add a new (empty) script in Scriptable by tapping the "plus" icon:
-
Copy the contents of Sense Widget.js into the new, empty script.
-
At the top of the script, configure it to your liking - select range of data you'd like to display (
HOUR,DAY,WEEK,MONTH,YEAR), and whether or not to use dark mode style (trueorfalse). As an alternative to hard coding the range here, you can provide it in the iOS widget configuration instead - see Step 10! -
Feel free to customize the script details, like the name and icon - I use "Sense Widget" with a lightning bolt icon, naturally.
-
Run the script from the Scriptable app at least once, by tapping the "play" button. You will be requested to provide your Sense login info - this is only required intially (or if you change your password, or the authorization tokens rotate). Please be sure to see the note on security below, regarding the use of your login info!
-
Tap Done to save the script.
-
On your iOS home screen, enter jiggle mode and tap the "plus" icon in the top left to add a widget.
-
Search for Scriptable, and add a "medium" widget (a 2x1 size):
-
If still in jiggle mode, tap on the new widget to configure it, or long press on it and select "Edit Widget".
-
Select "Sense Widget" (or whatever you named it) as the script to run for the widget. I recommend setting the When Interfacing option to "Open URL", and enter
sense://in the URL field (this will open Sense when you tap on the widget). You can also provide the desired plot range (HOUR,DAY,WEEK,MONTH,YEAR) in the Parameter field. This lets you easily change it without editing the script itself.
-
Complete! Enjoy Sense on your homescreen.
- SECURITY: Your Sense login is not stored by the script, and is only sent to the Sense API initially. Upon a successful login, only the authorization token is stored on your device in the iOS Keychain, and this token is used for future API requests. The token can't let someone log into your account via normal means, but could be maliciously used for API commands to your account. While the risk is low, be wary of other Scriptable scripts you install as all scripts get access to the same Keychain and file directory (including the contents of other scripts) so it is difficult to store sensitive information in Scriptable as of today.
- The API method used doesn't typically grab the most up-to-date usage data. For example, when using an
HOURrange the most recent ~15 minutes can be missing. Presumably that's because this data is filled in by the Websockets part of the API, which isn't supported in Scriptable. To account for this, an extra 15 minutes is requested when using theHOURrange. iOS doesn't update widgets all that frequently anyway!
Scriptable also lets a script export certain data when run from the iOS Shortcuts app. Sense-Scriptable exports the retreived, reduced plot data points, start time, and end time when run as part of a Shortcut. This helps with the data reduction - from experience, I can say that Shortcuts doesn't love directly manipulating JSON with 3,000+ data points.
- Time-scheduled light/dark mode switching, as an alternative to switching in sync with the device.
- Verify average of provided totals is the correct value to use.
- Add support for solar production - going to need some help here on what data the API provides!