com.highmobility.autoapi.Maintenance 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.ByteEnum;
import com.highmobility.autoapi.property.Property;
import com.highmobility.autoapi.property.PropertyInteger;
import com.highmobility.autoapi.value.ConditionBasedService;
import com.highmobility.autoapi.value.measurement.Duration;
import com.highmobility.autoapi.value.measurement.Length;
import com.highmobility.value.Bytes;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.List;
import static com.highmobility.utils.ByteUtils.hexFromByte;
/**
* The Maintenance capability
*/
public class Maintenance {
public static final int IDENTIFIER = Identifier.MAINTENANCE;
public static final byte PROPERTY_DAYS_TO_NEXT_SERVICE = 0x01;
public static final byte PROPERTY_KILOMETERS_TO_NEXT_SERVICE = 0x02;
public static final byte PROPERTY_CBS_REPORTS_COUNT = 0x03;
public static final byte PROPERTY_MONTHS_TO_EXHAUST_INSPECTION = 0x04;
public static final byte PROPERTY_TELESERVICE_AVAILABILITY = 0x05;
public static final byte PROPERTY_SERVICE_DISTANCE_THRESHOLD = 0x06;
public static final byte PROPERTY_SERVICE_TIME_THRESHOLD = 0x07;
public static final byte PROPERTY_AUTOMATIC_TELESERVICE_CALL_DATE = 0x08;
public static final byte PROPERTY_TELESERVICE_BATTERY_CALL_DATE = 0x09;
public static final byte PROPERTY_NEXT_INSPECTION_DATE = 0x0a;
public static final byte PROPERTY_CONDITION_BASED_SERVICES = 0x0b;
public static final byte PROPERTY_BRAKE_FLUID_CHANGE_DATE = 0x0c;
public static final byte PROPERTY_TIME_TO_NEXT_SERVICE = 0x0d;
public static final byte PROPERTY_DISTANCE_TO_NEXT_SERVICE = 0x0e;
public static final byte PROPERTY_TIME_TO_EXHAUST_INSPECTION = 0x0f;
public static final byte PROPERTY_LAST_ECALL = 0x10;
/**
* Get Maintenance property availability information.
*/
public static class GetStateAvailability extends GetAvailabilityCommand {
/**
* Get every Maintenance property availability
*/
public GetStateAvailability() {
super(IDENTIFIER);
}
/**
* Get specific Maintenance property availabilities
*
* @param propertyIdentifiers The property identifierBytes
*/
public GetStateAvailability(Bytes propertyIdentifiers) {
super(IDENTIFIER, propertyIdentifiers);
}
/**
* Get specific Maintenance 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 Maintenance properties
*/
public static class GetState extends GetCommand {
/**
* Get all Maintenance properties
*/
public GetState() {
super(State.class, IDENTIFIER);
}
/**
* Get specific Maintenance properties
*
* @param propertyIdentifiers The property identifiers
*/
public GetState(Bytes propertyIdentifiers) {
super(State.class, IDENTIFIER, propertyIdentifiers);
}
/**
* Get specific Maintenance 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 Maintenance 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);
}
}
/**
* The maintenance state
*/
public static class State extends SetCommand {
Property daysToNextService = new Property<>(Duration.class, PROPERTY_DAYS_TO_NEXT_SERVICE);
Property kilometersToNextService = new Property<>(Length.class, PROPERTY_KILOMETERS_TO_NEXT_SERVICE);
PropertyInteger cbsReportsCount = new PropertyInteger(PROPERTY_CBS_REPORTS_COUNT, false);
Property monthsToExhaustInspection = new Property<>(Duration.class, PROPERTY_MONTHS_TO_EXHAUST_INSPECTION);
Property teleserviceAvailability = new Property<>(TeleserviceAvailability.class, PROPERTY_TELESERVICE_AVAILABILITY);
Property serviceDistanceThreshold = new Property<>(Length.class, PROPERTY_SERVICE_DISTANCE_THRESHOLD);
Property serviceTimeThreshold = new Property<>(Duration.class, PROPERTY_SERVICE_TIME_THRESHOLD);
Property automaticTeleserviceCallDate = new Property<>(Calendar.class, PROPERTY_AUTOMATIC_TELESERVICE_CALL_DATE);
Property teleserviceBatteryCallDate = new Property<>(Calendar.class, PROPERTY_TELESERVICE_BATTERY_CALL_DATE);
Property nextInspectionDate = new Property<>(Calendar.class, PROPERTY_NEXT_INSPECTION_DATE);
List> conditionBasedServices;
Property brakeFluidChangeDate = new Property<>(Calendar.class, PROPERTY_BRAKE_FLUID_CHANGE_DATE);
Property timeToNextService = new Property<>(Duration.class, PROPERTY_TIME_TO_NEXT_SERVICE);
Property distanceToNextService = new Property<>(Length.class, PROPERTY_DISTANCE_TO_NEXT_SERVICE);
Property timeToExhaustInspection = new Property<>(Duration.class, PROPERTY_TIME_TO_EXHAUST_INSPECTION);
Property lastECall = new Property<>(Calendar.class, PROPERTY_LAST_ECALL);
/**
* @return Time until next servicing of the car
* @deprecated removed the unit from the name. Replaced by {@link #getTimeToNextService()}
*/
@Deprecated
public Property getDaysToNextService() {
return daysToNextService;
}
/**
* @return The distance until next servicing of the vehicle
* @deprecated removed the unit from the name. Replaced by {@link #getDistanceToNextService()}
*/
@Deprecated
public Property getKilometersToNextService() {
return kilometersToNextService;
}
/**
* @return The number of CBS reports
*/
public PropertyInteger getCbsReportsCount() {
return cbsReportsCount;
}
/**
* @return Time until exhaust inspection
* @deprecated removed the unit from the name. Replaced by {@link #getTimeToExhaustInspection()}
*/
@Deprecated
public Property getMonthsToExhaustInspection() {
return monthsToExhaustInspection;
}
/**
* @return The teleservice availability
*/
public Property getTeleserviceAvailability() {
return teleserviceAvailability;
}
/**
* @return Distance threshold for service
*/
public Property getServiceDistanceThreshold() {
return serviceDistanceThreshold;
}
/**
* @return Time threshold for service
*/
public Property getServiceTimeThreshold() {
return serviceTimeThreshold;
}
/**
* @return Automatic teleservice call date
*/
public Property getAutomaticTeleserviceCallDate() {
return automaticTeleserviceCallDate;
}
/**
* @return Teleservice batter call date
*/
public Property getTeleserviceBatteryCallDate() {
return teleserviceBatteryCallDate;
}
/**
* @return Next inspection date
*/
public Property getNextInspectionDate() {
return nextInspectionDate;
}
/**
* @return The condition based services
*/
public List> getConditionBasedServices() {
return conditionBasedServices;
}
/**
* @return Brake fluid change date
*/
public Property getBrakeFluidChangeDate() {
return brakeFluidChangeDate;
}
/**
* @return Time until next servicing of the vehicle
*/
public Property getTimeToNextService() {
return timeToNextService;
}
/**
* @return The distance until next servicing of the vehicle
*/
public Property getDistanceToNextService() {
return distanceToNextService;
}
/**
* @return Time until exhaust inspection
*/
public Property getTimeToExhaustInspection() {
return timeToExhaustInspection;
}
/**
* @return Date-time of the last eCall
*/
public Property getLastECall() {
return lastECall;
}
State(byte[] bytes) throws CommandParseException {
super(bytes);
final ArrayList> conditionBasedServicesBuilder = new ArrayList<>();
while (propertyIterator.hasNext()) {
propertyIterator.parseNext(p -> {
switch (p.getPropertyIdentifier()) {
case PROPERTY_DAYS_TO_NEXT_SERVICE: return daysToNextService.update(p);
case PROPERTY_KILOMETERS_TO_NEXT_SERVICE: return kilometersToNextService.update(p);
case PROPERTY_CBS_REPORTS_COUNT: return cbsReportsCount.update(p);
case PROPERTY_MONTHS_TO_EXHAUST_INSPECTION: return monthsToExhaustInspection.update(p);
case PROPERTY_TELESERVICE_AVAILABILITY: return teleserviceAvailability.update(p);
case PROPERTY_SERVICE_DISTANCE_THRESHOLD: return serviceDistanceThreshold.update(p);
case PROPERTY_SERVICE_TIME_THRESHOLD: return serviceTimeThreshold.update(p);
case PROPERTY_AUTOMATIC_TELESERVICE_CALL_DATE: return automaticTeleserviceCallDate.update(p);
case PROPERTY_TELESERVICE_BATTERY_CALL_DATE: return teleserviceBatteryCallDate.update(p);
case PROPERTY_NEXT_INSPECTION_DATE: return nextInspectionDate.update(p);
case PROPERTY_CONDITION_BASED_SERVICES:
Property conditionBasedService = new Property<>(ConditionBasedService.class, p);
conditionBasedServicesBuilder.add(conditionBasedService);
return conditionBasedService;
case PROPERTY_BRAKE_FLUID_CHANGE_DATE: return brakeFluidChangeDate.update(p);
case PROPERTY_TIME_TO_NEXT_SERVICE: return timeToNextService.update(p);
case PROPERTY_DISTANCE_TO_NEXT_SERVICE: return distanceToNextService.update(p);
case PROPERTY_TIME_TO_EXHAUST_INSPECTION: return timeToExhaustInspection.update(p);
case PROPERTY_LAST_ECALL: return lastECall.update(p);
}
return null;
});
}
conditionBasedServices = conditionBasedServicesBuilder;
}
private State(Builder builder) {
super(builder);
daysToNextService = builder.daysToNextService;
kilometersToNextService = builder.kilometersToNextService;
cbsReportsCount = builder.cbsReportsCount;
monthsToExhaustInspection = builder.monthsToExhaustInspection;
teleserviceAvailability = builder.teleserviceAvailability;
serviceDistanceThreshold = builder.serviceDistanceThreshold;
serviceTimeThreshold = builder.serviceTimeThreshold;
automaticTeleserviceCallDate = builder.automaticTeleserviceCallDate;
teleserviceBatteryCallDate = builder.teleserviceBatteryCallDate;
nextInspectionDate = builder.nextInspectionDate;
conditionBasedServices = builder.conditionBasedServices;
brakeFluidChangeDate = builder.brakeFluidChangeDate;
timeToNextService = builder.timeToNextService;
distanceToNextService = builder.distanceToNextService;
timeToExhaustInspection = builder.timeToExhaustInspection;
lastECall = builder.lastECall;
}
public static final class Builder extends SetCommand.Builder {
private Property daysToNextService;
private Property kilometersToNextService;
private PropertyInteger cbsReportsCount;
private Property monthsToExhaustInspection;
private Property teleserviceAvailability;
private Property serviceDistanceThreshold;
private Property serviceTimeThreshold;
private Property automaticTeleserviceCallDate;
private Property teleserviceBatteryCallDate;
private Property nextInspectionDate;
private final List> conditionBasedServices = new ArrayList<>();
private Property brakeFluidChangeDate;
private Property timeToNextService;
private Property distanceToNextService;
private Property timeToExhaustInspection;
private Property lastECall;
public Builder() {
super(IDENTIFIER);
}
public State build() {
return new State(this);
}
/**
* @param daysToNextService Time until next servicing of the car
* @return The builder
* @deprecated removed the unit from the name. Replaced by {@link #getTimeToNextService()}
*/
@Deprecated
public Builder setDaysToNextService(Property daysToNextService) {
this.daysToNextService = daysToNextService.setIdentifier(PROPERTY_DAYS_TO_NEXT_SERVICE);
addProperty(this.daysToNextService);
return this;
}
/**
* @param kilometersToNextService The distance until next servicing of the vehicle
* @return The builder
* @deprecated removed the unit from the name. Replaced by {@link #getDistanceToNextService()}
*/
@Deprecated
public Builder setKilometersToNextService(Property kilometersToNextService) {
this.kilometersToNextService = kilometersToNextService.setIdentifier(PROPERTY_KILOMETERS_TO_NEXT_SERVICE);
addProperty(this.kilometersToNextService);
return this;
}
/**
* @param cbsReportsCount The number of CBS reports
* @return The builder
*/
public Builder setCbsReportsCount(Property cbsReportsCount) {
this.cbsReportsCount = new PropertyInteger(PROPERTY_CBS_REPORTS_COUNT, false, 1, cbsReportsCount);
addProperty(this.cbsReportsCount);
return this;
}
/**
* @param monthsToExhaustInspection Time until exhaust inspection
* @return The builder
* @deprecated removed the unit from the name. Replaced by {@link #getTimeToExhaustInspection()}
*/
@Deprecated
public Builder setMonthsToExhaustInspection(Property monthsToExhaustInspection) {
this.monthsToExhaustInspection = monthsToExhaustInspection.setIdentifier(PROPERTY_MONTHS_TO_EXHAUST_INSPECTION);
addProperty(this.monthsToExhaustInspection);
return this;
}
/**
* @param teleserviceAvailability The teleservice availability
* @return The builder
*/
public Builder setTeleserviceAvailability(Property teleserviceAvailability) {
this.teleserviceAvailability = teleserviceAvailability.setIdentifier(PROPERTY_TELESERVICE_AVAILABILITY);
addProperty(this.teleserviceAvailability);
return this;
}
/**
* @param serviceDistanceThreshold Distance threshold for service
* @return The builder
*/
public Builder setServiceDistanceThreshold(Property serviceDistanceThreshold) {
this.serviceDistanceThreshold = serviceDistanceThreshold.setIdentifier(PROPERTY_SERVICE_DISTANCE_THRESHOLD);
addProperty(this.serviceDistanceThreshold);
return this;
}
/**
* @param serviceTimeThreshold Time threshold for service
* @return The builder
*/
public Builder setServiceTimeThreshold(Property serviceTimeThreshold) {
this.serviceTimeThreshold = serviceTimeThreshold.setIdentifier(PROPERTY_SERVICE_TIME_THRESHOLD);
addProperty(this.serviceTimeThreshold);
return this;
}
/**
* @param automaticTeleserviceCallDate Automatic teleservice call date
* @return The builder
*/
public Builder setAutomaticTeleserviceCallDate(Property automaticTeleserviceCallDate) {
this.automaticTeleserviceCallDate = automaticTeleserviceCallDate.setIdentifier(PROPERTY_AUTOMATIC_TELESERVICE_CALL_DATE);
addProperty(this.automaticTeleserviceCallDate);
return this;
}
/**
* @param teleserviceBatteryCallDate Teleservice batter call date
* @return The builder
*/
public Builder setTeleserviceBatteryCallDate(Property teleserviceBatteryCallDate) {
this.teleserviceBatteryCallDate = teleserviceBatteryCallDate.setIdentifier(PROPERTY_TELESERVICE_BATTERY_CALL_DATE);
addProperty(this.teleserviceBatteryCallDate);
return this;
}
/**
* @param nextInspectionDate Next inspection date
* @return The builder
*/
public Builder setNextInspectionDate(Property nextInspectionDate) {
this.nextInspectionDate = nextInspectionDate.setIdentifier(PROPERTY_NEXT_INSPECTION_DATE);
addProperty(this.nextInspectionDate);
return this;
}
/**
* Add an array of condition based services.
*
* @param conditionBasedServices The condition based services
* @return The builder
*/
public Builder setConditionBasedServices(Property[] conditionBasedServices) {
this.conditionBasedServices.clear();
for (int i = 0; i < conditionBasedServices.length; i++) {
addConditionBasedService(conditionBasedServices[i]);
}
return this;
}
/**
* Add a single condition based service.
*
* @param conditionBasedService The condition based service
* @return The builder
*/
public Builder addConditionBasedService(Property conditionBasedService) {
conditionBasedService.setIdentifier(PROPERTY_CONDITION_BASED_SERVICES);
addProperty(conditionBasedService);
conditionBasedServices.add(conditionBasedService);
return this;
}
/**
* @param brakeFluidChangeDate Brake fluid change date
* @return The builder
*/
public Builder setBrakeFluidChangeDate(Property brakeFluidChangeDate) {
this.brakeFluidChangeDate = brakeFluidChangeDate.setIdentifier(PROPERTY_BRAKE_FLUID_CHANGE_DATE);
addProperty(this.brakeFluidChangeDate);
return this;
}
/**
* @param timeToNextService Time until next servicing of the vehicle
* @return The builder
*/
public Builder setTimeToNextService(Property timeToNextService) {
this.timeToNextService = timeToNextService.setIdentifier(PROPERTY_TIME_TO_NEXT_SERVICE);
addProperty(this.timeToNextService);
return this;
}
/**
* @param distanceToNextService The distance until next servicing of the vehicle
* @return The builder
*/
public Builder setDistanceToNextService(Property distanceToNextService) {
this.distanceToNextService = distanceToNextService.setIdentifier(PROPERTY_DISTANCE_TO_NEXT_SERVICE);
addProperty(this.distanceToNextService);
return this;
}
/**
* @param timeToExhaustInspection Time until exhaust inspection
* @return The builder
*/
public Builder setTimeToExhaustInspection(Property timeToExhaustInspection) {
this.timeToExhaustInspection = timeToExhaustInspection.setIdentifier(PROPERTY_TIME_TO_EXHAUST_INSPECTION);
addProperty(this.timeToExhaustInspection);
return this;
}
/**
* @param lastECall Date-time of the last eCall
* @return The builder
*/
public Builder setLastECall(Property lastECall) {
this.lastECall = lastECall.setIdentifier(PROPERTY_LAST_ECALL);
addProperty(this.lastECall);
return this;
}
}
}
public enum TeleserviceAvailability implements ByteEnum {
PENDING((byte) 0x00),
IDLE((byte) 0x01),
SUCCESSFUL((byte) 0x02),
ERROR((byte) 0x03);
public static TeleserviceAvailability fromByte(byte byteValue) throws CommandParseException {
TeleserviceAvailability[] values = TeleserviceAvailability.values();
for (int i = 0; i < values.length; i++) {
TeleserviceAvailability state = values[i];
if (state.getByte() == byteValue) {
return state;
}
}
throw new CommandParseException("Maintenance.TeleserviceAvailability does not contain: " + hexFromByte(byteValue));
}
private final byte value;
TeleserviceAvailability(byte value) {
this.value = value;
}
@Override public byte getByte() {
return value;
}
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy