Yannick SchausandGitHub
065177b730
The /things, /rules, /ui/components endpoints retrieve all objects in their entirety, which can become very big, i.e. channels, config parameters, script rule modules or trees of UI components can quickly add up to the size. When the UI simply displays a list of those objects it retrieves all this extra information but does nothing with it. This introduces an optional ?summary=true query parameter for the above resources to limit the output to pre-defined fields which are deemed most relevant for displaying these lists, omitting the rest. When the option is not set, the behavior remains unchanged so this change is not API breaking. The API version has therefore not been incremented. The client is responsible for adding the option to retrieve summarized collections instead of the entire objects. Signed-off-by: Yannick Schaus <github@schaus.net>
openHAB Core
This project contains core bundles of the openHAB runtime.
Building and running the project is fairly easy if you follow the steps detailed below.
Please note that openHAB Core is not a product itself, but a framework to build solutions on top. It is picked up by the main openHAB distribution.
This means that what you build is primarily an artifact repository of OSGi bundles that can be used within smart home products.
1. Prerequisites
The build infrastructure is based on Maven. If you know Maven already then there won't be any surprises for you. If you have not worked with Maven yet, just follow the instructions and everything will miraculously work ;-)
What you need before you start:
- Java SE Development Kit 11
- Maven 3 from https://maven.apache.org/download.html
Make sure that the mvn command is available on your path
2. Checkout
Checkout the source code from GitHub, e.g. by running:
git clone https://github.com/openhab/openhab-core.git
3. Building with Maven
To build this project from the sources, Maven takes care of everything:
- set
MAVEN_OPTSto-Xms512m -Xmx1024m - change into the openhab-core directory (
cd openhab-core) - run
mvn clean installto compile and package all sources
If there are tests that are failing occasionally on your local build, run mvn -DskipTests=true clean install instead to skip them.
How to contribute
If you want to become a contributor to the project, please read about contributing and check our guidelines first.