This repository contains the documentation for openHAB.
Home Page: https://www.openhab.org/docs/
License: Other
This repository contains add-ons that are using openHAB 1.x APIs. Earlier branches of this repo also contain the 1.x runtime and designer, which are no longer maintained.
Note that all information about openHAB itself, the IDE setup and the contribution processes can be found in the openhab-distro project, so please go there for any further details!
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
The recent change in eclipse-archived/smarthome#2300 means that we can keep to defaults with openHAB in regards to proxy_buffering (on). This is usually used to free up backend servers in case of slow client connections.
I think the defaults for buffer sizes should be fine for most openHAB users, so this should be a simple case of removing the proxy_buffering line. But I want to test some options before putting in a PR and thought I'd make an issue in case I forget to do this.
See https://community.openhab.org/t/custom-dynamic-icons-for-number-items-when-mapped/16894/10
Unlike OH 1, OH 2 uses the label's transformed state when picking the icons, not the Item's original state.
For some context see:
https://community.openhab.org/t/problems-with-items-things-in-habmin-paperui/14777
There are many threads on the forum of users struggling with the use of PaperUI. The problems stem from the following:
These all lead users down a path toward frustration and confusion as they run into limitations of PaperUI.
Ultimately I would suggest using Habmin as the default admin UI instead of PaperUI, but that is an issue for a different repo. But I would like to propose an article or paragraphs in the beginners tutorials and migration tutorials to warn users about these limitations and head off some of this confusion.
I'm currently in the process of writing a new general installation overview article and updating the Raspberry Pi article.
If anyone wants to contribute or has first feedback, don't hesitate! ;)
What/Why/When/How?
https://community.openhab.org/t/astro-binding-issue/2011/43
H1..H3 receive styling from style.css
H4 does not and is thereby bigger and darker.
needs to be fixed in ESH and OH2 docs
linked to #62
Reference to television icon wrong.
https://github.com/openhab/openhab-docs/blob/gh-pages/addons/iconsets/classic/readme.md
This is a task for whoever wants to contribute and is looking for a starting point:
New updated articles for openHAB 2 are written here, while the old articles in the wiki are still valid for openHAB 1.8. The problem is, that a user searching for a topic in the forum or via google may end up in the 2.0-vise outdated wiki article.
That's why, we need to add an information (highlighted, ...) at the beginning of each wiki article, informing users about the openHAB 2 article over at docs.openHAB.org.
Example: https://github.com/openhab/openhab/wiki/Astro-binding --> http://docs.openhab.org/addons/bindings/astro/readme.html
Add the following description to "Advanced Functionality", wherever fitting.
https://community.openhab.org/t/addons-cfg-proper-way-to-discover-the-name-of-an-addon/17107/3
Continuing #56
Would it be better to have the whole eclise smarthome docs as a submodule (to make realtions clear to everyone) and to work with symlinks (if jekyll and friends like that)? Without symlink an idea would be to have an sh script (like you have now) copying files with an additional step, marking them as copied. An added YAML front matter "page.source" in the head of the file would be a nice approach I guess.
And to answer your question, yes I think so, we should copy as much as possible but add openhab specific things on top. A styles2.css loaded after style.css could be a place for everything orange and openhab'y.
to work with symlinks (if jekyll and friends like that)?
I think this won't work, at least I wasn't very successful when I experimented with such a solution.
What we will indeed need sooner or later is a better manageable copy mechanism, doing it in the pom.xml as it is now will definitely become too complex at some point in time.
I think we should copy as much as possible
Feel free to adapt the copy mechanism accordingly.
Will have to find the time for that.
See: openhab/openhab-distro#318
TODO:
The existing "Migration from openHAB 1 to openHAB 2" has a lot of important information about what will be different between OH 1.x and OH 2 but it really isn't a tutorial. there are no step by step instructions. I'm going to start the migration process myself and will use my experiences to beef up these instructions.
Hello busy bees,
the sitemaps article is almost done. I've created pull request #54 to merge the article in it's first version. I would like to point out a few open questions:
There should be a pronunciation information on the starting page of docs.
Maybe an easier solution would be nice ;)
Adding openhab to dialout is quite important to many bindings and should thereby be mentioned in the installation article
In a recent build something changed and the "hack" to set one of your sitemaps as the default that comes up by naming it _default.sitemap no longer works. The Migration Tutorial needs to be updated to remove that suggestion.
This should be replaced with instructions for how to set the default sitemap using runtime.cfg.
Hi,
Here is a small mistake I think.
Instead of:
yahooweather:weather:berlin [ location="638242" ]
should be:
yahooweather:weather:berlin [ location=638242 ]
Somewhere below Add-ons I've mentioned Extensions. After openhab/openhab-distro#352 that should be corrected/updated. This would also be a good time to update screenshots.
Firtst paragraph wrongly formatted: http://docs.openhab.org/addons/bindings/netatmo/readme.html
Yes, this needs to be fixed over at openhab-distro or smarthome.
Better fix while working on #50
On http://docs.openhab.org/administration/console.html the instructions say:
If openHAB runs a service, the console can be accessed using ssh to the openHAB host on port 8101. The default Username/Password is openhab/habopen.
However, the provided output of the command shows the user having logged in as user karaf.
ssh karaf@localhost -p 8101
This should be
ssh openhab@localhost -p 8101
I'd fix it myself but I don't yet know how to have more than one pull request at a time.
I intend on using Draw.io so we can keep the source with the project. I believe that is what was used to create the existing architectural drawings already in docs.
Discussion on the forum is here:
https://community.openhab.org/t/lets-talk-about-oh-2-drawings/13096
This is a placeholder for the work on the items.md article. If you are willing to work on this task, please leave a message.
It seems, that the details and functionality of dynamic icons is still pretty unclear. Should receive it's own article, possibly next to the iconsets article.
My latest change works up until the third sub-directory for example: http://docs.openhab.org/one/two/three
It looks like the header and footer isn't applying base.html as intended and I'm not entirely sure of the reasoning behind the process. Why is {{base}} used all over in the first place? Surely a working <script src="{{base}}/js/jquery.min.js"></script> is the same as <script src="/js/jquery.min.js"></script> etc. which sets the initial level?
What is the necessity to calculate {{base}} by breaking down the target url?
Tried getting the IDE setup for the first time, and it appears Eclipse Neon has been released, and this is breaking the Oomph install process.
May want to add a clarification note to IDE setup step 3, indicating Product Version Mars needs to be selected. It is in the screen shot, but I just took the default which is now "Neon". Once I went back and select Mars everything worked as expected.
Image of selection attached.
I was going to edit and make a Pull request, but it was saying I didn't have push rights.
I believe that the documentation for the nginx reverse proxy is misconfigured: I believe that proxy_buffering by default should be disabled, since the server will try to wait for the full message recieved from event source objects such as //rest/events?topics=smarthome/items/*/state.
proxy_buffering off;
Secondly, the server at that configuration will not forward https links in REST unless the following is specified:
proxy_set_header X-Forwarded-Proto $scheme;
In the documentation "X-Forwarded-Scheme" is set but I don't think this is a valid header. I will send a pull request for the above but wanted to bring it as an issue in case I've missed any reasoning behind this.
Finally, would it be worth it to make a full tutorial on using an nginx reverse proxy with openhab, which includes setup, basic authentication and ssh encryption/renewal?
Since you asked...
I realize the tutorial is a work in progress and the vast amount of work required, kudos to everyone on OpenHAB. These comments are non-critical feedback in response to your feedback request.
I'm a pretty solid target audience for this tutorial and the suggested System Info binding looks like a great starting place...I sure can't figure out how to get it to do anything.
I'm someone who helps others with their tech, always have been. I'm not a software developer or professional tech. No prior experience with OpenHAB. A few steps ahead of a complete noob as far as Linus, terminal/shell stuff, navigating, etc. Very green but slightly familiar with Github, building complex apps. Old school.
I suggest an entirely step-by-step approach to this tutorial, no 'overview' except a paragraph or two with links to conceptual stuff, then go right into a numbered list of steps. Possibly forked by platform as needed.
The User Interfaces page, as an example, isn't helpful to the beginner tutorial. Tell the noob what to do, don't give theory or choices. Terms like Channels, Things, Bindings, Extensions, Rules, etc. are only going to be understood with exposure and something simple that ACTUALLY WORKS to build upon. Looking at something that is actually running is essential.
Version 2 vs. 1 should be mentioned ONCE for clarity, then version 1 should never be mentioned again. Tutorial should state that it written for newcomers with no OpenHAB experience of any kind.
It should be assumed that beginners have NO exposure to Github or the nuts and bolts of setting up anything beyond user-level Windows or Mac. If this is too low a bar for you, EXACTLY what the assumptions of a beginner's technical experience should be stated at the beginning. Since you cannot possibly know what level of expertise a beginner has, you have to spell it out. It may well be that a particular beginner has 8 out of 10 of your expectations - if you spell it out exactly, and provide a link to sources that will let a beginner fill in a gap before proceeding (in my case, Github was only slightly familiar and I struggled.
I expect a LOT of otherwise tech-savvy but non-Linux types with new RPis are a big part of your potential user base. Plenty of smart and savvy folks to whom a terminal window and shell will be either entirely new or weak areas.
If I can be of any assistance in creating a tutorial, as a noob who's not entirely unfamiliar with the broad technologies, please let me know.
Background :
Have spent maybe 6 hours reviewing openhab website and github info,( just glanced at code). Ignored 1.X. Installed openHAB demo (2.0) on Mac, got Mosquitto up and running in two terminal windows. Demo didn't clarify what to do next.
So I grabbed old RPi, used OpenHABian to create a card image, worked great, MUCH easier than the first go round. (The hardest thing was finding the github link to download the OpenHABian file - noob!) So now I have a bare system running headless...the goal of this beginner tutorial sounds perfect for me. But I'm still looking at blank screens and mostly empty config files.
Good luck with your project!
Tim
When accessing the docs website through https://docs.openhab.org instead of http://docs.openhab.org, the browser (Safari for iOS, Firefox for Mac) shows a message that the website cannot be trusted. This is due to the fact that the site is using the Github certificate instead of one from openHAB.org.
Migrated from: https://community.openhab.org/t/starters-guides-not-directly-related-to-openhab-2/11348/1
svilenvul wrote:
In the company, that I work for (MusalaSoft), I have prepared some basic guides in form of wiki pages about OSGi, Equinox, p2 and Tycho for newcomers, that are going to work with Eclipse SmartHome and openHAB in order to help them with the first steps.
We would like to share them with the open source community. But I could find the best place, as they are not directly related to openHAB.
I will try to give a short overview, what we have:
- OSGi introduction page
- overview of OSGi Declarative Service specification
- OSGi coding tasks
- Tycho and dependency resolution process
- what is p2, Installable Units, update-site
- info about some basic Equinox commands and core bundles
The articles contain a lot of links to external resources.
@kaikreuzer, please advise us, how we can proceed further.
kaikreuzer wrote:
All the topics you suggest are relevant for developers and not that much for users, right?
So in general, I think the Developer Guide is a good place for this - it anyhow is currently still pretty empty 😉We could introduce a new main menu entry (something like "Prerequisites") with entries for OSGi, Tycho, p2 etc. Feel free to suggest a suitable menu structure, but I definitely do not mind to have such things also part of the documentation (although not directly related to openHAB).
Cheers,
Kai
Feel free to join the discussion.
There should be a page for each of the Add-Ons types under Add-Ons. Missing types are
As a user I would expect to see a one-to-one mapping between that section and the tabs listed in PaperUI. As it is right now I have no idea where I would look to find the README contents for the XPATH transform or the InfluxDB Persistence.
To resume #48
I saw, that materialize is used for styling. So despite what I suggested in the other discussion, it would make more sense to rely on materialize to handle pics? http://materializecss.com/media-css.html
<img class="responsive-img"...>The effect is more or less the same:
img.responsive-img {max-width: 100%; height: auto;}I have no experience with jekyll, would be great if somebody could quickly provide the needed change.
There are occasional problems from markdown documents to a correct presentation on http://docs.openhab.org. Examples eclipse-archived/smarthome#1873 and https://github.com/openhab/openhab2-addons/pull/1159. From a general standpoint, it would be good to have some Markdown Style Guides for docs in place.
I would suggest including a Markdown linter into the build process, possibly even as Pull Request validator. Options:
I would like to contribute to the testing documentation.
I think it might be difficult for new binding developers to set up and run integration test in openHAB (Eclipse SmartHome too)
Currently we have Testing Eclipse SmartHome. It is a good staring point, but I would like to go with a different approach - something more like "HelloTest" bundle for beginners. I would like to make a step-by-step developer guide:
I think this can be added to ''Developers -> Basics -> Write a simple test'' page for example.
Please, let me know what do you think about this idea.
Hello I think it would be a good idea to add implementations to the OSGI Coding tasks in http://docs.openhab.org/developers/prerequisites/osgitasks.html because it will be very beneficial for the beginners to see sample code with the tasks. I would like to implement them.
I want to align where will be the most appropriate place to store them. I would suggest to create a new repository named "openhab-osgi-samples"
I believe it would be best if there is a different PR for every task.
Awaiting your response
With the current need to rewrite and restructure docs articles, it could be handy to know which links need to be changed.
http://www.deadlinkchecker.com/website-dead-link-checker.asp?u0=http://docs.openhab.org
Is it reasonable and feasible to simple replace the contents of installation/Docker.md with the README.md on the Docker's GitHub repo? Or maybe we should just point there? Or we could even just change the link for the Docker instructions to go directly to the Docker Hub site.
I started to add the docker pull instructions to the documents and realized that the entire page is basically lifted from the README.md anyway. In the interest of only having this documented once...
Plugins can not be used on GitHub Pages.
One option: http://digitaldrummerj.me/blogging-on-github-part-7-adding-a-custom-google-search/
If you open a non existing page like http://docs.openhab.org/somepage/ a 404 page with GitHub branding is shown. This should be replaced with a OH branded one.
The example uses port 8011 instead of the default 8080. For clarity and consistency the documentation should always use the same.
I was sad to learn, that syntax highlighting in the freshly created sitemap article is not working. Other than on github in preview, GitHub pages + Jekyll does not seem to support the xtend syntax. https://jekyllrb.com/docs/templates/#code-snippet-highlighting
Why not use Java? Because there can always be misinterpretations...
visibility=[Battery_Level<30]
visibility=[TV_Power==ON]
visibility=[Day_Time=="Morning", Day_Time=="Afternoon", Temperature>19]As you can see, one small < will f up everything.
To get xtend we would need pygments https://haisum.github.io/2014/11/07/jekyll-pygments-supported-highlighters
Any ideas?
I would like to add a short page about how to configure the logger during development:
I will appreciate any comments. Do you think this page will be helpful? Where will be the right place to add it - maybe in the "Basics" tab?
I decided to continue with openHAB for my automation plans, but I struggle with the basic installations.
I develop JSF applications with Eclipse but the Designer ( on Eclipse ) will not work.
I downloaded multiple versions 0.7 and 0.8
I have another Eclipse Installation on my Mac for JSF development. May be this is the problem.
I was able to install the Smarthome Eclipse Development, but even this has many errors and I can not solve them with a project cleanup.
MACOS Sierra 10.12.1
I run on SE Runtime Environment (build 1.8.0_66-b17)
Can somebody please help!!
Thanks
could you please provide an analytic step-by-step guide for installing and configuring my.opnehab addon on raspberry pi 3.
Thank you in advance,
Tasos
Update the Linux installation instructions to save the apt- repos to /etc/apt/sources.list.d/openhab2.list instead of openhab.list. This will prevent overriding openhab.list for those who are migrating from OH 1 and used the apt-get install or confusing apt with left over OH 1 openhab.list.distUpgrade files.
In work by @joergkling
1.2 Tutorial (Beginner)
1.2.1 Overview
1.2.2 User interfaces
1.2.3 Installing an Extension
1.2.4 Working with Extension
1.2.5 Working with rules and script
1.2.6 Looking at the Logs
With one exception, documented in wiki:
openhab/openhab1-addons#4917
https://github.com/openhab/openhab/wiki/CalDAV#note-for-openhab-2
The link "How to contribute" leads to a 404: http://docs.openhab.org/CONTRIBUTING.md
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.