iotlabkit 1.0.0__py3-none-any.whl

iotlabkit/templates/program_10.py

@@ -0,0 +1,338 @@
+"""Template generator for Program 10: CoAP Environmental Monitoring (Open-Meteo + DB + Dashboard)."""
+
+from typing import Dict
+import os
+
+
+def generate(target_dir: str, mode: str = "learning") -> Dict[str, str]:
+    files = {}
+
+    files["requirements.txt"] = (
+        "requests>=2.28.0\n"
+        "python-dotenv>=1.0.0\n"
+        "streamlit>=1.25.0\n"
+    )
+
+    files[".env.example"] = (
+        "# Environmental Station Coordinates (Default: Kochi/Kalamassery, Kerala)\n"
+        "LATITUDE=10.0159\n"
+        "LONGITUDE=76.3419\n\n"
+        "# CoAP Server Port\n"
+        "COAP_HOST=127.0.0.1\n"
+        "COAP_PORT=56830\n\n"
+        "# Cloud Database Configuration ('supabase' or 'firebase')\n"
+        "CLOUD_PROVIDER=supabase\n"
+        "SUPABASE_URL=https://your-project-ref.supabase.co\n"
+        "SUPABASE_KEY=your-supabase-anon-key\n"
+        "FIREBASE_DATABASE_URL=https://your-firebase-project.firebaseio.com\n"
+    )
+
+    files[".gitignore"] = (
+        ".env\n"
+        "__pycache__/\n"
+        "*.py[cod]\n"
+        "data/local_coap_env.json\n"
+    )
+
+    # Embed coap_core.py
+    coap_util_path = os.path.join(os.path.dirname(os.path.dirname(__file__)), "coap_util.py")
+    if os.path.exists(coap_util_path):
+        with open(coap_util_path, "r", encoding="utf-8") as f:
+            files["coap_core.py"] = f.read()
+
+    files["supabase_schema.sql"] = (
+        "-- Supabase SQL Table Schema for Program 10 (CoAP Environmental Monitoring)\n"
+        "CREATE TABLE IF NOT EXISTS coap_environmental_records (\n"
+        "    id BIGINT GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY,\n"
+        "    created_at TIMESTAMP WITH TIME ZONE DEFAULT TIMEZONE('utc'::text, NOW()) NOT NULL,\n"
+        "    latitude DOUBLE PRECISION NOT NULL,\n"
+        "    longitude DOUBLE PRECISION NOT NULL,\n"
+        "    temperature DOUBLE PRECISION,\n"
+        "    humidity DOUBLE PRECISION,\n"
+        "    pm10 DOUBLE PRECISION,\n"
+        "    pm2_5 DOUBLE PRECISION,\n"
+        "    carbon_monoxide DOUBLE PRECISION,\n"
+        "    nitrogen_dioxide DOUBLE PRECISION,\n"
+        "    ozone DOUBLE PRECISION,\n"
+        "    european_aqi INTEGER\n"
+        ");\n\n"
+        "ALTER TABLE coap_environmental_records ENABLE ROW LEVEL SECURITY;\n"
+        "CREATE POLICY \"Allow anon read\" ON coap_environmental_records FOR SELECT USING (true);\n"
+        "CREATE POLICY \"Allow anon insert\" ON coap_environmental_records FOR INSERT WITH CHECK (true);\n"
+    )
+
+    # coap_env_server.py
+    if mode == "learning":
+        srv_doc = (
+            '"""CoAP Environmental Monitoring Server - Program 10.\n\n'
+            "Retrieves authentic real-time weather and air-quality observations from\n"
+            "Open-Meteo REST APIs and serves the consolidated metrics over CoAP UDP.\n"
+            '"""\n'
+        )
+    else:
+        srv_doc = '"""CoAP Environmental Server - Program 10 (Exam Mode)."""\n'
+
+    files["coap_env_server.py"] = srv_doc + (
+        "import argparse\n"
+        "import json\n"
+        "import os\n"
+        "import sys\n"
+        "import time\n"
+        "import requests\n"
+        "from dotenv import load_dotenv\n"
+        "from coap_core import CoAPServer, CODE_CONTENT, CODE_INTERNAL_ERR\n\n"
+        "load_dotenv()\n\n"
+        "DEFAULT_LAT = float(os.getenv('LATITUDE', 10.0159))\n"
+        "DEFAULT_LON = float(os.getenv('LONGITUDE', 76.3419))\n"
+        "COAP_HOST = os.getenv('COAP_HOST', '127.0.0.1')\n"
+        "COAP_PORT = int(os.getenv('COAP_PORT', 56830))\n\n"
+        "def fetch_live_environmental_data(lat: float, lon: float) -> dict:\n"
+        "    weather_url = f\"https://api.open-meteo.com/v1/forecast?latitude={lat}&longitude={lon}&current=temperature_2m,relative_humidity_2m,weather_code\"\n"
+        "    air_url = f\"https://air-quality-api.open-meteo.com/v1/air-quality?latitude={lat}&longitude={lon}&current=pm10,pm2_5,carbon_monoxide,nitrogen_dioxide,ozone,european_aqi\"\n\n"
+        "    record = {\n"
+        "        'latitude': lat,\n"
+        "        'longitude': lon,\n"
+        "        'timestamp': int(time.time()),\n"
+        "        'temperature': None,\n"
+        "        'humidity': None,\n"
+        "        'pm10': None,\n"
+        "        'pm2_5': None,\n"
+        "        'carbon_monoxide': None,\n"
+        "        'nitrogen_dioxide': None,\n"
+        "        'ozone': None,\n"
+        "        'european_aqi': None,\n"
+        "        'status': 'DATA_OK'\n"
+        "    }\n\n"
+        "    # 1. Fetch Weather\n"
+        "    try:\n"
+        "        w_resp = requests.get(weather_url, timeout=5)\n"
+        "        if w_resp.status_code == 200:\n"
+        "            curr_w = w_resp.json().get('current', {})\n"
+        "            record['temperature'] = curr_w.get('temperature_2m')\n"
+        "            record['humidity'] = curr_w.get('relative_humidity_2m')\n"
+        "    except requests.exceptions.Timeout:\n"
+        "        record['status'] = 'WEATHER_TIMEOUT'\n"
+        "    except Exception as e:\n"
+        "        record['status'] = f'WEATHER_ERROR: {e}'\n\n"
+        "    # 2. Fetch Air Quality\n"
+        "    try:\n"
+        "        a_resp = requests.get(air_url, timeout=5)\n"
+        "        if a_resp.status_code == 200:\n"
+        "            curr_a = a_resp.json().get('current', {})\n"
+        "            record['pm10'] = curr_a.get('pm10')\n"
+        "            record['pm2_5'] = curr_a.get('pm2_5')\n"
+        "            record['carbon_monoxide'] = curr_a.get('carbon_monoxide')\n"
+        "            record['nitrogen_dioxide'] = curr_a.get('nitrogen_dioxide')\n"
+        "            record['ozone'] = curr_a.get('ozone')\n"
+        "            record['european_aqi'] = curr_a.get('european_aqi')\n"
+        "    except requests.exceptions.Timeout:\n"
+        "        record['status'] = 'AIR_QUALITY_TIMEOUT'\n"
+        "    except Exception as e:\n"
+        "        record['status'] = f'AIR_ERROR: {e}'\n\n"
+        "    return record\n\n"
+        "def main():\n"
+        "    parser = argparse.ArgumentParser(description='CoAP Environmental Monitoring Server')\n"
+        "    parser.add_argument('--lat', type=float, default=DEFAULT_LAT, help='Latitude coordinate')\n"
+        "    parser.add_argument('--lon', type=float, default=DEFAULT_LON, help='Longitude coordinate')\n"
+        "    parser.add_argument('--port', type=int, default=COAP_PORT, help='CoAP UDP port')\n"
+        "    args = parser.parse_args()\n\n"
+        "    server = CoAPServer(host=COAP_HOST, port=args.port)\n\n"
+        "    def live_resource_handler():\n"
+        "        data = fetch_live_environmental_data(args.lat, args.lon)\n"
+        "        return CODE_CONTENT, json.dumps(data)\n\n"
+        "    server.add_resource('/environmental/live', live_resource_handler)\n\n"
+        "    print('=' * 65)\n"
+        "    print('🌐 Program 10: CoAP Environmental Monitoring Server')\n"
+        "    print('=' * 65)\n"
+        "    print(f'Listening on     : udp://{COAP_HOST}:{args.port}')\n"
+        "    print(f'CoAP Endpoint    : coap://{COAP_HOST}:{args.port}/environmental/live')\n"
+        "    print(f'Target Location  : Lat={args.lat}, Lon={args.lon} (Kochi, Kerala)')\n"
+        "    print('Live API Sources : Open-Meteo Weather & Air Quality APIs')\n"
+        "    print('=' * 65)\n"
+        "    print('Server started! Run `python coap_env_client.py` in Terminal 2.')\n"
+        "    print('Press Ctrl+C to stop.')\n\n"
+        "    try:\n"
+        "        server.start(blocking=True)\n"
+        "    except KeyboardInterrupt:\n"
+        "        print('\\nShutting down CoAP server...')\n"
+        "        server.stop()\n\n"
+        "if __name__ == '__main__':\n"
+        "    main()\n"
+    )
+
+    # coap_env_client.py
+    if mode == "learning":
+        cli_doc = (
+            '"""CoAP Environmental Monitoring Client - Program 10.\n\n'
+            "Retrieves live environmental metrics from CoAP server over UDP and\n"
+            "persists records into Supabase / Firebase cloud database.\n"
+            '"""\n'
+        )
+    else:
+        cli_doc = '"""CoAP Environmental Client - Program 10 (Exam Mode)."""\n'
+
+    files["coap_env_client.py"] = cli_doc + (
+        "import argparse\n"
+        "import json\n"
+        "import os\n"
+        "import sys\n"
+        "import time\n"
+        "from datetime import datetime, timezone\n"
+        "import requests\n"
+        "from dotenv import load_dotenv\n"
+        "from coap_core import CoAPClient\n\n"
+        "load_dotenv()\n\n"
+        "COAP_HOST = os.getenv('COAP_HOST', '127.0.0.1')\n"
+        "COAP_PORT = int(os.getenv('COAP_PORT', 56830))\n"
+        "CLOUD_PROVIDER = os.getenv('CLOUD_PROVIDER', 'supabase').lower().strip()\n"
+        "SUPABASE_URL = os.getenv('SUPABASE_URL', '').rstrip('/')\n"
+        "SUPABASE_KEY = os.getenv('SUPABASE_KEY', '')\n"
+        "FIREBASE_URL = os.getenv('FIREBASE_DATABASE_URL', '').rstrip('/')\n"
+        "LOCAL_BACKUP = os.path.join(os.path.dirname(__file__), 'data', 'local_coap_env.json')\n\n"
+        "def save_to_supabase(record: dict) -> bool:\n"
+        "    if not SUPABASE_URL or not SUPABASE_KEY or 'your-project' in SUPABASE_URL:\n"
+        "        return False\n"
+        "    headers = {'apikey': SUPABASE_KEY, 'Authorization': f'Bearer {SUPABASE_KEY}', 'Content-Type': 'application/json'}\n"
+        "    resp = requests.post(f'{SUPABASE_URL}/rest/v1/coap_environmental_records', json=record, headers=headers, timeout=5)\n"
+        "    return resp.status_code in (200, 201, 204)\n\n"
+        "def save_to_firebase(record: dict) -> bool:\n"
+        "    if not FIREBASE_URL or 'your-firebase' in FIREBASE_URL:\n"
+        "        return False\n"
+        "    resp = requests.post(f'{FIREBASE_URL}/coap_environmental_records.json', json=record, timeout=5)\n"
+        "    return resp.status_code == 200\n\n"
+        "def save_locally(record: dict):\n"
+        "    os.makedirs(os.path.dirname(LOCAL_BACKUP), exist_ok=True)\n"
+        "    records = []\n"
+        "    if os.path.exists(LOCAL_BACKUP):\n"
+        "        try:\n"
+        "            with open(LOCAL_BACKUP, 'r', encoding='utf-8') as f:\n"
+        "                records = json.load(f)\n"
+        "        except Exception:\n"
+        "            records = []\n"
+        "    records.append(record)\n"
+        "    with open(LOCAL_BACKUP, 'w', encoding='utf-8') as f:\n"
+        "        json.dump(records, f, indent=2)\n\n"
+        "def main():\n"
+        "    parser = argparse.ArgumentParser(description='CoAP Environmental Client')\n"
+        "    parser.add_argument('--host', default=COAP_HOST, help='CoAP server host')\n"
+        "    parser.add_argument('--port', type=int, default=COAP_PORT, help='CoAP server port')\n"
+        "    args = parser.parse_args()\n\n"
+        "    client = CoAPClient(timeout=6.0)\n"
+        "    print(f\"Sending CoAP GET to coap://{args.host}:{args.port}/environmental/live...\")\n\n"
+        "    try:\n"
+        "        resp = client.get(args.host, args.port, '/environmental/live')\n"
+        "        data = json.loads(resp.payload_text)\n"
+        "        data['created_at'] = datetime.now(timezone.utc).isoformat()\n\n"
+        "        print('✓ Received CoAP Response [2.05 Content]:')\n"
+        "        print(f\"  Coordinates  : Lat={data.get('latitude')}, Lon={data.get('longitude')}\")\n"
+        "        print(f\"  Temperature  : {data.get('temperature')} °C\")\n"
+        "        print(f\"  Humidity     : {data.get('humidity')} %\")\n"
+        "        print(f\"  PM2.5        : {data.get('pm2_5')} μg/m³\")\n"
+        "        print(f\"  PM10         : {data.get('pm10')} μg/m³\")\n"
+        "        print(f\"  CO           : {data.get('carbon_monoxide')} μg/m³\")\n"
+        "        print(f\"  NO2          : {data.get('nitrogen_dioxide')} μg/m³\")\n"
+        "        print(f\"  O3           : {data.get('ozone')} μg/m³\")\n"
+        "        print(f\"  European AQI : {data.get('european_aqi')}\")\n\n"
+        "        cloud_ok = False\n"
+        "        if CLOUD_PROVIDER == 'supabase':\n"
+        "            cloud_ok = save_to_supabase(data)\n"
+        "        elif CLOUD_PROVIDER == 'firebase':\n"
+        "            cloud_ok = save_to_firebase(data)\n"
+        "        save_locally(data)\n\n"
+        "        status_msg = 'Stored in cloud database' if cloud_ok else 'Cached locally (cloud keys pending)'\n"
+        "        print(f\"✓ Data Persistence: {status_msg}\")\n"
+        "    except Exception as err:\n"
+        "        print(f\"✗ CoAP Request failed: {err}\")\n"
+        "        print('  Ensure `python coap_env_server.py` is actively running.')\n\n"
+        "if __name__ == '__main__':\n"
+        "    main()\n"
+    )
+
+    # dashboard.py
+    files["dashboard.py"] = (
+        "import os\n"
+        "import json\n"
+        "import requests\n"
+        "import streamlit as st\n"
+        "from dotenv import load_dotenv\n\n"
+        "load_dotenv()\n\n"
+        "st.set_page_config(page_title='Program 10: CoAP Environmental Dashboard', layout='wide')\n"
+        "st.title('🌿 CoAP Environmental Monitoring Dashboard')\n"
+        "st.caption('MSc/MCA IoT Practical — Program 10 (Open-Meteo + CoAP + Cloud DB)')\n\n"
+        "CLOUD_PROVIDER = os.getenv('CLOUD_PROVIDER', 'supabase').lower().strip()\n"
+        "SUPABASE_URL = os.getenv('SUPABASE_URL', '').rstrip('/')\n"
+        "SUPABASE_KEY = os.getenv('SUPABASE_KEY', '')\n"
+        "LOCAL_BACKUP = os.path.join(os.path.dirname(__file__), 'data', 'local_coap_env.json')\n\n"
+        "def fetch_records():\n"
+        "    if CLOUD_PROVIDER == 'supabase' and SUPABASE_URL and 'your-project' not in SUPABASE_URL:\n"
+        "        try:\n"
+        "            headers = {'apikey': SUPABASE_KEY, 'Authorization': f'Bearer {SUPABASE_KEY}'}\n"
+        "            resp = requests.get(f'{SUPABASE_URL}/rest/v1/coap_environmental_records?order=created_at.desc&limit=30', headers=headers, timeout=4)\n"
+        "            if resp.status_code == 200:\n"
+        "                return resp.json()\n"
+        "        except Exception:\n"
+        "            pass\n"
+        "    if os.path.exists(LOCAL_BACKUP):\n"
+        "        try:\n"
+        "            with open(LOCAL_BACKUP, 'r', encoding='utf-8') as f:\n"
+        "                return list(reversed(json.load(f)))\n"
+        "        except Exception:\n"
+        "            pass\n"
+        "    return []\n\n"
+        "records = fetch_records()\n"
+        "if not records:\n"
+        "    st.warning('No records found. Run `python coap_env_server.py` in Terminal 1 and `python coap_env_client.py` in Terminal 2.')\n"
+        "else:\n"
+        "    curr = records[0]\n"
+        "    c1, c2, c3, c4 = st.columns(4)\n"
+        "    c1.metric('Temperature', f\"{curr.get('temperature', 'N/A')} °C\")\n"
+        "    c2.metric('Humidity', f\"{curr.get('humidity', 'N/A')} %\")\n"
+        "    c3.metric('PM2.5 Pollutant', f\"{curr.get('pm2_5', 'N/A')} μg/m³\")\n"
+        "    c4.metric('European AQI', str(curr.get('european_aqi', 'N/A')))\n\n"
+        "    st.subheader('📊 Environmental & Air Quality Data Log')\n"
+        "    st.dataframe(records, use_container_width=True)\n"
+    )
+
+    # README.md
+    if mode == "learning":
+        readme_content = (
+            "# Program 10 — CoAP Environmental Monitoring\n\n"
+            "## 1. Overview\n"
+            "This practical integrates live external APIs with the Constrained Application Protocol (CoAP):\n"
+            "- Queries **Open-Meteo Weather API** and **Open-Meteo Air Quality API** for configurable coordinates (Kalamassery/Kochi: `10.0159°N, 76.3419°E`).\n"
+            "- A CoAP Server exposes the live combined data over UDP at `coap://localhost:56830/environmental/live`.\n"
+            "- A CoAP Client retrieves the readings via UDP GET requests and persists them into Supabase or Firebase.\n"
+            "- A Streamlit web dashboard visualizes weather parameters, pollutant concentrations, and AQI.\n\n"
+            "## 2. Execution Guide\n\n"
+            "### Terminal 1 — Start the CoAP Environmental Server\n"
+            "```bash\n"
+            "python coap_env_server.py\n"
+            "```\n\n"
+            "### Terminal 2 — Query via CoAP Client & Store to DB\n"
+            "```bash\n"
+            "python coap_env_client.py\n"
+            "```\n\n"
+            "### Terminal 3 — Launch Dashboard\n"
+            "```bash\n"
+            "streamlit run dashboard.py\n"
+            "```\n\n"
+            "## 3. Viva Questions and Answers\n"
+            "**Q1: Why is an API bridge used between Open-Meteo and CoAP?**  \n"
+            "A: Public cloud APIs provide HTTP REST interfaces. In constrained IoT networks, edge gateways query HTTP APIs, compress the telemetry into lightweight packets, and distribute it internally via CoAP UDP to power-limited sensor nodes.\n\n"
+            "**Q2: What is European AQI (EAQI)?**  \n"
+            "A: EAQI is an index developed by the European Environment Agency based on hourly concentrations of 5 key pollutants: PM2.5, PM10, NO2, O3, and SO2.\n"
+        )
+    else:
+        readme_content = (
+            "# Program 10 — CoAP Environmental Monitoring (Exam Mode)\n\n"
+            "## Execution\n"
+            "1. Terminal 1: `python coap_env_server.py`\n"
+            "2. Terminal 2: `python coap_env_client.py`\n"
+            "3. Terminal 3: `streamlit run dashboard.py`\n\n"
+            "## Viva Q&A\n"
+            "- **Q: What data does Open-Meteo Air Quality API provide?**  \n"
+            "  A: Hourly concentrations of PM10, PM2.5, Carbon Monoxide, Nitrogen Dioxide, Ozone, and European AQI.\n"
+        )
+
+    files["README.md"] = readme_content
+    return files