User / System diagnostics
- Browser:
- —
- Platform:
- —
- CPU Threads:
- —
- RAM:
- —
- Display:
- —
- Polling Soll:
- —
- Polling Ist:
- waiting for samples
- Request Ø:
- —
- Request min/max:
- —
- Jitter:
- —
- Fehler:
- 0 / 0
Recent transmissions
| ID | Node | Frequency | Power | BW | Status | Payload |
|---|
Transmission parameters
events.log
| Time | type | ID | Node | Frequency | Power | BW | Duration | Collision | With | Collision bins | Occupied bins | Payload |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Click the button to load the retained contents of events.log (max. 1024 entries). | ||||||||||||
API reference
Direct Tap™ controls virtual TX through a single spatial press; UTC Tap™ synchronizes the five statistical period cards. Neither requires a permanent browser ID.
All requests go to this PHP file, normally /index.php.
Use HTTPS for the public playground. The short ?c=... interface
is intended for small embedded clients; ?api=... returns JSON.
Neither requires cookies or a session ID; a node name is supplied only when needed.
Public APIs have shared global rate limits, so a burst of traffic may return HTTP 429.
Short text API — embedded devices
| Method / path | Meaning | Plain-text response |
|---|---|---|
GET ?c=T&n=CC1&f=27025&p=-30&bw=10&ms=1000&d=hi |
Transmit a virtual RF packet | A = accepted with no collision detected at submission;
C = collision detected at submission; R (HTTP 429) = global rate limit or capacity reached. |
GET ?c=S |
Live status | active,colliding, e.g. 2,1 |
GET ?c=Q&n=CC1 |
Was this node active in the previous 10 seconds? | 1 = yes; 0 = no |
Minimum transmission:
/index.php?c=T&n=CC1&f=27025
The omitted parameters use the server defaults. A later transmission can still collide with
one initially answered with A. Public API limits are global and anonymous: frequent requests may return HTTP 429 with Retry-After. No session IDs, IP logs or client keys are created by the application.
Transmission parameters
| Short / JSON | Value and allowed range | Default |
|---|---|---|
n / node | Node name, ASCII letters, digits, _ . - (up to 24 chars) | N0 |
f | Centre frequency in kHz; 26565…27405 (manual API values may be off-raster) | 27025 |
p | TX power in dBm; −150…100 | 36.2 |
bw | Occupied bandwidth in kHz; 0.1…500 | 10 |
ms | Transmission duration in milliseconds; 1…600000 | 1000 |
d / data | Optional valid UTF-8 payload; at most 256 bytes | empty |
JSON API
| Method / path | Description |
|---|---|
GET ?api=state | Compact live state: server time (UTC), band limits, anonymous access estimate, currently retained TX.
Do not add heartbeat=1 for embedded monitoring; it is reserved for regular browser polling statistics. |
GET ?api=metrics | 85-bin all-time collision/occupancy arrays (backward compatible), period_bins for year/month/day/last 24 h UTC, period summaries, channel averages and popularity statistics. Poll less frequently than live state. |
POST / GET ?api=tx | Prefer POST so payloads are not copied into URL access logs; legacy GET remains available for embedded clients. Returns JSON including ok, id, collision, collides_with and end_ms. |
GET ?api=node&node=CC1 | Latest known information for the named node (or HTTP 404). |
GET ?api=log | Last 100 retained events, payloads redacted; globally rate-limited. |
GET ?api=logall | Complete retained rotating log (up to 1024 events), payloads redacted; globally rate-limited. |
POST ?api=reset | Admin only: requires server-configured secret sent in the X-RF-Admin-Key HTTP header; disabled until configured. Clears live RF state but preserves long-term metrics. |
POST ?api=admin_logall | Admin only: retained log including original payloads. |
POST ?api=feedback | Submit anonymous feedback (form field message, up to 2000 UTF-8 bytes); globally rate-limited. No public read API. |
POST ?api=admin_feedback | Admin only: retrieve up to 256 retained, private feedback entries via X-RF-Admin-Key. |
GET /index.php?api=tx&node=ARD1&f=27025&p=-30&bw=10&ms=1000&data=hello
Example response:
{"ok":true,"id":42,"collision":false,"collides_with":[],"end_ms":1780000000000}
The example ID and timestamp above are illustrative; use the actual server response. Requests with invalid values return HTTP 400; an exhausted global quota returns HTTP 429 and a Retry-After header.
Direct Tap™ — Spatial PTT
Direct Tap is an opt-in spatial virtual transmitter. Slide one finger to choose one of 85 CB-centre bins (26.565–27.405 MHz in 10-kHz steps) and continuous power (−80…+40 dBm, displayed to 0.01 dB). Put down a second finger on the spectrum to start a held virtual transmission. Lift either finger to stop; tab hiding or connection loss also releases the hold (connection loss after at most one lease). The current TX locks frequency and power at the moment the second finger touches; the crosshair may keep moving for the next TX. When Direct Tap is enabled, the ordinary Transmit button also uses the visible crosshair values on every click, overriding frequency and power randomization only. On desktop, move the mouse to select, then press and hold the left, middle or right mouse button anywhere within the spectrum plotting field to transmit; releasing it stops the virtual PTT. The normal Transmit button remains available. This is a virtual RF simulation, not control of an external transmitter.
POST ?api=touch_start
Content-Type: application/x-www-form-urlencoded
node=N1&f=27025&p=10&bw=10&data=
Response: {"ok":true,"id":42,"touch_key":"...","lease_ms":4500,"renew_ms":1600,...}
POST ?api=touch_extend
id=42&touch_key=...
POST ?api=touch_stop
id=42&touch_key=...&held_ms=850
The one-time touch_key is an unpredictable per-transmission capability, supplied only to the client that started the TX. Send it only in a POST body over HTTPS; it is never stored in a browser cookie, returned by the public state API or included in the event log. The server keeps only its hash in the protected state file. A stopped or expired key cannot restart the TX. On a lost connection, the current lease expires without further requests. Existing ?api=tx and ?c=T are unchanged.
Open-Control/BASIC and Arduino Connection
A microcontroller without native TCP / TLS can send the following ASCII request through a serial to network gateway that handles the higher layers of connection.
An Arduino-compatible board with Ethernet or Wi-Fi can issue the same URL through its HTTP client.
GET /index.php?c=T&n=CC1&f=27025&p=-30&bw=10&ms=1000&d=hi HTTP/1.1 Host: rfaquarium.ghn-sensorik.de Connection: close
Terminate HTTP headers with a blank CRLF line. Read the HTTP status code first, then the body:
A or C. A TLS-capable gateway is
necessary for an HTTPS-only webspace.
Arduino / ESP32 example (excerpt; Wi-Fi must already be connected,
and ROOT_CA_PEM must be configured for certificate validation):
WiFiClientSecure net; net.setCACert(ROOT_CA_PEM); HTTPClient http; http.begin(net, "https://rfaquarium.ghn-sensorik.de/index.php?c=S"); int status = http.GET(); if (status == 200) Serial.println(http.getString()); http.end();
RF_AQUARIUM_TOKEN
is enabled on the server, add token=... to requests.
Query-string tokens may be recorded by hosting access logs; the browser interface also contains its configured token,
so this mechanism is not a substitute for proper access control.Field Feedback
How has RF-Aquarium worked for you? Share observations, bugs or suggestions. No name, email address, account or session ID is required. Please do not include personal information. Your message is stored separately from the public RF event log and can be read only through the authenticated administrator API. The hosting provider may maintain its own access logs.