Skip to content

[teslascope] Remove deprecated apiKey support #21396

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lsiepel merged 4 commits into from
Aug 18, 2026
Merged

[teslascope] Remove deprecated apiKey support #21396

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
93eda08
Remove apiKey support
psmedley Aug 15, 2026
408c866
Update i18n
psmedley Aug 15, 2026
f6897b7
Fix review comment
psmedley Aug 15, 2026
5be37a4
Update README.md
psmedley Aug 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions bundles/org.openhab.binding.teslascope/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,11 @@ Account configuration is necessary.
The easiest way to do this is from the UI.
Just add a new Thing, select the Teslascope binding, then Teslascope Account Binding Thing, and enter the personalAccessToken which can be generated from the Teslascope website.

As a minimum, the personalAccessToken or API key (deprecated) is needed:
As a minimum, the personalAccessToken is needed:
Comment thread
psmedley marked this conversation as resolved.

| Thing Parameter | Default Value | Required | Advanced | Description |
|---------------------|---------------|----------|----------|--------------------------------------------------------------------------------------|
| apiKey | N/A | No | No | API Key from the Teslascope website (deprecated) |
| personalAccessToken | N/A | No | No | Personal Access Token generated from the Teslascope website |
| personalAccessToken | N/A | Yes | No | Personal Access Token generated from the Teslascope website |
| refreshInterval | 60 | No | Yes | The frequency with which to refresh information from Teslascope specified in seconds |

