Adding doc for EV3 US Sensor

jabrena · jabrena · commit de068e94cfa9 · 2017-06-25T13:53:10.000+01:00
diff --git a/src/main/asciidoc/sensors/ev3-us-sensor/45504_Ultrasonic_Sensor_product_sheet.pdf b/src/main/asciidoc/sensors/ev3-us-sensor/45504_Ultrasonic_Sensor_product_sheet.pdf
diff --git a/src/main/asciidoc/sensors/ev3-us-sensor/USSensorDemo.java b/src/main/asciidoc/sensors/ev3-us-sensor/USSensorDemo.java
@@ -0,0 +1,30 @@
+package ev3dev.sensors.ev3;
+
+import lejos.hardware.port.SensorPort;
+import lejos.robotics.SampleProvider;
+import lejos.utility.Delay;
+
+public class USSensorDemo {
+
+	private static EV3UltrasonicSensor us1 = new EV3UltrasonicSensor(SensorPort.S1);
+
+	public static void main(String[] args) {
+
+		final SampleProvider sp = us1.getDistanceMode();
+		int distanceValue = 0;
+
+        final int iteration_threshold = 100;
+        for(int i = 0; i <= iteration_threshold; i++) {
+
+        	float [] sample = new float[sp.sampleSize()];
+            sp.fetchSample(sample, 0);
+            distanceValue = (int)sample[0];
+
+			System.out.println("Iteration: " + i + ", Distance: " + distanceValue);
+
+			Delay.msDelay(500);
+        }
+		
+	}
+
+}
diff --git a/src/main/asciidoc/sensors/ev3-us-sensor/USSensorDemo2.java b/src/main/asciidoc/sensors/ev3-us-sensor/USSensorDemo2.java
@@ -0,0 +1,45 @@
+package ev3dev.sensors.ev3;
+
+import ev3dev.sensors.Battery;
+import lejos.hardware.port.SensorPort;
+import lejos.robotics.SampleProvider;
+import lejos.utility.Delay;
+
+public class USSensorDemo2 {
+
+	//Robot Configuration
+	private static EV3UltrasonicSensor us1 = new EV3UltrasonicSensor(SensorPort.S1);
+	
+	//Configuration
+	private static int HALF_SECOND = 500;
+	
+	public static void main(String[] args) {
+
+		SampleProvider sp;
+
+		int distanceValue = 0;
+
+		for(int i = 0; i <= 10; i++) {
+
+			sp = us1.getListenMode();
+			int sampleSize = sp.sampleSize();
+			float[] sample = new float[sampleSize];
+			sp.fetchSample(sample, 0);
+
+			Delay.msDelay(2000);
+
+			sp = us1.getDistanceMode();
+			sampleSize = sp.sampleSize();
+			sample = new float[sampleSize];
+			sp.fetchSample(sample, 0);
+
+			distanceValue = (int)sample[0];
+
+			System.out.println("Iteration: {}, Distance: {}" + i + " "+ distanceValue);
+
+		}
+
+		System.out.println(Battery.getInstance().getVoltage());
+	}
+
+}
diff --git a/src/main/asciidoc/sensors/ev3-us-sensor/ev3_us_sensor.adoc b/src/main/asciidoc/sensors/ev3-us-sensor/ev3_us_sensor.adoc
@@ -0,0 +1,31 @@
+# EV3 Ultrasonic Sensor
+
+## Introduction
+
+The digital EV3 Ultrasonic Sensor generates sound waves and reads their echoes to detect and measure distance from objects. It can also send single sound waves to work as sonar or listen for a sound wave that triggers the start of a program. Students could design a traffic-monitoring system and measure distances between vehicles, for instance. There is an opportunity to discover how the technology is used in everyday items like automatic doors, cars and manufacturing systems.
+
+* Measures distances between one and 250 cm
+* Front illumination is constant while emitting and blinks while listening
+
+image:./ev3_us_sensor.png[image]
+
+## How to use the sensor
+
+### Example to read distances
+
+[source,java]
+----
+include::./USSensorDemo.java[]
+----
+
+### Example to use the Listen Mode
+
+[source,java]
+----
+include::./USSensorDemo2.java[]
+----
+
+**References**
+
+https://shop.lego.com/en-GB/EV3-Ultrasonic-Sensor-45504
+
diff --git a/src/main/asciidoc/sensors/ev3-us-sensor/ev3_us_sensor.png b/src/main/asciidoc/sensors/ev3-us-sensor/ev3_us_sensor.png
diff --git a/src/main/asciidoc/sensors/ev3_gyro_sensor.adoc b/src/main/asciidoc/sensors/ev3_gyro_sensor.adoc
@@ -1,4 +1,4 @@
-= EV3 Gyro sensor
+# EV3 Gyro sensor
 
 The digital EV3 Gyro Sensor measures the robot’s rotational motion and changes in its orientation.
 
diff --git a/src/main/asciidoc/sensors/index.adoc b/src/main/asciidoc/sensors/index.adoc
@@ -15,7 +15,7 @@ In same way, in a Robot, it is possible to use sensors in your robots to get dat
 
 ### Exteroceptors sensors
 
-* link:ev3_us_sensor.html[Ultrasonic sensor]
+* link:ev3-us-sensor/ev3_us_sensor.html[Ultrasonic sensor]
 * link:ev3_ir_sensor.html[Infrared sensor]
 * link:ev3_touch_sensor.html[Touch sensor]
 * link:ev3_light_sensor.html[Light sensor]
@@ -43,7 +43,7 @@ image:./31313.png[image]
 
 The Kit includes the following sensors:
 
-* link:ev3_us_sensor.html[Ultrasonic sensor] x1
+* link:ev3-us-sensor/ev3_us_sensor.html[Ultrasonic sensor] x1
 * link:ev3_touch_sensor.html[Touch sensor] x2
 * link:ev3_light_sensor.html[Light sensor] x1
 * link:ev3_gyro_sensor.html[Gyro sensor] x1

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-= EV3 Gyro sensor`
	`1`	`+# EV3 Gyro sensor`
`2`	`2`
`3`	`3`	`The digital EV3 Gyro Sensor measures the robot’s rotational motion and changes in its orientation.`
`4`	`4`