Metadata-Version: 2.4
Name: frigate-top
Version: 1.0.0
Summary: Real-time terminal dashboard for Frigate NVR/CCTV servers
Author-email: JD Bungart <me@jdneer.com>
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright 2026 JD Bungart
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Project-URL: Homepage, https://git.jdneer.com/jd/frigate-top
Project-URL: Repository, https://git.jdneer.com/jd/frigate-top
Project-URL: Changelog, https://git.jdneer.com/jd/frigate-top/src/branch/main/CHANGELOG.md
Keywords: frigate,nvr,cctv,monitoring,tui,terminal,dashboard,curses
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console :: Curses
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: System :: Monitoring
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Provides-Extra: yaml
Requires-Dist: PyYAML>=6.0; extra == "yaml"
Provides-Extra: dev
Requires-Dist: ruff>=0.6; extra == "dev"
Dynamic: license-file

# frigate-top

A real-time, interactive terminal dashboard for [Frigate](https://frigate.video/) NVR/CCTV hosts —
`htop` for your Frigate box. Stdlib-only Python, one file, no required dependencies.

![frigate-top dashboard](doc/screenshot.png)

It shows host-level metrics (CPU, memory, disk I/O, network I/O + errors, NVIDIA GPU, CPU iowait,
load) and Frigate-specific metrics (skipped frames, detector inference time, detection FPS, camera
FPS, online/offline cameras, estimated supported cameras) across a grid of block-bar graphs (one GPU
set per detected GPU). Each graph fills the full width over the configured timeframe, carries a
`-span … now` time axis, colours its fill and current value green/amber/red by warn/crit thresholds,
and marks the newest sample with a bright endpoint.

## What it does

- Draws a live, auto-refreshing dashboard grouped into **SYSTEM / NETWORK / FRIGATE** bands with colour-coded graph borders (blue = system, yellow = network, orange = Frigate).
- Shows a **header table** grouped into identity (hostname, uptime, OS, kernel), hardware (CPU, memory, GPU model + driver), Frigate (version, camera counts, supported-camera estimate, detector), and streams/storage (resolution, retention, interface, disk) — plus a status line of active warnings.
- Summarises **tracked-object activity** for the selected timeframe in the header (`Detections 1m  4 person  2 vehicle  1 animal  2 face  1 plate`), pulled from `/api/events` — a fixed category breakdown (person / vehicle / animal / recognised face / recognised plate, plus `other`) so the structure is visible even at zero. The API is polled at most every few seconds and cached.
- **Collapsible sections** — press `s` / `w` / `f` to fold the System / Network / Frigate groups; System and Network start collapsed so everything fits smaller terminals. Handles live terminal resizing without dropping graphs.
- Detects **multiple GPUs** and draws a labelled `GPU0 / GPU1 …` util/mem/temp set for each.
- Graphs **Frigate skipped frames** and **NET errors** in red on any nonzero value — these should always be zero, so they catch the eye immediately.
- Renders **block-bar graphs** by default (`--braille` for dense Braille area charts, `--ascii` for plain ASCII). Fills always span the full width and scroll left over the true timeframe; the x-axis reports how much history is currently shown.
- Encodes health in colour: bars and the title value turn amber past the warn threshold and red past crit, with a dashed guide line at each threshold and a `▲/▼/→` trend arrow versus the window start.
- Marks absent sensors (no GPU, no Frigate) with a dimmed `no sensor` panel instead of a misleading flat line.
- Estimates how many cameras the **detector(s)** can keep up with — a throughput bound (`detector inferences/sec × headroom ÷ configured detect fps`), which is the real limit on a Frigate box. It is motion-independent (uses the configured detect fps, not the noisy live rate); a single Coral at 5 fps works out to ~18 cameras. Tune the safety margin with `--detector-headroom` (default `0.75`).
- Auto-detects the Frigate API at common ports (`5000`, `8971`, `80`, `443`) and protocols (HTTP/HTTPS) (override with `--frigate-url`); tracks disk and the busiest network interface (pin with `--disk` / `--net-iface`).
- Lets you switch history timeframe on the fly (`1`, `5`, `p` for 15m, `t` for custom) and export samples to CSV (`--csv`).

## Install

`frigate-top` is a single stdlib-only module — install it however suits you.

**From the Forgejo package registry (pip):**

```bash
pip install --index-url https://git.jdneer.com/api/packages/jd/pypi/simple/ frigate-top
# optional: robust YAML config parsing (a regex fallback is used without it)
pip install --index-url https://git.jdneer.com/api/packages/jd/pypi/simple/ 'frigate-top[yaml]'
frigate-top
```

**From source:**

```bash
git clone https://git.jdneer.com/jd/frigate-top.git
cd frigate-top
pip install .          # or: pip install '.[yaml]'
frigate-top
```

**Single file (no install):** copy `frigate_top.py` to the host and run it — it needs only Python 3.7+.

```bash
scp frigate_top.py user@frigate-host:/usr/local/bin/frigate-top   # optional: drop it on PATH
python3 frigate_top.py
```

## Usage

Run `frigate-top` (installed) or `python3 frigate_top.py` (single file).

**Controls (keyboard):**

- `m` — toggle memory graph between percentage and bytes (used / cached / free)
- `n` — toggle network graphs between Mbps and MB/s
- `s` / `w` / `f` — collapse or expand the System / Network / Frigate sections (System and Network start collapsed)
- `1` / `5` / `p` — set history to 1 / 5 / 15 minutes
- `t` — set a custom history timeframe (in minutes)
- `q` — quit

**Examples:**

```bash
# Default 1-minute history, 1-second refresh
frigate-top

# 10-minute history
frigate-top --timeframe 10

# Point to a Frigate API and config
frigate-top --frigate-url http://localhost:5000 --config /config/config.yml

# Pin a specific network interface / disk device
frigate-top --net-iface eth0 --disk nvme0n1

# Write samples to CSV
frigate-top --csv /tmp/frigate-top.csv

# Dense Braille area charts, or plain ASCII with no colour
frigate-top --braille
frigate-top --ascii --no-color

# One-off snapshot for cron or health checks (works headless)
frigate-top --snapshot
```

## Requirements

- **Python 3.7+** (Linux — reads `/proc` and `/sys`)
- **No required dependencies.** `frigate-top` runs on the standard library alone.
- Optional, detected at runtime:
  - **PyYAML** (`frigate-top[yaml]`) — richer Frigate config parsing; a minimal regex fallback is used without it
  - `nvidia-smi` — NVIDIA GPU stats
  - `docker` or `podman` — Frigate container status
  - A reachable Frigate API — camera/detector stats and the detections summary

## Configuration

All options can be set via command-line arguments or environment variables.

| Variable | Default | Description |
|----------|---------|-------------|
| `TIMEFRAME` | `1` | Graph history in minutes |
| `REFRESH` | `1.0` | Refresh interval in seconds |
| `MAX_TIMEFRAME` | `60` | Maximum allowed history in minutes |
| `FRIGATE_CONFIG` | `""` | Path to Frigate `config.yml` |
| `FRIGATE_URL` | `""` | Frigate API URL, e.g. `http://localhost:5000` |
| `INSECURE` | `0` | Set to `1` to skip TLS verification for a remote HTTPS Frigate (loopback always allowed) |
| `NET_IFACE` | `""` | Network interface to monitor (auto-detected if empty) |
| `DISK_DEVICE` | `""` | Disk device to monitor, e.g. `sda` / `nvme0n1` (auto-detected if empty) |
| `CSV_FILE` | `""` | Append samples to CSV |
| `ASCII` | `0` | Set to `1` for ASCII graph characters |
| `BRAILLE` | `0` | Set to `1` for dense Braille area charts instead of block bars |
| `NO_COLOR` | `0` | Set to `1` to disable colors |
| `CPU_WARN` | `80` | CPU warning threshold |
| `CPU_CRIT` | `95` | CPU critical threshold |
| `MEM_WARN` | `80` | Memory warning threshold |
| `MEM_CRIT` | `95` | Memory critical threshold |
| `GPU_WARN` | `80` | GPU utilization warning threshold |
| `GPU_CRIT` | `95` | GPU utilization critical threshold |
| `GPU_TEMP_WARN` | `80` | GPU temperature warning °C |
| `DISK_IOWAIT_WARN` | `20` | I/O wait warning threshold |
| `DISK_FULL_CRIT` | `85` | Storage full critical threshold |
| `NET_WARN` | `1000` | Network throughput warning Mbps |
| `FRIGATE_SKIPPED_WARN` | `1.0` | Skipped FPS warning threshold |
| `FRIGATE_INFERENCE_WARN` | `100` | Detector inference time warning ms |
| `DETECTOR_HEADROOM` | `0.75` | Fraction of detector throughput used to size the supported-cameras estimate |

## Files

| File | Description |
|------|-------------|
| `frigate_top.py` | The dashboard — a single stdlib-only module |
| `pyproject.toml` | Package metadata (version read from `__version__`) |
| `requirements.in` / `requirements.txt` | Optional pinned + hash-verified PyYAML (see below) |
| `VERSION.md` / `CHANGELOG.md` | Versioning and release notes |
| `LICENSE` / `NOTICE` / `DISCLAIMER.md` | Apache-2.0 licence and terms |

## Optional supply-chain hardening

PyYAML is optional. If you want it hash-verified, `requirements.txt` pins it with SHA-256 hashes:

```bash
pip install --require-hashes -r requirements.txt
```

Regenerate after changing `requirements.in`:

```bash
pip install pip-tools && pip-compile --generate-hashes requirements.in -o requirements.txt
```

## Versioning

`frigate-top` follows [Semantic Versioning](https://semver.org/). The version lives once in
`frigate_top.py` as `__version__` and flows to the header title and the built package — see
[VERSION.md](VERSION.md) for the release process and [CHANGELOG.md](CHANGELOG.md) for history.

## Notes

- If the terminal is too small or not a TTY, use `--snapshot` for a one-off reading.
- The first sample is used as a baseline and is not shown in the graphs, so deltas are meaningful.
- Frigate config auto-detection tries `/config/config.yml`, `/config/config.yaml`, `/etc/frigate/config.yml`, `/opt/frigate/config/config.yml`, and `~/frigate/config/config.yml`.
- MQTT broker monitoring is intentionally not included because the broker is optional and containerized; the Frigate API provides the same health signals.
- **Security posture:** the tool is read-only — it shells out only to fixed commands (`nvidia-smi`, `docker`/`podman ps`, `df`) with no shell or user-interpolated arguments, parses YAML with `safe_load`, and writes its optional `--debug` log to a per-user directory (`$XDG_RUNTIME_DIR`) opened with `O_NOFOLLOW`. TLS certificates are verified for remote HTTPS Frigate instances; verification is relaxed only for loopback hosts (where self-signed certs are the norm) or when `--insecure` is passed.

## License

Licensed under the [Apache License 2.0](LICENSE). See [NOTICE](NOTICE) for attribution and
[DISCLAIMER.md](DISCLAIMER.md) for terms regarding use, third-party trademarks, warranty, and
liability.

frigate-top is an independent project and is not affiliated with or endorsed by the Frigate NVR
project, NVIDIA, Google, or Docker.
