How to figure out how to do something in openHAB 3

The docs are never going to match what the code can do and what is in the SNAPSHOTS or in the milestones. Especially if there are new features. You are running with Alpha and Beta level software at that point. The SNAPSHOTS are not even ALPHA. They are literally everything that was merged into the baseline yesterday.

If you want the docs to match, you have to use the releases, not the testing versions.

Have you filed an issue? Have you created a PR to mention this in the docs?

Again, nothing I’ve said applies to newbys. None of it. Not one word. I don’t expect newbes to know this stuff. I do expect them to supply them when asked for them.

And adding logging to a rule doesn’t required any reconfiguration of the loggers config. It’s only if someone might have a bug or misconfiguration on a binding that someone here might ask that user to enable debug or trace logging. No one expects any user, let alone a new user to know to do that or to know how to do that. It’s unreasonable. But if you are an intermediate user who has been using OH for awhile, you should know that logs will be required.

You may not know what the error means but any user can figure out what line of code an error occurs on just by adding logs. Sometimes that’s enough to solve the problem. If not, it certainly will help us solve the problem.

I do not set the bar that high. If you are a newbe, I expect the docs to at least have been consulted and a search of the forum made. That’s it. I don’t expect you to understand what you’ve read. I don’t expect you to know to do anything that I put in the OP above. Newbes get a complete and total pass (until such time that information requests is not given, replies are not ready thoroughly, or there is a refusal to try anything themselves when asked). I’m fine with coddling new users. This stuff is hard even for programmers and technically inclined people.

But if you’ve been using OH for awhile, you should know at least that logs are needed. Most of the time the default settings for the logs generate everything we need to know. I don’t require you to know how to reconfigure the loggers or anything like that. But at least post the logs when asking the question. Especially post logs when asked. I require you to have spent at least a minimum amount of time trying out a few things on your own. I expect you to have a look at the docs. Tried a few experiments. Maybe bothered to look at the actual states of the relevant Items (I can’t count how many problems I’ve helped experienced users with that ended up being because their Items are NULL in the past couple of months).

Frankly, I just don’t have a lot of sympathy for users who can’t manage to find a log file on the file system. If that’s too hard I can’t imagine that user will ever be successful with home automation.

And a final word on the docs. There are far too few contributing to them. Even so, to the best of our knowledge, when OH 3 was released, every word of them were still relevant to OH 3 or were rewritten for OH 3. I can’t speak to the Add-ons docs as those are wholly written by and updated by the maintainers of the individual bindings. But the core docs that are there are all applicable, as written, to OH 3. But docs have bugs and are missing features too. If you find something wrong or missing in the docs, and you are an intermediate to experienced user, file an issue! Even better, make the fix!

1 Like

I did ultimately get the issue tracked down and there is a bug report for that. However, you make a good point - I had no clue I could create a PR to mention it in the documentation. I’ll see if I can figure that out.

At the bottom of every page in the docs there is a link:

Caught a mistake or want to contribute to the documentation? Edit this page on GitHub(opens new window)

Note, that’s the SNMP binding’s readme which I just happened to have open.

There is also:

1 Like

Fact is, there’s a single sentence that turns us into the most helpful people you’ll ever find.

“I searched the community and the docs, and couldn’t find an answer.”

All I want to know is that someone put in an effort. It is legitimately hard to do keyword searches, and completely reasonable that someone might not be able to find the information they need when terminology differs. I’m always happy to point them in the right direction if I can connect the dots. I just don’t want to do their work for them.

6 Likes

Please don’t give up this status!

Reading posts on this forum I can not only second your finding (correct English?) about a changing attitude in the posted questions, I also “sensed” that this change had an effect on you.
Although I’m not putting into the forum as much you do I understand you’re reasoning.
If it would have been me writing the OP the

would be the writing of that post and the following ones.
I do hope writing these posts are actually having this effect on you, if not PLEASE take your time off the forum and come back.

BTW:
Is it only my used browser not showing your profile picture with the bowler hat or did you remove that on purpose?

I noticed this too. Can’t see the photo on Firefox on by Ubuntu PC, but shows up fine on my Android phone browser. Only Rich’s avatar is affected!!

Without searching

Sounds like you could use a holiday. I feel your frustrations and I have learned an enormous amount of things from reading your responses to other peoples questions without even posting the question.

#METOO

You are part of the solution keep up the good work. You will likely not interact with lots of people due to your detailed posts.

Oh come on you are better than this and we all know it.

Some of you may have noticed that lately I answered some post with a single question. Its due to the poster not putting any effort in a all.

2 Likes

Hmm, it’s still showing up for me. I didn’t change anything. I’ll be mostly off the forum starting Wednesday for a week. Heading to the mountains for some birthday celebrations (mine is today, my son’s is Saturday). I’ll look into the avatar issue. Other users avatars disappeared awhile back.

