Commit Graph

80 Commits (final-stable)

Author SHA1 Message Date
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
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
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
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
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 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
Дилян Палаузов 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
J-N-K e4996fbf4d
New ThingHandlerService documentation (#2194)
* New ThingHandlerService documentation

* Update developers/bindings/index.md

Co-authored-by: Wouter Born <github@maindrain.net>
Signed-off-by: J-N-K <github@klug.nrw>

* improvement

* improvement

Signed-off-by: Jan N. Klug <github@klug.nrw>

* Update developers/bindings/index.md

Co-authored-by: Wouter Born <github@maindrain.net>
Signed-off-by: J-N-K <github@klug.nrw>

* Update developers/bindings/index.md

Co-authored-by: Wouter Born <github@maindrain.net>
Signed-off-by: J-N-K <github@klug.nrw>

* Update developers/bindings/index.md

Co-authored-by: Wouter Born <github@maindrain.net>
Signed-off-by: J-N-K <github@klug.nrw>

---------

Signed-off-by: J-N-K <github@klug.nrw>
Signed-off-by: Jan N. Klug <github@klug.nrw>
Co-authored-by: Wouter Born <github@maindrain.net>
2024-01-03 15:50:33 +01:00
Konstantin Polihronov ef6d4f92da
Fix the Reference typeId of the system.electric-energy (#2132)
Signed-off-by: Konstantin Polihronov <polychronov@gmail.com>
2023-09-17 21:01:24 +02:00
Wouter Born 010da345e1
Fix broken links (#2108)
Some documentation files were moved in #1872 which caused these links to be broken.

Signed-off-by: Wouter Born <github@maindrain.net>
2023-07-30 22:40:46 +02:00
J-N-K d12754a359
[developer] document thing-type update instructions (#2040)
* [developer] document thing-type update instructions

Signed-off-by: Jan N. Klug <github@klug.nrw>

* address review comments

Signed-off-by: Jan N. Klug <github@klug.nrw>

---------

Signed-off-by: Jan N. Klug <github@klug.nrw>
2023-04-16 17:24:16 +02:00
Rosi 0fee8ff11c
spelling corrections (#1998)
Signed-off-by: Rosi2143 <Schrott.Micha@web.de>
Co-authored-by: Jerome Luckenbach <github@luckenba.ch>
2023-02-06 10:08:51 +01:00
J-N-K 71adc538ad
Adapt to core changes (addon.xml) (#1872)
* Adjust to addon.xml

Signed-off-by: Jan N. Klug <github@klug.nrw>
2023-01-16 20:37:08 +01:00
Wouter Born 446022f8a4
Fix add-ons stylization (#1976)
This makes the documentation a bit more consistent to use "add-ons" or "Add-ons" where possible.

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

Signed-off-by: Wouter Born <github@maindrain.net>
2022-12-26 23:09:28 +01:00
Дилян Палаузов 969fae1f7b
Typos a/an (#1933) 2022-12-01 22:42:51 +01:00
Jerome Luckenbach 2ddff112b1
Remove common jekyll references. (#1917)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2022-11-24 18:35:16 +01:00
Jerome Luckenbach 53cdcdfe51
Fix markdown errors due to configuration changes (#1908)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2022-11-06 22:13:21 +01:00
Jerome Luckenbach 1a15b6c7fc
Improve markdown linting (#1906)
* Improve markdownlint configuration.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

* Apply changes to current linting rules.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2022-11-03 18:43:14 +01:00
Christoph Weitkamp fb6f36607d
Added default channel types for electrical energy (#1886)
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2022-09-11 17:42:36 +02:00
lolodomo 0ca265b68a
item-type (channel): list all available in core (#1814)
Signed-off-by: Laurent Garnier <lg.hc@free.fr>
2022-05-15 18:27:53 +02:00
Wouter Born c9b5b59c84
Fix broken "System State Channel Types" table (#1797)
Looks like the table got broken with #1788.

Signed-off-by: Wouter Born <github@maindrain.net>
2022-04-13 19:37:36 +02:00
Wouter Born 6d42647cb8
Fix broken links (#1796)
Signed-off-by: Wouter Born <github@maindrain.net>
2022-04-13 19:36:53 +02:00
Gaël L'hopital b4c3945b4c
Update thing-xml.md (#1788)
Adding indoor temperature as system channel.
2022-03-27 23:21:02 +02:00
Fabian Wolter 1c1bf5fc1b
Add note about textual configuration when implementing a discovery service (#1767)
Signed-off-by: Fabian Wolter <github@fabian-wolter.de>
2022-02-21 21:55:09 +01:00
Christoph Weitkamp aa263bc977
Remove references to Yahoo in developer documentation (#1726)
- Remove references to Yahoo in developer documentation

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2022-01-10 16:54:47 +01:00
Andrew Fiddian-Green 36214ff200
[developer-bindings] getRemovalGracePeriodSeconds for mDNS discovery (#1708)
* [developer-bindings] getRemovalGracePeriodSeconds for mDNS discovery
* [developer-bindings] tweak example code
* [developer-bindings] add modified() to example code
* [developer-bindings] tweak example code

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
2021-12-23 16:11:38 +01:00
Jerome Luckenbach 5cd00632cf
Fixed markdownlint errors. (#1679)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2021-11-26 18:21:25 +01:00
Kai Kreuzer 3da266ef60
Add faq section on how to model lights (#1675)
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2021-11-26 15:08:55 +01:00
Christoph Weitkamp bf61b10afc
Removed author-tags from binding definitions (#1655)
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2021-10-31 19:49:17 +01:00
Wouter Born 70a717d297
Update "Default Tags" documentation (#1651)
There used to be the following "Default Tags" which are no longer used in the current semantic model:

* Lighting
* Switchable
* CurrentTemperature
* TargetTemperature
* CurrentHumidity

Related to openhab/openhab-addons#11313

Signed-off-by: Wouter Born <github@maindrain.net>
2021-09-27 18:46:08 +02:00
Christoph Weitkamp cbe998e488
Added documentation of 'ChannelDescriptionChangedEvent's (#1610)
* Added documantation of 'ChannelDescriptionChangedEvent's

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>

* Replaced Sets.newHashSet(...) by Set.of(...)

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2021-06-27 20:59:30 +02:00
Fabian Wolter d8aba58e85
Add logo section to dev documentation (#1540)
* Add logo section to dev documentation

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

* Add SVG and zopflipng

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

* Remove SVG reference

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>

* Fix markdown lint error

Signed-off-by: Fabian Wolter <github@fabian-wolter.de>
2021-05-24 20:38:49 +02:00
Ethan Dye 0865d9c102
Optimize all png images using zopflipng (#1555)
The command
```
for i in $(find . -name '*.png'); do zopflipng -m --filters=0me --lossy_8bit --lossy_transparent -y "$i" "$i"; done
```
was used to accomplish this optimization, all images should have lost no
accuracy as a result of the compression applied.

Signed-off-by: Ethan Dye <mrtops03@gmail.com>
2021-04-27 21:00:55 +02:00
Jerome Luckenbach 388301e09d
Fix broken link (#1553)
Fixes #1547 

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2021-04-23 16:29:25 +02:00
Fabian Wolter d3d73927cc
Add default value of required tag (#1519)
Signed-off-by: Fabian Wolter <github@fabian-wolter.de>
2021-03-21 13:57:32 +01:00
Arjan Mels 1076022ff7
Remove advanced property from channel-group-type (#1509)
The advanced property does not exist for the channel-group-type.

Signed-off-by: Arjan Mels <43108771+arjanmels@users.noreply.github.com>
2021-03-14 16:14:04 +01:00
Jerome Luckenbach ae9bdd76ec
Fix Markdown. Remove Jenkins base tags. (#1497)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2021-02-24 21:08:19 +01:00
J-N-K 6f12d354d1
Update binding developer documentation (#1487)
Signed-Off-By: Jan N. Klug <jan.n.klug@rub.de>
2021-02-07 17:39:31 +01:00
Hilbrand Bouwkamp 20b9f74f9f [developers] Added Discovery that is bound to a Thing section (#1262)
Signed-off-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
2021-02-07 16:55:46 +01:00
Andrew Fiddian-Green fbf6db6cc4
[developers.bindings.discovery.upnp] Describe getRemovalGracePeriodSeconds() method (#1478)
* [developers.bindings.discovery.upnp] added getRemovalGracePeriodSeconds()

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

* [developers.bindings.discovery.upnp] minor tweaks

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
2021-02-03 20:48:39 +01:00
Christoph Weitkamp 454cdd99f5
Update list of system default channel types (#1467)
Related to https://github.com/openhab/openhab-core/pull/2069
Related to https://github.com/openhab/openhab-core/pull/2157

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2021-01-27 21:19:54 +01:00
Wouter Born 6bf5bf026b
Update links to target "main" branches (#1460)
* Update links to target "main" branches

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

* Update process_file.rb

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

* Update for all other repos too

Signed-off-by: Wouter Born <github@maindrain.net>
2021-01-20 20:32:07 +01:00