{"id":42307157,"url":"https://github.com/kurtarmamento/telemetry-ingest-api","last_synced_at":"2026-01-27T11:11:28.261Z","repository":{"id":333444400,"uuid":"1137352814","full_name":"kurtarmamento/telemetry-ingest-api","owner":"kurtarmamento","description":"FastAPI telemetry ingest service that validates sensor readings and stores the latest per device in SQLite (tests + CI).","archived":false,"fork":false,"pushed_at":"2026-01-19T14:54:05.000Z","size":84,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-01-19T16:43:52.094Z","etag":null,"topics":["backend","fastapi","github-actions","iot","mqtt","pydantic","pytest","python","rest-api","sqlite","telemetry"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kurtarmamento.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-19T09:02:45.000Z","updated_at":"2026-01-19T14:54:08.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/kurtarmamento/telemetry-ingest-api","commit_stats":null,"previous_names":["kurtarmamento/telemetry-ingest-api"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/kurtarmamento/telemetry-ingest-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kurtarmamento%2Ftelemetry-ingest-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kurtarmamento%2Ftelemetry-ingest-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kurtarmamento%2Ftelemetry-ingest-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kurtarmamento%2Ftelemetry-ingest-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kurtarmamento","download_url":"https://codeload.github.com/kurtarmamento/telemetry-ingest-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kurtarmamento%2Ftelemetry-ingest-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28812371,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-27T07:41:26.337Z","status":"ssl_error","status_checked_at":"2026-01-27T07:41:08.776Z","response_time":168,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backend","fastapi","github-actions","iot","mqtt","pydantic","pytest","python","rest-api","sqlite","telemetry"],"created_at":"2026-01-27T11:11:27.619Z","updated_at":"2026-01-27T11:11:28.254Z","avatar_url":"https://github.com/kurtarmamento.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Telemetry Ingest API (FastAPI + SQLite)\n\nA small backend service that **accepts sensor telemetry over HTTP**, validates it, and stores the **latest reading per device** in SQLite.\nThis makes MQTT-produced data easy to consume by any system that can speak HTTP (web apps, mobile apps, scripts, services).\n\n## What it does\n- **Ingest** telemetry via `POST /ingest` (validate + store)\n- Query the **latest** stored telemetry via `GET /latest/{device_id}`\n- Provide a simple **health** endpoint via `GET /health`\n- Persist data in **SQLite** (one row per device, updated on each ingest)\n\n### Why this is useful\nMQTT is great for streaming messages, but many consumers prefer HTTP. This API provides:\n- a **stable “current state” store** (latest reading survives restarts)\n- a **standard HTTP interface** for other systems\n- a **validation gate** that rejects malformed payloads (basic junk filtering)\n\n## Architecture (high level)\nDevice publishes to MQTT → Node-RED subscribes → Node-RED forwards to this API → other apps query via HTTP.\n\n## Endpoints\n- `GET /health` → `{ \"status\": \"ok\" }`\n- `POST /ingest` → validates payload and upserts latest reading by `device_id`\n- `GET /latest/{device_id}` → returns latest stored reading or 404\n\n## Data contract\n\n### `POST /ingest` payload\n```json\n{\n  \"device_id\": \"room-sensor-1\",\n  \"timestamp\": \"2026-01-19T12:34:56Z\",\n  \"metrics\": {\n    \"temp_c\": 25.4,\n    \"humidity_pct\": 56.1\n  }\n}\n```\n\nNotes:\n- `timestamp` is optional (server will assign current UTC time if omitted)\n- `metrics` must contain **at least one** numeric key/value pair\n\n### `GET /latest/{device_id}` response\n```json\n{\n  \"device_id\": \"room-sensor-1\",\n  \"timestamp\": \"2026-01-19T12:34:56Z\",\n  \"received_at\": \"2026-01-19T12:35:02Z\",\n  \"metrics\": {\n    \"humidity_pct\": 56.1,\n    \"temp_c\": 25.4\n  }\n}\n```\n\n## Quickstart (Windows / PowerShell)\n\n### 1) Setup venv + install\n```powershell\npy -3.12 -m venv .venv\n.\\.venv\\Scripts\\Activate.ps1\npip install -r requirements.txt\n```\n\n### 2) Run the server\n```powershell\nuvicorn app.main:app --reload\n```\n\nOpen API docs (interactive UI):\n- http://127.0.0.1:8000/docs\n\nHealth check:\n- http://127.0.0.1:8000/health\n\n## Using the UI (`/docs`)\nFastAPI provides Swagger UI:\n1) Open `http://127.0.0.1:8000/docs`\n2) Expand an endpoint (e.g., `POST /ingest`)\n3) Click **Try it out** → edit JSON → **Execute**\n4) Use `GET /latest/{device_id}` to confirm the stored value\n\n## Example requests (PowerShell)\n\n### Ingest\n```powershell\n$body = @{\n  device_id = \"room-sensor-1\"\n  timestamp = \"2026-01-19T12:34:56Z\"\n  metrics   = @{ temp_c = 25.4; humidity_pct = 56.1 }\n} | ConvertTo-Json -Depth 4\n\nInvoke-RestMethod -Method Post -Uri \"http://127.0.0.1:8000/ingest\" -ContentType \"application/json\" -Body $body\n```\n\n### Query latest\n```powershell\nInvoke-RestMethod -Uri \"http://127.0.0.1:8000/latest/room-sensor-01\"\n```\n\n## Storage\n- Default DB path: `data/telemetry.db`\n- Override with environment variable:\n  - `TELEMETRY_DB_PATH` (see `.env.example`)\n\nThis service stores **latest-per-device** using an upsert keyed on `device_id`.\n\n## Tests\n```powershell\npytest -q\n```\n\n## CI\nGitHub Actions runs `pytest` on every push/PR (see `.github/workflows/ci.yml`).\n\n## Repo structure\n```text\napp/\n  main.py      # FastAPI app + endpoints\n  models.py    # Pydantic request/response models + validation\n  db.py        # SQLite connection + schema init\n  repo.py      # SQL operations (upsert + fetch)\ntests/\n  test_health.py\n  test_ingest.py\n  test_latest.py\n```\n\n## Node-RED integration (MQTT → HTTP)\nIn Node-RED:\n- Subscribe to your MQTT topics (e.g., `sensors/#`)\n- Transform to the ingest payload shape\n- Use an HTTP Request node to `POST /ingest`\n\nIf Node-RED runs in Docker and this API runs on your host PC, the URL is typically:\n- `http://host.docker.internal:8000/ingest`\n\nIf Node-RED runs on your host PC, use:\n- `http://127.0.0.1:8000/ingest`\n\n## Troubleshooting\n- If you see import errors in tests, ensure:\n  - `app/__init__.py` exists\n  - you run tests from repo root: `python -m pytest -q`\n  - (recommended) add `pytest.ini` with:\n    ```ini\n    [pytest]\n    testpaths = tests\n    pythonpath = .\n    ```\n\n## Screenshots\n![Swagger UI](docs/images/swagger-ui.png)\n![Latest Response Example](docs/images/latest-response.png)\n![Node-Red MQTT -\u003e HTTP Bridge](docs/images/node-red-flow.png)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkurtarmamento%2Ftelemetry-ingest-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkurtarmamento%2Ftelemetry-ingest-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkurtarmamento%2Ftelemetry-ingest-api/lists"}