Merge pull request #5 from canchebagur/add-docs

Add docs folder

Author: aentinger

docs/api.md

@@ -0,0 +1,340 @@
+# ArduinoLSM6DSOX library
+
+## Methods
+
+### `begin()`
+
+Initialize the IMU.
+
+#### Syntax 
+
+```
+IMU.begin()
+```
+
+#### Parameters
+
+None.
+
+#### Returns
+
+1 on success, 0 on failure.
+
+#### Example
+
+```
+if (!IMU.begin()) {
+    Serial.println("Failed to initialize IMU!");
+    while (1);
+}
+```
+
+#### See also
+
+* [end()](#end)
+* [readAcceleration()](#readAcceleration)
+* [readGyroscope()](#readGyroscope)
+* [accelerationAvailable()](#accelerationAvailable)
+* [gyroscopeAvailable()](#gyroscopeAvailable)
+* [accelerationSampleRate()](#accelerationSampleRate)
+* [gyroscopeSampleRate()](#gyroscopeSampleRate)
+
+### `end()`
+
+De-initialize the IMU.
+
+#### Syntax 
+
+```
+IMU.end()
+```
+
+#### Parameters
+
+None.
+
+#### Returns
+
+None.
+
+#### Example
+
+```
+if (!IMU.begin()) {
+    Serial.println("Failed to initialize IMU!");
+    while (1);
+}
+
+// Read IMU data...
+
+// Done with the IMU readings
+IMU.end();
+```
+
+#### See also
+
+* [begin()](#begin)
+* [readAcceleration()](#readAcceleration)
+* [readGyroscope()](#readGyroscope)
+* [accelerationAvailable()](#accelerationAvailable)
+* [gyroscopeAvailable()](#gyroscopeAvailable)
+* [accelerationSampleRate()](#accelerationSampleRate)
+* [gyroscopeSampleRate()](#gyroscopeSampleRate)
+
+### `readAcceleration()`
+
+Query the IMU's accelerometer and return the acceleration in g's. 
+
+#### Syntax 
+
+```
+IMU.readAcceleration(x,y,z)
+```
+
+#### Parameters
+
+* _x_: float variable where the acceleration value in the IMU's x-axis will be stored.
+* _y_: float variable where the acceleration value in the IMU's y-axis will be stored.
+* _z_: float variable where the acceleration value in the IMU's z-axis will be stored.
+
+#### Returns
+
+1 on success, 0 on failure.
+
+#### Example
+
+```
+float x, y, z;
+
+if (IMU.accelerationAvailable()) {
+    IMU.readAcceleration(x, y, z);
+
+    Serial.print(x);
+    Serial.print('\t');
+    Serial.print(y);
+    Serial.print('\t');
+    Serial.println(z);
+}
+```
+
+#### See also
+
+* [begin()](#begin)
+* [end()](#end)
+* [readGyroscope()](#readGyroscope)
+* [accelerationAvailable()](#accelerationAvailable)
+* [gyroscopeAvailable()](#gyroscopeAvailable)
+* [accelerationSampleRate()](#accelerationSampleRate)
+* [gyroscopeSampleRate()](#gyroscopeSampleRate)
+
+### `readGyroscope()`
+
+Query the IMU's gyroscope and return the angular speed in dps (degrees per second).
+
+#### Syntax 
+
+```
+IMU.readGyroscope(x,y,z)
+```
+
+#### Parameters
+
+* _x_: float variable where the gyroscope value in the IMU's x-axis will be stored.
+* _y_: float variable where the gyroscope value in the IMU's y-axis will be stored.
+* _z_: float variable where the gyroscope value in the IMU's z-axis will be stored.
+
+#### Returns
+
+1 on success, 0 on failure.
+
+#### Example
+
+```
+float x, y, z;
+
+if (IMU.gyroscopeAvailable()) {
+    IMU.readGyroscope(x, y, z);
+
+    Serial.print(x);
+    Serial.print('\t');
+    Serial.print(y);
+    Serial.print('\t');
+    Serial.println(z);
+}
+```
+
+#### See also
+
+* [begin()](#begin)
+* [end()](#end)
+* [readAcceleration()](#readAcceleration)
+* [accelerationAvailable()](#accelerationAvailable)
+* [gyroscopeAvailable()](#gyroscopeAvailable)
+* [accelerationSampleRate()](#accelerationSampleRate)
+* [gyroscopeSampleRate()](#gyroscopeSampleRate)
+
+### `accelerationAvailable()`
+
+Query if new acceleration data from the IMU is available.
+
+#### Syntax 
+
+```
+IMU.accelerationAvailable()
+```
+
+#### Parameters
+
+None.
+
+#### Returns
+
+0 if no new acceleration data is available, 1 if new acceleration data is available.
+
+#### Example
+
+```
+float x, y, z;
+
+if (IMU.accelerationAvailable()) {
+    IMU.readAcceleration(x, y, z);
+
+    Serial.print(x);
+    Serial.print('\t');
+    Serial.print(y);
+    Serial.print('\t');
+    Serial.println(z);
+}
+```
+
+#### See also
+
+* [begin()](#begin)
+* [end()](#end)
+* [readAcceleration()](#readAcceleration)
+* [readGyroscope()](#readGyroscope)
+* [gyroscopeAvailable()](#gyroscopeAvailable)
+* [accelerationSampleRate()](#accelerationSampleRate)
+* [gyroscopeSampleRate()](#gyroscopeSampleRate)
+
+### `gyroscopeAvailable()`
+
+Query if new gyroscope data from the IMU is available.
+
+#### Syntax 
+
+```
+IMU.gyroscopeAvailable()
+```
+
+#### Parameters
+
+None.
+
+#### Returns
+
+0 if no new gyroscope data is available, 1 if new gyroscope data is available.
+
+#### Example
+
+```
+float x, y, z;
+
+if (IMU.gyroscopeAvailable()) {
+    IMU.readGyroscope(x, y, z);
+
+    Serial.print(x);
+    Serial.print('\t');
+    Serial.print(y);
+    Serial.print('\t');
+    Serial.println(z);
+}
+```
+
+#### See also
+
+* [begin()](#begin)
+* [end()](#end)
+* [readAcceleration()](#readAcceleration)
+* [readGyroscope()](#readGyroscope)
+* [accelerationAvailable()](#accelerationAvailable)
+* [accelerationSampleRate()](#accelerationSampleRate)
+* [gyroscopeSampleRate()](#gyroscopeSampleRate)
+
+### `accelerationSampleRate()`
+
+Return the IMU's accelerometer sample rate.
+
+#### Syntax 
+
+```
+IMU.accelerationSampleRate()
+```
+
+#### Parameters
+
+None.
+
+#### Returns
+
+The IMU's accelerometer sample rate in Hz.
+
+#### Example
+
+```
+Serial.print("Accelerometer sample rate = ");
+Serial.print(IMU.accelerationSampleRate());
+Serial.println(" Hz");
+Serial.println();
+Serial.println("Acceleration in g's");
+Serial.println("X\tY\tZ");
+```
+
+#### See also
+
+* [begin()](#begin)
+* [end()](#end)
+* [readAcceleration()](#readAcceleration)
+* [readGyroscope()](#readGyroscope)
+* [accelerationAvailable()](#accelerationAvailable)
+* [gyroscopeAvailable()](#gyroscopeAvailable)
+* [gyroscopeSampleRate()](#gyroscopeSampleRate)
+
+### `gyroscopeSampleRate()`
+
+Return the IMU's gyroscope sample rate.
+
+#### Syntax 
+
+```
+IMU.gyroscopeSampleRate()
+```
+
+#### Parameters
+
+None.
+
+#### Returns
+
+The IMU's gyroscope sample rate in Hz.
+
+#### Example
+
+```
+Serial.print("Gyroscope sample rate = ");
+Serial.print(IMU.gyroscopeSampleRate());
+Serial.println(" Hz");
+Serial.println();
+Serial.println("Angular speed in degrees/second");
+Serial.println("X\tY\tZ");
+```
+
+#### See also
+
+* [begin()](#begin)
+* [end()](#end)
+* [readAcceleration()](#readAcceleration)
+* [readGyroscope()](#readGyroscope)
+* [accelerationAvailable()](#accelerationAvailable)
+* [gyroscopeAvailable()](#gyroscopeAvailable)
+* [accelerationSampleRate()](#accelerationSampleRate)

docs/readme.md

@@ -0,0 +1,17 @@
+# ArduinoLSM6DSOX library
+
+
+The ArduinoLSM6DSOX library allows you to use the inertial measurement unit (IMU) available on the Arduino® Nano RP2040 Connect board. The IMU is a LSM6DSOX, it is a 3-axis accelerometer and 3-axis gyroscope. The IMU is connected to the Nano RP2040 Connect board's microcontroller through I2C. The values returned are signed floats.
+
+To use this library:
+
+```
+#include <Arduino_LSM6DSOX.h>
+```
+
+The ArduinoLSM6DSOX library takes care of the sensor initialization and sets its values as follows:
+
+- Accelerometer range is set at ±4 g with a resolution of 0.122 mg.
+- Gyroscope range is set at ±2000 dps with a resolution of 70 mdps.
+- Accelerometer and gyrospcope output data rate is fixed at 104 Hz.
+