Merge pull request #324 from DefangLabs/linda-arduino-wifi

Add Arduino Flask Wifi Server sample

Author: commit111

samples/arduino-wifi/.github/workflows/deploy.yaml

@@ -0,0 +1,21 @@
+name: Deploy
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    environment: playground
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+    - name: Checkout Repo
+      uses: actions/checkout@v4
+
+    - name: Deploy
+      uses: DefangLabs/defang-github-action@v1.1.3

samples/arduino-wifi/README.md

@@ -0,0 +1,69 @@
+# Arduino Flask Wifi Server
+
+[![1-click-deploy](https://defang.io/deploy-with-defang.png)](https://portal.defang.dev/redirect?url=https%3A%2F%2Fgithub.com%2Fnew%3Ftemplate_name%3Dsample-<arduino-wifi-template%26template_owner%3DDefangSamples)
+
+![project image](./images/wifi.png)
+
+This sample contains an interactive wifi-connected UI program for a [SenseCAP Indicator Device](https://wiki.seeedstudio.com/Sensor/SenseCAP/SenseCAP_Indicator/Get_started_with_SenseCAP_Indicator/), built for an Embedded Systems project at Defang Software Labs.
+
+The device has a square liquid-crystal touch screen display, and a ESP32-S3 chip that can be programmed in an Arduino environment.
+
+The program `welcome.ino`, acting as a client, pings data every 5 seconds after it is connected to a wifi network. It uses a library called [ArduinoHTTPClient](https://github.com/arduino-libraries/ArduinoHttpClient). It is also recommended to use [Arduino IDE](https://www.arduino.cc/en/software) when coding with `.ino` files. The program UI will display a message that is randomized in color and location on the screen at the same time during pings (every 5 seconds). 
+
+The Flask server in `web_server.py` receives these pings when it is initialized and connected to the same wifi network as the client. To initalize it, run `python web_server.py`. To view it, open `localhost` with the port number used. To deploy it to the cloud, run `defang up` in the `\welcome` directory.
+
+A helpful file called `serial_reader.py` decodes serial monitor readings to a readable format, allowing you to see `Serial.println()` messages in real time when running.  To initalize it, run `python serial_reader.py` and see it show up in the terminal. 
+
+Here is a diagram showing the structure of the application. 
+
+![arduino wifi diagram](./images/arduino_wifi_diagram.png)
+
+## Prerequisites
+
+1. Download [Defang CLI](https://github.com/DefangLabs/defang)
+2. (Optional) If you are using [Defang BYOC](https://docs.defang.io/docs/concepts/defang-byoc) authenticate with your cloud provider account
+3. (Optional for local development) [Docker CLI](https://docs.docker.com/engine/install/)
+
+## Development
+
+To run the application locally, you can use the following command:
+
+```bash
+docker compose up --build
+```
+
+## Configuration
+
+For this sample, you will not need to provide [configuration](https://docs.defang.io/docs/concepts/configuration). 
+
+If you wish to provide configuration, see below for an example of setting a configuration for a value named `API_KEY`.
+
+```bash
+defang config set API_KEY
+```
+
+## Deployment
+
+> [!NOTE]
+> Download [Defang CLI](https://github.com/DefangLabs/defang)
+
+### Defang Playground
+
+Deploy your application to the Defang Playground by opening up your terminal and typing:
+```bash
+defang compose up
+```
+
+### BYOC
+
+If you want to deploy to your own cloud account, you can [use Defang BYOC](https://docs.defang.io/docs/tutorials/deploy-to-your-cloud).
+
+---
+
+Title: Arduino Flask Wifi Server
+
+Short Description: An Arduino wifi server built with Flask. 
+
+Tags: Arduino, Flask, Python, IoT, Wifi, Serial
+
+Languages: python

samples/arduino-wifi/app/Dockerfile

@@ -0,0 +1,26 @@
+# Use an official Python runtime as a base image
+FROM python:3.11-slim
+
+# Set the working directory to /app
+WORKDIR /app
+
+# Install required packages
+RUN apt-get update -qq \
+      && apt-get install -y --no-install-recommends \
+      build-essential \
+      python3-dev \
+      && apt-get clean \
+      && rm -rf /var/lib/apt/lists/*
+
+# Copy the current directory contents into the container at /app
+COPY . /app
+
+# Install any needed packages specified in requirements.txt
+COPY requirements.txt /app/
+RUN pip install --no-cache-dir --upgrade pip && pip install --no-cache-dir -r requirements.txt
+
+# Make port available to the world outside this container
+EXPOSE 8081
+
+# Run app.py when the container launches
+CMD ["python3", "web_server.py"]

samples/arduino-wifi/app/requirements.txt

@@ -0,0 +1,6 @@
+Flask==3.0.0
+Werkzeug==3.0.1
+Jinja2==3.1.2
+itsdangerous==2.1.2
+click==8.1.7
+blinker==1.7.0

samples/arduino-wifi/app/web_server.py

@@ -0,0 +1,39 @@
+from flask import Flask, jsonify, request
+
+app = Flask(__name__)
+
+# Sample data
+tasks = [
+    {"id": 1, "title": "Defang x Arduino x Flask example!", "done": False},
+    {"id": 2, "title": "Pings appear on browser refresh when device is connected.", "done": False}
+]
+
+@app.route('/', methods=['GET'])
+def home():
+    return jsonify({"message": "Defang x Arduino x Flask. Go to /tasks to see example!"})
+
+@app.route('/tasks', methods=['GET'])
+def get_tasks():
+    return jsonify({"tasks": tasks})
+
+@app.route('/tasks/<int:task_id>', methods=['GET'])
+def get_task(task_id):
+    task = next((task for task in tasks if task['id'] == task_id), None)
+    if task:
+        return jsonify({"task": task})
+    return jsonify({"error": "Task not found"}), 404
+
+@app.route('/tasks', methods=['POST'])
+def create_task():
+    if not request.json or 'title' not in request.json:
+        return jsonify({"error": "Bad request"}), 400
+    task = {
+        'id': tasks[-1]['id'] + 1,
+        'title': request.json['title'],
+        'done': False
+    }
+    tasks.append(task)
+    return jsonify({"task": task}), 201
+
+if __name__ == '__main__':
+    app.run(debug=True, port=8081, host="0.0.0.0")

samples/arduino-wifi/compose.yaml

@@ -0,0 +1,17 @@
+services:
+  flask:
+    restart: unless-stopped
+    build:
+      context: ./app
+      dockerfile: Dockerfile
+    deploy:
+      resources:
+        reservations:
+          cpus: "1.0"
+          memory: 512M
+    ports:
+      - mode: ingress
+        target: 8081
+        published: 8081
+    healthcheck:
+       test: ["CMD", "python3", "-c", "import sys, urllib.request; urllib.request.urlopen(sys.argv[1]).read()", "http://localhost:8081/"]

samples/arduino-wifi/flash.bat

@@ -0,0 +1 @@
+esptool.py --chip esp32s3 --port /dev/tty.usbserial-1110 --baud 921600 write_flash -z 0x0 Default_Factory_Firmware_ESP32-S3_v1.0.0.bin

samples/arduino-wifi/images/arduino_wifi_diagram.png

@@ -0,0 +1,7 @@
+esptool.py --chip esp32s3 \
+merge_bin -o sensecap_indicator_basis_v1.0.0.bin \
+--flash_mode dio \
+--flash_size 8MB \
+0x0 ../../build/bootloader/bootloader.bin \
+0x8000 ../../build/partition_table/partition-table.bin \
+0x10000 ../../build/indicator_basis.bin