REST API

From Aquarium-Control
Revision as of 08:05, 20 November 2025 by Uwe (talk | contribs) (Created page with "== Requirements == === General requirements === The API shall communicate with mobile apps and dynamic webpage. For each request, the API shall validate the credentials (user, password). The API shall provide the data in JSON format. Timestamps shall have the format: YYYY-MM-DD hh:mm:ss === Requirements for overview feature === The API shall provide an endpoint for informing the client about the validity of the credentials. The API shall provide an endpoint commun...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Requirements

General requirements

The API shall communicate with mobile apps and dynamic webpage.

For each request, the API shall validate the credentials (user, password).

The API shall provide the data in JSON format.

Timestamps shall have the format: YYYY-MM-DD hh:mm:ss

Requirements for overview feature

The API shall provide an endpoint for informing the client about the validity of the credentials.

The API shall provide an endpoint communicating a set of floating point data read from a set of files:

Signal name Signal format Signal source
timestamp string /var/local/aquarium-ctrl/aquarium-ctrl-ts
water temperature floating point number /var/local/aquarium-ctrl/atlsscntfc-temp

Architecture

Testing