Skip to content

Instantly share code, notes, and snippets.

@mountbatt
Last active February 21, 2025 08:28
Show Gist options
  • Save mountbatt/772e4512089802a2aa2622058dd1ded7 to your computer and use it in GitHub Desktop.
Save mountbatt/772e4512089802a2aa2622058dd1ded7 to your computer and use it in GitHub Desktop.
Scriptable iOS widget that displays the status of your Renault ZOE (or Megane, Dacia Spring) on your iPhone and iPad.
// Variables used by Scriptable.
// These must be at the very top of the file. Do not edit.
// icon-color: light-gray; icon-glyph: car;
// version 2024-04-19
// latest changes:
// new kameron api key
// added language strings so you can translate it by yourself!
// add your my-renault account data:
// let myRenaultUser = "user" // email
// let myRenaultPass = "pass" // password
let myRenaultUser = "your_email" // email
let myRenaultPass = "your_password" // password
// set your ZOE Model (Phase 1 or 2) // bitte eingeben!
let ZOE_Phase = "2" // "1" or "2"
// set your battery size in kWh // bitte eingeben!
let ZOE_Battery = "52" // "52" or "41" or "22" or "21"
// should we use apple-maps or google maps?
let mapProvider = "apple" // "apple" or "google"
// optional:
// change that number to eg. 2 if you want to select an another car from your account.
// 1 is the first car, 2 will be the second.
let carNumber = 1;
// optional
// account number
// if you have problems with accessing the data, try to change this number from 0 to 1
let accountNumber = 0;
// enter your VIN / FIN if you have any problems
// leave it empty if everything works // leer lassen, wenn alles läuft
let VIN = "" // starts with VF1... enter like this: "VF1XXXXXXXXX"
// Language Strings
// GERMAN / DEUTSCH
let text_ladestand = "Ladestand"
let text_reichweite = "Reichweite"
let text_restenergie = "Restenergie"
let text_kilometerstand = "Kilometerstand"
let text_position = "Position"
let text_klimatisierung = "Klimatisierung"
let text_karte_oeffnen = "➤ Karte öffnen"
let text_starten = "➤ Starten"
let text_stoppen = "➤ Stoppen"
let text_wird_geladen = "⚡ Wird geladen …"
let text_gekoppelt = "🟢 Gekoppelt"
let text_entkoppelt = "⚫ Entkoppelt"
let text_laden_starten = "➤ Laden starten"
let text_akkutemp = "Akkutemp."
/*
// ENGLISH
let text_ladestand = "Charge level"
let text_reichweite = "Range"
let text_restenergie = "Remaining energy"
let text_kilometerstand = "Mileage"
let text_position = "Position"
let text_klimatisierung = "Climate control"
let text_karte_oeffnen = "➤ Open map"
let text_starten = "➤ Start"
let text_stoppen = "➤ Stop"
let text_wird_geladen = "⚡ Charging..."
let text_gekoppelt = "🟢 Connected"
let text_entkoppelt = "⚫ Disconnected"
let text_laden_starten = "➤ Start charging"
let text_akkutemp = "Battery temp."
*/
/*
// FRENCH:
let text_ladestand = "Niveau de charge"
let text_reichweite = "Autonomie"
let text_restenergie = "Énergie restante"
let text_kilometerstand = "Kilométrage"
let text_position = "Position"
let text_klimatisierung = "Climatisation"
let text_karte_oeffnen = "➤ Ouvrir la carte"
let text_starten = "➤ Démarrer"
let text_stoppen = "➤ Arrêter"
let text_wird_geladen = "⚡ En charge ..."
let text_gekoppelt = "🟢 Connecté"
let text_entkoppelt = "⚫ Déconnecté"
let text_laden_starten = "➤ Démarrer la charge"
let text_akkutemp = "Temp. de la batterie"
*/
// do not edit
let kamareonURL = "https://api-wired-prod-1-euw1.wrd-aws.com"
let kamareonAPI = "YjkKtHmGfaceeuExUDKGxrLZGGvtVS0J"
let gigyaURL = "https://accounts.eu1.gigya.com"
let gigyaAPI = "3_7PLksOyBRkHv126x5WhHb-5pqC1qFR8pQjxSeLB6nhAnPERTUlwnYoznHSxwX668" // austria: "3__B4KghyeUb0GlpU62ZXKrjSfb7CPzwBS368wioftJUL5qXE0Z_sSy0rX69klXuHy"
const timenow = new Date().toJSON().slice(0, 13).replace(/-/g, '').replace(/T/g, '-') //20201028-14 (14 = hour)
// clear everything from keychain if we are on an other day
if (Keychain.contains('lastJWTCall') && Keychain.get('lastJWTCall') != timenow) {
clearKeychain()
//console.log("Keychain cleared")
}
// clear keychain, if script gets called with action parameters (to get new tokens)
if (args.queryParameters.action != "") {
clearKeychain()
//console.log("Keychain cleared cause of action parameters")
}
function clearKeychain() {
if (Keychain.contains('VIN')) { Keychain.remove('VIN') }
if (Keychain.contains('carPicture')) { Keychain.remove('carPicture') } // enable if picture is wrong
if (Keychain.contains('account_id')) { Keychain.remove('account_id') }
if (Keychain.contains('gigyaJWTToken')) { Keychain.remove('gigyaJWTToken') }
if (Keychain.contains('gigyaCookieValue')) { Keychain.remove('gigyaCookieValue') }
if (Keychain.contains('gigyaPersonID')) { Keychain.remove('gigyaPersonID') }
}
if (VIN && VIN != "") {
Keychain.set('VIN', VIN)
}
const widget = new ListWidget()
await createWidget()
// used for debugging if script runs inside the app
if (!config.runsInWidget) {
await widget.presentMedium()
}
Script.setWidget(widget)
Script.complete()
// build the widget
async function createWidget(items) {
// get all data in a single variable
const data = await getData()
console.log(data)
//widget.refreshAfterDate = new Date(Date.now() + 300) // dont know if this works
widget.setPadding(10, 0, 10, 20)
const wrap = widget.addStack()
wrap.layoutHorizontally()
wrap.topAlignContent()
wrap.spacing = 15
const column0 = wrap.addStack()
column0.layoutVertically()
if (data.carPicture) {
const icon = await getImage("my-renault-car-" + VIN + ".png", data.carPicture)
//console.log("getting my-renault-car-"+VIN+".png")
//console.log("current icon: " + data.carPicture)
let CarStack = column0.addStack()
let iconImg = CarStack.addImage(icon)
// simple hack if we have a phase 1 model (no location data & no hvac-status available) – resize car-image
// not the smartest solution - but i try to check if the results show only 1 column.
// if column2 is empty, we have to resizes the car-image for better styling
if (typeof(data.locationStatus) == 'undefined' && typeof(data.hvacStatus) == 'undefined') {
iconImg.imageSize = new Size(130, 73)
}
}
column0.addSpacer(8)
if (typeof(data.batteryStatus) != 'undefined') {
let plugIcon
let plugStateLabel
let plugStateUrl
let scriptName = encodeURIComponent(Script.name())
const PlugWrap = column0.addStack()
PlugWrap.layoutHorizontally()
//PlugWrap.setPadding(0,15,0,15)
if (data.batteryStatus.attributes.plugStatus != 1) {
//plugIcon = await getImage("zoe-plug-off.png", "")
plugStateLabel = text_entkoppelt
} else {
//plugIcon = await getImage("zoe-plug-on.png", "")
plugStateLabel = text_gekoppelt
}
if (data.batteryStatus.attributes.chargingStatus == "1.0") {
plugStateLabel = text_wird_geladen
}
if (data.batteryStatus.attributes.plugStatus == 1 && data.batteryStatus.attributes.chargingStatus == "0") {
plugStateLabel = text_laden_starten
plugStateUrl = `scriptable:///run?scriptName=${scriptName}&action=start_charge`;
}
const PlugText = PlugWrap.addStack()
PlugText.setPadding(0, 10, 0, 0)
PlugText.layoutVertically()
plugStateLabel = PlugText.addText(plugStateLabel)
plugStateLabel.font = Font.regularSystemFont(10)
plugStateLabel.url = plugStateUrl
PlugText.addSpacer(6)
if (data.batteryStatus.attributes.chargingStatus == "1.0") { // must be 1.0, debug = 0
// (Akku minus verf. Energie) geteilt durch Restzeit = Ladegeschwindigkeit (by Marc)
let batteryAvailableEnergy = data.batteryStatus.attributes.batteryAvailableEnergy;
let chargingInstantaneousPower = data.batteryStatus.attributes.chargingInstantaneousPower
chargingInstantaneousPower = Math.round(chargingInstantaneousPower)
// check if the numbers are in Watt or kW
if (chargingInstantaneousPower > 150) {
// if over 200, we believe the value is in watt :-)
chargingInstantaneousPower = chargingInstantaneousPower / 1000
}
//console.log('chargingInstantaneousPower: ' + chargingInstantaneousPower)
chargingInstantaneousPower = Math.round(chargingInstantaneousPower).toLocaleString()
//console.log('chargingInstantaneousPower rounded: ' + chargingInstantaneousPower)
let chargingPower = chargingInstantaneousPower
if (ZOE_Battery) {
chargingPower = (ZOE_Battery - batteryAvailableEnergy) / (data.batteryStatus.attributes.chargingRemainingTime / 60)
//console.log("chargingPower calculated: " + chargingPower);
chargingPower = chargingPower.toFixed(1).toLocaleString()
}
//console.log('chargingPower final result: ' + chargingPower)
let chargingRemainingTime = time_convert(data.batteryStatus.attributes.chargingRemainingTime)
chargingRemainingTimeString = " | " + chargingRemainingTime + " h"
chargeStateLabel = " " + chargingPower + " kW" + chargingRemainingTimeString
chargeStateLabel = PlugText.addText(chargeStateLabel)
chargeStateLabel.font = Font.regularSystemFont(10)
PlugText.addSpacer(2)
}
}
const column1 = wrap.addStack()
column1.layoutVertically()
//column1.addSpacer(3)
// simple quota-limit check:
// (battery status is the first request – if it reports nothing, we can be sure, that there will be no other data available at the moment)
if (!data.batteryStatus || typeof(data.batteryStatus) == "undefined") {
if (config.runsInWidget) { // only in widget
throw new Error('Quota Limit! – Datenabruf zur Zeit nicht möglich. Später nochmals versuchen oder bei Renault beschweren.')
} else {
console.log('Quota Limit! – Datenabruf zur Zeit nicht möglich. Später nochmals versuchen oder bei Renault beschweren.')
}
}
if (typeof(data.batteryStatus) != 'undefined') {
let BatteryStack = column1.addStack()
BatteryStack.layoutVertically()
const batteryStatusLabel = BatteryStack.addText(text_ladestand)
batteryStatusLabel.font = Font.mediumSystemFont(12)
const batteryStatusVal = BatteryStack.addText(data.batteryStatus.attributes.batteryLevel.toString() + " %")
batteryStatusVal.font = Font.boldSystemFont(16)
column1.addSpacer(10)
// push Message if maxSoC reachead
/* under development! */
/*
let maxSoC = 62
// if(batteryStatusVal == maxSoC && data.batteryStatus.attributes.chargingStatus != "-1.0"){
const delaySeconds = 1;
let currentDate = new Date;
let newDate = new Date(currentDate.getTime() + (delaySeconds * 1000));
chargeFull = new Notification()
chargeFull.identifier = "maxSoCReached"
chargeFull.title = "🔋 Geladen"
chargeFull.body = "Die Batterie Deines Fahrzeugs wurde zu " + maxSoC + " % geladen!"
chargeFull.sound = "complete"
chargeFull.setTriggerDate(newDate);
chargeFull.schedule()
// } */
}
if (typeof(data.batteryStatus) != 'undefined') {
let RangeStack = column1.addStack()
RangeStack.layoutVertically()
const RangeStatusLabel = RangeStack.addText(text_reichweite)
RangeStatusLabel.font = Font.mediumSystemFont(12)
const RangeStatusVal = RangeStack.addText(data.batteryStatus.attributes.batteryAutonomy.toString() + " km")
RangeStatusVal.font = Font.boldSystemFont(16)
column1.addSpacer(10)
}
if (ZOE_Phase == 1 && typeof(data.batteryStatus) != 'undefined') {
if (typeof(data.batteryStatus.attributes.batteryTemperature) != 'undefined') {
let TempStack = column1.addStack()
TempStack.layoutVertically()
const TempStatusLabel = TempStack.addText(text_akkutemp)
TempStatusLabel.font = Font.mediumSystemFont(12)
const TempStatusVal = TempStack.addText(data.batteryStatus.attributes.batteryTemperature.toString() + " °C")
TempStatusVal.font = Font.boldSystemFont(16)
}
}
if (ZOE_Phase == 2 && typeof(data.batteryStatus) != 'undefined') {
if (typeof(data.batteryStatus.attributes.batteryAvailableEnergy) != 'undefined') {
let AvEnergyStack = column1.addStack()
AvEnergyStack.layoutVertically()
const AvEnergyStatusLabel = AvEnergyStack.addText(text_restenergie)
AvEnergyStatusLabel.font = Font.mediumSystemFont(12)
const AvEnergyStatusVal = AvEnergyStack.addText(data.batteryStatus.attributes.batteryAvailableEnergy.toString() + " kWh")
AvEnergyStatusVal.font = Font.boldSystemFont(16)
}
}
const column2 = wrap.addStack()
column2.layoutVertically()
//column2.addSpacer(3)
if (typeof(data.cockpitStatus) != 'undefined') {
let MileageStack = column2.addStack()
MileageStack.layoutVertically()
const MileageStatusLabel = MileageStack.addText(text_kilometerstand)
MileageStatusLabel.font = Font.mediumSystemFont(12)
let mileage = Math.round(data.cockpitStatus.attributes.totalMileage).toLocaleString()
const MileageStatusVal = MileageStack.addText(mileage.toString() + " km")
MileageStatusVal.font = Font.boldSystemFont(16)
column2.addSpacer(10)
}
if (typeof(data.locationStatus) != 'undefined') {
let LocationStack = column2.addStack()
LocationStack.spacing = 2
LocationStack.layoutVertically()
const LocationLabel = LocationStack.addText(text_position)
LocationLabel.font = Font.mediumSystemFont(12)
const LocationVal = LocationStack.addText(text_karte_oeffnen)
LocationVal.font = Font.boldSystemFont(12)
if (mapProvider == "google") {
// https://www.google.com/maps/search/?api=1&query=58.698017,-152.522067
LocationVal.url = "https://www.google.com/maps/search/?api=1&query=" + data.locationStatus.attributes.gpsLatitude + "," + data.locationStatus.attributes.gpsLongitude
} else {
// fallback to apple…
// http://maps.apple.com/?ll=50.894967,4.341626
LocationVal.url = "http://maps.apple.com/?q=ZOE&ll=" + data.locationStatus.attributes.gpsLatitude + "," + data.locationStatus.attributes.gpsLongitude
}
//LocationStack.addSpacer(0.5)
column2.addSpacer(12)
}
//if(typeof(data.hvacStatus) != 'undefined'){ // we have to uncomment this later!
let AcStack = column2.addStack()
AcStack.spacing = 2
AcStack.layoutVertically()
const AcLabel = AcStack.addText(text_klimatisierung)
AcLabel.font = Font.mediumSystemFont(12)
// create a self-opening url to run the start_ac function
// could be nicer, but seems to work at the moment.
let scriptName = encodeURIComponent(Script.name())
let AcVal
let ac_url
if (args.queryParameters.action == 'start_ac') {
AcVal = AcStack.addText(text_stoppen)
ac_url = `scriptable:///run?scriptName=${scriptName}&action=stop_ac`;
} else {
AcVal = AcStack.addText(text_starten)
ac_url = `scriptable:///run?scriptName=${scriptName}&action=start_ac`;
}
AcVal.font = Font.boldSystemFont(12)
AcVal.url = ac_url
//} // we have to uncomment this later!
}
// fetch all data
async function getData() {
// we are going now a long way through multiple servers to get access to our data
// 1. fetch session and user data from gigya
let gigyaCookieValue
let gigyaPersonID
if (Keychain.contains('gigyaCookieValue') && Keychain.get('gigyaCookieValue') != "") {
gigyaCookieValue = Keychain.get('gigyaCookieValue')
}
//console.log('gigyaCookieValue (from keychain): ' + gigyaCookieValue)
if (Keychain.contains('gigyaPersonID') && Keychain.get('gigyaPersonID') != "") {
gigyaPersonID = Keychain.get('gigyaPersonID')
}
//console.log('gigyaPersonID (from keychain): ' + gigyaPersonID)
if (gigyaCookieValue == "" || gigyaPersonID == "" ||
typeof(gigyaCookieValue) == "undefined" || typeof(gigyaPersonID) == "undefined") {
let url = gigyaURL + '/accounts.login?loginID=' + encodeURIComponent(myRenaultUser) + '&password=' + encodeURIComponent(myRenaultPass) + '&include=data&apiKey=' + gigyaAPI
let req = new Request(url)
let apiResult = await req.loadString()
apiResult = JSON.parse(apiResult)
//console.log("1.: " + apiResult.statusCode)
if (apiResult.statusCode == "403") {
let loginMessage = "Login nicht möglich. Zugangsdaten prüfen."
throw new Error(loginMessage);
} else {
gigyaCookieValue = apiResult.sessionInfo.cookieValue
gigyaPersonID = apiResult.data.personId
Keychain.set('gigyaCookieValue', gigyaCookieValue)
Keychain.set('gigyaPersonID', gigyaPersonID)
//console.log('gigyaCookieValue (new generated): ' + gigyaCookieValue)
//console.log('gigyaPersonID (new generated): ' + gigyaPersonID)
}
}
// 2. fetch JWT data from gigya
// renew gigyaJWTToken once a day
if (Keychain.contains('lastJWTCall') == false) {
Keychain.set('lastJWTCall', 'never')
}
let gigyaJWTToken
if (Keychain.contains('gigyaJWTToken')) {
gigyaJWTToken = Keychain.get('gigyaJWTToken')
}
//console.log('gigyaJWTToken (from keychain): ' + gigyaJWTToken)
if (gigyaJWTToken == "" || typeof(gigyaJWTToken) == "undefined") {
let expiration = 87000
url = gigyaURL + '/accounts.getJWT?oauth_token=' + gigyaCookieValue + '&login_token=' + gigyaCookieValue + '&expiration=' + expiration + '&fields=data.personId,data.gigyaDataCenter&ApiKey=' + gigyaAPI
req = new Request(url)
apiResult = await req.loadString()
apiResult = JSON.parse(apiResult)
//console.log("3.: " + apiResult.statusCode)
gigyaJWTToken = apiResult.id_token
Keychain.set('gigyaJWTToken', gigyaJWTToken)
//console.log('gigyaJWTToken (new generated): ' + gigyaJWTToken)
const callDate = new Date().toJSON().slice(0, 13).replace(/-/g, '').replace(/T/g, '-')
Keychain.set('lastJWTCall', callDate)
//console.log('lastJWTCall (new generated): ' + callDate)
}
// 3. fetch data from kamereon (person)
// if not in Keychain (we try to avoid quota limits here)
let account_id
if (Keychain.contains('account_id')) {
account_id = Keychain.get('account_id')
}
//console.log('account_id (from keychain): ' + account_id)
if (account_id == "" || typeof(account_id) == "undefined") {
url = kamareonURL + '/commerce/v1/persons/' + gigyaPersonID + '?country=DE'
req = new Request(url)
req.method = "GET"
req.headers = { "x-gigya-id_token": gigyaJWTToken, "apikey": kamareonAPI }
apiResult = await req.loadString()
//console.log("4.: " + apiResult)
apiResult = JSON.parse(apiResult)
if (apiResult.type == "FUNCTIONAL") {
let quotaMessage = apiResult.messages[0].message + " – Login derzeit nicht möglich. Später nochmal versuchen."
throw new Error(quotaMessage);
} else {
account_id = apiResult.accounts[accountNumber].accountId
Keychain.set('account_id', account_id)
//console.log('account_id (new generated): ' + account_id)
}
}
// 4. fetch data from kamereon (all vehicles data)
// we need this only once to get the picture of the car and the VIN!
let carPicture
if (Keychain.contains('carPicture')) {
carPicture = Keychain.get('carPicture')
}
//console.log('carPicture (from keychain): ' + carPicture)
if (Keychain.contains('VIN') && Keychain.get('VIN') != "") {
VIN = Keychain.get('VIN')
}
//console.log('VIN (from keychain): ' + VIN)
if (carPicture == "" || typeof(carPicture) == "undefined" || VIN == "" || typeof(VIN) == "undefined") {
url = kamareonURL + '/commerce/v1/accounts/' + account_id + '/vehicles?country=DE'
req = new Request(url)
req.method = "GET"
req.headers = { "x-gigya-id_token": gigyaJWTToken, "apikey": kamareonAPI }
apiResult = await req.loadString()
apiResult = JSON.parse(apiResult)
if (carNumber == "") { // fallback
carNumber = 0;
}
// set correct carNumber to array (starts with 0)
carNumber = carNumber - 1;
//console.log("carNumber: " + carNumber)
// set carPicture
carPicture = await apiResult.vehicleLinks[carNumber].vehicleDetails.assets[0].renditions[0].url
Keychain.set('carPicture', carPicture)
//console.log('carPicture (new): ' + carPicture)
// set VIN
if (VIN == "" || typeof(VIN) == "undefined") {
VIN = apiResult.vehicleLinks[carNumber].vin
Keychain.set('VIN', VIN)
//console.log('VIN (new generated): ' + VIN)
}
}
// log all vehicle data:
// console.log(apiResult.vehicleLinks)
// NOW WE CAN READ AND SET EVERYTHING INTO AN OBJECT:
const allResults = {};
// real configurator picture of the vehicle
// old call: let carPicture = allVehicleData.vehicleLinks[0].vehicleDetails.assets[0].renditions[0].url // renditions[0] = large // renditions[1] = small image
allResults["carPicture"] = carPicture
// batteryStatus
// version: 2
// batteryLevel = Num (percentage)
// plugStatus = bolean (0/1)
// chargeStatus = bolean (0/1) (?)
let batteryStatus = await getStatus('battery-status', 2, kamareonURL, account_id, VIN, gigyaJWTToken, kamareonAPI)
allResults["batteryStatus"] = batteryStatus
// cockpitStatus
// version: 2
// totalMileage = Num (in Kilometres!)
let cockpitStatus = await getStatus('cockpit', 1, kamareonURL, account_id, VIN, gigyaJWTToken, kamareonAPI)
allResults["cockpitStatus"] = cockpitStatus
// locationStatus
// version: 1
// gpsLatitude
// gpsLongitude
// LastUpdateTime
let locationStatus = await getStatus('location', 1, kamareonURL, account_id, VIN, gigyaJWTToken, kamareonAPI)
allResults["locationStatus"] = locationStatus
// chargeSchedule
// note: unused at the moment!
// version: 1
let chargeSchedule = await getStatus('charging-settings', 1, kamareonURL, account_id, VIN, gigyaJWTToken, kamareonAPI)
allResults["chargeSchedule"] = chargeSchedule
// hvacStatus
// version: 1
let hvacStatus = await getStatus('hvac-status', 1, kamareonURL, account_id, VIN, gigyaJWTToken, kamareonAPI)
allResults["hvacStatus"] = hvacStatus
//console.log('hvacStatus: ' + hvacStatus)
// query parameter / args
// if query action = "start_ac" we start "vorklimatisierung"
// default temperature will be 21°C
let query_action = args.queryParameters.action
if (query_action == "start_ac") {
let attr_data = '{"data":{"type":"HvacStart","attributes":{"action":"start","targetTemperature":"21"}}}'
let action = await postStatus('hvac-start', attr_data.toString(), 1, kamareonURL, account_id, VIN, gigyaJWTToken, kamareonAPI)
//console.log("start_ac_action: " + action)
//throw new Error(action)
}
if (query_action == "stop_ac") {
let attr_data = '{"data":{"type":"HvacStart","attributes":{"action":"cancel"}}}'
let action = await postStatus('hvac-start', attr_data.toString(), 1, kamareonURL, account_id, VIN, gigyaJWTToken, kamareonAPI)
//console.log("stop_ac_action: " + action)
}
if (query_action == "start_charge") {
let attr_data = '{"data":{"type":"ChargingStart","attributes":{"action":"start"}}}'
let action = await postStatus('charging-start', attr_data.toString(), 1, kamareonURL, account_id, VIN, gigyaJWTToken, kamareonAPI)
console.log("start_charge_action: " + action)
}
//console.log(allResults)
// return array
return allResults
}
// general function to get status-values from our vehicle
async function getStatus(endpoint, version = 1, kamareonURL, account_id, VIN, gigyaJWTToken, kamareonAPI) {
// fetch data from kamereon (single vehicle)
url = kamareonURL + '/commerce/v1/accounts/' + account_id + '/kamereon/kca/car-adapter/v' + version + '/cars/' + VIN + '/' + endpoint + '?country=DE'
req = new Request(url)
req.method = "GET"
req.headers = { "x-gigya-id_token": gigyaJWTToken, "apikey": kamareonAPI, "Content-type": "application/vnd.api+json" }
apiResult = await req.loadString()
if (req.response.statusCode == 200) {
apiResult = JSON.parse(apiResult)
}
return apiResult.data
console.log(apiResult.data)
}
// general function to POST status-values to our vehicle
async function postStatus(endpoint, jsondata, version, kamareonURL, account_id, VIN, gigyaJWTToken, kamareonAPI) {
url = kamareonURL + '/commerce/v1/accounts/' + account_id + '/kamereon/kca/car-adapter/v' + version + '/cars/' + VIN + '/actions/' + endpoint + '?country=DE'
request = new Request(url)
request.method = "POST"
request.body = jsondata
request.headers = { "x-gigya-id_token": gigyaJWTToken, "apikey": kamareonAPI, "Content-type": "application/vnd.api+json" }
apiResult = await request.loadString()
//console.log(apiResult)
//debug:
// throw new Error(url)
let pushBody
let sound
if (request.response.statusCode == 200) {
pushBody = "Die Übermittlung des Befehls war erfolgreich."
sound = "piano_success"
} else {
pushBody = "Es ist ein Fehler beim Senden des Befehls aufgetreten. Keine Verbindung. Code:" + request.response.statusCode
sound = "piano_error"
}
pushMessage = new Notification()
pushMessage.identifier = "zoePostStatus"
if (endpoint == "hvac-start") {
pushMessage.title = "Kommando an Klimaanlage gesendet"
}
if (endpoint == "charge-start") {
pushMessage.title = "Kommando an Ladeanlage gesendet"
}
//pushMessage.title = "Befehl gesendet"
pushMessage.body = pushBody
pushMessage.sound = sound
//pushMessage.setTriggerDate(newDate);
pushMessage.schedule()
return apiResult
}
function time_convert(num) {
var hours = Math.floor(num / 60);
var minutes = num % 60;
return hours + ":" + minutes;
}
// get images from local filestore or download them once
// this part is inspired by the dm-toilet-paper widget
// credits: https://gist.github.com/marco79cgn
async function getImage(image, imgUrl) {
let fm = FileManager.local()
let dir = fm.documentsDirectory()
let path = fm.joinPath(dir, image)
if (fm.fileExists(path)) {
return fm.readImage(path)
//fm.remove(path)
} else {
// download once
let imageUrl
switch (image) {
case 'my-renault-car-' + VIN + '.png':
imageUrl = imgUrl
break
default:
//console.log(`Sorry, couldn't find ${image}.`);
}
if (imageUrl) {
let iconImage = await loadImage(imageUrl)
fm.writeImage(path, iconImage)
return iconImage
}
}
}
// helper function to download an image from a given url
async function loadImage(imgUrl) {
const req = new Request(imgUrl)
return await req.loadImage()
}
// end of script
@mountbatt
Copy link
Author

