TPsoft.org/Hladinac
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doplnena dokumentacia projektu a fotky realizacie

Browse Source
This commit is contained in:
Igor Miňo
2026-06-24 11:52:05 +02:00
parent 62e78cac45
commit 2a77bec567
6 changed files with 252 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
AGENTS.md
View File

@ -9,7 +9,8 @@ This repository contains a small ESP8266/ESP32 Arduino project for monitoring wa
- `server/data-checker.php` is intended for hourly CRON runs and checks whether recent measurements are still being written.
- `server/functions.inc.php` contains shared PHP helpers, including JSON responses, HTTP requests, and Telegram notifications.
- `data/YYYY.jsonl` is created at runtime for logged measurements and should not be treated as source code.
- `README.md` gives the high-level project purpose.
- `docs/` contains project documentation images referenced from `README.md`.
- `README.md` is the user- and developer-facing project documentation.
- `LICENSE` contains licensing information.
- `.agents/` is reserved for agent/tooling metadata and should not be treated as firmware source.
@ -56,6 +57,8 @@ For PHP scripts, keep them framework-free unless the project grows. Return JSON
Keep shared PHP helpers in `server/functions.inc.php`. Use the existing `telegram()` helper for Telegram notifications, and wrap notification calls so delivery failures do not change the HTTP response or stop measurement logging.
Keep `README.md` as complete human-facing documentation for both users and developers. When hardware pins, measurement intervals, server endpoints, notifications, or documented photos change, update the README in the same change. Reference documentation images with relative paths such as `docs/example.jpg` so they render on GitHub.
## Hardware Notes
For ESP8266 conductive level sensing, use external pull-down resistors from each `PIN_LEVEL1..4` input to `GND`. The common electrode is driven to positive voltage only during measurement.
@ -86,6 +89,12 @@ Before committing server changes:
- For notification changes, verify that Telegram messages are sent only when `level1..level4` differ from the previous saved measurement.
- Verify invalid level combinations such as `0100`, `1010`, and `1101` produce the measurement error notification without causing an HTTP error.
Before committing documentation changes:
- Verify every image referenced from `README.md` exists under `docs/`.
- Verify hardware details in `README.md` match `arduino/arduino.ino`.
- Verify server behavior in `README.md` matches `server/log.php`, `server/data-checker.php`, and `server/functions.inc.php`.
## Commit & Pull Request Guidelines
Current Git history is minimal and uses a simple message such as `Initial commit`. Keep future commits short, imperative, and specific, for example `Add WiFi timeout handling`.