Tutorials ready

Author: mcmchris

content/hardware/03.nano/boards/nano-matter/tutorials/matter-fan/assets/add-device-2.png

@@ -17,4 +17,198 @@ software:
   - ide-v2
   - web-editor
   - iot-cloud
----
+---
+
+## Overview
+
+This tutorial will teach you how to create a Matter fan for keeping you cool. 
+
+![Matter fan overview](assets/thumbnail-v4.png)
+
+Thanks to the seamless compatibility of the Nano Matter with almost any Matter network we can easily integrate our fan with Amazon Alexa, Google Assistant, Apple Home, Home Assistant and even custom assistants.
+
+## Hardware and Software Requirements
+### Hardware Requirements
+
+- [Nano Matter](https://store.arduino.cc/products/nano-matter) (x1)
+- Grove motor driver module (x1)
+- DC motor (x1)
+- Breadboard (x1)
+- Jumper wires
+- Google Nest Hub Max (Thread Border Router) (x1)
+- [USB-C® cable](https://store.arduino.cc/products/usb-cable2in1-type-c) (x1)
+
+### Software Requirements
+
+- [Arduino IDE 2.0+](https://www.arduino.cc/en/software) or [Arduino Cloud Editor](https://create.arduino.cc/editor)
+- [Google Home App](https://home.google.com/get-app/)
+
+### Board Core and Libraries
+
+The **Silicon Labs** core contains the libraries and examples you need to work with the board's components, such as its Matter, Bluetooth® Low Energy, and I/Os. To install the Nano Matter core, navigate to **File > Preferences** and in the **Additional boards manager URLs**, add the following:
+
+`https://siliconlabs.github.io/arduino/package_arduinosilabs_index.json`
+
+Now navigate to **Tools > Board > Boards Manager** or click the Boards Manager icon in the left tab of the IDE. In the Boards Manager tab, search for `Nano Matter` and install the latest `Silicon Labs` core version.
+
+![Installing the Silicon Labs core in the Arduino IDE](assets/bsp-install-2.png)
+
+## Project Setup
+
+### Schematic Diagram
+
+Use the following connection diagram for the project:
+
+![Project wiring diagram](assets/diagram-v4.png)
+
+### Programming
+
+In the Arduino IDE upper menu, navigate to **Tools > Protocol stack** and select **Matter**.
+
+![Matter Protocol stack selected](assets/matter-setup-2.png)
+
+Copy and paste the following sketch:
+
+```arduino
+#include <Matter.h>
+#include <MatterFan.h>
+
+#define fan_pin D4
+
+MatterFan matter_fan;
+
+void setup()
+{
+  Serial.begin(115200);
+  Matter.begin();
+  matter_fan.begin();
+
+  pinMode(BTN_BUILTIN, INPUT_PULLUP);
+  pinMode(LEDR, OUTPUT);
+  digitalWrite(LEDR, HIGH);
+
+  pinMode(fan_pin, OUTPUT);
+
+  Serial.println("Matter fan");
+
+  if (!Matter.isDeviceCommissioned()) {
+    Serial.println("Matter device is not commissioned");
+    Serial.println("Commission it to your Matter hub with the manual pairing code or QR code");
+    Serial.printf("Manual pairing code: %s\n", Matter.getManualPairingCode().c_str());
+    Serial.printf("QR code URL: %s\n", Matter.getOnboardingQRCodeUrl().c_str());
+  }
+  while (!Matter.isDeviceCommissioned()) {
+    delay(200);
+  }
+
+  Serial.println("Waiting for Thread network...");
+  while (!Matter.isDeviceThreadConnected()) {
+    delay(200);
+    decommission_handler();
+  }
+  Serial.println("Connected to Thread network");
+
+  Serial.println("Waiting for Matter device discovery...");
+  while (!matter_fan.is_online()) {
+    delay(200);
+    decommission_handler();
+  }
+  Serial.println("Matter device is now online");
+}
+
+void loop()
+{
+  decommission_handler();
+  static uint8_t fan_last_speed = 0;
+  uint8_t fan_current_speed = matter_fan.get_percent();
+
+  if (fan_current_speed != fan_last_speed) {
+    fan_last_speed = fan_current_speed;
+    Serial.print("Fan speed: ");
+    Serial.print(fan_current_speed);
+    Serial.println("%");
+    int speed = map(fan_current_speed, 0, 100, 0, 255);
+    analogWrite(fan_pin, speed);
+  }
+
+  static bool fan_last_state = false;
+  bool fan_current_state = matter_fan.get_onoff();
+
+  if (fan_current_state != fan_last_state) {
+    fan_last_state = fan_current_state;
+    if (fan_current_state) {
+      Serial.println("Fan ON");
+    } else {
+      Serial.println("Fan OFF");
+    }
+  }
+}
+
+void decommission_handler()
+{
+  // If the button is not pressed or the device is not commissioned - return
+  if (digitalRead(BTN_BUILTIN) != LOW || !Matter.isDeviceCommissioned()) {
+    return;
+  }
+
+  // Store the time when the button was first pressed
+  uint32_t start_time = millis();
+  // While the button is being pressed
+  while (digitalRead(BTN_BUILTIN) == LOW) {
+    // Calculate the elapsed time
+    uint32_t elapsed_time = millis() - start_time;
+    // If the button has been pressed for less than 10 seconds, continue
+    if (elapsed_time < 10000u) {
+      yield();
+      continue;
+    }
+
+    // Blink the LED to indicate the start of the decommissioning process
+    for (uint8_t i = 0u; i < 10u; i++) {
+      digitalWrite(LED_BUILTIN, !(digitalRead(LED_BUILTIN)));
+      delay(100);
+    }
+
+    Serial.println("Starting decommissioning process, device will reboot...");
+    Serial.println();
+    digitalWrite(LED_BUILTIN, LED_BUILTIN_INACTIVE);
+    // This function will not return
+    // The device will restart once decommissioning has finished
+    Matter.decommission();
+  }
+}
+```
+
+This is a very simple code that consist of the Arduino basic sketch parts:
+- In the `setup()` function we initialize the Matter connectivity and the fan output pin. 
+- In the `loop()` function we listen to any fan control command sent from the smartphone or voice assistant and then adjust the fan speed setting the PWM signal accordingly.
+
+Once you uploaded the example code to the Nano Matter, open the Serial Monitor and reset the board.
+
+![QR Code URL](assets/serial-monitor-v4.png)
+
+There you will find the URL that generates the QR for the Matter device commissioning.
+
+### Commissioning 
+
+Copy and paste the QR code URL on your favorite web browser and a unique QR code will be generated for your board.
+
+Go to your **Google Home** app, navigate to **devices** and tap on **Add**, select the **Matter-enabled device** option and scan the QR code.
+
+![Adding the device to Google Home app](assets/add-device.png)
+
+![Your device is successfully added](assets/add-device-2.png)
+
+## Final Results
+
+Finally, you will be able to control the fan from your smartphone, hub or asking your personal assistant.
+
+![Matter fan final result](assets/matter-fan.gif)
+
+## Conclusion
+
+In this tutorial we have learned how to create a Matter enabled fan that can be controlled from our smartphone and personal assistant. The Nano Matter allows us to seamlessly integrate the fan as a commercial product with our current smart home ecosystem.
+
+### Next Steps
+
+You can take this solution even further by adding an external knob to adjust the fan speed manually or integrating an AC motor driver to control an actual ceiling fan.