2.2 KiB
| layout |
|---|
| documentation |
{% include base.html %}
Categories
Categories in Eclipse SmartHome are used to provide meta information about things channels, etc. UIs can use this information to render specific icons or provide a search functionality to for example filter all things for a certain category.
Differences between categories
We seperate the categories into functional and visual. Therefore we treat thing categories as how the physical device looks like and channel categories as something that describes the functional purpose of the channel.
Thing Categories
The thing type definition allows to specify a category. User interfaces can parse this category to get an idea how to render this thing. A binding can classify each thing into one of the existing categories. The list of all predefined categories can be found in our categories overview:
| Category | Description | Icon Example |
|-----------------|-------------|{% for category in site.data.categories_thing %}
|{{category.name}}|{{category.description}}|
Channel Group Categories
Channel groups can be seen as a kind of sub-device as they combine certain (physical) abilities of a thing into one. For such group channels one can set a category from the thing category list.
Channel Categories
The channel type definition allows to specify a category. A binding should classify each channel into one of the existing categories or leave the category blank, if there is no good match. There are different types of categories for channels, which are listed below.
{% for category in site.data.categories %} {% assign typesStr = typesStr | append: category.type | append: ',' %} {% endfor %} {% assign types = typesStr | split: ',' | uniq %}
{% for type in types %}
{{ type }}
| Category | Icon Example | |-----------------|--------------|{% for category in site.data.categories %}{% if category.type == type %} |{{category.name}}|{:height="36px" width="36px"}|{% endif %}{% endfor %} {% endfor %}