From f12fe5b8d562a730716c5ea60053960becbf753a Mon Sep 17 00:00:00 2001
From: tpariney <theo.pariney@edu.univ-fcomte.fr>
Date: Wed, 17 Sep 2025 15:23:42 +0200
Subject: [PATCH] Add the battery module

---
 battery/pom.xml                               | 78 +++++++++++++++++++
 .../m1info/gl/tparineymates/Battery.java      | 52 +++++++++++++
 .../InsufficientChargeException.java          |  9 +++
 .../gl/tparineymates/BatteryUnitTest.java     | 55 +++++++++++++
 pom.xml                                       |  1 +
 5 files changed, 195 insertions(+)
 create mode 100644 battery/pom.xml
 create mode 100644 battery/src/main/java/fr/ufrst/m1info/gl/tparineymates/Battery.java
 create mode 100644 battery/src/main/java/fr/ufrst/m1info/gl/tparineymates/InsufficientChargeException.java
 create mode 100644 battery/src/test/java/fr/ufrst/m1info/gl/tparineymates/BatteryUnitTest.java

diff --git a/battery/pom.xml b/battery/pom.xml
new file mode 100644
index 0000000..dd2a290
--- /dev/null
+++ b/battery/pom.xml
@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <artifactId>robot-modules</artifactId>
+    <groupId>fr.ufrst.m1info.gl.tparineymates</groupId>
+    <version>1.0-SNAPSHOT</version>
+  </parent>
+
+  <groupId>fr.ufrst.m1info.gl.tparineymates</groupId>
+  <artifactId>battery</artifactId>
+  <version>1.0-SNAPSHOT</version>
+
+  <name>battery</name>
+  <!-- FIXME change it to the project's website -->
+  <url>http://www.example.com</url>
+
+  <properties>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <maven.compiler.source>1.7</maven.compiler.source>
+    <maven.compiler.target>1.7</maven.compiler.target>
+  </properties>
+
+  <dependencies>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.11</version>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
+      <plugins>
+        <!-- clean lifecycle, see https://maven.apache.org/ref/current/maven-core/lifecycles.html#clean_Lifecycle -->
+        <plugin>
+          <artifactId>maven-clean-plugin</artifactId>
+          <version>3.1.0</version>
+        </plugin>
+        <!-- default lifecycle, jar packaging: see https://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_jar_packaging -->
+        <plugin>
+          <artifactId>maven-resources-plugin</artifactId>
+          <version>3.0.2</version>
+        </plugin>
+        <plugin>
+          <artifactId>maven-compiler-plugin</artifactId>
+          <version>3.8.0</version>
+        </plugin>
+        <plugin>
+          <artifactId>maven-surefire-plugin</artifactId>
+          <version>2.22.1</version>
+        </plugin>
+        <plugin>
+          <artifactId>maven-jar-plugin</artifactId>
+          <version>3.0.2</version>
+        </plugin>
+        <plugin>
+          <artifactId>maven-install-plugin</artifactId>
+          <version>2.5.2</version>
+        </plugin>
+        <plugin>
+          <artifactId>maven-deploy-plugin</artifactId>
+          <version>2.8.2</version>
+        </plugin>
+        <!-- site lifecycle, see https://maven.apache.org/ref/current/maven-core/lifecycles.html#site_Lifecycle -->
+        <plugin>
+          <artifactId>maven-site-plugin</artifactId>
+          <version>3.7.1</version>
+        </plugin>
+        <plugin>
+          <artifactId>maven-project-info-reports-plugin</artifactId>
+          <version>3.0.0</version>
+        </plugin>
+      </plugins>
+    </pluginManagement>
+  </build>
+</project>
diff --git a/battery/src/main/java/fr/ufrst/m1info/gl/tparineymates/Battery.java b/battery/src/main/java/fr/ufrst/m1info/gl/tparineymates/Battery.java
new file mode 100644
index 0000000..d69a725
--- /dev/null
+++ b/battery/src/main/java/fr/ufrst/m1info/gl/tparineymates/Battery.java
@@ -0,0 +1,52 @@
+package fr.ufrst.m1info.gl.tparineymates;
+
+
+import java.util.Timer;
+import java.util.TimerTask;
+
+public class Battery {
+
+    private final long CHARGE_TOP = 1000;
+    private float chargeLevel;
+
+    public Battery() {
+        chargeLevel = 100;
+    }
+
+    public void charge() {
+        chargeLevel = chargeFunction(chargeLevel);
+    }
+
+    private static float chargeFunction(float charge) {
+        return charge*1.1f + 1;
+    }
+
+    public void setUp() {
+        Timer timer = new Timer();
+        timer.schedule(new TimerTask() {
+            @Override
+            public void run() {
+                charge();
+            }
+        }, 0, CHARGE_TOP);
+    }
+
+    public float getChargeLevel(){
+        return chargeLevel;
+    }
+
+    public void use(double energy) throws InsufficientChargeException {
+        if (chargeLevel < energy) throw new InsufficientChargeException();
+        chargeLevel -= energy;
+    }
+
+    public long timeToSufficientCharge(double neededEnergy) {
+        int clock = 0;
+        float charge = chargeLevel;
+        while (charge<neededEnergy) {
+            charge = chargeFunction(charge);
+            clock++;
+        }
+        return clock*CHARGE_TOP;
+    }
+}
diff --git a/battery/src/main/java/fr/ufrst/m1info/gl/tparineymates/InsufficientChargeException.java b/battery/src/main/java/fr/ufrst/m1info/gl/tparineymates/InsufficientChargeException.java
new file mode 100644
index 0000000..30bcdbb
--- /dev/null
+++ b/battery/src/main/java/fr/ufrst/m1info/gl/tparineymates/InsufficientChargeException.java
@@ -0,0 +1,9 @@
+package fr.ufrst.m1info.gl.tparineymates;
+
+public class InsufficientChargeException extends Exception {
+
+	/**
+	 * 
+	 */
+	private static final long serialVersionUID = -7068684380888005700L;
+}
diff --git a/battery/src/test/java/fr/ufrst/m1info/gl/tparineymates/BatteryUnitTest.java b/battery/src/test/java/fr/ufrst/m1info/gl/tparineymates/BatteryUnitTest.java
new file mode 100644
index 0000000..9e1331a
--- /dev/null
+++ b/battery/src/test/java/fr/ufrst/m1info/gl/tparineymates/BatteryUnitTest.java
@@ -0,0 +1,55 @@
+package fr.ufrst.m1info.gl.tparineymates;
+
+import org.junit.Assert;
+import org.junit.Ignore;
+import org.junit.Test;
+
+
+public class BatteryUnitTest {
+
+    @Test
+    public void testCharge() {
+        Battery cell = new Battery();
+        Assert.assertEquals(100f, cell.getChargeLevel(),0);
+        cell.charge();
+        Assert.assertEquals(111f, cell.getChargeLevel(),0);
+    }
+
+    @Ignore
+    @Test
+    public void testSetup() throws InterruptedException {
+        Battery cell = new Battery();
+        Assert.assertEquals(100f, cell.getChargeLevel(), 0);
+        cell.setUp();
+        Thread.sleep(1000);
+        Assert.assertEquals(111f, cell.getChargeLevel(), 0);
+        Thread.sleep(1000);
+        Assert.assertEquals(123.100006f, cell.getChargeLevel(), 0);
+    }
+
+    @Test (expected = InsufficientChargeException.class)
+    public void testUseWithInsufficientCharge() throws Exception {
+        Battery cell = new Battery();
+        cell.use(125f);
+    }
+
+    @Test
+    public void testUse() throws InsufficientChargeException {
+        Battery cell = new Battery();
+        cell.use(25f);
+        Assert.assertEquals(75f, cell.getChargeLevel(), 0);
+    }
+
+    @Test
+    public void testUseMax() throws InsufficientChargeException {
+        Battery cell = new Battery();
+        cell.use(cell.getChargeLevel());
+        Assert.assertEquals(0f, cell.getChargeLevel(), 0);
+    }
+
+    @Test
+    public void testTimeToSufficientCharge() {
+        Battery cell = new Battery();
+        Assert.assertEquals(7000,cell.timeToSufficientCharge(200));
+    }
+}
diff --git a/pom.xml b/pom.xml
index 26c4cb5..3fe9687 100644
--- a/pom.xml
+++ b/pom.xml
@@ -16,5 +16,6 @@
   </dependencies>
   <modules>
     <module>robot</module>
+    <module>battery</module>
   </modules>
 </project>
-- 
GitLab