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

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

Class ProjectController

java.lang.Object

ro.pippo.controller.Controller

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

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

public final class ProjectController
extends AbstractController

Controller for project-specific endpoints to return some data from KNX Project file

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
ProjectController(KnxClient knxClient)

Method Summary

Modifier and Type	Method	Description
List<XmlGroupAddress>	getGroupAddresses()	Returns all group addresses
List<XmlGroupAddress>	getGroupAddresses(int main)	Returns the group addresses for a two-level project (main/sub) Main: 0 .. 31 Not supported for: three-level and free-level projects
List<XmlGroupAddress>	getGroupAddresses(int main, int middle)	Returns the group addresses for a three-level project (main/middle/sub) Main: 0 .. 31 Middle: 0 .. 7 Not supported for: two-level and free-level projects
List<XmlGroupRange>	getGroupRanges()	Returns the all group main ranges for a two-level project (main/sub) or a three-level project (main/middle/sub)
List<XmlGroupRange>	getGroupRanges(int main)	Returns the middle group ranges for a three-level project (main/middle/sub) Main: 0 .. 31 Not supported for: two-level and free-level projects
ProjectStructureResponse	projectStructure()	Returns the project structure containing metadata from *.knxproj file

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

ProjectController

public ProjectController(KnxClient knxClient)

Method Detail

projectStructure

@GET("/project")
@Produces("application/json")
public ProjectStructureResponse projectStructure()

Returns the project structure containing metadata from *.knxproj file

Returns:

response of project structure

getGroupRanges

@GET("/project/ranges")
@Produces("application/json")
public List<XmlGroupRange> getGroupRanges()

Returns the all group main ranges for a two-level project (main/sub) or a three-level project (main/middle/sub)

Not supported for: free-level projects

Returns:

list of XmlGroupRange on root level

getGroupRanges

@GET("/project/ranges/{main: \\d+}")
@Produces("application/json")
public List<XmlGroupRange> getGroupRanges(@Param
                                          int main)

Returns the middle group ranges for a three-level project (main/middle/sub)

• Main: 0 .. 31

Not supported for: two-level and free-level projects

Returns:

list of XmlGroupRange for given main range

getGroupAddresses

@GET("/project/addresses")
@Produces("application/json")
public List<XmlGroupAddress> getGroupAddresses()

Returns all group addresses

Supported for all projects: free-level, two-level and three-level

Returns:

list of XmlGroupAddress for given project

getGroupAddresses

@GET("/project/addresses/{main: \\d+}")
@Produces("application/json")
public List<XmlGroupAddress> getGroupAddresses(@Param
                                               int main)

Returns the group addresses for a two-level project (main/sub)

• Main: 0 .. 31

Not supported for: three-level and free-level projects

Returns:

list of XmlGroupAddress for given main range

getGroupAddresses

@GET("/project/addresses/{main: \\d+}/{middle: \\d+}")
@Produces("application/json")
public List<XmlGroupAddress> getGroupAddresses(@Param
                                               int main,
                                               @Param
                                               int middle)

Returns the group addresses for a three-level project (main/middle/sub)

• Main: 0 .. 31
• Middle: 0 .. 7

Not supported for: two-level and free-level projects

Returns:

list of XmlGroupAddress for given main and middle ranges