Trying to Develop a Sub-Plugin for PSU Control for openHAB3

tomatenjoghurt · September 7, 2021, 10:44am

Dear Experts,

I've been running octopi for quite a while now and I came to the point, that I wanted to integrate OctoPi with an Open Source Smart Home Hub called openHAB3.

The Idea seems pretty easy, as there is already a similiar Sub-Plugin for a similiar Smart Home Software: The PSUControl HomeAssistant Subplugin. Both offer a REST-based API to switch on or off hardware and with a little tweeking it should be easy to integrate openHAB3.

As this is my first try on Github and developing on OpenSource-Software on my own, please do not kill me if I did anything wrong.
I forked the existing Sub-Plugin and made some Code-Adjustments to it, so that it should be working with openHAB instead of HomeAssistant.

But somehow, I'm struggling with the configuration.

I'm able to install the plugin via the gitHub URL. But afterwards it is not possible to do any changes and safe them in the settings menu. The Save button is permanently "rotating". When uninstalling the plugin, Octoprint works fine again. Logs do not display anything helpful...

I've go the feeling that something's wrong inside my psucontrol_openhab3_settings.jinja2 - I'm thinking Octoprint does not even pickup the settings there. Interaction on the configuration page is ot working at all - can be checked when selecting an Authorization Method - in theory the displayed fields on the page should change, but they don't.

You can have a look at the code here:

Am I missing something out? Do you have an idea?
Is there anywhere any documentation I can read regarding this?

It's my first GitHub Project like that, so sorry if there is something wrong with the fork/release/readme page, whatever...
Any feedback would be greatly appreciated!

Thank you!

Charlie_Powell · September 7, 2021, 3:28pm

Have you been through the 'Developing plugins' section of the docs? There's also a plugin tutorial if you want to learn how it all fits together.

https://docs.octoprint.org/en/master/plugins/index.html

PSU control sub-plugins are exactly the same as other plugins, with a few specific hooks. I'll take a look at the code later to see what jumps out, I'm not at my laptop now to have a look.

kantlivelong · September 7, 2021, 6:09pm

Two things stand out:

authorizationMethod isn't defined on the py side

github.com

Tomatenjoghurt/OctoPrint-PSUControl-openHAB3/blob/7ace838222f2bc4ae113244a9f8c526605e90606/octoprint_psucontrol_openhab3/templates/psucontrol_openhab3_settings.jinja2#L22

    
      
          <div class="control-group">

              <label class="control-label">Address</label>

              <div class="controls">

                  <input type="text" class="input" data-bind="value: settings.plugins.psucontrol_openhab3.address">

                  <span class="help-block">The IP address or hostname of your openHAB3 server. e.g. http://ip:port or http://hostname:port. Do not include a trailing slash /</span>

              </div>

          </div>

          <div class="control-group">

              <label class="control-label">Authorization Method</label>

              <div class="controls">

                  <select data-bind="value: settings.plugins.psucontrol_openhab3.authorizationMethod">

                      <option value="TOKEN">Access Token</option>

                      <option value="BASIC">Username & Password (Basic Authorization)</option>

                  </select>

              </div>

          </div>

          <!-- ko if: settings.plugins.psucontrol_openhab3.authorizationMethod() === "TOKEN" -->

          <div class="control-group">

              <label class="control-label">Access Token</label>

              <div class="controls">

                  <input type="text" class="input" data-bind="value: settings.plugins.psucontrol_openhab3.api_key">

Pretty sure the variables inside the ko if need ()

github.com

Tomatenjoghurt/OctoPrint-PSUControl-openHAB3/blob/7ace838222f2bc4ae113244a9f8c526605e90606/octoprint_psucontrol_openhab3/templates/psucontrol_openhab3_settings.jinja2#L65-L70

    
      
          <!-- ko if: settings.plugins.psucontrol_openhab3.verify_certificate -->

          <span class="help-block">Verify TLS certificate and do not connect on certificate issues.</span>

          <!-- /ko -->

          <!-- ko ifnot: settings.plugins.psucontrol_openhab3.verify_certificate -->

          <span class="help-block">Do not verify TLS certificate.</span>

          <!-- /ko -->

tomatenjoghurt · September 7, 2021, 7:27pm

Thanks for pointing that out!
I released a version 1.0.1 containing your ideas - unfortunately, the problems stays the same - nothing changed.

First thing: thats because I added the authorizationMethod later and forgot about it...but now, I added it to the definition.

Second: funny thing: thats the only part I did not change from the fork
I added the brackets () after the variable, but nothing changed.
I'll have some spare time tomorrow, I'll look into the docs @Charlie_Powell linked.
Thank you guys!

tomatenjoghurt · September 8, 2021, 12:01pm

Dang it, there was a typo in the if clause for the authorizationMethod...fixed that and now the plugin seems to be loading.

Will test it and see if it works from a functional perspective now

kantlivelong · September 8, 2021, 1:05pm

Looked right past that

tomatenjoghurt · September 28, 2021, 2:57pm

Plugin has been merged and is available, thank you!