Commit Graph

40 Commits (b010c8061647c43679b682e15f2f00a2c45386c7)

Author SHA1 Message Date
David Gräff 64e3d99edd Rewrite developer section (#942)
* Rewrite developer section
* More work on module types
* More module-type stuff
* Adapt vuepress files
* Write binding doc
* Add TODOs for missing topics
* Add all missing topics from ESH.
* Tests
* Audio extensions
* Utilities
* i18n
* Event-bus
* Small fixes
* Command Description
* Add some tocs
* Add concept drawing to binding dev.
* Update developers/osgi/configadmin.md
Co-Authored-By: davidgraeff <david.graeff@web.de>
* Update administration/logging.md
Co-Authored-By: davidgraeff <david.graeff@web.de>
* Update developers/bindings/thing-xml.md
Co-Authored-By: davidgraeff <david.graeff@web.de>
* Convert HTML tables to Markdown
Signed-off-by: Hakan Tandogan <hakan@tandogan.com>
* Resolved one line per sentence review parts.
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
* Update developers/index.md
* Update developers/buildsystem.md
Co-Authored-By: davidgraeff <davgraeff@gmail.com>
* Add persistence placeholder. Address review comments
* fix persistence subdirectory
Signed-off-by: David Graeff <david.graeff@web.de>
* Update developers/audio/index.md
Co-Authored-By: davidgraeff <davgraeff@gmail.com>
* Update developers/guidelines.md
Co-Authored-By: davidgraeff <davgraeff@gmail.com>
* Update developers/contributing.md
Co-Authored-By: davidgraeff <davgraeff@gmail.com>
* Update developers/buildsystem.md
Co-Authored-By: davidgraeff <davgraeff@gmail.com>
* Update developers/guidelines.md
Co-Authored-By: davidgraeff <davgraeff@gmail.com>
* Update developers/index.md
Co-Authored-By: davidgraeff <davgraeff@gmail.com>
* Update developers/index.md
Co-Authored-By: davidgraeff <davgraeff@gmail.com>
* Update developers/osgi/osgids.md
Co-Authored-By: davidgraeff <davgraeff@gmail.com>
* Update developers/transformations/index.md
Co-Authored-By: davidgraeff <davgraeff@gmail.com>
* Update developers/ioservices/index.md
Co-Authored-By: davidgraeff <davgraeff@gmail.com>
* Remove extensionservices (for now ;)
Signed-off-by: David Graeff <david.graeff@web.de>
* Fix typos
Signed-off-by: David Graeff <david.graeff@web.de>
* Added example code for 'DynamicCommandDescriptionProvider' and 'DynamicCommandDescriptionProvider'
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
* Added example code for 'ThingHandlerFactory'
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
* Applied review comments
Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2019-05-02 20:52:37 +02:00
Jerome Luckenbach ae90389d40
Refactoring of nearly all markdown tables. (#869)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2019-01-13 14:25:05 +01:00
vzorglub 5acd79fd3c Changed smarthome:script (incorrect syntax) (#854)
By the way, it doesn't work
**test.script**
```
logInfo("TEST", "SCRIPT")
```

`openhab> smarthome:script test.script`
```
 ___ test.script
   The method or field test is undefined; line 1, column 0, length 4
```
2019-01-07 19:13:54 +01:00
Angelos Fountoulakis 484cd53e30 Update logging.md to exclude FATAL level (#821)
Remove Log Level `FATAL` since it does not exist in Karaf 4.x
Ref: http://karaf.apache.org/manual/latest/#_log4j_v2_support
It does exist as a standard log level built-in to log4j2 (https://logging.apache.org/log4j/2.x/manual/customloglevels.html) but it is not available on Karaf.

Signed-off-by: Angelos Fountoulakis agf@wired-net.gr (github: AngelosF)
2018-12-05 20:38:03 +01:00
Angelos Fountoulakis f183788dc2 Update Logging article, log4j2 (#814)
* Update Logging article, log4j2

Closes https://github.com/openhab/openhab-docs/issues/476 (yes, 1 year later 👍 )

Signed-off-by: Angelos Fountoulakis agf@wired-net.gr (github: AngelosF)

* Further updates on logging.md

[!] Changed the introductory text in section `#defining-what-to-log`
[!] Split the text in section `#defining-what-to-log` to one line per sentence
[!] Minor cosmetic improvements

Signed-off-by: Angelos Fountoulakis agf@wired-net.gr (github: AngelosF)

* Removed unnecessary blank lines

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2018-11-19 13:00:40 +01:00
Sami Salonen f6cbe2dd3e Serial configuration section added (#755)
* Serial configuration section

Discussed with Kai Kreuzer to have a central place explaining
serial port configuration in openHAB:
https://github.com/openhab/openhab2-addons/pull/2246#discussion_r206528746

Signed-off-by: Sami Salonen <ssalonen@gmail.com>

* Serial configuration section: some review changes

Signed-off-by: Sami Salonen <ssalonen@gmail.com>
2018-10-12 19:51:17 +02:00
Wouter Born 2803603919 Fix configuration file path references (#779)
* Replace 'config/' and 'conf/' with '$OPENHAB_CONF/'

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

* Replace ${openhab.home} with $OPENHAB_HOME in compatibilitylayer.md

Signed-off-by: Wouter Born <eclipse@maindrain.net>
2018-10-01 17:19:56 +02:00
Michael B 25e333ac96 [jsondb] Wrong hyperlink (#748)
Added the missing `t` to `jasonlint.com`
2018-07-17 21:37:11 +02:00
Yannick Schaus 94a28b3842 Fix link in administration/bundles.md
Signed-off-by: Yannick Schaus <habpanel@schaus.net>
2018-06-14 17:49:20 +02:00
Jerome L eb68de80aa
[administration/jsondb.md]Changed images from imageshack to local saved ones. (#714)
* Changed images from imageshack to local saved ones.

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

* s/images/.\/images/g

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2018-06-13 14:17:20 +02:00
Angelos Fountoulakis 799d74d850 Add content to jsondb.md (#281)
* Add content to jsondb.md

Closes #202 (https://github.com/openhab/openhab-docs/issues/202)

Sources of info:
a) https://community.openhab.org/t/replacement-of-mapdb-by-jsondb/17498
b) https://github.com/eclipse/smarthome/pull/1868

Signed-off-by: Angelos <agf@itcs.ro> (github: AngelosF)

* Add minor change for testing purpose

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)

* Adressed some review comments

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

* Changed to one sentence per line everywhere

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

* Improved backup file description

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

* Removed empty example file code fences.

Signed-off-by: Confectrician <github@luckenba.ch>
2018-06-11 08:43:22 +02:00
Yannick Schaus 19d8d3d39d Fix runtime command tables rendering (#680)
The new website's Markdown renderer (like GitHub's) doesn't support tables without headers.

Signed-off-by: Yannick Schaus <github@schaus.net>
2018-05-21 18:19:24 +02:00
Christoph Weitkamp 229544ad4b Documentation for new parameter to adjust the volume (#644)
* Added parameter to adjust the volume

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

* Added 'volume' parameter in the runtime section

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

* Removed volume parameter for 'stream()' methods

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2018-03-14 14:20:47 +01:00
Thomas Dietrich 39963e689e
Fix typo in logging article, fixes #615
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2018-01-04 22:29:53 +01:00
dougmcdorman 4a26f9b53a [administration/console.md]Fixing a bug in the Apache Karaf change password command (#611)
This command will remove the comma which makes the new password unusable so it needs put a "," in the replacement string as well.
For comparison look at the password change function which has the "," in both the search and replace.
https://github.com/openhab/openhabian/blob/master/functions/passwords.sh
sed -i "s/openhab = .*,/openhab = $passwordChange,/g" /var/lib/openhab2/etc/users.properties
2018-01-01 21:49:18 +01:00
Ben Clark 9bbabfce14 Update Linux and Console instructions for 2.2.0 (#588)
* Update Linux instructions for 2.2.0

Signed-off-by: Ben Clark <ben@benjyc.uk>

* Correct console link

Signed-off-by: Ben Clark <ben@benjyc.uk>

* Add warning about known_hosts file using SSH

And suggest using the Karaf console script instead of SSH on localhost.

Signed-off-by: Ben Clark <ben@benjyc.uk>

* Add user/pass info at relevant point.

Signed-off-by: Ben Clark <ben@benjyc.uk>

* Update windows with client script note.

Signed-off-by: Ben Clark <ben@benjyc.uk>

* Update console page according to reviews

Signed-off-by: Ben Clark <ben@benjyc.uk>

* Update Linux page according to reviews

Signed-off-by: Ben Clark <ben@benjyc.uk>
2017-12-16 18:57:32 -05:00
Ian Hubbertz 6437c7d047 [administration/console.md]openhab-distro:#533: Change sshHost description (#504)
* openhab-distro:#533: Change sshHost description

See https://github.com/openhab/openhab-distro/issues/533

However, I only changed this for the *"Bind Console to All Interfaces"* section, but other section are affected by the same issue.

Signed-off-by: Ian Hubbertz ian_web1@hubbertz.de

* Change directory references to $OPENHAB_CONF

-  Addresses comments submitted by @ThomDietrich and @bgilmer77

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)

* Fix long sentence

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-11-24 00:12:40 +01:00
bgilmer77 2b3586399e [Logging] Add example for logging Item state (#546)
* Add example for logging Item State

-  Addresses #534
-  Edited text to improve comprehension
-  Changed "Demo" to "heating-control.rules" in text
-  Changed "Demo" example to "heating-control.rules" example in #534
-  Article needs more work, but this PR is limited to addressing this issue.

* Address various comments from ThomDietrich

-  Numerous changes to address comments

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)

* Shorten package name/log example

-  Shortened package to e.model.script.heating-control.rules
-  Removed one of the temp entries from the logging example

Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)

* Add improvements

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)

* Change suggested by @bgilmer

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-11-08 13:23:08 +01:00
Jerome L e92cbee583 [Admin] Add naming convention to bundles (#522)
* Linting update before improving the article.

Signed-off-by: Jerome Luckenbach github@luckenba.ch (github: @Confectrician)

* Added an article about the bundle naming convention.

Closes #165

Signed-off-by: Jerome Luckenbach github@luckenba.ch (github: @Confectrician)

* Changes according to the review from @bgilmer77

- Removed the "id" explanation
- Simplified the usage Example

Signed-off-by: Jerome Luckenbach github@luckenba.ch (github: @Confectrician)

* Edited all code blocks and changed them to "text" instead of "python".

Signed-off-by: Jerome Luckenbach github@luckenba.ch (github: @Confectrician)

* Review edits.
- Added package namespace
- Changed to a generic description for <prefix>

Signed-off-by: Jerome Luckenbach github@luckenba.ch (github: @Confectrician)

* Markdown conform list indention

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-11-06 01:43:26 +01:00
sihui 61111d0bb4 Add prerequisite to stop openHAB before changing JsonDB files manually (#391)
Changing a JsonDB file manually is only possible if openHAB is stopped first, then perform the changes and then restart openHAB.
See discussion https://community.openhab.org/t/storage-of-items-authored-in-paperui/29427/14

Signed-off-by: Siegfried Huismann sihui@gmx.de (github: sihui62)
2017-06-06 20:19:49 +02:00
ShaunCurrier 943f2a1164 [Console] Update whole Karaf console article (#352)
Resolves #168
Resolves #298 
Resolves #299 
Resolves #345

* Clarify console access via localhost (#168)

Also, minor editing for clarity and ease of use.
Signed-off-by: Shaun Currier <shaun.currier@gmail.com> (github: ShaunCurrier)

* Refresh successful console connection example

Make ssh command ordering more conventional
Signed-off-by: Shaun Currier shaun.currier@gmail.com (github: ShaunCurrier)

* Add detailed console password and port change (#345)

Also reorganized headers to accommodate new detail and for easier navigation.

* Link to bind to all interfaces header

* Add walkthrough for console connection.

Also, clean up wording about distinction of interactive vs. service mode console access.

* Minor cleanups from proofing

* Minor fixes from building and proofing

* Revise whole article

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)

* Update console.md

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-03-18 13:05:00 +01:00
Thomas Dietrich cd86421a5b [Administration] Fix spelling error
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-02-09 11:43:07 +01:00
Chris Jackson 5be5bc2fb9 [JsonDB] Initial addition of jsondb overview (#282)
Signed-off-by: Chris Jackson <chris@cd-jackson.com>
2017-02-04 21:09:26 +01:00
Angelos Fountoulakis 44266484bf [Logging] Small correction on log command (#286)
Closes: #285 (https://github.com/openhab/openhab-docs/issues/285)
Small Correction on Log command to display exceptions

Signed-off-by: Angelos agf@itcs.ro (github: AngelosF)
2017-02-02 13:34:42 +01:00
M-ax-G a3fa6a75d8 [Logging] Update loglevels description (#212)
* Update logging.md

* Update logging.md

* Update logging.md

Signed-off-by: Max Grenkowitz <mxgrnkwtz@gmail.com> (github: M-ax-G)
Also signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-01-22 14:31:39 +01:00
Kai Kreuzer 00db391e8b [Console] Replace "Karaf console" by simply "console" (#217)
* Replaced "Karaf console" by simply "console"

Signed-off-by: Kai Kreuzer <kai@openhab.org>

* also changed menu entry

Signed-off-by: Kai Kreuzer <kai@openhab.org>

* some missed changes...

Signed-off-by: Kai Kreuzer <kai@openhab.org>

* moved sentences to single lines

Signed-off-by: Kai Kreuzer <kai@openhab.org>
2017-01-18 17:50:32 +01:00
Thomas Dietrich 11557486b5 Update menu entry names, many small changes
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00
Thomas Dietrich c87cd8c42c Add placeholder articles 2016-12-14 19:05:17 +01:00
Thomas Dietrich d1e667aa54 [Runtime] Remove table headers 2016-11-12 20:34:33 +01:00
Thomas Dietrich 0681324a2e Fix markdown 2016-11-12 20:24:41 +01:00
Kai Kreuzer 9075c11b32 added audio and voice console commands
Signed-off-by: Kai Kreuzer <kai@openhab.org>
2016-11-12 20:24:41 +01:00
Thomas Dietrich ccf16c3c58 [Logging] Fix formatting 2016-11-12 19:33:30 +01:00
Christian Häussler d2cc60145f Update paths to new OH2 folder layout, improve content (#130)
CHanges related to https://github.com/openhab/openhab-distro/pull/318


* Add HABmin and HABPanel UIs to Overview

Signed-off-by: Christian Häussler <c-n-i@web.de> (github: cniweb)

* Update working devices

https://github.com/openhab/openhab-syno-spk/issues/29

Signed-off-by: Christian Häussler <c-n-i@web.de> (github: cniweb)

* Updating paths for new OH2 folder layout

Fix for #129

Needed for: openhab/openhab-distro#318

Signed-off-by: Christian Häussler <c-n-i@web.de> (github: cniweb)

* Updating paths for new OH2 folder layout

Fix for #129

Needed for: openhab/openhab-distro#318

Signed-off-by: Christian Häussler <c-n-i@web.de> (github: cniweb)

* Updating paths for new OH2 folder layout

Fix for #129

Needed for: openhab/openhab-distro#318

Signed-off-by: Christian Häussler <c-n-i@web.de> (github: cniweb)

* Updating paths for new OH2 folder layout

Fix for #129

Needed for: openhab/openhab-distro#318

Signed-off-by: Christian Häussler <c-n-i@web.de> (github: cniweb)

* Improve console interface text

* Correct path information, clarify details

* Update logging.md

* Remove redundant already commented content

* Add exlicit syntax to code fences

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de>
2016-11-12 19:28:23 +01:00
lolodomo 7bcc7f3599 Fix console username, add interfaces cmd (#94)
* Fix the command to access the console

and add an advice in case the command fails.

* Replace warning and improve console interfaces

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-09-13 13:44:09 +02:00
Thomas Dietrich 228e74fa83 Add title to most pages, fixes (#60)
minor spelling and format inconsistencies
upper case headlines
deletes spaces and lines at the end

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-08-05 12:10:20 +02:00
joergkling 49c89a643a Rewrite of examples in chapter "Administration" so that they based on the demo setup (#52)
Signed-off-by: Joerg Kling <joerg.kling@gmail.com>
2016-08-02 11:35:18 +02:00
joergkling 576c75cb4a Small enhancements to chapter "Administration" and new sub-chapter "Runtime Commands" (#47)
* Small enhancements plus new chapter "Runtime Commands"

Signed-off-by: Joerg Kling <joerg.kling@gmail.com>
2016-07-16 21:50:38 +02:00
Łukasz Dywicki 936b28942b openhab/openhab-distro#145 Add documentation related to ssh console binding. (#38)
Signed-off-by: Łukasz Dywicki <luke@code-house.org>
2016-06-30 21:16:11 +02:00
joergkling a3dc71de8a Enhancements to chapter "Administration" (#20)
New Chapter "Administration"

Signed-off-by: Joerg Kling <joerg.kling@gmail.com>
2016-06-11 12:48:53 +02:00
joergkling fb21092209 New Chapter "Administration" (#13)
Signed-off-by: Joerg Kling <joerg.kling@gmail.com>
2016-06-04 20:39:05 +02:00