Skip to content

docs: Update the library name to include the Arduino prefix #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
4 changes: 2 additions & 2 deletions docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <Modulino.h>
#include <Arduino_Modulino.h>
Modulino.begin(); // Initialize the Modulino library
```

Expand Down Expand Up @@ -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 <Modulino.h>
#include <Arduino_Modulino.h>

ModulinoButtons buttons; // Declare a Buttons Modulino
ModulinoPixels leds; // Declare a Pixels Modulino
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
* SPDX-License-Identifier: MPL-2.0
*/

#include "Modulino.h"
#include <Arduino_Modulino.h>
#include "Button2.h"

Button2 button;
Expand Down
6 changes: 3 additions & 3 deletions examples/Modulino_Buttons/Buttons_Basic/Buttons_Basic.ino
Original file line number Diff line number Diff line change
@@ -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 <Modulino.h>
#include <Arduino_Modulino.h>

// Create a ModulinoButtons object
ModulinoButtons buttons;
Expand Down Expand Up @@ -36,4 +36,4 @@ void loop() {
Serial.println("Button C pressed!");
}
}
}
}
6 changes: 3 additions & 3 deletions examples/Modulino_Buzzer/Buzzer_Basic/Buzzer_Basic.ino
Original file line number Diff line number Diff line change
@@ -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 <Modulino.h>
#include <Arduino_Modulino.h>

// Create a ModulinoBuzzer object
ModulinoBuzzer buzzer;
Expand All @@ -30,4 +30,4 @@ void loop(){
buzzer.tone(0, duration);
delay(1000);

}
}
6 changes: 3 additions & 3 deletions examples/Modulino_Buzzer/Simple_melody/Simple_melody.ino
Original file line number Diff line number Diff line change
@@ -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 <Modulino.h>
#include <Arduino_Modulino.h>

// Create a ModulinoBuzzer object
ModulinoBuzzer buzzer;
Expand All @@ -31,4 +31,4 @@ void loop() {
delay(250);

}
}
}
2 changes: 1 addition & 1 deletion examples/Modulino_Buzzer/Theremin/Theremin.ino
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#include "Modulino.h"
#include <Arduino_Modulino.h>

ModulinoBuzzer buzzer;
ModulinoDistance distance;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
* SPDX-License-Identifier: MPL-2.0
*/

#include "Modulino.h"
#include <Arduino_Modulino.h>

// Create a ModulinoDistance object
ModulinoDistance distance;
Expand Down
2 changes: 1 addition & 1 deletion examples/Modulino_Knob/Encoder_Setter/Encoder_Setter.ino
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
* SPDX-License-Identifier: MPL-2.0
*/

#include "Modulino.h"
#include <Arduino_Modulino.h>

// Create objects for the modules
ModulinoKnob encoder;
Expand Down
6 changes: 3 additions & 3 deletions examples/Modulino_Knob/Knob_Basic/Knob_Basic.ino
Original file line number Diff line number Diff line change
@@ -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 <Modulino.h>
#include <Arduino_Modulino.h>

// Create a ModulinoKnob object
ModulinoKnob knob;
Expand All @@ -32,4 +32,4 @@ void loop(){
Serial.println("Clicked!");
}

}
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
* SPDX-License-Identifier: MPL-2.0
*/

#include "Modulino.h"
#include <Arduino_Modulino.h>

// Create a ModulinoMovement
ModulinoMovement movement;
Expand Down
6 changes: 3 additions & 3 deletions examples/Modulino_Pixels/Pixels_Basic/Pixels_Basic.ino
Original file line number Diff line number Diff line change
@@ -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 <Modulino.h>
#include <Arduino_Modulino.h>

// Create a ModulinoPixels object
ModulinoPixels leds;
Expand All @@ -29,4 +29,4 @@ void loop(){
// Update the physical LEDs with new settings
leds.show();
}
}
}
Original file line number Diff line number Diff line change
@@ -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 <Modulino.h>
#include <Arduino_Modulino.h>

// Create a ModulinoPixels object for the LED array
ModulinoPixels leds;
Expand Down Expand Up @@ -54,4 +54,4 @@ void loop() {
void setPixel(int pixel, ModulinoColor color) {
leds.set(pixel, color, brightness);
leds.show();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
* SPDX-License-Identifier: MPL-2.0
*/

#include "Modulino.h"
#include <Arduino_Modulino.h>
#include "ArduinoGraphics.h"
#include "Arduino_LED_Matrix.h"

Expand Down
6 changes: 3 additions & 3 deletions examples/Modulino_Thermo/Thermo_Basic/Thermo_Basic.ino
Original file line number Diff line number Diff line change
@@ -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 <Modulino.h>
#include <Arduino_Modulino.h>

// Create object instance
ModulinoThermo thermo;
Expand Down Expand Up @@ -39,4 +39,4 @@ void loop(){
Serial.print("Humidity (rH) is: ");
Serial.println(humidity);

}
}
2 changes: 1 addition & 1 deletion examples/Utilities/FirmwareUpdater/FirmwareUpdater.ino
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
#include "Arduino_LED_Matrix.h"
#endif

#include "Modulino.h"
#include <Arduino_Modulino.h>
#include "Wire.h"
#include "fw.h"

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
* SPDX-License-Identifier: MPL-2.0
*/

#include "Modulino.h"
#include <Arduino_Modulino.h>

// Create objects for all Modulino modules
ModulinoButtons buttons;
Expand Down
4 changes: 2 additions & 2 deletions library.properties
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name=Modulino
name=Arduino_Modulino
version=0.4.3
author=Arduino
maintainer=Arduino <[email protected]>
Expand All @@ -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
1 change: 1 addition & 0 deletions src/Arduino_Modulino.h
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#include "Modulino.h"