Skip to content
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

[tesla] Add channels for software update #15816

Merged
merged 13 commits into from
Nov 1, 2023
Merged

[tesla] Add channels for software update #15816

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
35d5b78
[tesla] Add value holders for Software Update state
hakan42 Oct 28, 2023
66442d0
[tesla] Add channels for software update, including a switch for avai…
hakan42 Oct 28, 2023
5143107
[tesla] Update instructions for software update channels
hakan42 Oct 28, 2023
bd6ad93
[tesla] Update documentation for software update channels
hakan42 Oct 28, 2023
05ad0e2
[tesla] Review comment - keep 'version' as a property, not channel
hakan42 Oct 28, 2023
a8d58fc
Update bundles/org.openhab.binding.tesla/src/main/resources/OH-INF/th…
hakan42 Oct 29, 2023
2d5cbdc
Update bundles/org.openhab.binding.tesla/src/main/resources/OH-INF/th…
hakan42 Oct 29, 2023
3225f85
Update bundles/org.openhab.binding.tesla/src/main/resources/OH-INF/th…
hakan42 Oct 29, 2023
2a0fb83
[tesla] regenerated i18n files after review comments
hakan42 Oct 29, 2023
3b78b22
[tesla] Removed superflous softwareversion channel description, as it…
hakan42 Oct 29, 2023
0132d1d
Update bundles/org.openhab.binding.tesla/README.md
kaikreuzer Nov 1, 2023
3e1ad6c
Update bundles/org.openhab.binding.tesla/README.md
kaikreuzer Nov 1, 2023
a050024
Update bundles/org.openhab.binding.tesla/README.md
kaikreuzer Nov 1, 2023
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: 4 additions & 1 deletion bundles/org.openhab.binding.tesla/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,9 +182,12 @@ Additionally, these advanced channels are available (not all are available on al
| shiftstate | String | Shift State | Indicates the state of the transmission, “P”, “D”, “R”, or “N” |
| sidemirrorheaters | Switch | Side Mirror Heaters | Indicates if the side mirror heaters are switched on |
| smartpreconditioning | Switch | Smart Preconditioning | Indicates if smart preconditioning is switched on |
| softwareupdateavailable | Switch | Update Available | Car Software update available, automatically generated on non-empty "update version" |
kaikreuzer marked this conversation as resolved.
Show resolved Hide resolved
| softwareupdatestatus | String | Update Status | Car Software update status, e.g. "downloading_wifi_wait", "installing" |
kaikreuzer marked this conversation as resolved.
Show resolved Hide resolved
| softwareupdateversion | String | Update version | Car software version to update to, e.g. "2023.32.9" or empty |
kaikreuzer marked this conversation as resolved.
Show resolved Hide resolved
| soc | Number | State of Charge | State of Charge, in % |
| state | String | State | “online”, “asleep”, “waking” |
| steeringwheelheater | Switch | Steering Wheel Heater | Turns On/Off the steering wheel heater |
| steeringwheelheater | Switch | Steering Wheel Heater | Turns On/Off the steering wheel heater |
| sunroofstate | String | Sunroof State | Valid states are “unknown”, “open”, “closed”, “vent”, “comfort”. Accepts commands "close" and "vent". |
| sunroof | Dimmer | Sunroof | Indicates the opening state of the sunroof (0% closed, 100% fully open) |
| temperature | Number:Temperature | Temperature | Set the temperature of the autoconditioning system. The temperature for the driver and passenger will be synced. |
Expand Down
2 changes: 2 additions & 0 deletions ...binding.tesla/src/main/java/org/openhab/binding/tesla/internal/TeslaBindingConstants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,8 @@ public enum EventKeys {
public static final String CHANNEL_COMBINED_TEMP = "combinedtemp";
public static final String CHANNEL_EVENTSTAMP = "eventstamp";

public static final String CHANNEL_SOFTWARE_UPDATE_AVAILABLE = "softwareupdateavailable";

// thing configurations
public static final String CONFIG_ALLOWWAKEUP = "allowWakeup";
public static final String CONFIG_ALLOWWAKEUPFORCOMMANDS = "allowWakeupForCommands";
Expand Down
2 changes: 2 additions & 0 deletions ...ing.tesla/src/main/java/org/openhab/binding/tesla/internal/TeslaChannelSelectorProxy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -933,6 +933,8 @@ public State getState(String s, TeslaChannelSelectorProxy proxy, Map<String, Str
}
},
SOC("soc", "soc", PercentType.class, false),
SOFTWARE_UPDATE_STATUS("status", "softwareupdatestatus", StringType.class, false),
SOFTWARE_UPDATE_VERSION("version", "softwareupdateversion", StringType.class, false),
SPEED("speed", "speed", DecimalType.class, false) {
@Override
public State getState(String s, TeslaChannelSelectorProxy proxy, Map<String, String> properties) {
Expand Down
12 changes: 12 additions & 0 deletions ...g.tesla/src/main/java/org/openhab/binding/tesla/internal/handler/TeslaVehicleHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
import org.openhab.binding.tesla.internal.protocol.DriveState;
import org.openhab.binding.tesla.internal.protocol.Event;
import org.openhab.binding.tesla.internal.protocol.GUIState;
import org.openhab.binding.tesla.internal.protocol.SoftwareUpdate;
import org.openhab.binding.tesla.internal.protocol.Vehicle;
import org.openhab.binding.tesla.internal.protocol.VehicleData;
import org.openhab.binding.tesla.internal.protocol.VehicleState;
Expand Down Expand Up @@ -111,6 +112,7 @@ public class TeslaVehicleHandler extends BaseThingHandler {
protected VehicleState vehicleState;
protected ChargeState chargeState;
protected ClimateState climateState;
protected SoftwareUpdate softwareUpdate;

protected boolean allowWakeUp;
protected boolean allowWakeUpForCommands;
Expand Down Expand Up @@ -922,6 +924,8 @@ public void parseAndUpdate(String request, String payLoad, String result) {
(climateState.driver_temp_setting + climateState.passenger_temp_setting) / 2.0f));
updateState(CHANNEL_COMBINED_TEMP, new QuantityType<>(avgtemp, SIUnits.CELSIUS));

softwareUpdate = vehicleState.software_update;

try {
lock.lock();

Expand All @@ -932,6 +936,8 @@ public void parseAndUpdate(String request, String payLoad, String result) {
entrySet.addAll(gson.toJsonTree(vehicleState, VehicleState.class).getAsJsonObject().entrySet());
entrySet.addAll(gson.toJsonTree(chargeState, ChargeState.class).getAsJsonObject().entrySet());
entrySet.addAll(gson.toJsonTree(climateState, ClimateState.class).getAsJsonObject().entrySet());
entrySet.addAll(
gson.toJsonTree(softwareUpdate, SoftwareUpdate.class).getAsJsonObject().entrySet());

for (Map.Entry<String, JsonElement> entry : entrySet) {
try {
Expand Down Expand Up @@ -966,6 +972,12 @@ public void parseAndUpdate(String request, String payLoad, String result) {
e.getMessage(), e);
}
}

if (softwareUpdate.version == null || softwareUpdate.version.isBlank()) {
updateState(CHANNEL_SOFTWARE_UPDATE_AVAILABLE, OnOffType.OFF);
} else {
updateState(CHANNEL_SOFTWARE_UPDATE_AVAILABLE, OnOffType.ON);
}
} finally {
lock.unlock();
}
Expand Down
31 changes: 31 additions & 0 deletions ...nding.tesla/src/main/java/org/openhab/binding/tesla/internal/protocol/SoftwareUpdate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
/**
* Copyright (c) 2010-2023 Contributors to the openHAB project
*
* See the NOTICE file(s) distributed with this work for additional
* information.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.openhab.binding.tesla.internal.protocol;

/**
* The {@link SoftwareUpdate} is a datastructure to capture
* variables sent by the Tesla Vehicle
*
* @author Hakan Tandogan - Initial contribution
*/
public class SoftwareUpdate {

public int download_perc;
public int expected_duration_sec;
public int install_perc;
public String status;
public String version;

SoftwareUpdate() {
}
}
2 changes: 2 additions & 0 deletions ...binding.tesla/src/main/java/org/openhab/binding/tesla/internal/protocol/VehicleState.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ public class VehicleState {
public String vehicle_name;
public String wheel_type;

public SoftwareUpdate software_update;

VehicleState() {
}
}
11 changes: 11 additions & 0 deletions bundles/org.openhab.binding.tesla/src/main/resources/OH-INF/i18n/tesla.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,6 +322,12 @@ channel-type.tesla.smartpreconditioning.label = Smart Preconditioning
channel-type.tesla.smartpreconditioning.description = Indicates if smart preconditioning is switched on
channel-type.tesla.soc.label = State of Charge
channel-type.tesla.soc.description = State of Charge, in %
channel-type.tesla.softwareupdateavailable.label = Update Available
channel-type.tesla.softwareupdateavailable.description = Car Software update available
channel-type.tesla.softwareupdatestatus.label = Update Status
channel-type.tesla.softwareupdatestatus.description = Car Software update status
channel-type.tesla.softwareupdateversion.label = Update version
channel-type.tesla.softwareupdateversion.description = Car software version to update to
channel-type.tesla.speed.label = Speed
channel-type.tesla.speed.description = Vehicle speed
channel-type.tesla.state.label = State
Expand Down Expand Up @@ -352,3 +358,8 @@ channel-type.tesla.wakeup.label = Wake Up
channel-type.tesla.wakeup.description = Wake up the vehicle from a (deep) sleep
channel-type.tesla.wiperbladeheater.label = Wiperblade Heater
channel-type.tesla.wiperbladeheater.description = Indicates if the wiperblade heater is switched on

# channel types

channel-type.tesla.softwareversion.label = Software version
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Think the i18n files need to be regenerated.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done and pushed.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What am i missing, i would not expect this as software version is no longer a channel, but a property as it was before.

channel-type.tesla.softwareversion.description = Current software version of the car
18 changes: 18 additions & 0 deletions bundles/org.openhab.binding.tesla/src/main/resources/OH-INF/thing/channels.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,24 @@
xmlns:thing="https://openhab.org/schemas/thing-description/v1.0.0"
xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">

<channel-type id="softwareupdateavailable">
<item-type>Switch</item-type>
<label>Update Available</label>
<description>Car Software update available</description>
hakan42 marked this conversation as resolved.
Show resolved Hide resolved
<state readOnly="true"></state>
</channel-type>
<channel-type id="softwareupdatestatus">
lsiepel marked this conversation as resolved.
Show resolved Hide resolved
<item-type>String</item-type>
<label>Update Status</label>
<description>Car Software update status</description>
hakan42 marked this conversation as resolved.
Show resolved Hide resolved
<state readOnly="true"></state>
</channel-type>
<channel-type id="softwareupdateversion">
<item-type>String</item-type>
<label>Update version</label>
hakan42 marked this conversation as resolved.
Show resolved Hide resolved
<description>Car software version to update to</description>
<state readOnly="true"></state>
</channel-type>
<channel-type id="destinationname">
<item-type>String</item-type>
<label>Route Destination</label>
Expand Down
5 changes: 4 additions & 1 deletion bundles/org.openhab.binding.tesla/src/main/resources/OH-INF/thing/model3.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,9 @@
<channel id="sidemirrorheaters" typeId="sidemirrorheaters"/>
<channel id="smartpreconditioning" typeId="smartpreconditioning"/>
<channel id="soc" typeId="soc"/>
<channel id="softwareupdateavailable" typeId="softwareupdateavailable"/>
<channel id="softwareupdatestatus" typeId="softwareupdatestatus"/>
<channel id="softwareupdateversion" typeId="softwareupdateversion"/>
<channel id="speed" typeId="speed"/>
<channel id="state" typeId="state"/>
<channel id="steeringwheelheater" typeId="steeringwheelheater"/>
Expand All @@ -126,7 +129,7 @@
</channels>

<properties>
<property name="thingTypeVersion">1</property>
<property name="thingTypeVersion">2</property>
</properties>

<config-description>
Expand Down
5 changes: 4 additions & 1 deletion bundles/org.openhab.binding.tesla/src/main/resources/OH-INF/thing/models.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,9 @@
<channel id="sidemirrorheaters" typeId="sidemirrorheaters"/>
<channel id="smartpreconditioning" typeId="smartpreconditioning"/>
<channel id="soc" typeId="soc"/>
<channel id="softwareupdateavailable" typeId="softwareupdateavailable"/>
<channel id="softwareupdatestatus" typeId="softwareupdatestatus"/>
<channel id="softwareupdateversion" typeId="softwareupdateversion"/>
<channel id="speed" typeId="speed"/>
<channel id="state" typeId="state"/>
<channel id="steeringwheelheater" typeId="steeringwheelheater"/>
Expand All @@ -132,7 +135,7 @@
</channels>

<properties>
<property name="thingTypeVersion">1</property>
<property name="thingTypeVersion">2</property>
</properties>

<config-description>
Expand Down
5 changes: 4 additions & 1 deletion bundles/org.openhab.binding.tesla/src/main/resources/OH-INF/thing/modelx.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,9 @@
<channel id="sidemirrorheaters" typeId="sidemirrorheaters"/>
<channel id="smartpreconditioning" typeId="smartpreconditioning"/>
<channel id="soc" typeId="soc"/>
<channel id="softwareupdateavailable" typeId="softwareupdateavailable"/>
<channel id="softwareupdatestatus" typeId="softwareupdatestatus"/>
<channel id="softwareupdateversion" typeId="softwareupdateversion"/>
<channel id="speed" typeId="speed"/>
<channel id="state" typeId="state"/>
<channel id="steeringwheelheater" typeId="steeringwheelheater"/>
Expand All @@ -132,7 +135,7 @@
</channels>

<properties>
<property name="thingTypeVersion">1</property>
<property name="thingTypeVersion">2</property>
</properties>

<config-description>
Expand Down
5 changes: 4 additions & 1 deletion bundles/org.openhab.binding.tesla/src/main/resources/OH-INF/thing/modely.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,9 @@
<channel id="smartpreconditioning" typeId="smartpreconditioning"/>
<channel id="steeringwheelheater" typeId="steeringwheelheater"/>
<channel id="soc" typeId="soc"/>
<channel id="softwareupdateavailable" typeId="softwareupdateavailable"/>
<channel id="softwareupdatestatus" typeId="softwareupdatestatus"/>
<channel id="softwareupdateversion" typeId="softwareupdateversion"/>
<channel id="speed" typeId="speed"/>
<channel id="state" typeId="state"/>
<channel id="combinedtemp" typeId="combinedtemp"/>
Expand All @@ -128,7 +131,7 @@
</channels>

<properties>
<property name="thingTypeVersion">1</property>
<property name="thingTypeVersion">2</property>
</properties>

<config-description>
Expand Down
48 changes: 48 additions & 0 deletions bundles/org.openhab.binding.tesla/src/main/resources/OH-INF/update/instructions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,18 @@
<type>tesla:trafficminutesdelay</type>
</add-channel>
</instruction-set>

<instruction-set targetVersion="2">
<add-channel id="softwareupdateavailable" typeId="softwareupdateavailable">
<type>tesla:softwareupdateavailable</type>
</add-channel>
<add-channel id="softwareupdatestatus" typeId="softwareupdatestatus">
<type>tesla:softwareupdatestatus</type>
</add-channel>
<add-channel id="softwareupdateversion" typeId="softwareupdateversion">
<type>tesla:softwareupdateversion</type>
</add-channel>
</instruction-set>
</thing-type>

<thing-type uid="tesla:models">
Expand All @@ -41,6 +53,18 @@
<type>tesla:trafficminutesdelay</type>
</add-channel>
</instruction-set>

<instruction-set targetVersion="2">
<add-channel id="softwareupdateavailable" typeId="softwareupdateavailable">
<type>tesla:softwareupdateavailable</type>
</add-channel>
<add-channel id="softwareupdatestatus" typeId="softwareupdatestatus">
<type>tesla:softwareupdatestatus</type>
</add-channel>
<add-channel id="softwareupdateversion" typeId="softwareupdateversion">
<type>tesla:softwareupdateversion</type>
</add-channel>
</instruction-set>
</thing-type>

<thing-type uid="tesla:modelx">
Expand All @@ -61,6 +85,18 @@
<type>tesla:trafficminutesdelay</type>
</add-channel>
</instruction-set>

<instruction-set targetVersion="2">
<add-channel id="softwareupdateavailable" typeId="softwareupdateavailable">
<type>tesla:softwareupdateavailable</type>
</add-channel>
<add-channel id="softwareupdatestatus" typeId="softwareupdatestatus">
<type>tesla:softwareupdatestatus</type>
</add-channel>
<add-channel id="softwareupdateversion" typeId="softwareupdateversion">
<type>tesla:softwareupdateversion</type>
</add-channel>
</instruction-set>
</thing-type>

<thing-type uid="tesla:modely">
Expand All @@ -81,5 +117,17 @@
<type>tesla:trafficminutesdelay</type>
</add-channel>
</instruction-set>

<instruction-set targetVersion="2">
<add-channel id="softwareupdateavailable" typeId="softwareupdateavailable">
<type>tesla:softwareupdateavailable</type>
</add-channel>
<add-channel id="softwareupdatestatus" typeId="softwareupdatestatus">
<type>tesla:softwareupdatestatus</type>
</add-channel>
<add-channel id="softwareupdateversion" typeId="softwareupdateversion">
<type>tesla:softwareupdateversion</type>
</add-channel>
</instruction-set>
</thing-type>
</update:update-descriptions>