diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/compatibility.yml b/content/hardware/03.nano/carriers/nano-connector-carrier/compatibility.yml new file mode 100644 index 0000000000..fd623b1d12 --- /dev/null +++ b/content/hardware/03.nano/carriers/nano-connector-carrier/compatibility.yml @@ -0,0 +1,17 @@ +software: + - arduino-ide + - arduino-cli + - cloud-editor +hardware: + shields: ~ + carriers: ~ + boards: + - nano-33-iot + - nano + - nano-33-ble-sense + - nano-33-ble + - nano-every + - nano-rp2040-connect + - nano-esp32 + - nano-every + - nano-matter diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/ASX00061-datasheet.pdf b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/ASX00061-datasheet.pdf new file mode 100644 index 0000000000..bcdbdef74c Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/ASX00061-datasheet.pdf differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/ASX00061-pinout-v2.png b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/ASX00061-pinout-v2.png new file mode 100644 index 0000000000..d0ea11d6d7 Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/ASX00061-pinout-v2.png differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/Block_Diagram.png b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/Block_Diagram.png new file mode 100644 index 0000000000..3586893b6d Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/Block_Diagram.png differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/board-selector.png b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/board-selector.png new file mode 100644 index 0000000000..477a49e28b Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/board-selector.png differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/connectors-rect.png b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/connectors-rect.png new file mode 100644 index 0000000000..e874cb0ede Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/connectors-rect.png differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/dimensions-rect.png b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/dimensions-rect.png new file mode 100644 index 0000000000..cbcc884f41 Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/dimensions-rect.png differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/grove.png b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/grove.png new file mode 100644 index 0000000000..bbfeba009d Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/grove.png differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/nano-connector-top.png b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/nano-connector-top.png new file mode 100644 index 0000000000..0f578e8c6a Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/nano-connector-top.png differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/power-tree.png b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/power-tree.png new file mode 100644 index 0000000000..217d8f513f Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/power-tree.png differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/qwiic.png b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/qwiic.png new file mode 100644 index 0000000000..3f54d935f4 Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/qwiic.png differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/sd.png b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/sd.png new file mode 100644 index 0000000000..6edf269607 Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/sd.png differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/topology.jpg b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/topology.jpg new file mode 100644 index 0000000000..6fd7e832be Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/assets/topology.jpg differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/datasheet.md b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/datasheet.md new file mode 100644 index 0000000000..e2e0f6681e --- /dev/null +++ b/content/hardware/03.nano/carriers/nano-connector-carrier/datasheet/datasheet.md @@ -0,0 +1,368 @@ +--- +identifier: ASX00061 +title: Nano Connector Carrier +type: maker +variant: 'Datasheet' +author: Christopher Méndez +--- + +![](assets/nano-connector-top.png) + +# Description + +The Nano Connector Carrier is a practical solution for expanding the capabilities of our Nano product family. It is plug-and-play compatible with Qwiic and Grove modules, making rapid prototyping easier than ever. + +Whether diving into MicroPython or Matter, building with Modulinos, or developing AI-powered applications, this carrier provides a simple platform for bringing your ideas to life. + +The onboard microSD card slot unlocks new possibilities for data logging, Edge AI and real-time storage needs. + +# Target Areas: + +Industrial Automation, Rapid Prototyping, Proof of Concept, Edge AI, Research and Development + +# CONTENTS + +## Application Examples + +**Industrial Automation:** +- **Data Logging:** Data Logger as a compact, all-in-one device for efficient data collection and storage, ideal for IoT and sensor-based applications. With Nano boards advanced features and a compact design, it simplifies sensor interfacing, data management, and storage, making it perfect for smart homes, industrial monitoring, and research projects. +- **Predictive Maintenance:** Leverage the powerful features of the Nano Connector Carrier to develop a robust predictive maintenance prototype for industrial machinery. Utilize Modulino to monitor key operational parameters and detect anomalies or early signs of wear, enabling proactive maintenance and reducing downtime. Enhance this system with the Nano 33 BLE Sense, which continuously gathers crucial environmental data, including temperature, humidity, and vibrations to assess the overall health of the machinery. +- **Proof of Concept:** Expand your Nano board's capabilities with Nano Connector Carrier. The Nano Connector Carrier is ready for use with a wide range of external hardware components or modules, covering all your needs, from embedded sensing to actuation. + +**Prototyping:** +- **Compact Device:** Effortlessly integrate the Connector Carrier into your interactive prototype, regardless of whether the Nano board is based on. Its plug-and-play sensors and actuators make development seamless. Whether using modules from our Qwiic or Grove series, its compact design allows you to experiment in small spaces, making it a perfect platform for testing and validating your tech ideas. +- **Smart Home:** Easily prototype any smart device that can monitor and adjust temperature, humidity, or occupancy levels by combining Nano Connector Carrier, Modulinos and Nano Matter. Integrate with Matter-compatible smart home systems like Alexa or Google Home for frictionless voice control and automation. +- **Controller:** Using the Nano Connector Carrier, you can easily prototype a versatile RC - MIDI - RF - BLE - HID - DMX controller for your projects. With plug-and-play support for sensors and actuators, you can create custom interfaces that respond to touch, motion or even pressure. The compact design allows for a fully portable setup using Modulinos or third-party sensors. + +**Education:** +- **Micropython Learning:** Easily dive into MicroPython with the Nano Connector Carrier, Modulinos and Nano ESP32 as your learning platform. Its plug-and-play support for sensors and actuators allows you to experiment with real-world applications right away, whether you're reading sensor data, controlling LEDs, or building interactive projects. +- **Cross-Disciplinary Student Projects:** The Connector Carrier accelerates interdisciplinary collaboration by enabling rapid prototyping in classroom and lab environments. Its compact, modular design allows students across various fields (including engineering, computer science and the arts) to quickly develop, test, and refine ideas using Arduino Nano boards. Students can seamlessly integrate sensors, actuators and communication modules with built-in connectivity and expansion options, fostering hands-on experimentation and innovation. +- **Sustainability and Green Tech:** Energy Management project where students can design and test systems that monitor or reduce energy use in buildings or devices, promoting sustainability and teaching about renewable energy or energy efficiency, within integrated solar or wind power systems. + +## Features +### General Specifications Overview + +The main features of the Nano Connector Carrier are detailed in the table shown below. + +| **Feature** | **Description** | +| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Interfaces | 2x Grove analog/digital connector

1x Grove I2C connector

1x Grove UART connector

1x Qwiic I2C connector

1x microSD card reader | +| I/O Voltage | Switch between +3.3 VDC and +5 VDC | +| Dimensions | 28 mm x 43 mm | +| Operating Temperatures | -40 °C to +85 °C | + + +### Board Selection + +The Nano Connector Carrier lets you select +5 VDC or +3.3 VDC Nano boards to ensure compatibility with the whole Nano family. To do this, toggle the carrier onboard switch to its respective position, following the table below. + +![Board Selector Switch](assets/board-selector.png) + +| **3V3** | **5V** | +| ---------------------- | ------------ | +| Nano ESP32 | Arduino Nano | +| Nano 33 IoT | Nano Every | +| Nano 33 BLE | Nano R4 | +| Nano 33 BLE Rev2 | | +| Nano 33 BLE Sense | | +| Nano 33 BLE Sense Rev2 | | +| Nano RP2040 Connect | | +| Nano Matter | | + +Setting the switch to a specific position (3V3 or 5V) also manages the voltage output on the Grove connector VCC pin. + +
+Note: The logic and power voltage of the Qwiic connector and the microSD card slot are always +3.3 VDC regardless of the board selector switch position. +
+ +### Qwiic I2C Connector + +The Qwiic connector is connected to the standard I2C bus on the board (via A4 and A5 pins). It is powered via +3.3 VDC, following the Qwiic standard system, making the Nano Connector Carrier compatible with the Arduino Modulino nodes. + +Its logic level is fixed to +3.3 VDC, which is translated to the host Nano board voltage defined by the board selector switch. + +![Nano Connector Carrier Qwiic Connector](assets/qwiic.png) + +### Grove Connectors + +The Nano Connector Carrier features 4x Grove connectors that expose the host board's main communication interfaces. + +![Nano Connector Carrier Grove Connectors](assets/grove.png) + +
+Note: The Grove connectors VCC voltage is controlled by the board selector switch. +
+ +
+ +### Micro SD Card + +The onboard microSD card slot unlocks new possibilities for data logging, Edge AI and real-time storage needs. + +![Nano Connector Carrier Grove Connectors](assets/sd.png) + +
+Note: The microSD card SPI Slave Select (SS) pin can be changed using the solder jumpers on the carrier. See pinout section for more details. +
+ +### Communication Interfaces + +The Nano Connector Carrier exposes all the Nano host board connections and communication interfaces through the header pins and connectors. + +| Interfaces | Connector | +| -------------- | ----------------------------------------------------------------------------- | +| UART (x1) | - Grove connector | +| SPI (x1) | - Nano header connector

- Micro SD card slot | +| I2C (x1) | - Nano header connector

- Qwiic connector

- Grove connector | +| Analog/Digital | - Nano header connector

- 2x Grove connectors | + +### Related Products + +- Arduino Nano (A000005) +- Nano 33 BLE (ABX00030) +- Nano 33 BLE Rev2 (ABX00071 / ABX00072) +- Nano 33 BLE Sense (ABX00031) +- Nano 33 BLE Sense Rev2 (ABX00069) +- Nano 33 IoT (ABX00027) +- Nano ESP32 (ABX00083 / ABX00092 / ABX00083_CN / ABX00092_CN) +- Nano Every (ABX00028) +- Nano Matter (ABX00112 / ABX00137) +- Nano RP2040 Connect (ABX00053) +- Nano R4 (ABX00142) +- Arduino Modulino nodes + +## Power and Ratings +### Recommended Operating Conditions + +| Symbol | Description | Min | Typ | Max | Unit | +| -------------- | ------------------------------- | --- | --- | --- | ---- | +| 3V3 | Input voltage from 3.3 V boards | - | 3.3 | - | V | +| 5V | Input voltage from 5 V boards | - | 5.0 | - | V | +| TOP | Operating Temperature | -40 | 25 | 85 | °C | + +
+Note: The Nano Connector Carrier is powered by the host board's nominal voltage. +
+ +### Power Tree + +The following diagram illustrates the Nano Connector Carrier's main system power architecture. + +![Nano Connector Carrier Power Tree](assets/power-tree.png) + +## Functional Overview + +The Nano Connector Carrier expands the connectivity of the Nano boards family, featuring a variety of Grove and Qwiic connectors. It also includes a Micro SD card interface for data logging. + +### Pinout + +The Nano Connector Carrier pinout is shown in the following figure. + +![Pinout for Nano Connector Carrier](assets/ASX00061-pinout-v2.png) + +#### Analog (JP1) + +| Pin | Function | Type | Description | +| --- | --------- | --------- | --------------------------------------- | +| 1 | D13 / SCK | Digital | Serial Clock | +| 2 | +3V3 | Power Out | +3V3 Power Rail | +| 3 | B0 / AREF | Analog | Analog Reference | +| 4 | A0 | Analog | Analog input 0 | +| 5 | A1 | Analog | Analog input 1 | +| 6 | A2 | Analog | Analog input 2 | +| 7 | A3 | Analog | Analog input 3 | +| 8 | A4 | Analog | Analog input 4 / I²C Serial Data (SDA) | +| 9 | A5 | Analog | Analog input 5 / I²C Serial Clock (SCL) | +| 10 | A6 | Analog | Analog input 6 | +| 11 | A7 | Analog | Analog input 7 | +| 12 | +5V | Power | USB power (5 V) | +| 13 | BOOT1 | Mode | Board Reset 1 | +| 14 | GND | Power | Ground | +| 15 | VIN | Power | Voltage Input | + +#### Digital (JP2) + +| Pin | Function | Type | Description | +| --- | ----------- | -------- | --------------------------------------- | +| 15 | D12 / MISO | Digital | Master In Slave Out | +| 14 | D11 / MOSI | Digital | Master Out Slave In | +| 13 | D10 / SS | Digital | Slave Select | +| 12 | D9 | Digital | Digital pin 9 | +| 11 | D8 | Digital | Digital pin 8 | +| 10 | D7 | Digital | Digital pin 7 | +| 9 | D6 | Digital | Digital pin 6 | +| 8 | D5 | Digital | Digital pin 5 | +| 7 | D4 / SD_SS | Digital | Digital pin 4 / Default SD card SS | +| 6 | D3 / *SD_SS | Digital | Digital pin 3 / Optional SD card SS | +| 5 | D2 / *SD_SS | Digital | Digital pin 2 / Optional SD card SS | +| 4 | GND | Power | Ground | +| 3 | RST | Internal | Reset | +| 2 | D0 / RX | Digital | Digital pin 0 / Serial Receiver (RX) | +| 1 | D1 / TX | Digital | Digital pin 1 / Serial Transmitter (TX) | + +__*SD_SS__ are optional SPI Slave Select (SS) pins for the Micro SD card communication. See [pinout](#pinout) for more details. + +
+ +### Block Diagram + +An overview of the Nano Connector Carrier high-level architecture is illustrated in the figure below. + +![Nano Connector Carrier Block Diagram](assets/Block_Diagram.png) + +
+ +## Board Topology +### Overall View + +![Top View of Nano Connector Carrier](assets/topology.jpg) + +| **Reference** | **Description** | +| -------------- | ---------------------------------------- | +| U1, U2, U3, U5 | Push pull translators (SN74LVC1G125DCKR) | +| U4 | Open drain translator (TCA9406DCUR) | +| J2, J3 | Nano board headers | +| S1 | Board selector switch | +| J5 | Grove analog connector | +| J7 | Grove analog connector | +| J4 | Grove UART connector | +| J8 | Qwiic I2C connector | +| J9 | microSD card connector | + +## Device Operation + +### Getting Started - IDE + +If you want to program your Nano board to use the Nano Connector Carrier while offline you need to install the Arduino® Desktop IDE **[1]**. To connect the Nano board to your computer, you will need a USB cable, which can also provide power to the board. + +### Online Resources + +Now that you have learned the basics of what you can do with the carrier, you can explore its endless possibilities by checking out exciting projects on Arduino Project Hub **[4]**, the Arduino Library Reference **[5]**, and the online store **[6]**. Here, you can complement your board with sensors, actuators and more. + +## Mechanical Information + +The Nano Connector Carrier is a double-sided 28 mm x 43 mm board with female double row Nano headers around the top long edges, 4x Grove horizontal connectors, one on each corner of the bottom side, a Micro SD card slot and a Qwiic connector on the bottom edges. + +### Board Dimensions +The outline and dimensions of the Nano Connector Carrier and mounting holes can be seen in the following figure; all the dimensions are in mm. + +![Mechanical View of Nano Connector Carrier](assets/dimensions-rect.png) + +The Nano Connector Carrier has two 3.2 mm drilled mounting holes for mechanical fixing. + +### Board Connectors + +The Nano Connector Carrier's connectors are placed on the top side of the board, as shown in the figure below; all the dimensions are in mm. + +![Mechanical View of Nano Connector Carrier's Connectors](assets/connectors-rect.png) + +## Certifications + +### Certificactions Summary + +| **Certification** | **Status** | +| :-----------------: | :--------: | +| CE (European Union) | Yes | +| RoHS | Yes | +| REACH | Yes | +| WEEE | Yes | +| FCC (USA) | Yes | +| IC (Canada) | Yes | +| UKCA (UK) | Yes | + +### Declaration of Conformity CE DoC (EU) + +We declare under our sole responsibility that the products above are in conformity with the essential requirements of the following EU Directives and therefore qualify for free movement within markets comprising the European Union (EU) and European Economic Area (EEA). + +### Declaration of Conformity to EU RoHS & REACH 211 01/19/2021 + +Arduino boards are in compliance with RoHS 2 Directive 2011/65/EU of the European Parliament and RoHS 3 Directive 2015/863/EU of the Council of 4 June 2015 on the restriction of the use of certain hazardous substances in electrical and electronic equipment. + +| **Substance** | **Maximum Limit (ppm)** | +| -------------------------------------- | ----------------------- | +| Lead (Pb) | 1000 | +| Cadmium (Cd) | 100 | +| Mercury (Hg) | 1000 | +| Hexavalent Chromium (Cr6+) | 1000 | +| Poly Brominated Biphenyls (PBB) | 1000 | +| Poly Brominated Diphenyl ethers (PBDE) | 1000 | +| Bis(2-Ethylhexyl) phthalate (DEHP) | 1000 | +| Benzyl butyl phthalate (BBP) | 1000 | +| Dibutyl phthalate (DBP) | 1000 | +| Diisobutyl phthalate (DIBP) | 1000 | + +Exemptions : No exemptions are claimed. + +Arduino Boards are fully compliant with the related requirements of European Union Regulation (EC) 1907 /2006 concerning the Registration, Evaluation, Authorization and Restriction of Chemicals (REACH). We declare none of the SVHCs ([https://echa.europa.eu/web/guest/candidate-list-table](https://echa.europa.eu/web/guest/candidate-list-table)), the Candidate List of Substances of Very High Concern for authorization currently released by ECHA, is present in all products (and also package) in quantities totaling in a concentration equal or above 0.1%. To the best of our knowledge, we also declare that our products do not contain any of the substances listed on the "Authorization List" (Annex XIV of the REACH regulations) and Substances of Very High Concern (SVHC) in any significant amounts as specified by the Annex XVII of Candidate list published by ECHA (European Chemical Agency) 1907 /2006/EC. + +### Conflict Minerals Declaration + +As a global supplier of electronic and electrical components, Arduino is aware of our obligations with regards to laws and regulations regarding Conflict Minerals, specifically the Dodd-Frank Wall Street Reform and Consumer Protection Act, Section 1502. Arduino does not directly source or process conflict minerals such as Tin, Tantalum, Tungsten, or Gold. Conflict minerals are contained in our products in the form of solder, or as a component in metal alloys. As part of our reasonable due diligence Arduino has contacted component suppliers within our supply chain to verify their continued compliance with the regulations. Based on the information received thus far we declare that our products contain Conflict Minerals sourced from conflict-free areas. + +### FCC Caution + +Any Changes or modifications not expressly approved by the party responsible for compliance could void the user’s authority to operate the equipment. + +This device complies with part 15 of the FCC Rules. Operation is subject to the following two conditions: + +(1) This device may not cause harmful interference + +(2) this device must accept any interference received, including interference that may cause undesired operation. + +**FCC RF Radiation Exposure Statement:** + +1. This Transmitter must not be co-located or operating in conjunction with any other antenna or transmitter. + +2. This equipment complies with RF radiation exposure limits set forth for an uncontrolled environment. + +3. This equipment should be installed and operated with a minimum distance of 20 cm between the radiator & your body. + +English: +User manuals for licence-exempt radio apparatus shall contain the following or equivalent notice in a conspicuous location in the user manual or alternatively on the device or both. This device complies with Industry Canada licence-exempt RSS standard(s). Operation is subject to the following two conditions: + +(1) this device may not cause interference + +(2) this device must accept any interference, including interference that may cause undesired operation of the device. + +French: +Le présent appareil est conforme aux CNR d’Industrie Canada applicables aux appareils radio exempts de licence. L’exploitation est autorisée aux deux conditions suivantes : + +(1) l’ appareil nedoit pas produire de brouillage + +(2) l’utilisateur de l’appareil doit accepter tout brouillage radioélectrique subi, même si le brouillage est susceptible d’en compromettre le fonctionnement. + +**IC SAR Warning:** + +English +This equipment should be installed and operated with a minimum distance of 20 cm between the radiator and your body. + +French: +Lors de l’ installation et de l’ exploitation de ce dispositif, la distance entre le radiateur et le corps est d ’au moins 20 cm. + +**Important:** The operating temperature of the EUT can’t exceed 85 ℃ and shouldn’t be lower than -40 ℃. + +Hereby, Arduino S.r.l. declares that this product is in compliance with essential requirements and other relevant provisions of Directive 201453/EU. This product is allowed to be used in all EU member states. + +## Company Information + +| Company Information | Details | +| --------------- | -------------------------------------------- | +| Company Name | Arduino S.r.l. | +| Company Address | Via Andrea Appiani, 25 - 20900 MONZA (Italy) | + +## Reference Documentation + +| Reference | Link | +| ------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| Arduino IDE (Desktop) | [https://www.arduino.cc/en/Main/Software](https://www.arduino.cc/en/Main/Software) | +| Arduino IDE (Cloud) | [https://app.arduino.cc/sketches](https://app.arduino.cc/sketches) | +| Arduino Cloud - Getting Started | [https://docs.arduino.cc/arduino-cloud/guides/overview/](https://docs.arduino.cc/arduino-cloud/guides/overview/) | +| Project Hub | [https://projecthub.arduino.cc/](https://projecthub.arduino.cc/) | +| Language Reference | [https://docs.arduino.cc/language-reference/](https://docs.arduino.cc/language-reference/) | +| Online Store | [https://store.arduino.cc/](https://store.arduino.cc/) | + +## Change Log + +| Date | **Revision** | **Changes** | +| --------- | ------------ | ------------- | +| 6/06/2025 | 1 | First Release | \ No newline at end of file diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/downloads/ASX00061-pinout.png b/content/hardware/03.nano/carriers/nano-connector-carrier/downloads/ASX00061-pinout.png new file mode 100644 index 0000000000..d0ea11d6d7 Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/downloads/ASX00061-pinout.png differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/features.md b/content/hardware/03.nano/carriers/nano-connector-carrier/features.md new file mode 100644 index 0000000000..4b79e43d74 --- /dev/null +++ b/content/hardware/03.nano/carriers/nano-connector-carrier/features.md @@ -0,0 +1,20 @@ + + +This product expands the capabilities of our Nano board family, with QWIIC and Grove modules, and the onboard microSD card slot unlocks new possibilities for data logging, edge AI, and real-time storage needs. The Nano Connector Carrier is an ultimate tool for fast, flexible, and future-ready development. + + + + + + +The Nano Connector Carrier is ready to be used with a wide range of external hardware components or modules, covering all your needs, from embedded sensing to actuation. + + + + + +Unlocks new possibilities for data logging, edge AI, and real-time storage needs. + + + + diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/image.svg b/content/hardware/03.nano/carriers/nano-connector-carrier/image.svg new file mode 100644 index 0000000000..32ea10fe23 --- /dev/null +++ b/content/hardware/03.nano/carriers/nano-connector-carrier/image.svg @@ -0,0 +1,3 @@ + + + diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/product.md b/content/hardware/03.nano/carriers/nano-connector-carrier/product.md new file mode 100644 index 0000000000..ba352c6fe0 --- /dev/null +++ b/content/hardware/03.nano/carriers/nano-connector-carrier/product.md @@ -0,0 +1,12 @@ +--- +title: Nano Connector Carrier +url_shop: https://store.arduino.cc/nano-connector-carrier +url_guide: /tutorials/ +primary_button_url: /tutorials/ +primary_button_title: Get Started +certifications: [] +forumCategorySlug: '/hardware/12' +sku: [ASX00061] +--- + +The Nano Connector Carrier brings plug & play compatibility with QWIIC and Grove modules, making rapid prototyping easier than ever. \ No newline at end of file diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/tech-specs.md b/content/hardware/03.nano/carriers/nano-connector-carrier/tech-specs.md new file mode 100644 index 0000000000..6f87303422 --- /dev/null +++ b/content/hardware/03.nano/carriers/nano-connector-carrier/tech-specs.md @@ -0,0 +1 @@ +Here you will find the technical specifications for the Arduino® Nano Connector Carrier. \ No newline at end of file diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/tech-specs.yml b/content/hardware/03.nano/carriers/nano-connector-carrier/tech-specs.yml new file mode 100644 index 0000000000..956f5aac50 --- /dev/null +++ b/content/hardware/03.nano/carriers/nano-connector-carrier/tech-specs.yml @@ -0,0 +1,13 @@ +Carrier: + Name: Arduino® Nano Connector Carrier + SKU: ASX00061 +GROVE Connectors: + analog/digital I/O: 2 + I2C: Yes + UART: Yes +QWIIC Connector: Yes, I2C +External memory: SD card Reader +I/O Voltage: Switch between 3.3v and 5V +Dimensions: + Width: 28 mm + Length: 43 mm diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/ASX00061-pinout-v2.png b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/ASX00061-pinout-v2.png new file mode 100644 index 0000000000..d0ea11d6d7 Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/ASX00061-pinout-v2.png differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/connector-list.png b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/connector-list.png new file mode 100644 index 0000000000..3116d60a4f Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/connector-list.png differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/cover.gif b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/cover.gif new file mode 100644 index 0000000000..0df8eeba55 Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/cover.gif differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/enclosure-connection.png b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/enclosure-connection.png new file mode 100644 index 0000000000..746a943c66 Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/enclosure-connection.png differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/enclosure-monitor.png b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/enclosure-monitor.png new file mode 100644 index 0000000000..a5a81473d7 Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/enclosure-monitor.png differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/grove-01.gif b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/grove-01.gif new file mode 100644 index 0000000000..5c46c637ec Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/grove-01.gif differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/moduleConnection.png b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/moduleConnection.png new file mode 100644 index 0000000000..bf43d6278f Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/moduleConnection.png differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/movement-connector.png b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/movement-connector.png new file mode 100644 index 0000000000..14bbbff461 Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/movement-connector.png differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/movement_monitor.png b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/movement_monitor.png new file mode 100644 index 0000000000..b23ee94656 Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/movement_monitor.png differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/nano-formfactor.png b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/nano-formfactor.png new file mode 100644 index 0000000000..854e0f39f7 Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/nano-formfactor.png differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/power-switch-01.gif b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/power-switch-01.gif new file mode 100644 index 0000000000..2c5306af1a Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/power-switch-01.gif differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/qwiic-01.gif b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/qwiic-01.gif new file mode 100644 index 0000000000..117e0040a3 Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/qwiic-01.gif differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/sd-card-01.gif b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/sd-card-01.gif new file mode 100644 index 0000000000..b3c7f70bd6 Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/sd-card-01.gif differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/solder-jumper-01.gif b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/solder-jumper-01.gif new file mode 100644 index 0000000000..83e1ea4f63 Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/solder-jumper-01.gif differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/teamometer.png b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/teamometer.png new file mode 100644 index 0000000000..8d068565f3 Binary files /dev/null and b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/assets/teamometer.png differ diff --git a/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/content.md b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/content.md new file mode 100644 index 0000000000..d6dc6dc0cb --- /dev/null +++ b/content/hardware/03.nano/carriers/nano-connector-carrier/tutorials/getting-started-nano-connector-carrier/content.md @@ -0,0 +1,652 @@ +--- +title: 'Getting Started with Nano Connector Carrier' +difficulty: beginner +description: 'This short guide takes you through the features of the Nano Connector Carrier, along with some important considerations when using this product.' +tags: [Prototyping] +author: 'Pedro Sousa Lima' +hardware: + - hardware/03.nano/carriers/nano-connector-carrier +--- + +The Nano Connector Carrier is a versatile expansion board designed for the Arduino Nano form factor. It provides an easy way to interface your Arduino Nano with various sensors, modules and storage options through industry-standard connectors. This carrier board eliminates the need for complex wiring and breadboarding, allowing you to focus on your project's functionality rather than connectivity challenges. + +![The Nano Connector Carrier](assets/cover.gif) + +## Compatibility + +The carrier is designed to work with all Arduino Nano form factor boards. Its standardized layout ensures compatibility with current and future Arduino Nano family boards, giving you flexibility in developing your current and future projects. + +![Carrier With a Nano Board](assets/nano-formfactor.png) + +## Features + +The Nano Connector Carrier comes packed with the following key features to enhance your projects based on Nano family boards: + +### Input Selector Switch + +To ensure full compatibility with the Nano family boards, as some boards can be [configured to different input voltage levels](https://docs.arduino.cc/tutorials/nano-esp32/cheat-sheet/#Input:~:text=otherwise%20be%20damaged.-,Input%20Voltage%20(VIN),-If%20you%27re%20using) the carrier includes a switch to select +3.3 VDC or +5 VDC input voltage levels. The selector switch lets you choose the appropriate input voltage for your Nano board. + +![Onboard Voltage Switch](assets/power-switch-01.gif) + +This feature also ensures compatibility with a wide range of sensors and modules that operate at different voltage levels, eliminating the need for additional level shifters in most cases. + +### Connectors + +The Nano Connector Carrier includes both QWIIC and Grove connectors for expanding the Nano board's capability with external sensors, as well as an onboard microSD card slot to expand the board's memory capabilities : +![Available Connectors](assets/connector-list.png) + +#### Qwiic Connector + +The Nano Connector Carrier features a single Qwiic connector, allowing you to easily interface with Arduino Modulinos and other Qwiic-based sensors and modules. + +![QWIIC Connector](assets/qwiic-01.gif) + +The Qwiic connector uses a 4-pin JST SH connector (P/N: SM04B-SRSS-TB(LF)(SN)) with the following standardized pinout: + +| Pin | Connection | +|-----|------------------------------------------| +| GND | Ground | +| VCC | +3.3 VDC/ +5 VDC (selected by the input selector switch) | +| SDA | I²C Data (connected to the A4 pin of the Nano board) | +| SCL | I²C Clock (connected to the A5 pin of the Nano board) | + +A single Qwiic connector is all you need since it's designed to be daisy-chainable, allowing you to connect multiple Modulinos or other Qwiic-compatible devices in series. This connector makes it plug-and-play simple to add sensors, displays and other Qwicc-compatible devices to your project. + +#### Grove Connectors + +The Nano Connector Carrier also includes four Grove connectors, compatible with the extensive ecosystem of Grove modules. + +![Grove Connector](assets/grove-01.gif) + +The Grove connector uses a 4-pin DIP-2.0 mm connector (P/N: 114020164) with four different standardized pinouts: + +**Grove (J5) - Analog** + +| Pin | Connection | +|-----|--------------------------------------| +| GND | Ground | +| VCC | +3.3 VDC/ +5 VDC (selected by the input selector switch) | +| A3 | Analog pin A3 on the Nano board| +| A2 | Analog pin A2 on the Nano board| + +**Grove (J7) - Analog** + +| Pin | Connection | +|-----|--------------------------------------| +| GND | Ground | +| VCC | +3.3 VDC/ +5 VDC (selected by the input selector switch) | +| A1 | Analog pin A1 on the Nano board| +| A0 | Analog pin A0 on the Nano board| + +**Grove (J4) - SPI** + +| Pin | Connection | +|------|--------------------------------------| +| GND | Ground | +| VCC | +3.3 VDC/ +5 VDC (selected by the input selector switch) | +| MOSI | SPI MOSI (D11 pin on the Nano board)| +| MISO | SPI MISO (D12 pin on the Nano board)| + +**Grove (J6) - I²C** + +| Pin | Connection | +|-----|--------------------------------------| +| GND | Ground | +| VCC | +3.3 VDC/ +5 VDC (selected by the input selector switch) | +| SDA | I²C Data (A4 pin on the Nano board, shared with the Qwiic connector) | +| SCL | I²C Clock (A5 pin on the Nano board, shared with the Qwiic connector)| + +With the standardized pinouts mentioned, using Groove connectors eliminates the need for soldering or breadboarding and simplifies connecting various and different sensors, actuators and displays to your Nano family board. + +#### MicroSD Card Slot + +The Nano Connector Carrier includes an onboard microSD card slot for projects requiring data logging or file storage. + +![MicroSD Card Slot](assets/sd-card-01.gif) + +The microSD card slot is connected to the Nano family board through the SPI interface as follows: + +| SPI Signal | Arduino Pin | +|------------|----------------------------------------| +| MISO | D12 pin on the Nano board| +| MOSI | D11 pin on the Nano board| +| SCK | D13 pin on the Nano board| +| CS | D4 pin on the Nano board (configurable also to D2 or D3 pins) | + +***By default, pin D4 is used as the SPI CS (Chip Select) for the microSD card, but you can also configure solder jumpers on the Nano Connector Carrier to use D2 or D3 pins if needed.*** + +![CS Pin Selector Jumpers](assets/solder-jumper-01.gif) + +With this feature, your Nano family board can read and write files on a microSD card, making it perfect for data logging applications, playing audio files or storing configuration data. + +## Pinout + +The Nano Connector Carrier features the intuitive and straightforward Nano family board pinout that easily connects various peripherals to your Nano family board. The carrier is divided into two main sections: + +![Nano Connector Carrier Pinout](assets/ASX00061-pinout-v2.png) + +The pinout includes labeled connections for all the interfaces: +- Nano family pins (digital and analog pins) +- SPI interface pins +- I²C interface pins +- Power lines (+5 VDC, +3.3 VDC and GND) +- Serial interface pins + +The board's connectors are mapped to specific Nano family pins, making it straightforward to program your projects. The voltage level switch affects all VCC pins on the Grove and Qwiic connectors, allowing you to match your peripheral's voltage requirements. + +## What to Do Next? + +### Example Project: Teamometer + +The Teamometer demonstrates how different Modulino sensor modules can work together to solve a real-world problem. This project combines temperature sensing, LED visual feedback, button interaction and audio alerts to create a smart tea temperature monitor. It's a fun way to see how easily the Nano Connector Carrier can connect to different sensors and modules simultaneously, giving you visual cues, sounds and temperature readings in a straightforward project, even with different connectors. + +![Teamometer overview](assets/teamometer.png) + +**Components needed:** +- [Modulino Buttons](https://store.arduino.cc/products/modulino-buttons) - ABX00110 +- [Modulino Pixels](https://store.arduino.cc/products/modulino-pixels) - ABX00109 +- [Modulino Thermo](https://store.arduino.cc/products/modulino-thermo) - ABX00103 +- [Nano family board](https://docs.arduino.cc/hardware/) +- [Nano Connector Carrier](https://store.arduino.cc/products/nano-connector-carrier) - ASX00061 +- Grove Buzzer sensor +- Thick rubber band (for securing the Thermo module to your cup) +- Cup +- Your favorite tea + +**Assembly instructions:** +1. Connect the Modulino Buttons, Pixels and Thermo modules to your Nano family board through the Nano Connector Carrier. +2. Attach the Thermo module to the outside of your cup using the thick rubber band. +3. Connect the Grove Buzzer sensor to your Nano family board through the Nano Connector Carrier. +4. Upload the code provided below. +5. Fill your cup with hot tea. +6. Wait a few seconds to allow the heat to transfer to the sensor. +7. Press button A to begin monitoring. + +![Connection guide](assets/moduleConnection.png) + +**Code Example:** +```arduino +#include + +// Create object instances +ModulinoThermo thermo; +ModulinoButtons buttons; +ModulinoPixels leds; + +// Define temperature thresholds (in Celsius) feel free tpo change these as the heat transfer will depend a lot on your cup. Thermal paste can be added to improve this. +const float HOT_TEMP = 80.0; // Fresh tea temperature +const float LUKEWARM_TEMP = 40.0; // Ideal drinking temperature +const float ROOM_TEMP = 25.0; // Room temperature + +// Define pin for buzzer +const int BUZZER_PIN = A0; + +// Variables to track state +bool measuring = false; // Are we actively measuring temperature? +bool buzzing = false; // Is the buzzer currently active? +int brightness = 25; // LED brightness (0-255) + +void setup() { + Serial.begin(9600); + + // Initialize Modulino I2C communication + Modulino.begin(); + + // Detect and connect to modules + thermo.begin(); + buttons.begin(); + leds.begin(); + + // Set up buzzer pin as output + pinMode(BUZZER_PIN, OUTPUT); + + // Initial message + Serial.println("Tea Temperature Monitor"); + Serial.println("Press Button A to start monitoring"); + + // Show all LEDs off initially + leds.clear(); + leds.show(); +} + +void loop() { + // Check for new button events + if (buttons.update()) { + // Check which button was pressed (0=A, 1=B, 2=C) + if (buttons.isPressed(0)) { + Serial.println("Button A pressed - Start measuring!"); + measuring = true; + } else if (buttons.isPressed(1)) { + Serial.println("Button B pressed - Stop buzzer!"); + // Turn off buzzer if it's on + if (buzzing) { + noTone(BUZZER_PIN); + buzzing = false; + } + } + } + + // If we're in measuring mode, check temperature + if (measuring) { + // Read temperature in Celsius from the sensor + float celsius = thermo.getTemperature(); + + Serial.print("Temperature (C): "); + Serial.println(celsius); + + // Update the LED progress bar based on temperature + updateTemperatureDisplay(celsius); + + // Check if tea has cooled to lukewarm + if (celsius <= LUKEWARM_TEMP && celsius > ROOM_TEMP) { + // Tea is ready to drink! Activate buzzer if not already buzzing + if (!buzzing) { + Serial.println("Tea is ready to drink!"); + tone(BUZZER_PIN, 1000); // 1kHz tone + buzzing = true; + } + } + // If the tea is removed (temperature drops to near room temp) + else if (celsius <= ROOM_TEMP) { + // Turn off buzzer + if (buzzing) { + noTone(BUZZER_PIN); + buzzing = false; + } + // Reset measuring state as tea is likely removed + measuring = false; + Serial.println("Tea removed or cooled to room temperature"); + Serial.println("Press Button A to start new measurement"); + leds.clear(); + leds.show(); + } + + // If tea is still too hot + else if (celsius > LUKEWARM_TEMP) { + // Ensure buzzer is off + if (buzzing) { + noTone(BUZZER_PIN); + buzzing = false; + } + } + } + + // Small delay to prevent reading too frequently + delay(500); +} + +// Function to update LED display based on temperature +void updateTemperatureDisplay(float celsius) { + // Calculate how many LEDs to light based on temperature + // Hotter = more LEDs lit + + // Map temperature range to LED count (0-8) + // If temperature is at or above HOT_TEMP, all LEDs are on + // If temperature is at or below ROOM_TEMP, no LEDs are on + int ledCount = map(celsius * 100, ROOM_TEMP * 100, HOT_TEMP * 100, 0, 8); + + // Constrain to valid range + ledCount = constrain(ledCount, 0, 8); + + // Update LEDs + leds.clear(); // Use the class's built-in clear method + + // Light up LEDs based on temperature with color coding + for (int i = 0; i < ledCount; i++) { + // Choose color based on temperature ranges + if (celsius >= 70) { + // Very hot (70°C+): RED + leds.set(i, RED, brightness); + } else if (celsius >= 55) { + // Hot (55-70°C): VIOLET + leds.set(i, VIOLET, brightness); + } else if (celsius >= LUKEWARM_TEMP) { + // Warm (40-55°C): WHITE + leds.set(i, WHITE, brightness); + } else if (celsius >= 30) { + // Getting cool (30-40°C): GREEN + leds.set(i, GREEN, brightness); + } else { + // Cool (below 30°C): BLUE + leds.set(i, BLUE, brightness); + } + } + + // Update the LEDs + leds.show(); +} +``` + +The temperature information will be displayed on the serial console and the Modulino Pixels. As your tea cools, fewer LEDs will light up, and the colors will change from red (very hot) through violet, white, and green, to blue (cool). When your tea reaches the perfect drinking temperature, the buzzer will tell you it is ready. + +Keep in mind that because the sensor is designed for atmospheric temperature monitoring you might have to tinker the values a bit(depending on your setup) as the measurement will not be as accurate measuring a different medium. + +### Example Project: Motion Logger + +The Motion Tracker demonstrates how the Nano Connector Carrier can integrate with the Movement sensor to record motion data. This project showcases real-time motion sensing, button control and data logging to create a portable motion capture system that can be used for activity tracking, sports analysis or interactive projects. + +![Motion Logger overview](assets/movement_monitor.png) + +**Components needed:** +- [Modulino Movement](https://store.arduino.cc/products/modulino-movement) - ABX00101 +- [Modulino Buttons ](https://store.arduino.cc/products/modulino-buttons) - ABX00110 +- MicroSD card +- [Nano Connector Carrier](https://store.arduino.cc/products/nano-connector-carrier) - ASX00061 + +![Connection guide](assets/movement-connector.png) + +**Assembly instructions:** +1. Connect the Modulino Movement and Buttons modules to your Nano Connector Carrier +2. Insert a microSD card into the Nano Connector Carrier +3. Upload the example sketch provided below +4. Open the Arduino IDE's Serial Monitor to view real-time motion data +5. Press button A to start recording motion data to the microSD card +6. Move the sensor to capture motion data +7. Press button A again to stop recording + +**Example sketch:** +```arduino +/* + * Modulino Movement Logger + * + * Records movement data from a Modulino Movement sensor to an SD card. + * Press Button A to start/stop recording. + */ +#include "Arduino_Modulino.h" +#include + +// Create objects for the modules +ModulinoMovement movement; +ModulinoButtons buttons; + +// SD card configuration +#define SD_CS 4 // SD Card chip select (D4 on Modulino carrier) +File dataFile; + +// Variables to track state +bool recordingActive = false; +unsigned long lastRecordTime = 0; +const unsigned long RECORD_INTERVAL = 100; // Record every 100ms (10Hz) +String fileName = "/movement.csv"; // File name on SD card + +// Movement data +float x, y, z; // Acceleration +float roll, pitch, yaw; // Gyroscope + +void setup() { + // Initialize serial communication + Serial.begin(115200); + delay(1000); // Give serial monitor time to connect + + Serial.println("==================================="); + Serial.println("Modulino Movement Logger"); + Serial.println("==================================="); + + // Initialize Modulino I2C communication + Modulino.begin(); + + // Initialize modules + movement.begin(); + buttons.begin(); + + Serial.println("Press Button A to start/stop recording"); + + // Initialize SD card + Serial.print("Initializing SD card..."); + if (!SD.begin(SD_CS)) { + Serial.println("SD card initialization failed!"); + Serial.println("Check connections and continue anyway."); + } else { + Serial.println("SD card initialized successfully."); + } + + // Create CSV file with headers if it doesn't exist + if (!SD.exists(fileName)) { + dataFile = SD.open(fileName, FILE_WRITE); + if (dataFile) { + dataFile.println("Time,AccelX,AccelY,AccelZ,Roll,Pitch,Yaw"); + dataFile.close(); + Serial.println("Created new CSV file with headers"); + } else { + Serial.println("Error creating file!"); + } + } else { + Serial.println("File exists, will append to it"); + } + + Serial.println("Setup complete!"); + Serial.println("==================================="); +} + +void loop() { + // Read new movement data from the sensor (always do this to keep data current) + movement.update(); + + // Get acceleration and gyroscope values + x = movement.getX(); + y = movement.getY(); + z = movement.getZ(); + roll = movement.getRoll(); + pitch = movement.getPitch(); + yaw = movement.getYaw(); + + // Print current values to serial monitor + Serial.print("A: "); + Serial.print(x, 3); + Serial.print(", "); + Serial.print(y, 3); + Serial.print(", "); + Serial.print(z, 3); + Serial.print(" | G: "); + Serial.print(roll, 1); + Serial.print(", "); + Serial.print(pitch, 1); + Serial.print(", "); + Serial.println(yaw, 1); + + // Check for button presses + if (buttons.update()) { + // Check if button A was pressed (index 0) + if (buttons.isPressed(0)) { + // Toggle recording mode + recordingActive = !recordingActive; + + if (recordingActive) { + Serial.println("------------------------------------"); + Serial.println("RECORDING STARTED - Button A pressed"); + Serial.println("------------------------------------"); + } else { + Serial.println("------------------------------------"); + Serial.println("RECORDING STOPPED - Button A pressed"); + Serial.println("------------------------------------"); + } + + // Small delay after button press to debounce + delay(300); + } + } + + // If recording is active, save data to SD card at the specified interval + if (recordingActive) { + unsigned long currentTime = millis(); + if (currentTime - lastRecordTime >= RECORD_INTERVAL) { + // Open the file for writing + dataFile = SD.open(fileName, FILE_APPEND); + + if (dataFile) { + // Write timestamp and movement data to CSV file + dataFile.print(currentTime); + dataFile.print(","); + dataFile.print(x, 3); + dataFile.print(","); + dataFile.print(y, 3); + dataFile.print(","); + dataFile.print(z, 3); + dataFile.print(","); + dataFile.print(roll, 1); + dataFile.print(","); + dataFile.print(pitch, 1); + dataFile.print(","); + dataFile.println(yaw, 1); + + // Close the file + dataFile.close(); + } else { + Serial.println("Error opening file for writing"); + } + + lastRecordTime = currentTime; + } + } + + // Small delay to keep things responsive but not flood serial monitor + delay(50); +} +``` +The Motion Tracker continuously reads acceleration and orientation data from the Modulino Movement, displaying it in real-time on the Arduino IDE Serial Monitor. When recording is activated, the data is saved to a CSV file on the microSD card, creating a detailed motion profile that can be analyzed later in a spreadsheet or data visualization tools. This project is perfect for capturing movement patterns, analyzing sports techniques or creating interactive motion-controlled devices. + +### Example Project: Enclosure Monitor in MicroPython + +The Enclosure Monitor demonstrates how MicroPython and Modulino modules can work together to create a smart environmental monitoring system. This project uses temperature sensing and LED visual feedback to monitor conditions inside an enclosure, like a terrarium, server cabinet, or food storage area. It logs data over time while providing immediate visual indicators if temperatures fall outside the ideal range. +Note that the temperature settings can be changed to your specific use-case. + +To get started with MicroPython and install the Modulino library on your Arduino board, follow the official guide [here](https://docs.arduino.cc/micropython/modulinos/installation/). This guide will walk you through installing both MicroPython and the necessary Modulino libraries to work with your modules. + +![Enclosure Monitor overview](assets/enclosure-monitor.png) + +**Components needed:** +- [Modulino Thermo](https://store.arduino.cc/products/modulino-thermo) - ABX00103 +- [Modulino Pixels](https://store.arduino.cc/products/modulino-pixels) - ABX00109 +- [Nano family board](https://docs.arduino.cc/hardware/) +- [Nano Connector Carrier](https://store.arduino.cc/products/nano-connector-carrier) - ASX00061 +- Optional enclosure for permanent installation + +**Assembly instructions:** +1. Connect the Modulino Thermo and Pixels modules to your Nano family board through the Nano Connector Carrier. +2. Position the Thermo module where you want to monitor temperature (inside your enclosure). +3. Place the Pixels module where it's visible for status monitoring. +4. Upload the MicroPython code provided below. +5. Open the serial monitor to view real-time readings. +6. The system will automatically begin monitoring and logging data. + +![Connection guide](assets/enclosure-connection.png) + +**Code Example:** +```python +""" +Enclosure Temperature Monitor using Modulino Thermo and Pixels modules. +- BLUE LEDs: Too cold (below MIN_TEMP) +- GREEN LEDs: Ideal temperature (between MIN_TEMP and MAX_TEMP) +- RED LEDs: Too hot (above MAX_TEMP) + +Logs temperature data to both the console and internal file system. +""" +from modulino import ModulinoThermo, ModulinoPixels, ModulinoColor +from time import sleep +import os + +# Create module instances +thermo = ModulinoThermo() +pixels = ModulinoPixels() + +# Configuration +MIN_TEMP = 20.0 # Below this is too cold (BLUE) +MAX_TEMP = 25.0 # Above this is too hot (RED) +BRIGHTNESS = 50 # LED brightness (0-100) +LOG_FILE = "templog.csv" # Log file name in the internal file system +LOG_INTERVAL = 5 # Log every 5 readings + +# Create log file with headers if it doesn't exist +try: + # Check if file exists + files = os.listdir() + if LOG_FILE not in files: + with open(LOG_FILE, 'w') as f: + f.write('Reading,Temperature,Humidity,Status\n') + print(f"Created new log file: {LOG_FILE}") + else: + print(f"Using existing log file: {LOG_FILE}") +except Exception as e: + print(f"File system error: {e}") + +# Initialize LEDs to off +pixels.clear_all().show() + +# Main loop +print("=== Enclosure Temperature Monitor ===") +print(f"Cold: < {MIN_TEMP}°C | Ideal: {MIN_TEMP}-{MAX_TEMP}°C | Hot: > {MAX_TEMP}°C") + +counter = 0 # Simple counter for readings + +while True: + counter += 1 + + # Read temperature and humidity + temp = thermo.temperature + humidity = thermo.relative_humidity + + # Update display if temperature reading is valid + if temp is not None: + # Determine temperature status + if temp < MIN_TEMP: + status = "Cold" + color = ModulinoColor.BLUE + elif temp > MAX_TEMP: + status = "Hot" + color = ModulinoColor.RED + else: + status = "Ideal" + color = ModulinoColor.GREEN + + # Print to console + print(f"Temp: {temp:.1f}°C - {status}", end="") + if humidity is not None: + print(f", Humidity: {humidity:.1f}%") + else: + print("") + + # Update LED display + pixels.clear_all() + # Calculate how many LEDs to light (1-8) + led_count = int(max(1, min(8, (temp - MIN_TEMP + 5) / 15 * 8))) + for i in range(led_count): + pixels.set_color(i, color, BRIGHTNESS) + pixels.show() + + # Log to file at interval + if counter % LOG_INTERVAL == 0: + try: + with open(LOG_FILE, 'a') as f: + humidity_str = f"{humidity:.1f}" if humidity is not None else "N/A" + f.write(f"{counter},{temp:.1f},{humidity_str},{status}\n") + print("Data logged to file ✓") + except Exception as e: + print(f"Failed to write to file: {e}") + else: + print("Waiting for temperature reading...") + # Blink white LED to indicate waiting + pixels.set_all_color(ModulinoColor.WHITE, 20).show() + sleep(0.5) + pixels.clear_all().show() + sleep(0.5) + + # Wait before next reading + sleep(1) +``` + +The Enclosure Monitor provides immediate visual feedback about environmental conditions through the Modulino Pixels. LEDs glow BLUE when it's too cold, GREEN when the temperature is in the ideal range, and RED when it's too hot. The number of illuminated LEDs indicates where the temperature falls within each range - more LEDs light up as temperature increases. + +Temperature and humidity readings are displayed in real time on the serial monitor and logged to a CSV file on the internal storage. This data can be retrieved later for analysis of environmental trends over time. + +Now that you understand the features of the Nano Connector Carrier, here are some exciting project ideas to get you started: + +- **Weather Station**: Collect temperature, humidity and pressure data via sensors connected to the Grove connectors to create a simple weather monitoring system. +- **Plant Monitor**: Use soil moisture and light sensors to monitor your houseplants and alert you when they need attention. +- **Data Logger**: Use the microSD card slot to record sensor readings over time, which is perfect for environmental monitoring or tracking experiments. +- **Smart Home interface**: Create a hub with multiple sensors around your home that log data or send alerts. + +For additional project inspiration, check out the Arduino Project Hub or join the Arduino community forums to share your creations and learn from others. + +## Conclusion + +The Nano Connector Carrier transforms your Nano family board into a versatile platform capable of interfacing with different sensors, displays and storage options. By eliminating complex wiring and providing standardized pinouts, the Nano Connector Carrier allows you to focus on developing your application rather than dealing with connection issues. \ No newline at end of file diff --git a/content/hardware/11.accessories/family.md b/content/hardware/11.accessories/family.md new file mode 100644 index 0000000000..dd92dd966a --- /dev/null +++ b/content/hardware/11.accessories/family.md @@ -0,0 +1,6 @@ +--- +title: Accessories +description: To make your projects even greater. +businessUnit: maker +anchor: accessories-family +--- \ No newline at end of file diff --git a/content/hardware/11.accessories/modulinos/category.md b/content/hardware/11.accessories/modulinos/category.md new file mode 100644 index 0000000000..52d2a838c0 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/category.md @@ -0,0 +1,3 @@ +--- +title: Modulinos +--- \ No newline at end of file diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/compatibility.yml b/content/hardware/11.accessories/modulinos/modulino-buttons/compatibility.yml new file mode 100644 index 0000000000..68fc831f20 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-buttons/compatibility.yml @@ -0,0 +1,8 @@ +software: + - arduino-ide + - arduino-cli + - web-editor +hardware: + shields: ~ + carriers: ~ + boards: ~ \ No newline at end of file diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/assets/BlockDiagramButtons.png b/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/assets/BlockDiagramButtons.png new file mode 100644 index 0000000000..3d9d5199d6 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/assets/BlockDiagramButtons.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/assets/BtnMec.png b/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/assets/BtnMec.png new file mode 100644 index 0000000000..6db108c9c4 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/assets/BtnMec.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/assets/ButtonsPinouts.png b/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/assets/ButtonsPinouts.png new file mode 100644 index 0000000000..ece702fa0b Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/assets/ButtonsPinouts.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/assets/I2CTag.png b/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/assets/I2CTag.png new file mode 100644 index 0000000000..9d9b7b0f72 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/assets/I2CTag.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/assets/Modulino_Buttons_Power_Tree.png b/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/assets/Modulino_Buttons_Power_Tree.png new file mode 100644 index 0000000000..3281df8b8e Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/assets/Modulino_Buttons_Power_Tree.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/assets/ResistorsPullupBtn.png b/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/assets/ResistorsPullupBtn.png new file mode 100644 index 0000000000..89fcf0c3cd Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/assets/ResistorsPullupBtn.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/assets/featured.png b/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/assets/featured.png new file mode 100644 index 0000000000..6100aca3d5 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/assets/featured.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/datasheet.md b/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/datasheet.md new file mode 100644 index 0000000000..30a2a1f73b --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-buttons/datasheet/datasheet.md @@ -0,0 +1,261 @@ +--- +identifier: ABX00110 +title: Arduino® Modulino® Buttons +type: maker +author: Pedro Sousa Lima +--- + +![](assets/featured.png) + +# Description + +The Modulino® Buttons, powered by an on-board STM32C011F4 microcontroller, features three SPST push buttons and three indicator LEDs. This setup enables both simple digital input reading via I2C and more advanced interfacing or reprogramming options. Ideal for projects that require user interaction, menu navigation, or quick control inputs. + +# Target Areas + +Maker, beginner, education + +# Contents +## Application Examples + +- **Interactive Interfaces** + Integrate multiple buttons into a project to navigate menus or adjust settings in real time. + +- **Educational Projects** + Teach fundamentals of state detection (pressed/released) and microcontroller-based I2C communication. + +- **Control Panels** + Combine button inputs with other Modulino® nodes (e.g., display, buzzer) for a complete user interface. + +
+ +## Features +- Three **SPST push buttons** and three on-board indicator LEDs. +- Integrated **STM32C011F4** microcontroller providing I2C interface by default. +- **Optional SWD** interface for custom firmware and advanced features. +- Designed for **3.3 V** operation via the Qwiic connector (I2C). +- Ideal for **user interaction** and input within modular IoT or maker projects. + +### Contents +| **SKU** | **Name** | **Purpose** | **Quantity** | +| ---------- | --------------------- | -------------------------------------- | ------------ | +| ABX00110 | Modulino® Buttons | 3× push buttons and indicator LEDs | 1 | +| | I2C Qwiic cable | Compatible with the Qwiic standard | 1 | + + +## Related Products +- *SKU: ASX00027* – [Arduino® Sensor Kit](https://store.arduino.cc/products/arduino-sensor-kit) +- *SKU: K000007* – [Arduino® Starter Kit](https://store.arduino.cc/products/arduino-starter-kit-multi-language) +- *SKU: AKX00026* – [Arduino® Oplà IoT Kit](https://store.arduino.cc/products/opla-iot-kit) + +## Rating + +### Recommended Operating Conditions +- **Microcontroller supply range:** 2.0 V – 3.6 V (STM32C011F4) +- **Powered at 3.3 V** through the Qwiic interface (in accordance with the Qwiic standard) +- **Operating temperature:** –40 °C to +85 °C + +**Typical current consumption:** +- Push buttons + LEDs: ~2.5 mA × 3 + ~3.4 mA +- Microcontroller idle: ~3.4 mA + +## Power Tree +The power tree for the modulino can be consulted below: + +![Modulino® Buttons Power Tree](assets/Modulino_Buttons_Power_Tree.png) + +## Block Diagram +This module includes an STM32C011F4 microcontroller handling button inputs and LED outputs. It communicates via I2C by default, but can be reprogrammed via SWD for custom functionality. + +![Modulino® Buttons block diagram](assets/BlockDiagramButtons.png) + +## Functional Overview +The Modulino® Buttons node has a dedicated microcontroller (STM32C011F4) which scans the three SPST push buttons and drives the three LEDs. By default, it exposes a standard I2C interface over the Qwiic connector. The on-board firmware reports button states and allows simple LED control via I2C registers. Advanced users can re-flash the microcontroller via the SWD interface for additional custom logic. + +### Technical Specifications (Module-Specific) +| **Specification** | **Details** | +| ----------------------- | ----------------------------------------------- | +| **Microcontroller** | STM32C011F4 | +| **Accuracy** | ADC: ±2 LSB typical INL | +| **Resolution** | 12-bit ADC | +| **Supply Voltage** | Min: 2.0 V, Max: 3.6 V | +| **Power Consumption** | ~2.5 mA × 3 + 3.4 mA (LEDs + MCU) | +| **User Inputs** | 3× SPST push buttons | +| **LEDs** | 3× indicator LEDs (controlled by MCU) | +| **Communication** | I2C (Qwiic), SWD (reprogramming), UART (option) | + +### Pinout + +**Qwiic / I2C (1×4 Header)** +| **Pin** | **Function** | +|---------|---------------------------| +| GND | Ground | +| 3.3 V | Power Supply (3.3 V) | +| SDA | I2C Data | +| SCL | I2C Clock | + +These pads and the Qwiic connectors share the same I2C bus at 3.3 V. + +**Additional 1×10 Header (STM32C011F4 Signals)** +| **Pin** | **Function** | +|---------|------------------------| +| PA0 | Button/LED line (MCU) | +| PA1 | Button/LED line (MCU) | +| PA2 | Button/LED line (MCU) | +| RX1 | UART Receive (optional)| +| TX1 | UART Transmit (optional)| +| SWDIO | SWD Data | +| SWCLK | SWD Clock | +| PF2 | NRST (Reset) | + + **Note:** + - The board can be reprogrammed via SWD to implement custom functionality. + - Pull-up resistor pads exist for optional I2C lines, but are not populated by default. + +![Pinout Overview](assets/ButtonsPinouts.png) + +### Power Specifications +- **Nominal operating voltage:** 3.3 V via Qwiic +- **Microcontroller voltage range:** 2.0 V–3.6 V + +### Mechanical Information +![Modulino® Buttons Mechanical Information](assets/BtnMec.png) + +- Board dimensions: 41 mm × 25.36 mm +- Thickness: 1.6 mm (±0.2 mm) +- Four mounting holes (Ø 3.2 mm) + - Hole spacing: 16 mm vertically, 32 mm horizontally + +### I2C Address Reference +| **Board Silk Name** | **Sensor/Actuator** | **Modulino I2C Address (HEX)** | **Editable Addresses (HEX)** | **Hardware I2C Address (HEX)** | +|---------------------|-------------------------|--------------------------------|---------------------------------------------|--------------------------------| +| MODULINO BUTTONS | 3× SPST Push Buttons | 0x7C | Any custom address (via software config.) | 0x3E | + + **Note:** + - Default I2C address is **0x7C**. + - “Hardware I2C Address” might be seen by advanced scanners, but you should use 0x7C in your code unless changed. + - A white rectangle on the bottom silk allows users to write a new address after reconfiguration. + ![Blank silk for identification](assets/I2CTag.png) + +#### Pull-up Resistors + +This module has pads for optional I2C pull-up mounting in both data lines. No resistors are mounted by default but in case the resistors are need 4.7 K resistors in an SMD 0402 format are recommended. + +These are positioned between the button B and C. +![Generic pull-up resistor position](assets/ResistorsPullupBtn.png) + +## Device Operation +By default, the board is an I2C target device. It manages button inputs and LED outputs through integrated firmware. Simply connect it to a 3.3 V Qwiic interface. If needed, you can reprogram the STM32C011F4 via SWD to modify or extend functionality. A LED positioned near each button indicates operation, this is hardware connected by the button directly and cannot be altered with firmware. + +# Certifications + +## Certifications Summary + +| **Certification** | **Status** | +|:-----------------:|:----------:| +| CE/RED (Europe) | Yes | +| UKCA (UK) | Yes | +| FCC (USA) | Yes | +| IC (Canada) | Yes | +| RoHS | Yes | +| REACH | Yes | +| WEEE | Yes | + +## Declaration of Conformity CE DoC (EU) + +

We declare under our sole responsibility that the products above are in conformity with the essential requirements of the following EU Directives and therefore qualify for free movement within markets comprising the European Union (EU) and European Economic Area (EEA).

+ +## Declaration of Conformity to EU RoHS & REACH 211 01/19/2021 + +

Arduino boards are in compliance with RoHS 2 Directive 2011/65/EU of the European Parliament and RoHS 3 Directive 2015/863/EU of the Council of 4 June 2015 on the restriction of the use of certain hazardous substances in electrical and electronic equipment.

+ +| Substance | **Maximum limit (ppm)** | +|----------------------------------------|-------------------------| +| Lead (Pb) | 1000 | +| Cadmium (Cd) | 100 | +| Mercury (Hg) | 1000 | +| Hexavalent Chromium (Cr6+) | 1000 | +| Poly Brominated Biphenyls (PBB) | 1000 | +| Poly Brominated Diphenyl ethers (PBDE) | 1000 | +| Bis(2-Ethylhexyl) phthalate (DEHP) | 1000 | +| Benzyl butyl phthalate (BBP) | 1000 | +| Dibutyl phthalate (DBP) | 1000 | +| Diisobutyl phthalate (DIBP) | 1000 | + +Exemptions: No exemptions are claimed. + +

Arduino Boards are fully compliant with the related requirements of European Union Regulation (EC) 1907 /2006 concerning the Registration, Evaluation, Authorization and Restriction of Chemicals (REACH). We declare none of the SVHCs (https://echa.europa.eu/web/guest/candidate-list-table), the Candidate List of Substances of Very High Concern for authorization currently released by ECHA, is present in all products (and also package) in quantities totaling in a concentration equal or above 0.1%. To the best of our knowledge, we also declare that our products do not contain any of the substances listed on the "Authorization List" (Annex XIV of the REACH regulations) and Substances of Very High Concern (SVHC) in any significant amounts as specified by the Annex XVII of Candidate list published by ECHA (European Chemical Agency) 1907 /2006/EC.

+ +## Conflict Minerals Declaration + +

As a global supplier of electronic and electrical components, Arduino is aware of our obligations with regard to laws and regulations regarding Conflict Minerals, specifically the Dodd-Frank Wall Street Reform and Consumer Protection Act, Section 1502. Arduino does not directly source or process conflict minerals such as Tin, Tantalum, Tungsten, or Gold. Conflict minerals are contained in our products in the form of solder or as a component in metal alloys. As part of our reasonable due diligence, Arduino has contacted component suppliers within our supply chain to verify their continued compliance with the regulations. Based on the information received thus far we declare that our products contain Conflict Minerals sourced from conflict-free areas.

+ +## FCC Caution + +Any Changes or modifications not expressly approved by the party responsible for compliance could void the user’s authority to operate the equipment. + +This device complies with part 15 of the FCC Rules. Operation is subject to the following two conditions: + +1. This device may not cause harmful interference. +2. This device must accept any interference received, including interference that may cause undesired operation. + +**FCC RF Radiation Exposure Statement:** + +1. This Transmitter must not be co-located or operating in conjunction with any other antenna or transmitter. +2. This equipment complies with RF radiation exposure limits set forth for an uncontrolled environment. +3. This equipment should be installed and operated with a minimum distance of 20 cm between the radiator & your body. + +**Note:** This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures: + +- Reorient or relocate the receiving antenna. +- Increase the separation between the equipment and receiver. +- Connect the equipment into an outlet on a circuit different from that to which the receiver is connected. +- Consult the dealer or an experienced radio/TV technician for help. + +English: +User manuals for license-exempt radio apparatus shall contain the following or equivalent notice in a conspicuous location in the user manual or alternatively on the device or both. This device complies with Industry Canada license-exempt RSS standard(s). Operation is subject to the following two conditions: + +1. this device may not cause interference. +2. this device must accept any interference, including interference that may cause undesired operation of the device. + +French: +Le présent appareil est conforme aux CNR d’Industrie Canada applicables aux appareils radio exempts de licence. L’exploitation est autorisée aux deux conditions suivantes: + +1. l’appareil nedoit pas produire de brouillage. +2. l’utilisateur de l’appareil doit accepter tout brouillage radioélectrique subi, même si le brouillage est susceptible d’en compromettre le fonctionnement. + +**IC SAR Warning:** + +English: +This equipment should be installed and operated with a minimum distance of 20 cm between the radiator and your body. + +French: +Lors de l’installation et de l’exploitation de ce dispositif, la distance entre le radiateur et le corps est d’au moins 20 cm. + +**Important:** The operating temperature of the EUT can’t exceed 85 ℃ and shouldn’t be lower than -40 ℃. + +Hereby, Arduino S.r.l. declares that this product is in compliance with essential requirements and other relevant provisions of Directive 2014/53/EU. This product is allowed to be used in all EU member states. + +# Company Information + +| Company name | Arduino SRL | +|-----------------|-----------------------------------------------| +| Company Address | Via Andrea Appiani, 25 - 20900 MONZA（Italy) | + +# Reference Documentation + +| Ref | Link | +| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Arduino IDE (Desktop) | [https://www.arduino.cc/en/Main/Software](https://www.arduino.cc/en/Main/Software) | +| Arduino Courses | [https://www.arduino.cc/education/courses](https://www.arduino.cc/education/courses) | +| Arduino Documentation | [https://docs.arduino.cc/](https://docs.arduino.cc/) | +| Arduino IDE (Cloud) | [https://create.arduino.cc/editor](https://create.arduino.cc/editor) | +| Cloud IDE Getting Started | [https://docs.arduino.cc/cloud/web-editor/tutorials/getting-started/getting-started-web-editor](https://docs.arduino.cc/cloud/web-editor/tutorials/getting-started/getting-started-web-editor) | +| Project Hub | [https://projecthub.arduino.cc/](https://projecthub.arduino.cc/) | +| Library Reference | [https://github.com/arduino-libraries/](https://github.com/arduino-libraries/) | +| Online Store | [https://store.arduino.cc/](https://store.arduino.cc/) | + +# Revision History +| **Date** | **Revision** | **Changes** | +|------------ |------------ |------------------------------------------------| +| 11/07/2024 | 1 | First release | diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/essentials.md b/content/hardware/11.accessories/modulinos/modulino-buttons/essentials.md new file mode 100644 index 0000000000..762e36d575 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-buttons/essentials.md @@ -0,0 +1,8 @@ + + + + +This library allows you to communicate with the Arduino Modulino® nodes. + + + diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/features.md b/content/hardware/11.accessories/modulinos/modulino-buttons/features.md new file mode 100644 index 0000000000..f6444e41bd --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-buttons/features.md @@ -0,0 +1,14 @@ + +The Modulino® Buttons module includes 3 buttons with LEDs to indicate button presses. It is designed to be used with any compatible board with QWIIC , allowing you to build interactive projects without making complicated connections. The module also includes example projects for you to learn important programming concepts and get inspired. + + + + + +This module includes instructions for projects that use the Modulino® nodes, giving you a starting point to get inspired for your next project. The module also includes 3 buttons with LEDs to indicate button presses. + + +The Modulino® Buttons module connects to your UNO R4 WiFi with Qwiic cables, letting you focus on learning programming without building complex circuits. + + + diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/image.svg b/content/hardware/11.accessories/modulinos/modulino-buttons/image.svg new file mode 100644 index 0000000000..7b8cb18ce7 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-buttons/image.svg @@ -0,0 +1,1340 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/product.md b/content/hardware/11.accessories/modulinos/modulino-buttons/product.md new file mode 100644 index 0000000000..d6cd844a0d --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-buttons/product.md @@ -0,0 +1,11 @@ +--- +title: Modulino® Buttons +url_shop: https://store.arduino.cc/products/modulino-buttons +url_guide: https://courses.arduino.cc/plugandmake +primary_button_url: https://courses.arduino.cc/plugandmake +primary_button_title: Get Started +certifications: [] +sku: [ABX00110] +--- + +Easily add user interaction to your projects with three SPST push buttons and integrated yellow LEDs. Compatible with the Arduino UNO R4 WiFi or any board with a Qwiic interface, and includes solderable pins for direct wiring if you aren’t using Qwiic. Focus on creating interactive experiences without the need for complex circuits. diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tech-specs.md b/content/hardware/11.accessories/modulinos/modulino-buttons/tech-specs.md new file mode 100644 index 0000000000..05fd4da2d3 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-buttons/tech-specs.md @@ -0,0 +1 @@ +Here you will find the technical specifications for the Modulino® Buttons. \ No newline at end of file diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tech-specs.yml b/content/hardware/11.accessories/modulinos/modulino-buttons/tech-specs.yml new file mode 100644 index 0000000000..18d10187fd --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-buttons/tech-specs.yml @@ -0,0 +1,11 @@ +Node: + Name: Modulino Buttons + SKU: ABX00110 + Board recommended: Arduino® UNO R4 WiFi (ABX00087) + Communications: I2C (over Qwiic connector or solderable pin) + Operational voltage: 3.3V + Sensor: + 3 push buttons + 3 yellow LEDs (STM32C011F4): 0x7C (address can change via software) + +Other accessories: + Qwiic cables: 1x diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/AdressChangeIDE.png b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/AdressChangeIDE.png new file mode 100644 index 0000000000..d5cd3fd195 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/AdressChangeIDE.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/ButtonsPinouts.png b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/ButtonsPinouts.png new file mode 100644 index 0000000000..cd1e959c27 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/ButtonsPinouts.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/IDE-Left-Tab.png b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/IDE-Left-Tab.png new file mode 100644 index 0000000000..c7bb86575e Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/IDE-Left-Tab.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/Modulino_Buttons_Power_Tree.png b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/Modulino_Buttons_Power_Tree.png new file mode 100644 index 0000000000..3281df8b8e Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/Modulino_Buttons_Power_Tree.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/adressChanger.png b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/adressChanger.png new file mode 100644 index 0000000000..c6eae670c8 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/adressChanger.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/connection-guide-buttons-jumper.png b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/connection-guide-buttons-jumper.png new file mode 100644 index 0000000000..a2aa5b68df Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/connection-guide-buttons-jumper.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/connection-guide-buttons-qwiic-chain.png b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/connection-guide-buttons-qwiic-chain.png new file mode 100644 index 0000000000..ae538f5949 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/connection-guide-buttons-qwiic-chain.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/connection-guide-buttons-qwiik.png b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/connection-guide-buttons-qwiik.png new file mode 100644 index 0000000000..4df7f0508a Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/connection-guide-buttons-qwiik.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/connection-guide-buttons.gif b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/connection-guide-buttons.gif new file mode 100644 index 0000000000..73e0d48f1c Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/connection-guide-buttons.gif differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/connection-guide-buttons.png b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/connection-guide-buttons.png new file mode 100644 index 0000000000..473282f2a9 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/connection-guide-buttons.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/library-install.gif b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/library-install.gif new file mode 100644 index 0000000000..16f396c353 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/library-install.gif differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/schematic.png b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/schematic.png new file mode 100644 index 0000000000..df5f2cfb25 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/assets/schematic.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/how-to-buttons-ardu.md b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/how-to-buttons-ardu.md new file mode 100644 index 0000000000..7752ac1483 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-ardu/how-to-buttons-ardu.md @@ -0,0 +1,297 @@ +--- +title: "How To Use The Modulino Buttons" +description: "Learn how to get the most out of your Modulino Buttons." +tags: + - Modulino + - QWIIC + - I2C +author: 'Pedro Sousa Lima' +hardware: + - hardware/11.modulinos/modulinos/modulino-buttons +software: + - ide-v2 + - web-editor +--- +The Modulino Buttons is a modular sensor that provides tactile input and visual feedback, making it perfect to add interactive controls to your projects! +The Modulino form factor is shaped with two QWIIC connectors and the I²C protocol integration, allowing the connection and programming of multiple modulinos in a very simple way. In addition to the QWIIC's connectors, the Modulinos also expose solderable pins that can be used in multiple ways and make them compatible with boards that are not QWIIC compatible. + +![Module demonstration](assets/connection-guide-buttons.gif) + +Pressing a button pulls the signal LOW, and each button has an onboard pull-up resistor. The LEDs can be controlled independently through the onboard microcontroller. + +The **Modulino Buttons** module uses three tactile buttons and LEDs, which do not have native I²C capabilities. Instead, the buttons and LEDs are controlled by the Modulino's onboard microcontroller (STM32C011F4U6TR). This microcontroller provides I²C communication, allowing for flexible reading of button states and control of the LEDs. One unique feature of this setup is the ability to change the I²C address via software. This means the address can be modified based on your application needs, making it adaptable to different system configurations. + +The default I²C address for the **Modulino Buttons** module is: + +| Modulino I²C Address | Hardware I²C Address | Editable Addresses (HEX) | +|----------------------|----------------------|-------------------------------------------------| +| 0x7C | 0x3E | Any custom address (via software configuration) | + +When scanning for I²C address on the bus, you might find the modulino using the **Hardware I²C Address**. However, you should always use the **Modulino I²C Address** when using the official Modulino library. +Later in this article we teach how to [change the address](#how-to-change-i2c-address). + +## Pinout + +The tactile buttons and LEDs are the core components of this module. These input and output devices are controlled by an onboard STM32 microcontroller, which supports digital communication (I²C), meaning it connects directly to the I²C bus on the module without requiring additional conversion circuitry. + +![Arduino Buttons Pinout](assets/ButtonsPinouts.png) + +### Input/Output Headers + +| Pin | Function | +|----------|-----------------| +| Button A | Button A Signal | +| Button B | Button B Signal | +| Button C | Button C Signal | +| RX1 | UART Receive | +| TX1 | UART Transmit | +| SWDIO | SWD Data | +| SWCLK | SWD Clock | +| PF2 | NRST | + +**Button A/B/C** – These pins connect directly to the three tactile buttons on the board. +**RX1: UART Receive** – Used for receiving data over UART communication. +**TX1: UART Transmit** – Used for transmitting data over UART communication. +**SWDIO: SWD Data** – Used for debugging, as part of the Serial Wire Debug (SWD) interface. +**SWCLK: SWD Clock** – Used for providing the clock signal in the SWD interface. +**PF2: NRST** – The reset pin for the microcontroller, which can be used to reset the system. + +### 1x4 Header (I2C) + +The pinout for the Modulino Buttons is shown below. While the recommended connection method is via the QWIIC connectors, this solderable header provides a connection option when using the modulino with a non-QWIIC compatible board. + +| Pin | Function | +|-------|--------------| +| GND | Ground | +| 3.3 V | Power Supply | +| SDA | I²C Data | +| SCL | I²C Clock | + +## Power Specifications + +The board is typically powered by +3.3 VDC when using the QWIIC interface as per the I²C standard. + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|------------------|-------------------|---------|-------------|---------|------| +| Supply Voltage | - | 2.3 | 3.3 (QWIIC) | 3.6 | V | +| LED Current Draw | Single LED Active | - | 2.5 | - | mA | + +The module includes a power LED that draws 1 mA and turns on as soon as it is powered. J1 (Qwiic connector), J2 (Qwiic connector), and the headers all share the same power branch. The power distribution of the module is therefore as follows: + +![Power Tree Modulino Buttons](assets/Modulino_Buttons_Power_Tree.png) + +## Schematic + +The Modulino Buttons uses a simple circuit, as shown in the schematic below: + +![Full Schematic Modulino Buttons](assets/schematic.png) + +The main components are the **three tactile buttons**, **three user-programmable LEDs** and the **STM32C011F4U6TR** microcontroller (U1), which handles button state reading, LED control, as well as I²C communication. +You can connect to the I²C pins (SDA and SCL) using either the **QWIIC connectors** (J1 and J2, this is the recommended method) or the **solderable pins** (J4). The board runs on **3.3V**, which comes from the QWIIC cable or the **3V3 pin** on J4. +There's also a small power LED indicator that lights up when the board is on. +You can grab the full schematic and PCB files from the [Modulino Buttons](https://docs.arduino.cc/hardware/modulinos/modulino-buttons) product page. + +## How To Connect Your Modulino + +The easiest and most reliable way to connect your Modulino is through the QWIIC Connect System. It’s plug-and-play, uses standard I²C, and makes it easy to join multiple modules. If your board supports QWIIC, this is the recommended way to go. +Note that the dedicated I²C pins will differ from board to board meaning it is always a good idea to check your specific model. + +![Modulino Wiring Options QWIIC(A - recommended) and Header(B)](assets/connection-guide-buttons.png) + +## QWIIC Connector +Whenever available, the **QWIIC Connect System** is the preferred method. Connecting to the Modulino is extremely simple, just use a standard QWIIC cable to connect your board to either of the QWIIC connectors on the Modulino. Because the cable and connectors are polarized, there is no need to worry about accidentally swapping connections. +QWIIC is a plug-and-play I²C Connect System that uses standardized 4-pin connectors: +- GND +- 3.3V +- SDA (Data) +- SCL (Clock) + +![Connection Guide QWIIC](assets/connection-guide-buttons-qwiik.png) +The Modulino features two QWIIC connectors, which are internally connected in parallel. This means you can daisy-chain multiple modules easily by connecting additional QWIIC cables between them. + +## Solderable Header +When QWIIC is not available, you can use the exposed solderable pins on the module. You can solder pins to the unpopulated pads; just remember the pinout provided in this guide to connect to the right pins of your board. + +![Connection Guide Solder Pads](assets/connection-guide-buttons-jumper.png) + +## Daisy-Chaining Multiple Modulinos + +Regardless of whether you connect the first Modulino via QWIIC or through the solderable pins, you can still take advantage of the extra QWIIC connector to daisy-chain additional modules. +Each Modulino includes two QWIIC connectors wired in parallel, allowing you to connect one module to the next in a chain. As long as each module is configured with a unique I²C address, they can all communicate on the same bus. +This approach keeps your setup clean, modular, and expandable without adding extra wiring complexity. + +![Modulino Wiring Options](assets/connection-guide-buttons-qwiic-chain.png) +***The number of modules you can connect will depend on what modules you are chaining together, as this system allows for multiple sensors from different manufacturers to be added. Also, the cables you use for these connections will play a significant role in the setup’s performance. Ensure your cables are properly connected and capable of handling the required data transfer. +Each module should have a unique address on a chain if you plan to address them individually. Later in this article we teach how to [change the address](#how-to-change-i2c-address). Multiple modules with the same address will cause conflicts on the I²C bus and will not allow you to address them individually.*** + +# How To Use Your Modulino +## Installing The Modulino Library +You need the official Modulino library available [here](https://docs.arduino.cc/libraries/modulino/) to use the Modulino Buttons. + +With the Arduino IDE you get some tools that make adding a library easier. To learn how to install the IDE please visit our [page](https://docs.arduino.cc/software/ide-v2/tutorials/getting-started/ide-v2-downloading-and-installing/). +After opening the IDE, a tab should be visible on the left. Press the book icon for "library" as highlighted in the image. +![IDE Library Tab](assets/IDE-Left-Tab.png) +The process should look like this: +![Library Install](assets/library-install.gif) +A message will appear after the installation is successful. + +# Getting Button Press Data + +Interacting with the Modulino Buttons module is simple using the `Modulino` library. +For the **Buttons** module, there are two key functions: +- `update()`**:** Requests new data from the button module. +- `isPressed(index)`**:** Checks if a specific button (`A`, `B`, or `C`) is pressed. +- `setLeds(A, B, C)`**:** Sets the state of the LED (`A`, `B`, or `C`). +- ```Modulino.begin();```: By default the Modulino library uses ```Wire1``` if your connection is in a different Wire you will have to edit it, check [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/) (by default the Modulino library uses ```Wire1``` if your board model has a different pinout for the dedicated I²C pins you might have to edit it. More information on **Wire** can be found [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/)) for the library's hardware compatibility. More information on **Wire** can be found [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/). + +Here is an example sketch demonstrating how to use these functions to detect button presses: + +```arduino +#include + +// Create object instance +ModulinoButtons buttons; + +void setup() { + Serial.begin(9600); + Modulino.begin(); + buttons.begin(); + + // Function to control the LEDs on top of each button + buttons.setLeds(true, true, true); +} + +void loop() { + // Request new data from the Modulino Buttons + if (buttons.update()) { + // Check if any button has been pressed + if (buttons.isPressed(0)) { + Serial.println("Button A pressed!"); + } else if (buttons.isPressed(1)) { + Serial.println("Button B pressed!"); + } else if (buttons.isPressed(2)) { + Serial.println("Button C pressed!"); + } + } +} +``` +The code example provided shows how to initialize the button module, read button states, and control the LEDs. The program begins by turning on all three LEDs, then continuously checks for button presses and reports them through the serial monitor. Each button is identified by its index (0 for A, 1 for B, 2 for C), making it easy to expand the functionality for more complex interactions. This simple interface can be adapted to trigger various actions in your projects, from controlling other components to navigating menus or implementing game controls. + +# Detecting Button Events + +The Modulino Buttons module can be enhanced with the [Button2 library](https://docs.arduino.cc/libraries/button2/) to detect various button events beyond simple presses. This approach allows you to respond to single clicks, double clicks, triple clicks, and long presses. + +For the **Button Events** functionality, there are several key functions: +- `setButtonStateFunction(function)`**:** Sets a custom function that provides the button state. +- `setClickHandler(function)`**:** Sets a handler for single-click events. +- `setDoubleClickHandler(function)`**:** Sets a handler for double-click events. +- `setTripleClickHandler(function)`**:** Sets a handler for triple-click events. +- `setLongClickHandler(function)`**:** Sets a handler for long-press events. +- `loop()`**:** Must be called repeatedly to check for button state changes. + +Here is an example sketch demonstrating how to implement button event detection: + +```arduino +#include "Arduino_Modulino.h" +#include "Button2.h" + +Button2 button; +ModulinoButtons modulino_buttons; + +uint8_t button0StateHandler() { + modulino_buttons.update(); + return modulino_buttons.isPressed(0) ? LOW : HIGH; // fake a normal button -> LOW = pressed +} + +void handler(Button2& btn) { + switch (btn.getType()) { + case single_click: + break; + case double_click: + Serial.print("double "); + break; + case triple_click: + Serial.print("triple "); + break; + case long_click: + Serial.print("long"); + break; + } + Serial.print("click"); + Serial.print(" ("); + Serial.print(btn.getNumberOfClicks()); + Serial.println(")"); +} + +void setup() { + + Serial.begin(115200); + + Modulino.begin(); + modulino_buttons.begin(); + + button.setDebounceTime(35); + button.setButtonStateFunction(button0StateHandler); + button.setClickHandler(handler); + button.setDoubleClickHandler(handler); + button.setTripleClickHandler(handler); + button.setLongClickHandler(handler); + button.begin(BTN_VIRTUAL_PIN); +} + +void loop() { + button.loop(); +} +``` + +The code example provided shows how to integrate the Button2 library with the Modulino Buttons module to detect advanced button interactions. It creates a virtual button connected to Button A (index 0) and sets up handlers for different types of clicks. The `button0StateHandler()` function serves as a bridge between the Modulino hardware and the Button2 library by converting the button state to the expected format. When running, the program will detect and report single clicks, double clicks, triple clicks, and long presses through the serial monitor. This approach enables more sophisticated user interfaces in your projects, from navigating multi-level menus to implementing different functions based on how a user interacts with a single button. + +## How To Change I2C Address + +An example sketch, AddressChanger, is also included with the library inside the `Utilities` folder and available [here](https://github.com/arduino-libraries/Modulino/blob/main/examples/Utilities/AddressChanger/AddressChanger.ino). This sketch changes the I²C address at a software level on the Module's microcontroller. +![Example location on the IDE](assets/AdressChangeIDE.png) + +- Connect the module to your board, remove any other modules that might be in the chain. Connection must be via I²C. +- Upload the sketch. +- Open the Serial Monitor. +- Text should now appear. Make sure the correct bauld-rate is selected if the displayed characters seem corrupted. + ![Expected console output](assets/adressChanger.png) +- Select the address and confirm. Valid I²C addresses range from 0x08 to 0x77 (7-bit values in hexadecimal format, e.g., 0x42). +- Your address should now have changed. Make sure to take note of the selected address. + +To keep track of the address in use the module has a white rectangle on the back. Feel free to use this to write the address that was chosen. + +When using a custom address in your sketch, you'll need to specify this address when creating the module object. For example: +```arduino +ModulinoButtons buttons(0x3E); // Replace 0x3E with your specific address +``` + + +# Troubleshooting + +## Buttons Not Responding +If your Modulino's power LED isn't on or the buttons aren't responsive, first check that the board is properly connected: +- Ensure both the board and the Modulino are connected to your computer, and that the power LEDs on both are lit. +- If the issue persists, make sure the Qwiic cable is properly clicked into place. + +## Library Not Installed Properly +If you encounter an issue with the `#include "modulino.h"` command, verify that the Modulino library is correctly installed: +- Check your IDE to ensure the library is installed and up-to-date. +- Re-install the library through the Library Manager. + +## LEDs Not Working +If the LEDs aren't lighting up as expected, make sure: +- The correct LED states are being set in your code (true for on, false for off). +- All exposed electronics are not touching any conductive surfaces, as this could interfere with the operation. + +# Conclusion + +The **Modulino Buttons** is a digital input and output device that communicates over I²C and follows the Modulino form factor. It includes standard Qwiic connectors for quick, solderless connections and easy daisy-chaining with other modules. Paired with the Modulino library, it makes detecting button presses and controlling LEDs straightforward, allowing you to focus on experimenting or building your system logic. It's a small, reliable module suited for both user interfaces and interactive control systems. + +# What Is Next? + +Now that you've learned how to use your Modulino Buttons, you're all set to integrate it into your projects! +- Create a simple menu system where each button performs a different function. +- Build a game controller for a simple arcade-style game. +- Use the buttons to control other Modulino devices in your project. +- Design an interactive installation where button presses trigger different visual and audio effects. \ No newline at end of file diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/ButtonsPinouts.png b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/ButtonsPinouts.png new file mode 100644 index 0000000000..cd1e959c27 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/ButtonsPinouts.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/Modulino_Buttons_Power_Tree.png b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/Modulino_Buttons_Power_Tree.png new file mode 100644 index 0000000000..3281df8b8e Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/Modulino_Buttons_Power_Tree.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/connection-guide-buttons-jumper.png b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/connection-guide-buttons-jumper.png new file mode 100644 index 0000000000..a2aa5b68df Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/connection-guide-buttons-jumper.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/connection-guide-buttons-qwiic-chain.png b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/connection-guide-buttons-qwiic-chain.png new file mode 100644 index 0000000000..ae538f5949 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/connection-guide-buttons-qwiic-chain.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/connection-guide-buttons-qwiik.png b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/connection-guide-buttons-qwiik.png new file mode 100644 index 0000000000..4df7f0508a Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/connection-guide-buttons-qwiik.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/connection-guide-buttons.gif b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/connection-guide-buttons.gif new file mode 100644 index 0000000000..73e0d48f1c Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/connection-guide-buttons.gif differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/connection-guide-buttons.png b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/connection-guide-buttons.png new file mode 100644 index 0000000000..473282f2a9 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/connection-guide-buttons.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/mp-usb-connection.png b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/mp-usb-connection.png new file mode 100644 index 0000000000..fb059f9e8b Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/mp-usb-connection.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/package-installer-overview.png b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/package-installer-overview.png new file mode 100644 index 0000000000..67678dc808 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/package-installer-overview.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/schematic.png b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/schematic.png new file mode 100644 index 0000000000..df5f2cfb25 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/assets/schematic.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/how-to-buttons-mp.md b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/how-to-buttons-mp.md new file mode 100644 index 0000000000..e930434dc4 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/how-to-buttons-mp.md @@ -0,0 +1,251 @@ +--- +title: "How To Use The Modulino Thermo And MicroPython" +description: "Learn how to get the most out of your Modulino Thermo in a MicroPython environment." +tags: + - Modulino + - QWIIC + - I2C +author: 'Pedro Sousa Lima' +hardware: + - hardware/11.modulinos/modulinos/modulino-buttons +software: + - ide-v2 + - web-editor +--- +The Modulino Buttons is a modular sensor that provides tactile input and visual feedback, making it perfect to add interactive controls to your projects! +The Modulino form factor is shaped with two QWIIC connectors and the I²C protocol integration, allowing the connection and programming of multiple modulinos in a very simple way. In addition to the QWIIC's connectors, the Modulinos also expose solderable pins that can be used in multiple ways and make them compatible with boards that are not QWIIC compatible. + +![Module demonstration](assets/connection-guide-buttons.gif) + +Pressing a button pulls the signal LOW, and each button has an onboard pull-up resistor. The LEDs can be controlled independently through the onboard microcontroller. + +The **Modulino Buttons** module uses three tactile buttons and LEDs, which do not have native I²C capabilities. Instead, the buttons and LEDs are controlled by the Modulino's onboard microcontroller (STM32C011F4U6TR). This microcontroller provides I²C communication, allowing for flexible reading of button states and control of the LEDs. One unique feature of this setup is the ability to change the I²C address via software. This means the address can be modified based on your application needs, making it adaptable to different system configurations. + +The default I²C address for the **Modulino Buttons** module is: + +| Modulino I²C Address | Hardware I²C Address | Editable Addresses (HEX) | +|----------------------|----------------------|-------------------------------------------------| +| 0x7C | 0x3E | Any custom address (via software configuration) | + +When scanning for I²C address on the bus, you might find the modulino using the **Hardware I²C Address**. However, you should always use the **Modulino I²C Address** when using the official Modulino library. +Later in this article we teach how to [change the address](#how-to-change-i2c-address). + +## Pinout + +The tactile buttons and LEDs are the core components of this module. These input and output devices are controlled by an onboard STM32 microcontroller, which supports digital communication (I²C), meaning it connects directly to the I²C bus on the module without requiring additional conversion circuitry. + +![Arduino Buttons Pinout](assets/ButtonsPinouts.png) + +### Input/Output Headers + +| Pin | Function | +|----------|-----------------| +| Button A | Button A Signal | +| Button B | Button B Signal | +| Button C | Button C Signal | +| RX1 | UART Receive | +| TX1 | UART Transmit | +| SWDIO | SWD Data | +| SWCLK | SWD Clock | +| PF2 | NRST | + +**Button A/B/C** – These pins connect directly to the three tactile buttons on the board. +**RX1: UART Receive** – Used for receiving data over UART communication. +**TX1: UART Transmit** – Used for transmitting data over UART communication. +**SWDIO: SWD Data** – Used for debugging, as part of the Serial Wire Debug (SWD) interface. +**SWCLK: SWD Clock** – Used for providing the clock signal in the SWD interface. +**PF2: NRST** – The reset pin for the microcontroller, which can be used to reset the system. + +### 1x4 Header (I2C) + +The pinout for the Modulino Buttons is shown below. While the recommended connection method is via the QWIIC connectors, this solderable header provides a connection option when using the modulino with a non-QWIIC compatible board. + +| Pin | Function | +|-------|--------------| +| GND | Ground | +| 3.3 V | Power Supply | +| SDA | I²C Data | +| SCL | I²C Clock | + +## Power Specifications + +The board is typically powered by +3.3 VDC when using the QWIIC interface as per the I²C standard. + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|------------------|-------------------|---------|-------------|---------|------| +| Supply Voltage | - | 2.3 | 3.3 (QWIIC) | 3.6 | V | +| LED Current Draw | Single LED Active | - | 2.5 | - | mA | + +The module includes a power LED that draws 1 mA and turns on as soon as it is powered. J1 (Qwiic connector), J2 (Qwiic connector), and the headers all share the same power branch. The power distribution of the module is therefore as follows: + +![Power Tree Modulino Buttons](assets/Modulino_Buttons_Power_Tree.png) + +## Schematic + +The Modulino Buttons uses a simple circuit, as shown in the schematic below: + +![Full Schematic Modulino Buttons](assets/schematic.png) + +The main components are the **three tactile buttons**, **three user-programmable LEDs** and the **STM32C011F4U6TR** microcontroller (U1), which handles button state reading, LED control, as well as I²C communication. +You can connect to the I²C pins (SDA and SCL) using either the **QWIIC connectors** (J1 and J2, this is the recommended method) or the **solderable pins** (J4). The board runs on **3.3V**, which comes from the QWIIC cable or the **3V3 pin** on J4. +There's also a small power LED indicator that lights up when the board is on. +You can grab the full schematic and PCB files from the [Modulino Buttons](https://docs.arduino.cc/hardware/modulinos/modulino-buttons) product page. + +## How To Connect Your Modulino + +The easiest and most reliable way to connect your Modulino is through the QWIIC Connect System. It’s plug-and-play, uses standard I²C, and makes it easy to join multiple modules. If your board supports QWIIC, this is the recommended way to go. +Note that the dedicated I²C pins will differ from board to board meaning it is always a good idea to check your specific model. + +![Modulino Wiring Options QWIIC(A - recommended) and Header(B)](assets/connection-guide-buttons.png) + +## QWIIC Connector +Whenever available, the **QWIIC Connect System** is the preferred method. Connecting to the Modulino is extremely simple, just use a standard QWIIC cable to connect your board to either of the QWIIC connectors on the Modulino. Because the cable and connectors are polarized, there is no need to worry about accidentally swapping connections. +QWIIC is a plug-and-play I²C Connect System that uses standardized 4-pin connectors: +- GND +- 3.3V +- SDA (Data) +- SCL (Clock) + +![Connection Guide QWIIC](assets/connection-guide-buttons-qwiik.png) +The Modulino features two QWIIC connectors, which are internally connected in parallel. This means you can daisy-chain multiple modules easily by connecting additional QWIIC cables between them. + +## Solderable Header +When QWIIC is not available, you can use the exposed solderable pins on the module. You can solder pins to the unpopulated pads; just remember the pinout provided in this guide to connect to the right pins of your board. + +![Connection Guide Solder Pads](assets/connection-guide-buttons-jumper.png) + +## Daisy-Chaining Multiple Modulinos + +Regardless of whether you connect the first Modulino via QWIIC or through the solderable pins, you can still take advantage of the extra QWIIC connector to daisy-chain additional modules. +Each Modulino includes two QWIIC connectors wired in parallel, allowing you to connect one module to the next in a chain. As long as each module is configured with a unique I²C address, they can all communicate on the same bus. +This approach keeps your setup clean, modular, and expandable without adding extra wiring complexity. + +![Modulino Wiring Options](assets/connection-guide-buttons-qwiic-chain.png) +***The number of modules you can connect will depend on what modules you are chaining together, as this system allows for multiple sensors from different manufacturers to be added. Also, the cables you use for these connections will play a significant role in the setup’s performance. Ensure your cables are properly connected and capable of handling the required data transfer. +Each module should have a unique address on a chain if you plan to address it independently. Later in this article we teach how to [change the address](#how-to-change-i2c-address). Multiple modules with the same address will cause conflicts on the I²C bus and will not allow you to address them individually.*** + + +# How To Program Your Modulino + +## Installing The Modulino Library +To program your Modulino it is recommended you use the official ```Modulino``` micropython library available [here](https://github.com/arduino/arduino-modulino-mpy). The library is fully compatible with the no **Arduino Lab for MicroPython**. +For information on installing the **Arduino Lab for MicroPython** please visit our [page](https://docs.arduino.cc/micropython/first-steps/install-guide/). + +The ```Modulino``` library is not available by default on MicroPython devices hence installation is needed. +To simplify the process the [MicroPython Package Installer](https://github.com/arduino/lab-micropython-package-installer/releases) is recommended as it will provide a graphical interface to guide installation. +After installation, you should now be able to: + +1. Open the tool. +2. Plug in your board to the computer. +![USB Connection](assets/mp-usb-connection.png) + +If the board does not appear in the Detected Boards section, click Reload. If the board is still undetected, ensure no other programs (e.g., a code editor) are using the board's COM port. + +4. Search for the ```Modulino``` package by filling in the text box on the search feature. +5. Click Install and wait for the installation confirmation. +6. Disconnect the board from the tool before returning to your code editor to avoid conflicts due to a busy COM port. + +![Package Installer Overview](assets/package-installer-overview.png) + +The module should now be includable in your program using: +```from modulino import ModulinoThermo``` + +# Getting Button Input and Controlling LEDs + +Interacting with buttons using the `Modulino` library is straightforward. For the **Modulino Buttons** module, there are key functions to detect button presses and control the LEDs associated with each button. + +## Detecting Button Presses + +Each button supports different interactions: +- **`.on_button_a_press`**, **`.on_button_b_press`**, **`.on_button_c_press`** + Triggers when a button is pressed. +- **`.on_button_a_long_press`**, **`.on_button_b_long_press`**, **`.on_button_c_long_press`** + Triggers when a button is held down for a longer duration. +- **`.on_button_a_release`**, **`.on_button_b_release`**, **`.on_button_c_release`** + Triggers when a button is released. +By default the Modulino library uses ```Wire1``` if your board model has a different pinout for the dedicated I²C pins you might have to edit it as instructed [here](https://github.com/arduino/arduino-modulino-mpy/tree/main/docs#%E2%84%B9%EF%B8%8F-using-3rd-party-boards). More information on **Wire** can be found [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/). + +## Reading Button Inputs And Controlling LEDs + +```python +from modulino import ModulinoButtons +from time import sleep + +buttons = ModulinoButtons() + +# Define button press actions +buttons.on_button_a_press = lambda : print("Button A pressed") +buttons.on_button_a_long_press = lambda : print("Button A long press") +buttons.on_button_a_release = lambda : print("Button A released") + +buttons.on_button_b_press = lambda : print("Button B pressed") +buttons.on_button_b_long_press = lambda : print("Button B long press") +buttons.on_button_b_release = lambda : print("Button B released") + +buttons.on_button_c_press = lambda : print("Button C pressed") +buttons.on_button_c_long_press = lambda : print("Button C long press") +buttons.on_button_c_release = lambda : print("Button C released") + +# LED Sequence: Turn each LED on with a delay, then turn them off +buttons.led_a.on() +sleep(0.5) +buttons.led_b.on() +sleep(0.5) +buttons.led_c.on() +sleep(0.5) +buttons.set_led_status(False, False, False) # Turn off all LEDs + +while True: + buttons_state_changed = buttons.update() + + if buttons_state_changed: + led_a_status = buttons.is_pressed(0) # Turn LED A on if button A is pressed + led_b_status = buttons.is_pressed(1) # Turn LED B on if button B is pressed + led_c_status = buttons.is_pressed(2) # Turn LED C on if button C is pressed + buttons.set_led_status(led_a_status, led_b_status, led_c_status) +``` + +### How To Change Address + +A sketch is also available included with the library named `AddressChanger` and also available [here](https://github.com/arduino/arduino-modulino-mpy/blob/main/examples/change_address.py). This sketch changes the I2C address at a software level on the Module's microcontroller. + +- Connect the module to your board via I2C, ensuring no other modules are in the chain. +- Run the script in a MicroPython environment. +- Follow the on-screen instructions (REPL) to select the device and enter a new address. Valid I²C addresses range from 0x08 to 0x77 (7-bit values in hexadecimal format, e.g., 0x42). +- The script will attempt to change the address and confirm success. + +To keep track of the address in use, the module has a white rectangle on the back. Feel free to use this to write the address that was chosen. + +When using a custom address in your MicroPython sketch, you'll need to specify this address when creating the module object. For example: +```python +buttons_module = ModulinoButtons(address=0x45) # Replace 0x45 with your specific address +``` + +# Troubleshooting + +## Buttons Not Responding +If your Modulino's power LED isn't on or the buttons aren't responsive, first check that the board is properly connected: +- Ensure both the board and the Modulino are connected to your computer, and that the power LEDs on both are lit. +- If the issue persists, make sure the Qwiic cable is properly clicked into place. + +## Library Not Installed Properly +If you encounter an issue with the `import ModulinoButtons` command, verify that the Modulino library is correctly installed: +- Check your library installer to ensure the library is installed and up-to-date. +- Re-install the library through the Library Manager. + +## LEDs Not Working +If the LEDs aren't lighting up as expected, make sure: +- The correct LED states are being set in your code (true for on, false for off). +- All exposed electronics are not touching any conductive surfaces, as this could interfere with the operation. + +# Conclusion + +The **Modulino Buttons** is a digital input and output device that communicates over I²C and follows the Modulino form factor. It includes standard Qwiic connectors for quick, solderless connections and easy daisy-chaining with other modules. Paired with the Modulino library, it makes detecting button presses and controlling LEDs straightforward, allowing you to focus on experimenting or building your system logic. It's a small, reliable module suited for both user interfaces and interactive control systems. + +# What Is Next? + +Now that you've learned how to use your Modulino Buttons, you're all set to integrate it into your projects! +- Create a simple menu system where each button performs a different function. +- Build a game controller for a simple arcade-style game. +- Use the buttons to control other Modulino devices in your project. +- Design an interactive installation where button presses trigger different visual and audio effects. \ No newline at end of file diff --git a/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/image.png b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/image.png new file mode 100644 index 0000000000..bceefec75d Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buttons/tutorials/how-buttons-mp/image.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/assets/BlockDiagramBuzzer.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/assets/BlockDiagramBuzzer.png new file mode 100644 index 0000000000..f5f1da4872 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/assets/BlockDiagramBuzzer.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/assets/BuzzMec.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/assets/BuzzMec.png new file mode 100644 index 0000000000..ec05c32da9 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/assets/BuzzMec.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/assets/BuzzerPinouts.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/assets/BuzzerPinouts.png new file mode 100644 index 0000000000..41c5fb908f Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/assets/BuzzerPinouts.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/assets/I2CTag.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/assets/I2CTag.png new file mode 100644 index 0000000000..9d9b7b0f72 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/assets/I2CTag.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/assets/Modulino_Buzzer_Power_Tree.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/assets/Modulino_Buzzer_Power_Tree.png new file mode 100644 index 0000000000..7ca852c52b Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/assets/Modulino_Buzzer_Power_Tree.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/assets/ResistorsPullupGen.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/assets/ResistorsPullupGen.png new file mode 100644 index 0000000000..7095581413 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/assets/ResistorsPullupGen.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/assets/featured.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/assets/featured.png new file mode 100644 index 0000000000..27fb2d2b4f Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/assets/featured.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/datasheet.md b/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/datasheet.md new file mode 100644 index 0000000000..758a91fc38 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-buzzer/datasheet/datasheet.md @@ -0,0 +1,254 @@ +--- +identifier: ABX00108 +title: Arduino® Modulino® Buzzer +type: maker +author: Pedro Sousa Lima +--- + +![](assets/featured.png) + +# Description +The Modulino® Buzzer, powered by an on-board **STM32C011F4** microcontroller, provides a compact and versatile way to generate sound alerts and tones through I2C control. Perfect for audible notifications, alarm systems, or simple musical applications in IoT and maker projects. + +# Target Areas +Maker, beginner, education + +# Contents +## Application Examples + +- **Audible Alerts** + Integrate a buzzer notification when a sensor reading crosses a threshold (e.g., temperature limit, motion detected). + +- **Alarm & Security Systems** + Produce warning tones in response to environment triggers or user-defined events. + +- **Interactive Learning Tools** + Combine with other Modulino® nodes (e.g., buttons, sensors) to create hands-on educational projects showcasing real-time sound feedback. + +
+ +## Features +- **PKLCS1212E4001** buzzer controlled by an **STM32C011F4** microcontroller over I2C (Qwiic). +- Operates at **3.3 V** (in line with Qwiic standards, 2.0–3.6 V MCU range). +- **SWD** header for optional reprogramming or custom sound logic. +- Ideal for **alarm tones**, **status beeps**, or **simple audio feedback**. + +### Contents +| **SKU** | **Name** | **Purpose** | **Quantity** | +| ---------- | ----------------- | ----------------------------------------- | ------------ | +| ABX00108 | Modulino® Buzzer | Produce sounds or alerts via I2C control | 1 | +| | I2C Qwiic cable | Compatible with the Qwiic standard | 1 | + + +## Related Products +- *SKU: ASX00027* – [Arduino® Sensor Kit](https://store.arduino.cc/products/arduino-sensor-kit) +- *SKU: K000007* – [Arduino® Starter Kit](https://store.arduino.cc/products/arduino-starter-kit-multi-language) +- *SKU: AKX00026* – [Arduino® Oplà IoT Kit](https://store.arduino.cc/products/opla-iot-kit) + +## Rating + +### Recommended Operating Conditions +- **Microcontroller supply range:** 2.0 V – 3.6 V (STM32C011F4) +- **Powered at 3.3 V** through the Qwiic interface (in accordance with the Qwiic standard) +- **Operating temperature:** –40 °C to +85 °C + +**Typical current consumption:** +- ~6.4 mA when buzzer is active + + +## Power Tree +The power tree for the modulino can be consulted below: + +![Modulino® Buzzer Power Tree](assets/Modulino_Buzzer_Power_Tree.png) + + +## Block Diagram + +This module features an STM32C011F4 microcontroller that drives a PKLCS1212E4001 buzzer. It communicates with the host over I2C (Qwiic). Advanced users can reprogram the MCU for custom audio patterns or logic. + +![Modulino® Buzzer block diagram](assets/BlockDiagramBuzzer.png) + +## Functional Overview +The Modulino® Buzzer node receives sound commands or frequency/tone data via I2C. The STM32C011F4 microcontroller then drives the buzzer, producing audible tones or beeps. For more advanced usage, users can re-flash the firmware via SWD to generate custom waveforms or integrate additional logic. + +### Technical Specifications (Module-Specific) +| **Specification** | **Details** | +| ----------------------- | -------------------------------------------- | +| **Microcontroller** | STM32C011F4 | +| **Accuracy** | ADC: ±2 LSB typical INL | +| **Resolution** | 12-bit ADC | +| **Actuator** | PKLCS1212E4001 buzzer | +| **Supply Voltage** | Min: 2.0 V, Max: 3.6 V | +| **Power Consumption** | ~6.4 mA (buzzer active) | +| **Accuracy** | ADC: ±2 LSB typical INL (for advanced usage) | +| **Resolution** | 12-bit ADC (potential for custom expansions) | +| **Communication** | I2C (Qwiic), SWD, optional UART if reprogrammed | + +### Pinout + +**Qwiic / I2C (1×4 Header)** +| **Pin** | **Function** | +|---------|---------------------------| +| GND | Ground | +| 3.3 V | Power Supply (3.3 V) | +| SDA | I2C Data | +| SCL | I2C Clock | + +These pads and the Qwiic connectors share the same I2C bus at 3.3 V. + +**Additional 1×8 Header (Buzzer & MCU Signals)** +| **Pin** | **Function** | +|---------|--------------------| +| PA0 | Buzzer signal (PWM)| +| RX1 | UART Receive | +| TX1 | UART Transmit | +| SWDIO | SWD Data | +| SWCLK | SWD Clock | +| PF2 | NRST (Reset) | + +**Note:** You can drive the buzzer with custom signals (PWM supplied to the PA0 pin) or reprogram the STM32C011F4 via SWD for alternate modes or advanced functionality. + +![Pinout Overview](assets/BuzzerPinouts.png) + +### Power Specifications +- **Nominal operating voltage:** 3.3 V via Qwiic +- **MCU voltage range:** 2.0 V–3.6 V + +### Mechanical Information +![Modulino® Buzzer Mechanical Information](assets/BuzzMec.png) + +- Board dimensions: 41 mm × 25.36 mm +- Thickness: 1.6 mm (±0.2 mm) +- Four mounting holes (Ø 3.2 mm) + - Hole spacing: 16 mm vertically, 32 mm horizontally + +### I2C Address Reference +| **Board Silk Name** | **Sensor/Actuator** | **Modulino I2C Address (HEX)** | **Editable Addresses (HEX)** | **Hardware I2C Address (HEX)** | +|---------------------|---------------------|--------------------------------|---------------------------------------|--------------------------------| +| MODULINO BUZZER | 1× Buzzer | 0x3C | Any custom address (via FW config) | 0x1E | + +**Note:** Default address is **0x3C**, but custom firmware can reassign it. Check your library or code for details. + +![Blank silk for identification](assets/I2CTag.png) + +#### Pull-up Resistors + +The module has pads for optional I2C pull-up mounting in both data lines. No resistors are mounted by default but in case the resistors are need 4.7 K resistors in an SMD 0402 format are recommended. + +These are positioned near the Qwiic connector on the power LED side. +![Generic pull-up resistor position](assets/ResistorsPullupGen.png) + +## Device Operation +By default, the Modulino® Buzzer node responds to I2C commands to produce tones or beep patterns. You can integrate it with the Arduino IDE or any 3.3 V microcontroller environment. Advanced users may flash custom code via the SWD header to implement unique waveforms or logic. + +# Certifications +## Certifications Summary + +| **Certification** | **Status** | +|:-----------------:|:----------:| +| CE/RED (Europe) | Yes | +| UKCA (UK) | Yes | +| FCC (USA) | Yes | +| IC (Canada) | Yes | +| RoHS | Yes | +| REACH | Yes | +| WEEE | Yes | + +## Declaration of Conformity CE DoC (EU) + +

We declare under our sole responsibility that the products above are in conformity with the essential requirements of the following EU Directives and therefore qualify for free movement within markets comprising the European Union (EU) and European Economic Area (EEA).

+ +## Declaration of Conformity to EU RoHS & REACH 211 01/19/2021 + +

Arduino boards are in compliance with RoHS 2 Directive 2011/65/EU of the European Parliament and RoHS 3 Directive 2015/863/EU of the Council of 4 June 2015 on the restriction of the use of certain hazardous substances in electrical and electronic equipment.

+ +| Substance | **Maximum limit (ppm)** | +|----------------------------------------|-------------------------| +| Lead (Pb) | 1000 | +| Cadmium (Cd) | 100 | +| Mercury (Hg) | 1000 | +| Hexavalent Chromium (Cr6+) | 1000 | +| Poly Brominated Biphenyls (PBB) | 1000 | +| Poly Brominated Diphenyl ethers (PBDE) | 1000 | +| Bis(2-Ethylhexyl) phthalate (DEHP) | 1000 | +| Benzyl butyl phthalate (BBP) | 1000 | +| Dibutyl phthalate (DBP) | 1000 | +| Diisobutyl phthalate (DIBP) | 1000 | + +Exemptions: No exemptions are claimed. + +

Arduino Boards are fully compliant with the related requirements of European Union Regulation (EC) 1907 /2006 concerning the Registration, Evaluation, Authorization and Restriction of Chemicals (REACH). We declare none of the SVHCs (https://echa.europa.eu/web/guest/candidate-list-table), the Candidate List of Substances of Very High Concern for authorization currently released by ECHA, is present in all products (and also package) in quantities totaling in a concentration equal or above 0.1%. To the best of our knowledge, we also declare that our products do not contain any of the substances listed on the "Authorization List" (Annex XIV of the REACH regulations) and Substances of Very High Concern (SVHC) in any significant amounts as specified by the Annex XVII of Candidate list published by ECHA (European Chemical Agency) 1907 /2006/EC.

+ +## Conflict Minerals Declaration + +

As a global supplier of electronic and electrical components, Arduino is aware of our obligations with regard to laws and regulations regarding Conflict Minerals, specifically the Dodd-Frank Wall Street Reform and Consumer Protection Act, Section 1502. Arduino does not directly source or process conflict minerals such as Tin, Tantalum, Tungsten, or Gold. Conflict minerals are contained in our products in the form of solder or as a component in metal alloys. As part of our reasonable due diligence, Arduino has contacted component suppliers within our supply chain to verify their continued compliance with the regulations. Based on the information received thus far we declare that our products contain Conflict Minerals sourced from conflict-free areas.

+ +## FCC Caution + +Any Changes or modifications not expressly approved by the party responsible for compliance could void the user’s authority to operate the equipment. + +This device complies with part 15 of the FCC Rules. Operation is subject to the following two conditions: + +1. This device may not cause harmful interference. +2. This device must accept any interference received, including interference that may cause undesired operation. + +**FCC RF Radiation Exposure Statement:** + +1. This Transmitter must not be co-located or operating in conjunction with any other antenna or transmitter. +2. This equipment complies with RF radiation exposure limits set forth for an uncontrolled environment. +3. This equipment should be installed and operated with a minimum distance of 20 cm between the radiator & your body. + +**Note:** This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures: + +- Reorient or relocate the receiving antenna. +- Increase the separation between the equipment and receiver. +- Connect the equipment into an outlet on a circuit different from that to which the receiver is connected. +- Consult the dealer or an experienced radio/TV technician for help. + +English: +User manuals for license-exempt radio apparatus shall contain the following or equivalent notice in a conspicuous location in the user manual or alternatively on the device or both. This device complies with Industry Canada license-exempt RSS standard(s). Operation is subject to the following two conditions: + +1. this device may not cause interference. +2. this device must accept any interference, including interference that may cause undesired operation of the device. + +French: +Le présent appareil est conforme aux CNR d’Industrie Canada applicables aux appareils radio exempts de licence. L’exploitation est autorisée aux deux conditions suivantes: + +1. l’appareil nedoit pas produire de brouillage. +2. l’utilisateur de l’appareil doit accepter tout brouillage radioélectrique subi, même si le brouillage est susceptible d’en compromettre le fonctionnement. + +**IC SAR Warning:** + +English: +This equipment should be installed and operated with a minimum distance of 20 cm between the radiator and your body. + +French: +Lors de l’installation et de l’exploitation de ce dispositif, la distance entre le radiateur et le corps est d’au moins 20 cm. + +**Important:** The operating temperature of the EUT can’t exceed 85 ℃ and shouldn’t be lower than -40 ℃. + +Hereby, Arduino S.r.l. declares that this product is in compliance with essential requirements and other relevant provisions of Directive 2014/53/EU. This product is allowed to be used in all EU member states. + +# Company Information + +| Company name | Arduino SRL | +|-----------------|-----------------------------------------------| +| Company Address | Via Andrea Appiani, 25 - 20900 MONZA（Italy) | + +# Reference Documentation + +| Ref | Link | +| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Arduino IDE (Desktop) | [https://www.arduino.cc/en/Main/Software](https://www.arduino.cc/en/Main/Software) | +| Arduino Courses | [https://www.arduino.cc/education/courses](https://www.arduino.cc/education/courses) | +| Arduino Documentation | [https://docs.arduino.cc/](https://docs.arduino.cc/) | +| Arduino IDE (Cloud) | [https://create.arduino.cc/editor](https://create.arduino.cc/editor) | +| Cloud IDE Getting Started | [https://docs.arduino.cc/cloud/web-editor/tutorials/getting-started/getting-started-web-editor](https://docs.arduino.cc/cloud/web-editor/tutorials/getting-started/getting-started-web-editor) | +| Project Hub | [https://projecthub.arduino.cc/](https://projecthub.arduino.cc/) | +| Library Reference | [https://github.com/arduino-libraries/](https://github.com/arduino-libraries/) | +| Online Store | [https://store.arduino.cc/](https://store.arduino.cc/) | + +# Revision History +| **Date** | **Revision** | **Changes** | +|------------ |------------ |------------------------------------------------| +| 11/07/2024 | 1 | First release | diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/essentials.md b/content/hardware/11.accessories/modulinos/modulino-buzzer/essentials.md new file mode 100644 index 0000000000..762e36d575 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-buzzer/essentials.md @@ -0,0 +1,8 @@ + + + + +This library allows you to communicate with the Arduino Modulino® nodes. + + + diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/features.md b/content/hardware/11.accessories/modulinos/modulino-buzzer/features.md new file mode 100644 index 0000000000..b0915aec81 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-buzzer/features.md @@ -0,0 +1,12 @@ + +The Modulino® Buzzer module adds audio feedback to your projects with an integrated buzzer. It is compatible with the Arduino UNO R4 WiFi or any board with a Qwiic interface, allowing you to generate tones, alerts, or melodies without messy wiring. + + + + + Follow example projects to learn how to produce beeps and tunes for notifications or interactive feedback, even if you’re just starting with electronics. + + + The Modulino® Buzzer links via Qwiic cables to your UNO R4 WiFi or other boards with a Qwiic interface. Solderable pins allow for direct wiring when Qwiic isn’t available. + + diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/image.svg b/content/hardware/11.accessories/modulinos/modulino-buzzer/image.svg new file mode 100644 index 0000000000..6563927b88 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-buzzer/image.svg @@ -0,0 +1,960 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/product.md b/content/hardware/11.accessories/modulinos/modulino-buzzer/product.md new file mode 100644 index 0000000000..91c737d999 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-buzzer/product.md @@ -0,0 +1,11 @@ +--- +title: Modulino® Buzzer +url_shop: https://store.arduino.cc/products/modulino-buzzer +url_guide: https://courses.arduino.cc/plugandmake +primary_button_url: https://courses.arduino.cc/plugandmake +primary_button_title: Get Started +certifications: [] +sku: [ABX00108] +--- + +Easily add audible alerts and notifications to any project with the built-in buzzer. From simple beeps to quick tunes, it keeps you informed. It connects to Arduino UNO R4 WiFi or other Qwiic-capable boards, and solderable pins allow for direct wiring whenever needed. diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tech-specs.md b/content/hardware/11.accessories/modulinos/modulino-buzzer/tech-specs.md new file mode 100644 index 0000000000..e44c926c08 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-buzzer/tech-specs.md @@ -0,0 +1 @@ +Here you will find the technical specifications for the Modulino® Buzzer. \ No newline at end of file diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tech-specs.yml b/content/hardware/11.accessories/modulinos/modulino-buzzer/tech-specs.yml new file mode 100644 index 0000000000..9a9ea0f579 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-buzzer/tech-specs.yml @@ -0,0 +1,11 @@ +Node: + Name: Modulino Buzzer + SKU: ABX00108 + Board recommended: Arduino® UNO R4 WiFi (ABX00087) + Communications: I2C (over Qwiic connector or solderable pin) + Operational voltage: 3.3V + Sensor: + PKLCS1212E4001-R1 (STM32C011F4): 0x3C (address can change via software) + +Other accessories: + Qwiic cables: 1x diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/BuzzerPinouts.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/BuzzerPinouts.png new file mode 100644 index 0000000000..4c1c420282 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/BuzzerPinouts.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/IDE-Left-Tab.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/IDE-Left-Tab.png new file mode 100644 index 0000000000..c7bb86575e Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/IDE-Left-Tab.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/Modulino_Buzzer_Power_Tree.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/Modulino_Buzzer_Power_Tree.png new file mode 100644 index 0000000000..7ca852c52b Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/Modulino_Buzzer_Power_Tree.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/addressChangeIDE.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/addressChangeIDE.png new file mode 100644 index 0000000000..d5cd3fd195 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/addressChangeIDE.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/adressChanger.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/adressChanger.png new file mode 100644 index 0000000000..c6eae670c8 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/adressChanger.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/buzzerPA0.gif b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/buzzerPA0.gif new file mode 100644 index 0000000000..7f133eb687 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/buzzerPA0.gif differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/connection-guide-buzzer-jumper.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/connection-guide-buzzer-jumper.png new file mode 100644 index 0000000000..1a45271300 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/connection-guide-buzzer-jumper.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/connection-guide-buzzer-qwiic-chain.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/connection-guide-buzzer-qwiic-chain.png new file mode 100644 index 0000000000..a90c8fdf46 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/connection-guide-buzzer-qwiic-chain.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/connection-guide-buzzer-qwiik.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/connection-guide-buzzer-qwiik.png new file mode 100644 index 0000000000..6ee9d1c03a Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/connection-guide-buzzer-qwiik.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/connection-guide-buzzer.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/connection-guide-buzzer.png new file mode 100644 index 0000000000..4f6bd1cd6c Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/connection-guide-buzzer.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/library-install.gif b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/library-install.gif new file mode 100644 index 0000000000..16f396c353 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/library-install.gif differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/schematic.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/schematic.png new file mode 100644 index 0000000000..4d0d4a9098 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/assets/schematic.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/content.md b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/content.md new file mode 100644 index 0000000000..b7ee8fe477 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-ardu/content.md @@ -0,0 +1,239 @@ +--- +title: "How To Use The Modulino Buzzer" +description: "Learn how to get the most out of your Modulino Buzzer." +tags: + - Modulino + - QWIIC + - I2C +author: 'Pedro Sousa Lima' +hardware: + - hardware/11.modulinos/modulinos/modulino-buzzer +software: + - ide-v2 + - web-editor +--- +The Modulino Buzzer is a modular sensor that generates audio output, making it perfect to add sound feedback to your projects! +The Modulino form factor is shaped with two QWIIC connectors and the I²C protocol integration, allowing the connection and programming of multiple modulinos in a very simple way. In addition to the QWIIC's connectors, the Modulinos also expose solderable pins that can be used in multiple ways and make them compatible with boards that are not QWIIC compatible. + + +## Hardware Specifications + +The Modulino Buzzer based on the buzzer (PKLCS1212E4001-R1) is capable of generating different tones and sound patterns. Take a look at the following table to know more about its characteristics: + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|----------------------|-------------------|---------|---------|---------|------| +| Frequency Range | - | 2,000 | - | 4,000 | Hz | +| Resonant Frequency | - | 2,400 | 2,700 | 3,000 | Hz | +| Sound Pressure Level | @ 2.7 kHz, 3.3Vpp | - | 75 | - | dB | + +## Sensor Details + +The **Modulino Buzzer** module uses the **PKLCS1212E4001-R1** buzzer, which does not have native I²C capabilities. Instead, the buzzer is controlled by the Modulino's onboard microcontroller (STM32C011F4U6T). This microcontroller provides I²C communication, allowing for flexible control of the buzzer. + +One unique feature of this setup is the ability to change the I²C address via software. This means the address can be modified based on your application needs, making it adaptable to different system configurations. + +The default I²C address for the **Modulino Buzzer** module is: + +| Modulino I²C Address | Hardware I²C Address |Editable Addresses (HEX)| +|----------------------|----------------------|----------------------| +| 0x3C | 0x1E |Any custom address (via software configuration) + + +When scanning for I²C address on the bus, you might find the modulino using the **Hardware I²C Address**. However, you should always use the **Modulino I²C Address** when using the official Modulino library. +Later in this article we teach how to [change the address](#how-to-change-i2c-address). + + +## Pinout + +The PKLCS1212E4001-R1 buzzer is the core component of this module. This audio output device is controlled by an onboard STM32 microcontroller, which supports digital communication (I²C), meaning it connects directly to the I²C bus on the module without requiring additional conversion circuitry. + +![Arduino Buzzer Pinout](assets/BuzzerPinouts.png) + +### 1x6 Header (LSM6DSOXTR) +| Pin | Function | +|-------|---------------| +| PA0 | Buzzer Signal | +| RX1 | UART Receive | +| TX1 | UART Transmit | +| SWDIO | SWD Data | +| SWCLK | SWD Clock | +| PF2 | NRST | + +**PA0: Buzzer Signal** – This pin is used to control the buzzer's output signal. In fact, this pin can be used to bypass the I²C interface and control the buzzer directly using a square wave. +![Direct control via signal](assets/buzzerPA0.gif) +****RX1:** UART Receive** – Used for receiving data over UART communication. +**TX1: UART Transmit** – Used for transmitting data over UART communication. +**SWDIO: SWD Data** – Used for debugging, as part of the Serial Wire Debug (SWD) interface. +**SWCLK: SWD Clock** – Used for providing the clock signal in the SWD interface. +**PF2: NRST** – The reset pin for the microcontroller, which can be used to reset the system. + +### 1x4 Header (I2C) +The pinout for the Modulino Buzzer is shown below. While the recommended connection method is via the QWIIC connectors, this solderable header provides a connection option when using the modulino with a non-QWIIC compatible board. + +| Pin | Function | +|-------|--------------| +| GND | Ground | +| 3.3 V | Power Supply | +| SDA | I²C Data | +| SCL | I²C Clock | + + +## Power Specifications + +The board is typically powered by +3.3 VDC when using the QWIIC interface as per the I²C standard. + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|---------------------|-----------------|---------|---------|---------|------| +| Operating Voltage | - | 2.5 | 3.3 | 3.6 | V | +| Current Consumption | @ 3.3V, 2.7 kHz | - | 120 | - | μA | + +The module includes a power LED that draws 1 mA and turns on as soon as it is powered. +J1 (Qwiic connector), J2 (Qwiic connector), and the headers all share the same power branch. The power distribution of the module is therefore as follows: +![Power Tree Modulino Buzzer](assets/Modulino_Buzzer_Power_Tree.png) + +## Schematic + +The Modulino Buzzer uses a simple circuit, as shown in the schematic below: + +![Full Schematic Modulino Buzzer](assets/schematic.png) + +The main components are the **PKLCS1212E4001-R1 buzzer** and the **STM32C011F6U6TR** microcontroller (U1), which handles tone generation as well as I²C communication. + +You can connect to the I²C pins (SDA and SCL) using either the **QWIIC connectors** (J1 and J2, this is the recommended method) or the **solderable pins** (J4). The board runs on **3.3V**, which comes from the QWIIC cable or the **3V3 pin** on J4. + +There's also a small power LED indicator that lights up when the board is on. + +You can grab the full schematic and PCB files from the [Modulino Buzzer](https://docs.arduino.cc/hardware/modulinos/modulino-buzzer) product page. + +# How To Connect Your Modulino + +The easiest and most reliable way to connect your Modulino is through the QWIIC Connect System. It’s plug-and-play, uses standard I²C, and makes it easy to join multiple modules. If your board supports QWIIC, this is the recommended way to go. Note that the dedicated I²C pins will differ from board to board meaning it is always a good idea to check your specific model. + +If your board doesn’t have a QWIIC connector, you can still access the same I²C bus and power the module using the solderable header pads just make sure you wire it to 3.3V and match the I²C pinout. + +![Modulino Wiring Options QWIIC(A - recommended) and Header(B)](assets/connection-guide-buzzer.png) + +## QWIIC Connector + +Whenever available, the **QWIIC Connect System** is the preferred method. Connecting to the Modulino is extremely simple, just use a standard QWIIC cable to connect your board to either of the QWIIC connectors on the Modulino. Because the cable and connectors are polarized, there is no need to worry about accidentally swapping connections. + +QWIIC is a plug-and-play I²C Connect System that uses standardized 4-pin connectors: +- GND +- 3.3V +- SDA (Data) +- SCL (Clock) + +![Connection Guide QWIIC](assets/connection-guide-buzzer-qwiik.png) + +The Modulino features two QWIIC connectors, which are internally connected in parallel. This means you can daisy-chain multiple modules easily by connecting additional QWIIC cables between them. + +## Solderable Header +When QWIIC is not available, you can use the exposed solderable pins on the module. You can solder pins to the unpopulated pads; just remember the pinout provided in this guide to connect to the right pins of your board. + +![Connection Guide Solder Pads](assets/connection-guide-buzzer-jumper.png) + +## Daisy-Chaining Multiple Modulinos + +Regardless of whether you connect the first Modulino via QWIIC or through the solderable pins, you can still take advantage of the extra QWIIC connector to daisy-chain additional modules. + +Each Modulino includes two QWIIC connectors wired in parallel, allowing you to connect one module to the next in a chain. As long as each module is configured with a unique I²C address, they can all communicate on the same bus as long as you select the correct I²C pins depending on your board. + +This approach keeps your setup clean, modular, and expandable without adding extra wiring complexity. + +![Modulino Wiring Options](assets/connection-guide-buzzer-qwiic-chain.png) +***The number of modules you can connect will depend on what modules you are chaining together, as this system allows for multiple sensors from different manufacturers to be added. Also, the cables you use for these connections will play a significant role in the setup’s performance. Ensure your cables are properly connected and capable of handling the required data transfer. +Each module should have a unique address on a chain if you plan to address them individually. Later in this article we teach how to [change the address](#how-to-change-i2c-address). Multiple modules with the same address will cause conflicts on the I²C bus and will not allow you to address them individually.*** + +# How To Use Your Modulino +## Installing The Modulino Library +You need the official Modulino library available [here](https://docs.arduino.cc/libraries/modulino/) to use the Modulino Buzzer. + +With the Arduino IDE you get some tools that make adding a library easier. To learn how to install the IDE please visit our [page](https://docs.arduino.cc/software/ide-v2/tutorials/getting-started/ide-v2-downloading-and-installing/). +After opening the IDE, a tab should be visible on the left. Press the book icon for "library" as highlighted in the image. +![IDE Library Tab](assets/IDE-Left-Tab.png) +The process should look like this: +![Library Install](assets/library-install.gif) +A message will appear after the installation is successful. + +## Play A Simple Tune + +Getting sound feedback from the buzzer is fairly simple using the ```Modulino``` library. For the **Modulino Buzzer** there is one important function: +- ```tone(frequency, duration)```: Generates a tone with the specified frequency (in Hz) and duration (in milliseconds). +- ```Modulino.begin();```: By default the Modulino library uses ```Wire1``` if your connection is in a different Wire you will have to edit it, check [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/) (by default the Modulino library uses ```Wire1``` if your board model has a different pinout for the dedicated I²C pins you might have to edit it. More information on **Wire** can be found [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/)) for the library's hardware compatibility. More information on **Wire** can be found [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/). + +Here is an example sketch of how to implement this function to control the buzzer: + +```arduino +#include + +ModulinoBuzzer buzzer; + +int frequency = 440; // Frequency of the tone in Hz +int duration = 1000; // Duration of the tone in milliseconds + +void setup(){ + Modulino.begin(); + buzzer.begin(); +} + +void loop(){ + buzzer.tone(frequency, duration); // Generate the tone + delay(1000); // Wait for 1 second + buzzer.tone(0, duration); // Stop the tone + delay(1000); // Wait for 1 second +} +``` + +The code example provided shows how to initialize the buzzer and generate tones. The buzzer alternates between playing a 440 Hz tone for one second and staying silent for one second. +It can be easily adapted to play different melodies or to provide sound feedback for your projects based on specific conditions or events. + +## How To Change I2C Address + +An example sketch, AddressChanger, is also included with the library inside the `Utilities` folder and available [here](https://github.com/arduino-libraries/Modulino/blob/main/examples/Utilities/AddressChanger/AddressChanger.ino). This sketch changes the I²C address at a software level on the Module's microcontroller. +![Example location on the IDE](assets/addressChangeIDE.png) + +- Connect the module to your board, remove any other modules that might be in the chain. Connection must be via I²C. +- Upload the sketch. +- Open the Serial Monitor. +- Text should now appear. Make sure the correct bauld-rate is selected if the displayed characters seem corrupted. + ![Expected console output](assets/adressChanger.png) +- Select the address and confirm. Valid I²C addresses range from 0x08 to 0x77 (7-bit values in hexadecimal format, e.g., 0x42). +- Your address should now have changed. Make sure to take note of the selected address. + +To keep track of the address in use the module has a white rectangle on the back. Feel free to use this to write the address that was chosen. + +When using a custom address in your sketch, you'll need to specify this address when creating the module object. For example: +```arduino +ModulinoBuzzer buzzer(0x3E); // Replace 0x3E with your specific address +``` + + +# Troubleshooting + +## Buzzer Not Sounding +If your Modulino's power LED isn't on or the buzzer isn't responsive, first check that the board is properly connected: +- Ensure both the board and the Modulino are connected to your computer, and that the power LEDs on both are lit. +- If the issue persists, make sure the Qwiic cable is properly clicked into place. + +## Library Not Installed Properly +If you encounter an issue with the `#include "modulino.h"` command, verify that the Modulino library is correctly installed: +- Check your IDE to ensure the library is installed and up-to-date. +- Re-install the library through the Library Manager. + +## Distorted Sound +If the buzzer sound is distorted or not playing as expected, make sure: +- The correct frequency values are being used (typically between 20 Hz and 20 kHz for audible sounds). +- All exposed electronics are not touching any conductive surfaces, as this could interfere with the sound output. + +# Conclusion + +The **Modulino Buzzer** is a digital sound output device that communicates over I²C and follows the Modulino form factor. It includes standard Qwiic connectors for quick, solderless connections and easy daisy-chaining with other modules. Paired with the Modulino library, it makes generating sound feedback straightforward, allowing you to focus on experimenting or building your system logic. It's a small, reliable module suited for both interactive feedback and audio alert systems. + +# What Is Next? + +Now that you've learned how to use your Modulino Buzzer, you're all set to integrate it into your projects! +- Experiment with different frequencies to create various tones and melodies. +- Try creating a simple alarm system that triggers the buzzer when certain conditions are met. +- Use the buzzer to provide feedback in your interactive projects when a button is pressed or a threshold is reached. +- Create a music box that plays different tunes when specific inputs are detected! + diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/BuzzerPinouts.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/BuzzerPinouts.png new file mode 100644 index 0000000000..4c1c420282 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/BuzzerPinouts.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/Modulino_Buzzer_Power_Tree.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/Modulino_Buzzer_Power_Tree.png new file mode 100644 index 0000000000..7ca852c52b Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/Modulino_Buzzer_Power_Tree.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/buzzerPA0.gif b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/buzzerPA0.gif new file mode 100644 index 0000000000..7f133eb687 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/buzzerPA0.gif differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/connection-guide-buzzer-jumper.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/connection-guide-buzzer-jumper.png new file mode 100644 index 0000000000..1b61af02f8 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/connection-guide-buzzer-jumper.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/connection-guide-buzzer-qwiic-chain.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/connection-guide-buzzer-qwiic-chain.png new file mode 100644 index 0000000000..a90c8fdf46 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/connection-guide-buzzer-qwiic-chain.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/connection-guide-buzzer-qwiik.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/connection-guide-buzzer-qwiik.png new file mode 100644 index 0000000000..0dbdad86af Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/connection-guide-buzzer-qwiik.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/connection-guide-buzzer.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/connection-guide-buzzer.png new file mode 100644 index 0000000000..4f6bd1cd6c Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/connection-guide-buzzer.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/mp-usb-connection.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/mp-usb-connection.png new file mode 100644 index 0000000000..fb059f9e8b Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/mp-usb-connection.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/package-installer-overview.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/package-installer-overview.png new file mode 100644 index 0000000000..67678dc808 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/package-installer-overview.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/schematic.png b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/schematic.png new file mode 100644 index 0000000000..4d0d4a9098 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/assets/schematic.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/content.md b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/content.md new file mode 100644 index 0000000000..41af65a707 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-buzzer/tutorials/how-buzzer-mp/content.md @@ -0,0 +1,241 @@ +--- +title: "How To Use The Modulino Movement And MicroPython" +description: "Learn how to get the most out of your Modulino Movement in a MicroPython environment." +tags: + - Modulino + - QWIIC + - I2C +author: 'Pedro Sousa Lima' +hardware: + - hardware/11.modulinos/modulinos/modulino-movement +software: + - ide-v2 + - web-editor +--- +The Modulino Buzzer is a modular sensor that generates audio output, making it perfect to add sound feedback to your projects! +The Modulino form factor is shaped with two QWIIC connectors and the I²C protocol integration, allowing the connection and programming of multiple modulinos in a very simple way. In addition to the QWIIC's connectors, the Modulinos also expose solderable pins that can be used in multiple ways and make them compatible with boards that are not QWIIC compatible. + + +## Hardware Specifications + +The Modulino Buzzer based on the buzzer (PKLCS1212E4001-R1) is capable of generating different tones and sound patterns. Take a look at the following table to know more about its characteristics: + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|----------------------|-------------------|---------|---------|---------|------| +| Frequency Range | - | 2,000 | - | 4,000 | Hz | +| Resonant Frequency | - | 2,400 | 2,700 | 3,000 | Hz | +| Sound Pressure Level | @ 2.7 kHz, 3.3Vpp | - | 75 | - | dB | + +## Sensor Details + +The **Modulino Buzzer** module uses the **PKLCS1212E4001-R1** buzzer, which does not have native I²C capabilities. Instead, the buzzer is controlled by the Modulino's onboard microcontroller (STM32C011F4U6T). This microcontroller provides I²C communication, allowing for flexible control of the buzzer. + +One unique feature of this setup is the ability to change the I²C address via software. This means the address can be modified based on your application needs, making it adaptable to different system configurations. + +The default I²C address for the **Modulino Buzzer** module is: + +| Modulino I²C Address | Hardware I²C Address |Editable Addresses (HEX)| +|----------------------|----------------------|----------------------| +| 0x3C | 0x1E |Any custom address (via software configuration) + + +When scanning for I²C address on the bus, you might find the modulino using the **Hardware I²C Address**. However, you should always use the **Modulino I²C Address** when using the official Modulino library. +Later in this article we teach how to [change the address](#how-to-change-i2c-address). + +## Pinout + +The PKLCS1212E4001-R1 buzzer is the core component of this module. This audio output device is controlled by an onboard STM32 microcontroller, which supports digital communication (I²C), meaning it connects directly to the I²C bus on the module without requiring additional conversion circuitry. + +![Arduino Buzzer Pinout](assets/BuzzerPinouts.png) + +### 1x6 Header (LSM6DSOXTR) +| Pin | Function | +|-------|---------------| +| PA0 | Buzzer Signal | +| RX1 | UART Receive | +| TX1 | UART Transmit | +| SWDIO | SWD Data | +| SWCLK | SWD Clock | +| PF2 | NRST | + +**PA0: Buzzer Signal** – This pin is used to control the buzzer's output signal. In fact, this pin can be used to bypass the I²C interface and control the buzzer directly using a square wave. +![Direct control via signal](assets/buzzerPA0.gif) +****RX1:** UART Receive** – Used for receiving data over UART communication. +**TX1: UART Transmit** – Used for transmitting data over UART communication. +**SWDIO: SWD Data** – Used for debugging, as part of the Serial Wire Debug (SWD) interface. +**SWCLK: SWD Clock** – Used for providing the clock signal in the SWD interface. +**PF2: NRST** – The reset pin for the microcontroller, which can be used to reset the system. + +### 1x4 Header (I2C) +The pinout for the Modulino Buzzer is shown below. While the recommended connection method is via the QWIIC connectors, this solderable header provides a connection option when using the modulino with a non-QWIIC compatible board. + +| Pin | Function | +|-------|--------------| +| GND | Ground | +| 3.3 V | Power Supply | +| SDA | I²C Data | +| SCL | I²C Clock | + + +## Power Specifications + +The board is typically powered by +3.3 VDC when using the QWIIC interface as per the I²C standard. + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|---------------------|-----------------|---------|---------|---------|------| +| Operating Voltage | - | 2.5 | 3.3 | 3.6 | V | +| Current Consumption | @ 3.3V, 2.7 kHz | - | 120 | - | μA | + +The module includes a power LED that draws 1 mA and turns on as soon as it is powered. +J1 (Qwiic connector), J2 (Qwiic connector), and the headers all share the same power branch. The power distribution of the module is therefore as follows: +![Power Tree Modulino Buzzer](assets/Modulino_Buzzer_Power_Tree.png) + +## Schematic + +The Modulino Buzzer uses a simple circuit, as shown in the schematic below: + +![Full Schematic Modulino Buzzer](assets/schematic.png) + +The main components are the **PKLCS1212E4001-R1 buzzer** and the **STM32C011F6U6TR** microcontroller (U1), which handles tone generation as well as I²C communication. + +You can connect to the I²C pins (SDA and SCL) using either the **QWIIC connectors** (J1 and J2, this is the recommended method) or the **solderable pins** (J4). The board runs on **3.3V**, which comes from the QWIIC cable or the **3V3 pin** on J4. + +There's also a small power LED indicator that lights up when the board is on. + +You can grab the full schematic and PCB files from the [Modulino Buzzer](https://docs.arduino.cc/hardware/modulinos/modulino-buzzer) product page. + +# How To Connect Your Modulino + +The easiest and most reliable way to connect your Modulino is through the QWIIC Connect System. It’s plug-and-play, uses standard I²C, and makes it easy to join multiple modules. If your board supports QWIIC, this is the recommended way to go. Note that the dedicated I²C pins will differ from board to board meaning it is always a good idea to check your specific model. + +If your board doesn’t have a QWIIC connector, you can still access the same I²C bus and power the module using the solderable header pads just make sure you wire it to 3.3V and match the I²C pinout. + +![Modulino Wiring Options QWIIC(A - recommended) and Header(B)](assets/connection-guide-buzzer.png) + +## QWIIC Connector + +Whenever available, the **QWIIC Connect System** is the preferred method. Connecting to the Modulino is extremely simple, just use a standard QWIIC cable to connect your board to either of the QWIIC connectors on the Modulino. Because the cable and connectors are polarized, there is no need to worry about accidentally swapping connections. + +QWIIC is a plug-and-play I²C Connect System that uses standardized 4-pin connectors: +- GND +- 3.3V +- SDA (Data) +- SCL (Clock) + +![Connection Guide QWIIC](assets/connection-guide-buzzer-qwiik.png) + +The Modulino features two QWIIC connectors, which are internally connected in parallel. This means you can daisy-chain multiple modules easily by connecting additional QWIIC cables between them. + +## Solderable Header +When QWIIC is not available, you can use the exposed solderable pins on the module. You can solder pins to the unpopulated pads; just remember the pinout provided in this guide to connect to the right pins of your board. + +![Connection Guide Solder Pads](assets/connection-guide-buzzer-jumper.png) + +## Daisy-Chaining Multiple Modulinos + +Regardless of whether you connect the first Modulino via QWIIC or through the solderable pins, you can still take advantage of the extra QWIIC connector to daisy-chain additional modules. + +Each Modulino includes two QWIIC connectors wired in parallel, allowing you to connect one module to the next in a chain. As long as each module is configured with a unique I²C address, they can all communicate on the same bus as long as you select the correct I²C pins depending on your board. + +This approach keeps your setup clean, modular, and expandable without adding extra wiring complexity. + +![Modulino Wiring Options](assets/connection-guide-buzzer-qwiic-chain.png) +***The number of modules you can connect will depend on what modules you are chaining together, as this system allows for multiple sensors from different manufacturers to be added. Also, the cables you use for these connections will play a significant role in the setup’s performance. Ensure your cables are properly connected and capable of handling the required data transfer. +Each module should have a unique address on a chain if you plan to address them individually. Later in this article we teach how to [change the address](#how-to-change-i2c-address). Multiple modules with the same address will cause conflicts on the I²C bus and will not allow you to address them individually.*** + +# How To Use Your Modulino +To program your Modulino it is recommended you use the official ```Modulino``` micropython library available [here](https://github.com/arduino/arduino-modulino-mpy). The library is fully compatible with the no **Arduino Lab for MicroPython**. +For information on installing the **Arduino Lab for MicroPython** please visit our [page](https://docs.arduino.cc/micropython/first-steps/install-guide/). + +## Installing The Modulino Library +The ```Modulino``` library is not available by default on MicroPython devices hence installation is needed. +To simplify the process the [MicroPython Package Installer](https://github.com/arduino/lab-micropython-package-installer/releases) is recommended as it will provide a graphical interface to guide installation. +After installation, you should now be able to: + +1. Open the tool. +2. Plug in your board to the computer. +![USB Connection](assets/mp-usb-connection.png) + +If the board does not appear in the Detected Boards section, click Reload. If the board is still undetected, ensure no other programs (e.g., a code editor) are using the board's COM port. + +4. Search for the ```Modulino``` package by filling in the text box on the search feature. +5. Click Install and wait for the installation confirmation. +6. Disconnect the board from the tool before returning to your code editor to avoid conflicts due to a busy COM port. + +![Package Installer Overview](assets/package-installer-overview.png) + +The module should now be includable in your program using: +```from modulino import ModulinoBuzzer``` + +## Play a Simple Tune with MicroPython + +Playing a sound from the **Modulino Buzzer** module is easy using the `Modulino` library. The crucial function to generate a tone is: +- `tone(frequency, duration, blocking)` - Generates a tone with the specified frequency (in Hz) and duration (in milliseconds). +- By default the Modulino library uses ```Wire1``` if your board model has a different pinout for the dedicated I²C pins you might have to edit it as instructed [here](https://github.com/arduino/arduino-modulino-mpy/tree/main/docs#%E2%84%B9%EF%B8%8F-using-3rd-party-boards). More information on **Wire** can be found [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/). + +Here’s a basic example to control the buzzer: + +```python +from modulino import ModulinoBuzzer +from time import sleep + +buzzer = ModulinoBuzzer() + +frequency = 440 # Frequency of the tone in Hz +duration = 1000 # Duration of the tone in milliseconds + +# Play the tone +buzzer.tone(frequency, duration, blocking=True) +sleep(1) # Wait for 1 second + +# Stop the tone +buzzer.tone(0, duration, blocking=True) +sleep(1) # Wait for 1 second +``` + +## How To Change Address + +A sketch is also available included with the library named `AddressChanger` and also available [here](https://github.com/arduino/arduino-modulino-mpy/blob/main/examples/change_address.py). This sketch changes the I2C address at a software level on the Module's microcontroller. + +- Connect the module to your board via I2C, ensuring no other modules are in the chain. +- Run the script in a MicroPython environment. +- Follow the on-screen instructions (REPL) to select the device and enter a new address. Valid I²C addresses range from 0x08 to 0x77 (7-bit values in hexadecimal format, e.g., 0x42). +- The script will attempt to change the address and confirm success. + +To keep track of the address in use, the module has a white rectangle on the back. Feel free to use this to write the address that was chosen. + +When using a custom address in your MicroPython sketch, you'll need to specify this address when creating the module object. For example: +```python +buzzer_module = ModulinoBuzzer(address=0x45) # Replace 0x45 with your specific address +``` + + +# Troubleshooting + +## Buzzer Not Sounding +If your Modulino's power LED isn't on or the buzzer isn't responsive, first check that the board is properly connected: +- Ensure both the board and the Modulino are connected to your computer, and that the power LEDs on both are lit. +- If the issue persists, make sure the Qwiic cable is properly clicked into place. + +## Library Not Installed Properly +If you encounter an issue with the `from modulino import ModulinoBuzzer"` command, verify that the Modulino library is correctly installed: +- Check if the library is installed and up-to-date. +- Re-install the library through the Library Manager. + +## Distorted Sound +If the buzzer sound is distorted or not playing as expected, make sure: +- The correct frequency values are being used (typically between 20 Hz and 20 kHz for audible sounds). +- All exposed electronics are not touching any conductive surfaces, as this could interfere with the sound output. + +# Conclusion + +The **Modulino Buzzer** is a digital sound output device that communicates over I²C and follows the Modulino form factor. It includes standard Qwiic connectors for quick, solderless connections and easy daisy-chaining with other modules. Paired with the Modulino library, it makes generating sound feedback straightforward, allowing you to focus on experimenting or building your system logic. It's a small, reliable module suited for both interactive feedback and audio alert systems. + +# What Is Next? + +Now that you've learned how to use your Modulino Buzzer, you're all set to integrate it into your projects! +- Experiment with different frequencies to create various tones and melodies. +- Try creating a simple alarm system that triggers the buzzer when certain conditions are met. +- Use the buzzer to provide feedback in your interactive projects when a button is pressed or a threshold is reached. +- Create a music box that plays different tunes when specific inputs are detected! + diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/datasheet/assets/BlockDiagramDistance.png b/content/hardware/11.accessories/modulinos/modulino-distance/datasheet/assets/BlockDiagramDistance.png new file mode 100644 index 0000000000..440ea9e874 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/datasheet/assets/BlockDiagramDistance.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/datasheet/assets/DistanceMec.png b/content/hardware/11.accessories/modulinos/modulino-distance/datasheet/assets/DistanceMec.png new file mode 100644 index 0000000000..c07224a9ba Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/datasheet/assets/DistanceMec.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/datasheet/assets/DistancePinouts.png b/content/hardware/11.accessories/modulinos/modulino-distance/datasheet/assets/DistancePinouts.png new file mode 100644 index 0000000000..9c82b4b68f Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/datasheet/assets/DistancePinouts.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/datasheet/assets/Modulino_Distance_Power_Tree.png b/content/hardware/11.accessories/modulinos/modulino-distance/datasheet/assets/Modulino_Distance_Power_Tree.png new file mode 100644 index 0000000000..64b9ae3a3c Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/datasheet/assets/Modulino_Distance_Power_Tree.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/datasheet/assets/featuredDist.png b/content/hardware/11.accessories/modulinos/modulino-distance/datasheet/assets/featuredDist.png new file mode 100644 index 0000000000..cccb00c431 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/datasheet/assets/featuredDist.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/datasheet/datasheet.md b/content/hardware/11.accessories/modulinos/modulino-distance/datasheet/datasheet.md new file mode 100644 index 0000000000..6f7234326b --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-distance/datasheet/datasheet.md @@ -0,0 +1,241 @@ +--- +identifier: ABX00102 +title: Arduino® Modulino® Distance +type: maker +author: Pedro Sousa Lima +--- + +![](assets/featuredDist.png) + +# Description +The Modulino® Distance, featuring the **VL53L4CDV0DH/1** time-of-flight sensor, provides accurate distance measurements in a compact, easy-to-use form factor. Ideal for proximity detection, obstacle avoidance, and various smart sensing applications. + +# Target Areas +Maker, beginner, education + +# Contents + +## Application Examples +- **Robotics Navigation** + Detect objects or obstacles up to about 1200 mm away, enabling mobile robots to sense and avoid collisions. + +- **Proximity Sensing** + Trigger actions when an object is within a user-defined range, such as auto-locking doors or touchless controls. + +- **Smart Home Devices** + Monitor open/close states of containers or doors, measure fluid levels, or create interactive installations. + +
+ +## Features +- Uses the **VL53L4CDV0DH/1** sensor for precise **time-of-flight** distance measurements (0–1200 mm). +- **I2C (Qwiic)** interface for solder-free integration; operates at **3.3 V**. +- **Additional GPIO1** pin for interrupt signaling, **XSHUT** pin for power saving or reset. +- Ideal for **proximity detection**, **collision avoidance**, and general distance measuring tasks. + +### Contents +| **SKU** | **Name** | **Purpose** | **Quantity** | +| ---------- | ------------------- | --------------------------------------------- | ------------ | +| ABX00102 | Modulino® Distance | Time-of-flight distance sensing | 1 | +| | I2C Qwiic cable | Compatible with the Qwiic standard | 1 | + + +## Related Products +- *SKU: ASX00027* – [Arduino® Sensor Kit](https://store.arduino.cc/products/arduino-sensor-kit) +- *SKU: K000007* – [Arduino® Starter Kit](https://store.arduino.cc/products/arduino-starter-kit-multi-language) +- *SKU: AKX00026* – [Arduino® Oplà IoT Kit](https://store.arduino.cc/products/opla-iot-kit) + +## Rating + +### Recommended Operating Conditions +- **Sensor supply range:** 2.6 V – 3.5 V +- **Powered at 3.3 V** through the Qwiic interface (in accordance with the Qwiic standard) +- **Operating temperature:** –40 °C to +85 °C + +**Typical current consumption:** +- ~40 mA peak (active ranging) +- ~24 mA during active measurement, ~4 mA I2C idle + +## Power Tree +The power tree for the modulino can be consulted below: + +![Modulino® Distance Power Tree](assets/Modulino_Distance_Power_Tree.png) + +## Block Diagram +This module is designed to be placed on an I2C bus, allowing the on-board VL53L4CDV0DH/1 sensor to communicate with a host microcontroller via I2C. + +![Modulino® Distance block diagram](assets/BlockDiagramDistance.png) + +## Functional Overview +The Modulino® Distance node uses a **time-of-flight** measuring principle to detect objects from 0 to ~1200 mm. It communicates via I2C (through the Qwiic connector at 3.3 V). **GPIO1** can signal an interrupt when a threshold is reached or measurement is ready, while **XSHUT** can place the sensor in shutdown mode to save power. + +### Technical Specifications +| **Specification** | **Details** | +| ----------------------- | ------------------------------------------------ | +| **Sensor** | VL53L4CDV0DH/1 | +| **Supply Voltage** | Min: 2.6 V, Max: 3.5 V | +| **Power Consumption** | ~24 mA active, 4 mA idle, 40 mA peak | +| **Range** | 0–1200 mm | +| **Accuracy** | ±7 mm to ±3% | +| **Resolution** | 1 mm | +| **Communication** | I2C | + +### Pinout + +**Qwiic / I2C (1×4 Header)** +| **Pin** | **Function** | +| ------- | ----------------------- | +| GND | Ground | +| 3.3 V | Power Supply (3.3 V) | +| SDA | I2C Data | +| SCL | I2C Clock | + +These pads and the Qwiic connectors share the same I2C bus. You can optionally solder header pins here. + +**Additional 1×4 Header (Distance Sensor Signals)** +| **Pin** | **Function** | +| ------- | ------------------------------------ | +| GPIO1 | Interrupt output (open-drain) | +| XSHUT | Active-low shutdown input | + +**Note:** On-board 10 kΩ pull-ups to 3.3 V exist for GPIO1 and XSHUT. + +![Pinout Overview](assets/DistancePinouts.png) + +### Power Specifications +- **Nominal operating voltage:** 3.3 V via Qwiic +- **Sensor voltage range:** 2.6 V–3.5 V + +### Mechanical Information +![Modulino® Distance Mechanical Information](assets/DistanceMec.png) + +- Board dimensions: 41 mm × 25.36 mm +- Thickness: 1.6 mm (±0.2 mm) +- Four mounting holes (Ø 3.2 mm) + - Hole spacing: 16 mm vertically, 32 mm horizontally + +### I2C Address Reference +| **Board Silk Name** | **Sensor** | **Modulino I2C Address (HEX)** | **Editable Addresses (HEX)** | **Hardware I2C Address (HEX)** | +|---------------------|------------------|--------------------------------|-------------------------------------------|--------------------------------| +| MODULINO DISTANCE | VL53L4CDV0DH/1 | 0x29 | Any custom address (via software config.) | 0x29 | + +**Note:** The default address is **0x29**. Multiple units of the same sensor may require address reconfiguration in software to avoid collisions. + +## Device Operation +The Modulino® Distance node operates as an I2C target device on the Qwiic bus. A host microcontroller can read distance values, set thresholds, or configure measurement timing. If using multiple distance sensors, you may need to set unique addresses or toggle XSHUT lines. + +### Getting Started +Use any standard Arduino or microcontroller environment at 3.3 V. Library support for the VL53 series sensors can simplify reading distance measurements. Ensure the sensor’s field of view is unobstructed for accurate results. + +# Certifications + +## Certifications Summary + +| **Certification** | **Status** | +|:-----------------:|:----------:| +| CE/RED (Europe) | Yes | +| UKCA (UK) | Yes | +| FCC (USA) | Yes | +| IC (Canada) | Yes | +| RoHS | Yes | +| REACH | Yes | +| WEEE | Yes | + +## Declaration of Conformity CE DoC (EU) + +

We declare under our sole responsibility that the products above are in conformity with the essential requirements of the following EU Directives and therefore qualify for free movement within markets comprising the European Union (EU) and European Economic Area (EEA).

+ +## Declaration of Conformity to EU RoHS & REACH 211 01/19/2021 + +

Arduino boards are in compliance with RoHS 2 Directive 2011/65/EU of the European Parliament and RoHS 3 Directive 2015/863/EU of the Council of 4 June 2015 on the restriction of the use of certain hazardous substances in electrical and electronic equipment.

+ +| Substance | **Maximum limit (ppm)** | +|----------------------------------------|-------------------------| +| Lead (Pb) | 1000 | +| Cadmium (Cd) | 100 | +| Mercury (Hg) | 1000 | +| Hexavalent Chromium (Cr6+) | 1000 | +| Poly Brominated Biphenyls (PBB) | 1000 | +| Poly Brominated Diphenyl ethers (PBDE) | 1000 | +| Bis(2-Ethylhexyl) phthalate (DEHP) | 1000 | +| Benzyl butyl phthalate (BBP) | 1000 | +| Dibutyl phthalate (DBP) | 1000 | +| Diisobutyl phthalate (DIBP) | 1000 | + +Exemptions: No exemptions are claimed. + +

Arduino Boards are fully compliant with the related requirements of European Union Regulation (EC) 1907 /2006 concerning the Registration, Evaluation, Authorization and Restriction of Chemicals (REACH). We declare none of the SVHCs (https://echa.europa.eu/web/guest/candidate-list-table), the Candidate List of Substances of Very High Concern for authorization currently released by ECHA, is present in all products (and also package) in quantities totaling in a concentration equal or above 0.1%. To the best of our knowledge, we also declare that our products do not contain any of the substances listed on the "Authorization List" (Annex XIV of the REACH regulations) and Substances of Very High Concern (SVHC) in any significant amounts as specified by the Annex XVII of Candidate list published by ECHA (European Chemical Agency) 1907 /2006/EC.

+ +## Conflict Minerals Declaration + +

As a global supplier of electronic and electrical components, Arduino is aware of our obligations with regard to laws and regulations regarding Conflict Minerals, specifically the Dodd-Frank Wall Street Reform and Consumer Protection Act, Section 1502. Arduino does not directly source or process conflict minerals such as Tin, Tantalum, Tungsten, or Gold. Conflict minerals are contained in our products in the form of solder or as a component in metal alloys. As part of our reasonable due diligence, Arduino has contacted component suppliers within our supply chain to verify their continued compliance with the regulations. Based on the information received thus far we declare that our products contain Conflict Minerals sourced from conflict-free areas.

+ +## FCC Caution + +Any Changes or modifications not expressly approved by the party responsible for compliance could void the user’s authority to operate the equipment. + +This device complies with part 15 of the FCC Rules. Operation is subject to the following two conditions: + +1. This device may not cause harmful interference. +2. This device must accept any interference received, including interference that may cause undesired operation. + +**FCC RF Radiation Exposure Statement:** + +1. This Transmitter must not be co-located or operating in conjunction with any other antenna or transmitter. +2. This equipment complies with RF radiation exposure limits set forth for an uncontrolled environment. +3. This equipment should be installed and operated with a minimum distance of 20 cm between the radiator & your body. + +**Note:** This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures: + +- Reorient or relocate the receiving antenna. +- Increase the separation between the equipment and receiver. +- Connect the equipment into an outlet on a circuit different from that to which the receiver is connected. +- Consult the dealer or an experienced radio/TV technician for help. + +English: +User manuals for license-exempt radio apparatus shall contain the following or equivalent notice in a conspicuous location in the user manual or alternatively on the device or both. This device complies with Industry Canada license-exempt RSS standard(s). Operation is subject to the following two conditions: + +1. this device may not cause interference. +2. this device must accept any interference, including interference that may cause undesired operation of the device. + +French: +Le présent appareil est conforme aux CNR d’Industrie Canada applicables aux appareils radio exempts de licence. L’exploitation est autorisée aux deux conditions suivantes: + +1. l’appareil nedoit pas produire de brouillage. +2. l’utilisateur de l’appareil doit accepter tout brouillage radioélectrique subi, même si le brouillage est susceptible d’en compromettre le fonctionnement. + +**IC SAR Warning:** + +English: +This equipment should be installed and operated with a minimum distance of 20 cm between the radiator and your body. + +French: +Lors de l’installation et de l’exploitation de ce dispositif, la distance entre le radiateur et le corps est d’au moins 20 cm. + +**Important:** The operating temperature of the EUT can’t exceed 85 ℃ and shouldn’t be lower than -40 ℃. + +Hereby, Arduino S.r.l. declares that this product is in compliance with essential requirements and other relevant provisions of Directive 2014/53/EU. This product is allowed to be used in all EU member states. + +# Company Information + +| Company name | Arduino SRL | +|-----------------|-----------------------------------------------| +| Company Address | Via Andrea Appiani, 25 - 20900 MONZA（Italy) | + +# Reference Documentation + +| Ref | Link | +| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Arduino IDE (Desktop) | [https://www.arduino.cc/en/Main/Software](https://www.arduino.cc/en/Main/Software) | +| Arduino Courses | [https://www.arduino.cc/education/courses](https://www.arduino.cc/education/courses) | +| Arduino Documentation | [https://docs.arduino.cc/](https://docs.arduino.cc/) | +| Arduino IDE (Cloud) | [https://create.arduino.cc/editor](https://create.arduino.cc/editor) | +| Cloud IDE Getting Started | [https://docs.arduino.cc/cloud/web-editor/tutorials/getting-started/getting-started-web-editor](https://docs.arduino.cc/cloud/web-editor/tutorials/getting-started/getting-started-web-editor) | +| Project Hub | [https://projecthub.arduino.cc/](https://projecthub.arduino.cc/) | +| Library Reference | [https://github.com/arduino-libraries/](https://github.com/arduino-libraries/) | +| Online Store | [https://store.arduino.cc/](https://store.arduino.cc/) | + +# Revision History +| **Date** | **Revision** | **Changes** | +|------------ |------------ |------------------------------------------------| +| 11/07/2024 | 1 | First release | diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/essentials.md b/content/hardware/11.accessories/modulinos/modulino-distance/essentials.md new file mode 100644 index 0000000000..762e36d575 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-distance/essentials.md @@ -0,0 +1,8 @@ + + + + +This library allows you to communicate with the Arduino Modulino® nodes. + + + diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/features.md b/content/hardware/11.accessories/modulinos/modulino-distance/features.md new file mode 100644 index 0000000000..3ee4062c4f --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-distance/features.md @@ -0,0 +1,12 @@ + +The Modulino® Distance module provides accurate distance measurements using time-of-flight technology. It is compatible with the Arduino UNO R4 WiFi or any board with a Qwiic interface, allowing you to create proximity and ranging applications without complex wiring. + + + + + This module includes step-by-step guides for projects that use the Modulino® nodes, helping newcomers build applications that involve measuring and reacting to distances. + + + The Modulino® Distance module connects using Qwiic cables to your UNO R4 WiFi or other compatible boards. Additionally, solderable pins are provided for direct wiring if a Qwiic connector isn’t available. + + diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/image.svg b/content/hardware/11.accessories/modulinos/modulino-distance/image.svg new file mode 100644 index 0000000000..f2243615fe --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-distance/image.svg @@ -0,0 +1,616 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/product.md b/content/hardware/11.accessories/modulinos/modulino-distance/product.md new file mode 100644 index 0000000000..01e83a6c85 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-distance/product.md @@ -0,0 +1,11 @@ +--- +title: Modulino® Distance +url_shop: https://store.arduino.cc/products/modulino-distance +url_guide: https://courses.arduino.cc/plugandmake +primary_button_url: https://courses.arduino.cc/plugandmake +primary_button_title: Get Started +certifications: [] +sku: [ABX00102] +--- + +Precise time-of-flight distance sensing in a compact form factor (VL53L4CDV0DH/1). Ideal for proximity detection, robotics, or smart-home triggers. Easily connect to the Arduino UNO R4 WiFi or any board with a Qwiic interface, or use the solderable pins for a custom wiring solution. diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tech-specs.md b/content/hardware/11.accessories/modulinos/modulino-distance/tech-specs.md new file mode 100644 index 0000000000..6c1b4b6240 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-distance/tech-specs.md @@ -0,0 +1 @@ +Here you will find the technical specifications for the Modulino® Distance. \ No newline at end of file diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tech-specs.yml b/content/hardware/11.accessories/modulinos/modulino-distance/tech-specs.yml new file mode 100644 index 0000000000..d260ab217f --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-distance/tech-specs.yml @@ -0,0 +1,11 @@ +Node: + Name: Modulino Distance + SKU: ABX00102 + Board recommended: Arduino® UNO R4 WiFi (ABX00087) + Communications: I2C (over Qwiic connector or solderable pin) + Operational voltage: 3.3V + Sensor: + VL53L4CDV0DH/1: 0x29 + +Other accessories: + Qwiic cables: 1x diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/DistancePinouts.png b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/DistancePinouts.png new file mode 100644 index 0000000000..f657054092 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/DistancePinouts.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/IDE-Left-Tab.png b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/IDE-Left-Tab.png new file mode 100644 index 0000000000..c7bb86575e Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/IDE-Left-Tab.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/Modulino_Distance_Power_Tree.png b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/Modulino_Distance_Power_Tree.png new file mode 100644 index 0000000000..64b9ae3a3c Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/Modulino_Distance_Power_Tree.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/connection-guide-distance-jumper.png b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/connection-guide-distance-jumper.png new file mode 100644 index 0000000000..df073cc73b Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/connection-guide-distance-jumper.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/connection-guide-distance-qwiic-chain.png b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/connection-guide-distance-qwiic-chain.png new file mode 100644 index 0000000000..9399b6deb1 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/connection-guide-distance-qwiic-chain.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/connection-guide-distance-qwiik.png b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/connection-guide-distance-qwiik.png new file mode 100644 index 0000000000..37768f52e8 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/connection-guide-distance-qwiik.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/connection-guide-distance.png b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/connection-guide-distance.png new file mode 100644 index 0000000000..e011bec29e Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/connection-guide-distance.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/library-install.gif b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/library-install.gif new file mode 100644 index 0000000000..16f396c353 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/library-install.gif differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/schematic.png b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/schematic.png new file mode 100644 index 0000000000..20dd38803b Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/assets/schematic.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/content.md b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/content.md new file mode 100644 index 0000000000..04d0fccfdf --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/content.md @@ -0,0 +1,194 @@ +--- +title: "How To Use The Modulino Distance" +description: "Learn how to get the most out of your Modulino Distance." +tags: + - Modulino + - QWIIC + - I2C +author: 'Pedro Sousa Lima' +hardware: + - hardware/11.modulinos/modulinos/modulino-distance +software: + - ide-v2 + - web-editor +--- +The Modulino Distance is a modular sensor that measures distance using Time-of-Flight (ToF) technology, making it perfect to add precise distance sensing and depth mapping to your projects! +The Modulino form factor is shaped with two QWIIC connectors and the I²C protocol integration, allowing the connection and programming of multiple modulinos in a very simple way. In addition to the QWIIC's connectors, the Modulinos also expose solderable pins that can be used in multiple ways and make them compatible with boards that are not QWIIC compatible. + +# General Characteristics + +The Modulino Distance is capable of measuring distances using Time-of-Flight technology. Take a look at the following table to know more about its measuring ranges: + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|-----------------------|----------------------|---------|---------|---------|------| +| Range | Distance Measurement | 1 | - | 1300 | mm | +| Resolution | - | - | 1 | - | mm | +| Operating Temperature | - | -30 | - | 85 | °C | + + +## Sensor Details + +The VL53L5CX sensor from STMicroelectronics is the core component of this module. This ToF sensor natively supports digital communication (I²C), meaning it connects directly to the I²C bus on the module without requiring additional conversion circuitry. + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|---------------|---------------|---------|---------|---------|------| +| Field of View | - | - | 18 | - | ° | +| Sampling Rate | - | - | 100 | - | Hz | +| Wavelength | Laser Emitter | - | 940 | - | nm | + +The default address for the Module is: + +| Modulino I²C Address | Hardware I²C Address | +|----------------------|----------------------| +| 0x52 | 0x52 | + +***Note: Since the address cannot be changed on this Modulino specifically, using two or more identical modules on the same I²C bus will result in address conflicts and cause communication issues.*** + +## Pinout + +The pinout for the Modulino Distance is shown below. Please note that the exposed solderable pins are directly connected to the QWIIC connectors using the same I²C interface. + +![Arduino Distance Pinout](assets/DistancePinouts.png) + +Depending on the board connected to the modulino, the I²C pin names to program it may differ. Please check the [board tutorials](https://docs.arduino.cc/hardware/) on your modulino's compatible board or the [Modulino library](https://github.com/arduino-libraries/Modulino/tree/main/docs) to learn more. + +## Power Specifications + +The board is typically powered by +3.3 VDC when using the QWIIC interface as per the I²C standard. + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|-----------------------|-------------------------|---------|-------------|---------|------| +| Supply Voltage | - | 2.6 | 3.3 (QWIIC) | 3.5 | V | +| Current Consumption | Active measurement mode | - | 18 | 21 | mA | +| Current Consumption | Standby mode | - | 2 | 5 | µA | +| Current Consumption | Power-down mode | - | 0.5 | 1 | µA | +| Operating Temperature | - | -30 | - | 85 | °C | + +The module includes a power LED that draws 1 mA and turns on as soon as it is powered. J1 (Qwiic connector), J2 (Qwiic connector), and the headers all share the same power branch. The power distribution of the module is therefore as follows: + +![Power Tree Modulino Distance](assets/Modulino_Distance_Power_Tree.png) + +## Schematic + +The Modulino Distance uses a simple circuit, as shown in the schematic below: + +![Full Schematic Modulino Distance](assets/schematic.png) + +The main component is the **VL53L5CX** sensor (U1), which handles distance measurements using Time-of-Flight technology, as well as I²C communication. + +You can connect to the I²C pins (SDA and SCL) using either the **QWIIC connectors** (J1 and J2, this is the recommended method) or the **solderable pins** (J4). The board runs on **3.3V**, which comes from the QWIIC cable or the **3V3 pin** on J4. + +There's also a small power indicator LED that lights up when the board is on. + +You can grab the full schematic and PCB files from the [Modulino Distance](https://docs.arduino.cc/hardware/modulinos/modulino-distance) product page. + +## How To Connect Your Modulino + +The easiest and most reliable way to connect your Modulino is through the QWIIC Connect System. It’s plug-and-play, uses standard I²C, and makes it easy to join multiple modules. If your board supports QWIIC, this is the recommended way to go. +Note that the dedicated I²C pins will differ from board to board meaning it is always a good idea to check your specific model. + + +![Modulino Wiring Options QWIIC(A - recommended) and Header(B)](assets/connection-guide-distance.png) + +## QWIIC Connector + +Whenever available, the **QWIIC Connect System** is the preferred method. Connecting to the Modulino is extremely simple, just use a standard QWIIC cable to connect your board to either of the QWIIC connectors on the Modulino. Because the cable and connectors are polarized, there is no need to worry about accidentally swapping connections. + +QWIIC is a plug-and-play I²C Connect System that uses standardized 4-pin connectors: +- GND +- 3.3V +- SDA (Data) +- SCL (Clock) + +![Connection Guide QWIIC](assets/connection-guide-distance-qwiik.png) + +The Modulino features two QWIIC connectors, which are internally connected in parallel. This means you can daisy-chain multiple modules easily by connecting additional QWIIC cables between them. + +## Solderable Header + +When QWIIC is not available, you can use the exposed solderable pins on the module. You can solder pins to the unpopulated pads; just remember the pinout provided in this guide to connect to the right pins of your board. + +![Connection Guide Solder Pads](assets/connection-guide-distance-jumper.png) + +## Daisy-Chaining Multiple Modulinos + +Regardless of whether you connect the first Modulino via QWIIC or through the solderable pins, you can still take advantage of the extra QWIIC connector to daisy-chain additional modules. Each Modulino includes two QWIIC connectors wired in parallel, allowing you to connect one module to the next in a chain. As long as each module is configured with a unique I²C address, they can all communicate on the same bus. This approach keeps your setup clean, modular, and expandable without adding extra wiring complexity. + +![Modulino Wiring Options](assets/connection-guide-distance-qwiic-chain.png) + +***The number of modules you can connect will depend on what modules you are chaining together, as this system allows for multiple sensors from different manufacturers to be added. Also, the cables you use for these connections will play a significant role in the setup's performance. Ensure your cables are correctly connected and capable of handling the required data transfer. + +Each module should have a unique address on a chain if you plan to address them individually. Multiple modules with the same address will cause conflicts on the I²C bus.*** + +# How To Use Your Modulino + +## Installing The Modulino Library +You need the official Modulino library available [here](https://docs.arduino.cc/libraries/modulino/) to use the Modulino Thermo. + +With the Arduino IDE you get some tools that make adding a library easier. To learn how to install the IDE please visit our [page](https://docs.arduino.cc/software/ide-v2/tutorials/getting-started/ide-v2-downloading-and-installing/). +After opening the IDE, a tab should be visible on the left. Press the book icon for "library" as highlighted in the image. +![IDE Library Tab](assets/IDE-Left-Tab.png) +The process should look like this: +![Library Install](assets/library-install.gif) +A message will appear after the installation is successful. + +## Getting Distance Data + +Getting data from the sensor is fairly simple using the ```Modulino``` library. For the **Modulino Distance** there are two important functions: +- ```available()```: Checks if new distance data is available. +- ```get()```: Retrieves the measured distance from the sensor (default in cm). +- ```Modulino.begin();```: By default the Modulino library uses ```Wire1``` if your connection is in a different Wire you will have to edit it, check [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/) (by default the Modulino library uses ```Wire1``` if your board model has a different pinout for the dedicated I²C pins you might have to edit it. More information on **Wire** can be found [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/)) for the library's hardware compatibility. More information on **Wire** can be found [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/). + +Here is an example sketch of how to implement these functions to acquire data and show it using the serial monitor: + +```arduino +#include "Arduino_Modulino.h" + +// Create object instance +ModulinoDistance distance; + +void setup() { + Serial.begin(9600); + + // Initialize the Modulino system and distance sensor + Modulino.begin(); + distance.begin(); +} + +void loop() { + if (distance.available()) { + int measure = distance.get(); + Serial.println(measure); + } + delay(10); +} +``` + +## Troubleshooting + +### Sensor Not Reachable +If your Modulino's power LED isn't on or the sensor isn't responsive, first check that the board is properly connected: +- Ensure both the board and the Modulino are connected to your computer, and that the power LEDs on both are lit. +- If the issue persists, make sure the Qwiic cable is properly clicked into place. + +### Library Not Installed Properly +If you encounter an issue with the `#include "modulino.h"` command, verify that the Modulino library is correctly installed: +- Check your IDE to ensure the library is installed and up-to-date. +- Re-install the library through the Library Manager. + +### Inaccurate Values +If the sensor values are not accurate, make sure: +- The sensor lens is clean and free from dust or obstructions. +- All exposed electronics are not touching any conductive surfaces, as this could interfere with readings. +- The object being measured is within the sensor's detection range. + +# What Is Next? + +Now that you've learned how to use your Modulino Distance, you're all set to integrate it into your projects! +- Create a parking assistance system that provides audio feedback as objects get closer, similar to car parking sensors. +- Build a theremin-like musical instrument that changes pitch or volume based on hand movements in front of the sensor. +- Design an automatic dispenser that activates when hands are detected beneath it (for soap, sanitizer, etc.). + +# Conclusion + +The **Modulino Distance** is a digital Time-of-Flight distance sensor that communicates over I²C and follows the Modulino form factor. It includes standard Qwiic connectors for quick, solderless connections and easy daisy-chaining with other modules. Paired with the Modulino library, it makes accessing distance data straightforward, allowing you to focus on experimenting or building your system logic. It's a small, reliable module suited for both quick tests and longer-term setups. \ No newline at end of file diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/image.png b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/image.png new file mode 100644 index 0000000000..bceefec75d Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-ardu/image.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/DistancePinouts.png b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/DistancePinouts.png new file mode 100644 index 0000000000..f657054092 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/DistancePinouts.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/Modulino_Distance_Power_Tree.png b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/Modulino_Distance_Power_Tree.png new file mode 100644 index 0000000000..64b9ae3a3c Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/Modulino_Distance_Power_Tree.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/connection-guide-distance-jumper.png b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/connection-guide-distance-jumper.png new file mode 100644 index 0000000000..df073cc73b Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/connection-guide-distance-jumper.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/connection-guide-distance-qwiic-chain.png b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/connection-guide-distance-qwiic-chain.png new file mode 100644 index 0000000000..9399b6deb1 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/connection-guide-distance-qwiic-chain.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/connection-guide-distance-qwiik.png b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/connection-guide-distance-qwiik.png new file mode 100644 index 0000000000..21e4b96ff0 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/connection-guide-distance-qwiik.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/connection-guide-distance.png b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/connection-guide-distance.png new file mode 100644 index 0000000000..e011bec29e Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/connection-guide-distance.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/mp-usb-connection.png b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/mp-usb-connection.png new file mode 100644 index 0000000000..fb059f9e8b Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/mp-usb-connection.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/package-installer-overview.png b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/package-installer-overview.png new file mode 100644 index 0000000000..67678dc808 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/package-installer-overview.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/schematic.png b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/schematic.png new file mode 100644 index 0000000000..20dd38803b Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/assets/schematic.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/content.md b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/content.md new file mode 100644 index 0000000000..501b0bd15c --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/content.md @@ -0,0 +1,194 @@ +--- +title: "How To Use The Modulino Distance And MicroPython" +description: "Learn how to get the most out of your Modulino Distance in a MicroPython environment." +tags: + - Modulino + - QWIIC + - I2C +author: 'Pedro Sousa Lima' +hardware: + - hardware/11.modulinos/modulinos/modulino-distance +software: + - ide-v2 + - web-editor +--- +The Modulino Distance is a modular sensor that measures distance using Time-of-Flight (ToF) technology, making it perfect to add precise distance sensing and depth mapping to your projects! +The Modulino form factor is shaped with two QWIIC connectors and the I²C protocol integration, allowing the connection and programming of multiple modulinos in a very simple way. In addition to the QWIIC's connectors, the Modulinos also expose solderable pins that can be used in multiple ways and make them compatible with boards that are not QWIIC compatible. + +# General Characteristics + +The Modulino Distance is capable of measuring distances using Time-of-Flight technology. Take a look at the following table to know more about its measuring ranges: + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|-----------------------|----------------------|---------|---------|---------|------| +| Range | Distance Measurement | 1 | - | 1300 | mm | +| Resolution | - | - | 1 | - | mm | +| Operating Temperature | - | -30 | - | 85 | °C | + + +## Sensor Details + +The VL53L5CX sensor from STMicroelectronics is the core component of this module. This ToF sensor natively supports digital communication (I²C), meaning it connects directly to the I²C bus on the module without requiring additional conversion circuitry. + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|---------------|---------------|---------|---------|---------|------| +| Field of View | - | - | 18 | - | ° | +| Sampling Rate | - | - | 100 | - | Hz | +| Wavelength | Laser Emitter | - | 940 | - | nm | + +The default address for the Module is: + +| Modulino I²C Address | Hardware I²C Address | +|----------------------|----------------------| +| 0x52 | 0x52 | + +***Note: Since the address cannot be changed on this Modulino specifically, using two or more identical modules on the same I²C bus will result in address conflicts and cause communication issues.*** + +## Pinout + +The pinout for the Modulino Distance is shown below. Please note that the exposed solderable pins are directly connected to the QWIIC connectors using the same I²C interface. + +![Arduino Distance Pinout](assets/DistancePinouts.png) + +Depending on the board connected to the modulino, the I²C pin names to program it may differ. Please check the [board tutorials](https://docs.arduino.cc/hardware/) on your modulino's compatible board or the [Modulino library](https://github.com/arduino-libraries/Modulino/tree/main/docs) to learn more. + +## Power Specifications + +The board is typically powered by +3.3 VDC when using the QWIIC interface as per the I²C standard. + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|-----------------------|-------------------------|---------|-------------|---------|------| +| Supply Voltage | - | 2.6 | 3.3 (QWIIC) | 3.5 | V | +| Current Consumption | Active measurement mode | - | 18 | 21 | mA | +| Current Consumption | Standby mode | - | 2 | 5 | µA | +| Current Consumption | Power-down mode | - | 0.5 | 1 | µA | +| Operating Temperature | - | -30 | - | 85 | °C | + +The module includes a power LED that draws 1 mA and turns on as soon as it is powered. J1 (Qwiic connector), J2 (Qwiic connector), and the headers all share the same power branch. The power distribution of the module is therefore as follows: + +![Power Tree Modulino Distance](assets/Modulino_Distance_Power_Tree.png) + +## Schematic + +The Modulino Distance uses a simple circuit, as shown in the schematic below: + +![Full Schematic Modulino Distance](assets/schematic.png) + +The main component is the **VL53L5CX** sensor (U1), which handles distance measurements using Time-of-Flight technology, as well as I²C communication. + +You can connect to the I²C pins (SDA and SCL) using either the **QWIIC connectors** (J1 and J2, this is the recommended method) or the **solderable pins** (J4). The board runs on **3.3V**, which comes from the QWIIC cable or the **3V3 pin** on J4. + +There's also a small power indicator LED that lights up when the board is on. + +You can grab the full schematic and PCB files from the [Modulino Distance](https://docs.arduino.cc/hardware/modulinos/modulino-distance) product page. + +## How To Connect Your Modulino + +The easiest and most reliable way to connect your Modulino is through the QWIIC Connect System. It’s plug-and-play, uses standard I²C, and makes it easy to join multiple modules. If your board supports QWIIC, this is the recommended way to go. +Note that the dedicated I²C pins will differ from board to board meaning it is always a good idea to check your specific model. + +![Modulino Wiring Options QWIIC(A - recommended) and Header(B)](assets/connection-guide-distance.png) + +## QWIIC Connector + +Whenever available, the **QWIIC Connect System** is the preferred method. Connecting to the Modulino is extremely simple, just use a standard QWIIC cable to connect your board to either of the QWIIC connectors on the Modulino. Because the cable and connectors are polarized, there is no need to worry about accidentally swapping connections. + +QWIIC is a plug-and-play I²C Connect System that uses standardized 4-pin connectors: +- GND +- 3.3V +- SDA (Data) +- SCL (Clock) + +![Connection Guide QWIIC](assets/connection-guide-distance-qwiik.png) + +The Modulino features two QWIIC connectors, which are internally connected in parallel. This means you can daisy-chain multiple modules easily by connecting additional QWIIC cables between them. + +## Solderable Header + +When QWIIC is not available, you can use the exposed solderable pins on the module. You can solder pins to the unpopulated pads; just remember the pinout provided in this guide to connect to the right pins of your board. + +![Connection Guide Solder Pads](assets/connection-guide-distance-jumper.png) + +## Daisy-Chaining Multiple Modulinos + +Regardless of whether you connect the first Modulino via QWIIC or through the solderable pins, you can still take advantage of the extra QWIIC connector to daisy-chain additional modules. Each Modulino includes two QWIIC connectors wired in parallel, allowing you to connect one module to the next in a chain. As long as each module is configured with a unique I²C address, they can all communicate on the same bus. This approach keeps your setup clean, modular, and expandable without adding extra wiring complexity. + +![Modulino Wiring Options](assets/connection-guide-distance-qwiic-chain.png) + +***The number of modules you can connect will depend on what modules you are chaining together, as this system allows for multiple sensors from different manufacturers to be added. Also, the cables you use for these connections will play a significant role in the setup's performance. Ensure your cables are correctly connected and capable of handling the required data transfer. + +Each module should have a unique address on a chain if you plan to address them individually. Multiple modules with the same address will cause conflicts on the I²C bus.*** +# How To Program Your Modulino + +## Installing The Modulino Library +To program your Modulino it is recommended you use the official ```Modulino``` micropython library available [here](https://github.com/arduino/arduino-modulino-mpy). The library is fully compatible with the no **Arduino Lab for MicroPython**. +For information on installing the **Arduino Lab for MicroPython** please visit our [page](https://docs.arduino.cc/micropython/first-steps/install-guide/). + +The ```Modulino``` library is not available by default on MicroPython devices hence installation is needed. +To simplify the process the [MicroPython Package Installer](https://github.com/arduino/lab-micropython-package-installer/releases) is recommended as it will provide a graphical interface to guide installation. +After installation, you should now be able to: + +1. Open the tool. +2. Plug in your board to the computer. +![USB Connection](assets/mp-usb-connection.png) + +If the board does not appear in the Detected Boards section, click Reload. If the board is still undetected, ensure no other programs (e.g., a code editor) are using the board's COM port. + +4. Search for the ```Modulino``` package by filling in the text box on the search feature. +5. Click Install and wait for the installation confirmation. +6. Disconnect the board from the tool before returning to your code editor to avoid conflicts due to a busy COM port. + +![Package Installer Overview](assets/package-installer-overview.png) + +The module should now be includable in your program using: +```from modulino import ModulinoDistance``` + +# Getting Distance Data + +Getting data from the sensor is straightforward using the ```Modulino``` library. +For the **Modulino Distance**, there is one crucial function: +- ```.distance``` - Provides the distance measurement from the sensor. (Default in cm) +- By default the Modulino library uses ```Wire1``` if your board model has a different pinout for the dedicated I²C pins you might have to edit it as instructed [here](https://github.com/arduino/arduino-modulino-mpy/tree/main/docs#%E2%84%B9%EF%B8%8F-using-3rd-party-boards). More information on **Wire** can be found [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/). +Here is an example of how to implement this function to acquire data: + +```python +from modulino import ModulinoDistance +from time import sleep_ms + +distance = ModulinoDistance() + +while True: + print(f"📏 Distance: {distance.distance} cm") + sleep_ms(50) +``` + +This simple code creates an instance of the ModulinoDistance class and continuously reads the distance values, displaying them in centimeters with a 50ms delay between readings. + +## Troubleshooting + +### Sensor Not Reachable +If your Modulino's power LED isn't on or the sensor isn't responsive, first check that the board is properly connected: +- Ensure both the board and the Modulino are connected to your computer, and that the power LEDs on both are lit. +- If the issue persists, make sure the Qwiic cable is properly clicked into place. + +### Library Not Installed Properly +If you encounter an issue with the `import ModulinoDistance` command, verify that the Modulino library is correctly installed: +- Check the package installer to ensure the library is installed and up-to-date. +- Re-install the library through the Library Manager. + +### Inaccurate Values +If the sensor values are not accurate, make sure: +- The sensor lens is clean and free from dust or obstructions. +- All exposed electronics are not touching any conductive surfaces, as this could interfere with readings. +- The object being measured is within the sensor's detection range. + +# What Is Next? + +Now that you've learned how to use your Modulino Distance, you're all set to integrate it into your projects! +- Create a parking assistance system that provides audio feedback as objects get closer, similar to car parking sensors. +- Build a theremin-like musical instrument that changes pitch or volume based on hand movements in front of the sensor. +- Design an automatic dispenser that activates when hands are detected beneath it (for soap, sanitizer, etc.). + +# Conclusion + +The **Modulino Distance** is a digital Time-of-Flight distance sensor that communicates over I²C and follows the Modulino form factor. It includes standard Qwiic connectors for quick, solderless connections and easy daisy-chaining with other modules. Paired with the Modulino library, it makes accessing distance data straightforward, allowing you to focus on experimenting or building your system logic. It's a small, reliable module suited for both quick tests and longer-term setups. \ No newline at end of file diff --git a/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/image.png b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/image.png new file mode 100644 index 0000000000..bceefec75d Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-distance/tutorials/how-distance-mp/image.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/assets/BlockDiagramKnob.png b/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/assets/BlockDiagramKnob.png new file mode 100644 index 0000000000..c60a4f3f81 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/assets/BlockDiagramKnob.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/assets/I2CTag.png b/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/assets/I2CTag.png new file mode 100644 index 0000000000..9d9b7b0f72 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/assets/I2CTag.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/assets/KnobMec.png b/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/assets/KnobMec.png new file mode 100644 index 0000000000..61ad2aee3f Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/assets/KnobMec.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/assets/KnobPinouts.png b/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/assets/KnobPinouts.png new file mode 100644 index 0000000000..ea4147de61 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/assets/KnobPinouts.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/assets/Modulino_Knob_Power_Tree.png b/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/assets/Modulino_Knob_Power_Tree.png new file mode 100644 index 0000000000..f50d5ba207 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/assets/Modulino_Knob_Power_Tree.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/assets/ResistorsPullupGen.png b/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/assets/ResistorsPullupGen.png new file mode 100644 index 0000000000..7095581413 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/assets/ResistorsPullupGen.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/assets/featuredKnob.png b/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/assets/featuredKnob.png new file mode 100644 index 0000000000..116003f7e0 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/assets/featuredKnob.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/datasheet.md b/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/datasheet.md new file mode 100644 index 0000000000..33ecd22274 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-knob/datasheet/datasheet.md @@ -0,0 +1,264 @@ +--- +identifier: ABX00107 +title: Arduino® Modulino® Knob +type: maker +author: Pedro Sousa Lima +--- + +![](assets/featuredKnob.png) + +# Description +The Modulino® Knob features a **quadrature rotary encoder** (PEC11J-9215F-S0015) paired with an on-board **STM32C011F4 microcontroller**, enabling both precise rotational input and push-button interaction. The node communicates via I2C (Qwiic interface) by default, but can also be reprogrammed or accessed via other communication interfaces for advanced projects. + +# Target Areas +Maker, beginner, education + +# Contents + +## Application Examples + +- **User Interface Control** + Implement smooth menu navigation, scrolling through options, or fine adjustment of parameters (e.g., volume, brightness) in your project. + +- **Industrial/Mechanical Projects** + Use rotary input for setting machine parameters, calibrating sensors, or controlling motor speed. + +- **Educational Tools** + Teach the concepts of rotary encoding, I2C interfacing, and microcontroller-based data handling using a simple, hands-on input device. + +
+ +## Features +- **Quadrature rotary encoder** with push-switch capability for rich user input. +- **STM32C011F4** microcontroller handling I2C communications and optional reprogramming. +- Operates at **3.3 V** via the Qwiic interface; supports 2.0 V–3.6 V supply range internally. +- **SWD** interface on-board for firmware customization, plus optional UART lines. +- Ideal for **menu navigation**, fine-tuning controls, and interactive IoT or maker projects. + +### Contents +| **SKU** | **Name** | **Purpose** | **Quantity** | +| --------- | -------------------- | ------------------------------------------- | ------------ | +| ABX00107 | Modulino® Knob | Quadrature rotary encoder with push switch | 1 | +| | I2C Qwiic cable | Compatible with the Qwiic standard | 1 | + + +## Related Products +- *SKU: ASX00027* – [Arduino® Sensor Kit](https://store.arduino.cc/products/arduino-sensor-kit) +- *SKU: K000007* – [Arduino® Starter Kit](https://store.arduino.cc/products/arduino-starter-kit-multi-language) +- *SKU: AKX00026* – [Arduino® Oplà IoT Kit](https://store.arduino.cc/products/opla-iot-kit) + +## Rating + +### Recommended Operating Conditions +- **Microcontroller supply range:** 2.0 V – 3.6 V (STM32C011F4) +- **Powered at 3.3 V** through the Qwiic interface (in accordance with the Qwiic standard) +- **Operating temperature:** –40 °C to +85 °C + +**Typical current consumption:** +- ~3.4 mA (microcontroller + rotary encoder interface) + +## Power Tree +The power tree for the modulino can be consulted below: + +![Modulino® Knob Power Tree](assets/Modulino_Knob_Power_Tree.png) + +## Block Diagram +This module includes an STM32C011F4 microcontroller, reading the quadrature signals from the rotary encoder and a push switch. It communicates via I2C by default but can be customized via SWD for additional functionalities. + +![Modulino® Knob block diagram](assets/BlockDiagramKnob.png) + +## Functional Overview +The Modulino® Knob node reads a **quadrature rotary encoder** (including push-switch action), translating positional and switch states into data accessible via I2C. The on-board MCU (STM32C011F4) can also support other protocols (UART, SPI, I2S) if reprogrammed. By default, I2C data allows host microcontrollers (e.g., Arduino® UNO R4 WiFi) to read knob rotation and button states easily. + +### Technical Specifications +| **Specification** | **Details** | +| ----------------------- | ------------------------------------------------- | +| **Microcontroller** | STM32C011F4 (handles I2C, rotary encoder logic) | +| **Accuracy** | ADC: ±2 LSB typical INL | +| **Resolution** | 12-bit ADC | +| **Encoder** | PEC11J-9215F-S0015 (quadrature + push switch) | +| **Supply Voltage** | Min: 2.0 V, Max: 3.6 V | +| **Power Consumption** | ~3.4 mA | +| **Encoder Range** | 360° (continuous rotation) | +| **Communication** | I2C (Qwiic), SWD (debug/reprogram), optional UART | +| **Resolution** | Internal 12-bit ADC (for custom expansions) | + +### Pinout + +**Qwiic / I2C (1×4 Header)** +| **Pin** | **Function** | +|---------|---------------------------| +| GND | Ground | +| 3.3 V | Power Supply (3.3 V) | +| SDA | I2C Data | +| SCL | I2C Clock | + +These pads and the Qwiic connectors share the same I2C bus at 3.3 V. + +**Additional 1×10 Header (Knob & MCU Signals)** +| **Pin** | **Function** | +|---------|-------------------| +| PA0 | Encoder Pin A | +| PA1 | Encoder Pin B | +| PA2 | Push Switch | +| RX1 | UART Receive | +| TX1 | UART Transmit | +| SWDIO | SWD Data | +| SWCLK | SWD Clock | +| PF2 | NRST (Reset) | + +**Note:** By default, the STM32C011F4 firmware manages the rotary encoder via I2C registers. Advanced users may modify this behavior by flashing custom code through SWD. + +![Pinout Overview](assets/KnobPinouts.png) + + +### Power Specifications +- **Nominal operating voltage:** 3.3 V via Qwiic +- **MCU voltage range:** 2.0 V–3.6 V + +### Mechanical Information +![Modulino® Knob Mechanical Information](assets/KnobMec.png) + +- Board dimensions: 41 mm × 25.36 mm +- Thickness: 1.6 mm (±0.2 mm) +- Four mounting holes (Ø 3.2 mm) + - Hole spacing: 16 mm vertically, 32 mm horizontally + +### I2C Address Reference +| **Board Silk Name** | **Sensor** | **Modulino I2C Address (HEX)** | **Editable Addresses (HEX)** | **Hardware I2C Address (HEX)** | +|---------------------|--------------------------|--------------------------------|---------------------------------------|--------------------------------| +| MODULINO KNOB | Quadrature Encoder + MCU | 0x76 | Any custom address (via FW config) | 0x3A | + +**Note:** Default I2C address is **0x76**. You can change it through the Modulino® library or by flashing custom firmware. A white rectangle on the board silk can be used to label the new address. +![Blank silk for identification](assets/I2CTag.png) + +#### Pull-up Resistors + +The module has pads for optional I2C pull-up mounting in both data lines. No resistors are mounted by default but in case the resistors are need 4.7 K resistors in an SMD 0402 format are recommended. + +These are positioned near the Qwiic connector on the power LED side. +![Generic pull-up resistor position](assets/ResistorsPullupGen.png) + +## Device Operation +The Modulino® Knob node acts as an I2C target device on the Qwiic bus. It detects rotation steps (increment/decrement), push-switch events, and reports them to the host controller. If the included firmware doesn’t meet your needs, you can reprogram the STM32C011F4 via SWD. + +### Getting Started +Use any Arduino or other 3.3 V microcontroller environment. An official Modulino® library may be available to streamline reading rotary values and push-switch states. Ensure your master device shares the same 3.3 V reference and I2C bus. + + +### Board Recovery + +All Arduino® boards have a built-in bootloader which allows flashing the board via USB. In case a sketch locks up the processor and the board is not reachable anymore via USB, it is possible to enter bootloader mode by double-tapping the reset button right after the power-up. + +# Certifications + +## Certifications Summary + +| **Certification** | **Status** | +|:-----------------:|:----------:| +| CE/RED (Europe) | Yes | +| UKCA (UK) | Yes | +| FCC (USA) | Yes | +| IC (Canada) | Yes | +| RoHS | Yes | +| REACH | Yes | +| WEEE | Yes | + +## Declaration of Conformity CE DoC (EU) + +

We declare under our sole responsibility that the products above are in conformity with the essential requirements of the following EU Directives and therefore qualify for free movement within markets comprising the European Union (EU) and European Economic Area (EEA).

+ +## Declaration of Conformity to EU RoHS & REACH 211 01/19/2021 + +

Arduino boards are in compliance with RoHS 2 Directive 2011/65/EU of the European Parliament and RoHS 3 Directive 2015/863/EU of the Council of 4 June 2015 on the restriction of the use of certain hazardous substances in electrical and electronic equipment.

+ +| Substance | **Maximum limit (ppm)** | +|----------------------------------------|-------------------------| +| Lead (Pb) | 1000 | +| Cadmium (Cd) | 100 | +| Mercury (Hg) | 1000 | +| Hexavalent Chromium (Cr6+) | 1000 | +| Poly Brominated Biphenyls (PBB) | 1000 | +| Poly Brominated Diphenyl ethers (PBDE) | 1000 | +| Bis(2-Ethylhexyl) phthalate (DEHP) | 1000 | +| Benzyl butyl phthalate (BBP) | 1000 | +| Dibutyl phthalate (DBP) | 1000 | +| Diisobutyl phthalate (DIBP) | 1000 | + +Exemptions: No exemptions are claimed. + +

Arduino Boards are fully compliant with the related requirements of European Union Regulation (EC) 1907 /2006 concerning the Registration, Evaluation, Authorization and Restriction of Chemicals (REACH). We declare none of the SVHCs (https://echa.europa.eu/web/guest/candidate-list-table), the Candidate List of Substances of Very High Concern for authorization currently released by ECHA, is present in all products (and also package) in quantities totaling in a concentration equal or above 0.1%. To the best of our knowledge, we also declare that our products do not contain any of the substances listed on the "Authorization List" (Annex XIV of the REACH regulations) and Substances of Very High Concern (SVHC) in any significant amounts as specified by the Annex XVII of Candidate list published by ECHA (European Chemical Agency) 1907 /2006/EC.

+ +## Conflict Minerals Declaration + +

As a global supplier of electronic and electrical components, Arduino is aware of our obligations with regard to laws and regulations regarding Conflict Minerals, specifically the Dodd-Frank Wall Street Reform and Consumer Protection Act, Section 1502. Arduino does not directly source or process conflict minerals such as Tin, Tantalum, Tungsten, or Gold. Conflict minerals are contained in our products in the form of solder or as a component in metal alloys. As part of our reasonable due diligence, Arduino has contacted component suppliers within our supply chain to verify their continued compliance with the regulations. Based on the information received thus far we declare that our products contain Conflict Minerals sourced from conflict-free areas.

+ +## FCC Caution + +Any Changes or modifications not expressly approved by the party responsible for compliance could void the user’s authority to operate the equipment. + +This device complies with part 15 of the FCC Rules. Operation is subject to the following two conditions: + +1. This device may not cause harmful interference. +2. This device must accept any interference received, including interference that may cause undesired operation. + +**FCC RF Radiation Exposure Statement:** + +1. This Transmitter must not be co-located or operating in conjunction with any other antenna or transmitter. +2. This equipment complies with RF radiation exposure limits set forth for an uncontrolled environment. +3. This equipment should be installed and operated with a minimum distance of 20 cm between the radiator & your body. + +**Note:** This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures: + +- Reorient or relocate the receiving antenna. +- Increase the separation between the equipment and receiver. +- Connect the equipment into an outlet on a circuit different from that to which the receiver is connected. +- Consult the dealer or an experienced radio/TV technician for help. + +English: +User manuals for license-exempt radio apparatus shall contain the following or equivalent notice in a conspicuous location in the user manual or alternatively on the device or both. This device complies with Industry Canada license-exempt RSS standard(s). Operation is subject to the following two conditions: + +1. this device may not cause interference. +2. this device must accept any interference, including interference that may cause undesired operation of the device. + +French: +Le présent appareil est conforme aux CNR d’Industrie Canada applicables aux appareils radio exempts de licence. L’exploitation est autorisée aux deux conditions suivantes: + +1. l’appareil nedoit pas produire de brouillage. +2. l’utilisateur de l’appareil doit accepter tout brouillage radioélectrique subi, même si le brouillage est susceptible d’en compromettre le fonctionnement. + +**IC SAR Warning:** + +English: +This equipment should be installed and operated with a minimum distance of 20 cm between the radiator and your body. + +French: +Lors de l’installation et de l’exploitation de ce dispositif, la distance entre le radiateur et le corps est d’au moins 20 cm. + +**Important:** The operating temperature of the EUT can’t exceed 85 ℃ and shouldn’t be lower than -40 ℃. + +Hereby, Arduino S.r.l. declares that this product is in compliance with essential requirements and other relevant provisions of Directive 2014/53/EU. This product is allowed to be used in all EU member states. + +# Company Information + +| Company name | Arduino SRL | +|-----------------|-----------------------------------------------| +| Company Address | Via Andrea Appiani, 25 - 20900 MONZA（Italy) | + +# Reference Documentation + +| Ref | Link | +| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Arduino IDE (Desktop) | [https://www.arduino.cc/en/Main/Software](https://www.arduino.cc/en/Main/Software) | +| Arduino Courses | [https://www.arduino.cc/education/courses](https://www.arduino.cc/education/courses) | +| Arduino Documentation | [https://docs.arduino.cc/](https://docs.arduino.cc/) | +| Arduino IDE (Cloud) | [https://create.arduino.cc/editor](https://create.arduino.cc/editor) | +| Cloud IDE Getting Started | [https://docs.arduino.cc/cloud/web-editor/tutorials/getting-started/getting-started-web-editor](https://docs.arduino.cc/cloud/web-editor/tutorials/getting-started/getting-started-web-editor) | +| Project Hub | [https://projecthub.arduino.cc/](https://projecthub.arduino.cc/) | +| Library Reference | [https://github.com/arduino-libraries/](https://github.com/arduino-libraries/) | +| Online Store | [https://store.arduino.cc/](https://store.arduino.cc/) | + +# Revision History +| **Date** | **Revision** | **Changes** | +|------------ |------------ |------------------------------------------------| +| 11/07/2024 | 1 | First release | diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/essentials.md b/content/hardware/11.accessories/modulinos/modulino-knob/essentials.md new file mode 100644 index 0000000000..762e36d575 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-knob/essentials.md @@ -0,0 +1,8 @@ + + + + +This library allows you to communicate with the Arduino Modulino® nodes. + + + diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/features.md b/content/hardware/11.accessories/modulinos/modulino-knob/features.md new file mode 100644 index 0000000000..5b2e9975f4 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-knob/features.md @@ -0,0 +1,12 @@ + +The Modulino® Knob module combines a rotary encoder with an integrated switch, providing a tactile way to navigate menus or adjust values. It is compatible with the Arduino UNO R4 WiFi or any board featuring a Qwiic interface, making it simple to prototype user interfaces with physical dials. + + + + + Example projects demonstrate how to read the knob’s position and switch state, making it easy to learn how rotary encoders work in interactive applications. + + + The Modulino® Knob connects via Qwiic cables to your UNO R4 WiFi or other compatible boards. Solderable pins are also available for direct wiring when a Qwiic interface is not available. + + diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/image.svg b/content/hardware/11.accessories/modulinos/modulino-knob/image.svg new file mode 100644 index 0000000000..f3d16cb150 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-knob/image.svg @@ -0,0 +1,1212 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/product.md b/content/hardware/11.accessories/modulinos/modulino-knob/product.md new file mode 100644 index 0000000000..c46a0b213a --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-knob/product.md @@ -0,0 +1,11 @@ +--- +title: Modulino® Knob +url_shop: https://store.arduino.cc/products/modulino-knob +url_guide: https://courses.arduino.cc/plugandmake +primary_button_url: https://courses.arduino.cc/plugandmake +primary_button_title: Get Started +certifications: [] +sku: [ABX00107] +--- + +A rotary encoder with a built-in SPST switch—ideal for menu navigation, parameter tuning, or interactive input. Effortlessly integrate with Arduino UNO R4 WiFi or other Qwiic-enabled boards, or use the solderable pins if Qwiic is not available. No complex wiring needed to start turning your ideas into reality. diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tech-specs.md b/content/hardware/11.accessories/modulinos/modulino-knob/tech-specs.md new file mode 100644 index 0000000000..58755cb974 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-knob/tech-specs.md @@ -0,0 +1 @@ +Here you will find the technical specifications for the Modulino® Knob. \ No newline at end of file diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tech-specs.yml b/content/hardware/11.accessories/modulinos/modulino-knob/tech-specs.yml new file mode 100644 index 0000000000..b7ac1a332e --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-knob/tech-specs.yml @@ -0,0 +1,11 @@ +Node: + Name: Modulino Knob + SKU: ABX00107 + Board recommended: Arduino® UNO R4 WiFi (ABX00087) + Communications: I2C (over Qwiic connector or solderable pin) + Operational voltage: 3.3V + Sensor: + PEC11J (STM32C011F4): 0x76 (address can change via software) + +Other accessories: + Qwiic cables: 1x diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/AdressChangeIDE.png b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/AdressChangeIDE.png new file mode 100644 index 0000000000..d5cd3fd195 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/AdressChangeIDE.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/KnobPinouts.png b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/KnobPinouts.png new file mode 100644 index 0000000000..ea4147de61 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/KnobPinouts.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/Modulino_Knob_Power_Tree.png b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/Modulino_Knob_Power_Tree.png new file mode 100644 index 0000000000..f50d5ba207 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/Modulino_Knob_Power_Tree.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/adressChanger.png b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/adressChanger.png new file mode 100644 index 0000000000..c6eae670c8 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/adressChanger.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/connection-guide-knob-jumper.png b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/connection-guide-knob-jumper.png new file mode 100644 index 0000000000..f53484a929 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/connection-guide-knob-jumper.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/connection-guide-knob-qwiic-chain.png b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/connection-guide-knob-qwiic-chain.png new file mode 100644 index 0000000000..bdb182ec7e Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/connection-guide-knob-qwiic-chain.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/connection-guide-knob-qwiic.png b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/connection-guide-knob-qwiic.png new file mode 100644 index 0000000000..82dccffca5 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/connection-guide-knob-qwiic.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/connection-guide-knob.png b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/connection-guide-knob.png new file mode 100644 index 0000000000..8e5bc0b051 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/connection-guide-knob.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/library-dependencies.png b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/library-dependencies.png new file mode 100644 index 0000000000..d25bd9720b Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/library-dependencies.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/library-install.gif b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/library-install.gif new file mode 100644 index 0000000000..16f396c353 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/library-install.gif differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/library-menu.png b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/library-menu.png new file mode 100644 index 0000000000..2339cf8450 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/library-menu.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/schematic.png b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/schematic.png new file mode 100644 index 0000000000..4b20ab5c12 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/assets/schematic.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/content.md b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/content.md new file mode 100644 index 0000000000..51493e495a --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-ardu/content.md @@ -0,0 +1,231 @@ +--- +title: "How To Use The Modulino Knob" +description: "Learn how to get the most out of your Modulino Knob." +tags: + - Modulino + - QWIIC + - I2C +author: 'Christoher Méndez' +hardware: + - hardware/11.modulinos/modulinos/modulino-knob +software: + - ide-v2 + - web-editor +--- + +The Modulino Knob is a modular sensor based on a quadrature rotary encoder that translates angular motion (rotation) into a digital signal. The sensor value will increase or decrease according to the rotation direction. Also, it includes an SPST switch that is activated when the knob is pressed. +It uses the Modulino form factor, streamlining integration through the I2C protocol. It provides QWIIC connectors and exposed solderable pins (for boards without a QWIIC interface). + +## General Characteristics + +The Modulino Knob has the following measurement specifications: + + +| **Parameter** | **Condition** | **Minimum** | **Typical** | **Maximum** | **Unit** | +| -------------- | ------------- | ----------- | ---------------- | ----------- | -------- | +| Sensor | Angle | - | 360 (continuous) | - | ° | +| Steps | - | - | 30 | - | - | +| Resolution | - | - | 12 | - | bit | + +## Sensor Details + +The PEC11J-9215F-S0015 rotary encoder is the core component of this module. This sensor output is processed by an STM32C011F4 microcontroller for digital communication (I2C), meaning that the encoder is communicated through the I2C pins using the mentioned microcontroller as an intermediary. +The default address for the Module is: + +| **Modulino I2C Address** | **Hardware I2C Address** | +| ------------------------ | ------------------------ | +| 0x76 | 0x3A | + +When scanning for I²C address on the bus, you might find the modulino using the **Hardware I²C Address**. However, you should always use the **Modulino I²C Address** when using the official Modulino library. +Later in this article we teach how to [change the address](#how-to-change-i2c-address). + + +## Pinout + +The rotary encoder is the core component of this module. This input device is controlled by an onboard STM32 microcontroller, which supports digital communication (I²C), meaning it connects directly to the I²C bus on the module without requiring additional conversion circuitry. + +![Arduino Knob Pinout](assets/KnobPinouts.png) + +The board also includes direct connections to the rotary encoder bypassing the built-in microcontroller. + +### Input/Output Headers + +| Pin | Function | +|----------|-----------------| +| Button | PA2 Button Signal | +| Encoder A | PA0 Encoder A Signal | +| Encoder B | PA1 Encoder B Signal | +| RX1 | UART Receive | +| TX1 | UART Transmit | +| SWDIO | SWD Data | +| SWCLK | SWD Clock | +| PF2 | NRST | + +**Button** – This pin connects directly to the built-in button of the rotary encoder. +**Encoder A/B** – These pins connect directly to the rotary encoder's quadrature outputs. +**RX1: UART Receive** – Used for receiving data over UART communication. +**TX1: UART Transmit** – Used for transmitting data over UART communication. +**SWDIO: SWD Data** – Used for debugging, as part of the Serial Wire Debug (SWD) interface. +**SWCLK: SWD Clock** – Used for providing the clock signal in the SWD interface. +**PF2: NRST** – The reset pin for the microcontroller, which can be used to reset the system. + +### 1x4 Header (I2C) + +The pinout for the Modulino Knob is shown below. While the recommended connection method is via the QWIIC connectors, this solderable header provides a connection option when using the modulino with a non-QWIIC compatible board. + +| Pin | Function | +|-------|--------------| +| GND | Ground | +| 3.3 V | Power Supply | +| SDA | I²C Data | +| SCL | I²C Clock | + +## Power Specifications + +The board must be powered **only** by +3.3 VDC when using the solderable pins or the QWIIC interface as per the standard. + +| Parameter | Minimum | Typical | Maximum | Unit | +| --------------- | ------- | ------- | ------- | ---- | +| Supply Voltage | 2.0 | 3.3 | 3.6 | V | +| Average Current | | 3.4 | | mA | + +The module includes a power LED that draws 1 mA and turns on as soon as it is powered. J1 (Qwiic connector), J2 (Qwiic connector), and the headers all share the same power branch. The power distribution of the module is therefore as follows: +![Power Tree Modulino Knob](assets/Modulino_Knob_Power_Tree.png) + +## Schematic + +The Modulino Knob uses a simple circuit, as shown in the schematic below: + +![Full Schematic Modulino Knob](assets/schematic.png) + +The main components are the **rotary encoder with integrated pushbutton** (PECHL-9215E-S0015) and the **STM32C011F4U6TR** microcontroller (U1), which handles encoder position reading, button state detection, as well as I²C communication. +You can connect to the I²C pins (SDA and SCL) using either the **QWIIC connectors** (J1 and J2, this is the recommended method) or the **solderable pins** (J3). The board runs on **3.3V**, which comes from the QWIIC cable or the **3V3 pin** on J3. +There's also a small power LED indicator (green) that lights up when the board is on. + +You can grab the full schematic and PCB files from the [Modulino Knob](https://docs.arduino.cc/hardware/modulinos/modulino-knob) product page. + +## How To Connect Your Modulino + +The easiest and most reliable way to connect your Modulino is through the QWIIC Connect System. It's plug-and-play, uses standard I²C, and makes it easy to join multiple modules. If your board supports QWIIC, this is the recommended way to go. Note that the dedicated I²C pins will differ from board to board meaning it is always a good idea to check your specific model. + +![Modulino Wiring Options QWIIC(A - recommended) and Header(B)](assets/connection-guide-knob.png) + +### QWIIC Connector + +Whenever available, the **QWIIC Connect System** is the preferred method. Connecting to the Modulino is extremely simple, just use a standard QWIIC cable to connect your board to either of the QWIIC connectors on the Modulino. Because the cable and connectors are polarized, there is no need to worry about accidentally swapping connections. + +QWIIC is a plug-and-play I²C Connect System that uses standardized 4-pin connectors: +- GND +- 3.3V +- SDA (Data) +- SCL (Clock) + +![Connection Guide QWIIC](assets/connection-guide-knob-qwiic.png) + +The Modulino features two QWIIC connectors, which are internally connected in parallel. This means you can daisy-chain multiple modules easily by connecting additional QWIIC cables between them. + +### Solderable Header + +When QWIIC is not available, you can use the exposed solderable pins on the module. You can solder pins to the unpopulated pads; just remember the pinout provided in this guide to connect to the right pins of your board. + +![Connection Guide Solder Pads](assets/connection-guide-knob-jumper.png) + +### Daisy-Chaining Multiple Modulinos + +Regardless of whether you connect the first Modulino via QWIIC or through the solderable pins, you can still take advantage of the extra QWIIC connector to daisy-chain additional modules. Each Modulino includes two QWIIC connectors wired in parallel, allowing you to connect one module to the next in a chain. As long as each module is configured with a unique I²C address, they can all communicate on the same bus. This approach keeps your setup clean, modular, and expandable without adding extra wiring complexity. + +![Modulino Wiring Options](assets/connection-guide-knob-qwiic-chain.png) + +***The number of modules you can connect will depend on what modules you are chaining together, as this system allows for multiple sensors from different manufacturers to be added. Also, the cables you use for these connections will play a significant role in the setup's performance. Ensure your cables are properly connected and capable of handling the required data transfer. + +Each module should have a unique address on a chain if you plan to address them individually. Later in this article we teach how to [change the address](#how-to-change-i2c-address). Multiple modules with the same address will cause conflicts on the I²C bus and will not allow you to address them individually.*** + +## How To Program Your Modulino + +### Installing The Modulino Library + +You need the official Modulino library available [here](https://github.com/arduino-libraries/Modulino) to use the Modulino Knob. +With the Arduino IDE, you get some tools that make adding a library easier. To learn how to install the IDE, please visit our [page](https://docs.arduino.cc/micropython/first-steps/install-guide/). +After opening the IDE, a tab should be visible on the left. Press the book icon for "library" as highlighted in the image. +![IDE Library Tab](assets/library-menu.png) + +You can now search for the library `Modulino` by filling in the `Filter your search` text box. A prompt might appear saying that additional dependencies are required. This is not a problem, as they will be automatically added when you confirm the prompt. +![Add Dependencies Prompt](assets/library-dependencies.png) + +The libraries should now start to install. A message will appear after the installation is successful. +The process should be like this: +![Library Install](assets/library-install.gif) + +### Getting Knob Data + +Data can be obtained from the sensor using the `Modulino` library. + +For the **Knob** there are two important functions: + +- `get()`: Returns a numerical value relative to the knob rotation. +- `isPressed()`: Returns the state of the knob built-in button. +- `knob.get();` retrieves a unitless value relative to the knob rotation. +- `knob.isPressed();` retrieves the knob button state. +- `knob.set();` changes the initial position of the encoder. +- `Modulino.begin();`: By default the Modulino library uses ```Wire1``` if your connection is in a different Wire you will have to edit it, check [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/) (by default the Modulino library uses ```Wire1``` if your board model has a different pinout for the dedicated I²C pins you might have to edit it. More information on **Wire** can be found [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/)) for the library's hardware compatibility. More information on **Wire** can be found [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/). + +Here is an example sketch of how to implement these functions to acquire data: + +```arduino +#include + +ModulinoKnob knob; + +void setup() { + Serial.begin(9600); + Modulino.begin(); + knob.begin(); +} + +void loop(){ + int position = knob.get(); + bool click = knob.isPressed(); + + Serial.print("Current position is: "); + Serial.println(position); + + if(click){ + Serial.println("Clicked!"); + } + +} +``` + +### How To Change I2C Address + +An example sketch, AddressChanger, is also included with the library inside the `Utilities` folder and available [here](https://github.com/arduino-libraries/Modulino/blob/main/examples/Utilities/AddressChanger/AddressChanger.ino). This sketch changes the I²C address at a software level on the Module's microcontroller. +![Example location on the IDE](assets/AdressChangeIDE.png) + +- Connect the module to your board, remove any other modules that might be in the chain. Connection must be via I²C. +- Upload the sketch. +- Open the Serial Monitor. +- Text should now appear. Make sure the correct bauld-rate is selected if the displayed characters seem corrupted. + ![Expected console output](assets/adressChanger.png) +- Select the address and confirm. Valid I²C addresses range from 0x08 to 0x77 (7-bit values in hexadecimal format, e.g., 0x42). +- Your address should now have changed. Make sure to take note of the selected address. + +To keep track of the address in use the module has a white rectangle on the back. Feel free to use this to write the address that was chosen. + +When using a custom address in your sketch, you'll need to specify this address when creating the module object. For example: +```arduino +ModulinoKnob knob(0x3E); // Replace 0x3E with your specific address +``` + + +## Conclusion + +The **Modulino Knob** provides a simple solution for UI interface, volume control or rotational measurement in any project. With its **I2C interface**, compact **Modulino form factor**, and **robustness**, it seamlessly integrates into both beginner and advanced applications. + +By leveraging the **Modulino library**, users can quickly access sensor data and implement functionalities such as **user interface control and angle measurement tool**. With just a few lines of code, you can start **controlling your projects**, making it easier than ever to bring intelligent sensing to your applications. + +## What Next? + +After mastering the basics of the Modulino Knob, try these project ideas: +- Calculate what is the encoder rotation angle per step to convert the arbitrary output into a rotation angle output. +- Control the Arduino onboard LED with the press of the knob button. +- Use the Modulino Knob to control the navigation on a UI display on an LCD or OLED screen. \ No newline at end of file diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/KnobPinouts.png b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/KnobPinouts.png new file mode 100644 index 0000000000..ea4147de61 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/KnobPinouts.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/Modulino_Knob_Power_Tree.png b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/Modulino_Knob_Power_Tree.png new file mode 100644 index 0000000000..f50d5ba207 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/Modulino_Knob_Power_Tree.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/connection-guide-knob-jumper.png b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/connection-guide-knob-jumper.png new file mode 100644 index 0000000000..61ae95f8bc Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/connection-guide-knob-jumper.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/connection-guide-knob-qwiic-chain.png b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/connection-guide-knob-qwiic-chain.png new file mode 100644 index 0000000000..bdb182ec7e Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/connection-guide-knob-qwiic-chain.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/connection-guide-knob-qwiic.png b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/connection-guide-knob-qwiic.png new file mode 100644 index 0000000000..82dccffca5 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/connection-guide-knob-qwiic.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/connection-guide-knob.png b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/connection-guide-knob.png new file mode 100644 index 0000000000..8e5bc0b051 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/connection-guide-knob.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/mp-usb-connection.png b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/mp-usb-connection.png new file mode 100644 index 0000000000..fb059f9e8b Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/mp-usb-connection.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/package-installer-overview.png b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/package-installer-overview.png new file mode 100644 index 0000000000..67678dc808 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/package-installer-overview.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/schematic.png b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/schematic.png new file mode 100644 index 0000000000..4b20ab5c12 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/assets/schematic.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/content.md b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/content.md new file mode 100644 index 0000000000..c6f2571653 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-knob/tutorials/how-knob-mp/content.md @@ -0,0 +1,248 @@ +--- +title: "How To Use The Modulino Knob with MicroPython" +description: "Learn how to get the most out of your Modulino Knob in a MicroPython environment." +tags: + - Modulino + - QWIIC + - I2C +author: 'Christoher Méndez' +hardware: + - hardware/11.modulinos/modulinos/modulino-knob +software: + - ide-v2 + - web-editor +--- + +The Modulino Knob is a modular sensor based on a quadrature rotary encoder that translates angular motion (rotation) into a digital signal. The sensor value will increase or decrease according to the rotation direction. Also, it includes an SPST switch that is activated when the knob is pressed. +It uses the Modulino form factor, streamlining integration through the I2C protocol. It provides QWIIC connectors and exposed solderable pins (for boards without a QWIIC interface). + +## General Characteristics + +The Modulino Knob has the following measurement specifications: + + +| **Parameter** | **Condition** | **Minimum** | **Typical** | **Maximum** | **Unit** | +| -------------- | ------------- | ----------- | ---------------- | ----------- | -------- | +| Sensor | Angle | - | 360 (continuous) | - | ° | +| Steps | - | - | 30 | - | - | +| Resolution | - | - | 12 | - | bit | + +## Sensor Details + +The PEC11J-9215F-S0015 rotary encoder is the core component of this module. This sensor output is processed by an STM32C011F4 microcontroller for digital communication (I2C), meaning that the encoder is communicated through the I2C pins using the mentioned microcontroller as an intermediary. +The default address for the Module is: + +| **Modulino I2C Address** | **Hardware I2C Address** | +| ------------------------ | ------------------------ | +| 0x76 | 0x3A | + +When scanning for I²C address on the bus, you might find the modulino using the **Hardware I²C Address**. However, you should always use the **Modulino I²C Address** when using the official Modulino library. +Later in this article we teach how to [change the address](#how-to-change-i2c-address). + + +## Pinout + +The rotary encoder is the core component of this module. This input device is controlled by an onboard STM32 microcontroller, which supports digital communication (I²C), meaning it connects directly to the I²C bus on the module without requiring additional conversion circuitry. + +![Arduino Knob Pinout](assets/KnobPinouts.png) + +The board also includes direct connections to the rotary encoder bypassing the built-in microcontroller. + +### Input/Output Headers + +| Pin | Function | +|----------|-----------------| +| Button | PA2 Button Signal | +| Encoder A | PA0 Encoder A Signal | +| Encoder B | PA1 Encoder B Signal | +| RX1 | UART Receive | +| TX1 | UART Transmit | +| SWDIO | SWD Data | +| SWCLK | SWD Clock | +| PF2 | NRST | + +**Button** – This pin connects directly to the built-in button of the rotary encoder. +**Encoder A/B** – These pins connect directly to the rotary encoder's quadrature outputs. +**RX1: UART Receive** – Used for receiving data over UART communication. +**TX1: UART Transmit** – Used for transmitting data over UART communication. +**SWDIO: SWD Data** – Used for debugging, as part of the Serial Wire Debug (SWD) interface. +**SWCLK: SWD Clock** – Used for providing the clock signal in the SWD interface. +**PF2: NRST** – The reset pin for the microcontroller, which can be used to reset the system. + +### 1x4 Header (I2C) + +The pinout for the Modulino Knob is shown below. While the recommended connection method is via the QWIIC connectors, this solderable header provides a connection option when using the modulino with a non-QWIIC compatible board. + +| Pin | Function | +|-------|--------------| +| GND | Ground | +| 3.3 V | Power Supply | +| SDA | I²C Data | +| SCL | I²C Clock | + +## Power Specifications + +The board must be powered **only** by +3.3 VDC when using the solderable pins or the QWIIC interface as per the standard. + +| Parameter | Minimum | Typical | Maximum | Unit | +| --------------- | ------- | ------- | ------- | ---- | +| Supply Voltage | 2.0 | 3.3 | 3.6 | V | +| Average Current | | 3.4 | | mA | + +The module includes a power LED that draws 1 mA and turns on as soon as it is powered. J1 (Qwiic connector), J2 (Qwiic connector), and the headers all share the same power branch. The power distribution of the module is therefore as follows: +![Power Tree Modulino Knob](assets/Modulino_Knob_Power_Tree.png) + +## Schematic + +The Modulino Knob uses a simple circuit, as shown in the schematic below: + +![Full Schematic Modulino Knob](assets/schematic.png) + +The main components are the **rotary encoder with integrated pushbutton** (PECHL-9215E-S0015) and the **STM32C011F4U6TR** microcontroller (U1), which handles encoder position reading, button state detection, as well as I²C communication. +You can connect to the I²C pins (SDA and SCL) using either the **QWIIC connectors** (J1 and J2, this is the recommended method) or the **solderable pins** (J3). The board runs on **3.3V**, which comes from the QWIIC cable or the **3V3 pin** on J3. +There's also a small power LED indicator (green) that lights up when the board is on. + +You can grab the full schematic and PCB files from the [Modulino Knob](https://docs.arduino.cc/hardware/modulinos/modulino-knob) product page. + +## How To Connect Your Modulino + +The easiest and most reliable way to connect your Modulino is through the QWIIC Connect System. It's plug-and-play, uses standard I²C, and makes it easy to join multiple modules. If your board supports QWIIC, this is the recommended way to go. Note that the dedicated I²C pins will differ from board to board meaning it is always a good idea to check your specific model. + +![Modulino Wiring Options QWIIC(A - recommended) and Header(B)](assets/connection-guide-knob.png) + +### QWIIC Connector + +Whenever available, the **QWIIC Connect System** is the preferred method. Connecting to the Modulino is extremely simple, just use a standard QWIIC cable to connect your board to either of the QWIIC connectors on the Modulino. Because the cable and connectors are polarized, there is no need to worry about accidentally swapping connections. + +QWIIC is a plug-and-play I²C Connect System that uses standardized 4-pin connectors: +- GND +- 3.3V +- SDA (Data) +- SCL (Clock) + +![Connection Guide QWIIC](assets/connection-guide-knob-qwiic.png) + +The Modulino features two QWIIC connectors, which are internally connected in parallel. This means you can daisy-chain multiple modules easily by connecting additional QWIIC cables between them. + +### Solderable Header + +When QWIIC is not available, you can use the exposed solderable pins on the module. You can solder pins to the unpopulated pads; just remember the pinout provided in this guide to connect to the right pins of your board. + +![Connection Guide Solder Pads](assets/connection-guide-knob-jumper.png) + +### Daisy-Chaining Multiple Modulinos + +Regardless of whether you connect the first Modulino via QWIIC or through the solderable pins, you can still take advantage of the extra QWIIC connector to daisy-chain additional modules. Each Modulino includes two QWIIC connectors wired in parallel, allowing you to connect one module to the next in a chain. As long as each module is configured with a unique I²C address, they can all communicate on the same bus. This approach keeps your setup clean, modular, and expandable without adding extra wiring complexity. + +![Modulino Wiring Options](assets/connection-guide-knob-qwiic-chain.png) + +***The number of modules you can connect will depend on what modules you are chaining together, as this system allows for multiple sensors from different manufacturers to be added. Also, the cables you use for these connections will play a significant role in the setup's performance. Ensure your cables are properly connected and capable of handling the required data transfer. + +Each module should have a unique address on a chain if you plan to address them individually. Later in this article we teach how to [change the address](#how-to-change-i2c-address). Multiple modules with the same address will cause conflicts on the I²C bus and will not allow you to address them individually.*** + +## How To Use Your Modulino + +### Installing The Modulino Library + +To program your Modulino it is recommended you use the official `Modulino` micropython library available [here](https://github.com/arduino/arduino-modulino-mpy). The library is fully compatible with the **Arduino Lab for MicroPython**. + +For information on installing the **Arduino Lab for MicroPython** please visit our [page](https://docs.arduino.cc/micropython/first-steps/install-guide/). + +The `Modulino` library is not available by default on MicroPython devices hence installation is needed. + +To simplify the process the [MicroPython Package Installer](https://github.com/arduino/lab-micropython-package-installer/releases) is recommended as it will provide a graphical interface to guide the installation. + +After installation, you should now be able to: + +1. Open the tool. +2. Plug in your board to the computer. +![USB Connection](assets/mp-usb-connection.png) + +If the board does not appear in the Detected Boards section, click Reload. If the board is still undetected, ensure no other programs (e.g., a code editor) are using the board's COM port. + +1. Search for the `Modulino` package by filling in the text box on the search feature. +2. Click Install and wait for the installation confirmation. +3. Disconnect the board from the tool before returning to your code editor to avoid conflicts due to a busy COM port. + +![Package Installer Overview](assets/package-installer-overview.png) + +The module should now be includable in your program using: +```python +from modulino import ModulinoThermo +``` + +### Getting Knob Data + +Data can be obtained from the sensor using the `Modulino` package. + +For the **Knob** there is a crucial function: + +- `ModulinoKnob` is imported from the `modulino` package to interact with the **Modulino Knob** sensor. +- `sleep` is imported from the `time` module to introduce delays between readings. +- `.update` - Check for new available data from the sensor and execute callback functions to react to the button press or rotation. +- `knob.value` lets you set the sensor initial value from which the encoder rotation will start increasing or decreasing. +- `knob.range` lets you set the minimum and maximum possible value of the encoder output. +- `knob.on_press` this function establish what will happen when the knob button is pressed. +- `knob.on_release` calls the `on_release()` function when the knob button is released. +- `knob.on_rotate_clockwise` prints the rotation value when the knob is turned clockwise. +- `knob.on_rotate_counter_clockwise` prints the rotation value when the knob is turned counter-clockwise. +- `knob.update()` function is called continuously checking for knob new values. If the rotation or button state is changed, it will print a message on the Terminal. +By default the Modulino library uses ```Wire1``` if your board model has a different pinout for the dedicated I²C pins you might have to edit it as instructed [here](https://github.com/arduino/arduino-modulino-mpy/tree/main/docs#%E2%84%B9%EF%B8%8F-using-3rd-party-boards). More information on **Wire** can be found [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/). + + +Here is an example of how to implement this function to acquire data: + +```python +from modulino import ModulinoKnob +from time import sleep + +knob = ModulinoKnob() +knob.value = 0 # (Optional) Set an initial value +knob.range = (-10, 10) # (Optional) Set a value range + +def on_release(): + knob.reset() + print("🔘 Released! Knob's value was reset.") + +knob.on_press = lambda: print("🔘 Pressed!") +knob.on_release = on_release +knob.on_rotate_clockwise = lambda steps, value: print(f"🎛️ Rotated {steps} steps clockwise! Value: {value}") +knob.on_rotate_counter_clockwise = lambda steps, value: print(f"🎛️ Rotated {steps} steps counter clockwise! Value: {value}") + +while True: + if(knob.update()): + print("👀 Knob value or state changed!") + + sleep(0.1) +``` + +The code can be easily adapted to trigger actions at certain rotation thresholds or to log data for analysis. + +### How To Change Address + +A sketch is also available included with the library named `AddressChanger` and also available [here](https://github.com/arduino/arduino-modulino-mpy/blob/main/examples/change_address.py). This sketch changes the I2C address at a software level on the Module's microcontroller. + +- Connect the module to your board via I2C, ensuring no other modules are in the chain. +- Run the script in a MicroPython environment. +- Follow the on-screen instructions (REPL) to select the device and enter a new address. Valid I²C addresses range from 0x08 to 0x77 (7-bit values in hexadecimal format, e.g., 0x42). +- The script will attempt to change the address and confirm success. + +To keep track of the address in use, the module has a white rectangle on the back. Feel free to use this to write the address that was chosen. + +When using a custom address in your MicroPython sketch, you'll need to specify this address when creating the module object. For example: +```python +knob_module = ModulinoKnob(address=0x45) # Replace 0x45 with your specific address +``` + +## Conclusion + +The **Modulino Knob** provides a simple solution for UI interface, volume control or rotational measurement in any project. With its **I2C interface**, compact **Modulino form factor**, and **robustness**, it seamlessly integrates into both beginner and advanced applications. + +By leveraging the **Modulino package**, users can quickly access sensor data and implement functionalities such as **user interface control and angle measurement tool**. With just a few lines of code, you can start **controlling your projects**, making it easier than ever to bring intelligent sensing to your applications. + +## What Next? + +After mastering the basics of the Modulino Knob, try these project ideas: +- Calculate what is the encoder rotation angle per step to convert the arbitrary output into a rotation angle output. +- Control the Arduino onboard LED with the press of the knob button. +- Use the Modulino Knob to control the navigation on a UI display on an LCD or OLED screen. \ No newline at end of file diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/assets/BlockDiagramMovement.png b/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/assets/BlockDiagramMovement.png new file mode 100644 index 0000000000..95f6ba7ba9 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/assets/BlockDiagramMovement.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/assets/I2CTag.png b/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/assets/I2CTag.png new file mode 100644 index 0000000000..9d9b7b0f72 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/assets/I2CTag.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/assets/IMUMec.png b/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/assets/IMUMec.png new file mode 100644 index 0000000000..b1d4a7db35 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/assets/IMUMec.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/assets/Modulino_Movement_Power_Tree.png b/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/assets/Modulino_Movement_Power_Tree.png new file mode 100644 index 0000000000..fe775335ff Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/assets/Modulino_Movement_Power_Tree.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/assets/MovementPinouts.png b/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/assets/MovementPinouts.png new file mode 100644 index 0000000000..d6e5f561df Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/assets/MovementPinouts.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/assets/VDDIO.png b/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/assets/VDDIO.png new file mode 100644 index 0000000000..026eee0497 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/assets/VDDIO.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/assets/featuredMov.png b/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/assets/featuredMov.png new file mode 100644 index 0000000000..636d111be4 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/assets/featuredMov.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/datasheet.md b/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/datasheet.md new file mode 100644 index 0000000000..d6aed4661d --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-movement/datasheet/datasheet.md @@ -0,0 +1,272 @@ +--- +identifier: ABX00101 +title: Arduino® Modulino® Movement +type: maker +author: Pedro Sousa Lima +--- + +![](assets/featuredMov.png) + +# Description + +The Modulino® Movement, featuring the LSM6DSOXTR sensor, measures acceleration and rotation providing comprehensive data for motion detection applications. It’s ideal for projects involving gesture recognition, pedometers, and vibration monitoring. + +# Target Areas + +Maker, beginner, education + +# Contents +## Application Examples + +Below are some project ideas focused on the Modulino® Movement module and its built-in LSM6DSOXTR sensor: + +- **Gesture Recognition:** Harness the 6-axis motion data (accelerometer + gyroscope) to detect custom gestures. You can create interactive controls for games, user interfaces, or home automation—triggering actions when certain patterns (e.g., wrist flicks or device shakes) are recognized. + +- **Step Counter or Pedometer:** Use the accelerometer data to count steps accurately in wearable or fitness-related projects. Log daily movements or design health-oriented applications that notify users of their activity progress. + +- **Vibration Monitoring:** Monitor vibrations in appliances, machinery, or vehicles using the sensor’s high-sensitivity accelerometer. Detect anomalies, implement predictive maintenance strategies, or create alert systems for sudden impact or shock events. + +- **Orientation and Tilt Control:** Measure real-time orientation in space. Ideal for creating tilt-based controls in interactive art installations, DIY game controllers, or robotics projects that respond to angular displacement. + +- **IMU-based Stabilization:** Leverage both gyroscope and accelerometer data for advanced applications like robotics or drones, where real-time inertial measurements are used to maintain stability and smooth motion control. + +
+ +## Features + +- Incorporates the LSM6DSOXTR sensor to measure acceleration and rotation. +- Communicates via I2C (Qwiic connector) or SPI (optional). +- Powered by 3.3 V from the Qwiic/I2C bus; supports 1.71 V–3.6 V sensor supply range. +- Designed with an additional 1×10 header for advanced signals and a cuttable jumper to isolate VDDIO if needed. +- Ideal for motion-detection and wearable applications (gesture recognition, pedometers, vibration monitoring). + +### Contents + +| **SKU** | **Name** | **Purpose** | **Quantity** | +| -------- | -------------------- | -------------------------------------- | ------------ | +| ABX00101 | Modulino® Movement | Measure acceleration and rotation | 1 | +| | I2C Qwiic cable | Compatible with the Qwiic standard | 1 | + + + + +## Related Products + +- *SKU: ASX00027* - [Arduino® Sensor Kit](https://store.arduino.cc/products/arduino-sensor-kit) + +- *SKU: K000007* - [Arduino® Starter Kit](https://store.arduino.cc/products/arduino-starter-kit-multi-language) + +- *SKU: AKX00026* - [Arduino® Oplà IoT Kit](https://store.arduino.cc/products/opla-iot-kit) + +## Rating + +### Recommended Operating Conditions + +-Sensor supply range: 1.71 V – 3.6 V +-Powered at 3.3 V through the Qwiic interface (in accordance with the Qwiic standard) +-Operating temperature: –40 °C to +85 °C + +**Typical current consumption:** +Accelerometer: ~170 µA +Gyroscope: ~0.55 mA + +## Power Tree +The power tree for the modulino can be consulted below: + +![Modulino® Movement Power Tree](assets/Modulino_Movement_Power_Tree.png) + +## Block Diagram +This module is designed to be placed on an I2C bus, allowing the on-board LSM6DSOXTR sensor to communicate with a host microcontroller via I2C or, optionally, SPI. + +![Modulino® Movement block diagram](assets/BlockDiagramMovement.png) + +## Functional Overview +The Modulino® Movement node uses the LSM6DSOXTR sensor for 3‑axis acceleration and 3‑axis gyroscopic measurements. It can detect motion, orientation. Data is accessed through I2C (via the Qwiic connector at 3.3 V) or SPI (through the additional header). + +### Technical Specifications +| **Specification** | **Details** | +| ----------------------- | ------------------------------------------------------------------------ | +| **Sensor** | LSM6DSOXTR | +| **Supply Voltage** | Min: 1.71 V, Max: 3.6 V | +| **Power Consumption** | Accel: 170 µA, Gyro: 0.55 mA | +| **Range (Gyro)** | ±125 dps to ±2000 dps | +| **Accuracy** | Accel: ±20 mg, Gyro: ±1 dps | +| **Resolution** | Accel: 0.061 mg/LSB to 0.488 mg/LSB; Gyro: 4.375 mdps/LSB to 70 mdps/LSB | +| **Communication** | SPI, I2C, MIPI I3CSM | + +### Pinout + +![Pinout Overview](assets/MovementPinouts.png) + +**Qwiic / I2C (1×4 Header)** +| **Pin** | **Function** | +|---------|-------------------| +| GND | Ground | +| 3.3 V | Power Supply (3.3 V) | +| SDA | I2C Data | +| SCL | I2C Clock | + +These pads and the Qwiic connectors share the same I2C bus. You can optionally solder header pins here. + +**Additional 1×10 Header (LSM6DSOXTR Signals)** +| **Pin** | **Function** | +|---------|------------------------------| +| VDDIO | 3.3 V (cuttable jumper) | +| GND | Ground | +| INT1 | Interrupt 1 (Sensor) | +| INT2 | Interrupt 2 (Sensor) | +| SDO/SA0 | SPI Data Out / I2C Address | +| SDX | SPI Data X | +| SCX | SPI Clock X | +| CS | SPI Chip Select | +| SDOAUX | Auxiliary Output | +| OCSAUX | Auxiliary Output | + +**Note:** By cutting its solder jumper, you can isolate **VDDIO** from 3.3 V if needed. + +![Optional jumper](assets/VDDIO.png) + + +### Power Specifications +- **Nominal operating voltage:** 3.3 V via Qwiic +- **Sensor voltage range:** 1.71 V–3.6 V + +### Mechanical Information +![Modulino® Movement Mechanical Information](assets/IMUMec.png) +- Board dimensions: 41 mm × 25.36 mm +- Thickness: 1.6 mm (±0.2 mm) +- Four mounting holes (Ø 3.2 mm) + - Hole spacing: 16 mm vertically, 32 mm horizontally + +### I2C Address Reference +| **Board Silk Name** | **Sensor** | **Modulino I2C Address (HEX)** | **Editable Addresses (HEX)** | **Hardware I2C Address (HEX)** | +|---------------------|--------------|--------------------------------|------------------------------------|--------------------------------| +| MODULINO MOVEMENT | LSM6DSOXTR | 0x6A | 0x6A, 0x6B (via solder jumper) | 0x6A & 0x7E | + + **Note:** + - By default, you use **0x6A** in your code. + - The “Hardware I2C Address” might appear when scanning the bus. + - You can flip the address to **0x6B** by bridging or cutting the relevant solder jumper. + - A white rectangle on the bottom silk allows you to note a custom address. +![Blank silk for identification](assets/I2CTag.png) + +## Device Operation +The Modulino® Movement node acts as an I2C target device on the Qwiic bus. Simply connect it via a Qwiic cable to the 3.3 V I2C interface of your microcontroller. If desired, SPI signals can be used instead via the additional header. + +### Getting Started +Use any standard Arduino workflow—desktop IDE or Arduino Cloud Editor. Libraries are available to simplify reading the LSM6DSOXTR sensor outputs (acceleration, gyroscope). Ensure your controller and this node share the same 3.3 V reference when using the Qwiic connection. + +# Certifications + +## Certifications Summary + +| **Certification** | **Status** | +|:-----------------:|:----------:| +| CE/RED (Europe) | Yes | +| UKCA (UK) | Yes | +| FCC (USA) | Yes | +| IC (Canada) | Yes | +| RoHS | Yes | +| REACH | Yes | +| WEEE | Yes | + +## Declaration of Conformity CE DoC (EU) + +

We declare under our sole responsibility that the products above are in conformity with the essential requirements of the following EU Directives and therefore qualify for free movement within markets comprising the European Union (EU) and European Economic Area (EEA).

+ +## Declaration of Conformity to EU RoHS & REACH 211 01/19/2021 + +

Arduino boards are in compliance with RoHS 2 Directive 2011/65/EU of the European Parliament and RoHS 3 Directive 2015/863/EU of the Council of 4 June 2015 on the restriction of the use of certain hazardous substances in electrical and electronic equipment.

+ +| Substance | **Maximum limit (ppm)** | +|----------------------------------------|-------------------------| +| Lead (Pb) | 1000 | +| Cadmium (Cd) | 100 | +| Mercury (Hg) | 1000 | +| Hexavalent Chromium (Cr6+) | 1000 | +| Poly Brominated Biphenyls (PBB) | 1000 | +| Poly Brominated Diphenyl ethers (PBDE) | 1000 | +| Bis(2-Ethylhexyl) phthalate (DEHP) | 1000 | +| Benzyl butyl phthalate (BBP) | 1000 | +| Dibutyl phthalate (DBP) | 1000 | +| Diisobutyl phthalate (DIBP) | 1000 | + +Exemptions: No exemptions are claimed. + +

Arduino Boards are fully compliant with the related requirements of European Union Regulation (EC) 1907 /2006 concerning the Registration, Evaluation, Authorization and Restriction of Chemicals (REACH). We declare none of the SVHCs (https://echa.europa.eu/web/guest/candidate-list-table), the Candidate List of Substances of Very High Concern for authorization currently released by ECHA, is present in all products (and also package) in quantities totaling in a concentration equal or above 0.1%. To the best of our knowledge, we also declare that our products do not contain any of the substances listed on the "Authorization List" (Annex XIV of the REACH regulations) and Substances of Very High Concern (SVHC) in any significant amounts as specified by the Annex XVII of Candidate list published by ECHA (European Chemical Agency) 1907 /2006/EC.

+ +## Conflict Minerals Declaration + +

As a global supplier of electronic and electrical components, Arduino is aware of our obligations with regard to laws and regulations regarding Conflict Minerals, specifically the Dodd-Frank Wall Street Reform and Consumer Protection Act, Section 1502. Arduino does not directly source or process conflict minerals such as Tin, Tantalum, Tungsten, or Gold. Conflict minerals are contained in our products in the form of solder or as a component in metal alloys. As part of our reasonable due diligence, Arduino has contacted component suppliers within our supply chain to verify their continued compliance with the regulations. Based on the information received thus far we declare that our products contain Conflict Minerals sourced from conflict-free areas.

+ +## FCC Caution + +Any Changes or modifications not expressly approved by the party responsible for compliance could void the user’s authority to operate the equipment. + +This device complies with part 15 of the FCC Rules. Operation is subject to the following two conditions: + +1. This device may not cause harmful interference. +2. This device must accept any interference received, including interference that may cause undesired operation. + +**FCC RF Radiation Exposure Statement:** + +1. This Transmitter must not be co-located or operating in conjunction with any other antenna or transmitter. +2. This equipment complies with RF radiation exposure limits set forth for an uncontrolled environment. +3. This equipment should be installed and operated with a minimum distance of 20 cm between the radiator & your body. + +**Note:** This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures: + +- Reorient or relocate the receiving antenna. +- Increase the separation between the equipment and receiver. +- Connect the equipment into an outlet on a circuit different from that to which the receiver is connected. +- Consult the dealer or an experienced radio/TV technician for help. + +English: +User manuals for license-exempt radio apparatus shall contain the following or equivalent notice in a conspicuous location in the user manual or alternatively on the device or both. This device complies with Industry Canada license-exempt RSS standard(s). Operation is subject to the following two conditions: + +1. this device may not cause interference. +2. this device must accept any interference, including interference that may cause undesired operation of the device. + +French: +Le présent appareil est conforme aux CNR d’Industrie Canada applicables aux appareils radio exempts de licence. L’exploitation est autorisée aux deux conditions suivantes: + +1. l’appareil nedoit pas produire de brouillage. +2. l’utilisateur de l’appareil doit accepter tout brouillage radioélectrique subi, même si le brouillage est susceptible d’en compromettre le fonctionnement. + +**IC SAR Warning:** + +English: +This equipment should be installed and operated with a minimum distance of 20 cm between the radiator and your body. + +French: +Lors de l’installation et de l’exploitation de ce dispositif, la distance entre le radiateur et le corps est d’au moins 20 cm. + +**Important:** The operating temperature of the EUT can’t exceed 85 ℃ and shouldn’t be lower than -40 ℃. + +Hereby, Arduino S.r.l. declares that this product is in compliance with essential requirements and other relevant provisions of Directive 2014/53/EU. This product is allowed to be used in all EU member states. + +# Company Information + +| Company name | Arduino SRL | +|-----------------|-----------------------------------------------| +| Company Address | Via Andrea Appiani, 25 - 20900 MONZA（Italy) | + +# Reference Documentation + +| Ref | Link | +| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Arduino IDE (Desktop) | [https://www.arduino.cc/en/Main/Software](https://www.arduino.cc/en/Main/Software) | +| Arduino Courses | [https://www.arduino.cc/education/courses](https://www.arduino.cc/education/courses) | +| Arduino Documentation | [https://docs.arduino.cc/](https://docs.arduino.cc/) | +| Arduino IDE (Cloud) | [https://create.arduino.cc/editor](https://create.arduino.cc/editor) | +| Cloud IDE Getting Started | [https://docs.arduino.cc/cloud/web-editor/tutorials/getting-started/getting-started-web-editor](https://docs.arduino.cc/cloud/web-editor/tutorials/getting-started/getting-started-web-editor) | +| Project Hub | [https://projecthub.arduino.cc/](https://projecthub.arduino.cc/) | +| Library Reference | [https://github.com/arduino-libraries/](https://github.com/arduino-libraries/) | +| Online Store | [https://store.arduino.cc/](https://store.arduino.cc/) | + +# Revision History + +| **Date** | **Revision** | **Changes** | +| ---------- | ------------ | ------------------------------------------------------ | +| 11/07/2024 | 1 | First release | + diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/essentials.md b/content/hardware/11.accessories/modulinos/modulino-movement/essentials.md new file mode 100644 index 0000000000..762e36d575 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-movement/essentials.md @@ -0,0 +1,8 @@ + + + + +This library allows you to communicate with the Arduino Modulino® nodes. + + + diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/features.md b/content/hardware/11.accessories/modulinos/modulino-movement/features.md new file mode 100644 index 0000000000..3c5c9c2428 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-movement/features.md @@ -0,0 +1,12 @@ + +The Modulino® Movement module incorporates a 6-axis sensor for measuring both acceleration and rotation. It is compatible with the Arduino UNO R4 WiFi or any board with a Qwiic interface, enabling you to build motion-sensing projects without complicated wiring. + + + + + This module includes instructions for projects that use the Modulino® nodes, giving you a quick start for motion-based applications. The built-in sensor measures acceleration and gyro data, perfect for experimenting with orientation and movement detection. + + + The Modulino® Movement module connects via Qwiic cables to your UNO R4 WiFi or other compatible boards. For projects where Qwiic isn’t available, solderable pins allow direct wiring, so you never miss a connection. + + diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/image.svg b/content/hardware/11.accessories/modulinos/modulino-movement/image.svg new file mode 100644 index 0000000000..a6fe77668c --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-movement/image.svg @@ -0,0 +1,736 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/product.md b/content/hardware/11.accessories/modulinos/modulino-movement/product.md new file mode 100644 index 0000000000..56809444a7 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-movement/product.md @@ -0,0 +1,11 @@ +--- +title: Modulino® Movement +url_shop: https://store.arduino.cc/products/modulino-movement +url_guide: https://courses.arduino.cc/plugandmake +primary_button_url: https://courses.arduino.cc/plugandmake +primary_button_title: Get Started +certifications: [] +sku: [ABX00101] +--- + +Measure acceleration and rotation with ease thanks to the integrated 6-axis sensor (LSM6DSOXTR). Perfect for robotics, wearables, or motion-driven applications. Compatible with the Arduino UNO R4 WiFi or any Qwiic-enabled board, and features optional solderable pins if you prefer direct wiring. diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tech-specs.md b/content/hardware/11.accessories/modulinos/modulino-movement/tech-specs.md new file mode 100644 index 0000000000..1db25a29df --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-movement/tech-specs.md @@ -0,0 +1 @@ +Here you will find the technical specifications for the Modulino® Movement. \ No newline at end of file diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tech-specs.yml b/content/hardware/11.accessories/modulinos/modulino-movement/tech-specs.yml new file mode 100644 index 0000000000..a6be444cc8 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-movement/tech-specs.yml @@ -0,0 +1,11 @@ +Node: + Name: Modulino Movement + SKU: ABX00101 + Board recommended: Arduino® UNO R4 WiFi (ABX00087) + Communications: I2C (over Qwiic connector or solderable pin) + Operational voltage: 3.3V + Sensor: + LSM6DSOXTR: 0x6A (address can change via software) + +Other accessories: + Qwiic cables: 1x diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/I2C-change-movement.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/I2C-change-movement.png new file mode 100644 index 0000000000..a3c9a51894 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/I2C-change-movement.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/IDE-Left-Tab.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/IDE-Left-Tab.png new file mode 100644 index 0000000000..c7bb86575e Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/IDE-Left-Tab.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/Modulino_Movement_Power_Tree.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/Modulino_Movement_Power_Tree.png new file mode 100644 index 0000000000..fe775335ff Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/Modulino_Movement_Power_Tree.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/MovementPinouts.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/MovementPinouts.png new file mode 100644 index 0000000000..9dd2cf39e3 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/MovementPinouts.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/connection-guide-movement-jumper.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/connection-guide-movement-jumper.png new file mode 100644 index 0000000000..5381b10c45 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/connection-guide-movement-jumper.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/connection-guide-movement-qwiic-chain.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/connection-guide-movement-qwiic-chain.png new file mode 100644 index 0000000000..c6c89cc127 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/connection-guide-movement-qwiic-chain.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/connection-guide-movement-qwiik.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/connection-guide-movement-qwiik.png new file mode 100644 index 0000000000..331a2f823c Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/connection-guide-movement-qwiik.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/connection-guide-movement.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/connection-guide-movement.png new file mode 100644 index 0000000000..c21dcc1db7 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/connection-guide-movement.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/library-dependencies.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/library-dependencies.png new file mode 100644 index 0000000000..d25bd9720b Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/library-dependencies.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/library-install.gif b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/library-install.gif new file mode 100644 index 0000000000..16f396c353 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/library-install.gif differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/schematic.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/schematic.png new file mode 100644 index 0000000000..a804960788 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/assets/schematic.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/content.md b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/content.md new file mode 100644 index 0000000000..4486d27e6b --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/content.md @@ -0,0 +1,298 @@ +--- +title: "How To Use The Modulino Movement" +description: "Learn how to get the most out of your Modulino Movement." +tags: + - Modulino + - QWIIC + - I2C +author: 'Pedro Sousa Lima' +hardware: + - hardware/11.modulinos/modulinos/modulino-movement +software: + - ide-v2 + - web-editor +--- + +The Modulino Movement is a modular sensor that measures acceleration and angular velocity, making it perfect to add motion sensing to your projects! The Modulino form factor is shaped with two QWIIC connectors and the I²C protocol integration, allowing the connection and programming of multiple modulinos in a very simple way. In addition to the QWIIC's connectors, the Modulinos also expose solderable pins that can be used in multiple ways and make them compatible with boards that are not QWIIC compatible. + +# General Characteristics + +The Modulino Movement is capable of measuring acceleration and angular velocity. Take a look at the following table to know more about its measuring ranges: + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|---------------------------------|-------------------------|---------|---------|---------|----------| +| **Accelerometer Range** | Configurable Full Scale | ±2 | ±8 | ±16 | g | +| **Gyroscope Range** | Configurable Full Scale | ±125 | ±1000 | ±2000 | dps | +| **Accelerometer Sensitivity** | @ ±2g | 0.061 | - | - | mg/LSB | +| **Gyroscope Sensitivity** | @ ±125dps | 4.375 | - | - | mdps/LSB | +| **Accelerometer Noise Density** | High-performance mode | - | 70 | - | µg/√Hz | +| **Gyroscope Noise Density** | High-performance mode | - | 3.8 | - | mdps/√Hz | +| **Temperature Sensor Range** | - | -40 | - | +85 | °C | +| **FIFO Buffer** | - | - | 9 | - | KB | +| **Sampling Rate** | Output Data Rate | 1.6 | - | 6664 | Hz | + +## Sensor Details + +The LSM6DSOXTR sensor from STMicroelectronics is the core component of this module. This 6-axis IMU (accelerometer and gyroscope) natively supports digital communication (I²C and SPI), meaning it connects directly to the I²C bus on the module without requiring additional conversion circuitry. +The default address for the Module is: + +| Modulino I²C Address | Hardware I²C Address | +|----------------------|----------------------| +| 0x6A or 0x7E | 0x6A or 0x7E | + +When scanning for I²C address on the bus, you might find the modulino using the **Hardware I²C Address**. However, you should always use the **Modulino I²C Address** when using the official Modulino library. +Later in this article we teach how to [change the address](#how-to-change-i2c-address). + +## Pinout + +The pinout for the Modulino Movement is shown below. Please note that the exposed solderable pins are directly connected to the QWIIC connectors using the same I²C interface. + +![Arduino Movement Pinout](assets/MovementPinouts.png) + +Depending on the board connected to the modulino, the I²C pin names to program it may differ. Please check the [board tutorials](https://docs.arduino.cc/hardware/) on your modulino's compatible board or the [Modulino library](https://github.com/arduino-libraries/Modulino/tree/main/docs) to learn more. + +### 1x10 Header (LSM6DSOXTR) +| Pin | Function | +|---------|----------------------| +| VDDIO | 3.3 V (cuttable) | +| GND | Ground | +| INT1 | Interrupt 1 (Sensor) | +| INT2 | Interrupt 2 (Sensor) | +| SDO/SA0 | SPI Data Out | +| SDX | SPI Data X | +| SCX | SPI Clock X | +| CS | SPI Chip Select | +| SDOAUX | Auxiliary Output | +| OCSAUX | Auxiliary Output | + +### 1x4 Header (I2C) +| Pin | Function | +|-------|--------------| +| GND | Ground | +| 3.3 V | Power Supply | +| SDA | I2C Data | +| SCL | I2C Clock | + +## Power Specifications + +The board is typically powered by +3.3 VDC when using the QWIIC interface as per the I²C standard. + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|-----------------------------------------------|--------------------------------|---------|---------|---------|------| +| Supply Voltage | - | 1.71 | 3.3 (QWIIC) | 3.6 | V | +| I/O Voltage | - | 1.62 | - | 3.6 | V | +| Gyro + Accel Current (High Performance Mode) | Both sensors active | - | 0.55 | - | mA | +| Accelerometer Current (High Performance Mode) | - | - | 170 | - | µA | +| Accelerometer Current (Low Power Mode) | ODR = 50 Hz | - | 26 | - | µA | +| Accelerometer Current (Ultra-Low Power Mode) | ODR = 50 Hz | - | 9.5 | - | µA | + +The module includes a power LED that draws 1 mA and turns on as soon as it is powered. J1 (Qwiic connector), J2 (Qwiic connector), and the headers all share the same power branch. The power distribution of the module is therefore as follows: + +![Power Tree Modulino Movement](assets/Modulino_Movement_Power_Tree.png) + +## Schematic + +The Modulino Movement uses a simple circuit, as shown in the schematic below: + +![Full Schematic Modulino Movement](assets/schematic.png) + +The main component is the **LSM6DSOXTR** sensor (U1), which handles both acceleration and gyroscope measurements, as well as I²C communication. + +You can connect to the I²C pins (SDA and SCL) using either the **QWIIC connectors** (J1 and J2, this is the recommended method) or the **solderable pins** (J4). The board runs on **3.3V**, which comes from the QWIIC cable or the **3V3 pin** on J4. + +There's also a small power indicator LED that lights up when the board is on. + +Some options for customizing the module's features via onboard solder jumpers are available: + +### **VDDIO Independence:** +- By default, **VDDIO is connected to +3V3**. +- To make **VDDIO independent**, cut the corresponding solder jumper. + +### SPI Mode Selection: +- The LSM6DSOXTR supports both **3-wire and 4-wire SPI**. +- You can configure SPI communication and connect additional sensors by cutting or soldering the appropriate jumpers. Please take a look at the IMU's datasheet for more information. + +You can grab the full schematic and PCB files from the [Modulino Movement](https://docs.arduino.cc/hardware/modulinos/modulino-movement) product page. + +# How To Connect Your Modulino + +The easiest and most reliable way to connect your Modulino is through the QWIIC Connect System. It's plug-and-play, uses standard I²C, and makes it easy to join multiple modules. If your board supports QWIIC, this is the recommended way to go. Note that the dedicated I²C pins will differ from board to board meaning it is always a good idea to check your specific model. + +If your board doesn't have a QWIIC connector, you can still access the same I²C bus and power the module using the solderable header pads just make sure you wire it to 3.3V and match the I²C pinout. + +![Modulino Wiring Options QWIIC(A - recommended) and Header(B)](assets/connection-guide-movement.png) + +## QWIIC Connector + +Whenever available, the **QWIIC Connect System** is the preferred method. Connecting to the Modulino is extremely simple, just use a standard QWIIC cable to connect your board to either of the QWIIC connectors on the Modulino. Because the cable and connectors are polarized, there is no need to worry about accidentally swapping connections. + +QWIIC is a plug-and-play I²C Connect System that uses standardized 4-pin connectors: +- GND +- 3.3V +- SDA (Data) +- SCL (Clock) + +![Connection Guide QWIIC](assets/connection-guide-movement-qwiik.png) + +The Modulino features two QWIIC connectors, which are internally connected in parallel. This means you can daisy-chain multiple modules easily by connecting additional QWIIC cables between them. + +When connecting multiple I²C devices, address conflicts may occur if two or more devices share the same default I²C address. The Modulino addresses this potential issue by allowing you to select a different address through a simple hardware modification. We cover this process in detail in the [**Changing I²C Address**](#changing-i2c-address) section, enabling you to integrate multiple identical modules or different devices that share the same default address in your project. + +## Solderable Header + +When QWIIC is not available, you can use the exposed solderable pins on the module. You can solder pins to the unpopulated pads; just remember the pinout provided in this guide to connect to the right pins of your board. + +![Connection Guide Solder Pads](assets/connection-guide-movement-jumper.png) + +## Daisy-Chaining Multiple Modulinos + +Regardless of whether you connect the first Modulino via QWIIC or through the solderable pins, you can still take advantage of the extra QWIIC connector to daisy-chain additional modules. Each Modulino includes two QWIIC connectors wired in parallel, allowing you to connect one module to the next in a chain. As long as each module is configured with a unique I²C address, they can all communicate on the same bus as long as you select the correct I²C pins depending on your board. This approach keeps your setup clean, modular, and expandable without adding extra wiring complexity. + +![Modulino Wiring Options](assets/connection-guide-movement-qwiic-chain.png) + +***The number of modules you can connect will depend on what modules you are chaining together, as this system allows for multiple sensors from different manufacturers to be added. Also, the cables you use for these connections will play a significant role in the setup's performance. Ensure your cables are correctly connected and capable of handling the required data transfer. + +Each module should have a unique address on a chain if you plan to address them individually. Later in this article we teach how to [change the address](#how-to-change-i2c-address). Multiple modules with the same address will cause conflicts on the I²C bus and will not allow you to address them individually.*** + +## Changing I2C Address + +The Modulino Movement can be configured to use an alternative I2C address (0x6B) instead of the default address (0x6A). To change the address, follow these steps carefully: + +1. Disconnect all power from the module +2. Locate the address selection solder jumpers on the back of the board +3. Cut the trace on the jumper marked **Default** (0x6A) +4. Solder closed the jumper marked **0x6B** + +After completing these modifications, your module will use the new address (0x6B) when powered on again. + +**IMPORTANT**: Ensure the module remains unpowered during this entire process. Never have both jumpers closed simultaneously when power is applied, as this will create a short circuit between power and ground that could damage your module. + +![I2C Address Change](assets/I2C-change-movement.png) + +When using a custom address in your sketch, you'll need to specify this address when creating the module object. For example: +```arduino +ModulinoMovement movement(0x7E); +``` + + + +# How To Use Your Modulino + +## Installing The Modulino Library + +You need the official Modulino library available [here](https://docs.arduino.cc/libraries/modulino/) to use the Modulino Movement. With the Arduino IDE you get some tools that make adding a library easier. To learn how to install the IDE please visit our [page](https://www.support.arduino.cc/hc/en-us/articles/360019833020-Download-and-install-Arduino-IDE). + +After opening the IDE, a tab should be visible on the left. Press the book icon for "library" as highlighted in the image. + +![IDE Library Tab](assets/IDE-Left-Tab.png) + +You can now look for the library ```Modulino``` by filling in the ```Filter your search``` textbox. +A prompt might appear saying that additional dependencies are required. This is not a problem, as they will be automatically added when you confirm the prompt. + +![Add Dependencies Prompt](assets/library-dependencies.png) + +The process should look like this: + +![Library Install](assets/library-install.gif) + +A message will appear after the installation is successful. + +## Getting Acceleration Data + +Getting data from the sensor is fairly simple using the ```Modulino``` library. For the **Modulino Movement** there are four important functions: +- ```update()```: Updates the sensor readings. +- ```getX()```: Retrieves the acceleration value on the **X-axis** in **g**. +- ```getY()```: Retrieves the acceleration value on the **Y-axis** in **g**. +- ```getZ()```: Retrieves the acceleration value on the **Z-axis** in **g**. +- ```getRoll()```: Retrieves the angular rotation around the X-axis in **dps**. +- ```getPitch()```: Retrieves the angular rotation around the Y-axis in **dps**. +- ```getYaw()```: Retrieves the angular rotation around the Z-axis in **dps**. +- ```Modulino.begin();```: By default the Modulino library uses ```Wire1``` if your connection is in a different Wire you will have to edit it, check [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/) (by default the Modulino library uses ```Wire1``` if your board model has a different pinout for the dedicated I²C pins you might have to edit it. More information on **Wire** can be found [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/)) for the library's hardware compatibility. More information on **Wire** can be found [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/). + +Here is an example sketch of how to implement these functions to acquire data and show it using the serial monitor: + +```arduino +#include "Arduino_Modulino.h" + +// Create a ModulinoMovement +ModulinoMovement movement; + + +float x, y, z; +float roll, pitch, yaw; + + +void setup() { + Serial.begin(9600); + // Initialize Modulino I2C communication + Modulino.begin(); + // Detect and connect to movement sensor module + movement.begin(); +} + +void loop() { + // Read new movement data from the sensor + movement.update(); + + // Get acceleration and gyroscope values + x = movement.getX(); + y = movement.getY(); + z = movement.getZ(); + roll = movement.getRoll(); + pitch = movement.getPitch(); + yaw = movement.getYaw(); + + // Print acceleration values + Serial.print("A: "); + Serial.print(x, 3); + Serial.print(", "); + Serial.print(y, 3); + Serial.print(", "); + Serial.print(z, 3); + + // Print divider between acceleration and gyroscope + Serial.print(" | G: "); + + // Print gyroscope values + Serial.print(roll, 1); + Serial.print(", "); + Serial.print(pitch, 1); + Serial.print(", "); + Serial.println(yaw, 1); + + delay(200); +} +``` + +The code example provided shows how to initialize the sensor, read the acceleration data, and display it on the serial monitor. The data is continuously updated, showing the current acceleration values in real time. +It can be easily adapted to trigger actions at certain movement thresholds or to detect specific motion patterns in your projects. + +### Troubleshooting + +#### Sensor Not Reachable +If your Modulino's power LED isn't on or the sensor isn't responsive, first check that the board is properly connected: +- Ensure both the board and the Modulino are connected to your computer, and that the power LEDs on both are lit. +- If the issue persists, make sure the Qwiic cable is properly clicked into place. + +#### Library Not Installed Properly +If you encounter an issue with the `#include "modulino.h"` command, verify that the Modulino library is correctly installed: +- Check your IDE to ensure the library is installed and up-to-date. +- Re-install the library through the Library Manager. + +#### Inaccurate Values +If the sensor values are not accurate, make sure: +- The sensor is not placed on an unstable surface that might cause unwanted vibrations. +- All exposed electronics are not touching any conductive surfaces, as this could interfere with readings. +- The board is mounted securely when measuring precise movements. + +# What Is Next? + +Now that you've learned how to use your Modulino Movement, you're all set to integrate it into your projects! +- Use the movement data to detect different patterns and use these as inputs for your projects. +- Create a motion-activated alarm that triggers when unexpected movement is detected. +- Build a balance game that challenges players to keep the sensor level within certain parameters. +- Make a pedometer that counts steps based on the characteristic motion patterns of walking. + +# Conclusion + +The **Modulino Movement** is a digital 6-axis IMU sensor that communicates over I²C and follows the Modulino form factor. It includes standard Qwiic connectors for quick, solderless connections and easy daisy-chaining with other modules. Paired with the Modulino library, it makes accessing motion data straightforward, allowing you to focus on experimenting or building your system logic. It's a small, reliable module suited for both quick tests and longer-term setups. \ No newline at end of file diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/image.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/image.png new file mode 100644 index 0000000000..bceefec75d Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-ardu/image.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/I2C-change-movement.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/I2C-change-movement.png new file mode 100644 index 0000000000..a3c9a51894 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/I2C-change-movement.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/Modulino_Movement_Power_Tree.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/Modulino_Movement_Power_Tree.png new file mode 100644 index 0000000000..fe775335ff Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/Modulino_Movement_Power_Tree.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/MovementPinouts.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/MovementPinouts.png new file mode 100644 index 0000000000..9dd2cf39e3 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/MovementPinouts.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/connection-guide-movement-jumper.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/connection-guide-movement-jumper.png new file mode 100644 index 0000000000..b72819526f Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/connection-guide-movement-jumper.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/connection-guide-movement-qwiic-chain.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/connection-guide-movement-qwiic-chain.png new file mode 100644 index 0000000000..c6c89cc127 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/connection-guide-movement-qwiic-chain.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/connection-guide-movement-qwiik.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/connection-guide-movement-qwiik.png new file mode 100644 index 0000000000..331a2f823c Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/connection-guide-movement-qwiik.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/connection-guide-movement.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/connection-guide-movement.png new file mode 100644 index 0000000000..c21dcc1db7 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/connection-guide-movement.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/mp-usb-connection.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/mp-usb-connection.png new file mode 100644 index 0000000000..fb059f9e8b Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/mp-usb-connection.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/package-installer-overview.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/package-installer-overview.png new file mode 100644 index 0000000000..67678dc808 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/package-installer-overview.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/schematic.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/schematic.png new file mode 100644 index 0000000000..a804960788 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/assets/schematic.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/content.md b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/content.md new file mode 100644 index 0000000000..c997b92435 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/content.md @@ -0,0 +1,260 @@ +--- +title: "How To Use The Modulino Movement And MicroPython" +description: "Learn how to get the most out of your Modulino Movement in a MicroPython environment." +tags: + - Modulino + - QWIIC + - I2C +author: 'Pedro Sousa Lima' +hardware: + - hardware/11.modulinos/modulinos/modulino-movement +software: + - ide-v2 + - web-editor +--- + +The Modulino Movement is a modular sensor that measures acceleration and angular velocity, making it perfect to add motion sensing to your projects! The Modulino form factor is shaped with two QWIIC connectors and the I²C protocol integration, allowing the connection and programming of multiple modulinos in a very simple way. In addition to the QWIIC's connectors, the Modulinos also expose solderable pins that can be used in multiple ways and make them compatible with boards that are not QWIIC compatible. + +# General Characteristics + +The Modulino Movement is capable of measuring acceleration and angular velocity. Take a look at the following table to know more about its measuring ranges: + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|---------------------------------|-------------------------|---------|---------|---------|----------| +| **Accelerometer Range** | Configurable Full Scale | ±2 | ±8 | ±16 | g | +| **Gyroscope Range** | Configurable Full Scale | ±125 | ±1000 | ±2000 | dps | +| **Accelerometer Sensitivity** | @ ±2g | 0.061 | - | - | mg/LSB | +| **Gyroscope Sensitivity** | @ ±125dps | 4.375 | - | - | mdps/LSB | +| **Accelerometer Noise Density** | High-performance mode | - | 70 | - | µg/√Hz | +| **Gyroscope Noise Density** | High-performance mode | - | 3.8 | - | mdps/√Hz | +| **Temperature Sensor Range** | - | -40 | - | +85 | °C | +| **FIFO Buffer** | - | - | 9 | - | KB | +| **Sampling Rate** | Output Data Rate | 1.6 | - | 6664 | Hz | + +## Sensor Details + +The LSM6DSOXTR sensor from STMicroelectronics is the core component of this module. This 6-axis IMU (accelerometer and gyroscope) natively supports digital communication (I²C and SPI), meaning it connects directly to the I²C bus on the module without requiring additional conversion circuitry. +The default address for the Module is: + +| Modulino I²C Address | Hardware I²C Address | +|----------------------|----------------------| +| 0x6A or 0x7E | 0x6A or 0x7E | + +When scanning for I²C address on the bus, you might find the modulino using the **Hardware I²C Address**. However, you should always use the **Modulino I²C Address** when using the official Modulino library. +Later in this article we teach how to [change the address](#how-to-change-i2c-address). + +## Pinout + +The pinout for the Modulino Movement is shown below. Please note that the exposed solderable pins are directly connected to the QWIIC connectors using the same I²C interface. + +![Arduino Movement Pinout](assets/MovementPinouts.png) + +Depending on the board connected to the modulino, the I²C pin names to program it may differ. Please check the [board tutorials](https://docs.arduino.cc/hardware/) on your modulino's compatible board or the [Modulino library](https://github.com/arduino-libraries/Modulino/tree/main/docs) to learn more. + +### 1x10 Header (LSM6DSOXTR) +| Pin | Function | +|---------|----------------------| +| VDDIO | 3.3 V (cuttable) | +| GND | Ground | +| INT1 | Interrupt 1 (Sensor) | +| INT2 | Interrupt 2 (Sensor) | +| SDO/SA0 | SPI Data Out | +| SDX | SPI Data X | +| SCX | SPI Clock X | +| CS | SPI Chip Select | +| SDOAUX | Auxiliary Output | +| OCSAUX | Auxiliary Output | + +### 1x4 Header (I2C) +| Pin | Function | +|-------|--------------| +| GND | Ground | +| 3.3 V | Power Supply | +| SDA | I2C Data | +| SCL | I2C Clock | + +## Power Specifications + +The board is typically powered by +3.3 VDC when using the QWIIC interface as per the I²C standard. + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|-----------------------------------------------|--------------------------------|---------|---------|---------|------| +| Supply Voltage | - | 1.71 | 3.3 (QWIIC) | 3.6 | V | +| I/O Voltage | - | 1.62 | - | 3.6 | V | +| Gyro + Accel Current (High Performance Mode) | Both sensors active | - | 0.55 | - | mA | +| Accelerometer Current (High Performance Mode) | - | - | 170 | - | µA | +| Accelerometer Current (Low Power Mode) | ODR = 50 Hz | - | 26 | - | µA | +| Accelerometer Current (Ultra-Low Power Mode) | ODR = 50 Hz | - | 9.5 | - | µA | + +The module includes a power LED that draws 1 mA and turns on as soon as it is powered. J1 (Qwiic connector), J2 (Qwiic connector), and the headers all share the same power branch. The power distribution of the module is therefore as follows: + +![Power Tree Modulino Movement](assets/Modulino_Movement_Power_Tree.png) + +## Schematic + +The Modulino Movement uses a simple circuit, as shown in the schematic below: + +![Full Schematic Modulino Movement](assets/schematic.png) + +The main component is the **LSM6DSOXTR** sensor (U1), which handles both acceleration and gyroscope measurements, as well as I²C communication. + +You can connect to the I²C pins (SDA and SCL) using either the **QWIIC connectors** (J1 and J2, this is the recommended method) or the **solderable pins** (J4). The board runs on **3.3V**, which comes from the QWIIC cable or the **3V3 pin** on J4. + +There's also a small power indicator LED that lights up when the board is on. + +Some options for customizing the module's features via onboard solder jumpers are available: + +### **VDDIO Independence:** +- By default, **VDDIO is connected to +3V3**. +- To make **VDDIO independent**, cut the corresponding solder jumper. + +### SPI Mode Selection: +- The LSM6DSOXTR supports both **3-wire and 4-wire SPI**. +- You can configure SPI communication and connect additional sensors by cutting or soldering the appropriate jumpers. Please take a look at the IMU's datasheet for more information. + +You can grab the full schematic and PCB files from the [Modulino Movement](https://docs.arduino.cc/hardware/modulinos/modulino-movement) product page. + +# How To Connect Your Modulino + +The easiest and most reliable way to connect your Modulino is through the QWIIC Connect System. It's plug-and-play, uses standard I²C, and makes it easy to join multiple modules. If your board supports QWIIC, this is the recommended way to go. Note that the dedicated I²C pins will differ from board to board meaning it is always a good idea to check your specific model. + +If your board doesn't have a QWIIC connector, you can still access the same I²C bus and power the module using the solderable header pads just make sure you wire it to 3.3V and match the I²C pinout. + +![Modulino Wiring Options QWIIC(A - recommended) and Header(B)](assets/connection-guide-movement.png) + +## QWIIC Connector + +Whenever available, the **QWIIC Connect System** is the preferred method. Connecting to the Modulino is extremely simple, just use a standard QWIIC cable to connect your board to either of the QWIIC connectors on the Modulino. Because the cable and connectors are polarized, there is no need to worry about accidentally swapping connections. + +QWIIC is a plug-and-play I²C Connect System that uses standardized 4-pin connectors: +- GND +- 3.3V +- SDA (Data) +- SCL (Clock) + +![Connection Guide QWIIC](assets/connection-guide-movement-qwiik.png) + +The Modulino features two QWIIC connectors, which are internally connected in parallel. This means you can daisy-chain multiple modules easily by connecting additional QWIIC cables between them. + +When connecting multiple I²C devices, address conflicts may occur if two or more devices share the same default I²C address. The Modulino addresses this potential issue by allowing you to select a different address through a simple hardware modification. We cover this process in detail in the [**Changing I²C Address**](#changing-i2c-address) section, enabling you to integrate multiple identical modules or different devices that share the same default address in your project. + +## Solderable Header + +When QWIIC is not available, you can use the exposed solderable pins on the module. You can solder pins to the unpopulated pads; just remember the pinout provided in this guide to connect to the right pins of your board. + +![Connection Guide Solder Pads](assets/connection-guide-movement-jumper.png) + +## Daisy-Chaining Multiple Modulinos + +Regardless of whether you connect the first Modulino via QWIIC or through the solderable pins, you can still take advantage of the extra QWIIC connector to daisy-chain additional modules. Each Modulino includes two QWIIC connectors wired in parallel, allowing you to connect one module to the next in a chain. As long as each module is configured with a unique I²C address, they can all communicate on the same bus as long as you select the correct I²C pins depending on your board. This approach keeps your setup clean, modular, and expandable without adding extra wiring complexity. + +![Modulino Wiring Options](assets/connection-guide-movement-qwiic-chain.png) + +***The number of modules you can connect will depend on what modules you are chaining together, as this system allows for multiple sensors from different manufacturers to be added. Also, the cables you use for these connections will play a significant role in the setup's performance. Ensure your cables are correctly connected and capable of handling the required data transfer. + +Each module should have a unique address on a chain if you plan to address them individually. Later in this article we teach how to [change the address](#how-to-change-i2c-address). Multiple modules with the same address will cause conflicts on the I²C bus and will not allow you to address them individually.*** + +## Changing I2C Address + +The Modulino Movement can be configured to use an alternative I2C address (0x6B) instead of the default address (0x6A). To change the address, follow these steps carefully: + +1. Disconnect all power from the module +2. Locate the address selection solder jumpers on the back of the board +3. Cut the trace on the jumper marked **Default** (0x6A) +4. Solder closed the jumper marked **0x6B** + +After completing these modifications, your module will use the new address (0x6B) when powered on again. + +**IMPORTANT**: Ensure the module remains unpowered during this entire process. Never have both jumpers closed simultaneously when power is applied, as this will create a short circuit between power and ground that could damage your module. + +![I2C Address Change](assets/I2C-change-movement.png) + +When using a custom address in your MicroPython sketch, you'll need to specify this address when creating the module object. For example: +```python +movement_module = ModulinoMovement(address=0x7E) +``` + + +### How To Program Your Modulino +To program your Modulino it is recommended you use the official ```Modulino``` micropython library available [here](https://github.com/arduino/arduino-modulino-mpy). The library is fully compatible with the no **Arduino Lab for MicroPython**. +For information on installing the **Arduino Lab for MicroPython** please visit our [page](https://docs.arduino.cc/micropython/first-steps/install-guide/). + +### Installing The Modulino Library +The ```Modulino``` library is not available by default on MicroPython devices hence installation is needed. +To simplify the process the [MicroPython Package Installer](https://github.com/arduino/lab-micropython-package-installer/releases) is recommended as it will provide a graphical interface to guide installation. +After installation, you should now be able to: + +1. Open the tool. +2. Plug in your board to the computer. +![USB Connection](assets/mp-usb-connection.png) + +If the board does not appear in the Detected Boards section, click Reload. If the board is still undetected, ensure no other programs (e.g., a code editor) are using the board's COM port. + +4. Search for the ```Modulino``` package by filling in the text box on the search feature. +5. Click Install and wait for the installation confirmation. +6. Disconnect the board from the tool before returning to your code editor to avoid conflicts due to a busy COM port. + +![Package Installer Overview](assets/package-installer-overview.png) + +The module should now be includable in your program using: +```from modulino import ModulinoThermo``` + +## Get Acceleration and Gyroscope Data + +Getting motion data from the **Modulino Movement** module is simple using the `Modulino` library. The module provides two crucial functions for motion sensing: + +- `.accelerometer` - Retrieves the acceleration values (x, y, z). +- `.gyro` - Retrieves the angular velocity (x, y, z) in **dps**. +- By default the Modulino library uses ```Wire1``` if your board model has a different pinout for the dedicated I²C pins you might have to edit it as instructed [here](https://github.com/arduino/arduino-modulino-mpy/tree/main/docs#%E2%84%B9%EF%B8%8F-using-3rd-party-boards). More information on **Wire** can be found [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/). + + +Here’s an example demonstrating how to acquire motion data: + +```python +from modulino import ModulinoMovement +from time import sleep_ms + +movement = ModulinoMovement() + +while True: + acc = movement.accelerometer + gyro = movement.gyro + + print(f"🏃 Accelerometer: x:{acc.x:>8.3f} y:{acc.y:>8.3f} z:{acc.z:>8.3f} g") + print(f"🌐 Gyroscope: x:{gyro.x:>8.3f} y:{gyro.y:>8.3f} z:{gyro.z:>8.3f} dps") + print("") + sleep_ms(100) +``` +The code example provided shows how to initialize the sensor, read the acceleration data, and display it on the console. +The data is continuously updated, showing the current acceleration values in real time. +It can be easily adapted to trigger actions at certain movement thresholds or to detect specific motion patterns in your projects. + +### Troubleshooting + +#### Sensor Not Reachable +If your Modulino's power LED isn't on or the sensor isn't responsive, first check that the board is properly connected: +- Ensure both the board and the Modulino are connected to your computer, and that the power LEDs on both are lit. +- If the issue persists, make sure the Qwiic cable is properly clicked into place. + +#### Library Not Installed Properly +If you encounter an issue with the `import ModulinoMovement` command, verify that the Modulino library is correctly installed: +- Check your Library installer to ensure the library is installed and up-to-date. +- Re-install the library through the Library Manager. + +#### Inaccurate Values +If the sensor values are not accurate, make sure: +- The sensor is not placed on an unstable surface that might cause unwanted vibrations. +- All exposed electronics are not touching any conductive surfaces, as this could interfere with readings. +- The board is mounted securely when measuring precise movements. + +# What Is Next? + +Now that you've learned how to use your Modulino Movement, you're all set to integrate it into your projects! +- Use the movement data to detect different patterns and use these as inputs for your projects. +- Create a motion-activated alarm that triggers when unexpected movement is detected. +- Build a balance game that challenges players to keep the sensor level within certain parameters. +- Make a pedometer that counts steps based on the characteristic motion patterns of walking. + +# Conclusion + +The **Modulino Movement** is a digital 6-axis IMU sensor that communicates over I²C and follows the Modulino form factor. It includes standard Qwiic connectors for quick, solderless connections and easy daisy-chaining with other modules. Paired with the Modulino library, it makes accessing motion data straightforward, allowing you to focus on experimenting or building your system logic. It's a small, reliable module suited for both quick tests and longer-term setups. \ No newline at end of file diff --git a/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/image.png b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/image.png new file mode 100644 index 0000000000..bceefec75d Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-movement/tutorials/how-movement-mp/image.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/assets/BlockDiagramPixels.png b/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/assets/BlockDiagramPixels.png new file mode 100644 index 0000000000..2d925e500b Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/assets/BlockDiagramPixels.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/assets/I2CTag.png b/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/assets/I2CTag.png new file mode 100644 index 0000000000..9d9b7b0f72 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/assets/I2CTag.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/assets/LEDExtention.png b/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/assets/LEDExtention.png new file mode 100644 index 0000000000..16b5a72b8f Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/assets/LEDExtention.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/assets/Modulino_Pixels_Power_Tree.png b/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/assets/Modulino_Pixels_Power_Tree.png new file mode 100644 index 0000000000..1360acf9f8 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/assets/Modulino_Pixels_Power_Tree.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/assets/PixelMec.png b/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/assets/PixelMec.png new file mode 100644 index 0000000000..72fe524062 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/assets/PixelMec.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/assets/PixelsPinouts.png b/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/assets/PixelsPinouts.png new file mode 100644 index 0000000000..1cd8e9f5d4 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/assets/PixelsPinouts.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/assets/featuredPix.png b/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/assets/featuredPix.png new file mode 100644 index 0000000000..1cae9ae6e6 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/assets/featuredPix.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/datasheet.md b/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/datasheet.md new file mode 100644 index 0000000000..b7b7fde614 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-pixels/datasheet/datasheet.md @@ -0,0 +1,253 @@ +--- +identifier: ABX00109 +title: Arduino® Modulino® Pixels +type: maker +author: Pedro Sousa Lima +--- + +![](assets/featuredPix.png) + +# Description +The Modulino® Pixels features **eight LC8822-2020 RGB LEDs** driven by an on-board **STM32C011F4** microcontroller. This setup enables simple I2C connectivity for controlling colorful visual effects, animations, or status indications in a wide variety of projects. + +# Target Areas +Maker, beginner, education + +# Contents +## Application Examples +- **Colorful Displays** + Create dynamic LED patterns, color indicators, or simple pixel-art displays. + +- **Notifications & Alerts** + Represent sensor data or status updates (e.g., temperature ranges, motion detection) via color-coded lights. + +- **Interactive Installations** + Combine with other Modulino® nodes (e.g., Knob or Buttons) to build interactive lighting dashboards or IoT displays. + +
+ +## Features +- **Eight LC8822-2020 RGB LEDs** providing individually addressable full-color output. +- **STM32C011F4** microcontroller that manages LED control over I2C. +- **3.3 V** operation via the Qwiic interface; supports 2.0 V–3.6 V supply range on the MCU. +- **SWD** header for reprogramming and advanced control. +- Ideal for **lighting effects**, **progress bars**, or any **multi-color** output in maker projects. + +### Contents +| **SKU** | **Name** | **Purpose** | **Quantity** | +| --------- | ------------------- | ----------------------------------------------- | ------------ | +| ABX00109 | Modulino® Pixels | 8× individually addressable RGB LEDs | 1 | +| | I2C Qwiic cable | Compatible with the Qwiic standard | 1 | + + +## Related Products +- *SKU: ASX00027* – [Arduino® Sensor Kit](https://store.arduino.cc/products/arduino-sensor-kit) +- *SKU: K000007* – [Arduino® Starter Kit](https://store.arduino.cc/products/arduino-starter-kit-multi-language) +- *SKU: AKX00026* – [Arduino® Oplà IoT Kit](https://store.arduino.cc/products/opla-iot-kit) + +## Rating + +### Recommended Operating Conditions +- **Microcontroller supply range:** 2.0 V – 3.6 V (STM32C011F4) +- **Powered at 3.3 V** through the Qwiic interface (in accordance with the Qwiic standard) +- **Operating temperature:** –40 °C to +85 °C + +**Typical current consumption:** +- Up to **33 mA per RGB LED** at full brightness * 8 LEDs (264 mA total), plus ~3.4 mA for the microcontroller. Actual usage depends on brightness and color settings. + +## Power Tree +The power tree for the modulino can be consulted below: + +![Modulino® Pixels Power Tree](assets/Modulino_Pixels_Power_Tree.png) + +## Block Diagram +This module includes an STM32C011F4 microcontroller managing eight LC8822-2020 RGB LEDs. It communicates with the host via I2C by default but can be reprogrammed via SWD for custom functionality. + +![Modulino® Pixels block diagram](assets/BlockDiagramPixels.png) + +## Functional Overview +The Modulino® Pixels node uses the on-board **STM32C011F4** to handle LED data and provide an I2C interface. Each of the eight **LC8822-2020 RGB LEDs** can be addressed and controlled individually for color and brightness. Advanced users may reprogram the MCU (via SWD) to alter LED control logic or to interface via other protocols. + +### Technical Specifications +| **Specification** | **Details** | +| ----------------------- | ---------------------------------------------------------------------------- | +| **Microcontroller** | STM32C011F4 (handles I2C, LED driving logic) | +| **Accuracy** | ADC: ±2 LSB typical INL | +| **Resolution** | 12-bit ADC | +| **Actuator** | 8× LC8822-2020 RGB LEDs | +| **Supply Voltage** | Min: 2.0 V, Max: 3.6 V | +| **Power Consumption** | Up to 33 mA/LED at full white brightness × 8 = 264 mA, plus ~3.4 mA for MCU | +| **Communication** | I2C (Qwiic), SWD (debug/reprogram), optional UART/SPI if reprogrammed | +| **Resolution** | 12-bit ADC in MCU (optional for other expansions) | + +### Pinout + +**Qwiic / I2C (1×4 Header)** +| **Pin** | **Function** | +|---------|----------------------------| +| GND | Ground | +| 3.3 V | Power Supply (3.3 V) | +| SDA | I2C Data | +| SCL | I2C Clock | + +These pads and the Qwiic connectors share the same I2C bus at 3.3 V. + +**Additional 1×10 Header (LED & MCU Signals)** +| **Pin** | **Function** | +|---------|-------------------| +| CO | Clock Out (for chained LEDs) | +| DO | Data Out (for chained LEDs) | +| RX1 | UART Receive | +| TX1 | UART Transmit | +| SWDIO | SWD Data | +| SWCLK | SWD Clock | +| PF2 | NRST (Reset) | + +![Pinout Overview](assets/PixelsPinouts.png) + +The header can be used to add more LC8822-2020 RGB's LED in a daisy chain configuration. +Built-in LEDs open for extension + +It also has other I2C interface controller IC pins usable for other purposes or for reprogramming it using its SWD interface. These provide a place to mount header pins if desired. + +![LED extension](assets/LEDExtention.png) + +### Power Specifications +- **Nominal operating voltage:** 3.3 V via Qwiic +- **MCU voltage range:** 2.0 V–3.6 V + +### Mechanical Information +![Modulino® Pixels Mechanical Information](assets/PixelMec.png) + +- Board dimensions: 41 mm × 25.36 mm +- Thickness: 1.6 mm (±0.2 mm) +- Four mounting holes (Ø 3.2 mm) + - Hole spacing: 16 mm vertically, 32 mm horizontally + +### I2C Address Reference + +| **Board Silk Name** | **Sensor/Actuator** | **Modulino I2C Address (HEX)** | **Editable Addresses (HEX)** | **Hardware I2C Address (HEX)** | +|---------------------|--------------------------|--------------------------------|------------------------------------------|--------------------------------| +| MODULINO PIXELS | 8× LC8822-2020 RGB LEDs | 0x6C | Any custom address (via FW config) | 0x36 | + +**Note:** Default address is **0x6C**. You can change it via the Modulino® library or custom firmware. A white rectangle on the board silk can be used to record a new address. +![Blank silk for identification](assets/I2CTag.png) + +## Device Operation +By default, this node operates as an I2C target device on the Qwiic bus. The integrated microcontroller receives LED control commands and drives each of the eight LC8822-2020 RGB LEDs. For advanced usage, you may reprogram the microcontroller to add different communication protocols or custom LED driving modes. + +Use any 3.3 V microcontroller or Arduino board. The official Modulino® libraries facilitate controlling the RGB LEDs with easy I2C commands to set colors, brightness, or special effects. Make sure your power supply can handle the current draw if driving all LEDs at full brightness. + +# Certifications +## Certifications Summary + +| **Certification** | **Status** | +|:-----------------:|:----------:| +| CE/RED (Europe) | Yes | +| UKCA (UK) | Yes | +| FCC (USA) | Yes | +| IC (Canada) | Yes | +| RoHS | Yes | +| REACH | Yes | +| WEEE | Yes | + +## Declaration of Conformity CE DoC (EU) + +

We declare under our sole responsibility that the products above are in conformity with the essential requirements of the following EU Directives and therefore qualify for free movement within markets comprising the European Union (EU) and European Economic Area (EEA).

+ +## Declaration of Conformity to EU RoHS & REACH 211 01/19/2021 + +

Arduino boards are in compliance with RoHS 2 Directive 2011/65/EU of the European Parliament and RoHS 3 Directive 2015/863/EU of the Council of 4 June 2015 on the restriction of the use of certain hazardous substances in electrical and electronic equipment.

+ +| Substance | **Maximum limit (ppm)** | +|----------------------------------------|-------------------------| +| Lead (Pb) | 1000 | +| Cadmium (Cd) | 100 | +| Mercury (Hg) | 1000 | +| Hexavalent Chromium (Cr6+) | 1000 | +| Poly Brominated Biphenyls (PBB) | 1000 | +| Poly Brominated Diphenyl ethers (PBDE) | 1000 | +| Bis(2-Ethylhexyl) phthalate (DEHP) | 1000 | +| Benzyl butyl phthalate (BBP) | 1000 | +| Dibutyl phthalate (DBP) | 1000 | +| Diisobutyl phthalate (DIBP) | 1000 | + +Exemptions: No exemptions are claimed. + +

Arduino Boards are fully compliant with the related requirements of European Union Regulation (EC) 1907 /2006 concerning the Registration, Evaluation, Authorization and Restriction of Chemicals (REACH). We declare none of the SVHCs (https://echa.europa.eu/web/guest/candidate-list-table), the Candidate List of Substances of Very High Concern for authorization currently released by ECHA, is present in all products (and also package) in quantities totaling in a concentration equal or above 0.1%. To the best of our knowledge, we also declare that our products do not contain any of the substances listed on the "Authorization List" (Annex XIV of the REACH regulations) and Substances of Very High Concern (SVHC) in any significant amounts as specified by the Annex XVII of Candidate list published by ECHA (European Chemical Agency) 1907 /2006/EC.

+ +## Conflict Minerals Declaration + +

As a global supplier of electronic and electrical components, Arduino is aware of our obligations with regard to laws and regulations regarding Conflict Minerals, specifically the Dodd-Frank Wall Street Reform and Consumer Protection Act, Section 1502. Arduino does not directly source or process conflict minerals such as Tin, Tantalum, Tungsten, or Gold. Conflict minerals are contained in our products in the form of solder or as a component in metal alloys. As part of our reasonable due diligence, Arduino has contacted component suppliers within our supply chain to verify their continued compliance with the regulations. Based on the information received thus far we declare that our products contain Conflict Minerals sourced from conflict-free areas.

+ +## FCC Caution + +Any Changes or modifications not expressly approved by the party responsible for compliance could void the user’s authority to operate the equipment. + +This device complies with part 15 of the FCC Rules. Operation is subject to the following two conditions: + +1. This device may not cause harmful interference. +2. This device must accept any interference received, including interference that may cause undesired operation. + +**FCC RF Radiation Exposure Statement:** + +1. This Transmitter must not be co-located or operating in conjunction with any other antenna or transmitter. +2. This equipment complies with RF radiation exposure limits set forth for an uncontrolled environment. +3. This equipment should be installed and operated with a minimum distance of 20 cm between the radiator & your body. + +**Note:** This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures: + +- Reorient or relocate the receiving antenna. +- Increase the separation between the equipment and receiver. +- Connect the equipment into an outlet on a circuit different from that to which the receiver is connected. +- Consult the dealer or an experienced radio/TV technician for help. + +English: +User manuals for license-exempt radio apparatus shall contain the following or equivalent notice in a conspicuous location in the user manual or alternatively on the device or both. This device complies with Industry Canada license-exempt RSS standard(s). Operation is subject to the following two conditions: + +1. this device may not cause interference. +2. this device must accept any interference, including interference that may cause undesired operation of the device. + +French: +Le présent appareil est conforme aux CNR d’Industrie Canada applicables aux appareils radio exempts de licence. L’exploitation est autorisée aux deux conditions suivantes: + +1. l’appareil nedoit pas produire de brouillage. +2. l’utilisateur de l’appareil doit accepter tout brouillage radioélectrique subi, même si le brouillage est susceptible d’en compromettre le fonctionnement. + +**IC SAR Warning:** + +English: +This equipment should be installed and operated with a minimum distance of 20 cm between the radiator and your body. + +French: +Lors de l’installation et de l’exploitation de ce dispositif, la distance entre le radiateur et le corps est d’au moins 20 cm. + +**Important:** The operating temperature of the EUT can’t exceed 85 ℃ and shouldn’t be lower than -40 ℃. + +Hereby, Arduino S.r.l. declares that this product is in compliance with essential requirements and other relevant provisions of Directive 2014/53/EU. This product is allowed to be used in all EU member states. + +# Company Information + +| Company name | Arduino SRL | +|-----------------|-----------------------------------------------| +| Company Address | Via Andrea Appiani, 25 - 20900 MONZA（Italy) | + +# Reference Documentation + +| Ref | Link | +| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Arduino IDE (Desktop) | [https://www.arduino.cc/en/Main/Software](https://www.arduino.cc/en/Main/Software) | +| Arduino Courses | [https://www.arduino.cc/education/courses](https://www.arduino.cc/education/courses) | +| Arduino Documentation | [https://docs.arduino.cc/](https://docs.arduino.cc/) | +| Arduino IDE (Cloud) | [https://create.arduino.cc/editor](https://create.arduino.cc/editor) | +| Cloud IDE Getting Started | [https://docs.arduino.cc/cloud/web-editor/tutorials/getting-started/getting-started-web-editor](https://docs.arduino.cc/cloud/web-editor/tutorials/getting-started/getting-started-web-editor) | +| Project Hub | [https://projecthub.arduino.cc/](https://projecthub.arduino.cc/) | +| Library Reference | [https://github.com/arduino-libraries/](https://github.com/arduino-libraries/) | +| Online Store | [https://store.arduino.cc/](https://store.arduino.cc/) | + +# Revision History +| **Date** | **Revision** | **Changes** | +|------------ |------------ |------------------------------------------------| +| 11/07/2024 | 1 | First release | + + diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/essentials.md b/content/hardware/11.accessories/modulinos/modulino-pixels/essentials.md new file mode 100644 index 0000000000..762e36d575 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-pixels/essentials.md @@ -0,0 +1,8 @@ + + + + +This library allows you to communicate with the Arduino Modulino® nodes. + + + diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/features.md b/content/hardware/11.accessories/modulinos/modulino-pixels/features.md new file mode 100644 index 0000000000..b188367611 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-pixels/features.md @@ -0,0 +1,12 @@ + +The Modulino® Pixels module features eight RGB LEDs for creating colorful displays and visual alerts. It is compatible with the Arduino UNO R4 WiFi or any board with a Qwiic interface, letting you craft vibrant light effects with minimal fuss. + + + + + Beginner-friendly guides show you how to program each RGB LED, so you can learn about color mixing and easily add dynamic lighting to your projects. + + + The Modulino® Pixels module connects via Qwiic cables to your UNO R4 WiFi or other compatible boards. Alternatively, solderable pins are available for direct wiring when a Qwiic connector is not accessible. + + diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/image.svg b/content/hardware/11.accessories/modulinos/modulino-pixels/image.svg new file mode 100644 index 0000000000..ef05cb3331 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-pixels/image.svg @@ -0,0 +1,1768 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/product.md b/content/hardware/11.accessories/modulinos/modulino-pixels/product.md new file mode 100644 index 0000000000..e08955e17d --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-pixels/product.md @@ -0,0 +1,11 @@ +--- +title: Modulino® Pixels +url_shop: https://store.arduino.cc/products/modulino-pixels +url_guide: https://courses.arduino.cc/plugandmake +primary_button_url: https://courses.arduino.cc/plugandmake +primary_button_title: Get Started +certifications: [] +sku: [ABX00109] +--- + +Illuminate your projects with eight customizable RGB LEDs (LC8822-2020). Create dazzling color displays, visual indicators, or light-based animations—all with minimal effort. Compatible with the Arduino UNO R4 WiFi or any board featuring a Qwiic interface, and includes solderable pins if you prefer a direct wiring approach. diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tech-specs.md b/content/hardware/11.accessories/modulinos/modulino-pixels/tech-specs.md new file mode 100644 index 0000000000..0a4a67fc65 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-pixels/tech-specs.md @@ -0,0 +1 @@ +Here you will find the technical specifications for the Modulino® Pixels. \ No newline at end of file diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tech-specs.yml b/content/hardware/11.accessories/modulinos/modulino-pixels/tech-specs.yml new file mode 100644 index 0000000000..924c54fea9 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-pixels/tech-specs.yml @@ -0,0 +1,11 @@ +Node: + Name: Modulino Pixels + SKU: ABX00109 + Board recommended: Arduino® UNO R4 WiFi (ABX00087) + Communications: I2C (over Qwiic connector or solderable pin) + Operational voltage: 3.3V + Actuator: + LC8822-2020 LEDs (STM32C011F4): 0x6C (address can change via software) + +Other accessories: + Qwiic cables: 1x diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/IDE-Left-Tab.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/IDE-Left-Tab.png new file mode 100644 index 0000000000..c7bb86575e Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/IDE-Left-Tab.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/Modulino_Pixels_Power_Tree.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/Modulino_Pixels_Power_Tree.png new file mode 100644 index 0000000000..1360acf9f8 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/Modulino_Pixels_Power_Tree.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/PixelsPinouts.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/PixelsPinouts.png new file mode 100644 index 0000000000..753e749422 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/PixelsPinouts.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/addressChangeIDE.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/addressChangeIDE.png new file mode 100644 index 0000000000..d5cd3fd195 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/addressChangeIDE.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/adressChanger.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/adressChanger.png new file mode 100644 index 0000000000..c6eae670c8 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/adressChanger.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/connection-guide-pixels-jumper.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/connection-guide-pixels-jumper.png new file mode 100644 index 0000000000..cdce255db8 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/connection-guide-pixels-jumper.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/connection-guide-pixels-qwiic-chain.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/connection-guide-pixels-qwiic-chain.png new file mode 100644 index 0000000000..5899d68721 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/connection-guide-pixels-qwiic-chain.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/connection-guide-pixels-qwiik.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/connection-guide-pixels-qwiik.png new file mode 100644 index 0000000000..3b09f3b752 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/connection-guide-pixels-qwiik.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/connection-guide-pixels.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/connection-guide-pixels.png new file mode 100644 index 0000000000..229410a0c3 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/connection-guide-pixels.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/expansion-guide-pixels.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/expansion-guide-pixels.png new file mode 100644 index 0000000000..427dc10d40 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/expansion-guide-pixels.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/library-install.gif b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/library-install.gif new file mode 100644 index 0000000000..16f396c353 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/library-install.gif differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/pixel-expantion-mc.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/pixel-expantion-mc.png new file mode 100644 index 0000000000..ef177015f8 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/pixel-expantion-mc.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/schematic.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/schematic.png new file mode 100644 index 0000000000..8f5504efee Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/assets/schematic.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/content.md b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/content.md new file mode 100644 index 0000000000..ffd0be0aa3 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/content.md @@ -0,0 +1,241 @@ +--- +title: "How To Use The Modulino Pixels" +description: "Learn how to get the most out of your Modulino Pixels." +tags: + - Modulino + - QWIIC + - I2C +author: 'Pedro Sousa Lima' +hardware: + - hardware/11.modulinos/modulinos/modulino-pixels +software: + - ide-v2 + - web-editor +--- +The Modulino Pixels is a modular sensor that generates RGB light effects, making it perfect to add colorful visual feedback to your projects! +The Modulino form factor is shaped with two QWIIC connectors and the I²C protocol integration, allowing the connection and programming of multiple modulinos in a very simple way. In addition to the QWIIC's connectors, the Modulinos also expose solderable pins that can be used in multiple ways and make them compatible with boards that are not QWIIC compatible. + +## Hardware Specifications + +The Modulino Pixels based on 8 LC8822-2020 addressable LEDs is capable of generating colorful light patterns and effects. Take a look at the following table to know more about its characteristics: + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|------------------|-------------------|---------|---------|---------|------| +| Supply Voltage | - | 2.0 | 3.3 | 3.6 | V | +| Resolution (ADC) | Default | - | 12-bit | - | mcd | +| Communication | I²C,USART,SPI,I2S | - | I²C | - | - | + +## Pinout + +The LC8822-2020 addressable LEDs are the core components of this module. These RGB light output devices are controlled by an onboard STM32C011F4U6TR microcontroller, which supports digital communication (I²C), meaning it connects directly to the I²C bus on the module without requiring additional conversion circuitry. +![Modulino Pixels Pinout](assets/PixelsPinouts.png) + +### 1x10 Header (LC8822-2020 and Microcontroller Signals) +| Pin | Function | +|------|----------------| +| PA0 | Clock Out (CO) | +| PA1 | Data Out (DO) | +| PA2 | User Defined | +| PA3 | User Defined | +| PA4 | User Defined | +| PA5 | User Defined | +| PA9 | USART TX | +| PA10 | USART RX | +| PA14 | SWCLK | +| PA13 | SWDIO | + +- **PA0: Clock Out (CO)**: Used to send the clock signal to the first LED in the daisy chain. (Expand LED strip) +- **PA1: Data Out (DO)**: Used to send data to the first LED in the daisy chain. (Expand LED strip) +- **PA2-PA5: Free pins**: Available for user defined functionality. +- **PA9 and PA10: UART TX/RX**: Can be used for serial communication. +- **PA14 and PA13: SWD Interface**: Used for debugging or reprogramming the microcontroller. + +### 1x4 Header (I2C) +The pinout for the Modulino Pixels is shown below. While the recommended connection method is via the QWIIC connectors, this solderable header provides a connection option when using the modulino with a non-QWIIC compatible board. + +| Pin | Function | +|-------|--------------| +| GND | Ground | +| 3.3 V | Power Supply | +| SDA | I²C Data | +| SCL | I²C Clock | + +## I2C Address + +The **Modulino Pixels** module uses **LC8822-2020** addressable LEDs, which do not have native I²C capabilities. Instead, the LED array is controlled by the Modulino's onboard microcontroller (STM32C011F4U6TR). This microcontroller provides I²C communication, allowing for flexible control of the LEDs. +One unique feature of this setup is the ability to change the I²C address via software. This means the address can be modified based on your application needs, making it adaptable to different system configurations. The default I²C address for the **Modulino Pixels** module is: + +| Modulino I²C Address | Hardware I²C Address | Editable Addresses (HEX) | +|----------------------|----------------------|-----------------------------------| +| 0x6C | 0x36 | Any custom address (via software) | + +When scanning for I²C address on the bus, you might find the modulino using the **Hardware I²C Address**. However, you should always use the **Modulino I²C Address** when using the official Modulino library. +Later in this article we teach how to [change the address](#how-to-change-i2c-address). + +## Power Specifications + +The board is typically powered by +3.3 VDC when using the QWIIC interface as per the I²C standard. + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|------------------------|----------------|---------|---------|---------|------| +| Operating Voltage | - | 4.5 | 3.3 | 3.6 | V | +| Power Dissipation | - | - | - | 350 | mW | +| Standby Current | No data signal | - | - | 1 | mA | +| Max LED Output Current | Per Channel | - | 18 | - | mA | + + +The module includes a power LED that draws 1 mA and turns on as soon as it is powered. +J1 (Qwiic connector), J2 (Qwiic connector), and the headers all share the same power branch. The power distribution of the module is therefore as follows: +![Power Tree Modulino Pixels](assets/Modulino_Pixels_Power_Tree.png) + +## Schematic + +The Modulino Pixels uses a simple circuit, as shown in the schematic below: + +![Full Schematic Modulino Pixels](assets/schematic.png) + +The main components are the **8 LC8822-2020 addressable LEDs** and the **STM32C011F4U6TR** microcontroller (U1), which handles LED control as well as I²C communication. +You can connect to the I²C pins (SDA and SCL) using either the **QWIIC connectors** (J1 and J2, this is the recommended method) or the **solderable pins** (J4). The board runs on **3.3V**, which comes from the QWIIC cable or the **3V3 pin** on J4. + +The **LC8822-2020** LEDs are connected in a daisy chain, with the first LED receiving clock and data signals from the microcontroller. The **CO (Clock Out)** and **DO (Data Out)** of the last LED in the chain are accessible via the **1x10 header**, allowing for expansion. ![LED Expantion](assets/expansion-guide-pixels.png) + +These can also be found in small pads near the STM32 microcontroller alongside a few user defines pads that can be used by editing the firmware: +![Exposed user-defined and LED expansion pads](assets/pixel-expantion-mc.png) + +There's also a small power LED indicator that lights up when the board is on. + +You can grab the full schematic and PCB files from the [Modulino Pixels](https://docs.arduino.cc/hardware/modulinos/modulino-pixels) product page. + +## How To Connect Your Modulino + +The easiest and most reliable way to connect your Modulino is through the QWIIC Connect System. It’s plug-and-play, uses standard I²C, and makes it easy to join multiple modules. If your board supports QWIIC, this is the recommended way to go. +Note that the dedicated I²C pins will differ from board to board meaning it is always a good idea to check your specific model. + + +![Modulino Wiring Options QWIIC(A - recommended) and Header(B)](assets/connection-guide-pixels.png) + +## QWIIC Connector +Whenever available, the **QWIIC Connect System** is the preferred method. Connecting to the Modulino is extremely simple, just use a standard QWIIC cable to connect your board to either of the QWIIC connectors on the Modulino. Because the cable and connectors are polarized, there is no need to worry about accidentally swapping connections. + +QWIIC is a plug-and-play I²C Connect System that uses standardized 4-pin connectors: +- GND +- 3.3V +- SDA (Data) +- SCL (Clock) + +![Connection Guide QWIIC](assets/connection-guide-pixels-qwiik.png) + +The Modulino features two QWIIC connectors, which are internally connected in parallel. This means you can daisy-chain multiple modules easily by connecting additional QWIIC cables between them. + +## Solderable Header +When QWIIC is not available, you can use the exposed solderable pins on the module. You can solder pins to the unpopulated pads; just remember the pinout provided in this guide to connect to the right pins of your board. + +![Connection Guide Solder Pads](assets/connection-guide-pixels-jumper.png) + +## Daisy-Chaining Multiple Modulinos + +Regardless of whether you connect the first Modulino via QWIIC or through the solderable pins, you can still take advantage of the extra QWIIC connector to daisy-chain additional modules. + +Each Modulino includes two QWIIC connectors wired in parallel, allowing you to connect one module to the next in a chain. As long as each module is configured with a unique I²C address, they can all communicate on the same bus. + +This approach keeps your setup clean, modular, and expandable without adding extra wiring complexity. + +![Modulino Wiring Options](assets/connection-guide-pixels-qwiic-chain.png) +***The number of modules you can connect will depend on what modules you are chaining together, as this system allows for multiple sensors from different manufacturers to be added. Also, the cables you use for these connections will play a significant role in the setup’s performance. Ensure your cables are properly connected and capable of handling the required data transfer. +Each module should have a unique address on a chain if you plan to address them individually. Later in this article we teach how to [change the address](#how-to-change-i2c-address). Multiple modules with the same address will cause conflicts on the I²C bus and will not allow you to address them individually.*** + +## How To Program Your Modulino +To program the Modulino the official library available [here](https://docs.arduino.cc/libraries/modulino/) is recommended, it is fully compatible with the Arduino IDE. +For information on how to install the IDE please visit our [page](https://docs.arduino.cc/software/ide-v2/tutorials/getting-started/ide-v2-downloading-and-installing/). + +### Installing The Modulino Library +You need the official Modulino library available [here](https://github.com/arduino-libraries/Modulino) to use the Modulino Thermo. + +With the Arduino IDE you get some tools that make adding a library easier. To learn how to install the IDE please visit our [page](https://docs.arduino.cc/software/ide-v2/tutorials/getting-started/ide-v2-downloading-and-installing/). +After opening the IDE, a tab should be visible on the left. Press the book icon for "library" as highlighted in the image. +![IDE Library Tab](assets/IDE-Left-Tab.png) +The process should look like this: +![Library Install](assets/library-install.gif) +A message will appear after the installation is successful. + +### Set LED Colors + +Controlling RGB LEDs using the **Modulino Pixels** module is straightforward with the `Modulino` library. +For the **Pixels**, there are two important functions: +- `set(index, color, brightness)`: Sets a specific LED to a chosen color and brightness level. (`RED`,`BLUE`,`GREEN`,`VIOLET`,`WHITE`) +- `show()`: Applies the changes to the LEDs. +- ```Modulino.begin();```: By default the Modulino library uses ```Wire1``` if your connection is in a different Wire you will have to edit it, check [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/) (by default the Modulino library uses ```Wire1``` if your board model has a different pinout for the dedicated I²C pins you might have to edit it. More information on **Wire** can be found [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/)) for the library's hardware compatibility. More information on **Wire** can be found [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/). + +Here is an example of how to implement these functions to control the LEDs: + +```arduino +#include + +ModulinoPixels leds; + +int brightness = 25; + +void setup(){ + Modulino.begin(); + leds.begin(); +} + +void loop(){ + // Set all LEDs to blue + for (int i = 0; i < 8; i++) { + leds.set(i, BLUE, brightness); + leds.show(); + } +} +``` +The code example provided demonstrates how to initialize the LED module and set all 8 LEDs to blue with a brightness level of 25%. The for-loop cycles through each LED (indexed 0-7), sets its color and brightness, and then uses the show() function to apply the change. This creates a simple blue light display that can be easily modified to create more complex lighting patterns or visual indicators for your projects. + +### How To Change I²C Address + +An example sketch, AddressChanger, is also included with the library inside the `Utilities` folder and available [here](https://github.com/arduino-libraries/Modulino/blob/main/examples/Utilities/AddressChanger/AddressChanger.ino). This sketch changes the I²C address at a software level on the Module's microcontroller. +![Example location on the IDE](assets/addressChangeIDE.png) + +- Connect the module to your board, remove any other modules that might be in the chain. Connection must be via I²C. +- Upload the sketch. +- Open the Serial Monitor. +- Text should now appear. Make sure the correct bauld-rate is selected if the displayed characters seem corrupted. + ![Expected console output](assets/adressChanger.png) +- Select the address and confirm. +- Your address should now have changed. Make sure to take note of the selected address. + +To keep track of the address in use the module has a white rectangle on the back. Feel free to use this to write the address that was chosen. + +When using a custom address in your sketch, you'll need to specify this address when creating the module object. For example: +```arduino +ModulinoPixels pixels(0x3E); // Replace 0x3E with your specific address +``` + +## Troubleshooting + +### LEDs Not Lighting +If your Modulino's power LED isn't on or the RGB LEDs aren't responsive, first check that the board is properly connected: +- Ensure both the board and the Modulino are connected to your computer, and that the power LEDs on both are lit. +- If the issue persists, make sure the Qwiic cable is properly clicked into place. + +### Library Not Installed Properly +If you encounter an issue with the `#include "modulino.h"` command, verify that the Modulino library is correctly installed: +- Check your IDE to ensure the library is installed and up-to-date. +- Re-install the library through the Library Manager. + +### Incorrect Colors or Flickering +If the LED colors are incorrect or the LEDs are flickering unexpectedly, make sure: +- The brightness values are within the appropriate range (typically 0-255). +- All exposed electronics are not touching any conductive surfaces, as this could interfere with the LED output. +- The power supply is stable and providing sufficient current for all LEDs at the desired brightness. + +# Conclusion + +The **Modulino Pixels** is a digital RGB LED control module that communicates over I²C and follows the Modulino form factor. It includes standard Qwiic connectors for quick, solderless connections and easy daisy-chaining with other modules. Paired with the Modulino library, it makes generating colorful light effects straightforward, allowing you to focus on experimenting or building your system logic. It's a small, reliable module suited for both visual feedback and creative lighting projects. + +# What Is Next? + +Now that you've learned how to use your Modulino Pixels, you're all set to integrate it into your projects! +- Create an animated progress bar that visually displays status, or battery charge level using a gradient of colors. +- Build a live sound level indicator that responds to ambient noise. +- Design a pomodoro timer with color coded work and rest periods to boost your productivity. +- Program an interactive game where players must match patterns of colors in the correct sequence, with difficulty increasing as they progress. diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/image.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/image.png new file mode 100644 index 0000000000..bceefec75d Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-ardu/image.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/Modulino_Pixels_Power_Tree.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/Modulino_Pixels_Power_Tree.png new file mode 100644 index 0000000000..1360acf9f8 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/Modulino_Pixels_Power_Tree.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/PixelsPinouts.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/PixelsPinouts.png new file mode 100644 index 0000000000..753e749422 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/PixelsPinouts.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/connection-guide-pixels-jumper.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/connection-guide-pixels-jumper.png new file mode 100644 index 0000000000..6796fa2911 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/connection-guide-pixels-jumper.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/connection-guide-pixels-qwiic-chain.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/connection-guide-pixels-qwiic-chain.png new file mode 100644 index 0000000000..5899d68721 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/connection-guide-pixels-qwiic-chain.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/connection-guide-pixels-qwiik.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/connection-guide-pixels-qwiik.png new file mode 100644 index 0000000000..621425659d Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/connection-guide-pixels-qwiik.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/connection-guide-pixels.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/connection-guide-pixels.png new file mode 100644 index 0000000000..229410a0c3 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/connection-guide-pixels.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/expansion-guide-pixels.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/expansion-guide-pixels.png new file mode 100644 index 0000000000..427dc10d40 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/expansion-guide-pixels.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/mp-usb-connection.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/mp-usb-connection.png new file mode 100644 index 0000000000..fb059f9e8b Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/mp-usb-connection.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/package-installer-overview.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/package-installer-overview.png new file mode 100644 index 0000000000..67678dc808 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/package-installer-overview.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/pixel-expantion-mc.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/pixel-expantion-mc.png new file mode 100644 index 0000000000..ef177015f8 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/pixel-expantion-mc.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/schematic.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/schematic.png new file mode 100644 index 0000000000..8f5504efee Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/assets/schematic.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/content.md b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/content.md new file mode 100644 index 0000000000..5f33a769ef --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/content.md @@ -0,0 +1,295 @@ +--- +title: "How To Use The Modulino Pixels" +description: "Learn how to get the most out of your Modulino Pixels." +tags: + - Modulino + - QWIIC + - I2C +author: 'Pedro Sousa Lima' +hardware: + - hardware/11.modulinos/modulinos/modulino-pixels +software: + - ide-v2 + - web-editor +--- +The Modulino Pixels is a modular sensor that generates RGB light effects, making it perfect to add colorful visual feedback to your projects! +The Modulino form factor is shaped with two QWIIC connectors and the I²C protocol integration, allowing the connection and programming of multiple modulinos in a very simple way. In addition to the QWIIC's connectors, the Modulinos also expose solderable pins that can be used in multiple ways and make them compatible with boards that are not QWIIC compatible. + +## Hardware Specifications + +The Modulino Pixels based on 8 LC8822-2020 addressable LEDs is capable of generating colorful light patterns and effects. Take a look at the following table to know more about its characteristics: + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|------------------|-------------------|---------|---------|---------|------| +| Supply Voltage | - | 2.0 | 3.3 | 3.6 | V | +| Resolution (ADC) | Default | - | 12-bit | - | mcd | +| Communication | I²C,USART,SPI,I2S | - | I²C | - | - | + +## Pinout + +The LC8822-2020 addressable LEDs are the core components of this module. These RGB light output devices are controlled by an onboard STM32C011F4U6TR microcontroller, which supports digital communication (I²C), meaning it connects directly to the I²C bus on the module without requiring additional conversion circuitry. +![Modulino Pixels Pinout](assets/PixelsPinouts.png) + +### 1x10 Header (LC8822-2020 and Microcontroller Signals) +| Pin | Function | +|------|----------------| +| PA0 | Clock Out (CO) | +| PA1 | Data Out (DO) | +| PA2 | User Defined | +| PA3 | User Defined | +| PA4 | User Defined | +| PA5 | User Defined | +| PA9 | USART TX | +| PA10 | USART RX | +| PA14 | SWCLK | +| PA13 | SWDIO | + +- **PA0: Clock Out (CO)**: Used to send the clock signal to the first LED in the daisy chain. (Expand LED strip) +- **PA1: Data Out (DO)**: Used to send data to the first LED in the daisy chain. (Expand LED strip) +- **PA2-PA5: Free pins**: Available for user defined functionality. +- **PA9 and PA10: UART TX/RX**: Can be used for serial communication. +- **PA14 and PA13: SWD Interface**: Used for debugging or reprogramming the microcontroller. + +### 1x4 Header (I2C) +The pinout for the Modulino Pixels is shown below. While the recommended connection method is via the QWIIC connectors, this solderable header provides a connection option when using the modulino with a non-QWIIC compatible board. + +| Pin | Function | +|-------|--------------| +| GND | Ground | +| 3.3 V | Power Supply | +| SDA | I²C Data | +| SCL | I²C Clock | + +## I2C Address + +The **Modulino Pixels** module uses **LC8822-2020** addressable LEDs, which do not have native I²C capabilities. Instead, the LED array is controlled by the Modulino's onboard microcontroller (STM32C011F4U6TR). This microcontroller provides I²C communication, allowing for flexible control of the LEDs. +One unique feature of this setup is the ability to change the I²C address via software. This means the address can be modified based on your application needs, making it adaptable to different system configurations. The default I²C address for the **Modulino Pixels** module is: + +| Modulino I²C Address | Hardware I²C Address | Editable Addresses (HEX) | +|----------------------|----------------------|-----------------------------------| +| 0x6C | 0x36 | Any custom address (via software) | + +When scanning for I²C address on the bus, you might find the modulino using the **Hardware I²C Address**. However, you should always use the **Modulino I²C Address** when using the official Modulino library. +Later in this article we teach how to [change the address](#how-to-change-i2c-address). + + +## Power Specifications + +The board is typically powered by +3.3 VDC when using the QWIIC interface as per the I²C standard. + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|------------------------|----------------|---------|---------|---------|------| +| Operating Voltage | - | 4.5 | 3.3 | 5.5 | V | +| Power Dissipation | - | - | - | 350 | mW | +| Standby Current | No data signal | - | - | 1 | mA | +| Max LED Output Current | Per Channel | - | 18 | - | mA | + + +The module includes a power LED that draws 1 mA and turns on as soon as it is powered. +J1 (Qwiic connector), J2 (Qwiic connector), and the headers all share the same power branch. The power distribution of the module is therefore as follows: +![Power Tree Modulino Pixels](assets/Modulino_Pixels_Power_Tree.png) + +## Schematic + +The Modulino Pixels uses a simple circuit, as shown in the schematic below: + +![Full Schematic Modulino Pixels](assets/schematic.png) + +The main components are the **8 LC8822-2020 addressable LEDs** and the **STM32C011F4U6TR** microcontroller (U1), which handles LED control as well as I²C communication. +You can connect to the I²C pins (SDA and SCL) using either the **QWIIC connectors** (J1 and J2, this is the recommended method) or the **solderable pins** (J4). The board runs on **3.3V**, which comes from the QWIIC cable or the **3V3 pin** on J4. + +The **LC8822-2020** LEDs are connected in a daisy chain, with the first LED receiving clock and data signals from the microcontroller. The **CO (Clock Out)** and **DO (Data Out)** of the last LED in the chain are accessible via the **1x10 header**, allowing for expansion. +![LED Expantion](assets/expansion-guide-pixels.png) + +These can also be found in small pads near the STM32 microcontroller alongside a few user defines pads that can be used by editing the firmware: +![Exposed user-defined and LED expansion pads](assets/pixel-expantion-mc.png) + +There's also a small power LED indicator that lights up when the board is on. + +You can grab the full schematic and PCB files from the [Modulino Pixels](https://docs.arduino.cc/hardware/modulinos/modulino-pixels) product page. + +## How To Connect Your Modulino + +The easiest and most reliable way to connect your Modulino is through the QWIIC Connect System. It’s plug-and-play, uses standard I²C, and makes it easy to join multiple modules. If your board supports QWIIC, this is the recommended way to go. +Note that the dedicated I²C pins will differ from board to board meaning it is always a good idea to check your specific model. + + +![Modulino Wiring Options QWIIC(A - recommended) and Header(B)](assets/connection-guide-pixels.png) + +## QWIIC Connector +Whenever available, the **QWIIC Connect System** is the preferred method. Connecting to the Modulino is extremely simple, just use a standard QWIIC cable to connect your board to either of the QWIIC connectors on the Modulino. Because the cable and connectors are polarized, there is no need to worry about accidentally swapping connections. + +QWIIC is a plug-and-play I²C Connect System that uses standardized 4-pin connectors: +- GND +- 3.3V +- SDA (Data) +- SCL (Clock) + +![Connection Guide QWIIC](assets/connection-guide-pixels-qwiik.png) + +The Modulino features two QWIIC connectors, which are internally connected in parallel. This means you can daisy-chain multiple modules easily by connecting additional QWIIC cables between them. + +## Solderable Header +When QWIIC is not available, you can use the exposed solderable pins on the module. You can solder pins to the unpopulated pads; just remember the pinout provided in this guide to connect to the right pins of your board. + +![Connection Guide Solder Pads](assets/connection-guide-pixels-jumper.png) + +## Daisy-Chaining Multiple Modulinos + +Regardless of whether you connect the first Modulino via QWIIC or through the solderable pins, you can still take advantage of the extra QWIIC connector to daisy-chain additional modules. + +Each Modulino includes two QWIIC connectors wired in parallel, allowing you to connect one module to the next in a chain. As long as each module is configured with a unique I²C address, they can all communicate on the same bus. + +This approach keeps your setup clean, modular, and expandable without adding extra wiring complexity. + +![Modulino Wiring Options](assets/connection-guide-pixels-qwiic-chain.png) +***The number of modules you can connect will depend on what modules you are chaining together, as this system allows for multiple sensors from different manufacturers to be added. Also, the cables you use for these connections will play a significant role in the setup’s performance. Ensure your cables are properly connected and capable of handling the required data transfer. +Each module should have a unique address on a chain if you plan to address them individually. Later in this article we teach how to [change the address](#how-to-change-i2c-address). Multiple modules with the same address will cause conflicts on the I²C bus and will not allow you to address them individually.*** +Later in this article we teach how to [change the address](#how-to-change-i2c-address). + +### How To Program Your Modulino +To program your Modulino it is recommended you use the official ```Modulino``` micropython library available [here](https://github.com/arduino/arduino-modulino-mpy). The library is fully compatible with the no **Arduino Lab for MicroPython**. +For information on installing the **Arduino Lab for MicroPython** please visit our [page](https://docs.arduino.cc/micropython/first-steps/install-guide/). + +### Installing The Modulino Library +The ```Modulino``` library is not available by default on MicroPython devices hence installation is needed. +To simplify the process the [MicroPython Package Installer](https://github.com/arduino/lab-micropython-package-installer/releases) is recommended as it will provide a graphical interface to guide installation. +After installation, you should now be able to: + +1. Open the tool. +2. Plug in your board to the computer. +![USB Connection](assets/mp-usb-connection.png) + +If the board does not appear in the Detected Boards section, click Reload. If the board is still undetected, ensure no other programs (e.g., a code editor) are using the board's COM port. + +4. Search for the ```Modulino``` package by filling in the text box on the search feature. +5. Click Install and wait for the installation confirmation. +6. Disconnect the board from the tool before returning to your code editor to avoid conflicts due to a busy COM port. + +![Package Installer Overview](assets/package-installer-overview.png) + +The module should now be includable in your program using: +```from modulino import ModulinoBuzzer``` + +### Control RGB LEDs with MicroPython + +Getting LED data from the **Modulino Pixels** module is simple using the `Modulino` library. The crucial functions to control the LEDs are: +- `set_rgb(index, r, g, b, brightness)`: Sets a specific LED to an RGB color with the specified brightness. +- `set_all_rgb(r, g, b, brightness)`: Sets all LEDs to an RGB color with the specified brightness. +- `set_all_color(color, brightness)`: Sets all LEDs to a predefined color. (`RED`,`BLUE`,`GREEN`,`VIOLET`,`WHITE`) +- `clear_all()`: Turns off all LEDs. +- `show()`: Sends the updated data to the LEDs. +- By default the Modulino library uses ```Wire1``` if your board model has a different pinout for the dedicated I²C pins you might have to edit it as instructed [here](https://github.com/arduino/arduino-modulino-mpy/tree/main/docs#%E2%84%B9%EF%B8%8F-using-3rd-party-boards). More information on **Wire** can be found [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/). + +Here’s an example demonstrating how to set colors and create a **Knight Rider animation**: + +```python +from modulino import ModulinoPixels, ModulinoColor +from time import sleep + +pixels = ModulinoPixels() + +# Set each LED to a different color from a color wheel +for index in range(0, 8): + color_wheel_colors = [ + (255, 0, 0), + (255, 85, 0), + (255, 255, 0), + (0, 255, 0), + (0, 255, 255), + (0, 0, 255), + (255, 0, 255), + (255, 0, 0) + ] + pixels.set_rgb(index, *color_wheel_colors[index], 100) +pixels.show() +sleep(1) + +# Set all LEDs to solid colors +pixels.set_all_rgb(255, 0, 0, 100) # Red +pixels.show() +sleep(1) + +pixels.set_all_color(ModulinoColor.GREEN, 100) +pixels.show() +sleep(1) + +pixels.set_all_color(ModulinoColor.BLUE, 100) +pixels.show() +sleep(1) + +# Knight Rider animation +def set_glowing_led(index, r, g, b, brightness): + """ + Set the color of the LED at the given index with its + neighboring LEDs slightly dimmed to create a glowing effect. + """ + pixels.clear_all() + pixels.set_rgb(index, r, g, b, brightness) + + if index > 0: + pixels.set_rgb(index - 1, r, g, b, brightness // 8) # Left LED + if index < 7: + pixels.set_rgb(index + 1, r, g, b, brightness // 8) # Right LED + + pixels.show() + +for j in range(3): + for i in range(8): + set_glowing_led(i, 255, 0, 0, 100) + sleep(0.05) + + for i in range(7, -1, -1): + set_glowing_led(i, 255, 0, 0, 100) + sleep(0.05) + +# Turn off all LEDs +pixels.clear_all().show() +``` +This example shows different ways to control the Pixels. It starts by creating a rainbow pattern using different colors for each LED. Next, it demonstrates setting all LEDs to the same color, using both RGB values and predefined color constants. The final section implements a Knight Rider animation by lighting one main LED at full brightness while slightly illuminating adjacent LEDs at reduced brightness. The `set_glowing_led()` function handles this effect by managing the primary LED and its neighbors, creating a back-and-forth scanning pattern that repeats three times before turning off all LEDs. + +### How To Change Address + +A sketch is also available included with the library named `AddressChanger` and also available [here](https://github.com/arduino/arduino-modulino-mpy/blob/main/examples/change_address.py). This sketch changes the I2C address at a software level on the Module's microcontroller. + +- Connect the module to your board via I2C, ensuring no other modules are in the chain. +- Run the script in a MicroPython environment. +- Follow the on-screen instructions (REPL) to select the device and enter a new address. Valid I²C addresses range from 0x08 to 0x77 (7-bit values in hexadecimal format, e.g., 0x42). +- The script will attempt to change the address and confirm success. + +To keep track of the address in use, the module has a white rectangle on the back. Feel free to use this to write the address that was chosen. + +When using a custom address in your MicroPython sketch, you'll need to specify this address when creating the module object. For example: +```python +pixels_module = ModulinoPixels(address=0x45) # Replace 0x45 with your specific address +``` + +## Troubleshooting + +### LEDs Not Lighting +If your Modulino's power LED isn't on or the RGB LEDs aren't responsive, first check that the board is properly connected: +- Ensure both the board and the Modulino are connected to your computer, and that the power LEDs on both are lit. +- If the issue persists, make sure the Qwiic cable is properly clicked into place. + +### Library Not Installed Properly +If you encounter an issue with the `import ModulinoPixels"` command, verify that the Modulino library is correctly installed: +- Check your IDE to ensure the library is installed and up-to-date. +- Re-install the library through the Library Manager. + +### Incorrect Colors or Flickering +If the LED colors are incorrect or the LEDs are flickering unexpectedly, make sure: +- The brightness values are within the appropriate range (typically 0-255). +- All exposed electronics are not touching any conductive surfaces, as this could interfere with the LED output. +- The power supply is stable and providing sufficient current for all LEDs at the desired brightness. + +# Conclusion + +The **Modulino Pixels** is a digital RGB LED control module that communicates over I²C and follows the Modulino form factor. It includes standard Qwiic connectors for quick, solderless connections and easy daisy-chaining with other modules. Paired with the Modulino library, it makes generating colorful light effects straightforward, allowing you to focus on experimenting or building your system logic. It's a small, reliable module suited for both visual feedback and creative lighting projects. + +# What Is Next? + +Now that you've learned how to use your Modulino Pixels, you're all set to integrate it into your projects! +- Create an animated progress bar that visually displays status, or battery charge level using a gradient of colors. +- Build a live sound level indicator that responds to ambient noise. +- Design a pomodoro timer with color coded work and rest periods to boost your productivity. +- Program an interactive game where players must match patterns of colors in the correct sequence, with difficulty increasing as they progress. diff --git a/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/image.png b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/image.png new file mode 100644 index 0000000000..bceefec75d Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-pixels/tutorials/how-pixels-mp/image.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/datasheet/assets/BlockDiagramThermo.png b/content/hardware/11.accessories/modulinos/modulino-thermo/datasheet/assets/BlockDiagramThermo.png new file mode 100644 index 0000000000..ed1a2136e7 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/datasheet/assets/BlockDiagramThermo.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/datasheet/assets/Modulino_Thermo_Power_Tree.png b/content/hardware/11.accessories/modulinos/modulino-thermo/datasheet/assets/Modulino_Thermo_Power_Tree.png new file mode 100644 index 0000000000..75ecb8a8e7 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/datasheet/assets/Modulino_Thermo_Power_Tree.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/datasheet/assets/TempMec.png b/content/hardware/11.accessories/modulinos/modulino-thermo/datasheet/assets/TempMec.png new file mode 100644 index 0000000000..00e1126bdb Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/datasheet/assets/TempMec.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/datasheet/assets/ThermoPinouts.png b/content/hardware/11.accessories/modulinos/modulino-thermo/datasheet/assets/ThermoPinouts.png new file mode 100644 index 0000000000..26f4ce527c Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/datasheet/assets/ThermoPinouts.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/datasheet/assets/featuredTherm.png b/content/hardware/11.accessories/modulinos/modulino-thermo/datasheet/assets/featuredTherm.png new file mode 100644 index 0000000000..e186b26a5f Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/datasheet/assets/featuredTherm.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/datasheet/datasheet.md b/content/hardware/11.accessories/modulinos/modulino-thermo/datasheet/datasheet.md new file mode 100644 index 0000000000..0a79d564b1 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-thermo/datasheet/datasheet.md @@ -0,0 +1,147 @@ +--- +identifier: ABX00103 +title: Arduino® Modulino® Thermo +type: maker +author: Pedro Sousa Lima +--- + +![](assets/featuredTherm.png) + +# Description +The Modulino® Thermo, featuring the HS3003 sensor, measures both temperature and humidity, making it ideal for environmental monitoring, indoor climate control, and various IoT applications. It provides accurate readings in a compact form factor and integrates seamlessly into the Qwiic ecosystem. + +# Target Areas +Maker, beginner, education + +# Contents + +## Application Examples +The Modulino® Thermo node can be used in numerous scenarios within IoT and electronics projects: + +- **Indoor Climate Control** + Monitor real-time temperature and humidity levels to automatically adjust HVAC systems or trigger alerts. + +- **Greenhouse Monitoring** + Maintain precise growing conditions by tracking changes in humidity and temperature, ensuring plant health and growth. + +- **Smart Home Automation** + Combine the Modulino® Thermo with other nodes, such as movement or distance sensors, to create fully automated home systems that respond to environmental changes. + +
+ +## Features +- Utilizes the **HS3003** sensor to measure temperature and humidity. +- Communicates via **I2C** (Qwiic connector) at 3.3 V (standard). +- Designed with an **additional header** for optional connections. +- Ideal for **environmental monitoring** in IoT and home automation applications. + +### Contents +| **SKU** | **Name** | **Purpose** | **Quantity** | +| -------- | ------------------ | --------------------------------------- | ------------ | +| ABX00103 | Modulino® Thermo | Measure temperature and humidity | 1 | +| | I2C Qwiic cable | Compatible with the Qwiic standard | 1 | + + +## Related Products +- *SKU: ASX00027* – [Arduino® Sensor Kit](https://store.arduino.cc/products/arduino-sensor-kit) +- *SKU: K000007* – [Arduino® Starter Kit](https://store.arduino.cc/products/arduino-starter-kit-multi-language) +- *SKU: AKX00026* – [Arduino® Oplà IoT Kit](https://store.arduino.cc/products/opla-iot-kit) + +## Rating + +### Recommended Operating Conditions +- **Sensor supply range:** 2.3 V – 5.5 V +- **Powered at 3.3 V** through the Qwiic interface (in accordance with the Qwiic standard) +- **Operating temperature:** –40 °C to +125 °C + +**Typical current consumption:** +- ~24.4 µA (at 14-bit resolution, 3.3 V) + +## Power Tree +The power tree for the modulino can be consulted below: + +![Modulino® Thermo Power Tree](assets/Modulino_Thermo_Power_Tree.png) + +## Block Diagram +This module is designed to be placed on an I2C bus, allowing the on-board HS3003 sensor to communicate with a host microcontroller via I2C. + +![Modulino® Thermo block diagram](assets/BlockDiagramThermo.png) + +## Functional Overview +The Modulino® Thermo node uses the HS3003 sensor to measure both temperature and humidity. Data is accessed through I2C (via the Qwiic connector at 3.3 V). It is well-suited for climate control, environmental logging, and wearable IoT. + +### Technical Specifications +| **Specification** | **Details** | +| ----------------------- | ------------------------------------------- | +| **Sensor** | HS3003 | +| **Supply Voltage** | Min: 2.3 V, Max: 5.5 V | +| **Power Consumption** | 24.4 µA (14-bit resolution, 3.3 V supply) | +| **Range** | 0–100% RH, –40 °C to +125 °C | +| **Accuracy** | Humidity: ±2.8% RH, Temperature: ±0.25 °C | +| **Resolution** | 14-bit humidity, 14-bit temperature | +| **Communication** | I2C | + +### Pinout +**Qwiic / I2C (1×4 Header)** +| **Pin** | **Function** | +|---------|-------------------------| +| GND | Ground | +| 3.3 V | Power Supply (3.3 V) | +| SDA | I2C Data | +| SCL | I2C Clock | + +These pads and the Qwiic connectors share the same I2C bus. You can optionally solder header pins here. + +**Note:** The board may also include pads for mounting pull-up resistors, not installed by default. + +![Pinout Overview](assets/ThermoPinouts.png) + + +### Power Specifications +- **Nominal operating voltage:** 3.3 V via Qwiic +- **Sensor voltage range:** 2.3 V–5.5 V + +### Mechanical Information +![Modulino® Thermo Mechanical Information](assets/TempMec.png) + +- Board dimensions: 41 mm × 25.36 mm +- Thickness: 1.6 mm (±0.2 mm) +- Four mounting holes (Ø 3.2 mm) + - Hole spacing: 16 mm vertically, 32 mm horizontally + +### I2C Address Reference +| **Board Silk Name** | **Sensor** | **Modulino I2C Address (HEX)** | **Editable Addresses (HEX)** | **Hardware I2C Address (HEX)** | +|---------------------|-----------|--------------------------------|------------------------------------------|--------------------------------| +| MODULINO THERMO | HS3003 | 0x44 | Any custom address (via software config) | 0x44 | + +**Note:** Default address is **0x44**. Adjustments may be made via software if multiple identical sensors are on the same bus. + +## Device Operation +The Modulino® Thermo node acts as an I2C target device on the Qwiic bus. Simply connect it via a Qwiic cable to the 3.3 V I2C interface of your microcontroller. Read humidity and temperature values via standard I2C transactions. + +### Getting Started +Use the Arduino IDE or Arduino Cloud Editor to program your microcontroller. Libraries for HS3003 or generic humidity/temperature sensors can help streamline data acquisition. Ensure your microcontroller and this node operate on the same 3.3 V reference for the Qwiic bus. + +# Company Information + +| Company name | Arduino SRL | +|-----------------|-----------------------------------------------| +| Company Address | Via Andrea Appiani, 25 - 20900 MONZA（Italy) | + +# Reference Documentation + +| Ref | Link | +| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Arduino IDE (Desktop) | [https://www.arduino.cc/en/Main/Software](https://www.arduino.cc/en/Main/Software) | +| Arduino Courses | [https://www.arduino.cc/education/courses](https://www.arduino.cc/education/courses) | +| Arduino Documentation | [https://docs.arduino.cc/](https://docs.arduino.cc/) | +| Arduino IDE (Cloud) | [https://create.arduino.cc/editor](https://create.arduino.cc/editor) | +| Cloud IDE Getting Started | [https://docs.arduino.cc/cloud/web-editor/tutorials/getting-started/getting-started-web-editor](https://docs.arduino.cc/cloud/web-editor/tutorials/getting-started/getting-started-web-editor) | +| Project Hub | [https://projecthub.arduino.cc/](https://projecthub.arduino.cc/) | +| Library Reference | [https://github.com/arduino-libraries/](https://github.com/arduino-libraries/) | +| Online Store | [https://store.arduino.cc/](https://store.arduino.cc/) | + +# Revision History +| **Date** | **Revision** | **Changes** | +|------------ |------------ |------------------------------------------------| +| 11/07/2024 | 1 | First release | diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/essentials.md b/content/hardware/11.accessories/modulinos/modulino-thermo/essentials.md new file mode 100644 index 0000000000..762e36d575 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-thermo/essentials.md @@ -0,0 +1,8 @@ + + + + +This library allows you to communicate with the Arduino Modulino® nodes. + + + diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/features.md b/content/hardware/11.accessories/modulinos/modulino-thermo/features.md new file mode 100644 index 0000000000..6859a7741a --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-thermo/features.md @@ -0,0 +1,12 @@ + +The Modulino® Thermo module measures temperature and humidity, making it perfect for climate control, environment monitoring, or weather station projects. It is compatible with the Arduino UNO R4 WiFi or any board with a Qwiic interface, ensuring an easy setup. + + + + + Guided examples show you how to read and log environmental data, making it ideal for classroom experiments or home projects involving temperature and humidity. + + + The Modulino® Thermo module connects via Qwiic cables to your UNO R4 WiFi or other boards with a Qwiic interface. If needed, solderable pins let you wire it directly. + + diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/image.svg b/content/hardware/11.accessories/modulinos/modulino-thermo/image.svg new file mode 100644 index 0000000000..2dbb2acbef --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-thermo/image.svg @@ -0,0 +1,560 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/product.md b/content/hardware/11.accessories/modulinos/modulino-thermo/product.md new file mode 100644 index 0000000000..a31d85c37c --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-thermo/product.md @@ -0,0 +1,11 @@ +--- +title: Modulino® Thermo +url_shop: https://store.arduino.cc/products/modulino-thermo +url_guide: https://courses.arduino.cc/plugandmake +primary_button_url: https://courses.arduino.cc/plugandmake +primary_button_title: Get Started +certifications: [] +sku: [ABX00103] +--- + +Monitor temperature and humidity seamlessly with the HS3003 sensor. Whether building a weather station or a climate control project, this module makes data capture straightforward. Designed for Arduino UNO R4 WiFi or any Qwiic-capable board; solderable pins provide an alternative wiring option. diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tech-specs.md b/content/hardware/11.accessories/modulinos/modulino-thermo/tech-specs.md new file mode 100644 index 0000000000..57ca951777 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-thermo/tech-specs.md @@ -0,0 +1 @@ +Here you will find the technical specifications for the Modulino® Thermo. \ No newline at end of file diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tech-specs.yml b/content/hardware/11.accessories/modulinos/modulino-thermo/tech-specs.yml new file mode 100644 index 0000000000..045e3f4f44 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-thermo/tech-specs.yml @@ -0,0 +1,11 @@ +Node: + Name: Modulino Thermo + SKU: ABX00103 + Board recommended: Arduino® UNO R4 WiFi (ABX00087) + Communications: I2C (over Qwiic connector or solderable pin) + Operational voltage: 3.3V + Sensor: + HS3003: 0x44 + +Other accessories: + Qwiic cables: 1x diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/IDE-Left-Tab.png b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/IDE-Left-Tab.png new file mode 100644 index 0000000000..c7bb86575e Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/IDE-Left-Tab.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/Modulino_Thermo_Power_Tree.png b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/Modulino_Thermo_Power_Tree.png new file mode 100644 index 0000000000..75ecb8a8e7 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/Modulino_Thermo_Power_Tree.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/ThermoPinouts.jpg b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/ThermoPinouts.jpg new file mode 100644 index 0000000000..22c8b59c70 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/ThermoPinouts.jpg differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/connection-guide-thermo-jumper.png b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/connection-guide-thermo-jumper.png new file mode 100644 index 0000000000..0742e36a31 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/connection-guide-thermo-jumper.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/connection-guide-thermo-qwiic-chain.png b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/connection-guide-thermo-qwiic-chain.png new file mode 100644 index 0000000000..28d62417a5 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/connection-guide-thermo-qwiic-chain.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/connection-guide-thermo-qwiik.png b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/connection-guide-thermo-qwiik.png new file mode 100644 index 0000000000..e10a27ebdb Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/connection-guide-thermo-qwiik.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/connection-guide-thermo.png b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/connection-guide-thermo.png new file mode 100644 index 0000000000..35591967a9 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/connection-guide-thermo.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/library-install.gif b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/library-install.gif new file mode 100644 index 0000000000..16f396c353 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/library-install.gif differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/schematic.png b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/schematic.png new file mode 100644 index 0000000000..b094fac53d Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/assets/schematic.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/content.md b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/content.md new file mode 100644 index 0000000000..f6f063e8b5 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/content.md @@ -0,0 +1,199 @@ +--- +title: "How To Use The Modulino Thermo" +description: "Learn how to get the most out of your Modulino Thermo." +tags: + - Modulino + - QWIIC + - I2C +author: 'Pedro Sousa Lima' +hardware: + - hardware/11.modulinos/modulinos/modulino-thermo +software: + - ide-v2 + - web-editor +--- +The Modulino Thermo is a modular sensor that measures temperature and humidity, making it perfect to add environmental monitoring to your projects! +The Modulino form factor is shaped with two QWIIC connectors and the I²C protocol integration, allowing the connection and programming of multiple modulinos in a very simple way. In addition to the QWIIC's connectors, the Modulinos also expose solderable pins that can be used in multiple ways and make them compatible with boards that are not QWIIC compatible. + +# General Characteristics + +The Modulino Thermo is capable of measuring temperature and relative humidity. Take a look at the following table to know more about its measuring ranges: + + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|-----------|-------------|---------|---------|---------|------| +| Range | Temperature | \-40 | \- | +125 | °C | +| \- | Humidity | 0 | \- | 100% | φ RH | +| Accuracy | Temperature | \- | ±0,25 | \- | °C | +| \- | Humidity | \- | ±2.8% | \- | φ | + +## Sensor Details + +The HS3003 sensor from Renesas is the core component of this module. This temperature and humidity sensor natively supports digital communication (I²C), meaning it connects directly to the I²C bus on the module without requiring additional conversion circuitry. + +The default address for the Module is: +| Modulino I²C Address | Hardware I²C Address | +|----------------------|----------------------| +| 0x44 | 0x44 | + +***Note: Since the address cannot be changed on this Modulino specifically, using two or more identical modules on the same I²C bus will result in address conflicts and cause communication issues.*** + +## Pinout + +The pinout for the Modulino Thermo is shown below. Please note that the exposed solderable pins are directly connected to the QWIIC connectors using the same I²C interface. + +![Arduino Thermo Pinout](assets/ThermoPinouts.jpg) + +Depending on the board connected to the modulino, the I²C pin names to program it may differ. Please check the [board tutorials](https://docs.arduino.cc/hardware/) on your modulino's compatible board or the [Modulino library](https://github.com/arduino-libraries/Modulino/tree/main/docs) to learn more. + +## Power Specifications + +The board is typically powered by +3.3 VDC when using the QWIIC interface as per the I²C standard. + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|-----------------|-------------------------------------------------------------------|---------|-------------|---------|------| +| Supply Voltage | \- | 2.3 | 3.3 (QWIIC) | 5.5 | V | +| Average Current | 1 humidity + temperature measurement/s 3.3 VDD - Max 5,5@ 3.3 VDD | \- | 1024.4 | 24.4 | µA | + +The module includes a power LED that draws 1 mA and turns on as soon as it is powered. +J1 (Qwiic connector), J2 (Qwiic connector), and the headers all share the same power branch. The power distribution of the module is therefore as follows: +![Power Tree Modulino Thermo](assets/Modulino_Thermo_Power_Tree.png) + +## Schematic + +The Modulino Thermo uses a simple circuit, as shown in the schematic below: +![Full Schematic Modulino Thermo](assets/schematic.png) +The main component is the **HS3003** sensor (U1), which handles both temperature and humidity measurements, as well as I²C communication. +You can connect to the I²C pins (SDA and SCL) using either the **QWIIC connectors** (J1 and J2, this is the recommended method) or the **solderable pins** (J4). The board runs on **3.3V**, which comes from the QWIIC cable or the **3V3 pin** on J4. +There's also a small power indicator LED that lights up when the board is on. +You can grab the full schematic and PCB files from the [Modulino Thermo](https://docs.arduino.cc/hardware/modulinos/modulino-thermo) product page. + +# How To Connect Your Modulino + +The easiest and most reliable way to connect your Modulino is through the QWIIC Connect System. It’s plug-and-play, uses standard I²C, and makes it easy to join multiple modules. If your board supports QWIIC, this is the recommended way to go. Note that the dedicated I²C pins will differ from board to board meaning it is always a good idea to check your specific model. + +If your board doesn’t have a QWIIC connector, you can still access the same I²C bus and power the module using the solderable header pads just make sure you wire it to 3.3V and match the I²C pinout. + +![Modulino Wiring Options QWIIC(A - recommended) and Header(B)](assets/connection-guide-thermo.png) + +## QWIIC Connector + +Whenever available, the **QWIIC Connect System** is the preferred method. Connecting to the Modulino is extremely simple, just use a standard QWIIC cable to connect your board to either of the QWIIC connectors on the Modulino. Because the cable and connectors are polarized, there is no need to worry about accidentally swapping connections. + +QWIIC is a plug-and-play I²C Connect System that uses standardized 4-pin connectors: +- GND +- 3.3V +- SDA (Data) +- SCL (Clock) + +![Connection Guide QWIIC](assets/connection-guide-thermo-qwiik.png) + +The Modulino features two QWIIC connectors, which are internally connected in parallel. This means you can daisy-chain multiple modules easily by connecting additional QWIIC cables between them. + +## Solderable Header +When QWIIC is not available, you can use the exposed solderable pins on the module. You can solder pins to the unpopulated pads; just remember the pinout provided in this guide to connect to the right pins of your board. + +![Connection Guide Solder Pads](assets/connection-guide-thermo-jumper.png) + +## Daisy-Chaining Multiple Modulinos + +Regardless of whether you connect the first Modulino via QWIIC or through the solderable pins, you can still take advantage of the extra QWIIC connector to daisy-chain additional modules. + +Each Modulino includes two QWIIC connectors wired in parallel, allowing you to connect one module to the next in a chain. As long as each module is configured with a unique I²C address, they can all communicate on the same bus as long as you select the correct I²C pins depending on your board. + +This approach keeps your setup clean, modular, and expandable without adding extra wiring complexity. + +![Modulino Wiring Options](assets/connection-guide-thermo-qwiic-chain.png) +***The number of modules you can connect will depend on what modules you are chaining together, as this system allows for multiple sensors from different manufacturers to be added. Also, the cables you use for these connections will play a significant role in the setup’s performance. Ensure your cables are correctly connected and capable of handling the required data transfer. +Each module should have a unique address on a chain if you plan to address them individually. Multiple modules with the same address will cause conflicts on the I²C bus.*** + +# How To Use Your Modulino + +## Installing The Modulino Library +You need the official Modulino library available [here](https://docs.arduino.cc/libraries/modulino/) to use the Modulino Thermo. + +With the Arduino IDE you get some tools that make adding a library easier. To learn how to install the IDE please visit our [page](https://docs.arduino.cc/software/ide-v2/tutorials/getting-started/ide-v2-downloading-and-installing/). +After opening the IDE, a tab should be visible on the left. Press the book icon for "library" as highlighted in the image. +![IDE Library Tab](assets/IDE-Left-Tab.png) +The process should look like this: +![Library Install](assets/library-install.gif) +A message will appear after the installation is successful. + + +## Getting Temperature And Humidity Data + +Getting data from the sensor is fairly simple using the ```Modulino``` library. For the **Modulino Thermo** there are two important functions: +- ```getTemperature()```: Provides the temperature measurement from the sensor. (default in Celsius C) +- ```getHumidity()```: Provides the relative humidity measurement from the sensor. (default in Relative Percentage %) +- ```Modulino.begin();```: By default the Modulino library uses ```Wire1``` if your connection is in a different Wire you will have to edit it, check [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/) (by default the Modulino library uses ```Wire1``` if your board model has a different pinout for the dedicated I²C pins you might have to edit it. More information on **Wire** can be found [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/)) for the library's hardware compatibility. More information on **Wire** can be found [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/). + +Here is an example sketch of how to implement these functions to acquire data and show it using the serial monitor: + +```arduino +#include + +// Create object instance +ModulinoThermo thermo; + +// Global Variables +float celsius = 0; +float humidity = 0; + +void setup(){ + // Initialization of the serial port, modulino object and thermo one + + Serial.begin(115200); + Modulino.begin(); + thermo.begin(); +} + +void loop(){ + celsius = thermo.getTemperature(); + humidity = thermo.getHumidity(); + + Serial.print("Temperature (C) is: "); + Serial.println(celsius); + + Serial.print("Humidity (rH) is: "); + Serial.println(humidity); + + delay(1000); +} +``` + +The code example provided shows how to initialize the sensor, read the data, and display it on the serial monitor. The data is updated every second, showing the current temperature and humidity values in real time. +It can be easily adapted to trigger actions at certain temperature/humidity thresholds or to log data for analysis. + +## Troubleshooting + + ### Sensor Not Reachable + + If your Modulino's power LED isn't on or the sensor isn't responsive, first check that the board is properly connected: + + - Ensure both the board and the Modulino are connected to your computer, and that the power LEDs on both are lit. + - If the issue persists, make sure the Qwiic cable is properly clicked into place. + + ### Library Not Installed Properly + + If you encounter an issue with the `#include "modulino.h"` command, verify that the Modulino library is correctly installed: + - Check your IDE to ensure the library is installed and up-to-date. + - Re-install the library through the Library Manager. + + ### Inaccurate Values + +If the sensor values are not accurate, make sure: +- The sensor is not placed near any components that might generate heat (like motors or power supplies). +- All exposed electronics are not touching any conductive surfaces, as this could interfere with readings. + +# What Is Next? + +Now that you've learned how to use your Modulino Thermo, you're all set to integrate it into your projects! + +- Experiment with temperature and humidity. What happens if you place your Modulino in the refrigerator? +- Try breathing near the sensor. Does the humidity change? +- Place your Modulino on the outside of your mug and fill it with a hot beverage. Can you create an automatic system to know when your tea has cooled down? +- How does the temperature change throughout the day at home? Let your Modulino run for an entire day and check out the data! + +# Conclusion + +The **Modulino Thermo** is a digital temperature and humidity sensor that communicates over I²C and follows the Modulino form factor. It includes standard Qwiic connectors for quick, solderless connections and easy daisy-chaining with other modules. Paired with the Modulino library, it makes accessing sensor data straightforward, allowing you to focus on experimenting or building your system logic. It’s a small, reliable module suited for both quick tests and longer-term setups. \ No newline at end of file diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/image.png b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/image.png new file mode 100644 index 0000000000..bceefec75d Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-ardu/image.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/Modulino_Thermo_Power_Tree.png b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/Modulino_Thermo_Power_Tree.png new file mode 100644 index 0000000000..75ecb8a8e7 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/Modulino_Thermo_Power_Tree.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/ThermoPinouts.jpg b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/ThermoPinouts.jpg new file mode 100644 index 0000000000..22c8b59c70 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/ThermoPinouts.jpg differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/connection-guide-thermo-jumper.png b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/connection-guide-thermo-jumper.png new file mode 100644 index 0000000000..650231c828 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/connection-guide-thermo-jumper.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/connection-guide-thermo-qwiic-chain.png b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/connection-guide-thermo-qwiic-chain.png new file mode 100644 index 0000000000..28d62417a5 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/connection-guide-thermo-qwiic-chain.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/connection-guide-thermo-qwiik.png b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/connection-guide-thermo-qwiik.png new file mode 100644 index 0000000000..e10a27ebdb Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/connection-guide-thermo-qwiik.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/connection-guide-thermo.png b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/connection-guide-thermo.png new file mode 100644 index 0000000000..35591967a9 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/connection-guide-thermo.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/mp-usb-connection.png b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/mp-usb-connection.png new file mode 100644 index 0000000000..fb059f9e8b Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/mp-usb-connection.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/package-installer-overview.png b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/package-installer-overview.png new file mode 100644 index 0000000000..67678dc808 Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/package-installer-overview.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/schematic.png b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/schematic.png new file mode 100644 index 0000000000..b094fac53d Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/assets/schematic.png differ diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/content.md b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/content.md new file mode 100644 index 0000000000..ab46a3f786 --- /dev/null +++ b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/content.md @@ -0,0 +1,198 @@ +--- +title: "How To Use The Modulino Thermo And MicroPython" +description: "Learn how to get the most out of your Modulino Thermo in a MicroPython environment." +tags: + - Modulino + - QWIIC + - I2C +author: 'Pedro Sousa Lima' +hardware: + - hardware/11.modulinos/modulinos/modulino-thermo +software: + - ide-v2 + - web-editor +--- +The Modulino Thermo is a modular sensor that measures temperature and humidity, making it perfect to add environmental monitoring to your projects! +The Modulino form factor is shaped with two QWIIC connectors and the I²C protocol integration, allowing the connection and programming of multiple modulinos in a very simple way. In addition to the QWIIC's connectors, the Modulinos also expose solderable pins that can be used in multiple ways and make them compatible with boards that are not QWIIC compatible. + +# General Characteristics + +The Modulino Thermo is capable of measuring temperature and relative humidity. Take a look at the following table to know more about its measuring ranges: + + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +| --------- | ----------- | ------- | ------- | ------- | ---- | +| Range | Temperature | \-40 | \- | +125 | °C | +| \- | Humidity | 0 | \- | 100% | φ RH | +| Accuracy | Temperature | \- | ±0,25 | \- | °C | +| \- | Humidity | \- | ±2.8% | \- | φ | + +## Sensor Details + +The HS3003 sensor from Renesas is the core component of this module. This temperature and humidity sensor natively supports digital communication (I²C), meaning it connects directly to the I²C bus on the module without requiring additional conversion circuitry. + +The default address for the Module is: +| Modulino I²C Address | Hardware I²C Address | +| -------------------- | -------------------- | +| 0x44 | 0x44 | + +***Note: Since the address cannot be changed on this Modulino specifically, using two or more identical modules on the same I²C bus will result in address conflicts and cause communication issues.*** + +## Pinout + +The pinout for the Modulino Thermo is shown below. Please note that the exposed solderable pins are directly connected to the QWIIC connectors using the same I²C interface. + +![Arduino Thermo Pinout](assets/ThermoPinouts.jpg) + +Depending on the board connected to the modulino, the I²C pin names to program it may differ. Please check the [board tutorials](https://docs.arduino.cc/hardware/) on your modulino's compatible board or the [Modulino library](https://github.com/arduino-libraries/Modulino/tree/main/docs) to learn more. + +## Power Specifications + +The board is typically powered by +3.3 VDC when using the QWIIC interface as per the I²C standard. + +| Parameter | Condition | Minimum | Typical | Maximum | Unit | +|-----------------|-------------------------------------------------------------------|---------|-------------|---------|------| +| Supply Voltage | \- | 2.3 | 3.3 (QWIIC) | 5.5 | V | +| Average Current | 1 humidity + temperature measurement/s 3.3 VDD - Max 5,5@ 3.3 VDD | \- | 1024.4 | 24.4 | µA | + +The module includes a power LED that draws 1 mA and turns on as soon as it is powered. +J1 (Qwiic connector), J2 (Qwiic connector), and the headers all share the same power branch. The power distribution of the module is therefore as follows: +![Power Tree Modulino Thermo](assets/Modulino_Thermo_Power_Tree.png) + +## Schematic + +The Modulino Thermo uses a simple circuit, as shown in the schematic below: +![Full Schematic Modulino Thermo](assets/schematic.png) +The main component is the **HS3003** sensor (U1), which handles both temperature and humidity measurements, as well as I²C communication. +You can connect to the I²C pins (SDA and SCL) using either the **QWIIC connectors** (J1 and J2, this is the recommended method) or the **solderable pins** (J4). The board runs on **3.3V**, which comes from the QWIIC cable or the **3V3 pin** on J4. +There's also a small power indicator LED that lights up when the board is on. +You can grab the full schematic and PCB files from the [Modulino Thermo](https://docs.arduino.cc/hardware/modulinos/modulino-thermo) product page. + +# How To Connect Your Modulino + +The easiest and most reliable way to connect your Modulino is through the QWIIC Connect System. It’s plug-and-play, uses standard I²C, and makes it easy to join multiple modules. If your board supports QWIIC, this is the recommended way to go. Note that the dedicated I²C pins will differ from board to board meaning it is always a good idea to check your specific model. + +If your board doesn’t have a QWIIC connector, you can still access the same I²C bus and power the module using the solderable header pads just make sure you wire it to 3.3V and match the I²C pinout. + +![Modulino Wiring Options QWIIC(A - recommended) and Header(B)](assets/connection-guide-thermo.png) + +## QWIIC Connector + +Whenever available, the **QWIIC Connect System** is the preferred method. Connecting to the Modulino is extremely simple, just use a standard QWIIC cable to connect your board to either of the QWIIC connectors on the Modulino. Because the cable and connectors are polarized, there is no need to worry about accidentally swapping connections. + +QWIIC is a plug-and-play I²C Connect System that uses standardized 4-pin connectors: +- GND +- 3.3V +- SDA (Data) +- SCL (Clock) + +![Connection Guide QWIIC](assets/connection-guide-thermo-qwiik.png) + +The Modulino features two QWIIC connectors, which are internally connected in parallel. This means you can daisy-chain multiple modules easily by connecting additional QWIIC cables between them. + +## Solderable Header +When QWIIC is not available, you can use the exposed solderable pins on the module. You can solder pins to the unpopulated pads; just remember the pinout provided in this guide to connect to the right pins of your board. + +![Connection Guide Solder Pads](assets/connection-guide-thermo-jumper.png) + +## Daisy-Chaining Multiple Modulinos + +Regardless of whether you connect the first Modulino via QWIIC or through the solderable pins, you can still take advantage of the extra QWIIC connector to daisy-chain additional modules. + +Each Modulino includes two QWIIC connectors wired in parallel, allowing you to connect one module to the next in a chain. As long as each module is configured with a unique I²C address, they can all communicate on the same bus as long as you select the correct I²C pins depending on your board. + +This approach keeps your setup clean, modular, and expandable without adding extra wiring complexity. + +![Modulino Wiring Options](assets/connection-guide-thermo-qwiic-chain.png) +***The number of modules you can connect will depend on what modules you are chaining together, as this system allows for multiple sensors from different manufacturers to be added. Also, the cables you use for these connections will play a significant role in the setup’s performance. Ensure your cables are correctly connected and capable of handling the required data transfer. +Each module should have a unique address on a chain if you plan to address them individually. Multiple modules with the same address will cause conflicts on the I²C bus.*** + +# How To Program Your Modulino + +## Installing The Modulino Library +To program your Modulino it is recommended you use the official ```Modulino``` micropython library available [here](https://github.com/arduino/arduino-modulino-mpy). The library is fully compatible with the no **Arduino Lab for MicroPython**. +For information on installing the **Arduino Lab for MicroPython** please visit our [page](https://docs.arduino.cc/micropython/first-steps/install-guide/). + +The ```Modulino``` library is not available by default on MicroPython devices hence installation is needed. +To simplify the process the [MicroPython Package Installer](https://github.com/arduino/lab-micropython-package-installer/releases) is recommended as it will provide a graphical interface to guide installation. +After installation, you should now be able to: + +1. Open the tool. +2. Plug in your board to the computer. +![USB Connection](assets/mp-usb-connection.png) + +If the board does not appear in the Detected Boards section, click Reload. If the board is still undetected, ensure no other programs (e.g., a code editor) are using the board's COM port. + +4. Search for the ```Modulino``` package by filling in the text box on the search feature. +5. Click Install and wait for the installation confirmation. +6. Disconnect the board from the tool before returning to your code editor to avoid conflicts due to a busy COM port. + +![Package Installer Overview](assets/package-installer-overview.png) + +The module should now be includable in your program using: +```from modulino import ModulinoThermo``` + +## Get Temperature And Humidity Data + +Getting data from the sensor is fairly simple using the ```Modulino``` library. +For the **Thermo** there are two crucial functions: +- ```.temperature``` - Provides the temperature measurement from the sensor. (Default in °C) +- ```.relative_humidity``` - Provides the relative humidity from the sensor. (Default in %) +By default the Modulino library uses ```Wire1``` if your board model has a different pinout for the dedicated I²C pins you might have to edit it as instructed [here](https://github.com/arduino/arduino-modulino-mpy/tree/main/docs#%E2%84%B9%EF%B8%8F-using-3rd-party-boards). More information on **Wire** can be found [here](https://docs.arduino.cc/language-reference/en/functions/communication/wire/). + +Here is an example of how to implement these functions to acquire data: + +```python +from modulino import ModulinoThermo +from time import sleep + +thermo_module = ModulinoThermo() + +while True:     + temperature = thermo_module.temperature + humidity = thermo_module.relative_humidity +    +    if temperature != None and humidity != None: +        print(f"🌡️ Temperature: {temperature:.1f} °C") +        print(f"💧 Humidity: {humidity:.1f} %")     +        print() +        +    sleep(2) +``` + +The code example provided shows how to initialize the sensor, read the data, and display it on the serial monitor. The data is updated every second, showing the current temperature and humidity values in real time. +It can be easily adapted to trigger actions at certain temperature/humidity thresholds or to log data for analysis. + +### Troubleshooting + + #### Sensor Not Reachable + + If your Modulino's power LED isn't on or the sensor isn't responsive, first check that the board is properly connected: + + - Ensure both the board and the Modulino are connected to your computer, and that the power LEDs on both are lit. + - If the issue persists, make sure the Qwiic cable is properly clicked into place. + + #### Library Not Installed Properly + + If you encounter an issue with the `#include "modulino.h"` command, verify that the Modulino library is correctly installed: + - Check your IDE to ensure the library is installed and up-to-date. + - Re-install the library through the Library Manager. + + #### Inaccurate Values + +If the sensor values are not accurate, make sure: +- The sensor is not placed near any components that might generate heat (like motors or power supplies). +- All exposed electronics are not touching any conductive surfaces, as this could interfere with readings. + +# What Is Next? + +Now that you've learned how to use your Modulino Thermo, you're all set to integrate it into your projects! + +- Experiment with temperature and humidity. What happens if you place your Modulino in the refrigerator? +- Try breathing near the sensor. Does the humidity change? +- Place your Modulino on the outside of your mug and fill it with a hot beverage. Can you create an automatic system to know when your tea has cooled down? +- How does the temperature change throughout the day at home? Let your Modulino run for an entire day and check out the data! + +# Conclusion + +The **Modulino Thermo** is a digital temperature and humidity sensor that communicates over I²C and follows the Modulino form factor. It includes standard Qwiic connectors for quick, solderless connections and easy daisy-chaining with other modules. Paired with the Modulino library, it makes accessing sensor data straightforward, allowing you to focus on experimenting or building your system logic. It’s a small, reliable module suited for both quick tests and longer-term setups. \ No newline at end of file diff --git a/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/image.png b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/image.png new file mode 100644 index 0000000000..bceefec75d Binary files /dev/null and b/content/hardware/11.accessories/modulinos/modulino-thermo/tutorials/how-thermo-mp/image.png differ