SinricPro_Generic Library

---

---

Table of Contents

• Full user documentation
• Changelog
• Prerequisites
• Installation
  • Use Arduino Library Manager
  • Manual Install
  • VS Code & PlatformIO
• Packages' Patches
  • 1. For Adafruit nRF52840 and nRF52832 boards
  • 2. For Teensy boards
  • 3. For Arduino SAM DUE boards
  • 4. For Arduino SAMD boards
    • For core version v1.8.10+
    • For core version v1.8.9-
  • 5. For Adafruit SAMD boards
  • 6. For Seeeduino SAMD boards
  • 7. For STM32 boards
    • 7.1. For STM32 boards to use LAN8720
    • 7.2. For STM32 boards to use Serial1
  • 8. For RP2040-based boards using Earle Philhower arduino-pico core
    • 8.1. To use BOARD_NAME
    • 8.2. To avoid compile error relating to microsecondsToClockCycles
  • 9. For Portenta_H7 boards using Arduino IDE in Linux
  • 10. For RTL8720DN boards using AmebaD core
  • 11. For SAMD21 and SAMD51 boards using ArduinoCore-fab-sam core
  • 12. For Seeeduino RP2040 boards
  • 13. For Seeeduino nRF52840 boards
• Libraries' Patches
  • 1. For application requiring 2K+ HTML page
  • 2. For Ethernet library
  • 3. For EthernetLarge library
  • 4. For Etherne2 library
  • 5. For Ethernet3 library
  • 6. For UIPEthernet library
  • 7. For fixing ESP32 compile error
  • 8. For fixing ESP8266 compile error
• HOWTO Use analogRead() with ESP32 running WiFi and/or BlueTooth (BT/BLE)
  • 1. ESP32 has 2 ADCs, named ADC1 and ADC2
  • 2. ESP32 ADCs functions
  • 3. ESP32 WiFi uses ADC2 for WiFi functions
• Important Notes
• Configuration Notes
  • 1. How to select which built-in Ethernet or shield to use
  • Important
  • 2. How to select another CS/SS pin to use
  • 3. How to use W5x00 with ESP8266
  • 4. How to increase W5x00 TX/RX buffer
  • 5. How to adjust sendContent_P() and send_P() buffer size
  • 6. How to use SPI2 for ESP32 using W5x00 and Ethernet_Generic Library
  • 7. How to use SPI1 for RP2040 using W5x00 and Ethernet_Generic Library
• Important Notes
• Examples
  • Examples for ESP32/ESP8266
    • ESP32/ESP8266 examples
  • Examples for Generic Boards (SAMD, nRF52, STM32, SAM DUE, etc.)
    • Generic Boards examples
  • Examples for WT32_ETH01
• HOWTO Usage
  • Include SinricPro-Library (SinricPro_Generic.h) and SinricPro-Device-Libraries (eg. SinricProSwitch.h)
  • Define your credentials from SinricPro-Portal (portal.sinric.pro)
  • Define callback routine(s)
  • In setup()
  • In loop()
• HOWTO Add a device
  • Example
  • Example 2 (alternatively)
• How to retrieve a device for sending an event?
  • Example 1
  • Example 2 (alternatively)
• Example SAMD_WiFiNINA_Switch
  • 1. File SAMD_WiFiNINA_Switch.ino
  • 2. File defines.h
• Debug Terminal Output Samples
  • 1. SAMD_WiFiNINA_TV on NANO_33_IOT
  • 2. SAMD_WiFiNINA_Light on NANO_33_IOT
  • 3. Generic_Ethernet_Blinds on nRF52 NRF52840_ITSYBITSY with W5500 Ethernet
  • 4. Generic_Ethernet_Blinds on Seeeduino SEEED_XIAO_M0 with W5500 Ethernet
  • 5. Generic_Ethernet_Blinds on Arduino SAMD_NANO_33_IOT with WiFiNINA
  • 6. Generic_Ethernet_Blinds on Adafruit nRF52 NRF52840_FEATHER with W5500 Ethernet
  • 7. Generic_Ethernet_Blinds on STM32F7 Nucleo-144 NUCLEO_F767ZI with W5500 Ethernet
  • 8. WIOT_MultiSwitch_LCD on SeeedStudio SAMD51 WIO Terminal
  • 9. Generic_WiFiNINA_Blinds on MBED NANO_RP2040_CONNECT
  • 10. RP2040_WiFiNINA_Blinds on MBED NANO_RP2040_CONNECT
  • 11. Blinds on WT32-ETH01 with ETH_PHY_LAN8720
  • 12. Generic_Ethernet_Light on RASPBERRY_PI_PICO
  • 13. Generic_Ethernet_Light on PORTENTA_H7_M7
• Devices
• Debug
• Troubleshooting
• Releases
• Issues
• TO DO
• DONE
• Contributions and Thanks
• Contributing
• License
• Copyright

---

---

Full user documentation

Please check Full User Documentation

---

---

Prerequisites

1. Arduino IDE 1.8.19+ for Arduino.

2. ESP32 Core 2.0.5+ for ESP32-based boards.

3. ESP8266 Core 3.0.2+ for ESP8266-based boards. . To use ESP8266 core 2.7.1+ for LittleFS.

4. Arduino AVR core 1.8.6+ for Arduino (Use Arduino Board Manager) for AVR boards.

5. Teensy core v1.57+ for Teensy (4.1, 4.0, 3.6, 3.5, 3,2, 3.1, 3.0) boards..

6. Arduino SAM DUE core v1.6.12+ for SAM DUE ARM Cortex-M3 boards.

7. Arduino SAMD core 1.8.13+ for SAMD ARM Cortex-M0+ boards.

8. Adafruit SAMD core 1.7.11+ for SAMD ARM Cortex-M0+ and M4 boards (Nano 33 IoT, etc.).

9. Seeeduino SAMD core 1.8.3+ for SAMD21/SAMD51 boards (XIAO M0, Wio Terminal, etc.).

10. Adafruit nRF52 v1.3.0+ for nRF52 boards such as Adafruit NRF52840_FEATHER, NRF52832_FEATHER, NRF52840_FEATHER_SENSE, NRF52840_ITSYBITSY, NRF52840_CIRCUITPLAY, NRF52840_CLUE, NRF52840_METRO, NRF52840_PCA10056, PARTICLE_XENON, NINA_B302_ublox, etc.

11. Arduino Core for STM32 v2.3.0+ for STM32F/L/H/G/WB/MP1 boards.

12. ArduinoCore-mbed mbed_rp2040, mbed_nano, mbed_portenta core 3.4.1+ for Arduino (Use Arduino Board Manager) Portenta_H7, RP2040-based boards, such as Nano_RP2040_Connect, RASPBERRY_PI_PICO.

13. Earle Philhower's arduino-pico core v2.6.3+ for RP2040-based boards such as RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040 and GENERIC_RP2040, etc.

14. ArduinoJson v6.19.4+.

15. WebSockets_Generic v2.16.1+. To install. check

16. For built-in LAN8742A Ethernet:

• STM32Ethernet library v1.3.0+ for built-in LAN8742A Ethernet on (Nucleo-144, Discovery).
• LwIP library v2.1.2+ for built-in LAN8742A Ethernet on (Nucleo-144, Discovery).

17. For W5x00 Ethernet:

• Ethernet_Generic library v2.7.1+ for W5100, W5100S, W5200 and W5500/WIZ550io/WIZ850io/USR-ES1 with Wiznet W5500 chip.

18. For ENC28J60 Ethernet:

• EthernetENC library v2.0.3+ for ENC28J60. . New and Better
• UIPEthernet library v2.0.12+ for ENC28J60.

19. WiFiNINA_Generic library v1.8.15-1+. To install. check if using WiFiNINA for boards such as Nano 33 IoT, nRF52, Teensy, etc.

20. Seeed_Arduino_rpcWiFi library v1.0.6+ for WIO-Terminal or boards using Realtek RTL8720DN WiFi. . To be used with Seeed_Arduino_rpcUnified library v2.1.4+. .

21. WebServer_WT32_ETH01 library v1.5.1+ to use WT32_ETH01 (ESP32 + LAN8720). To install, check .

---

---

Installation

Use Arduino Library Manager

The best and easiest way is to use Arduino Library Manager. Search for SinricPro_Generic, then select / install the latest version. You can also use this link for more detailed instructions.

Manual Install

Another way to install is to:

1. Navigate to SinricPro_Generic page.
2. Download the latest release SinricPro_Generic-master.zip.
3. Extract the zip file to SinricPro_Generic-master directory
4. Copy whole SinricPro_Generic-master folder to Arduino libraries' directory such as ~/Arduino/libraries/.

VS Code & PlatformIO:

1. Install VS Code
2. Install PlatformIO
3. Install SinricPro_Generic library by using Library Manager. Search for SinricPro_Generic in Platform.io Author's Libraries
4. Use included platformio.ini file from examples to ensure that all dependent libraries will installed automatically. Please visit documentation for the other options and examples at Project Configuration File

---

Packages' Patches

1. For Adafruit nRF52840 and nRF52832 boards

To be able to compile, run and automatically detect and display BOARD_NAME on nRF52840/nRF52832 boards, you have to copy the whole nRF52 Packages_Patches directory into Adafruit nRF52 directory