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

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

Class ProjectController

java.lang.Object

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

Constructor Summary

Constructors

Constructor	Description
ProjectController(li.pitschmann.knx.core.communication.KnxClient knxClient)

Method Summary

Modifier and Type	Method	Description
void	getGroupAddresses(io.javalin.http.Context ctx)	Returns all group addresses
void	getGroupAddresses(io.javalin.http.Context ctx, 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
void	getGroupAddresses(io.javalin.http.Context ctx, 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
void	getGroupRanges(io.javalin.http.Context ctx)	Returns the all group main ranges for a two-level project (main/sub) or a three-level project (main/middle/sub)
void	getGroupRanges(io.javalin.http.Context ctx, 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
void	projectStructure(io.javalin.http.Context ctx)	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 java.lang.Object

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

Constructor Detail

ProjectController

public ProjectController(li.pitschmann.knx.core.communication.KnxClient knxClient)

Method Detail

projectStructure

public void projectStructure(io.javalin.http.Context ctx)

Returns the project structure containing metadata from *.knxproj file

Parameters:

ctx - the Javalin context

getGroupRanges

public void getGroupRanges(io.javalin.http.Context ctx)

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

Parameters:

ctx - the Javalin context

getGroupRanges

public void getGroupRanges(io.javalin.http.Context ctx,
                           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

Parameters:

ctx - the Javalin context

main - the main group

getGroupAddresses

public void getGroupAddresses(io.javalin.http.Context ctx)

Returns all group addresses

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

Parameters:

ctx - the Javalin context

getGroupAddresses

public void getGroupAddresses(io.javalin.http.Context ctx,
                              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

Parameters:

ctx - the Javalin context

main - the main group

getGroupAddresses

public void getGroupAddresses(io.javalin.http.Context ctx,
                              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

Parameters:

ctx - the Javalin context

main - the main group

middle - the middle group