diff --git a/.vuepress/docs-sidebar.js b/.vuepress/docs-sidebar.js index 3cc597a49e..be359e77a9 100644 --- a/.vuepress/docs-sidebar.js +++ b/.vuepress/docs-sidebar.js @@ -68,6 +68,7 @@ module.exports = [ 'concepts/discovery', 'concepts/audio', 'concepts/units-of-measurement', + 'concepts/profiles', 'concepts/rules', ] }, diff --git a/concepts/categories.md b/concepts/categories.md deleted file mode 100644 index e8fa5d55e0..0000000000 --- a/concepts/categories.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -layout: documentation -title: Categories ---- - -# Categories - -Categories in openHAB 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 separate 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 | -| ---------------- | ---------------------------------------------------------------------------------------------------- | ------------------------------------------------- | -| Battery | Batteries, Energy Storages | ![battery](/iconsets/classic/battery.png) | -| Blinds | Roller shutters, window blinds, etc. | ![blinds](/iconsets/classic/blinds.png) | -| Camera | All kinds of cameras | ![camera](/iconsets/classic/camera.png) | -| Car | Smart Cars | | -| CleaningRobot | Vacuum robots, mopping robots, etc. | | -| Door | Door | ![door](/iconsets/classic/door.png) | -| FrontDoor | Front Door | ![frontdoor](/iconsets/classic/frontdoor.png) | -| GarageDoor | Garage Door | ![garagedoor](/iconsets/classic/garagedoor.png) | -| HVAC | Air condition devices, Fans | | -| Inverter | Power inverter, such as solar inverters etc. | | -| LawnMower | Lawn mowing robots, etc. | ![lawnmower](/iconsets/classic/lawnmower.png) | -| Lightbulb | Devices that illuminate something, such as bulbs, etc. | ![lightbulb](/iconsets/classic/lightbulb.png) | -| Lock | Devices whose primary purpose is locking something | ![lock](/iconsets/classic/lock.png) | -| MotionDetector | Motion sensors/detectors | | -| NetworkAppliance | Bridges/Gateway need to access other devices like used by Philips Hue for example, Routers, Switches | | -| PowerOutlet | Small devices to be plugged into a power socket in a wall which stick there | ![poweroutlet](/iconsets/classic/poweroutlet.png) | -| Projector | Devices that project a picture somewhere | ![projector](/iconsets/classic/projector.png) | -| RadiatorControl | Controls on radiators used to heat up rooms | | -| Receiver | Audio/Video receivers, i.e. radio receivers, satelite or cable receivers, recorders, etc. | ![receiver](/iconsets/classic/receiver.png) | -| Screen | Devices that are able to show a picture | ![screen](/iconsets/classic/screen.png) | -| Sensor | Device used to measure something | | -| Siren | Siren used by Alarm systems | ![siren](/iconsets/classic/siren.png) | -| SmokeDetector | Smoke detectors | | -| Speaker | Devices that are able to play sounds | | -| WallSwitch | Any device attached to the wall that controls a binary status of something, for ex. a light switch | ![wallswitch](/iconsets/classic/wallswitch.png) | -| WebService | Account with credentials for a website | | -| Window | Window | ![window](/iconsets/classic/window.png) | -| WhiteGood | Devices that look like Waschingmachines, Dishwashers, Dryers, Fridges, Ovens, etc. | ![whitegood](/iconsets/classic/whitegood.png) | - -### 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. - -### Widgets - -| Category | Icon Example | -| ------------- | ----------------------------------------------------- | -| Colorpicker | ![colorpicker](/iconsets/classic/colorpicker.png) | -| Number | ![number](/iconsets/classic/number.png) | -| Rollershutter | ![rollershutter](/iconsets/classic/rollershutter.png) | -| Slider | ![slider](/iconsets/classic/slider.png) | -| Switch | ![switch](/iconsets/classic/switch.png) | -| Text | ![text](/iconsets/classic/text.png) | -| Group | ![group](/iconsets/classic/group.png) | - -#### Weather - -| Category | Icon Example | -| ----------- | ------------------------------------------------- | -| Sun | ![sun](/iconsets/classic/sun.png) | -| Moon | ![moon](/iconsets/classic/moon.png) | -| Clouds | ![clouds](/iconsets/classic/clouds.png) | -| Sun_Clouds | ![sun_clouds](/iconsets/classic/sun_clouds.png) | -| Rain | ![rain](/iconsets/classic/rain.png) | -| Snow | ![snow](/iconsets/classic/snow.png) | -| Wind | ![wind](/iconsets/classic/wind.png) | -| Humidity | ![humidity](/iconsets/classic/humidity.png) | -| Temperature | ![temperature](/iconsets/classic/temperature.png) | - -#### Properties - -| Category | Icon Example | -| ---------------- | ----------------------------------------------------------- | -| BatteryLevel | ![batterylevel](/iconsets/classic/batterylevel.png) | -| LowBattery | ![lowbattery](/iconsets/classic/lowbattery.png) | -| CarbonDioxide | ![carbondioxide](/iconsets/classic/carbondioxide.png) | -| Energy | ![energy](/iconsets/classic/energy.png) | -| Gas | ![gas](/iconsets/classic/gas.png) | -| Oil | ![oil](/iconsets/classic/oil.png) | -| Water | ![water](/iconsets/classic/water.png) | -| Light | ![light](/iconsets/classic/light.png) | -| ColorLight | ![colorlight](/iconsets/classic/colorlight.png) | -| Temperature | ![temperature](/iconsets/classic/temperature.png) | -| Smoke | ![smoke](/iconsets/classic/smoke.png) | -| SoundVolume | ![soundvolume](/iconsets/classic/soundvolume.png) | -| Pressure | ![pressure](/iconsets/classic/pressure.png) | -| Fire | ![fire](/iconsets/classic/fire.png) | -| Motion | ![motion](/iconsets/classic/motion.png) | -| QualityOfService | ![qualityofservice](/iconsets/classic/qualityofservice.png) | -| Moisture | ![moisture](/iconsets/classic/moisture.png) | -| Noise | ![noise](/iconsets/classic/noise.png) | -| Flow | ![flow](/iconsets/classic/flow.png) | -| Price | ![price](/iconsets/classic/price.png) | -| Time | ![time](/iconsets/classic/time.png) | - -#### Control - -| Category | Icon Example | -| ------------ | --------------------------------------------------- | -| Heating | ![heating](/iconsets/classic/heating.png) | -| MediaControl | ![mediacontrol](/iconsets/classic/mediacontrol.png) | -| MoveControl | ![movecontrol](/iconsets/classic/movecontrol.png) | -| Zoom | ![zoom](/iconsets/classic/zoom.png) | - -#### Purpose - -| Category | Icon Example | -| -------- | ------------------------------------------- | -| Alarm | ![alarm](/iconsets/classic/alarm.png) | -| Presence | ![presence](/iconsets/classic/presence.png) | -| Vacation | ![vacation](/iconsets/classic/vacation.png) | -| Party | ![party](/iconsets/classic/party.png) | diff --git a/configuration/items.md b/configuration/items.md index 7f0ea880f0..bde8ad108a 100644 --- a/configuration/items.md +++ b/configuration/items.md @@ -297,6 +297,8 @@ In the example below, the "switch" icon has been selected: Switch Livingroom_Light "Livingroom Ceiling Light" ``` +Please note that icons (also know as categories) are not meant to be changed dynamically via rules. + #### Icons provided with openHAB openHAB provides a set of [classic icons](/docs/configuration/iconsets/classic/) by default. diff --git a/developers/bindings/thing-xml.md b/developers/bindings/thing-xml.md index 76465b4e6a..0e0aa0e25f 100644 --- a/developers/bindings/thing-xml.md +++ b/developers/bindings/thing-xml.md @@ -58,7 +58,7 @@ In that way, a generic thing type could be listed for users and a corresponding ### Thing Categories -A description about thing categories as well as an overview about which categories exist can be found in our [categories overview](../../concepts/categories.html). +Thing categories are used to set an icon for that Thing. The available categories correspond with the available icons of the classic icon set, however categories are written in Java class-naming style, e.g. FrontDoor instead of lowercase frontdoor. ## Channels @@ -145,9 +145,6 @@ There exist system-wide channel types that are available by default and which sh | electric-power | system.electric-power | Number:Power | Energy | Measurement, Power | Electric power | | electric-voltage | system.electric-voltage | Number:ElectricPotential | Energy | Measurement, Voltage | Electric voltage | | electrical-energy | system.electric-energy | Number:Energy | Energy | Measurement, Energy | Electrical energy | - -For further information about categories see the [categories page](../../concepts/categories.html). - The `advanced` property indicates whether this channel is a basic or a more specific functionality of the thing. If `advanced` is set to `true` a user interface may hide this channel by default. The default value is `false` and thus will be taken if the `advanced` attribute is not specified. @@ -411,7 +408,7 @@ public class ExampleHandlerFactory extends BaseThingHandlerFactory { ### Channel Categories -A description about channel categories as well as an overview about which categories exist can be found in out [categories overview](../../concepts/categories.html). +Channel categories are used to set an icon for that Channel. The available categories correspond with the available icons of the classic icon set, however categories are written in Java class-naming style, e.g. FrontDoor instead of lowercase frontdoor. ### Channel Groups @@ -434,7 +431,7 @@ Inside the thing types XML file channel groups can be defined like this: ``` The channel group type is defined on the same level as the thing types and channel types. -The group type must have a label, an optional description, and an optional [category](../../concepts/categories.html). +The group type must have a label, an optional description, and an optional category (icon). Moreover the list of contained channels must be specified: ```xml @@ -450,7 +447,6 @@ Moreover the list of contained channels must be specified: When a thing will be created for a thing type with channel groups, the channel UID will contain the group ID in the last segment divided by a hash (#). If an Item should be linked to a channel within a group, the channel UID would be `binding:multiChannelSwitchActor:myDevice:switchActor1#switch` for the XML example before. -Details about the category can be found in our [categories overview](../../concepts/categories.html). ## Properties