Skip to content

Commit 3c4bdc0

Browse files
committed
doc updates
1 parent 757cdfc commit 3c4bdc0

File tree

5 files changed

+42
-8
lines changed

5 files changed

+42
-8
lines changed

docs/_config.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,10 @@ plugins:
5656
# - vendor/cache/
5757
# - vendor/gems/
5858
# - vendor/ruby/
59+
callouts:
60+
warning:
61+
title: Warning
62+
color: red
63+
info:
64+
title: Info
65+
color: blue

docs/pages/automations.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,13 @@ Below are a few example automations, and downloadable Shortcut scripts. The prov
2020

2121
### Walk Away Lock
2222

23+
{: .warning-title }
24+
> Warning: You can lock yourself out of your car with this feature
25+
>
26+
> Locking via bluelink always locks regardless of your keys location. Thus auto-locking via bluelink means if you turn off the car, leave your keys in the car and leave the car - with the doors closed - you can get locked out.
27+
>
28+
> If using this feature never leave the car without one of your keys or your phone with the app installed (so you can un-lock when needed)
29+
2330
This automation will send a lock command to the car, after a delay. The triggering event can either be disconnecting from CarPlay or disconnecting from the Car's Bluetooth.
2431

2532
[Install "Auto Lock Car" Shortcut](https://www.icloud.com/shortcuts/2b49acde29904725b31c64f8195074ce)

docs/pages/install.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,15 @@ 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](https://scriptable.app/). Using scriptable meant a vastly reduced amount of development time was required, and no pesky app store rejections
11-
{: .fs-5 .fw-300 }
10+
{: .info-title }
11+
> This is not an "App Store" app
12+
>
13+
> Bluelink Scriptable is a "scriptable app". Its a "script" runs within the [scriptable IOS app](https://scriptable.app/), think of it as an app within a app. This means you install the scriptable app from the app store and then download the JS (Javascript) file into the scriptable directory on your phone.
14+
>
15+
>Using scriptable meant a vastly reduced amount of development time was required, no pesky app store rejections and quick fix times when Hyundai or Kia change their APIs! You still get close to the look and feel of a native app including widgets, Automations, Siri support and more!
16+
1217

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!.
18+
Instalation is a one time process. Once installed the app will prompt you when updates are released. The app includes a one-click upgrade process for ease of use.
1419
{: .fs-5 .fw-300 }
1520

1621
## Install Steps

docs/pages/multi-car.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,23 @@ nav_order: 7
77
# Multiple Car Support
88
{: .fs-9 }
99

10-
Since v1.2.0 the app supports the ability to have multiple cars configured (one per app script) with dedicated configuration per script created within Scriptable. This gives you the ability to have multiple widgets, each a car dedicated to each widget - with one-click access to perform car functions.
10+
{: .info-title }
11+
> Multiple Widgets one for each of your EVs.
12+
>
13+
> For households with more than one Hyundai or Kia EV you can effectively run multiple copies of the egmp-bluelink app, each one configured to fetch data on a specifically targeted car.
14+
>
15+
> Each car requires its own configuration and can be within the same Bluelink account or across different accounts or even Manufacturers
1116
{: .fs-5 .fw-300 }
1217

1318
## Enabling Multi-Car Support
1419

15-
First setup the [script as normal](./install.md) for your first car. Ensure you specify the correct VIN within the settings for the car you wish to setup, enable the "Multi Car" setting if you have previously used older versions of the app than v1.2.0 - if you hadnt this setting is not needed.
20+
Since v1.2.0 multi-car support is enabled by default. Simply setup the [script as normal](./install.md) for your first car.
1621
{: .fs-5 .fw-300 }
1722

1823
Once setup, within the Scriptable app press and hold the "egmp-bluelink" row and select "Duplicate", this will bring up a code window - just click on "done". This will produce a script likely called "egmp-bluelink 1", feel free to rename to something more appropiate (press and hold and choose rename)
1924
{: .fs-5 .fw-300 }
2025

21-
Now open the new script, it will prompt for Bluelink settings as per the first install, proceed to configure the same settings but this time select the second car's VIN. Once setup you can configure a new widget for this second car - just ensure when you configure the widget you select the new scriptable script.
26+
Now open the new script, it will prompt for Bluelink settings as per the first install, proceed to configure the same settings but your second car. Once setup you can configure a new widget for this second car - just ensure when you configure the widget you select the new scriptable script.
2227
{: .fs-5 .fw-300 }
2328

2429

docs/pages/widgets.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,20 @@ nav_order: 2
77
# Widget Support
88
{: .fs-9 }
99

10-
Bluelink Scriptable supports two sizes of both Lockscreen and Homescreen widgets. All widgets provide single click access to the main app and all widgets will auto-update in the background.
10+
Bluelink Scriptable supports both Lockscreen and Homescreen widgets.
1111
{: .fs-6 .fw-300 }
1212

13-
It should be noted that there is a optional opt-in setting within the Settings screen called "Enable widget remote refresh" once enabled, the auto-updating of widget data will include sending intermittent remote status commands to the car. This is required to get the latest data from the car directly vs cached data from the Bluelink servers.
13+
All widgets provide single click access to the main app and all widgets allow for auto-updating of car data in the background.
14+
{: .fs-5 .fw-300 }
15+
16+
{: .info-title }
17+
> Remote Widget Refresh
18+
>
19+
> It should be noted that auto-updating of car data is "opt-in" you are required to check the setting "Enable widget remote refresh" in the settings screen to enable this feature. This feature will auto send intermittent remote status commands to the car to obtain up-to date data on the status of your car.
20+
>
21+
> This is required to get the latest data from the car directly, without enabiling this setting it is likely your widget will always display stale data.
22+
>
23+
> 12V battery drain can occur if you send too many remote refresh commands. The defaults set in the app are very conservative for this reason. Only play with the advanced widget settings if you understand the potential consequences of sending too many commands.
1424
{: .fs-5 .fw-300 }
1525

1626
## Home Screen Widgets

0 commit comments

Comments
 (0)