Though I did have a user/contributer call me something like “an idiot in a stupid hat” once. If that didn’t cause me to remove it, nothing will. :grin:

It wasn’t an idle threat or anything like that. I’m very sensitive to the ethics of being a moderator. It is an important responsibility and there are lots of chances for conflict of interest. If my posting and my behavior ever rises to the level where there is a conflict of interest, I’ll gladly give up the moderator status. The last thing I want is to have users think there’s a double standard and moderators don’t have to follow the rules.

In this case, because I’m so active on the forum, others not being able to block me could be considered such a conflict.

2 Likes

@rlkoshak , hip hip, move on. And happy birthday !

1 Like

Happy birthday, Rich!

FYI, I noticed your avatar disappear and then reappear and then disappear again, so something’s up with it.

Off topic - my little dalek disappeared (from my point of view) a few days ago. I just harrumphed and re-uploaded the image, been consistent for me since.

2 Likes

Not gonna lie…I originally thought your dalek was a cheese grater, and it wasn’t until I clicked on your avatar that I realized the truth. I’m admittedly not a big Dr. Who fan, but I still felt a little silly for not questioning the cheese grater.

I understand the frustration of answering the same question over and over again. I still consider myself closer to a newbie than to most people that posted in this thread. I have a different opinion, which could be wrong, of course.

The first challenge a newbie has, after installing OH, is “how do I connect my devices ?”. The first impact with the OH jargon (things, items, bindings, rules, persistence, etc) is frightening. All that a newbie wants is the first place is to switch devices on and off, and having to understand such jargon takes its time. The OH3 semantic model is a great idea, but I have my doubts that a newbie should start from there.

To make things worse, to control some devices MQTT is required, hence a new and “horrifying” world.

Right, the docs explain it all, but who has the time to read them all ? It would be easier if discovery could do this initial job, but this is not perfect (in my case it never discovered all devices). Maybe a “first steps” document would be welcome. And then “grouping instructions” to start building a model.

After having all required things and items, probably the next step is rules. For simple rules OH3 is a major improvement, but for complex ones this forum is / should be the source for examples. Unfortunately it is “polluted” with examples from OH1 and OH2 that no longer work in OH3.

When I read the OH documentation it looks to me as “how it works” and not really “how it should be used”. OH3 improved this a lot, but is not yet perfect. Maybe a “sample model”, and how it was built, could improve this.

2 Likes

To reiterate what Rich and I both said earlier, this thread is not about new users. It’s about any users who don’t put in an effort before asking for help. Sorry for the boldface, but that message isn’t coming across to people arriving late to this conversation.

No one’s asking users to read all of the documentation. I haven’t read all of the documentation, and I never will. But when I’m trying to solve something, the first thing I do is to search the community and the docs. This is a reasonable expectation of anyone who comes asking for help.

That would be https://demo.openhab.org.

Per Rich’s earlier post, we welcome and encourage you to contribute edits to any docs that you believe can be improved. Every time someone criticizes the docs, some of us take the time to point this out to them. Unfortunately, very few people actually follow through. Some just don’t have the time, which is understandable, but in many cases they just want to complain. That helps no one.

Your opinion isn’t wrong. We just need more people to go from having opinions to taking action based on those opinions.

3 Likes

Have you seen and read the Getting Started Tutorial? If you have comments or recommendations we’d welcome them. Even better are contrabutions. It’s not done but four new pages were just added to it this week.

But ultimately home automation is a development activity. Development involves dealing with abstract concepts and knowing how to use reference documentation. These are skills that can be learned. But they cannot be eliminated. At least not without also eliminating capability. And it’s the capability and power of OH which is why most of us are here.

The Getting Started Tutorial is intended to address your concerns. But it will not replace the reference docs.

3 Likes

Of course

I accept the repto, but I need to team with someone else to review.

2 Likes

Awesome. When you submit your edits, they’ll be reviewed by maintainers who will review and provide feedback. The markdown is similar to what’s used in the community, and the only thing I found confusing was properly signing off on my pull request (it’s not hard, I just didn’t get it at first).

1 Like

This is an early draft of what I have in mind. Will this be ok ? openHAB Primer.pdf (43.0 KB)

Great start
Thanks for willingness to pitch in! :+1:
head on over to the documentation section on github, bump around a little bit, get to know the contributors (Jerome is in charge and he is super helpful and appreciative of any help) and see where your document will fit in and maybe make a pull request

1 Like

I’m not sure your document will work as written, particularly as some of that content already exists. So, I’d personally rather see the insights you’ve expressed get incorporated into existing sections. For example, I think your thoughts on MQTT belong in the MQTT binding documentation as a very quick disclaimer that we don’t recommend learning MQTT at the same time as openHAB.

We’re off topic for this thread, so I’d follow @Andrew_Rowe’s advice and start chatting in GitHub about where things might fit in. :wink:

1 Like