Module li.pitschmann.knx.core.plugin.api

Package li.pitschmann.knx.core.plugin.api.v1.controllers

Class ReadRequestController

java.lang.Object

ro.pippo.controller.Controller

li.pitschmann.knx.core.plugin.api.v1.controllers.AbstractController

li.pitschmann.knx.core.plugin.api.v1.controllers.ReadRequestController

public final class ReadRequestController
extends AbstractController

Controller for read requests

Field Summary

Fields inherited from class li.pitschmann.knx.core.plugin.api.v1.controllers.AbstractController

log

Constructor Summary

Constructors

Constructor	Description
ReadRequestController(KnxClient knxClient)

Method Summary

Modifier and Type	Method	Description
ReadResponse	readRequest(ReadRequest readRequest)	Endpoint for read request to be forwarded to KNX Net/IP device

Methods inherited from class li.pitschmann.knx.core.plugin.api.v1.controllers.AbstractController

getKnxClient, limitAndGetAsList

Methods inherited from class ro.pippo.controller.Controller

getApplication, getMessages, getRequest, getResponse, getRouteContext, getSettings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReadRequestController

public ReadRequestController(KnxClient knxClient)

Method Detail

readRequest

@POST("/read")
@Consumes("application/json")
@Produces("application/json")
public ReadResponse readRequest(@Body
                                ReadRequest readRequest)

Endpoint for read request to be forwarded to KNX Net/IP device

As soon we get an acknowledge frame from KNX Net/IP device, we will wait for a read request frame up to 3 seconds. If successful, the API will return the actual value with details like data point type. Otherwise, we simply return a JSON response with error state.

Parameters:

readRequest - the read request from HTTP client

Returns:

a new instance of ReadResponse