diff --git a/docs/readme.md b/docs/readme.md index de7bc45..89fdd82 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -25,7 +25,7 @@ The **Modulino** library supports the following hardware modules: To initialize the **Modulino** library, include the header file and call the `begin()` method. This will set up the I2C communication and prepare the library for use with the modules. ```cpp -#include +#include Modulino.begin(); // Initialize the Modulino library ``` @@ -124,7 +124,7 @@ Here’s an example of how to use some Modulino in a program: // This sketch demonstrates how to use the Modulino library to control buttons, LEDs, and a buzzer. // It listens for a button press (Button A), turns on the LED 0, and plays a sound through the buzzer when pressed. -#include +#include ModulinoButtons buttons; // Declare a Buttons Modulino ModulinoPixels leds; // Declare a Pixels Modulino diff --git a/examples/Modulino_Buttons/Button2Integration/Button2Integration.ino b/examples/Modulino_Buttons/Button2Integration/Button2Integration.ino index 9f092c0..0389ae8 100644 --- a/examples/Modulino_Buttons/Button2Integration/Button2Integration.ino +++ b/examples/Modulino_Buttons/Button2Integration/Button2Integration.ino @@ -7,7 +7,7 @@ * SPDX-License-Identifier: MPL-2.0 */ -#include "Modulino.h" +#include #include "Button2.h" Button2 button; diff --git a/examples/Modulino_Buttons/Buttons_Basic/Buttons_Basic.ino b/examples/Modulino_Buttons/Buttons_Basic/Buttons_Basic.ino index d69f13f..fd81102 100644 --- a/examples/Modulino_Buttons/Buttons_Basic/Buttons_Basic.ino +++ b/examples/Modulino_Buttons/Buttons_Basic/Buttons_Basic.ino @@ -1,12 +1,12 @@ /* * Modulino Buttons - Basic * - * This example code is in the public domain. + * This example code is in the public domain. * Copyright (c) 2025 Arduino * SPDX-License-Identifier: MPL-2.0 */ -#include +#include // Create a ModulinoButtons object ModulinoButtons buttons; @@ -36,4 +36,4 @@ void loop() { Serial.println("Button C pressed!"); } } -} \ No newline at end of file +} diff --git a/examples/Modulino_Buzzer/Buzzer_Basic/Buzzer_Basic.ino b/examples/Modulino_Buzzer/Buzzer_Basic/Buzzer_Basic.ino index 47ebcf9..bf3238f 100644 --- a/examples/Modulino_Buzzer/Buzzer_Basic/Buzzer_Basic.ino +++ b/examples/Modulino_Buzzer/Buzzer_Basic/Buzzer_Basic.ino @@ -1,12 +1,12 @@ /* * Modulino Buzzer - Basic * - * This example code is in the public domain. + * This example code is in the public domain. * Copyright (c) 2025 Arduino * SPDX-License-Identifier: MPL-2.0 */ -#include +#include // Create a ModulinoBuzzer object ModulinoBuzzer buzzer; @@ -30,4 +30,4 @@ void loop(){ buzzer.tone(0, duration); delay(1000); -} \ No newline at end of file +} diff --git a/examples/Modulino_Buzzer/Simple_melody/Simple_melody.ino b/examples/Modulino_Buzzer/Simple_melody/Simple_melody.ino index ba27151..bd6cf8d 100644 --- a/examples/Modulino_Buzzer/Simple_melody/Simple_melody.ino +++ b/examples/Modulino_Buzzer/Simple_melody/Simple_melody.ino @@ -1,12 +1,12 @@ /* * Modulino Buzzer - Simple melody * - * This example code is in the public domain. + * This example code is in the public domain. * Copyright (c) 2025 Arduino * SPDX-License-Identifier: MPL-2.0 */ -#include +#include // Create a ModulinoBuzzer object ModulinoBuzzer buzzer; @@ -31,4 +31,4 @@ void loop() { delay(250); } -} \ No newline at end of file +} diff --git a/examples/Modulino_Buzzer/Theremin/Theremin.ino b/examples/Modulino_Buzzer/Theremin/Theremin.ino index fd79184..9f3fd71 100644 --- a/examples/Modulino_Buzzer/Theremin/Theremin.ino +++ b/examples/Modulino_Buzzer/Theremin/Theremin.ino @@ -1,4 +1,4 @@ -#include "Modulino.h" +#include ModulinoBuzzer buzzer; ModulinoDistance distance; diff --git a/examples/Modulino_Distance/Distance_Basic/Distance_Basic.ino b/examples/Modulino_Distance/Distance_Basic/Distance_Basic.ino index 08e298e..0765519 100644 --- a/examples/Modulino_Distance/Distance_Basic/Distance_Basic.ino +++ b/examples/Modulino_Distance/Distance_Basic/Distance_Basic.ino @@ -6,7 +6,7 @@ * SPDX-License-Identifier: MPL-2.0 */ -#include "Modulino.h" +#include // Create a ModulinoDistance object ModulinoDistance distance; diff --git a/examples/Modulino_Knob/Encoder_Setter/Encoder_Setter.ino b/examples/Modulino_Knob/Encoder_Setter/Encoder_Setter.ino index 9f91112..81a491c 100644 --- a/examples/Modulino_Knob/Encoder_Setter/Encoder_Setter.ino +++ b/examples/Modulino_Knob/Encoder_Setter/Encoder_Setter.ino @@ -6,7 +6,7 @@ * SPDX-License-Identifier: MPL-2.0 */ -#include "Modulino.h" +#include // Create objects for the modules ModulinoKnob encoder; diff --git a/examples/Modulino_Knob/Knob_Basic/Knob_Basic.ino b/examples/Modulino_Knob/Knob_Basic/Knob_Basic.ino index b933002..d836629 100644 --- a/examples/Modulino_Knob/Knob_Basic/Knob_Basic.ino +++ b/examples/Modulino_Knob/Knob_Basic/Knob_Basic.ino @@ -1,12 +1,12 @@ /* * Modulino Knob - Basic * - * This example code is in the public domain. + * This example code is in the public domain. * Copyright (c) 2025 Arduino * SPDX-License-Identifier: MPL-2.0 */ -#include +#include // Create a ModulinoKnob object ModulinoKnob knob; @@ -32,4 +32,4 @@ void loop(){ Serial.println("Clicked!"); } -} \ No newline at end of file +} diff --git a/examples/Modulino_Movement/Movement_Basic/Movement_Basic.ino b/examples/Modulino_Movement/Movement_Basic/Movement_Basic.ino index 8de9a97..28c489c 100644 --- a/examples/Modulino_Movement/Movement_Basic/Movement_Basic.ino +++ b/examples/Modulino_Movement/Movement_Basic/Movement_Basic.ino @@ -6,7 +6,7 @@ * SPDX-License-Identifier: MPL-2.0 */ -#include "Modulino.h" +#include // Create a ModulinoMovement ModulinoMovement movement; diff --git a/examples/Modulino_Pixels/Pixels_Basic/Pixels_Basic.ino b/examples/Modulino_Pixels/Pixels_Basic/Pixels_Basic.ino index 69be734..9c919be 100644 --- a/examples/Modulino_Pixels/Pixels_Basic/Pixels_Basic.ino +++ b/examples/Modulino_Pixels/Pixels_Basic/Pixels_Basic.ino @@ -1,12 +1,12 @@ /* * Modulino Pixels - Basic * - * This example code is in the public domain. + * This example code is in the public domain. * Copyright (c) 2025 Arduino * SPDX-License-Identifier: MPL-2.0 */ -#include +#include // Create a ModulinoPixels object ModulinoPixels leds; @@ -29,4 +29,4 @@ void loop(){ // Update the physical LEDs with new settings leds.show(); } -} \ No newline at end of file +} diff --git a/examples/Modulino_Pixels/Simple_Animation/Simple_Animation.ino b/examples/Modulino_Pixels/Simple_Animation/Simple_Animation.ino index 40c1c26..1f77b4b 100644 --- a/examples/Modulino_Pixels/Simple_Animation/Simple_Animation.ino +++ b/examples/Modulino_Pixels/Simple_Animation/Simple_Animation.ino @@ -1,12 +1,12 @@ /* * Modulino Pixels - Simple Animation * - * This example code is in the public domain. + * This example code is in the public domain. * Copyright (c) 2025 Arduino * SPDX-License-Identifier: MPL-2.0 */ -#include +#include // Create a ModulinoPixels object for the LED array ModulinoPixels leds; @@ -54,4 +54,4 @@ void loop() { void setPixel(int pixel, ModulinoColor color) { leds.set(pixel, color, brightness); leds.show(); -} \ No newline at end of file +} diff --git a/examples/Modulino_Thermo/Temperature_Humidity_Matrix/Temperature_Humidity_Matrix.ino b/examples/Modulino_Thermo/Temperature_Humidity_Matrix/Temperature_Humidity_Matrix.ino index 57de8de..995f59d 100644 --- a/examples/Modulino_Thermo/Temperature_Humidity_Matrix/Temperature_Humidity_Matrix.ino +++ b/examples/Modulino_Thermo/Temperature_Humidity_Matrix/Temperature_Humidity_Matrix.ino @@ -6,7 +6,7 @@ * SPDX-License-Identifier: MPL-2.0 */ -#include "Modulino.h" +#include #include "ArduinoGraphics.h" #include "Arduino_LED_Matrix.h" diff --git a/examples/Modulino_Thermo/Thermo_Basic/Thermo_Basic.ino b/examples/Modulino_Thermo/Thermo_Basic/Thermo_Basic.ino index d219fce..8f36b96 100644 --- a/examples/Modulino_Thermo/Thermo_Basic/Thermo_Basic.ino +++ b/examples/Modulino_Thermo/Thermo_Basic/Thermo_Basic.ino @@ -1,12 +1,12 @@ /* * Modulino Thermo - Basic * - * This example code is in the public domain. + * This example code is in the public domain. * Copyright (c) 2025 Arduino * SPDX-License-Identifier: MPL-2.0 */ -#include +#include // Create object instance ModulinoThermo thermo; @@ -39,4 +39,4 @@ void loop(){ Serial.print("Humidity (rH) is: "); Serial.println(humidity); -} \ No newline at end of file +} diff --git a/examples/Utilities/FirmwareUpdater/FirmwareUpdater.ino b/examples/Utilities/FirmwareUpdater/FirmwareUpdater.ino index 3d6068a..5e8144c 100644 --- a/examples/Utilities/FirmwareUpdater/FirmwareUpdater.ino +++ b/examples/Utilities/FirmwareUpdater/FirmwareUpdater.ino @@ -11,7 +11,7 @@ #include "Arduino_LED_Matrix.h" #endif -#include "Modulino.h" +#include #include "Wire.h" #include "fw.h" diff --git a/examples/Utilities/Modulino_PlugNPlay/Modulino_PlugNPlay.ino b/examples/Utilities/Modulino_PlugNPlay/Modulino_PlugNPlay.ino index 5fcc7cf..b7f9131 100644 --- a/examples/Utilities/Modulino_PlugNPlay/Modulino_PlugNPlay.ino +++ b/examples/Utilities/Modulino_PlugNPlay/Modulino_PlugNPlay.ino @@ -6,7 +6,7 @@ * SPDX-License-Identifier: MPL-2.0 */ -#include "Modulino.h" +#include // Create objects for all Modulino modules ModulinoButtons buttons; diff --git a/library.properties b/library.properties index 7e1d04b..90bf5e3 100644 --- a/library.properties +++ b/library.properties @@ -1,4 +1,4 @@ -name=Modulino +name=Arduino_Modulino version=0.4.3 author=Arduino maintainer=Arduino @@ -7,5 +7,5 @@ paragraph= category=Communication url=https://github.com/arduino-libraries/Modulino architectures=* -includes=Modulino.h +includes=Arduino_Modulino.h depends=STM32duino VL53L4CD,STM32duino VL53L4ED,Arduino_LSM6DSOX,Arduino_LPS22HB,Arduino_HS300x,ArduinoGraphics diff --git a/src/Arduino_Modulino.h b/src/Arduino_Modulino.h new file mode 100644 index 0000000..f0d4f42 --- /dev/null +++ b/src/Arduino_Modulino.h @@ -0,0 +1 @@ +#include "Modulino.h"