mountbatt commented Oct 26, 2020

Intro

Dieses Widget zeigt den aktuellen Status des Renault ZOE an. Dazu werden die Login-Daten für die My-Renault App benötigt. Diese müssen oben im Script eingegeben werden.

Anforderungen

  • mind. iOS 14
  • Scriptable version 1.5 (oder neuer)
  • My RENAULT - Account Zugangsdaten (Email + Passwort)
  • Optional: Fahrgestellnummer des Fahrzeugs (VIN/FIN) bei mehreren Fahrzeugen im Account
  • Derzeit nur mit einer ZOE Phase 2 (2020) getestet, sollte mit Abstrichen aber auch mit Phase 1 laufen.

Installation

  • Kopiere den gesamten Sourcecode von oben (klick vorher auf "raw" oben rechts)
  • Öffne die Scriptable App
  • Klick auf das "+" Symbol oben rechts und füge das kopierte Skript ein
  • Ändere nun im Script ganz oben "your_email" und "your_pass" mit den Zugangsdaten Deines My-RENAULT Accounts (E-Mailadresse und zugehöriges Passwort)
  • Trage bei ZOE_Phase eine 1 oder 2 für Dein Fahrzeug ein
  • Trage bei ZOE_Battery die Batterie-Kapazität für Dein Fahrzeug ein (z.B. "52", wenn Du eine 52 kW Batterie hast)
  • Gebe optional die VIN / FIN Deines Fahrzeugs in die entsprechende Stelle ein. (Dies wird nur benötigt, wenn Du mehrere Fahrzeuge in Deinem Account hast und das Widget auf ein bestimmtes Fahrzeug zeigen lassen willst oder wenn es zu Problemen beim Datenabruf kommt)
  • Klick auf den Titel des Skripts ganz oben und vergebe einen Namen (z.B. ZOE)
  • Speichere das Skript durch Klick auf "Done" oben links
  • Gehe auf deinen iOS Homescreen und drücke irgendwo lang, um in den "Wiggle Mode" zu kommen (mit dem man auch die App Symbole anordnen kann)
  • Drücke das "+" Symbol oben links, blättere dann nach unten zu "Scriptable" (Liste ist alphabetisch), wähle die zweite Widget Größe (medium / breites Format) und drücke unten auf "Widget hinzufügen"
  • Drücke auf das Widget, um seine Einstellungen zu bearbeiten (optional lang drücken, wenn der Wiggle Modus schon beendet wurde)
    Wähle unter "Script" das oben erstellte aus (ZOE)
  • Warte einen Moment (ca. 15 Sek.), bis das Widget die Daten vom Server geladen hat.

Bekannte Fehler

  • Es kann derzeit noch zu Timeouts / Quota-Limits kommen, wenn das Widget zu oft versucht die Daten vom Server zu laden. Nach 15 Minuten sollte es aber gehen.
  • Beim Drücken des "Klima starten" oder "Klima stoppen" Links wird Scriptable geöffnet und das Widget erneut geöffnet. Dies ist eine Vorgabe von Apple und derzeit leider nicht anders zu implementieren.

Disclaimer

Bei diesem Widget / Script handelt es sich um ein reines Privatprojekt ohne kommerzielle Hintergründe etc. Ich stehe weder in Beziehung zu Renault, noch bekomme ich etwas dafür. Die API-Anbindung zu den Renault-Servern kann jederzeit von Renault geändert und der Zugriff des Widgets somit unmöglich werden. Beachte unbedingt, dass Du dein My-Renault-Passwort oben im Script nicht mit anderen teilst!

Hinweis

Beachte, dass zu viele Zugriffe auf die My-RENAULT API in kurzer Zeit zu einer temporären Abrufsperre führen. Das gilt aber für alle Zugriffe wie z.B. via Zeddy usw. Nach kurzer Zeit sollte der Abruf wieder gelingen.

Danke

Ein Dank geht an marco79cgn für sein dm-Widget – dies hat mich zu diesem Projekt inspiriert. Zudem gebührt Respekt muskat, der die API von Renault intensiv durchforstet hat.

Updates

19.04.2024 08:03

  • Fix für die Anzeige des Kilometerstands und der PlugStatus (gekoppelt/entkoppelt) Anzeige. Renault hat an der API Änderungen vorgenommen, ich hoffe, dass der PlugStatus sich richtig verhält. Der Endpoint "cockpit" wurde von Version 2 auf 1 zurückgestellt.

03.05.2022 12:14 Uhr

  • Kleines Update für alle, die mehrere Accounts bei gigya/Renault haben und keine Verbindung herstellen können. Probiert einfach in Zeile 30 die "accountNumber" mal auf 1 statt 0 zu setzen.

02.05.2022 21:32 Uhr

  • Nun wird die VIN besser automatisch ausgelesen und ihr könnt mehrere Widgets mit mehreren Fahrzeugen parallel laufen lassen. Durch die Eingabe einer Zahl in der Variable "carNumber" könnt Ihr Euer Fahrzeug entsprechend auswählen.
  • Verbesserter Abruf des Fahrzeug-Bilds
  • Verbesserte Abruf der VIN
  • Danke an Sven fürs Testen mit 2 Autos.

16.03.2022 20:14 Uhr

  • Neuer API Key "VAX7XYKGfa92yMvXculCkEFyfZbuM7Ss" Danke @dehsgr !!!

