Getting Started with OH3: rewriting the tutorial - 1. Introduction

Is there a guide on how to setup model with the file based approach? So far it seems that the model can only be edited through the WebUI or by directly modifying the JSON DB files.

Most all the model pieces appear to be Groups. I would try making one or 2 & use API Explorer to determine what might work in files. I think the new parts are all tags anyway.

See here, there are examples of models built with textual configuration, you just have to tag them properly:

1 Like

Reviewing the available OH3 docs I came across this and seems #6, #7 and #8 are still missing or was it just me to miss them ? There’s a #9 though.
Added one or two missing links to the table of contents.

1 Like

I just have to draft them, probably in the coming days…

1 Like

#6 is here.

I was referring to #6,7,8 of the list in post #1
OH cloud, persistence and an overall summary, these are.

1 Like

Hmmm OK.
Perhaps a section is missing from post 1.

EDIT:

I made a pass at making the wording sound more like an introduction and less like a plan of what we plan to write. I updated links where they were missing and marked sections that are not yet written as [TBD].

I propose moving persistence before Pages so that when we discuss pages we can assume they have persistence set up when we talk about Chart pages and the analyze buttons and such. I didn’t want to do that unilaterally though.

Let me know if I missed a link anywhere.

I’m also going to add forward/back links to the bottom of each page so it’s easier to read them like they will be in the docs.

Added a few sentences to use the code tab and post the YAML when asking for help on the forum.

I’ve started with following the docs and building my OH3 server for learning and testing it a bit before really diving in all the way.
This section is clear, only one question. In the section File-based vs UI-driven configuration first the file based is mentioned.
When I have no clue to choose (especially new users), I would pick the first one. But likely the best option for a new user would be the UI based option.
Or is it just me with that strange behavior? :slight_smile:

We present the pros and the cons for both approaches. we then state that this good l guide isn’t going to present the text based approach (I. e. the user will have to look at the docs on their own). That seems pretty clear to me.

The text based configs are acknowledged so those users who are drawn to then can choose that approach. But those users will have to do so without the benefit of this tutorial. Only developers (who can figure it out from the reference docs without too much trouble) and existing OH 2 users (who already know how to use text based configs) are likely to go down that path.

We won’t code for you though. All we can do is present the pros and cons, which we’ve done. But if you have any suggestions for edits, the post is a wiki so have at it. It’s a group effort.

A practical note from an absolute beginner: It would be useful linking the active page of the installation procedure when mentioned in

This tutorial assumes users have read the concepts and installation guide already

It would be also useful to explain, besides the installation procedure, the one to make a complete uninstallation. Migrating from a tentative installation from 2 to 3, I’d like to be sure I get a full rollback to a clean state. Currently uninstalling OH2 service and deleting the openHAB2 folder - not sure if that’s a rough approach leaving some zombie stuff around- would be nice having a page just saying doing that works fine :blush:

tagging @rlkoshak

1 Like

That’s easy. Just Read your Mail Really Fast (aka rm -rf /).
But seriously: No. This isn’t relevant for people to start with OH3 in the first place, and out of scope of this tutorial for those who don’t.
Common sense applies: make a system level backup and restore to get back there.

Well, sorry you think it’s useless. It just followed yesterday’s conversation with rloshak where I volunteered to review the doc as an absolute beginner and we agreed it was best done on 3 instead of 2.
not sure about your

rm -rf /

Really obscure for me. Is it a witty remark or is it something which can help? is it a command line command? not clear for an absolute beginner.

so you suggest I should use a restore point and restore the whole windows environment to do that? Doesn’t sound handy. I have been installing a bunch of apps to start openHAB, it would take a lot of work to roll back and reinstall everything again to get to a clen state from an app of about a couple of hundred megabytes. Uninstalling the whole Visual Studio suite would be way easier, in comparison.
In practice, here you go: I have been trying the last 3 hours.
and the most I have reched so far is this error log at the openhab prompt.

openhab> org.apache.felix.resolver.reason.ReasonException: Unable to resolve root: missing requirement [root] osgi.identity; osgi.identity=openhab-runtime-base; type=karaf.feature; version=“[3.0.0.RC1,3.0.0.RC1]”; filter:=“(&(osgi.identity=openhab-runtime-base)(type=karaf.feature)(version>=3.0.0.RC1)(version<=3.0.0.RC1))” [caused by: Unable to resolve openhab-runtime-base/3.0.0.RC1: missing requirement [openhab-runtime-base/3.0.0.RC1] osgi.identity; osgi.identity=openhab-core-io-rest-sitemap; type=karaf.feature [caused by: Unable to resolve openhab-core-io-rest-sitemap/3.0.0.RC1: missing requirement [openhab-core-io-rest-sitemap/3.0.0.RC1] osgi.identity; osgi.identity=org.openhab.core.io.rest.sitemap; type=osgi.bundle; version=“[3.0.0.RC1,3.0.0.RC1]”; r

and some other tons of error lines. Let’s see how far I can go.
Please don’t say in forum that new users do not want to spend time to contribute to improve documentation. I’m running the second day in trying to set up a working environment and maybe I will soon discover that trying to install 3 is not a good idea at all.

If you installed it on Windows (as your last comment indicates), I think this still applies to OH3: How do I uninstall OpenHAB2 from a Windows 10 PC

1 Like

thank you very much. Still wonder why is so hard to add a web page formalizing that and link it to the introduction. Baffling for me.

Java is cross platform and there are many installation methods and many OS/Platforms. Each combination would have a slightly different method for uninstallation. For instance, the commane mentioned earlier would not work on Windows.

exactly. That’s why I thought that a mention in the windows intallation page - like a header sayng “How to uninstall” ad a couple of bullet point would help. Better than absolute nothing. Just my opinion though.

I looked back at your first post here on this topic. Windows was not mentioned. The majority of developers & user have a UNIX-like OS like MacOS or Linux. That was the assumption without an OS mentioned.

you are correct. The fact is that every user assumes its system is the default. I did not think that the default of OH is Linux either.
In my view, purpose of documentation is helping people to get rid of assumptions to find solution.
Reading the documentation I just read obviously the page pertaining my OS and I did not understand that this introduction is meant only for Linux (is it?) -
I believe that the “curator” of any specific OS could easily add that piece of info, if relevant. Should be a piece of cake. You explain how to install, and how to uninstall. Comes together, usually. Especially when you don’t have an uninstall utility and you have no clue how settings work with java and the like.

Take my case for instance. I don’t know linux, I got Raspberry where, in the future, I’d like to run stuff including OH. But feels natural trying to understand OH on a OS like Windows I can easily navigate, first. Then, I will face Linux for Raspberry. It makes sense to me. And here I am.

1 Like