First release of the library

- Developed basic functionality
- Developed interrupt handling

Author: alessandro1105

README.md

@@ -1,2 +1,25 @@
-# D7S_Arduino_Library
-Arduino IDE library to use the D7S sensor
+# D7S Arduino Library
+
+This library improve the use of the D7S sensor developed by Omron.
+
+## Getting Started
+
+Just download the lastest realease and place it your Arduino IDE library folder. See [https://www.arduino.cc/en/Guide/Libraries](https://www.arduino.cc/en/Guide/Libraries)
+
+### Installing
+
+The D7S sensor must be connected to the I2C bus.
+
+On most Arduino boards, SDA (data line) is on analog input pin 4, and SCL (clock line) is on analog input pin 5. On the Arduino Mega, SDA is digital pin 20 and SCL is 21. (See [https://www.arduino.cc/en/Guide/Libraries](https://www.arduino.cc/en/Reference/Wire))
+
+## Authors
+
+* **Alessandro Pasqualini** - [alessandro1105](https://github.com/alessandro1105)
+
+## Contributors
+
+This project has been developed with the contribution of [Futura Elettronica](http://www.futurashop.it), [Elettronica In](http://www.elettronicain.it), [Open Electronics](https://www.open-electronics.org).
+
+## License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details

examples/AdvancedSeismograph/AdvancedSeismograph.ino

@@ -0,0 +1,149 @@
+/*
+   Copyright 2017 Alessandro Pasqualini
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+     http://www.apache.org/licenses/LICENSE-2.0
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+   @author    Alessandro Pasqualini <[email protected]>
+   @url       https://github.com/alessandro1105
+
+   This project has been developed with the contribution of Futura Elettronica.
+   - http://www.futurashop.it
+   - http://www.elettronicain.it
+   - https://www.open-electronics.org
+*/
+
+#include <D7S.h>
+
+//old earthquake data
+float oldSI = 0;
+float oldPGA = 0;
+
+//flag variables to handle collapse/shutoff only one time during an earthquake
+bool shutoffHandled = false;
+bool collapseHandled = false;
+
+//function to handle shutoff event
+void handleShutoff() {
+  //put here the code to handle the shutoff event
+  Serial.println("-------------------- SHUTOFF! --------------------");
+  Serial.println("Shutting down all device!");
+  //stop all device
+  while (1)
+    ;
+}
+
+//function to handle collapse event
+void handleCollapse() {
+  //put here the code to handle the collapse event
+  Serial.println("-------------------- COLLAPSE! --------------------");
+}
+
+
+void setup() {
+  // Open serial communications and wait for port to open:
+  Serial.begin(9600);
+  while (!Serial) {
+    ; // wait for serial port to connect. Needed for native USB port only
+  }
+
+  //--- STARTING ---
+  Serial.print("Starting D7S communications (it may take some time)...");
+  //start D7S connection
+  D7S.begin();
+  //wait until the D7S is ready
+  while (!D7S.isReady()) {
+    Serial.print(".");
+    delay(500);
+  }
+  Serial.println("STARTED");
+
+  //--- SETTINGS ---
+  //setting the D7S to switch the axis at inizialization time
+  Serial.println("Setting D7S sensor to switch axis at inizialization time.");
+  D7S.setAxis(SWITCH_AT_INSTALLATION);
+
+  //--- INITIALIZZAZION ---
+  Serial.println("Initializing the D7S sensor in 2 seconds. Please keep it steady during the initializing process.");
+  delay(2000);
+  Serial.print("Initializing...");
+  //start the initial installation procedure
+  D7S.initialize();
+  //wait until the D7S is ready (the initializing process is ended)
+  while (!D7S.isReady()) {
+    Serial.print(".");
+    delay(500);
+  }
+  Serial.println("INITIALIZED!");
+
+  //--- CHECKING FOR PREVIUS COLLAPSE ---
+  //check if there there was a collapse (if this is the first time the D7S is put in place the installation data may be wrong)
+  if (D7S.isInCollapse()) {
+    handleCollapse();
+  }
+
+  //--- RESETTING EVENTS ---
+  //reset the events shutoff/collapse memorized into the D7S
+  D7S.resetEvents();
+
+  //--- READY TO GO ---
+  Serial.println("\nListening for earthquakes!");
+
+}
+
+void loop() {
+
+	//checking if there is an earthquake occuring right now
+  if (D7S.isEarthquakeOccuring()) {
+
+    //check if the shutoff event has been handled and if the shutoff condition is met
+    //the call of D7S.isInShutoff() is executed after to prevent useless I2C call
+    if (!shutoffHandled && D7S.isInShutoff()) {
+      handleShutoff();
+      shutoffHandled = true;
+    }
+
+    //check if the shutoff event has been handled and if the shutoff condition is met
+    //the call of D7S.isInShutoff() is executed after to prevent useless I2C call
+    if (!collapseHandled && D7S.isInCollapse()) {
+      handleCollapse();
+      collapseHandled = true;
+    }
+
+    //print information about the current earthquake
+    float currentSI = D7S.getInstantaneusSI();
+    float currentPGA = D7S.getInstantaneusPGA();
+
+    if (currentSI > oldSI || currentPGA > oldPGA) {
+      //getting instantaneus SI
+      Serial.print("\tInstantaneus SI: ");
+      Serial.print(currentSI);
+      Serial.println(" [m/s]");
+
+      //getting instantaneus PGA
+      Serial.print("\tInstantaneus PGA (Peak Ground Acceleration): ");
+      Serial.print(currentPGA);
+      Serial.println(" [m/s^2]\n");
+
+      //save the current data
+      oldSI = currentSI;
+      oldPGA = currentPGA;
+    }
+    
+  } else {
+    //reset the old earthquake data
+    oldPGA = 0;
+    oldSI = 0;
+    //reset the flag of the handled events
+    shutoffHandled = false;
+    collapseHandled = false;
+    //reset D7S events
+    D7S.resetEvents();
+  }
+}

examples/ClearMemory/ClearMemory.ino

@@ -0,0 +1,66 @@
+/*
+   Copyright 2017 Alessandro Pasqualini
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+     http://www.apache.org/licenses/LICENSE-2.0
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+   @author    Alessandro Pasqualini <[email protected]>
+   @url       https://github.com/alessandro1105
+
+   This project has been developed with the contribution of Futura Elettronica.
+   - http://www.futurashop.it
+   - http://www.elettronicain.it
+   - https://www.open-electronics.org
+*/
+
+#include <D7S.h>
+
+void setup() {
+  // Open serial communications and wait for port to open:
+  Serial.begin(9600);
+  while (!Serial) {
+    ; // wait for serial port to connect. Needed for native USB port only
+  }
+
+  //--- STARTING ---
+  Serial.print("Starting D7S communications (it may take some time)...");
+  //start D7S connection
+  D7S.begin();
+  Serial.println("STARTED\n");
+
+  //clearing earthquake measured data
+  Serial.print("Clearing earthquake data...");
+  D7S.clearEarthquakeData();
+  Serial.println("CLEARED!\n");
+
+  //clearing installation data
+  Serial.print("Clearing installation data...");
+  D7S.clearInstallationData();
+  Serial.println("CLEARED!\n");
+
+  //clearing lastest offset data
+  Serial.print("Clearing lastest offset data...");
+  D7S.clearLastestOffsetData();
+  Serial.println("CLEARED!\n");
+
+  //clearing selftest data
+  Serial.print("Clearing Earthquake data...");
+  D7S.clearSelftestData();
+  Serial.println("CLEARED!\n");
+
+  //clearing all data
+  Serial.print("Clearing all data...");
+  D7S.clearAllData();
+  Serial.println("CLEARED!\n");
+
+}
+
+void loop() {
+	// put your main code here, to run repeatedly:
+}

examples/LastestEarthquakes/LastestEarthquakes.ino

@@ -0,0 +1,68 @@
+/*
+   Copyright 2017 Alessandro Pasqualini
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+     http://www.apache.org/licenses/LICENSE-2.0
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+   @author    Alessandro Pasqualini <[email protected]>
+   @url       https://github.com/alessandro1105
+
+   This project has been developed with the contribution of Futura Elettronica.
+   - http://www.futurashop.it
+   - http://www.elettronicain.it
+   - https://www.open-electronics.org
+*/
+
+#include <D7S.h>
+
+void setup() {
+  // Open serial communications and wait for port to open:
+  Serial.begin(9600);
+  while (!Serial) {
+    ; // wait for serial port to connect. Needed for native USB port only
+  }
+
+  //--- STARTING ---
+  Serial.print("Starting D7S communications (it may take some time)...");
+  //start D7S connection
+  D7S.begin();
+  //wait until the D7S is ready
+  while (!D7S.isReady()) {
+    Serial.print(".");
+    delay(500);
+  }
+  Serial.println("STARTED\n");
+
+  //--- LASTEST DATA ---
+  Serial.println("--- LASTEST EARTHQUAKES MEASURED ---\n");
+  //print the lastest 5 earthquakes registered with all data
+  for (int i = 0; i < 5; i++) { //the index must be from 0 to 4 (5 earthquakes total)
+  	Serial.print("Earthquake n. ");
+  	Serial.println(i+1);
+
+  	//getting the lastest SI at index i
+  	Serial.print("\tSI: ");
+  	Serial.print(D7S.getLastestSI(i));
+  	Serial.println(" [m/s]");
+
+  	//getting the lastest PGA at index i
+  	Serial.print("\tPGA (Peak Ground Acceleration): ");
+  	Serial.print(D7S.getLastestPGA(i));
+  	Serial.println(" [m/s^2]");
+
+  	//getting the temperature at which the earthquake at index i has occured
+  	Serial.print("\tTemperature: ");
+  	Serial.print(D7S.getLastestTemperature(i));
+  	Serial.println(" [°C]\n");
+  }
+}
+
+void loop() {
+	// put your main code here, to run repeatedly:
+}

examples/RankedEarthquakes/RankedEarthquakes.ino

@@ -0,0 +1,68 @@
+/*
+   Copyright 2017 Alessandro Pasqualini
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+     http://www.apache.org/licenses/LICENSE-2.0
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+   @author    Alessandro Pasqualini <[email protected]>
+   @url       https://github.com/alessandro1105
+
+   This project has been developed with the contribution of Futura Elettronica.
+   - http://www.futurashop.it
+   - http://www.elettronicain.it
+   - https://www.open-electronics.org
+*/
+
+#include <D7S.h>
+
+void setup() {
+  // Open serial communications and wait for port to open:
+  Serial.begin(9600);
+  while (!Serial) {
+    ; // wait for serial port to connect. Needed for native USB port only
+  }
+
+  //--- STARTING ---
+  Serial.print("Starting D7S communications (it may take some time)...");
+  //start D7S connection
+  D7S.begin();
+  //wait until the D7S is ready
+  while (!D7S.isReady()) {
+    Serial.print(".");
+    delay(500);
+  }
+  Serial.println("STARTED\n");
+
+  //--- LASTEST DATA ---
+  Serial.println("--- RANKED EARTHQUAKES BY SI ---\n");
+  //print the 5 greatest earthquakes registered with all data
+  for (int i = 0; i < 5; i++) { //the index must be from 0 to 4 (5 earthquakes in total)
+  	Serial.print("Earthquake in postion ");
+  	Serial.println(i+1);
+
+  	//getting the ranked SI at position i
+  	Serial.print("\tSI: ");
+  	Serial.print(D7S.getRankedSI(i));
+  	Serial.println(" [m/s]");
+
+  	//getting the ranked PGA at position i
+  	Serial.print("\tPGA (Peak Ground Acceleration): ");
+  	Serial.print(D7S.getRankedPGA(i));
+  	Serial.println(" [m/s^2]");
+
+  	//getting the temperature at which the earthquake at position i has occured
+  	Serial.print("\tTemperature: ");
+  	Serial.print(D7S.getRankedTemperature(i));
+  	Serial.println(" [°C]\n");
+  }
+}
+
+void loop() {
+	// put your main code here, to run repeatedly:
+}