Added notnull to some stuff

wildmountainfarms · Dec 31, 2021 · 03de524 · 03de524
1 parent 857fc95
commit 03de524
Show file tree

Hide file tree

Showing 9 changed files with 24 additions and 11 deletions.
diff --git a/core/src/main/java/me/retrodaredevil/solarthing/solar/common/ErrorReporter.java b/core/src/main/java/me/retrodaredevil/solarthing/solar/common/ErrorReporter.java
@@ -1,6 +1,7 @@
 package me.retrodaredevil.solarthing.solar.common;
 
 import me.retrodaredevil.solarthing.annotations.GraphQLInclude;
+import me.retrodaredevil.solarthing.annotations.NotNull;
 import me.retrodaredevil.solarthing.packets.BitmaskMode;
 import me.retrodaredevil.solarthing.packets.identification.Identifiable;
 
@@ -13,7 +14,7 @@ public interface ErrorReporter extends Identifiable {
 	 */
 	int getErrorModeValue();
 	@GraphQLInclude("errorModes")
-	Collection<? extends BitmaskMode> getErrorModes();
+	@NotNull Collection<@NotNull ? extends BitmaskMode> getErrorModes();
 	@GraphQLInclude("hasError")
 	default boolean hasError() {
 		return getErrorModeValue() != 0;

diff --git a/core/src/main/java/me/retrodaredevil/solarthing/solar/outback/fx/common/FXDailyData.java b/core/src/main/java/me/retrodaredevil/solarthing/solar/outback/fx/common/FXDailyData.java
@@ -67,7 +67,7 @@ default boolean isNewDay(DailyData previousDailyData){
 	int getErrorModeValue();
 	@Deprecated
 	@Override
-	default Set<@NotNull FXErrorMode> getErrorModes(){ return Modes.getActiveModes(FXErrorMode.class, getErrorModeValue()); }
+	default @NotNull Set<@NotNull FXErrorMode> getErrorModes(){ return Modes.getActiveModes(FXErrorMode.class, getErrorModeValue()); }
 
 	@JsonProperty("warningModeValue")
 	@Override

diff --git a/...ain/java/me/retrodaredevil/solarthing/solar/outback/fx/event/FXErrorModeChangePacket.java b/...ain/java/me/retrodaredevil/solarthing/solar/outback/fx/event/FXErrorModeChangePacket.java
@@ -35,7 +35,7 @@ public interface FXErrorModeChangePacket extends SupplementarySolarEventPacket,
 	@Nullable Integer getPreviousErrorModeValue();
 
 	@Override
-	default Set<@NotNull FXErrorMode> getErrorModes(){
+	default @NotNull Set<@NotNull FXErrorMode> getErrorModes(){
 		return Modes.getActiveModes(FXErrorMode.class, getErrorModeValue());
 	}
 	default @Nullable Set<FXErrorMode> getPreviousErrorModes(){

diff --git a/core/src/main/java/me/retrodaredevil/solarthing/solar/outback/mx/MXStatusPacket.java b/core/src/main/java/me/retrodaredevil/solarthing/solar/outback/mx/MXStatusPacket.java
@@ -156,7 +156,7 @@ default int getAuxModeValue() {
 	@Override
 	int getErrorModeValue();
 	@Override
-	default Set<@NotNull MXErrorMode> getErrorModes(){
+	default @NotNull Set<@NotNull MXErrorMode> getErrorModes(){
 		return Modes.getActiveModes(MXErrorMode.class, getErrorModeValue());
 	}
 

diff --git a/...ain/java/me/retrodaredevil/solarthing/solar/outback/mx/event/MXErrorModeChangePacket.java b/...ain/java/me/retrodaredevil/solarthing/solar/outback/mx/event/MXErrorModeChangePacket.java
@@ -35,7 +35,7 @@ public interface MXErrorModeChangePacket extends SupplementarySolarEventPacket,
 	@Nullable Integer getPreviousErrorModeValue();
 
 	@Override
-	default Set<@NotNull MXErrorMode> getErrorModes(){
+	default @NotNull Set<@NotNull MXErrorMode> getErrorModes(){
 		return Modes.getActiveModes(MXErrorMode.class, getErrorModeValue());
 	}
 	default @Nullable Set<MXErrorMode> getPreviousErrorModes(){

diff --git a/core/src/main/java/me/retrodaredevil/solarthing/solar/renogy/rover/RoverReadTable.java b/core/src/main/java/me/retrodaredevil/solarthing/solar/renogy/rover/RoverReadTable.java
@@ -20,6 +20,7 @@
 
 import java.util.Collection;
 import java.util.Collections;
+import java.util.Set;
 
 import static java.util.Objects.requireNonNull;
 
@@ -461,7 +462,7 @@ default int getStreetLightStatusValue(){
 	int getErrorModeValue();
 	@ValidSinceVersion(version = RoverStatusPacket.Version.CORRECT_TWO_REGISTER)
 	@Override
-	default Collection<? extends SimpleRoverErrorMode> getErrorModes(){
+	default @NotNull Collection<@NotNull ? extends SimpleRoverErrorMode> getErrorModes(){
 		if (isDcdc()) {
 			return getDcdcErrorModes();
 		}
@@ -479,13 +480,13 @@ default String getErrorsString(){
 	@ValidSinceVersion(version = RoverStatusPacket.Version.CORRECT_TWO_REGISTER)
 	@GraphQLInclude("dcdcErrorModes")
 	@DcdcOnly
-	default Collection<DcdcErrorMode> getDcdcErrorModes() {
+	default @NotNull Set<@NotNull DcdcErrorMode> getDcdcErrorModes() {
 		return Modes.getActiveModes(DcdcErrorMode.class, getErrorModeValue());
 	}
 	@ValidSinceVersion(version = RoverStatusPacket.Version.CORRECT_TWO_REGISTER)
 	@GraphQLInclude("roverErrorModes")
 	@RoverOnly
-	default Collection<RoverErrorMode> getRoverErrorModes() {
+	default @NotNull Set<@NotNull RoverErrorMode> getRoverErrorModes() {
 		return Modes.getActiveModes(RoverErrorMode.class, getErrorModeValue());
 	}
 	@ValidSinceVersion(version = RoverStatusPacket.Version.CORRECT_TWO_REGISTER)

diff --git a/...rc/main/java/me/retrodaredevil/solarthing/solar/tracer/TracerChargingEquipmentStatus.java b/...rc/main/java/me/retrodaredevil/solarthing/solar/tracer/TracerChargingEquipmentStatus.java
@@ -19,7 +19,7 @@ public interface TracerChargingEquipmentStatus extends ErrorReporter {
 	default int getInputVoltageStatusValue() { return getChargingEquipmentStatus() >> 14; }
 	default int getChargingStatusValue() { return (getChargingEquipmentStatus() >> 2) & 0b11; }
 	@Override
-	default @NotNull Set<ChargingEquipmentError> getErrorModes() { return Modes.getActiveModes(ChargingEquipmentError.class, getChargingEquipmentStatus()); }
+	default @NotNull Set<@NotNull ChargingEquipmentError> getErrorModes() { return Modes.getActiveModes(ChargingEquipmentError.class, getChargingEquipmentStatus()); }
 	/**
 	 * @deprecated Use {@link #getChargingEquipmentStatus()} instead
 	 * @return {@link #getChargingEquipmentStatus()}
@@ -35,4 +35,15 @@ public interface TracerChargingEquipmentStatus extends ErrorReporter {
 	default @NotNull ChargingStatus getChargingStatus() { return Modes.getActiveMode(ChargingStatus.class, getChargingStatusValue()); }
 	@GraphQLInclude("chargingStatusName")
 	default @NotNull String getChargingStatusName() { return getChargingStatus().getModeName(); }
+
+	@Override
+	default boolean hasError() {
+		Set<ChargingEquipmentError> errors = getErrorModes();
+		if (errors.contains(ChargingEquipmentError.FAULT)) {
+			// fault seems to always be present, so we'll ignore it for now.
+			//   Consider removing fault or something.
+			return errors.size() > 1;
+		}
+		return !errors.isEmpty();
+	}
 }
diff --git a/...st/java/me/retrodaredevil/solarthing/solar/outback/OutbackDuplicatePacketRemoverTest.java b/...st/java/me/retrodaredevil/solarthing/solar/outback/OutbackDuplicatePacketRemoverTest.java
@@ -86,7 +86,7 @@ public int getErrorModeValue() {
 			}
 
 			@Override
-			public Collection<? extends BitmaskMode> getErrorModes() {
+			public @NotNull Collection<@NotNull ? extends BitmaskMode> getErrorModes() {
 				throw new UnsupportedOperationException();
 			}
 		};

diff --git a/other/docs/todo.md b/other/docs/todo.md
@@ -5,7 +5,6 @@
 * Packet for disk usage
 * Send packet when mate serial port hasn't output data for 30 seconds
 * Create Dockerfile and example docker-compose file
-* Add event packets for rover and tracer devices (like we did for MXs and FXs)
 * Short term record packets for high/low battery voltage, FX inverter current, pv wattage, charging current, etc  
   * This would be very useful so that if packets are replaced there is still information on how
   high or low the battery voltage got or how high the load was
@@ -150,6 +149,7 @@ easy displaying in Grafana
 * Make an alternative for RetryFailedPacketHandler. Details in comments in class.
 * Actually start using SLF4J in graphql program
 * Get rid of InstantType
+* Add event packets for rover and tracer devices (like we did for MXs and FXs)
 
 ### Look into
 * Look into supporting Elasticsearch, MongoDB, Graphite