20.08.2021 22:14 Uhr

  • Neue Formel zur Berechnung der tatsächlichen Ladeleistung – hierfür muss nun die Kapazität der Batterie (z.B. 52) in das Script eingegeben werden. Dann kann beim Laden nun - und das ist weitgehend einzigartig - die momentane Ladeleistung angezeigt werden. Mit Dank an Marc für die Formel
  • Hier die Formel: (Batteriegröße - Verf. Energie) / Restladedauer also z.b. (52 - 30) / 1.3 = 16.93 kW
  • Version: 2021-08-20

10.02.2021 10:24 Uhr

  • Bugfix URL für Ladestart – @dehsgr
  • Version: 2021-02-10

09.02.2021 02:10 Uhr

  • Bugfix nach erneuten Änderungen von Renault – mit großem Dank erneut an @dehsgr
  • Version: 2021-02-09

02.02.2021 01:30 Uhr

  • Neuer kamareonAPI Key. Danke an @dehsgr
  • Quickfix: einfach den kamareonAPI Key (Zeile 23) ändern auf: "Ae9FDWugRxZQAGm3Sxgk7uJn6Q4CGEA2"

31.10.2020 12:00 Uhr

  • Danke an Marcus für die Hilfe beim Testen
  • Div. Bugfixes (und sicher div. neue Bugs eingebaut)
  • Anpassungen für Kompatibilität mit Phase 1
  • Anzeige der Laderestdauer
  • Anzeige der aktuellen kW beim Laden (Es gibt aber die Vermutung, dass es sich hierbei nur um die derzeit maximal mögliche Kapazität handelt - daher hat evtl. selbst Renault in seiner App derzeit keine richtige kW Anzeige mehr eingebaut!)
  • Erste Gehversuche einen "Klima starten" und "Klima stoppen" Knopf einzubauen - hier wird derzeit noch dran gearbeitet! (Ich kann es nicht testen, da mein ZOE Ph2 2020 derzeit keine Vorklimatisierung per App / API zulässt)
  • Erste Versuche einen Button für "Laden starten" einzubauen, wenn Fahrzeug gekoppelt und keine Ladeaktivität
  • Bei Phase 2 wird die Batteriekapazität, bei Phase 2 die Akkutemperatur angezeigt (Phase 1 und 2 können nur jw. diese Info anzeigen)
  • In Planung: Push Message wenn Akku voll geladen wurde

26.10.2020 16:58 Uhr

  • "⚡ Lädt (44 kWh)". Nun wird die Ladeleistung angezeigt. Muss aber noch von div. Usern bitte getestet werden. Angeblich stimmt die Angabe der Ladeleistung nicht immer. (Vielleicht wird sie deshalb auch nicht im Auto angezeigt :-)

26.10.2020 16:22 Uhr

  • Nun kompatibel mit Phase 1 Modellen (es wird derzeit hier nur der Ladestand und die Restreichweite angezeigt) (Danke Alexander)
  • Kleinere kosmetische Fixes, keine Einbindung mehr von Icons, sondern nativen Emojis (Spart Ladezeit und Verbindungen zu externen Servern)
  • "⚡ Lädt ..." wird nun bei aktiver Ladung angezeigt

26.10.2020 10:48 Uhr

  • Kleiner Fix für die Passwortübermittlung (Danke an BowlingX)

26.10.2020 9:35 Uhr

  • Erstes Release (getestet bislang nur auf iPhone 7) - Das Script ist noch in Entwicklung!

Roadmap

  • Status "Lädt grade" einfügen
  • Stecker-Icon und Text richtig zentrieren
  • Auf anderen iOS-Geräten testen und Größen / Abstände anpassen
  • Loading Indicator hinzufügen (Opacity etc.)
  • Kompatibel mit älteren ZOEs machen
  • Verständliche Fehlermeldungen einbauen
  • Ladeleistung anzeigen ( zb. so: ⚡ Lädt mit 43 kWh )
  • Vorklimatisierungsbutton einfügen (frühe Beta!)
  • Push Notifications z.b. wenn Akku 100% geladen
  • Besserer Umgang mit Quota Limit (wer kann helfen?)

