HSRW EOLab Students Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Bird Feeder ======

===== 1. Introduction =====

Bird Feeder is a project that aims to build a self-contained system which integrates a Pet Feeder manufactured by Nooie which will dispense food for birds via donations through a livestream. The Bird Feeder is projected to be placed in the bird house of [[https://www.kalisto-tierpark.de/|Kalisto Tierpark]] located in Kamp-Lintfort.

The Nooie Pet Feeder features a microcontroller board manufactured by Tuya. Tuya is an IoT and cloud development service provider with a varied range of products. The pet feeder can be controlled through Tuya’s cloud development platform. While cloud development is useful, we would like to control the pet feeder locally for security and latency reasons.

To control the pet feeder locally, we will be using Home Assistant. Home Assistant is a Linux based open-source software generally used for smart home automation. We will be using a Raspberry Pi to install Home Assistant, which will be our main control hub.

Additionally, an e-paper display will be used to display last donation information to show people physically present that this service actually exists.


===== 2. Materials =====

  * Raspberry Pi 4.
  * Nooie Pet Feeder.
  * Micro SD card.
  * SD card reader.
  * Ethernet Cable.
  * A smartphone which is compatible with Tuya Smart application.
  * XIAO Esp32S3.
  * XIAO eInk Expansion Board.
  * 7.5in E-ink Display.
  * Camera (Any).
  * PC (Any).

==== 2.1 Raspberry Pi 4 ====

  * The Raspberry Pi 4 is a powerful single-board computer that can power through many affordable electronics.
  * Home Assistant OS is installed on the RaPi4 to act as a hub for the different components and as an MQTT Broker.

<WRAP column 20%>   </WRAP>
<WRAP column 60%>
<imgcaption https://www.raspberrypi.com/products/raspberry-pi-4-model-b/|Raspberry Pi 4>{{https://assets.raspberrypi.com/static/raspberry-pi-4-labelled-f5e5dcdf6a34223235f83261fa42d1e8.png?480}}</imgcaption>
</WRAP>
<WRAP clear/>

==== 2.2 Xiao Esp32S3 ====

  * [[https://wiki.seeedstudio.com/xiao_esp32s3_getting_started/|XIAO ESP32S3]] is a tiny and cool device that combines the ESP32-S3R8 processor and support for both 2.4 GHz Wi-Fi and Bluetooth 5.0. The other ones have 8 MB PSRAM, 8 MB Flash, and an external SD card slot.

<WRAP column 20%>   </WRAP>
<WRAP column 60%>
<imgcaption https://wiki.seeedstudio.com/xiao_esp32s3_getting_started/|XIAO Esp32s3 Pinout>{{https://files.seeedstudio.com/wiki/SeeedStudio-XIAO-ESP32S3/img/2.jpg?480}}</imgcaption>
</WRAP>
<WRAP clear/>

  * It is mainly used to control the e-paper display using the [[https://wiki.seeedstudio.com/XIAO-eInk-Expansion-Board/|XIAO eInk Expansion]] Board

<WRAP column 20%>   </WRAP>
<WRAP column 60%>
<imgcaption https://wiki.seeedstudio.com/XIAO-eInk-Expansion-Board/|XIAO eInk Expansion Board>{{https://media-cdn.seeedstudio.com/media/catalog/product/cache/bb49d3ec4ee05b6f018e93f896b8a25d/4/-/4-105990172-epaper-breakout-board-45back.jpg?480|Expansion Board}}</imgcaption>
</WRAP>
<WRAP clear/>

==== 2.3 7.5in E-ink Display ====

  * An E-Ink display, also referred to as e-paper, is a display technology that is synonymous with its low power consumption and visual appearance—mimicking ink on paper.
  * Used to display last donation information.

<WRAP column 20%>   </WRAP>
<WRAP column 60%>
<imgcaption https://www.seeedstudio.com/7-5-Monochrome-ePaper-Display-with-800x480-Pixels-p-5788.html| 7.5" E-Ink Display>{{https://media-cdn.seeedstudio.com/media/catalog/product/cache/bb49d3ec4ee05b6f018e93f896b8a25d/1/-/1-308030054-ink-7.5-monochrome-epaper-display-with-800x480-pixels-45font.jpg?480|e-ink display}}</imgcaption>
</WRAP>
<WRAP clear/>

===== 3. Home Assistant on RaPi =====

  * [[amc:ss2024:bird_feeder:kalisto:system_arch|System-Architecture]]
  * [[amc:ss2024:bird_feeder:ha_installation|Home Assistant Installation]]

==== Home Assistant Installation ====

This guide was written using Home Assistant version 2024.5.x.
  * Credits go to Taycan.
=== Raspberry Pi Setup ===
  - 	Install Raspberry Pi imager https://www.raspberrypi.com/software/. <imgcaption label1|Pick the operating system you are using>{{ 1rbdl.png }}</imgcaption>
  - 	Insert the Micro SD card to the SD card reader.
  - 	Run the application.
  - 	Choose Device (Raspberry Pi 4 in this case). 
  - 	Choose Operating System (“Other specific-purpose OS” -> “Home assistants and home automation” -> “Home Assistant” -> “Home Assistant OS 12.x”).
  - 	Choose Storage. <imgcaption label2|Home Assistant Installation, In this case, Raspberry Pi 4>{{ 2rbst.png }}</imgcaption>
  - 	Click “Next” -> “Yes”. (Ignore Microsoft Error messages).
  - 	Remove the Micro SD card.
  - 	Insert the Micro SD card into the Raspberry Pi’s Micro SD card slot.
  - 	Connect Raspberry Pi to power via the USB-C (or Micro-USB depending on the model) port.
  - 	Connect the Raspberry Pi to your network via the ethernet port on the Pi, make sure your computer is connected to the same network as well.
  - 	Home Assistant Installation happens automatically if the Micro SD card is inserted and the Raspberry Pi is powered on. This might take a few minutes. If you want to monitor the installation, connect the Raspberry Pi through its mini-HDMI port to a display. 
  - 	Open a web explorer, navigate to http://homeassistant.local:8123/ and hit enter.
  - 	Wait for the setup to finish and click on “Create My Smart Home”.
  - 	Create a user using your preferred credentials.

===== 4. Implementation =====

  - System Architecture.
  - Connecting ESP32 to e-ink display using the extension board. **(Display Component)**.
  - Installing ESP-Home on //HA//.
  - Connect **Display Component** to ESP-Home.
  - Setting up MQTT Broker on //HA//.
  - Rewriting the **Display Component** code from C++ to ESP-Home yaml syntax.
  - Setting up Frontend website.
  - Configuring website to use MQTT QoS-2.
  - Configuring Nooie-pet feeder on HA using LocalTuya.
  - Creating Automation function for pet feeder to trigger on MQTT Message. 

==== 4.1 System Architecture ====

  * Raspberry Pi:
    * Home Assistant is flashed on a Raspberry Pi.
    * Local Tuya and MQTT Broker are installed and configured on //HA//.
    * Pet Feeder is connected to Local Tuya using LAN/WAN.
    * Both Pet Feeder and **Display Component** trigger on MQTT Messages.
  * A PC Acting as a server to hold services:
    * OBS/Streaming connected to a camera in the exhibit.
    * A full-stack web application that hosts the stream and acts as an interactive environment for people to watch and potentially donate.
    * The front-end side sends a MQTT message on donation to trigger pet feeder and **Display Component**.
<WRAP column 10%>   </WRAP>
<WRAP column 80%>
^ {{drawio>amc:ss2024:bird_feeder:kalisto:sys-arch-v3.png}} ^
^  Diagram 1: System Architecture  ^
</WRAP>
<WRAP clear/>
==== 4.2 Connecting ESP32 to e-ink display using the extension board. ====
  * Connecting the different parts was very simple. The microcontroller was connected to the extension board seamlessly as they are already compatible.
  * Display was connected to the extension board using its 24-pin cable. Warning, the cable is very fragile :!:

<WRAP column 20%>   </WRAP>
<WRAP column 60%>
<imgcaption label-DC|Display Component>{{:amc:ss2024:bird_feeder:display-component.jpeg?500&nolink}}</imgcaption>
</WRAP>
<WRAP clear/>

  * The following code file was implemented using **Seeed Studio**'s [[https://wiki.seeedstudio.com/XIAO-eInk-Expansion-Board/| wiki/documentation page]].
  * The e-ink display needs to be refreshed fully or partially between data changes, otherwise the text/image will not show properly.
  * The trickiest part was figuring out which pins to use for these pins: ''%%BUSY, RES, DC, CS%%''.
  * The display using bitmaps for... displaying text/images.
  * A bitmap uses a grid of pixels to display text/images. Each pixel in the bitmap corresponds to a pixel on the e-ink display.
  * :!: A Converter can used to convert normal images to cpp bitmap files.

<file cpp display_code.ino>
//Most Important Import
#include <SPI.h>

#include "Display_EPD_W21_spi.h"
#include "Display_EPD_W21.h"
#include "frame.h"
#include "GUI_Paint.h"
#include "font.h"

#if 1
unsigned char BlackImage[EPD_ARRAY]; //Define canvas space  
#endif

//Most Important Part
void setup() {
  pinMode(D5, INPUT); //BUSY
  pinMode(D0, OUTPUT); //RES 
  pinMode(D3, OUTPUT); //DC   
  pinMode(D1, OUTPUT); //CS  

  //SPI
  SPI.beginTransaction(SPISettings(10000000, MSBFIRST, SPI_MODE0));
  SPI.begin();

  Serial.begin(9600);
  Serial.print(111);
}

//Tips//
/*
1.Flickering is normal when EPD is performing a full screen update to clear ghosting from the previous image so to ensure better clarity and legibility for the new image.
2.There will be no flicker when EPD performs a partial refresh.
3.Please make sue that EPD enters sleep mode when refresh is completed and always leave the sleep mode command. Otherwise, this may result in a reduced lifespan of EPD.
4.Please refrain from inserting EPD to the FPC socket or unplugging it when the MCU is being powered to prevent potential damage.)
5.Re-initialization is required for every full screen update.
6.When porting the program, set the BUSY pin to input mode and other pins to output mode.
*/

void loop() {
  Serial.print(111);
  
  #if 1 //Partial refresh demostration.

  EPD_Init_Fast(); //Full screen refresh initialization.
  EPD_WhiteScreen_White(); //Clear screen function.
  EPD_DeepSleep(); //Enter the sleep mode and please do not delete it, otherwise it will reduce the lifespan of the screen.
  delay(2000); //Delay for 2s.	
  //Partial refresh demo support displaying a clock at 5 locations with 00:00.  If you need to perform partial refresh more than 5 locations, please use the feature of using partial refresh at the full screen demo.
  //After 5 partial refreshes, implement a full screen refresh to clear the ghosting caused by partial refreshes.
  //////////////////////Partial refresh time/////////////////////////////////////
  Paint_NewImage(BlackImage, EPD_WIDTH, EPD_HEIGHT, 0, WHITE); //Set canvas parameters, GUI image rotation, please change 0 to 0/90/180/270.
  Paint_SelectImage(BlackImage); //Select current settings.	
  EPD_Init(); //Full screen refresh initialization.
  Paint_Clear(WHITE); //Clear canvas.
  const char * Message = "Welcome to Kalisto";
  Paint_DrawString_EN(400 - (((strlen(Message) * 32) / 2)), 240 - (64 / 2), Message, & Font64, WHITE, BLACK);
  EPD_Display(BlackImage); //Display GUI image.
  EPD_DeepSleep(); //EPD_DeepSleep,Sleep instruction is necessary, please do not delete!!!
  delay(20000); //Delay for 2s. 		

  // Full screen update clear the screen.
  EPD_Init(); //Full screen refresh initialization.
  EPD_WhiteScreen_White(); //Clear screen function.
  EPD_DeepSleep(); //Enter the sleep mode and please do not delete it, otherwise it will reduce the lifespan of the screen.
  delay(2000); //Delay for 2s.	

  #endif

  delay(300000); // The program stops here   
}
</file>
==== 4.3 Installing ESP-Home on HA. ====
   * **ESP-Home** enables advanced functionality on ESP devices without deep programming knowledge. Despite that fact, it has a specific syntax to follow and requires some learning. It acts a hub for all connected ESP devices. 
   * Following the **ESP-Home** [[https://esphome.io/|Documentation website]] is essential for installation and general knowledge.
   * To install **ESP-Home** on //HA//, this [[https://esphome.io/guides/getting_started_hassio.html|page]] is far better than any steps I can write.
==== 4.4 Setting up MQTT Broker on HA. ====
  * MQTT originally stood for MQ Telemetry Transport. It is an extremely lightweight publish/subscribe messaging transport protocol on top of TCP/IP designed for machine-to-machine or Internet of Things connectivity. It's a very powerful protocol for transmission in smart home devices.
  * MQTT will be used for communication between the different components.
  * A MQTT Broker called Mosquitto can be installed to **HA** as an add-on. This [[https://github.com/home-assistant/addons/blob/master/mosquitto/DOCS.md|page]] contains detailed instructions for installation and configuration.
==== 4.5 Connect Display Component to ESP-Home. ====
  * Adding an ESP component is very simple and requires simple steps to be achieved.
  * 1. Click on "New Device"
<WRAP column 10%>   </WRAP>
<WRAP column 80%>
<imgcaption label4-4-1>{{:amc:ss2024:bird_feeder:esp-device-1.jpeg?600&nolink|esp-device-1}}</imgcaption>
</WRAP>
<WRAP clear/>
  * 2. Click "Continue"
<WRAP column 10%>   </WRAP>
<WRAP column 80%>
<imgcaption label4-4-2>{{:amc:ss2024:bird_feeder:esp-device-2.jpeg?600&nolink|esp-device-2}}</imgcaption>
</WRAP>
<WRAP clear/>
  * 3. Enter a name for the device and give the Wifi SSID and password for the device to establish connection wirelessly. The click "Next"
<WRAP column 10%>   </WRAP>
<WRAP column 80%>
<imgcaption label4-4-3>{{:amc:ss2024:bird_feeder:esp-device-3.jpeg?600&nolink|esp-device-3}}</imgcaption>
</WRAP>
<WRAP clear/>
  * 4.  Make sure "Use recommended settings" choose the device type, in our case it is "ESP32-S3".
<WRAP column 10%>   </WRAP>
<WRAP column 80%>
<imgcaption label4-4-4>{{:amc:ss2024:bird_feeder:esp-device-4.jpeg?600&nolink|esp-device-4}}</imgcaption>
</WRAP>
<WRAP clear/>
  * 5. Copy the encryption key safely for future use then click "Install".
<WRAP column 10%>   </WRAP>
<WRAP column 80%>
<imgcaption label4-4-5>{{:amc:ss2024:bird_feeder:esp-device-5.jpeg?600&nolink|esp-device-5}}</imgcaption>
</WRAP>
<WRAP clear/>
  * 6. This depends on how the device is connected. For the first time installation it is better to "Plug into the computer running ESPHome Dashboard".
<WRAP column 10%>   </WRAP>
<WRAP column 80%>
<imgcaption label4-4-6>{{:amc:ss2024:bird_feeder:esp-device-6.jpeg?600&nolink|esp-device-6}}</imgcaption>
</WRAP>
<WRAP clear/>
  * 7. Choose the correct port. In this case it is only one.
<WRAP column 10%>   </WRAP>
<WRAP column 80%>
<imgcaption label4-4-7>{{:amc:ss2024:bird_feeder:esp-device-7.jpeg?600&nolink|esp-device-7}}</imgcaption>
</WRAP>
<WRAP clear/>
  * 8. Wait for the first installation to pass. You can see if it was successful or not but seeing whether the device connected to the wifi connection or not.
==== 4.6 Rewriting the Display Component code from C++ to ESP-Home yaml syntax. ====
  * The ESPHome documentation proven to be the best way to fulfil this step.
    * [[https://esphome.io/components/esphome.html#on-boot|ESPHome Core Configuration
]], [[https://esphome.io/components/spi|SPI]], [[https://esphome.io/components/mqtt.html|MQTT]], [[https://esphome.io/components/text_sensor/index.html#on-value|text_sensor]] and [[https://esphome.io/components/display/#drawing-static-text|Display]] were the most used pages in the documentation to reach this code.
  * ESPHome Configuration: specifies the name of ESPHome project and on-boot actions. 
  * Configuration of ESP32 Board and Framework: In this, the ESP32 board and framework used are specified. 
  * Logging and API: Switches on logging and the Home Assistant API—all encrypted. 
  * WiFi Configuration: Provide WiFi credentials and setup fallback hotspot. 
  * MQTT Integration: Provide details of the MQTT broker to connect for communication. 
  * Display Setup: Specify your e-ink display model, pins, and update intervals. 
  * Text Sensor: Subscribes to MQTT topics to show messages on the e-ink display.
<file yaml display_code.yaml>
esphome:
  name: display
  friendly_name: display
  on_boot:
      priority: 200.0
      then:
        - component.update: eink_display
        - delay: 5s
        - logger.log: "Initial sensor data received: Refreshing display..."
        - script.execute: update_screen

esp32:
  board: esp32-s3-devkitc-1
  framework:
    type: arduino

# Enable logging
logger:

# Enable Home Assistant API
api:
  encryption:
    key: "7QLJzR30itSBn30kootHbIE6FI8jmUtAl7/fcytRxis="

ota:
  platform: esphome
  password: "81ceca8aa7f29a76601df5539733d32f"

wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password

  # Enable fallback hotspot (captive portal) in case wifi connection fails
  ap:
    ssid: "Display Fallback Hotspot"
    password: "WgV5TWXpXcpT"

captive_portal:

script:
  - id: update_screen
    then:
      - component.update: eink_display

font:
  - file: "gfonts://Roboto"
    id: roboto_64
    size: 64

spi:
  clk_pin: GPIO7
  mosi_pin: GPIO9

mqtt:
  broker: hafeeder.local
  port: 1883
  username: "mqtt"
  password: "1234"

text_sensor:
  - platform: mqtt_subscribe
    name: "Data from topic"
    id: mytext
    topic: birdfeeder  
    qos: 2
    on_value: 
      then:
        - script.execute: update_screen

display:
  - platform: waveshare_epaper
    model: 7.50in-bV3
    id: eink_display
    cs_pin: GPIO2
    dc_pin: GPIO4
    busy_pin: GPIO6
    reset_pin: GPIO1
    update_interval: never
    lambda: |-
      it.printf(400, 240, id(roboto_64), TextAlign::TOP_CENTER, id(mytext).state.c_str());

</file>
==== 4.7 Setting up Frontend website. ====
  * I built a simple react frontend application for sake of testing and showing the viability of the whole concept.
  * The application can be found on a [[https://github.com/seifeldingamal/bird-feeder-app.git|Github Repo]]
<WRAP column 10%>   </WRAP>
<WRAP column 80%>
<imgcaption label-react-app>{{:amc:ss2024:bird_feeder:react-app.jpeg?600&nolink|React App}}</imgcaption>
</WRAP>
<WRAP clear/>
==== 4.8 Configuring Nooie-pet feeder on HA using LocalTuya. ====
  * Credits go to Taycan.
=== HACS Installation ===
Home Assistant Community Store (HACS) is a third-party download manager for Home Assistant which contains various custom integrations. We need to install LocalTuya integration through HACS to locally control the pet feeder. This guide was written using HACS version 1.34.0.
  - 	Go to your user profile and enable “Advanced mode”. 
<WRAP column 10%>   </WRAP>
<WRAP column 80%>
<imgcaption label3|User profile is found on the bottom right.>{{ 3ha.png }}</imgcaption>
</WRAP>
<WRAP clear/>
  - 	 Go “Settings” -> “Add-ons” -> “Add-on store” -> search “SSH” -> Install “Terminal & SSH”.
  - 	 After the installation is complete, enable “Show in sidebar” 
<WRAP column 10%>   </WRAP>
<WRAP column 80%>
<imgcaption label4|SSH Add-on options after installation>{{ 4ssh.png }}</imgcaption>
</WRAP>
<WRAP clear/>
  - 	Navigate to “Terminal” on the sidebar, if it appears not to be running or if you are receiving error codes, refresh the instance.
  - 	 Copy and paste (CTRL+SHIFT+V to paste) the following command to the terminal and hit Enter. This will initiate the installation of HACS.\\ <code> wget -O - https://get.hacs.xyz | bash - </code>
<WRAP column 10%>   </WRAP>
<WRAP column 80%>
<imgcaption label5|HA SSH>{{ 5ssh.png }}</imgcaption>
</WRAP>
<WRAP clear/>
  - 	 After the installation is completed, restart the home assistant (“Settings” -> three dots on the top right -> “Restart Home Assistant” -> “Restart Home Assistant”). 
  - 	Home Assistant should automatically restart, if the browser crashes, refresh the browser page to access Home Assistant again.
  - 	Navigate to “Settings” -> “Devices & Services” -> Click “Add Integration” on the bottom right corner.
  - 	Type “HACS” on the search bar, click on the result. 
<WRAP column 10%>   </WRAP>
<WRAP column 80%>
<imgcaption image6|>{{ {{ 6hacs.png }} }}</imgcaption>
</WRAP>
<WRAP clear/>
  - 	Check all but the last checkbox and submit. 
<WRAP column 10%>   </WRAP>
<WRAP column 80%>
<imgcaption image7|>{{ {{ 7hacscb.png }} }}</imgcaption>
</WRAP>
<WRAP clear/>
  - 	Create a github account if you don’t have one.
  - 	HACS will ask you to activate device through your github account. Follow the instructions provided and link HACS with your github account. 
<WRAP column 10%>   </WRAP>
<WRAP column 80%>
<imgcaption label8|Copy highlighted code and click on the github link>{{ 8hacsgit.png }}</imgcaption> <imgcaption image9|Paste the code here.>{{ 9hacsgit.png }}</imgcaption>
</WRAP>
<WRAP clear/>
  - 	Click on “Authorize” and exit github.
  - 	If everything is set correctly you should have installed HACS on your Home Assistant. Do not pick an area on the pop-up and click on “finish”. 
  - 	Now HACS should show up on the sidebar of Home Assistant UI.
=== LocalTuya integration Installation ===
LocalTuya integration is what we need to control the pet feeder locally. This guide was written for LocalTuya version 5.2.1.
  - 	On the HACS tab, click on “Integrations”. 
<WRAP column 10%>   </WRAP>
<WRAP column 80%>
<imgcaption image10|>{{ {{ 10hacs.png }} }}</imgcaption>
</WRAP>
<WRAP clear/>
  - 	Click on "Explore & Download Repositories" on the bottom right, on the pop-up search, type "LocalTuya". Click on the result. 

<WRAP column 10%>   </WRAP>
<WRAP column 80%>
<imgcaption image11|>{{ 10ltuya.png }}</imgcaption>
</WRAP>
<WRAP clear/>
  - 	Click on “Download” on the bottom right. Click on “Download” again on the pop-up. 
<WRAP column 10%>   </WRAP>
<WRAP column 80%>
<imgcaption image1|>{{ 11ltuyai.png }}</imgcaption>
</WRAP>
<WRAP clear/>
=== Adding Pet Feeder to Home Assistant ===
  -	Download the “Tuya Smart” app to your smartphone (version 5.13.0 was used for this guide). 
  -	Press both buttons on the pet feeder at the same time.
  - 	Run the “Tuya Smart” app, press “Add Device”, the Pet feeder should appear automatically, turn on your Bluetooth if it doesn’t. Insert the wireless credentials and press login. **Make sure the pet feeder and the Home Assistant are in the same network**.
  - 	Navigate to [[https://auth.tuya.com/register?from=https%3A%2F%2Fdeveloper.tuya.com%2Fen%2F | Tuya IoT development platform]] and create an account. <imgcaption image12|>{{ 12tuyacc.png }}</imgcaption>
  - 	Once the account is created, navigate to the [[https://platform.tuya.com/ | developer platform]] on the top right corner of the page you were redirected to.
  - 	Skip the tutorials, hover the cursor over “Cloud” on the sidebar and click on “Development”. <imgcaption image13|>{{ 12ltuyacloud.png }}</imgcaption>
  - 	Click on “Create Cloud Project" on the Development page. Fill in the project details. Pick “Custom” Development method and “Central European Data Center”, pick the rest as you see fit. <imgcaption image14|>{{ 13tuyacproj.png }}</imgcaption>
  - 	In the next step, add "Smart Home Basic Service" and "[Deprecate]Device Log Query" to the selected API services. Click on "Authorize". <imgcaption image15|>{{ 13tuyzapi.png }}</imgcaption>
  - 	 Now that the project is created, let’s add the pet feeder to the project. Navigate to “Devices” -> “Link Tuya App Account” -> "Add App Account". <imgcaption image16|>{{ 14tuya.png }}</imgcaption>
  - 	 A QR code will appear, open the “Tuya Smart” app on your phone, press on “Me” on the bottom right and then press on the scan icon on the top right, scan the QR code.
  - 	After the QR code is scanned, pick “Automatic Device Linking Method” and click on OK. <imgcaption image17|>{{ 16tuyaaut.png }}</imgcaption>
  - 	Once the linking is complete, you should be able to see your account details on the “Link Tuya App Account” tab. **Make note of the “UID”**, we will use this later. Click on “Manage Devices”. <imgcaption image18|>{{ 17uid.png }}</imgcaption>
  - 	If the Pet Feeder is shown as unlinked, check the checkbox next to the pet feeder and hit “Link Device”. <imgcaption image19|>{{ 18deviceadd.png }}</imgcaption>
  - 	Confirm the pet feeder exists on the “All Devices” tab, do not close this webpage. <imgcaption image20|>{{ 19deviceconf.png }}</imgcaption>
  - 	 Navigate back to the [[http://homeassistant.local:8123/ | Home Assistant UI]] 
  - 	Go to “Settings” -> “Devices & Services” -> “Add Integration” on the bottom right corner, Search for “LocalTuya”. Click on “LocalTuya Integration”. <imgcaption image21|>{{ 20addlt.png }}</imgcaption>
  - 	Once LocalTuya is installed, Cloud API configuration pop up will appear. Make sure API server region is EU. For the rest of the credentials, we need to navigate back to [[https://platform.tuya.com/ | Tuya developer platform]]. <imgcaption image22|>{{ 21cred1.png }}</imgcaption>
  - 	 On the left sidebar, hover on “Cloud” -> “Development” -> “Open Project”. The “Client ID” and the “Secret” can be found under the “Overview” tab of the cloud project. (not the Overview on the sidebar, the one under our project name). <imgcaption image23|>{{ 22keysecret.png }}</imgcaption>
  - 	Insert the credentials back to Home Assistant. Use the previously mentioned “UID” from “Link Tuya App Account” tab and click on “Submit”.
  - 	LocalTuya Integration is now linked with your Tuya Development Account. We still need to configure the pet feeder for local use. 
  - 	You will be redirected to LocalTuya integration page, if not, Navigate to “Settings” -> “Devices & Integrations” -> “LocalTuya”. 
  - 	Click on “Configure” on the same page -> “Add a New Device” -> “Pet Feeder” (which should be recognized automatically) and submit. <imgcaption image24|>{{ 23configlt.png }}</imgcaption>  <imgcaption image25|>{{ 24loctuyaconf.png }}</imgcaption> <imgcaption image26|>{{ 25adddev.png }}</imgcaption> <imgcaption image27|>{{ 26pfcfg.png }}</imgcaption>
          - Skip to step 23 if the credentials of the Pet Feeder are configured automatically. If the Pet Feeder’s configuration is **not set automatically**, navigate back to the Tuya Developer Platform, hover on the “Cloud” icon on the sidebar -> “API Explorer”. <imgcaption image28|Optional step, refer to step 22.a.>{{ 26pfcfga.png }}</imgcaption>
          - On the API explorer, Navigate to “Query Devices in Project” on “Device Management”. 
          - Type “1” to “page_size” and click on “Submit Request”.
          - The response query gives us credentials of the device. We can find the local key and device id (called “id”). <imgcaption image29|Optional step, refer to step 22.a.>{{ 26pfcfgb.png }}</imgcaption>
          -  The Host address can be obtained via your router’s web interface.
  - 	After you submit, you will be met with the “Entity Type Selection” pop-up. The pet feeder has different functions such as dispensing food or turning the LED on the pet feeder on and off. Each of these functions has their own “Data Point ID” to communicate with the cloud. We need to intercept these Data Points and create separate entities to control the device via the Home Assistant. <imgcaption image30|>{{ 27entitiy.png }}</imgcaption>
  - 	Do not exit the Home Assistant instance and navigate back to Tuya Developer Platform. Open your project and navigate to “All Devices” tab under “Devices” and click on “Debug Device”.  <imgcaption image31|>{{ 28debug.png }}</imgcaption>
  - 	On the device debugging page, under “Standard Instructions Set” are the functions of the device we can set new values for. Under “Standard Status Set” are the previously mentioned functions and the available sensors of the device. 
  - 	To find out which Data Point is associated with which function of the device, navigate to “Device Logs” tab.  <imgcaption image32|>{{ 28debug.png }}</imgcaption>
  - 	 Turn the developer console on of your browser (CTRL+SHIFT+I or F12 for Google Chrome). Navigate to “Network” tab on the developer console. 
  - 	Notice the “Select DP ID” dropdown menu on the top left side of the page.
  - 	While the Developer console is on, click on the DP ID dropdown menu and select “Manual Feed”, click on “Search”.
  - 	After you click on “Search”, you should see the network tab of your developer console update with several different logs. “list” is the one we are looking for.  <imgcaption image33|>{{ 30devc.png }}</imgcaption>
  - 	Click on “list”, and navigate to the “Payload” tab, “Code” is the Data Point ID we are looking for.  In this case it’s 3.  <imgcaption image34|>{{ 32devcn.png }}</imgcaption>
  - 	The ID is our Data Point, which is 3. 
  - 	Navigate back to “Device Debugging” tab, make note of the manual_feed’s type and values. It’s an integer with a minimum value of 1, maximum value of 20 and with a step of 1. <imgcaption image35|>{{ 33feed.png }}</imgcaption>
  - 	 Navigate back to Home Assistant, last time, we were at the Entity Type Selection pop-up. “Settings” -> “Devices & Services” -> “LocalTuya” -> “Configure” -> “Add a new Device” -> ”Submit” -> “Submit”.
  - 	Let’s add the manual feed function to LocalTuya. LocalTuya includes integers in “number”, pick it from the dropdown menu and submit. <imgcaption image36|>{{ 34int.png }}</imgcaption>
  - 	The “ID” dropdown menu includes DP IDs of the pet feeder, we know 3 is manual feed. From the dropdown menu, pick 3. Call it Manual Feed. The minimum value is 1, maximum value is 20 and the increment between values is 1. Click “Submit’. <imgcaption image37|>{{ 35manfeed.png }}</imgcaption>
  - 	 On the next step, the entity type selection will appear again, for now, check the “Do not add any more entities” and click “Submit” (we can always add more later). <imgcaption image38|>{{ 36dontadd.png }}</imgcaption>
  - 	Now let’s see if the manual feed entity works. Click on "1 device" below the logo of localtuya. <imgcaption image39|>{{ 37ltd.png }}</imgcaption>
  - 	Slide the Manual Feed to any value and check the Pet Feeder is dispensing food. <imgcaption image40|>{{ 38ctrl.png }}</imgcaption>
  - 	Add more entities by repeating step 26 and beyond.

==== 4.9 Creating Automation function for pet feeder to trigger on MQTT Message. ====
  - This step was by far the easiest in the whole process. 
  - In the "When" section, choose MQTT and set the topic to the one we already established in the MQTT Broker.
  - In the "Then Do" section, choose the device, in our case "Pet Feeder". Choose the action already established in the previous step "Manual Feed" then set the value to be between 1-10.
<WRAP column 5%>   </WRAP>
<WRAP column 90%>
<imgcaption tuya-auto-trigger|Pet feeder automation configuration>{{:amc:ss2024:bird_feeder:tuya-automations.jpeg?800}}</imgcaption>
</WRAP>
<WRAP clear/>

===== 5. Results and Discussion =====
  * The concept has proven to be very much viable with all the requirements fulfilled in a prototype and ready to be moved to the next steps.
  * Using MQTT for communication between the different devices has proven simple yet efficient. 
  * The e-ink display was a great choice for this project due to its high visibility in daylight and power efficiency.
  * To display payer information, the payload of an MQTT message can be used.

===== 6. Future Steps =====
  * Build a casing for the display component to keep it protected and portable without any fear of damaging connectors.
  * Further develop the design of the text/images shown on the e-ink display.
  * Figure out whether the Kalisto main website can be used to integrate this whole system or not.
    * If not, further development of the web-application must proceed.
  * Payment can be handled using [[https://docs.stripe.com/stripe-js/react|Stripe]], a comprehensive suite of tools for handling online financial transactions.
  * Payer information should be stored in a queue like structure to give a chance for the display to show all donations.
===== 7. Obstacles =====
  * It was also a difficult and challenging accomplishment of the particular system architecture to ensure high level expertise with precision.
    * This can be shown from the different system architecture diagrams [[amc:ss2024:bird_feeder:kalisto:system_arch|here]].
  * Finds the correct pin configuration for between the XIAO ESP-32 and the e-ink display.
  * The e-ink display cable broke at some point during the implementation and testing and another display was ordered to continue with the project.
  * Just before the presentation, as there was another team using a RaPi and the same Nooie Pet Feeder connected on the same network, there was a conflict between both the 2 RaPis. This was solved by changing both the hostname and the port for one of them.
===== 8. Key Learnings =====
  * The different communication protocols such as SPI and I2C.
  * E-ink displays and how they function.
  * Home Assistant and most of its features.
  * Automation and triggers
  * ESPHome and how its yaml syntax works.
  * MQTT, Brokers, Topics, QoS, etc.
  * Networking Basics.

===== 9. References =====
  * https://wiki.seeedstudio.com/xiao_esp32s3_getting_started/
  * https://wiki.seeedstudio.com/XIAO-eInk-Expansion-Board/
  * https://www.home-assistant.io/docs/
  * https://esphome.io/
  * https://www.npmjs.com/package/precompiled-mqtt