# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## What this project does

Yodmon is a bridge between the **Yodeck** digital signage API and **Zabbix** monitoring. It polls the Yodeck API every 10 minutes, stores player state in SQLite, exposes the data via SNMP v2c (for Zabbix to poll every minute), auto-creates/updates Zabbix hosts, and provides a web dashboard.

## Running locally (dev)

```bash
pip install flask requests apscheduler
python dev_server.py                    # web UI at http://localhost:8080
python snmp_test.py                     # print OID tree to verify SNMP data
python snmp_test.py --filter <name_or_id>
```

`dev_server.py` sets `DB_PATH` to `./data/yodmon.db` and skips SNMP (Linux/Docker only).

## Running in Docker

```bash
docker compose up -d --build    # SNMP on :161/udp, web UI on :8088
```

Edit `docker-compose.yml` before first run: set `APP_HOST` to the IP of the Docker host reachable by Zabbix.

## Configuration

All settings are environment variables (see `app/config.py`). Key ones:

| Variable | Default | Purpose |
|---|---|---|
| `YODECK_API_TOKEN` | — | `Token yodeck:<secret>` format |
| `APP_HOST` | `127.0.0.1` | IP Zabbix uses to reach this app's SNMP agent |
| `ENTERPRISE_OID` | `.1.3.6.1.4.1.99999` | Root OID for all player data |
| `SNMP_COMMUNITY` | `public` | SNMPv2c community string |
| `ZABBIX_URL` | `""` | Leave empty to disable Zabbix auto-sync |
| `ZABBIX_API_TOKEN` | `""` | Preferred auth (Zabbix 5.4+, required for 6.4+) |
| `ZABBIX_USER` / `ZABBIX_PASSWORD` | — | Fallback auth when no API token |
| `DB_PATH` | `/data/yodmon.db` | SQLite file path |

## Architecture

```
Yodeck API (every 10 min)
    └── app/scheduler.py  →  app/yodeck.py     fetches all screens (paginated)
                          →  app/database.py   upserts players + writes logs
                          →  app/zabbix.py     creates/updates Zabbix hosts via JSON-RPC API

Zabbix SNMP poll (every 1 min)
    └── snmpd (net-snmp)  →  snmp/pass_persist.py  reads SQLite, serves OIDs over stdin/stdout

Web UI
    └── app/web.py (Flask)  →  templates/index.html  shows player table + activity log
```

**SNMP OID structure** — `ENTERPRISE_OID.1.1.<column>.<yodeck_id>`:
- col 1 `STRING` hostname (`yodeck-<id>`)
- col 2 `STRING` display name
- col 3 `INTEGER` online (0/1)
- col 4 `STRING` last_seen (ISO-8601)
- col 5 `INTEGER` updating (0/1)
- col 6 `INTEGER` registered (0/1)
- col 7 `INTEGER` last_seen_unix (Unix timestamp, 0 if unknown) — used by the "not seen 4h" trigger

The Yodeck ID is used directly as the SNMP table index — OIDs are stable (e.g. `.1.3.6.1.4.1.99999.1.1.3.54239` = online status of player 54239).

**Database** — two tables in `yodmon.db`:
- `players` — one row per Yodeck player, upserted on each poll
- `logs` — append-only activity log; event types: `yodeck_fetch`, `zabbix_sync`, `snmp_transfer`, `error`

**Docker entrypoint** (`entrypoint.sh`) templates `/etc/snmp/snmpd.conf` from env vars at startup, then starts `snmpd` in the background before handing off to `python main.py`.

## Zabbix integration details

Targets **Zabbix 7.x** (also works with 6.0+). Each player becomes a host:
- **Host name:** `yodeck-<id>` (e.g. `yodeck-54239`) — `#` is not valid in Zabbix 7.x host names
- **Visible name:** `QRS-{first4chars}MB-{remainder}` (e.g. Yodeck name `AMS-COF1` → `QRS-AMS-MB-COF1`)
- **SNMP interface:** `APP_HOST:161`, SNMPv2c, community from `ZABBIX_SNMP_COMMUNITY`
- **Items:** `yodeck.online`, `yodeck.last_seen`, `yodeck.updating`, `yodeck.registered` — SNMP type 20, polled every 1 minute

**Authentication:** `ZABBIX_API_TOKEN` is sent as `Authorization: Bearer <token>` HTTP header (Zabbix 6.4+ style). If not set, falls back to `user.login` with `ZABBIX_USER`/`ZABBIX_PASSWORD`.

**Required Zabbix setup before first run:**
1. Create host group `Yodeck Players` manually in Zabbix
2. Grant the API token's user group **Read-write** permission on that host group (Administration → User groups → Host group permissions)
3. Grant the API token's user group **Read** permission on the `Templates` template group (Administration → User groups → Template permissions) — required for `template.get` to return results
4. Import `zabbix_template.yaml` (Configuration → Templates → Import)
5. The API token user needs at minimum **Zabbix Admin** role to create hosts and items