com.highmobility.autoapi.Climate Maven / Gradle / Ivy
/*
* The MIT License
*
* Copyright (c) 2014- High-Mobility GmbH (https://high-mobility.com)
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.highmobility.autoapi;
import com.highmobility.autoapi.property.Property;
import com.highmobility.autoapi.value.ActiveState;
import com.highmobility.autoapi.value.HvacWeekdayStartingTime;
import com.highmobility.autoapi.value.measurement.Temperature;
import com.highmobility.value.Bytes;
import java.util.ArrayList;
import java.util.List;
import javax.annotation.Nullable;
/**
* The Climate capability
*/
public class Climate {
public static final int IDENTIFIER = Identifier.CLIMATE;
public static final byte PROPERTY_INSIDE_TEMPERATURE = 0x01;
public static final byte PROPERTY_OUTSIDE_TEMPERATURE = 0x02;
public static final byte PROPERTY_DRIVER_TEMPERATURE_SETTING = 0x03;
public static final byte PROPERTY_PASSENGER_TEMPERATURE_SETTING = 0x04;
public static final byte PROPERTY_HVAC_STATE = 0x05;
public static final byte PROPERTY_DEFOGGING_STATE = 0x06;
public static final byte PROPERTY_DEFROSTING_STATE = 0x07;
public static final byte PROPERTY_IONISING_STATE = 0x08;
public static final byte PROPERTY_DEFROSTING_TEMPERATURE_SETTING = 0x09;
public static final byte PROPERTY_HVAC_WEEKDAY_STARTING_TIMES = 0x0b;
public static final byte PROPERTY_REAR_TEMPERATURE_SETTING = 0x0c;
/**
* Get Climate property availability information.
*/
public static class GetStateAvailability extends GetAvailabilityCommand {
/**
* Get every Climate property availability
*/
public GetStateAvailability() {
super(IDENTIFIER);
}
/**
* Get specific Climate property availabilities
*
* @param propertyIdentifiers The property identifierBytes
*/
public GetStateAvailability(Bytes propertyIdentifiers) {
super(IDENTIFIER, propertyIdentifiers);
}
/**
* Get specific Climate property availabilities
*
* @param propertyIdentifiers The property identifierBytes
*/
public GetStateAvailability(byte... propertyIdentifiers) {
super(IDENTIFIER, new Bytes(propertyIdentifiers));
}
GetStateAvailability(byte[] bytes, @SuppressWarnings("unused") boolean fromRaw) throws CommandParseException {
super(bytes);
}
}
/**
* Get Climate properties
*/
public static class GetState extends GetCommand {
/**
* Get all Climate properties
*/
public GetState() {
super(State.class, IDENTIFIER);
}
/**
* Get specific Climate properties
*
* @param propertyIdentifiers The property identifiers
*/
public GetState(Bytes propertyIdentifiers) {
super(State.class, IDENTIFIER, propertyIdentifiers);
}
/**
* Get specific Climate properties
*
* @param propertyIdentifiers The property identifiers
*/
public GetState(byte... propertyIdentifiers) {
super(State.class, IDENTIFIER, new Bytes(propertyIdentifiers));
}
GetState(byte[] bytes, @SuppressWarnings("unused") boolean fromRaw) throws CommandParseException {
super(State.class, bytes);
}
}
/**
* Get specific Climate properties
*
* @deprecated use {@link GetState#GetState(byte...)} instead
*/
@Deprecated
public static class GetProperties extends GetCommand {
/**
* @param propertyIdentifiers The property identifiers
*/
public GetProperties(Bytes propertyIdentifiers) {
super(State.class, IDENTIFIER, propertyIdentifiers);
}
/**
* @param propertyIdentifiers The property identifiers
*/
public GetProperties(byte... propertyIdentifiers) {
super(State.class, IDENTIFIER, new Bytes(propertyIdentifiers));
}
GetProperties(byte[] bytes, @SuppressWarnings("unused") boolean fromRaw) throws CommandParseException {
super(State.class, bytes);
}
}
/**
* Change starting times
*/
public static class ChangeStartingTimes extends SetCommand {
List> hvacWeekdayStartingTimes;
/**
* @return The hvac weekday starting times
*/
public List> getHvacWeekdayStartingTimes() {
return hvacWeekdayStartingTimes;
}
/**
* Change starting times
*
* @param hvacWeekdayStartingTimes The hvac weekday starting times
*/
public ChangeStartingTimes(List hvacWeekdayStartingTimes) {
super(IDENTIFIER);
final ArrayList> hvacWeekdayStartingTimesBuilder = new ArrayList<>();
if (hvacWeekdayStartingTimes != null) {
for (HvacWeekdayStartingTime hvacWeekdayStartingTime : hvacWeekdayStartingTimes) {
Property prop = new Property<>(0x0b, hvacWeekdayStartingTime);
hvacWeekdayStartingTimesBuilder.add(prop);
addProperty(prop);
}
}
this.hvacWeekdayStartingTimes = hvacWeekdayStartingTimesBuilder;
createBytes();
}
ChangeStartingTimes(byte[] bytes) throws CommandParseException, NoPropertiesException {
super(bytes);
final ArrayList> hvacWeekdayStartingTimesBuilder = new ArrayList<>();
while (propertyIterator.hasNext()) {
propertyIterator.parseNext(p -> {
if (p.getPropertyIdentifier() == PROPERTY_HVAC_WEEKDAY_STARTING_TIMES) {
Property hvacWeekdayStartingTime = new Property<>(HvacWeekdayStartingTime.class, p);
hvacWeekdayStartingTimesBuilder.add(hvacWeekdayStartingTime);
return hvacWeekdayStartingTime;
}
return null;
});
}
hvacWeekdayStartingTimes = hvacWeekdayStartingTimesBuilder;
if (this.hvacWeekdayStartingTimes.size() == 0)
throw new NoPropertiesException();
}
}
/**
* Start stop hvac
*/
public static class StartStopHvac extends SetCommand {
Property hvacState = new Property<>(ActiveState.class, PROPERTY_HVAC_STATE);
/**
* @return The hvac state
*/
public Property getHvacState() {
return hvacState;
}
/**
* Start stop hvac
*
* @param hvacState The hvac state
*/
public StartStopHvac(ActiveState hvacState) {
super(IDENTIFIER);
addProperty(this.hvacState.update(hvacState));
createBytes();
}
StartStopHvac(byte[] bytes) throws CommandParseException, NoPropertiesException {
super(bytes);
while (propertyIterator.hasNext()) {
propertyIterator.parseNext(p -> {
if (p.getPropertyIdentifier() == PROPERTY_HVAC_STATE) return hvacState.update(p);
return null;
});
}
if (this.hvacState.getValue() == null)
throw new NoPropertiesException();
}
}
/**
* Start stop defogging
*/
public static class StartStopDefogging extends SetCommand {
Property defoggingState = new Property<>(ActiveState.class, PROPERTY_DEFOGGING_STATE);
/**
* @return The defogging state
*/
public Property getDefoggingState() {
return defoggingState;
}
/**
* Start stop defogging
*
* @param defoggingState The defogging state
*/
public StartStopDefogging(ActiveState defoggingState) {
super(IDENTIFIER);
addProperty(this.defoggingState.update(defoggingState));
createBytes();
}
StartStopDefogging(byte[] bytes) throws CommandParseException, NoPropertiesException {
super(bytes);
while (propertyIterator.hasNext()) {
propertyIterator.parseNext(p -> {
if (p.getPropertyIdentifier() == PROPERTY_DEFOGGING_STATE) return defoggingState.update(p);
return null;
});
}
if (this.defoggingState.getValue() == null)
throw new NoPropertiesException();
}
}
/**
* Start stop defrosting
*/
public static class StartStopDefrosting extends SetCommand {
Property defrostingState = new Property<>(ActiveState.class, PROPERTY_DEFROSTING_STATE);
/**
* @return The defrosting state
*/
public Property getDefrostingState() {
return defrostingState;
}
/**
* Start stop defrosting
*
* @param defrostingState The defrosting state
*/
public StartStopDefrosting(ActiveState defrostingState) {
super(IDENTIFIER);
addProperty(this.defrostingState.update(defrostingState));
createBytes();
}
StartStopDefrosting(byte[] bytes) throws CommandParseException, NoPropertiesException {
super(bytes);
while (propertyIterator.hasNext()) {
propertyIterator.parseNext(p -> {
if (p.getPropertyIdentifier() == PROPERTY_DEFROSTING_STATE) return defrostingState.update(p);
return null;
});
}
if (this.defrostingState.getValue() == null)
throw new NoPropertiesException();
}
}
/**
* Start stop ionising
*/
public static class StartStopIonising extends SetCommand {
Property ionisingState = new Property<>(ActiveState.class, PROPERTY_IONISING_STATE);
/**
* @return The ionising state
*/
public Property getIonisingState() {
return ionisingState;
}
/**
* Start stop ionising
*
* @param ionisingState The ionising state
*/
public StartStopIonising(ActiveState ionisingState) {
super(IDENTIFIER);
addProperty(this.ionisingState.update(ionisingState));
createBytes();
}
StartStopIonising(byte[] bytes) throws CommandParseException, NoPropertiesException {
super(bytes);
while (propertyIterator.hasNext()) {
propertyIterator.parseNext(p -> {
if (p.getPropertyIdentifier() == PROPERTY_IONISING_STATE) return ionisingState.update(p);
return null;
});
}
if (this.ionisingState.getValue() == null)
throw new NoPropertiesException();
}
}
/**
* Set temperature settings
*/
public static class SetTemperatureSettings extends SetCommand {
Property driverTemperatureSetting = new Property<>(Temperature.class, PROPERTY_DRIVER_TEMPERATURE_SETTING);
Property passengerTemperatureSetting = new Property<>(Temperature.class, PROPERTY_PASSENGER_TEMPERATURE_SETTING);
Property rearTemperatureSetting = new Property<>(Temperature.class, PROPERTY_REAR_TEMPERATURE_SETTING);
/**
* @return The driver temperature setting
*/
public Property getDriverTemperatureSetting() {
return driverTemperatureSetting;
}
/**
* @return The passenger temperature setting
*/
public Property getPassengerTemperatureSetting() {
return passengerTemperatureSetting;
}
/**
* @return The rear temperature setting
*/
public Property getRearTemperatureSetting() {
return rearTemperatureSetting;
}
/**
* Set temperature settings
*
* @param driverTemperatureSetting The driver temperature setting
* @param passengerTemperatureSetting The passenger temperature setting
* @param rearTemperatureSetting The rear temperature
*/
public SetTemperatureSettings(@Nullable Temperature driverTemperatureSetting, @Nullable Temperature passengerTemperatureSetting, @Nullable Temperature rearTemperatureSetting) {
super(IDENTIFIER);
addProperty(this.driverTemperatureSetting.update(driverTemperatureSetting));
addProperty(this.passengerTemperatureSetting.update(passengerTemperatureSetting));
addProperty(this.rearTemperatureSetting.update(rearTemperatureSetting));
if (this.driverTemperatureSetting.getValue() == null && this.passengerTemperatureSetting.getValue() == null && this.rearTemperatureSetting.getValue() == null) throw new IllegalArgumentException();
createBytes();
}
SetTemperatureSettings(byte[] bytes) throws CommandParseException, NoPropertiesException {
super(bytes);
while (propertyIterator.hasNext()) {
propertyIterator.parseNext(p -> {
switch (p.getPropertyIdentifier()) {
case PROPERTY_DRIVER_TEMPERATURE_SETTING: return driverTemperatureSetting.update(p);
case PROPERTY_PASSENGER_TEMPERATURE_SETTING: return passengerTemperatureSetting.update(p);
case PROPERTY_REAR_TEMPERATURE_SETTING: return rearTemperatureSetting.update(p);
}
return null;
});
}
if (this.driverTemperatureSetting.getValue() == null && this.passengerTemperatureSetting.getValue() == null && this.rearTemperatureSetting.getValue() == null) throw new NoPropertiesException();
}
}
/**
* The climate state
*/
public static class State extends SetCommand {
Property insideTemperature = new Property<>(Temperature.class, PROPERTY_INSIDE_TEMPERATURE);
Property outsideTemperature = new Property<>(Temperature.class, PROPERTY_OUTSIDE_TEMPERATURE);
Property driverTemperatureSetting = new Property<>(Temperature.class, PROPERTY_DRIVER_TEMPERATURE_SETTING);
Property passengerTemperatureSetting = new Property<>(Temperature.class, PROPERTY_PASSENGER_TEMPERATURE_SETTING);
Property hvacState = new Property<>(ActiveState.class, PROPERTY_HVAC_STATE);
Property defoggingState = new Property<>(ActiveState.class, PROPERTY_DEFOGGING_STATE);
Property defrostingState = new Property<>(ActiveState.class, PROPERTY_DEFROSTING_STATE);
Property ionisingState = new Property<>(ActiveState.class, PROPERTY_IONISING_STATE);
Property defrostingTemperatureSetting = new Property<>(Temperature.class, PROPERTY_DEFROSTING_TEMPERATURE_SETTING);
List> hvacWeekdayStartingTimes;
Property rearTemperatureSetting = new Property<>(Temperature.class, PROPERTY_REAR_TEMPERATURE_SETTING);
/**
* @return The inside temperature
*/
public Property getInsideTemperature() {
return insideTemperature;
}
/**
* @return The outside temperature
*/
public Property getOutsideTemperature() {
return outsideTemperature;
}
/**
* @return The driver temperature setting
*/
public Property getDriverTemperatureSetting() {
return driverTemperatureSetting;
}
/**
* @return The passenger temperature setting
*/
public Property getPassengerTemperatureSetting() {
return passengerTemperatureSetting;
}
/**
* @return The hvac state
*/
public Property getHvacState() {
return hvacState;
}
/**
* @return The defogging state
*/
public Property getDefoggingState() {
return defoggingState;
}
/**
* @return The defrosting state
*/
public Property getDefrostingState() {
return defrostingState;
}
/**
* @return The ionising state
*/
public Property getIonisingState() {
return ionisingState;
}
/**
* @return The defrosting temperature setting
*/
public Property getDefrostingTemperatureSetting() {
return defrostingTemperatureSetting;
}
/**
* @return The hvac weekday starting times
*/
public List> getHvacWeekdayStartingTimes() {
return hvacWeekdayStartingTimes;
}
/**
* @return The rear temperature
*/
public Property getRearTemperatureSetting() {
return rearTemperatureSetting;
}
State(byte[] bytes) throws CommandParseException {
super(bytes);
final ArrayList> hvacWeekdayStartingTimesBuilder = new ArrayList<>();
while (propertyIterator.hasNext()) {
propertyIterator.parseNext(p -> {
switch (p.getPropertyIdentifier()) {
case PROPERTY_INSIDE_TEMPERATURE: return insideTemperature.update(p);
case PROPERTY_OUTSIDE_TEMPERATURE: return outsideTemperature.update(p);
case PROPERTY_DRIVER_TEMPERATURE_SETTING: return driverTemperatureSetting.update(p);
case PROPERTY_PASSENGER_TEMPERATURE_SETTING: return passengerTemperatureSetting.update(p);
case PROPERTY_HVAC_STATE: return hvacState.update(p);
case PROPERTY_DEFOGGING_STATE: return defoggingState.update(p);
case PROPERTY_DEFROSTING_STATE: return defrostingState.update(p);
case PROPERTY_IONISING_STATE: return ionisingState.update(p);
case PROPERTY_DEFROSTING_TEMPERATURE_SETTING: return defrostingTemperatureSetting.update(p);
case PROPERTY_HVAC_WEEKDAY_STARTING_TIMES:
Property hvacWeekdayStartingTime = new Property<>(HvacWeekdayStartingTime.class, p);
hvacWeekdayStartingTimesBuilder.add(hvacWeekdayStartingTime);
return hvacWeekdayStartingTime;
case PROPERTY_REAR_TEMPERATURE_SETTING: return rearTemperatureSetting.update(p);
}
return null;
});
}
hvacWeekdayStartingTimes = hvacWeekdayStartingTimesBuilder;
}
private State(Builder builder) {
super(builder);
insideTemperature = builder.insideTemperature;
outsideTemperature = builder.outsideTemperature;
driverTemperatureSetting = builder.driverTemperatureSetting;
passengerTemperatureSetting = builder.passengerTemperatureSetting;
hvacState = builder.hvacState;
defoggingState = builder.defoggingState;
defrostingState = builder.defrostingState;
ionisingState = builder.ionisingState;
defrostingTemperatureSetting = builder.defrostingTemperatureSetting;
hvacWeekdayStartingTimes = builder.hvacWeekdayStartingTimes;
rearTemperatureSetting = builder.rearTemperatureSetting;
}
public static final class Builder extends SetCommand.Builder {
private Property insideTemperature;
private Property outsideTemperature;
private Property driverTemperatureSetting;
private Property passengerTemperatureSetting;
private Property hvacState;
private Property defoggingState;
private Property defrostingState;
private Property ionisingState;
private Property defrostingTemperatureSetting;
private final List> hvacWeekdayStartingTimes = new ArrayList<>();
private Property rearTemperatureSetting;
public Builder() {
super(IDENTIFIER);
}
public State build() {
return new State(this);
}
/**
* @param insideTemperature The inside temperature
* @return The builder
*/
public Builder setInsideTemperature(Property insideTemperature) {
this.insideTemperature = insideTemperature.setIdentifier(PROPERTY_INSIDE_TEMPERATURE);
addProperty(this.insideTemperature);
return this;
}
/**
* @param outsideTemperature The outside temperature
* @return The builder
*/
public Builder setOutsideTemperature(Property outsideTemperature) {
this.outsideTemperature = outsideTemperature.setIdentifier(PROPERTY_OUTSIDE_TEMPERATURE);
addProperty(this.outsideTemperature);
return this;
}
/**
* @param driverTemperatureSetting The driver temperature setting
* @return The builder
*/
public Builder setDriverTemperatureSetting(Property driverTemperatureSetting) {
this.driverTemperatureSetting = driverTemperatureSetting.setIdentifier(PROPERTY_DRIVER_TEMPERATURE_SETTING);
addProperty(this.driverTemperatureSetting);
return this;
}
/**
* @param passengerTemperatureSetting The passenger temperature setting
* @return The builder
*/
public Builder setPassengerTemperatureSetting(Property passengerTemperatureSetting) {
this.passengerTemperatureSetting = passengerTemperatureSetting.setIdentifier(PROPERTY_PASSENGER_TEMPERATURE_SETTING);
addProperty(this.passengerTemperatureSetting);
return this;
}
/**
* @param hvacState The hvac state
* @return The builder
*/
public Builder setHvacState(Property hvacState) {
this.hvacState = hvacState.setIdentifier(PROPERTY_HVAC_STATE);
addProperty(this.hvacState);
return this;
}
/**
* @param defoggingState The defogging state
* @return The builder
*/
public Builder setDefoggingState(Property defoggingState) {
this.defoggingState = defoggingState.setIdentifier(PROPERTY_DEFOGGING_STATE);
addProperty(this.defoggingState);
return this;
}
/**
* @param defrostingState The defrosting state
* @return The builder
*/
public Builder setDefrostingState(Property defrostingState) {
this.defrostingState = defrostingState.setIdentifier(PROPERTY_DEFROSTING_STATE);
addProperty(this.defrostingState);
return this;
}
/**
* @param ionisingState The ionising state
* @return The builder
*/
public Builder setIonisingState(Property ionisingState) {
this.ionisingState = ionisingState.setIdentifier(PROPERTY_IONISING_STATE);
addProperty(this.ionisingState);
return this;
}
/**
* @param defrostingTemperatureSetting The defrosting temperature setting
* @return The builder
*/
public Builder setDefrostingTemperatureSetting(Property defrostingTemperatureSetting) {
this.defrostingTemperatureSetting = defrostingTemperatureSetting.setIdentifier(PROPERTY_DEFROSTING_TEMPERATURE_SETTING);
addProperty(this.defrostingTemperatureSetting);
return this;
}
/**
* Add an array of hvac weekday starting times.
*
* @param hvacWeekdayStartingTimes The hvac weekday starting times
* @return The builder
*/
public Builder setHvacWeekdayStartingTimes(Property[] hvacWeekdayStartingTimes) {
this.hvacWeekdayStartingTimes.clear();
for (int i = 0; i < hvacWeekdayStartingTimes.length; i++) {
addHvacWeekdayStartingTime(hvacWeekdayStartingTimes[i]);
}
return this;
}
/**
* Add a single hvac weekday starting time.
*
* @param hvacWeekdayStartingTime The hvac weekday starting time
* @return The builder
*/
public Builder addHvacWeekdayStartingTime(Property hvacWeekdayStartingTime) {
hvacWeekdayStartingTime.setIdentifier(PROPERTY_HVAC_WEEKDAY_STARTING_TIMES);
addProperty(hvacWeekdayStartingTime);
hvacWeekdayStartingTimes.add(hvacWeekdayStartingTime);
return this;
}
/**
* @param rearTemperatureSetting The rear temperature
* @return The builder
*/
public Builder setRearTemperatureSetting(Property rearTemperatureSetting) {
this.rearTemperatureSetting = rearTemperatureSetting.setIdentifier(PROPERTY_REAR_TEMPERATURE_SETTING);
addProperty(this.rearTemperatureSetting);
return this;
}
}
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy