Add comments referring to the listener doc specification.

koppelting
Bertrik Sikken 2017-08-21 15:11:41 +02:00
rodzic 5c08920dbf
commit fe36a718e2
2 zmienionych plików z 8 dodań i 0 usunięć

Wyświetl plik

@ -7,6 +7,11 @@ import com.fasterxml.jackson.databind.node.ObjectNode;
/**
* Listener information doc.
*
* @see http://habitat.habhub.org/jse/#schemas/listener_information.json
*
* @note the document above does NOT describe all fields that are present in practice!
* There are also fields like "radio", "antenna", "location", "name"
*/
public final class ListenerInformationDoc extends ListenerDoc {
@ -27,6 +32,7 @@ public final class ListenerInformationDoc extends ListenerDoc {
protected JsonNode createDataNode() {
final ObjectNode node = factory().objectNode();
node.set("callsign", factory().textNode(callSign));
node.set("radio", factory().textNode("TheThingsNetwork"));
return node;
}

Wyświetl plik

@ -9,6 +9,8 @@ import nl.sikken.bertrik.hab.habitat.HabReceiver;
/**
* Listener telemetry doc.
*
* @see http://habitat.habhub.org/jse/#schemas/listener_telemetry.json
*/
public final class ListenerTelemetryDoc extends ListenerDoc {