Commit Graph

41 Commits (5348b22a2c05e49454ad4d0e03a489fc44ce0702)

Author SHA1 Message Date
Jerome Luckenbach d4cc7be27e
Introduced many custom containers. (#1117)
* Refactored multiple 'Note:' occurances.

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

* Small fixes

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2019-12-27 16:18:48 +01:00
lolodomo 0b39e869a0 Introduced new implicit variable named newState (#1029)
Signed-off-by: Laurent Garnier <lg.hc@free.fr>
2019-08-17 09:35:03 +02:00
Humberto Rodríguez A 6c37c2aed2 Update rules-dsl.md (#1013)
Fix typos and grammar mistakes

Signed-off-by: Humberto Rodriguez Avila <rhumbert@vub.ac.be>
2019-07-14 14:18:28 +02:00
awesomecogs 61d41b542e Update rules-dsl.md (#936)
Corrected "cron expression" link for time-based trigger to updated Quartz link.
2019-05-18 21:08:24 +02:00
Ryan Johnston 8d0ff52981 Fix 404 links (#978)
Cron link for quartz scheduler has been moved to a new url without a redirect. Suggested fix is to update openhab link.
2019-05-18 11:42:36 +02:00
Richard Koshak b010c80616 Change description of System started description (#979)
Signed-off-by: Richard Koshak <rlkoshak@gmail.com>
2019-05-18 11:40:39 +02:00
JMacIV 6f6805982d Small typo fix in Manipulating Item States (#928)
Signed-off-by: John McMillan <johnmcmillaniv@gmail.com>
2019-04-05 23:59:20 +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
Jerome Luckenbach 69175e38d0 Fixed backticks in rules-dsl.md
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2019-01-13 11:54:14 +01:00
Markus Lipp a115ed0312 Clarify rules-dsl.md (#868)
Added language to clarify that sendCommand can trigger rules with received update trigger

Signed-off-by: Markus Lipp lipp_markus@gmail.com (github: LightIsLife)
2019-01-13 11:49:55 +01:00
Christoph Weitkamp ed3d0e8a11 Added description of 'receivedEvent' variable for channel-based triggers (#830)
- Added description of 'receivedEvent' variable for channel-based triggers

Signed-off-by: Christoph Weitkamp <github@christophweitkamp.de>
2018-12-19 07:43:25 +01:00
Leroy Förster f03cd1ff75 Fix math for converting ColorItem HSBTypes to RGB (#743)
Added a step to divide by 100, changed 16^2 to 2^16-1 and fixed the example.

Signed-off-by: Leroy Förster <gersilex@email.com> (github: gersilex)
2018-10-15 19:04:50 +02:00
imtheuser 209ad63600 Updated Section DateTime Item (#784)
* Updated Section DateTime Item

The program code suggested in the documentation in section "// Convert DateTimeType to Joda DateTime" did not work for me.
@rkoshak proposed two options in this post:
https://community.openhab.org/t/error-timeinmillis-is-not-a-member-of-java-time-zoneddatetime/53079/3
Both worked for me.
I have therefore replaced the existing code with rlkoshak's two options.

* Update rules-dsl.md

Signed-off-by: Rudolf Allgaier <meinpcpostfach@yahoo.de>
2018-10-14 11:30:00 +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
Scott Rushworth 813e1e5ea0 Corrected Thing Status Action link (#777) 2018-09-18 19:29:31 +02:00
Rosi2143 95d20a7978 replace .calendar with .zonedDateTime (#762)
getCalender() is deprecated getZonedDateTime() should be used
2018-09-04 09:46:22 +02:00
William Leemans 2e087ec708 wrong method (#771) 2018-09-04 09:45:13 +02:00
Richard Koshak 1b8ce6d7ce Added documentation for Member of Rule triggers (#759)
This applies to OH 2.3, not sure how to back port it.

While I was here, I also added a warning that if one uses received command, one cannot use ItemName.state and should instead use receivedCommand.

Signed off by Richard Koshak <rlkoshak@gmail.com>

Addresses #758
2018-08-19 17:32:05 +02:00
Sam B 5079461954 Typo "MyTimes" instead of "MyItems" (#744) 2018-07-15 12:25:25 +02:00
Jerome Luckenbach c2293a1eff
Fixed some links. (#741)
* Fixed some links. Closes #732.

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

* Added Anchors.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2018-07-13 22:14:47 +02:00
Jerome Luckenbach 0b51686ea6
Fixed wrong url hash
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2018-07-08 23:04:27 +02:00
Mark Herwege f9b4d3af7f Replace Smarthome designer by VS Code Extension (#726) 2018-07-08 16:39:24 +02:00
Kai Kreuzer 76a85507d9 [configuration/rules-dsl.md]fixed formatting (#692)
* fixed formatting

* sentences on new lines, also escaped single units
2018-06-03 11:30:51 +02:00
Stefan Triller 20de280a6a Document new transformRaw command in rules (#687)
* Document new transformRaw command in rules

Signed-off-by: Stefan Triller <stefan.triller@telekom.de>
2018-05-25 16:41:58 +02:00
Henning Treu f5eded6370 Add QuantityType conversion to rules documentation (#675)
Signed-off-by: Henning Treu <henning.treu@telekom.de>
2018-05-14 20:47:40 +02:00
ConfusedTA 5597733082 [configuration/rules-dsl.md] Textual Rules -> Rule Name Uniqueness (#627)
* Textual Rules -> Rule Name Uniqueness

Add information on requirement for uniqueness of rule names.

Signed-off-by: Garry Mitchell garrymitchell@my105e.com (github: ConfusedTA)

* Textual Rules -> Rule Name Uniqueness

Amended per suggestions to include rule details as a list, tweak of wording, and amendment of sample rules to follow suggestion of wrapping quotes around rule names.

Signed-off-by: Garry Mitchell garrymitchell@my105e.com (github: ConfusedTA)

* Textual Rules -> Rule Name Uniqueness

Amend rule syntax, make syntax sections into a list.

Signed-off-by: Garry Mitchell garrymitchell@my105e.com (github: ConfusedTA)

* Textual Rules -> Rule Name Uniqueness

Updated based upon suggestions to further clarify points.

Signed-off-by: Garry Mitchell garrymitchell@my105e.com (github: ConfusedTA)

* Update rules-dsl.md
2018-01-16 17:14:06 +01:00
mod42 d2c3b160be [rules-dsl.md] Changed some typos in the createTimer sample code (#608) 2017-12-30 20:05:36 +01:00
Jason Jones 05b1e854c1 Added triggeringItem to Implicit Variables section
Signed-off-by: Jason Jones <jmsjones@gmail.com>
2017-12-30 14:23:21 +01:00
Jerome L d91a7e9c7c
[rulse-dsl.md]Added trigger channel section (#572)
* Added trigger channel section to rules-dsl.md

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

* Review based changes

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

* Adressed last Review comments

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
2017-11-22 18:34:22 +01:00
Eric Schiesser 825f967966 [Rules] Fix missing "val" in example (#531)
without sign-off. minor patch exception
2017-10-16 18:33:02 +02:00
kceiw a08044120d [Rules] Add chapters on thing status in actions and rules (#463)
The change of the code is at https://github.com/eclipse/smarthome/pull/3001
After this commit, the end user can find the documentation about how to react
to thing status change in the rule.

Bug: #517

Incorporate more pull request feedback.

Signed-off-by: Maoliang Huang <hellomao@outlook.com>
2017-09-26 12:08:50 +02:00
Markus Lipp 51a69535ad [Rules] Add section on type conversion, fixes #472 (#483)
* add section on type conversion

Addressing issue #472 and incorporating discussions from PR #469; work is based in contributions by @rkoshak https://community.openhab.org/t/type-conversions/32684
Fixed html anchors; changed text regarding example rules at the end to match new content

* added more webhooks, fixed URL

Added some more webhooks 
Fixed URL to use {{base}}

* more text clean-up

Tightening of text, adherence to one line per sentence rule, etc

* moved text, adjusted heading levels, added example

Moved proposed text to immediately after "Manipulating item states", adjusted header levels to match new location, added example to PointType using strings

* improved formatting, common structure, switch text

Added blank lines around code blocks, added text to Switch Item to make it stand-alone, improved common structure; deleted all examples of use of postUpdate and sendCommand as they are already dealt with in section above.

Signed-off-by: Markus Lipp lipp.markus@gmail.com (github: LightIsLife)
2017-09-24 22:58:34 +02:00
Thomas Dietrich 787295ff25 Add transformations section to rules-dsl (#513)
* Add transformations section to rules-dsl

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>

* Attend to comments, part 1

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

* Attend to comments, part 2

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

* Attend to comments, part 3

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-09-22 21:20:58 +02:00
Jerome L c51f07d584 [Editors] Small fixes (#485)
Like discussed in #434:

    Fixed/Improved the toc configuration for the Editors article
    Fixed broken ESH Designer urls in 3 pages

Signed-off-by:  Jerome Luckenbach <github@luckenba.ch> (github: @Confectrician)
2017-08-31 21:03:53 +02:00
Jerome L 0cd2cd15c0 [Configuration] Move Syntax Highlighting page from old wiki (#434)
* Moved Syntax Highlighting page from openhab1-addons wiki into user manual

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

* Cosmetic improvements according to the PR Discussion

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

* Some Improvements from the feedback of @ThomDietrich.
More to come.

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

* General:
Added some introduction sentences.
Updated Notepad++ "installation" section

Eclipse SmartHome Designer:
Moved ESH article from installation category to editors page.
Additionally removed the navigation menu entry and updated all references to other articles and moved used images in the now necessary folder.

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

* Improvement due to requested change
"First letter of a line capital pls"

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

* Requested Name and capital Letter changes.

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

* Updated mcedit section.
Signed-off-by:  Jerome Luckenbach <github@luckenba.ch> (github: @Confectrician)

* - Requested changes by ThomDietrich
- Additionally shortenend the "Others" Section

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

* Typo correction and intro text update to current headlines.

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

* - Defined headanchor explicitly
- Added designer.md file with a redirection to the new editors page.
- Removed some sentences of the introduction
- Changed the "Others" headline

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

* Add stable anchors

Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-08-27 12:56:55 +02:00
Markus Lipp e13c4885af [Rules DSL]Add sendCommand/postUpdate clarification, fixes #185 (#469)
* Adding description on using sendCommand/postUpdate

The use of sendCommand and postUpdate in rules is explained with an emphasis on discouraging the generic method sendCommand(Item,arg) over the method Item.sendCommand(arg) that provides much more reliable type conversions. Details as to the background have been added
Signed-off-by: lipp.markus@gmail.com (github: LightIsLife)

* Adding description on using sendCommand/postUpdate fixes #185 #469

Addressing comments by @rkoshak on commit 042dae745c
Signed-off-by: lipp.markus@gmail.com (github: LightIsLife)

* Updating language/editorial changes

Some editorial changes throughout, and added more consistency in the use of "" where new_state has to be a string (in actions) and no quotation marks where this is not mandated (in methods).
Signed-off-by: Markus Lipp <lipp.markus@gmail.com> (github: LightIsLife)

* Addressing comments made

Addressing all comments by @ThomDietrich: sentences are shortened and simplifies, heading capitalized and modified, text overall slightly shortened, etc

* fixed typo

just fixing a few typos

* made sentences shorter

Sentences shortened to address comments received

* one line per sentence reformatting

Adjustment as per style convention to each sentence begins on its own line

* Add some further clarification

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

* moved section to scripts, deleted details

Addressing comments by @thomdietrich. 
Moved the whole new section (Manipulating item states) into exisiting section "Scripts"
Deleted the paras under "Details"
2017-08-27 12:07:33 +02:00
Simon Kaufmann b061e1d043 [Rules] Add documentation of early returns (#457)
Signed-off-by: Simon Kaufmann <simon.kfm@googlemail.com>
2017-07-27 13:01:43 +02:00
Thomas Dietrich f18348d0f2 Correct linter warnings for configuration articles (#444)
* Correct linter warning ins config articles, part 1

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>

* Finish configuration linter corrections

Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2017-07-20 18:47:28 +02:00
bgilmer77 efb92a8934 [Rules] Add note on 'System started' trigger (#416)
* Add note on 'System started' trigger

The 'System started' trigger causes actions to execute when the system is started (i.e. a reboot).  But the trigger also fires when alterations are made to any rules files.  This could lead to unanticipated system behavior, since users may expect that the only time the trigger would fire is when the system initializes for the first time.

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

* Clarify description of system-based triggers

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

* Correct openHab to openHAB

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

* Modifed per comments by @ThomDietrich

Signed-off: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)
2017-07-06 17:39:52 +02:00
Thomas Dietrich a7fd22a985 [Rules] Add a better online generator
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
2017-04-13 14:38:17 +02:00
Thomas Dietrich 29b9ac1c7c Move articles, adapt menu
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
2016-12-14 19:05:17 +01:00