@BowlingX
Copy link

BowlingX commented Oct 26, 2020

Thank you!! Really cool.
I had a problem with a password that contains % signs.
There is a problem in the following line:

https://gist.github.com/mountbatt/772e4512089802a2aa2622058dd1ded7?fbclid=IwAR0HurkUSr4r1dJZZhQY68o_PgQWVf8e5bfGZnuORxqKxILDlGDwi4c2QWk#file-zoe-widget-js-L129

To support passwords with (% sign), they should be escaped with encodeURIComponent.
It should be changed to

let url = gigyaURL + '/accounts.login?loginID=' + encodeURIComponent(myRenaultUser) + '&password=' + encodeURIComponent(myRenaultPass) + '&apiKey=' + gigyaAPI

@mountbatt
Copy link
Author

Thank you!! Really cool.
I had a problem with a password that contains % signs.
There is a problem in the following line:

https://gist.github.com/mountbatt/772e4512089802a2aa2622058dd1ded7?fbclid=IwAR0HurkUSr4r1dJZZhQY68o_PgQWVf8e5bfGZnuORxqKxILDlGDwi4c2QWk#file-zoe-widget-js-L129

To support passwords with (% sign), they should be escaped with encodeURIComponent.
It should be changed to

let url = gigyaURL + '/accounts.login?loginID=' + encodeURIComponent(myRenaultUser) + '&password=' + encodeURIComponent(myRenaultPass) + '&apiKey=' + gigyaAPI

Danke! Ist eingefügt

@jrathert
Copy link

jrathert commented Oct 26, 2020

Hi, ich habe eine ZOE von 2018. Die unterstützt leider nicht das Abfragen der location (bzw. das Abfragen schon, aber es kommt halt kein Ergebnis. Wenn man aber einfach den Code-Block in den Zeilen 112-122 in ein if (data.locationStatus) { ... } packt, dann funktioniert es auch mit meiner ZOE :-)

@mountbatt
Copy link
Author

Hi, ich habe eine ZOE von 2018. Die unterstützt leider nicht das Abfragen der location (bzw. das Abfragen schon, aber es kommt halt kein Ergebnis. Wenn man aber einfach den Code-Block in den Zeilen 112-122 in ein if (data.locationStatus) { ... } packt, dann funktioniert es auch mit meiner ZOE :-)

Danke @jrathert für den Hinweis. Ist nun bei allen Datenfeldern so eingebaut (Check if defined) und nun kann man es auch mit den älteren Modellen nutzen.

@tobwil
Copy link

tobwil commented Oct 27, 2020

A377EE61-2208-42B9-A3D4-3B34BE9054C5

Ladeleistung wird leider falsch angegeben. Hier wird real gerade dreiphasig mit 9,6kWh geladen. Zoe Intens R135 Phase 2.
Identische, aber auch falsche Werte, werden auch via Zeddy App ausgegeben.

@druelie
Copy link

druelie commented Oct 27, 2020

kWh ist eine Einheit für die Batteriekapazität (Energiemenge), nicht die Ladeleistung. Leistung wird in Watt bzw. kW angegeben.

@mountbatt
Copy link
Author

Danke @druelie – habe es korrigiert. Die falschen Werte allerdings kann ich derzeit nicht in den Griff kriegen, das ist das, was das Auto leider per API übermittelt. Weißt Du ob das in der Renault App richtig angezeigt wird?

@tobwil
Copy link

tobwil commented Oct 28, 2020

In der Renault App wird das ja gar nicht mehr angezeigt. Vermutlich auch aus diesem Grund. :-)

@druelie
Copy link

druelie commented Oct 28, 2020

Vielleicht lässt sich auch noch einiges von folgender Android App abschauen:
https://github.com/robertaramar/MyZOE
Allerdings ist es ja kein Widget und der Entwickler macht keine Änderungen mehr, weil er keine Lust mehr hat, Renault ständig hinterher zu hechten, wenn wieder etwas nicht funktioniert.

Oder von diesem PHP-Script, was OS unabhängig funktioniert:
https://www.goingelectric.de/forum/viewtopic.php?f=57&t=58182

Falls das noch nicht bekannt ist :)

@fawick
Copy link

fawick commented Oct 29, 2020

Es gibt einen (polnischen, aber dank Google Translate gut lesbaren) Artikel auf https://elektrowoz.pl/auta/renault-zoe-ze-50-teoretycznie-powinien-obslugiwac-moc-ladowania-70-kw-odkrycie-czytelnika/, in dem spekuliert wird, dass chargingInstantaneousPower der aktuell maximal moeglichen Ladeleistung entspricht.

