Commit Graph

284 Commits (final)

Author SHA1 Message Date
Andrew Fiddian-Green 7c4e18141c
Describe addon.xml new `keywords` element (#2662)
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
2026-03-16 18:30:27 +01:00
Mark Herwege c0e1c0ec00
Add '-DskipFeatureChecks' option to build instructions (#2670)
Added option to skip Karaf feature resolution checks.
This is an option I use regularly to further speed up builds during development.

Signed-off-by: Mark Herwege <mherwege@users.noreply.github.com>
2026-03-16 18:28:26 +01:00
Andrew Fiddian-Green 5b9ca4b6df
Things: Describe channel properties (#2671)
Also-by: Jacob Laursen <jacob-github@vindvejr.dk>
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
2026-03-16 18:27:24 +01:00
Andrew Fiddian-Green d64125e93e
Schema update for configuration description (#2664)
* update readme for xml 'context' element

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
2026-03-04 19:52:30 +01:00
Andrew Fiddian-Green 3cb58eca89
Describe XSD schema requirement and IDE validation tools (#2629)
Also-by: Florian Hotze <dev@florianhotze.com>
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
2026-01-04 17:16:16 +01:00
jimtng d0cae00e90
Add sub-headings for core event attributes (#2621)
Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
2025-12-28 19:32:55 +01:00
jimtng bb0fbbb847
Fix typo in events.md regarding automation source (#2620) 2025-12-23 12:57:42 +01:00
Cody Cutrer ac472c485a
Update event source guidelines (#2611)
Signed-off-by: Cody Cutrer <cody@cutrer.us>
2025-12-18 14:08:32 +01:00
Richard Koshak a66dc1119d
Update description for 'group' parameter in config-xml (#2603)
Based on the discussion at https://github.com/openhab/openhab-webui/issues/3457 we determined the description of the `group` context on this doc was incorrect. This PR corrects the description.

Signed-off-by: Richard Koshak <rkoshak@users.noreply.github.com>
2025-11-27 08:54:24 +01:00
Дилян Палаузов 4371649459
developers/governance: Clarification on maintainers visibility (#2590) 2025-11-10 18:12:52 +01:00
Дилян Палаузов 99289f8dbb
developers/bindings: Fix dispose() code example (#2589) 2025-11-09 21:39:53 +01:00
Cody Cutrer 5666e102aa
Add guidelines for event source (#2580)
Signed-off-by: Cody Cutrer <cody@cutrer.us>
2025-10-14 20:39:15 +02:00
Andrew Fiddian-Green b199256a25
Improve modelling rules for light channels (#2552)
* Improve modelling rules for light channels

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* linting

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* Improve modelling rules for light channels

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* linting

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* Update developers/addons/faq.md

Co-authored-by: lsiepel <leosiepel@gmail.com>
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* Update developers/addons/faq.md

Co-authored-by: lsiepel <leosiepel@gmail.com>
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* Update developers/addons/faq.md

Co-authored-by: lsiepel <leosiepel@gmail.com>
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* Update developers/addons/faq.md

Co-authored-by: lsiepel <leosiepel@gmail.com>
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* Update developers/addons/faq.md

Co-authored-by: lsiepel <leosiepel@gmail.com>
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* Update developers/addons/faq.md

Co-authored-by: lsiepel <leosiepel@gmail.com>
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* Update developers/addons/faq.md

Co-authored-by: lsiepel <leosiepel@gmail.com>
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* Update developers/addons/faq.md

Co-authored-by: lsiepel <leosiepel@gmail.com>
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* Add link to example code

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* adopt reviewer suggestion

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

---------

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
Co-authored-by: lsiepel <leosiepel@gmail.com>
2025-10-07 22:52:43 +02:00
Cody Cutrer 7ae2f0c656
Add example implementations for profiles (#2561)
Shows how to access various pieces of context, and basic event forwarding.

Signed-off-by: Cody Cutrer <cody@cutrer.us>
2025-09-24 13:30:24 +02:00
lsiepel f0fc98716c
Add markdown format paragraph (#2542)
* Add markdown paragraph

Signed-off-by: lsiepel <leosiepel@gmail.com>

* fix no-trailing-spaces

Signed-off-by: Stefan Höhn <mail@stefanhoehn.com>

---------

Signed-off-by: lsiepel <leosiepel@gmail.com>
Signed-off-by: Stefan Höhn <mail@stefanhoehn.com>
Co-authored-by: Stefan Höhn <mail@stefanhoehn.com>
2025-08-16 07:48:48 +02:00
jimtng 3444342e1c
Thing status description clickable link to binding's url (#2447)
See https://github.com/openhab/openhab-webui/pull/2996

Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
2025-07-14 20:04:58 +02:00
Wouter Born 73ee41f698
Update Java 21 JVM requirements (#2510)
* Update Java 21 JVM requirements

Also fixes broken links and some outdated version numbers.

Signed-off-by: Wouter Born <github@maindrain.net>

* Update version numbers

Signed-off-by: Wouter Born <github@maindrain.net>

---------

Signed-off-by: Wouter Born <github@maindrain.net>
Co-authored-by: stefan-hoehn <mail@stefanhoehn.com>
2025-07-13 12:29:21 +02:00
Nadahar 1b3899fb61
Document Karaf debugging (#2501)
Signed-off-by: Ravi Nadahar <nadahar@rediffmail.com>
Co-authored-by: Ravi Nadahar <nadahar@rediffmail.com>
2025-07-05 13:43:32 +02:00
Holger Friedrich fba7b0db59
Document Felix Webconsole available in demo app (#2502)
* Document Felix Webconsole available in demo app

Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>

* fix markdown

Signed-off-by: Stefan Höhn <mail@stefanhoehn.com>

---------

Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
Signed-off-by: Stefan Höhn <mail@stefanhoehn.com>
Co-authored-by: stefan-hoehn <mail@stefanhoehn.com>
2025-06-16 21:19:41 +02:00
Florian Hotze d9612cd7de
Upgrade CI Markdown checks (#2497)
* Upgrade CI Markdown checks

- Use tcort/github-action-markdown-link-check instead of deprecated gaurav-nelson/github-action-markdown-link-check.
- Pin actions to SHA version to mitigate possible supply chain attacks.
- Consolidate markdown checks into a single workflow.

Signed-off-by: Florian Hotze <dev@florianhotze.com>

* Comment out broken link check as it was previously disabled

Signed-off-by: Florian Hotze <dev@florianhotze.com>

* Adjust markdownlint config for new version

Signed-off-by: Florian Hotze <dev@florianhotze.com>

* Fix markdownlint

Signed-off-by: Florian Hotze <dev@florianhotze.com>

---------

Signed-off-by: Florian Hotze <dev@florianhotze.com>
2025-06-16 20:44:16 +02:00
Andrew Fiddian-Green f40cf73eb3
Tagging conventions for commonly confused cases (#2496)
* Add conventions for commonly confused tag cases

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* A couple more use cases

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* Adopt reviewer suggestion

Co-authored-by: jimtng <2554958+jimtng@users.noreply.github.com>
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* describe multiple state modes

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* Remove empty line

* adopt some reviewer suggestions

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* adopt more reviwer suggestions

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* fix lint warning

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* more changes

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

---------

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
Co-authored-by: jimtng <2554958+jimtng@users.noreply.github.com>
2025-06-16 16:57:01 +02:00
Andrew Fiddian-Green eb248fa81e
Add tagging guideline (#2484)
* Add tagging guideline

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* adopt reviewer suggestion

Co-authored-by: Jacob Laursen <jacob-github@vindvejr.dk>
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* fix lint error

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

---------

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
Co-authored-by: Jacob Laursen <jacob-github@vindvejr.dk>
2025-05-09 19:40:59 +02:00
jimtng e9202e2417
Thing XML: Update system state channel types (#2490)
Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
Co-authored-by: stefan-hoehn <mail@stefanhoehn.com>
2025-05-07 16:15:12 +02:00
Andrew Fiddian-Green ead0542917
Update developer documentation concerning tags (#2483)
* Update developer documentation concerning tags

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* revert error

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* fix lint errors

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* tweak table

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* Add precision

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* Add schema link to references

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* Bug fix prior PR

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* second try

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* fix typo

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* Refer to primary function

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

---------

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
2025-04-16 16:58:50 +02:00
Andrew Fiddian-Green 93b8256446
Semantic Tags: developer information/rules (#2466)
* improve information on tags

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* typo

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* adopt some reviewer suggestions

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* add further rules

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* fix lint error

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* import https://github.com/openhab/openhab-core/issues/4619

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* tweaks

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* adopt reviewer suggestions

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* add rfc-2119 citation

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* cosmetics

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* fix capitalisation, and numbering scheme (to pass CI check)

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* adopt reviewer feedback

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* tweaks

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

---------

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
2025-03-20 15:28:04 +01:00
Holger Friedrich 673da56ad1
Java 21 for OH5 development (#2426)
* Java 21 for OH5 development

Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>

* rework after OH5 release

Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>

* review comment

Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>

---------

Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
2025-01-09 13:03:55 +01:00
Gwendal Roulleau 3298dc8463
[development] Adding generic, maven based run and debug. (#2435)
* [development] Adding generic, maven based run and debug.

Also see https://github.com/openhab/openhab-distro/pull/1707

Signed-off-by: Gwendal Roulleau <gwendal.roulleau@gmail.com>

* [development] Adding generic, maven based run and debug.

Apply MR comments

Signed-off-by: Gwendal Roulleau <gwendal.roulleau@gmail.com>

* [development] Adding generic, maven based run and debug.

Apply MR comments

Signed-off-by: Gwendal Roulleau <gwendal.roulleau@gmail.com>

---------

Signed-off-by: Gwendal Roulleau <gwendal.roulleau@gmail.com>
2024-12-30 09:45:39 +01:00
Jacob Laursen 85f084bed5
Link to Java 21 documentation (#2433)
Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>
2024-12-22 11:35:06 +01:00
Florian Hotze 41a27d6973
Improve `ThingActions` docs for UI-based rules & REST API support (#2416)
* Improve `ThingActions` documentation for UI-based rules & REST API support

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Add missing BigDecimal output type

Signed-off-by: Florian Hotze <dev@florianhotze.com>

---------

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
Signed-off-by: Florian Hotze <dev@florianhotze.com>
2024-12-14 13:51:41 +01:00
Andrew Fiddian-Green 1855cbd758
Documentation for IP addon discovery service (#2422)
* Description of syntax for IP suggestion finder service

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* escape escapes

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* again..

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* typos and cosmetics

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* fix markdown style warning

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* describe default

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

---------

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
2024-12-09 22:25:50 +01:00
Florian Hotze 7ac8659731
Developer docs: Improve new binding tutorial (#2415)
Supersedes #2304.

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
2024-12-01 11:37:44 +01:00
lsiepel 18c62200a9
Add clarification to ThingActionScope (#2413)
Fixes: https://github.com/openhab/openhab-addons/issues/10510

Signed-off-by: lsiepel <leosiepel@gmail.com>
2024-11-28 21:47:12 +01:00
Florian Hotze ef7e49d3b5
Change format for "datetime" context (#2389)
Refs https://github.com/openhab/openhab-core/pull/4428.

Signed-off-by: Florian Hotze <dev@florianhotze.com>
2024-10-27 11:41:25 +01:00
lolodomo e3badede91
Fix format for "datetime" context (config description parameter) (#2382)
The new expected format is "YYYY-MM-DD hh:mm:ss" instead of "YYYY-MM-DD hh:mm" as previously documented.

The "datetime" context is currently not used by official bindings and this context value is also not yet supported by Main UI.

Signed-off-by: Laurent Garnier <lg.hc@free.fr>
2024-10-18 20:28:02 +02:00
Udo Hartmann 56c8772efe
[profiles] Update index.md (#2367)
For consistency, existing system profiles need keyword `system:`

Signed-off-by: Udo Hartmann <udo1toni@users.noreply.github.com>
Co-authored-by: stefan-hoehn <mail@stefanhoehn.com>
2024-09-29 12:19:09 +02:00
Holger Friedrich 9842b1d408
Add notes about Java 21 (#2325)
* Add notes about Java 21

Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>

* review

Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>

---------

Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
2024-07-02 07:53:53 +02:00
jimtng f976b6b608
remove trailing whitespace (#2314)
Signed-off-by: jimtng <2554958+jimtng@users.noreply.github.com>
2024-06-26 22:30:18 +02:00
Andrew Fiddian-Green 3f51f6a3db
Provide more explanation of match preoprty value names for SDDP discovery (#2306)
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
2024-06-07 09:30:10 +02:00
Andrew Fiddian-Green 78acb0c6b6
Documentation for SDDP discovery (#2298)
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
2024-05-30 17:20:54 +02:00
stefan-hoehn a3accd8278
add latest docu of blockly features of M2 (#2297)
* add latest docu of blockly features of M2

Signed-off-by: Stefan Höhn <mail@stefanhoehn.com>

---------

Signed-off-by: Stefan Höhn <mail@stefanhoehn.com>
Co-authored-by: Florian Hotze <florianh_dev@icloud.com>
2024-05-27 20:01:55 +02:00
Andrew Fiddian-Green 29f533411e
Add documentation for Unit Hint (#2283)
* Unit Hint

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* Adopt reviewer suggestions..

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

* change camelCaseIds to dash-delimited-ids

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>

---------

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
2024-05-20 15:58:21 +02:00
GiviMAD 9474dc3bdf
[multimedia] Add record and transcribe commands (#2295)
* [multimedia] Add record and transcribe commands

Signed-off-by: Miguel Álvarez <miguelwork92@gmail.com>

* apply pr review

Signed-off-by: Miguel Álvarez <miguelwork92@gmail.com>

* fix md errors

Signed-off-by: Stefan Höhn <mail@stefanhoehn.com>

---------

Signed-off-by: Miguel Álvarez <miguelwork92@gmail.com>
Signed-off-by: Stefan Höhn <mail@stefanhoehn.com>
Co-authored-by: stefan-hoehn <mail@stefanhoehn.com>
2024-05-19 23:10:20 +02:00
M Valla 0a1212248d
Update link to update-description-1.0.0.xsd (#2275)
The link for the update-description-1.0.0.xsd is wrong.

Signed-off-by: M Valla <12682715+mvalla@users.noreply.github.com>
2024-05-04 14:54:01 +02:00
Florian Hotze a91eac17e4
Update developer docs for SVG add-on logos (#2273)
Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
2024-03-13 20:53:37 +01:00
Дилян Палаузов 1a96bd8863
Icons shall not be changed in rules (#2222)
• insert the conclusion from https://github.com/openhab/openhab-core/issues/3958

Co-authored-by: stefan-hoehn <mail@stefanhoehn.com>
2024-02-26 11:27:49 +01:00
Martin b936d88c73
Set params when using `@text/` (#2254)
Signed-off-by: Martin <martin.grzeslowski@gmail.com>
2024-02-26 07:43:34 +01:00
Andrew Fiddian-Green ac78eb1dff
Add match property name for process addon finder. (#2223)
Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
2024-02-01 19:16:13 +01:00
Florian Hotze 321c8decda
Add Main UI docs for integration into sidebar help (#2199)
* Add Main UI docs structure & Migrate UI-integrated docs

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Add some links

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Add CONTRIBUTING.md

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Update icon comments for UI code change

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Fix markdownlint

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Migrate existing MainUI settings documentation

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Fix build & Update sidebar

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Update img links

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Migrate docs from the UI section

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Add persistence docs

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Fixes & Improvements

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Update CONTRIBUTING.md

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

* Address review

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

---------

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
2024-01-27 00:35:27 +01:00
Wouter Born 07e189ba3f
Use `@Component` annotation instead of XML in Event Bus example code (#2217)
Using these DS Component annotations is more convenient and is used everywhere else in the code nowadays.

Signed-off-by: Wouter Born <github@maindrain.net>
2024-01-26 22:32:58 +01:00
J-N-K 0b5aa5b99e
Improve add-on dependency documentation (#2211)
Signed-off-by: Jan N. Klug <github@klug.nrw>
2024-01-17 20:03:32 +01:00