Initial commit

Author: pa1007

README.md

@@ -0,0 +1,53 @@
+# SB Components Motor-Shield Java API
+
+Disclaimer : Not the offical API for this shield, the original is on python and in the link :  [Original API](https://github.com/sbcshop/MotorShield)
+If you want the original manual go here : [Manual
+](https://github.com/sbcshop/MotorShield/blob/master/Maker_Sphere_Manual.pdf)
+
+![](https://cdn.shopify.com/s/files/1/1217/2104/products/motor_shield_a_720_660_1800x1800.png?v=1528533987)
+
+
+## How it works 
+ ```java
+Motor m1 = Motors.MOTOR_1; // Get the motor Can be MOTOR_2 , MOTOR_3 or MOTOR_4  
+  
+m1.forward(100); //Tell the motor to go forward at the speed of 100% (Anything higher will be the same)  
+m1.stop(); //Tell the motor to stop, it will set his speed to 0
+m1.reverse(100); // Tell the motor to go in reverse at the speed of 100%  
+  
+m1.unBound(); //Unbound the motor, it will released all the pin and can be recreate to work
+```
+Here you have the basics of the API, you can create more complexe one : 
+```java
+Motor m1 = Motors.MOTOR_1;  
+Motor m2 = Motors.MOTOR_2;  
+Motor m3 = Motors.MOTOR_3;  
+Motor m4 = Motors.MOTOR_4;  
+//Create all motors  
+  
+LinkedMotors all = new LinkedMotors(m1, m2, m3, m4); // Create a list with all the motors  
+  
+all.forward(100); // Tell all motors to move forward at a speed of 100%  
+all.stop(); //Tell all motors to stop, it will set their speed to 0  
+all.reverse(100); // Tell all motors to go on reverse at a speed of 100%
+```
+or 
+```java
+Motor m1 = Motors.MOTOR_1;  
+Motor m2 = Motors.MOTOR_2;  
+Motor m3 = Motors.MOTOR_3;  
+Motor m4 = Motors.MOTOR_4;  
+//Create all motors  
+  
+InvertedMotors motorsList = new InvertedMotors();  
+motorsList.addReverse(m2);  
+motorsList.addReverse(m3);  
+motorsList.addGoodWay(m1);  
+motorsList.addGoodWay(m4);  
+// Create a list with all the motors  
+  
+motorsList.forward(100); // Tell all motors m1 and m4 to go forward and tell m2 and m3 to go on reverse  
+motorsList.stop(); //Tell all motors to stop, it will set their speed to 0  
+motorsList.reverse(100); // Tell all motors m1 and m4 to go on reverse and tell m2 and m3 to go forward
+```
+The last exemple can be usefull if you have a 4 motor setup and all the motors cannot be on the same direction

build.gradle

@@ -0,0 +1,17 @@
+plugins {
+    id 'java'
+}
+
+group 'fr.pa1007'
+version '1.0'
+
+sourceCompatibility = 1.8
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    testCompile group: 'junit', name: 'junit', version: '4.12'
+    compile group: 'com.pi4j', name: 'pi4j-core', version: '1.2'
+}

gradlew

@@ -0,0 +1,2 @@
+rootProject.name = 'motorapi'
+

gradlew.bat

@@ -0,0 +1,56 @@
+package fr.pa1007.motor.api;
+
+import com.pi4j.io.gpio.*;
+
+/**
+ * The arrows are the arrow on the top of the board can activate them and deactivate them
+ * <br>
+ * See their Python API here : <a href="https://github.com/sbcshop/MotorShield">https://github.com/sbcshop/MotorShield</a>
+ *
+ * @author pa1007
+ */
+public class Arrow {
+
+    /**
+     * The Front arrow ( Facing the power entry)
+     */
+    public static final Arrow MOTOR_4 = new Arrow(RaspiPin.GPIO_23, "Motor 4");
+
+
+    /**
+     * The right arrow ( Facing the 40 pins)
+     */
+    public static final Arrow MOTOR_3 = new Arrow(RaspiPin.GPIO_24, "Motor 3");
+
+    /**
+     * The back arrow ( Facing the detection unit)
+     */
+    public static final Arrow MOTOR_2 = new Arrow(RaspiPin.GPIO_25, "Motor 2");
+
+    /**
+     * The left arrow ( Facing the motors connectors)
+     */
+    public static final Arrow MOTOR_1 = new Arrow(RaspiPin.GPIO_27, "Motor 1");
+
+    private GpioPinDigitalOutput output;
+
+    /**
+     * Protected constructor
+     *
+     * @param pin  the pin of the arrow to turn it on
+     * @param name the name of the connector
+     */
+    protected Arrow(Pin pin, String name) {
+        GpioController gpio = GpioFactory.getInstance();
+        this.output = gpio.provisionDigitalOutputPin(pin, name);
+    }
+
+    public void on() {
+        output.setState(PinState.HIGH);
+    }
+
+    public void off() {
+        output.setState(PinState.LOW);
+    }
+
+}