Skip to content

Commit c6f6a85

Browse files
committed
doc updates and minor tweaks - go for v1.0.0
1 parent 51d88c3 commit c6f6a85

File tree

5 files changed

+31
-41
lines changed

5 files changed

+31
-41
lines changed

docs/index.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,10 @@ function lightbox_close() {
6262
Features Include:
6363
{: .fs-6 .fw-300 }
6464

65-
- Homescreen and Lockscreen Widgets
66-
- Optional background auto-updating of widget data
67-
- One Click Control Center icons for common commands
68-
- Siri voice support "Hey Siri, Warm the car"
65+
- Auto-Updating Homescreen and Lockscreen Widgets
6966
- Fresh and more responsive app UI
70-
- Automations via IOS Shortcuts like walk-away lock and auto warm the car on a schedule
67+
- Single click options for common commands (lock, warm, charge etc) in both app and in IOS Control Center
68+
- Siri voice support "Hey Siri, Warm the car"
69+
- Automations via IOS Shortcuts like walk-away lock
7170
- Unlimited Custom Climate configurations
7271
{: .fs-6 .fw-300 }

docs/pages/features.md

Lines changed: 18 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -7,47 +7,32 @@ nav_order: 3
77
# Bluelink Scriptable feature set
88
{: .fs-9 }
99

10-
The app is designed to perform a subset of the main Hyundai / Kia app, but the subset that makes up for 99% of your usage.
10+
The app is designed to perform a subset of the main Hyundai / Kia app, but the subset that makes up for 99% of your normal usage.
1111
{: .fs-6 .fw-300 }
1212

13-
The app is driven through the main widget, which can sit on any homescreen of your choosing - clicking on the widget opens the app automatically, swiping away closes it. The widget automatically updates the data displayed regularly, attempting to balance freshness of data while limiting the amount of remote connections to the car.
14-
{: .fs-5 .fw-300 }
1513

16-
The app also supports the use of Siri Shortcuts, allowing you to ask siri to ***"get the status of the car"***, or ***"start warming the car"***. See the Siri Shortcuts section for more info.
14+
The app is driven through the main widget, which can sit on either your lockscreen or homescreen - clicking on the widget opens the app automatically, swiping away closes it. The widget automatically updates the data displayed regularly, attempting to balance freshness of data while limiting the amount of remote connections to the car.
1715
{: .fs-5 .fw-300 }
1816

19-
**Status / Remote Status**
20-
{: .fs-5 .fw-200 }
21-
22-
The app queries the Bluelink API to retireve information on the SOC (State of Charge), charging status, charging completion date/time, lock/unlock, climate and finally the 12v battery charge percentage.
23-
{: .fs-5 .fw-200 }
24-
25-
The widget reguarly queries the bluelink API to retrieve the lastest data on the server, however this is typically cached data as the car only updates the bluelinks servers on very in-frequent basis.
26-
{: .fs-5 .fw-200 }
27-
28-
The app also supports performing "remote refreshes" which actually queries the car and gets the most upto date information from the car. Within the app clicking the status icon will cause a remote refresh, the widget can also perform remote refreshes on a schedule - this feature needs to be opted into within the settings screen.
29-
{: .fs-5 .fw-200 }
30-
31-
> IMPORTANT NOTE: Too many remote refresh commands will drain the 12v battery in the car, which in a worst case situation will cause the car to not be able to start. The widget has been configured to be very careful on the number of remote refresh commands sent, however buyer beware - hence the opt-in - I take no liabiity for any 12v failures based on the abuse of this feature.
32-
33-
**Start Charge / Stop Charge**
34-
{: .fs-5 .fw-200 }
35-
36-
The app can stop or start charging the car. Click on the current charging status and choose start or stop.
37-
{: .fs-5 .fw-200 }
38-
39-
**Climate Warm / Cool / Stop**
40-
{: .fs-5 .fw-200 }
41-
42-
The app can stop or start the climate in the car, so you can pre-warm or pre-cool the car. Click on the current climate status and choose warm/cool/off.
43-
{: .fs-5 .fw-200 }
17+
[Multiple widget sizes are available](./widgets.md), data displayed varies based on the size available, but common items include:
18+
{: .fs-5 .fw-300 }
4419

45-
**Lock / Unlock**
46-
{: .fs-5 .fw-200 }
20+
- Current battery state of charge
21+
- Icons to indicate charging, or charger connected
22+
- If charging, day/time charging will complete and the power level the car is charging at
23+
- Last date/time the car was queried for its current state
24+
{: .fs-4 .fw-300 }
4725

48-
The app can lock of un-lock the car. Click on the current lock status and choose lock or un-lock.
49-
{: .fs-5 .fw-200 }
26+
Using the main app and through the [IOS Control Center](./control-center.md) you can:
27+
{: .fs-5 .fw-300 }
5028

29+
- Lock and Unlock the car
30+
- Pre warm/cool the car or use your own preset climate configurations
31+
- Start and Stop charging of the car
32+
- Change charge limits using your own pre-defined charge limit configurations
33+
{: .fs-5 .fw-300 }
5134

35+
The app also supports the use of [Siri Shortcuts](./siri.md), allowing you to ask siri to ***"get the status of the car"***, or ***"start warming the car"***. See the Siri Shortcuts section for more info.
36+
{: .fs-5 .fw-300 }
5237

5338
----

docs/pages/install.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,13 @@ nav_order: 4
77
# Install Guide
88
{: .fs-9 }
99

10-
Bluelink Scriptable is a "scriptable app". Its written in Javascript and runs within the scriptable IOS app. Using scriptable meant a vastly reduced amount of development time was required, and no pesky app store rejections (due to the use of the Bluelink API, technically this is against the terms and conditions of Bluelink)
10+
Bluelink Scriptable is a "scriptable app". Its written in Javascript and runs within the [scriptable IOS app](https://scriptable.app/). Using scriptable meant a vastly reduced amount of development time was required, and no pesky app store rejections
1111
{: .fs-5 .fw-300 }
1212

13-
As such, installation is a little more than just "install an app" but honestly not that much more:
13+
As such, installation is a couple more test than just "install an app". However once installed the app will prompt and auto-install new versions as they are released!.
14+
{: .fs-5 .fw-300 }
15+
16+
## Install Steps
1417

1518
Step 1: [Install the scriptable app](https://apps.apple.com/us/app/scriptable/id1405459188?uo=4)
1619
and open it.

src/about.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,9 @@ const upgrade = connect(({ state: { currentVersion, release } }) => {
144144
const fm = FileManager.iCloud()
145145
// try to backup current script - log errors, script could have been renamed for example
146146
try {
147+
if (fm.fileExists(`${SCRIPTABLE_DIR}/${release.assetName}.backup`)) {
148+
fm.remove(`${SCRIPTABLE_DIR}/${release.assetName}.backup`)
149+
}
147150
fm.move(`${SCRIPTABLE_DIR}/${release.assetName}`, `${SCRIPTABLE_DIR}/${release.assetName}.backup`)
148151
} catch (e) {
149152
logger.log(`Failed to backup current script: ${e}`)

src/widget.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ export async function createMediumWidget(config: Config, bl: Bluelink) {
157157

158158
// define widget and set date for when the next refresh should not occur before.
159159
const widget = new ListWidget()
160-
widget.setPadding(20, 10, 20, 15)
160+
widget.setPadding(20, 5, 20, 15)
161161
widget.refreshAfterDate = refresh.nextRefresh
162162

163163
const mainStack = widget.addStack()

0 commit comments

Comments
 (0)