add docs/api.md

Author: leonardocavagnis

docs/api.md

@@ -0,0 +1,175 @@
+# Arduino Modulino Library API
+
+## Summary
+
+ Members                                    | Descriptions
+--------------------------------------------|------------------------------------------
+| `class` [`ModulinoClass`](#modulinoclass)   | The base class for all Modulino components, providing essential functionality and structure for all subsequent Modulino modules.                                  |
+| `class` [`ModulinoButtons`](#modulinobuttons)  | Handles the functionality of Modulino Buttons, enabling detection of presses and handling input events.                                                |
+| `class` [`ModulinoBuzzer`](#modulinobuttons)   |Handles the functionality of Modulino Buzzer, enabling the sound generation for feedback or alerts.                                                    |
+| `class` [`ModulinoPixels`](#modulinopixels)    | Handles the functionality of Modulino Pixels, managing LEDs strip color, status and brightness.                                          |
+| `class` [`ModulinoKnob`](#modulinoknob)       | Handles the functionality of Modulino Knob, interfacing with the rotary knob position.                                                     |
+| `class` [`ModulinoMovement`](#modulinomovement) | Handles the functionality of Modulino Movement,interfacing with the IMU sensor to get acceleration readings. |
+| `class` [`ModulinoThermo`](#modulinothermo)   | Handles the functionality of Modulino Thermo, managing temperature sensors to provide real-time temperature and humidity readings.                                |
+| `class` [`ModulinoPressure`](#modulinopressure) | Handles the functionality of Modulino Pressure, interfacing with pressure sensors to get atmospheric pressure. |
+
+### ModulinoClass
+
+The `ModulinoClass` is the main class that handles the initialization of the I2C communication bus.
+
+#### Methods
+
+- **`void begin(HardwareI2C& wire = Wire)`**  
+  Initializes the I2C communication. The default I2C bus is `Wire`, but you can specify another one (e.g., `Wire1`).
+
+---
+
+### ModulinoButtons
+
+Represents a Modulino Buttons module.
+
+#### Methods
+
+- **`PinStatus isPressed(int index)`**  
+  Returns the press status (HIGH/LOW) of the button at the specified index (_0-A, 1-B, 2-C_).
+
+- **`bool update()`**  
+  Updates the button status. Returns `true` if the status has changed, `false` otherwise.
+
+- **`void setLeds(bool a, bool b, bool c)`**  
+  Sets the LED states. Each argument corresponds to one LED's state (on/off).
+
+---
+
+### ModulinoBuzzer
+
+Represents a Modulino Buzzer module.
+
+#### Methods
+
+- **`void tone(size_t freq, size_t len_ms)`**  
+  Plays a tone at the specified frequency (`freq`) and duration (`len_ms`).
+
+- **`void noTone()`**  
+  Stops any tone currently playing.
+
+---
+
+### ModulinoPixels
+
+Represents a Modulino Pixels module.
+
+#### Methods
+
+- **`void set(int idx, ModulinoColor rgb, uint8_t brightness = 25)`**  
+  Sets the color of the LED at the specified index.
+
+- **`void set(int idx, uint8_t r, uint8_t g, uint8_t b, uint8_t brightness = 5)`**  
+  Sets the color of the LED at the specified index using RGB values.
+
+- **`void clear(int idx)`**  
+  Clears the LED at the specified index (turns it off).
+
+- **`void clear()`**  
+  Clears all LEDs (turns them all off).
+
+- **`void show()`**  
+  Updates the LEDs to display the current color data.
+
+---
+
+### ModulinoKnob
+
+Represents a Modulino Knob module.
+
+#### Methods
+
+- **`int16_t get()`**  
+  Gets the current value of the knob.
+
+- **`bool isPressed()`**  
+  Returns `true` if the button on the knob is pressed, `false` otherwise.
+
+- **`void set(int16_t value)`**  
+  Sets the knob value.
+
+---
+
+### ModulinoMovement
+
+Represents a Modulino Movement module.
+
+#### Methods
+
+- **`int update()`**  
+  Updates the sensor data and reads the acceleration values.
+
+- **`int available()`**  
+  Returns `true` if acceleration data is available.
+
+- **`float getX()`**  
+  Returns the X-axis acceleration.
+
+- **`float getY()`**  
+  Returns the Y-axis acceleration.
+
+- **`float getZ()`**  
+  Returns the Z-axis acceleration.
+
+---
+
+### ModulinoThermo
+
+Represents a Modulino Thermo module.
+
+#### Methods
+
+- **`float getHumidity()`**  
+  Returns the humidity reading.
+
+- **`float getTemperature()`**  
+  Returns the temperature reading.
+
+---
+
+### ModulinoPressure
+
+Represents a Modulino Pressure module.
+
+#### Methods
+
+- **`float getPressure()`**  
+  Returns the pressure reading.
+
+- **`float getTemperature()`**  
+  Returns the temperature reading.
+
+## Constants
+
+- **`ModulinoColor RED`**  
+  Represents the color red for Modulino Pixels modules.
+
+- **`ModulinoColor BLUE`**  
+  Represents the color blue for Modulino Pixels modules.
+
+- **`ModulinoColor GREEN`**  
+  Represents the color green for Modulino Pixels modules.
+
+- **`ModulinoColor VIOLET`**  
+  Represents the color violet for Modulino Pixels modules.
+
+- **`ModulinoColor WHITE`**  
+  Represents the color white for Modulino Pixels modules.
+
+### ModulinoColor
+
+Represents a color for Modulino Pixels modules.
+
+#### Constructor
+
+- **`ModulinoColor(uint8_t r, uint8_t g, uint8_t b)`**  
+  Creates a color with the specified red (`r`), green (`g`), and blue (`b`) components.
+
+## License
+
+This library is released under the [LGPLv2.1 license](../LICENSE).