When i run my iTerm script from a shortcut, the execution completes, but the widget is not updated
I’m a little confused.
iTerm is a Mac terminal app. Is the script you are triggering a shell script or an AppleScript to control iterm? It may also be useful to confirm if you are running iTerm or iTerm 2.
This post is flagged as Scriptable and refers to a widget. Can you explain more about how this relates to iTerm and confirm what device you are running this from?
Sharing any script you are having issues with is usually very helpful. Remember to place code between triple back ticks so that the forum does not change any of the characters and formatting.
Widgets update on their own cycle, managed by the OS. Is your widget not updating immediately or ever?
1 Like
My bad, I’ll specify. I am refering to the iTermWidget script that i found in the gallery of Scriptable. After a few modifications, it now looks like this.
class Cache {
constructor(name) {
this.fm = FileManager.iCloud();
this.cachePath = this.fm.joinPath(this.fm.documentsDirectory(), name);
if (!this.fm.fileExists(this.cachePath)) {
this.fm.createDirectory(this.cachePath);
}
}
async read(key, expirationMinutes) {
try {
const path = this.fm.joinPath(this.cachePath, key);
await this.fm.downloadFileFromiCloud(path);
const createdAt = this.fm.creationDate(path);
if (expirationMinutes) {
if ((new Date()) - createdAt > (expirationMinutes * 60000)) {
this.fm.remove(path);
return null;
}
}
const value = this.fm.readString(path);
try {
return JSON.parse(value);
} catch (error) {
return value;
}
} catch (error) {
return null;
}
}
write(key, value) {
const path = this.fm.joinPath(this.cachePath, key.replace('/', '-'));
console.log(`Caching to ${path}...`);
if (typeof value === 'string' || value instanceof String) {
this.fm.writeString(path, value);
} else {
this.fm.writeString(path, JSON.stringify(value));
}
}
}
/******************************************************************************
* Constants and Configurations
*****************************************************************************/
// Cache keys and default location
const CACHE_KEY_LAST_UPDATED = 'last_updated';
const CACHE_KEY_LOCATION = 'location';
const DEFAULT_LOCATION = { latitude: 0, longitude: 0 };
// Font name and size
const FONT_NAME = 'Menlo';
const FONT_SIZE = 10;
// Colors
const COLORS = {
bg0: '#29323c',
bg1: '#1c1c1c',
personalCalendar: '#5BD2F0',
workCalendar: '#9D90FF',
weather: '#FDFD97',
location: '#FEB144',
period: '#FF6663',
deviceStats: '#7AE7B9',
};
// TODO: PLEASE SET THESE VALUES
const NAME = 'Nikolai';
const WEATHER_API_KEY = 'weatherAPI';
const WORK_CALENDAR_NAME = 'work';
const PERSONAL_CALENDAR_NAME = 'personal';
/******************************************************************************
* Initial Setups
*****************************************************************************/
/**
* Convenience function to add days to a Date.
*
* @param {*} days The number of days to add
*/
Date.prototype.addDays = function(days) {
var date = new Date(this.valueOf());
date.setDate(date.getDate() + days);
return date;
};
// Import and setup Cache
const cache = new Cache('terminalWidget');
// Fetch data and create widget
const data = await fetchData();
const widget = createWidget(data);
Script.setWidget(widget);
Script.complete();
/******************************************************************************
* Main Functions (Widget and Data-Fetching)
*****************************************************************************/
/**
* Main widget function.
*
* @param {} data The data for the widget to display
*/
function createWidget(data) {
console.log(`Creating widget with data: ${JSON.stringify(data)}`);
const widget = new ListWidget();
const bgColor = new LinearGradient();
bgColor.colors = [new Color(COLORS.bg0), new Color(COLORS.bg1)];
bgColor.locations = [0.0, 1.0];
widget.backgroundGradient = bgColor;
widget.setPadding(10, 15, 15, 10);
const stack = widget.addStack();
stack.layoutVertically();
stack.spacing = 4;
stack.size = new Size(320, 0);
// Line 0 - Last Login
const timeFormatter = new DateFormatter();
timeFormatter.locale = "no";
timeFormatter.useNoDateStyle();
timeFormatter.useShortTimeStyle();
const lastLoginLine = stack.addText(`Last login: ${timeFormatter.string(new Date())} on ttys001`);
lastLoginLine.textColor = Color.white();
lastLoginLine.textOpacity = 0.7;
lastLoginLine.font = new Font(FONT_NAME, FONT_SIZE);
// Line 1 - Input
const inputLine = stack.addText(`iPad:~ ${NAME}$ info`);
inputLine.textColor = Color.white();
inputLine.font = new Font(FONT_NAME, FONT_SIZE);
// Line 2 - Next Personal Calendar Event
const nextPersonalCalendarEventLine = stack.addText(`🗓 | ${getCalendarEventTitle(data.nextPersonalEvent, false)}`);
nextPersonalCalendarEventLine.textColor = new Color(COLORS.personalCalendar);
nextPersonalCalendarEventLine.font = new Font(FONT_NAME, FONT_SIZE);
// Line 3 - Next Work Calendar Event
const nextWorkCalendarEventLine = stack.addText(`🗓 | ${getCalendarEventTitle(data.nextWorkEvent, true)}`);
nextWorkCalendarEventLine.textColor = new Color(COLORS.workCalendar);
nextWorkCalendarEventLine.font = new Font(FONT_NAME, FONT_SIZE);
// Line 4 - Weather
const weatherLine = stack.addText(`${data.weather.icon} | ${data.weather.temperature}° (${data.weather.high}°-${data.weather.low}°), ${data.weather.description}, feels like ${data.weather.feelsLike}°`);
weatherLine.textColor = new Color(COLORS.weather);
weatherLine.font = new Font(FONT_NAME, FONT_SIZE);
// Line 5 - Location
const locationLine = stack.addText(`📍 | ${data.weather.location}`);
locationLine.textColor = new Color(COLORS.location);
locationLine.font = new Font(FONT_NAME, FONT_SIZE);
// Line 7 - Various Device Stats
const deviceStatsLine = stack.addText(`📊 | ⚡︎ ${data.device.battery}%, ☀ ${data.device.brightness}%`);
deviceStatsLine.textColor = new Color(COLORS.deviceStats);
deviceStatsLine.font = new Font(FONT_NAME, FONT_SIZE);
return widget;
}
/**
* Fetch pieces of data for the widget.
*/
async function fetchData() {
// Get the weather data
const weather = await fetchWeather();
// Get next work/personal calendar events
const nextWorkEvent = await fetchNextCalendarEvent(WORK_CALENDAR_NAME);
const nextPersonalEvent = await fetchNextCalendarEvent(PERSONAL_CALENDAR_NAME);
// Get last data update time (and set)
const lastUpdated = await getLastUpdated();
cache.write(CACHE_KEY_LAST_UPDATED, new Date().getTime());
return {
weather,
nextWorkEvent,
nextPersonalEvent,
device: {
battery: Math.round(Device.batteryLevel() * 100),
brightness: Math.round(Device.screenBrightness() * 100),
},
lastUpdated,
};
}
/******************************************************************************
* Helper Functions
*****************************************************************************/
//-------------------------------------
// Weather Helper Functions
//-------------------------------------
/**
* Fetch the weather data from Open Weather Map
*/
async function fetchWeather() {
let location = await cache.read(CACHE_KEY_LOCATION);
if (!location) {
try {
Location.setAccuracyToThreeKilometers();
location = await Location.current();
} catch(error) {
location = await cache.read(CACHE_KEY_LOCATION);
}
}
if (!location) {
location = DEFAULT_LOCATION;
}
const url = "https://api.openweathermap.org/data/2.5/onecall?lat=" + location.latitude + "&lon=" + location.longitude + "&exclude=minutely,hourly,alerts&units=imperial&lang=en&appid=" + WEATHER_API_KEY;
const address = await Location.reverseGeocode(location.latitude, location.longitude);
const data = await fetchJson(`weather_${address[0].locality}`, url);
const currentTime = new Date().getTime() / 1000;
const isNight = currentTime >= data.current.sunset || currentTime <= data.current.sunrise
return {
location: `${address[0].postalAddress.city}, ${address[0].postalAddress.state}`,
icon: getWeatherEmoji(data.current.weather[0].id, isNight),
description: data.current.weather[0].main,
temperature: Math.round((data.current.temp-32)/1.8),
wind: Math.round(data.current.wind_speed),
high: Math.round((data.daily[0].temp.max-32)/1.8),
low: Math.round((data.daily[0].temp.min-32)/1.8),
feelsLike: Math.round((data.current.feels_like-32)/1.8),
}
}
/**
* Given a weather code from Open Weather Map, determine the best emoji to show.
*
* @param {*} code Weather code from Open Weather Map
* @param {*} isNight Is `true` if it is after sunset and before sunrise
*/
function getWeatherEmoji(code, isNight) {
if (code >= 200 && code < 300 || code == 960 || code == 961) {
return "⛈"
} else if ((code >= 300 && code < 600) || code == 701) {
return "🌧"
} else if (code >= 600 && code < 700) {
return "❄️"
} else if (code == 711) {
return "🔥"
} else if (code == 800) {
return isNight ? "🌕" : "☀️"
} else if (code == 801) {
return isNight ? "☁️" : "🌤"
} else if (code == 802) {
return isNight ? "☁️" : "⛅️"
} else if (code == 803) {
return isNight ? "☁️" : "🌥"
} else if (code == 804) {
return "☁️"
} else if (code == 900 || code == 962 || code == 781) {
return "🌪"
} else if (code >= 700 && code < 800) {
return "🌫"
} else if (code == 903) {
return "🥶"
} else if (code == 904) {
return "🥵"
} else if (code == 905 || code == 957) {
return "💨"
} else if (code == 906 || code == 958 || code == 959) {
return "🧊"
} else {
return "❓"
}
}
//-------------------------------------
// Calendar Helper Functions
//-------------------------------------
/**
* Fetch the next calendar event from the given calendar
*
* @param {*} calendarName The calendar to get events from
*/
async function fetchNextCalendarEvent(calendarName) {
const calendar = await Calendar.forEventsByTitle(calendarName);
const events = await CalendarEvent.today([calendar]);
const tomorrow = await CalendarEvent.tomorrow([calendar]);
console.log(`Got ${events.length} events for ${calendarName}`);
console.log(`Got ${tomorrow.length} events for ${calendarName} tomorrow`);
const upcomingEvents = events.concat(tomorrow).filter(e => (new Date(e.endDate)).getTime() >= (new Date()).getTime());
return upcomingEvents ? upcomingEvents[0] : null;
}
/**
* Given a calendar event, return the display text with title and time.
*
* @param {*} calendarEvent The calendar event
* @param {*} isWorkEvent Is this a work event?
*/
function getCalendarEventTitle(calendarEvent, isWorkEvent) {
if (!calendarEvent) {
return `No upcoming ${isWorkEvent ? 'work ' : ''}events`;
}
const timeFormatter = new DateFormatter();
timeFormatter.locale = 'en';
timeFormatter.useNoDateStyle();
timeFormatter.useShortTimeStyle();
const eventTime = new Date(calendarEvent.startDate);
return `[${timeFormatter.string(eventTime)}] ${calendarEvent.title}`;
}
//-------------------------------------
// Misc. Helper Functions
//-------------------------------------
/**
* Make a REST request and return the response
*
* @param {*} key Cache key
* @param {*} url URL to make the request to
* @param {*} headers Headers for the request
*/
async function fetchJson(key, url, headers) {
const cached = await cache.read(key, 5);
if (cached) {
return cached;
}
try {
console.log(`Fetching url: ${url}`);
const req = new Request(url);
req.headers = headers;
const resp = await req.loadJSON();
cache.write(key, resp);
return resp;
} catch (error) {
try {
return cache.read(key, 5);
} catch (error) {
console.log(`Couldn't fetch ${url}`);
}
}
}
/**
* Get the last updated timestamp from the Cache.
*/
async function getLastUpdated() {
let cachedLastUpdated = await cache.read(CACHE_KEY_LAST_UPDATED);
if (!cachedLastUpdated) {
cachedLastUpdated = new Date().getTime();
cache.write(CACHE_KEY_LAST_UPDATED, cachedLastUpdated);
}
return cachedLastUpdated;
}
This script makes a widget that i can use on the home screen of my iPad/iPhone. Currently I need to run the script in the app to update the information on the widget. I did notice that it updated overnight, given a longer period of time, but it would be nice to run the script through shortcuts, to ensure that the widget is updated i.e 8AM every day.
However, I have yet to make this work. There is an action in shortcuts called “Run iTermWidget Script” but running this does nothing unless i check “Run in app”, which is not what I want. I want widget to update without any confirmation from me or the need to enter Scriptable and then exit back to where i were.
Any thoughts on why widget is not updating when running the “run script” action from shortcuts?
Okay, seeing the code and having the extra information certainly helps.
Assuming you have just cleaned the script to remove your weather API key (a good thing, but would stop you getting weather data updates), one thing I can see that might explain some delays is the caching the script has built into it. The fetchJson() function looks to be explicitly working with some caching functions to say if there has been an update in the last 5 hours, just get the previously cached JSON data.
Does that happen to fit with what you are seeing?
If so try amending the numeric value in this line:
return cache.read(key, 5);
For example, just for testing purposes, try setting it to 0.1. That should cause the cache to lapse every 6 minutes rather than every 5 hours. Then increase it from there to a more reasonable frequency.
The action in Shortcuts to “Run iTermWidget Script” may just be a Siri suggestion, or you are selecting it as a Run Script parameter. In either case, for a lot of Scriptable interactions (probably widget creation being one of them), Shortcuts needs to hand over full foreground processing to the Scriptable app. That isn’t an ideal approach to updating data for a widget.