## `vehicle` Thing Configuration
Expand Down
5 changes: 0 additions & 5 deletions ...src/main/java/org/openhab/binding/teslascope/internal/TeslascopeAccountConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,6 @@
*/
@NonNullByDefault
public class TeslascopeAccountConfiguration {
/**
* Teslascope is phasing out support for apiKey in lieu of Personal Access Tokens
*/
@Deprecated
public String apiKey = "";
public String personalAccessToken = "";
public int refreshInterval = 60;
}
14 changes: 5 additions & 9 deletions ...scope/src/main/java/org/openhab/binding/teslascope/internal/TeslascopeAccountHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
TeslascopeAccountConfiguration config = this.config;
if (config != null) {
try {
return webTargets.getVehicleList(config.apiKey, config.personalAccessToken);
return webTargets.getVehicleList(config.personalAccessToken);
} catch (TeslascopeAuthenticationException e) {
updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR,
"Authentication problem: " + e.getMessage());
Expand All @@ -85,7 +85,7 @@
throws TeslascopeCommunicationException, TeslascopeAuthenticationException {
TeslascopeAccountConfiguration config = this.config;
if (config != null) {
return webTargets.getDetailedInformation(publicID, config.apiKey, config.personalAccessToken);
return webTargets.getDetailedInformation(publicID, config.personalAccessToken);
}
return "";
}
Expand All @@ -94,15 +94,15 @@
throws TeslascopeCommunicationException, TeslascopeAuthenticationException {
TeslascopeAccountConfiguration config = this.config;
if (config != null) {
webTargets.sendCommand(publicID, config.apiKey, config.personalAccessToken, command);
webTargets.sendCommand(publicID, config.personalAccessToken, command);
}
}

public void sendCommand(String publicID, String command, String params)
throws TeslascopeCommunicationException, TeslascopeAuthenticationException {
TeslascopeAccountConfiguration config = this.config;
if (config != null) {
webTargets.sendCommand(publicID, config.apiKey, config.personalAccessToken, command, params);
webTargets.sendCommand(publicID, config.personalAccessToken, command, params);
}
}

Expand All @@ -114,11 +114,7 @@
@Override
public void initialize() {
TeslascopeAccountConfiguration localConfig = config = getConfigAs(TeslascopeAccountConfiguration.class);
if (!localConfig.apiKey.isBlank() && localConfig.personalAccessToken.isBlank()) {
logger.warn(
"ApiKey is deprecated and is expected to stop working in late 2026. Please migrate to a Personal Access Token.");
}
if (localConfig.apiKey.isBlank() && localConfig.personalAccessToken.isBlank()) {
if (localConfig.personalAccessToken.isBlank()) {
updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR,
"@text/offline.conf-error.no-credentials");
return;
Expand All @@ -140,7 +136,7 @@
private void pollStatus() {
String responseVehicleList = getVehicleList();

if (responseVehicleList == null || responseVehicleList.isBlank()) {

Check warning on line 139 in bundles/org.openhab.binding.teslascope/src/main/java/org/openhab/binding/teslascope/internal/TeslascopeAccountHandler.java

View workflow job for this annotation

GitHub Actions / Build (Java 21, ubuntu-24.04) 

Null comparison always yields false: The variable responseVehicleList cannot be null at this location
return; // Status is already updated to OFFLINE in getVehicleList()
}

Expand Down
45 changes: 12 additions & 33 deletions ...eslascope/src/main/java/org/openhab/binding/teslascope/internal/TeslascopeWebTargets.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,53 +45,32 @@
this.httpClient = httpClient;
}

public String getVehicleList(String apiKey, String personalAccessToken)
public String getVehicleList(String personalAccessToken)
throws TeslascopeCommunicationException, TeslascopeAuthenticationException {
if (personalAccessToken.isBlank()) {
return invoke(BASE_URI + "vehicles?api_key=" + apiKey, HttpMethod.GET, "");
} else {
return invoke(BASE_URI + "vehicles", HttpMethod.GET, personalAccessToken);
}
return invoke(BASE_URI + "vehicles", HttpMethod.GET, personalAccessToken);
}

public String getDetailedInformation(String publicID, String apiKey, String personalAccessToken)
public String getDetailedInformation(String publicID, String personalAccessToken)
throws TeslascopeCommunicationException, TeslascopeAuthenticationException {
if (personalAccessToken.isBlank()) {
return invoke(BASE_VEHICLE_URI + publicID + "/detailed?api_key=" + apiKey, HttpMethod.GET, "");
} else {
return invoke(BASE_VEHICLE_URI + publicID + "/detailed", HttpMethod.GET, personalAccessToken);
}
return invoke(BASE_VEHICLE_URI + publicID + "/detailed", HttpMethod.GET, personalAccessToken);
}

public void sendCommand(String publicID, String apiKey, String personalAccessToken, String command)
public void sendCommand(String publicID, String personalAccessToken, String command)
throws TeslascopeCommunicationException, TeslascopeAuthenticationException {
if (personalAccessToken.isBlank()) {
invoke(BASE_VEHICLE_URI + publicID + "/command/" + command + "?api_key=" + apiKey, HttpMethod.POST, "");
} else {
invoke(BASE_VEHICLE_URI + publicID + "/command/" + command, HttpMethod.POST, personalAccessToken);
}
invoke(BASE_VEHICLE_URI + publicID + "/command/" + command, HttpMethod.POST, personalAccessToken);
return;
}

public void sendCommand(String publicID, String apiKey, String personalAccessToken, String command, String params)
public void sendCommand(String publicID, String personalAccessToken, String command, String params)
throws TeslascopeCommunicationException, TeslascopeAuthenticationException {
String cleanParams = (params == null) ? "" : params.replaceFirst("^[?&]", "");

Check warning on line 66 in bundles/org.openhab.binding.teslascope/src/main/java/org/openhab/binding/teslascope/internal/TeslascopeWebTargets.java

View workflow job for this annotation

GitHub Actions / Build (Java 21, ubuntu-24.04) 

Redundant null check: comparing '@nonnull String' against null

if (personalAccessToken.isBlank()) {
// Legacy API Key method (needs & separator because ? is already used)
String url = BASE_VEHICLE_URI + publicID + "/command/" + command + "?api_key=" + apiKey;
if (!cleanParams.isEmpty()) {
url += "&" + cleanParams;
}
invoke(url, HttpMethod.POST, "");
} else {
// Personal Access Token method (needs ? separator)
String url = BASE_VEHICLE_URI + publicID + "/command/" + command;
if (!cleanParams.isEmpty()) {
url += "?" + cleanParams;
}
invoke(url, HttpMethod.POST, personalAccessToken);
// Personal Access Token method (needs ? separator)
String url = BASE_VEHICLE_URI + publicID + "/command/" + command;
if (!cleanParams.isEmpty()) {
url += "?" + cleanParams;
}
invoke(url, HttpMethod.POST, personalAccessToken);
}

private String invoke(String uri, HttpMethod method, String personalAccessToken)
Expand Down
4 changes: 0 additions & 4 deletions bundles/org.openhab.binding.teslascope/src/main/resources/OH-INF/i18n/teslascope.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ thing-type.teslascope.vehicle.description = Access to Tesla Vehicle data via the

# thing types config

thing-type.config.teslascope.account.apiKey.label = apiKey
thing-type.config.teslascope.account.apiKey.description = apiKey provided by Teslascope (Deprecated - use Personal Access Token instead)
thing-type.config.teslascope.account.personalAccessToken.label = Personal Access Token
thing-type.config.teslascope.account.personalAccessToken.description = Personal Access Token provided by Teslascope
thing-type.config.teslascope.account.refreshInterval.label = Refresh Interval
Expand Down Expand Up @@ -197,8 +195,6 @@ thing-type.teslascope.service.description = Access to Tesla Vehicle data via the

# thing types config

thing-type.config.teslascope.service.apiKey.label = apiKey
thing-type.config.teslascope.service.apiKey.description = apiKey provided by Teslascope
thing-type.config.teslascope.service.publicID.label = Vehicle Public ID
thing-type.config.teslascope.service.publicID.description = Vehicle public ID listed in Teslascope
thing-type.config.teslascope.service.refreshInterval.label = Refresh Interval
Expand Down
6 changes: 1 addition & 5 deletions bundles/org.openhab.binding.teslascope/src/main/resources/OH-INF/thing/thing-types.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,7 @@
<description>Access to Tesla Vehicle data via the Teslascope developer API</description>
<semantic-equipment-tag>WebService</semantic-equipment-tag>
<config-description>
<parameter name="apiKey" type="text" required="false">
<label>apiKey</label>
<description>apiKey provided by Teslascope (Deprecated - use Personal Access Token instead)</description>
</parameter>
<parameter name="personalAccessToken" type="text" required="false">
<parameter name="personalAccessToken" type="text" required="true">
<label>Personal Access Token</label>
<description>Personal Access Token provided by Teslascope</description>
</parameter>
Expand Down
Loading