@bloemi
Copy link

bloemi commented Oct 31, 2020

vielleicht lässt sich noch ein Parameter zum Script hinzufügen der einen wählen lässt, ob Google Maps oder Apple Maps bei der Lokalisierung verwendet werden soll

@mountbatt
Copy link
Author

@bloemi gute Idee!

@mountbatt
Copy link
Author

@bloemi Ist nun eingebaut …

@MacSchierer
Copy link

Vielen Dank für das geniale Skript. Etwas ähnliches hatte ich über ein paar Umwege realisiert.
Aber dein Skript wird das wohl jetzt ablösen! :-)
Vorschlag zum Layout bzw. Design: Schicke SFSymbols könnten gerne die Emoji-Symbole ablösen.

function addSymbol({
  symbol = 'applelogo',
  stack,
  color = Color.white(),
  size = 20,
  imageOpacity = 1,
}) {
  const _sym = SFSymbol.named(symbol)
  const wImg = stack.addImage(_sym.image)
  wImg.tintColor = color
  wImg.imageSize = new Size(size, size)
  wImg.containerRelativeShape = false
  wImg.imageOpacity = imageOpacity
}

@t-stricker
Copy link

Danke für das Skript! Leider zeigts bei mir immer die falsche Wagenfarbe und die Phase 1 an statt 2. Hatte vorher einen Phase 1 in meinem Konto hinterlegt, nachdem löschen aus der Renault App zeigt das Widget die Farbe aber trotzdem an. Habe auch die 43 mal aus kommentiert, Bild ändert sich aber nicht.

@t-stricker
Copy link

Scriptable App neu installieren hats gelöst...

@mountbatt
Copy link
Author

@t-stricker Ja, das Bild vom Auto wird in einem Keychain Element gesichert. Also Lösung hättest Du Zeile 43 aktivieren können und nach 1 Tag wäre das dann erschienen. Oder Du hättest noch einfach clearKeychain() irgendwo nach Zeile 49 schreiben können, dann wäre der Keychain einmal komplett geleert worden. Neuinstallation von Scriptable scheint also auch den Keychain zu leeren. Danke für die Rückmeldung.

@cristianmargescu
Copy link

Falls ihr noch Hilfe braucht Entwicklung/Testing gerne melden.

@RYOSAEBAXYZ
Copy link

Hi !! I always get the same error.

Error on line 425:45: TypeError: undefined is not an object (evaluating 'apiResult.vehicleLinks[0].vehicleDetails')

Any idea ? (I’m from France ) thank you very much !

@mountbatt
Copy link
Author

@RYOSAEBAXYZ Are you sure, you copied the whole script? It looks like the script is not able to get all data from the server.

@RYOSAEBAXYZ
Copy link

RYOSAEBAXYZ commented Nov 14, 2020 via email

@RYOSAEBAXYZ
Copy link

Still the same msg no matter what. It seems credentials are not at fault. I can’t figure out what it is.
Zoe 1 (2015)
TypeError: undefined is not an object (evaluating 'apiResult.vehicleLinks[0].vehicleDetails')

@thkl
Copy link

thkl commented Nov 17, 2020

Maybe its a better approach to ask for the users credentials and store them in the device keychain instead to safe cleartext data at the top of the script ?

@valentincosson
Copy link

valentincosson commented Dec 15, 2020

Should I be changing the country code for the API ? (France ?)

@RYOSAEBAXYZ I think i figured out why that's not working in france:

  • gigyaAPI is different in france --> "3_4LKbCcMMcvjDm3X89LU4z4mNKYKdl_W0oD9w-Jvih21WqgJKtFZAnb9YdUgWT9_a"
    let gigyaAPI = "3_4LKbCcMMcvjDm3X89LU4z4mNKYKdl_W0oD9w-Jvih21WqgJKtFZAnb9YdUgWT9_a"
  • country is "FR" instead of "DE"
    you just need to replace all "DE" with "FR
  • And for my case, Renault API returns 3 accounts in step "4. Fetch the Data". So i updated the script to get the right one. I wrote this code for keychain set of account_id :
for (const index in apiResult.accounts) {
    let account = apiResult.accounts[index];
    if ("accountType" in account) {
        if (account["accountType"] == "MYRENAULT") {
            console.log(account);
            account_id = account.accountId;
            break;
        }
    }
}
Keychain.set('account_id', account_id)
console.log('account_id (new generated): ' + account_id)

@RYOSAEBAXYZ
Copy link

let account = apiResult.accounts[index];

Thanks !! Where should your bit be added then ?

@RYOSAEBAXYZ
Copy link

Should I be changing the country code for the API ? (France ?)

@RYOSAEBAXYZ I think i figured out why that's not working in france:

  • gigyaAPI is different in france --> "3_4LKbCcMMcvjDm3X89LU4z4mNKYKdl_W0oD9w-Jvih21WqgJKtFZAnb9YdUgWT9_a"
    let gigyaAPI = "3_4LKbCcMMcvjDm3X89LU4z4mNKYKdl_W0oD9w-Jvih21WqgJKtFZAnb9YdUgWT9_a"
  • country is "FR" instead of "DE"
    you just need to replace all "DE" with "FR
  • And for my case, Renault API returns 3 accounts in step "4. Fetch the Data". So i updated the script to get the right one. I wrote this code for keychain set of account_id :
for (const index in apiResult.accounts) {
    let account = apiResult.accounts[index];
    if ("accountType" in account) {
        if (account["accountType"] == "MYRENAULT") {
            console.log(account);
            account_id = account.accountId;
            break;
        }
    }
}
Keychain.set('account_id', account_id)
console.log('account_id (new generated): ' + account_id)

You figured it out !! That was it !! The multiple accounts !! Thanks a lot !

@dehsgr
Copy link

dehsgr commented Feb 1, 2021

Since today the call is resulting in 403 making Kameron server calls from Germany. Is this reproducible to someone else?

@coolio2004
Copy link

same error here from cologne

@lix-src
Copy link

lix-src commented Feb 1, 2021

i hope this is only temporary

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