Skip to content

Instantly share code, notes, and snippets.

@ChristophObermeier
Last active November 11, 2022 17:06
Show Gist options
  • Save ChristophObermeier/02774af9774f6967393ef29e2b91e794 to your computer and use it in GitHub Desktop.
Save ChristophObermeier/02774af9774f6967393ef29e2b91e794 to your computer and use it in GitHub Desktop.
iOS Scriptable Widget for current Air Quality / Pollution in your city (nearest station) #stayhealthy #enjoyfreshair #stopcancer.
// ***Air Quality Widget***
//
// Copyright (C) 2020 by ChristophObermeier
//
// Permission to use, copy, modify, and/or distribute this software is hereby granted.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
// IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
// OF THIS SOFTWARE.
//
// Variables used by Scriptable.
// These must be at the very top of the file. Do not edit.
// icon-color: deep-green; icon-glyph: cloud;
// * Script for scriptable to get the current Air Polution of your city
//Thank you World Air Quality Index Project for gathering all the data!
//By the use you agree to the Terms of Service of the Air Quality Open Data Platform: https://aqicn.org/api/tos/
//Get your own API-KEY here: https://aqicn.org/data-platform/token/#/
const apiKey = "19b71483eb9ddd3831a5e83312cd860fb00fa03d";
var today = new Date();
// Set up the file manager local or iCloud.
const files = FileManager.local()
// Set up the location logic.
const locationPath = files.joinPath(files.documentsDirectory(), "aqi1_location")
//Define Location
var latitude, longitude
const LocationCacheExists = files.fileExists(locationPath)
const LocationCacheDate = LocationCacheExists ? files.modificationDate(locationPath) : 0
try {
// If cache exists and it’s been less than 60 minutes since last request, use cached data.
if (LocationCacheExists && (today.getTime() - LocationCacheDate.getTime()) < (60 * 60 * 1000))
{
console.log("Get your location from the Cache")
const locationStr = files.readString(locationPath).split(",")
latitude = locationStr[0]
longitude = locationStr[1]
} else {
Location.setAccuracyToHundredMeters()
const location = await Location.current()
console.log("Get Your Location")
latitude = location.latitude.toFixed(3)
longitude = location.longitude.toFixed(3)
files.writeString(locationPath, latitude + "," + longitude)
}
} catch (e) {
console.log(e)
const locationStr = files.readString(locationPath).split(",")
latitude = locationStr[0]
longitude = locationStr[1]
}
//Get AQI for location
const aqiReq = "https://api.waqi.info/feed/geo:" + latitude + ";" + longitude + "/?token=" + apiKey;
response = await new Request(aqiReq).loadJSON();
//files.writeString(cachePath, JSON.stringify(response));
// Store the Aqi values.
const name = response.data.city.name.toUpperCase();
const aqi = response.data.aqi.toString();
const date = response.data.time.s;
// AQI Logo
const logoImg = await getImage('AQI-logo.png');
//AQI Scale and Color Legend
const url = "https://aqicn.org/scale/"
let widget = createWidget(name, aqi, date, url);
if (config.runsInWidget) {
// The script runs inside a widget, so we pass our instance of ListWidget to be shown inside the widget on the Home Screen.
Safari.open(url)
Script.setWidget(widget)
} else {
// The script runs inside the app, so we preview the widget.
widget.presentSmall()
Safari.open(url)
}
function createWidget(name, aqi, date) {
let widget = new ListWidget()
let title = widget.addText("πŸ“"+name);
title.font = Font.boldSystemFont(12);
title.centerAlignText();
title.minimumScaleFactor = 0.5;
title.lineLimit = 2;
widget.addSpacer();
let row = widget.addStack();
row.layoutHorizontally();
row.addSpacer(12);
const aqiLogo = row.addImage(logoImg);
aqiLogo.imageSize = new Size(12, 12);
row.addSpacer(5)
let aqiTitle = row.addText("Air Quality Index");
aqiTitle.font = Font.regularSystemFont(10);
aqiTitle.textColor = Color.black();
aqiTitle.centerAlignText();
aqiTitle.minimumScaleFactor = 0.5;
//Air Quality Levels
let aqiText = widget.addText(aqi);
aqiText.font = Font.boldSystemFont(40);
aqiText.centerAlignText();
aqiText.minimumScaleFactor = 1;
if (aqi >= 300) {
aqiText.textColor = Color.white();
widget.backgroundColor = new Color("#7e0023");
let aqiText1 = widget.addText("HAZARDOUS:😷🏠");
aqiText1.font = Font.boldSystemFont(10);
aqiText1.textColor = Color.white();
aqiText1.centerAlignText();
aqiText1.minimumScaleFactor = 1;
} else if (aqi >= 201) {
aqiText.textColor = Color.white();
widget.backgroundColor = new Color("#660099");
let aqiText1 = widget.addText("VERY UNHEALTHY:πŸ‘΅πŸ½πŸ‘ΆπŸΌ@🏠");
aqiText1.font = Font.boldSystemFont(8);
aqiText1.textColor = Color.white();
aqiText1.centerAlignText();
aqiText1.minimumScaleFactor = 0.7;
} else if (aqi >= 151) {
aqiText.textColor = Color.white();
widget.backgroundColor = new Color("#cc0033");
let aqiText1 = widget.addText("UNHEALTHY:⏱–>🏠");
aqiText1.font = Font.boldSystemFont(10);
aqiText1.textColor = Color.white();
aqiText1.centerAlignText();
aqiText1.minimumScaleFactor = 0.8;
} else if (aqi >= 101) {
aqiText.textColor = Color.white();
widget.backgroundColor = new Color("#ff9933");
let aqiText1 = widget.addText("☠️ sensitive groups–>🏠");
aqiText1.font = Font.boldSystemFont(10);
aqiText1.textColor = Color.white();
aqiText1.centerAlignText();
aqiText1.minimumScaleFactor = 0.7;
} else if (aqi >= 51) {
aqiText.textColor = Color.white();
widget.backgroundColor = new Color("#ffde33");
let aqiText1 = widget.addText("MODERATE:πŸ‘ΆπŸ€§πŸ”œπŸ ");
aqiText1.font = Font.boldSystemFont(10);
aqiText1.textColor = Color.white();
aqiText1.centerAlignText();
aqiText1.minimumScaleFactor = 0.7;
} else if (aqi >= 0) {
aqiText.textColor = Color.white();
widget.backgroundColor = new Color("#009966");
let aqiText1 = widget.addText("GOOD:πŸ•πŸšΆπŸ»πŸƒπŸ½β€β™€οΈπŸš΄πŸ»β€β™€οΈ");
aqiText1.font = Font.boldSystemFont(10);
aqiText1.textColor = Color.white();
aqiText1.centerAlignText();
} else {
aqiText.textColor = Color.red();
widget.backgroundColor = Color.white();
}
//Last Update of Data
let dateText = widget.addText(date + " (loc. time)");
dateText.font = Font.regularSystemFont(6);
dateText.centerAlignText();
dateText.minimumScaleFactor = 0.3;
widget.addSpacer();
//Thx World Air Quality Project
let Text = widget.addText("πŸ™πŸ½World Air Quality Project");
Text.font = Font.boldSystemFont(5);
Text.textColor = Color.black();
Text.centerAlignText();
Text.minimumScaleFactor = 0.4;
return widget;
}
// Get and save Logo
async function getImage(logo) {
let fm = FileManager.local()
let dir = fm.documentsDirectory()
let path = fm.joinPath(dir, logo)
if (fm.fileExists(path)) {
return fm.readImage(path)
} else {
// download once
let imageUrl
switch (logo) {
case 'AQI-logo.png':
imageUrl = "https://waqi.info/icons/logo.png";
break
default:
console.log(`Sorry, couldn't find ${logo}.`);
break
}
let iconImage = await loadImage(imageUrl)
fm.writeImage(path, iconImage)
return iconImage
}
}
// helps to download an image from a given url
async function loadImage(imgUrl) {
console.log('loadImage')
const req = new Request(imgUrl)
return await req.loadImage()
}
// Calling Script.complete() signals to Scriptable that the script have finished running.
// This can speed up the execution, in particular when running the script from Shortcuts or using Siri.
Script.complete();
@yangloft
Copy link

yangloft commented Jan 7, 2021

Thank you!

@sfksuperman
Copy link

Can you please provide an alternative way to fetch latitude and longitude? Because in my case, It's not picking my near area rather it's picking like 100kms away from my area which is not good.

Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment