Commit Graph

261 Commits (main)

Author SHA1 Message Date
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
Wouter Born 45773302a2
Fix typos and capitalization issues (#2207)
Signed-off-by: Wouter Born <github@maindrain.net>
2024-01-13 19:06:34 +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
Wouter Born 467f27cd25
Document network-interface context (#2197)
This context was added in https://github.com/openhab/openhab-core/pull/3981.

Signed-off-by: Wouter Born <github@maindrain.net>
2024-01-03 14:03:45 +01:00
Andrew Fiddian-Green 3fd71f4076
Update addon.md for USB finder service (#2191)
This is a small update to align the documentation with last minute changes made in https://github.com/openhab/openhab-core/pull/3922

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
2023-12-28 18:54:14 +01:00
Andrew Fiddian-Green 0fc7a4615f
Improve developer documentation for addons.xml (#2186)
* Improve developer documentation for addons.xml

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

* Adopt reviwer suggestions.

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

---------

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
2023-12-22 17:15:32 +01:00
Andrew Fiddian-Green 1156252301
Add-on suggestion finder revised schema (#2174)
* Add-on suggestion finder revised schema

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

* Adopt reviewer suggestions

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

---------

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
2023-12-16 16:48:15 +01:00
Andrew Fiddian-Green ae491a7957
Extra fields for addon discovery in addon.xml (#2150)
* Add description of discovery-methods

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

* Add description of discovery-methods

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

* [developers-addons-addon] fix markdown errors

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

---------

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
2023-12-08 18:10:13 +01:00
Florian Hotze b86d50201c
Update Contributing guide for openhab-webui repo (#2168)
When sharing a link to that page, I noticed that the repository list was outdated.

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>
2023-12-05 13:46:04 +01:00
Daniel Rosengarten 2f8322730a
[ide-vscode] Add instructions to tasks.json (#2126)
* Update tasks.json for VS Code

Add 2 tasks for Visual Studio Code IDE.
Force code style update before compile.

Signed-off-by: Daniel Rosengarten <github@praetorians.be>

* Add a second update properties task

Signed-off-by: Daniel Rosengarten <github@praetorians.be>

* Update tasks.json

Signed-off-by: Daniel Rosengarten <github@praetorians.be>

---------

Signed-off-by: Daniel Rosengarten <github@praetorians.be>
2023-11-19 23:48:22 +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
Jeremy edadbc64bc
Bump github action workflow package dependencies (#2124)
* Bump github action workflow package dependencies

Signed-off-by: jsetton <jeremy.setton@gmail.com>

* Fix markdownlint errors

Signed-off-by: jsetton <jeremy.setton@gmail.com>

---------

Signed-off-by: jsetton <jeremy.setton@gmail.com>
2023-09-02 12:56:18 +02:00
Wouter Born 98a6d319a6
Link to Java 17 documentation (#2119)
This prevents issues because older documentation may not apply to Java 17.

Signed-off-by: Wouter Born <github@maindrain.net>
2023-08-21 18:13:13 +02:00
Jacob Laursen bdb37078aa
Update example for I18N custom keys (#2117)
Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>
2023-08-21 14:10:22 +02:00
Wouter Born e78c8ab82c
Update Governance for Teams to Discussions migration (#2120)
This updates the Governance docs for the migration to GitHub Discussions due to the Teams discussions sunset.

See: https://github.com/openhab/openhab-distro/discussions/1512

Signed-off-by: Wouter Born <github@maindrain.net>
2023-08-13 19:47:32 +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
Wouter Born ea5fce9b99
Some guidelines.md fixes (#2094)
There is no `log` method on Loggers, see:

https://slf4j.org/api/org/slf4j/Logger.html

Signed-off-by: Wouter Born <github@maindrain.net>
2023-07-01 10:35:16 +02:00
Jacob Laursen 52f9a4822c
Redefine connection in addon.xsd (#2069)
Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>
2023-04-24 18:52:35 +02:00
Jacob Laursen 73db235375
Add clarification for two-letter country codes (#2066)
Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>
2023-04-16 17:33:33 +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
Jacob Laursen ca8c303d57
Add naming convention (#2061)
Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>
2023-04-10 12:11:35 +02:00
Wouter Born 8eb2bd73d3
[Development] Eclipse Setup - Remove version notice (#2043)
Reverts #1925 because newer Eclipse versions are supported with openhab/openhab-distro#1513.

Signed-off-by: Wouter Born <github@maindrain.net>
2023-04-06 16:58:08 +02:00
Jacob Laursen cd10104705
Remove deprecated author property (#2041)
Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>
2023-04-02 22:18:01 +02:00
Wouter Born 096a6b1056
Update docs for OSGi R8 upgrade (#2037)
Signed-off-by: Wouter Born <github@maindrain.net>
2023-03-25 11:30:30 +01:00