* 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)
* Improve introductory paragraph
This is a test.
DO NOT approve this PR.
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Clarify Item/real world interaction
This is a second test. I am still learning about GitHub/GitHub Desktop interaction. The purpose of the test is to check the behavior of GitHub when making multiple commits on a single branch.
I have modified the language to clarify the interaction between Items and the real world through bindings. While the existing language was okay, I hope this submission provides additional clarity around the fact that Item states can be set by actions in the real world
* Improve readability of Introduction section
Changed wording in the Introduction section to improve readability and comprehension.
* Correct spelling error and clarify Item/real world interaction
Edited introduction to correct spelling error and clarify Item/real-world interaction.
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Item Definition and Syntax: improve readability
Some wording in the Item Definition and Syntax section has been changed to improve readability.
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)
* Type: improve readability
Some wording in the Type section has been changed to improve readability
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)
* Name: improve readability
Some wording in the Name section has been changed, and the section has been reorganized to improve comprehension.
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)
* Name: Tweak group naming suggestions
Based upon comment from @ThomDetrich, tweak the first scheme for group names.
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)
* Label: improve readability
Changed text in the Label section to improve readability and comprehension
* State: improve readability
Made changes to improve readability and comprehension.
* Icons: improve readability
The Icons section has been modified to improve readability and comprehension.
* Group: improve readability
Changes have been made in wording and arrangement to improve readability and comprehension.
* Tags: improve readability
Changes have been made in wording and arrangement to improve readability and comprehension.
* Binding: improve readability
Changes have been made in wording and arrangement to improve readability and comprehension.
* Binding Configuration: improve readability
Changes have been made in wording and arrangement to improve readability and comprehension.
Not sure whether all this 1.x information needs to remain.
Removed information on persistence. Will look to see if it should be added to other PR on STATE #507.
This complete the nit pass through the items.md file
* Correct linter formatting issues
This commit corrects formatting issues revealed by linter.
* Add some last minute changes
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* Discuss distinction between command and status
- End-users may assume that the change in state of a Switch Item reflects the actual state of the Thing.
- Added section to make clear the difference between command and status
- May seem obvious, but some implementers could get burned by not thinking this through.
* Add second batch of corrections
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* Correct typo
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* 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)
* Fix syntax error and editors change
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Fix typo
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* Added Marketplace link.\n Corrected image alt tag.\nImproved installation section to marketplace install.\nAdded section about rule validation with a link to the vscode repo readme file.
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
* Added list item 0 in the installation instructions
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
* Correct list marker
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* Additional improvements to sitemaps.md
- Addresses most of @ThomDietrich comments in #528
- See #528 for open items and questions
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Address numerous comments in #528
- This commit addresses all but one of @ThomDietrich comments from #528
Signed-off-by:Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Address remaining comments from @ThomDietrich in #542
- Verified that Slider Items and Setpoint Items do NOT work with Switch Things. Removed text hinting that this was possible.
- Added back text about visibility working with OR conditions but not with AND conditions
* Remove example from Label and Value Colors section
- Deleted example and graphic from Label and Value example. The explanations and the graphic did not match, and contained errors.
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Correct error in link in Dynamic Sitemaps section
- Corrected syntax error in "dynamic icon" link
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Correct link syntax in Dynamic Sitemaps section
- Corrected link syntax (again)
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)
* Additional improvements to persistence article
Addressing comments left over from #527
- Changed that -> than
- Resolved clashing headlines
- Strategies section: added `default` and explained its operation
- Changed persistence extensions from code block to itemized list
* Improve readability of Strategies and Items sections
- Reworded some of tne introductory material
- Reorganized and changed some sub-section titles in Strategies and Items area to improve comprehension.
- Item Persistence Configuration -> Persistence Configuration
- Added Persistence Trigers section
- Strategies section -> Strategies
- Items section -> Items
- Addressed comments by @Confectrician
* Address numerous comments from @ThomDietrich
- Deleted one configuration headline
- Added intro sentence to configuration section
- Combined all text about default in one section of the document
- corrected cronexpression angle bracket error
- added code fence around everyChange, etc.
- Removed detail of Quartz stuff and just added a pointer to Rules article
- Replaced "persist everything" example to persisting Heating_Mode, etc..."
- Added example of how default works.
* Finishes "nit" pass through Persistence article
- Numerous small changes to improve readability
* Expand explanation of how one may specify persistence for an Item
- Existing text was not clear about the syntax one would use with a Persistence Extension in order to specify a persistence store in cases where multiple stores are available.
- Clarified language and added an example.
* Correct formating of Persistence Extensions
- Removed extra lines
- Added code fences
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Format Persistence Extensions as a table
- Changed Persistence Extensions section from a non-enumerated list to a table
- Fixed a spelling error in the section on restoring items after a restart
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Fix markdown table style
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* Updated mismatching Screenshots for the kitchen temperature Item
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
* Added MapView Sitemap element (includes update of the demo sitemap comment)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
* Corrected demo sitemap comment for kichen temperature too.
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
* Changes due to Review from @ThomDietrich.
Generalized Screenshot dimesnions.
Added link to the OSM page.
Corrected Mapview spelling.
Moved Mapview section to another position based on the popularity.
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
* Sitemaps: improve comprehension
- made changes to improve comprehension in introduction
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Concepts: improve readability
- A few minor word changes are recommended
- Some slight changes to punctuation
* Special Element Sitemap: improve comprehension
- Eliminated redundant statement about sitemapname and filename
- Introduced the term "shall", which indicates that no other choice except the one described is acceptable
* Element Types: improve comprehension
- numerous changes to wording to improve comprehension
- Addressed PR #523 regarding HLS video element
* Mappings: improve comprehension
- some changes to improve reader comprehension
* Mapping: Add reference to Items/command-vs-status
- Removed text in mapping article that mentions command vs. status
- Added command vs. status to my PR on items.md
- Added reference to the items.md section in this document.
This way we have only one place where this point is discussed.
* Color: improve comprehension
- various changes to increase comprehension
* Address comments received
- "Renders an Item as a ON/OFF..." changed to "Renders an Item as an ON/OFF..."
- "Renders an Item in as text changed to "Renders an Item as text".
- Capitalize Item in two occurances
- Remove term, "However..."
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Update persistence.md
- updates persistence.md by adding content from old wiki article
- removes references to old wiki article
- addresses #524
* Address comments from @ThomDietrich
- See GitHub Conversation page for comments addressed.
* Capitalize all instances of "Item"
- Capitalized all instances of "Item"
- Did NOT capitalize all instances of "items"
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github:bgilmer77)
* Add Section on Item State; fixes#507
Propose to add a section on Item State to the documentation on Items to address #507.
Adding an Item state diagram would be very useful.
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Make additions visible in GitHub "View" mode
Strange - adding the TODO line caused the text below to not be visible on GitHub. Removing it.
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Correct text formatting so that each sentence is on one line
The Item State section has been reformatted so that each sentence is on its own line.
This seems to be the norm for line formatting.
Inserted a TODO regarding generating a state diagram.
* Remove TODO note
The TODO note about adding a state diagram has been removed - it seems to cause the entire new Item State section to disappear - at least in GitHub 'View' mode.
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Correct links to other relevant articles
Links were incorrect. This commit resolves the problem.
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
* Incorporate "Restoring State" info at end of items.md into this section
I removed the text at the end of the items.md file related to restoring state.
Incorporated them into this new section.
* Address comments from @ThomDietrich (first round)
All comments received from @ThomDietrich's first round have been addressed.
Ran linter and reformatted list items.
* Remove section on restoring states
The section on restoring states has been removed - it repeats information which is available elsewhere in the documentation.
* Address comments from Thom dated 8-OCT
- removed backticks that were used incorrectly.
- added links to Persistence and system-based-trigger articles
- removed trailing periods from list items
-
Signed-off-by: Brad Gilmer <brad@gilmer.tv> (github: bgilmer77)
fixes misconfigured links to "Linux article" and "openHABian" in "Networks preparation" chapter
Simple fix exception: Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
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>
* Add Linux/MacOSX backup and restore instructions
Signed-off-by: Ben Clark <ben@benjyc.uk>
* Change to absolute path references
Signed-off-by: Ben Clark <ben@benjyc.uk>
* 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)
* 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>
* Rename collection folders
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Change all occurences of addons and repos
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Add further corrections
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Remove temporary directories after processing
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Reduce addons menus, show current uncond.
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Fix typo
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Remove redundant addons from permalinks
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Sort UI menu entries correctly
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Split maven command
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
Closes#200
* initial edits
Added detail to iOS app page, including feature list, screenshots, and
brief setup instructions
* Initial edits
Reference issue 200, added feature list, screenshots, and getting
started instructions.
* Updates per review
Fixed some grammar and formatting issues, provided more accurate
description of app’s remote capabilities, and fixed image width display.
Signed-off-by: Tom Nerison captomner@gmail.com (github: dome2048)
* Add a few corrections
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* describe REST API
describe the value of the REST API and showcase the possibilities; replacing entire current content;
Signed-off-by: Markus Lipp lipp.markus@gmail.com (github: LightIsLife)
* addressing review comments
Addressing all review comments:
- changed generic ip
- adapted opening sentence
- linked to OH2 security chapter
- re-added comment on push-service
various editorial edits
Signed-off-by: Markus Lipp lipp.markus@gmail.com (github: LightIsLife)
* typos and grammar fixes from review
Fixed typos and grammar mistakes; added sentence that all curl and other commands are displayed in REST API as a response to "Try me out"
Signed-off-by: Markus Lipp lipp.markus@gmail.com (github: LightIsLife)
* more typo, style and grammar fixes
Missed some typos, re-arranged a few sentences for better flow; fixed punctuation (hopefully)
* intro more concise; review comments addressed
Signed-off-by: Markus Lipp lipp.markus@gmail.com (github: LightIsLife)
* Add general usage description to Transformations
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* Update transformations.md
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* Update transformations.md
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* Add content to transform config article
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Add naming recommendations to items article
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* Follow up on comments, improve article parts
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Address further comments
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Unify example item names, add details
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Add last fixes
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Add Item types to article
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Add tagging intro and example
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Add tagging syntax example
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Rearrange and improve Dynamic Icons chapter
Signed-off-by: Thomas Dietrich <thomas.dietrich@tu-ilmenau.de> (github: ThomDietrich)
* Transform general Item syntax into list
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
* Final comments and further additions
Signed-off-by: Thomas Dietrich <Thomas.Dietrich@tu-ilmenau.de>
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)
bgilmer77
Jerome L
Thomas Dietrich
Kai Kreuzer
Christian Häussler
Eric Schiesser
Holger Reichert
sihui
kceiw
Ben Clark
Markus Lipp
dome2048
mueller-ma