User Management for OpenEMS UI Backend

thomas · November 17, 2023, 11:19am

Hello,

I am currently running OpenEMS Edge and Backend successfully with my ESS setup. I am running the OpenEMS UI attached to the backend and it is working successfully.

However, there is no user validation being enforced. You can log in without a username and password. We would like to make the UI available to customers over the internet, however of course the current configuration is highly insecure as there is absolutely no validation applied and a malicious user can easily cause damage to the customer’s equipment.

How can user management be implemented in OpenEMS Backend? Ideally we should be able to create and manage user accounts, require credentials to log in etc.

Thanks,
Thomas

miettal · November 19, 2023, 9:50am

Hi,

In OpenEMS, user management function is not provided directly.
instead of user management, OpenEMS is providing “Metadata” function.

This function is interface of authentication/authorization.
Now officially OpenEMS implemented FileMetadata(use static file) and OdooMetadata(OSS ERP user integration via web api) based on this interface.

Of course you can also implement it yourself. // io.openems.backend.metadata.{dummy, file, odoo} directory is implementation of ↑. you just write handler function.

I think official implementation is good material of learning metadata mecanism.

stefan.feilmeier · January 2, 2024, 2:36pm

Hi Thomas,

we use the Odoo connection in production and I can highly recommend it to anyone.

Odoo not only serves as a authentication provider and for Edge management, but also for persisting configuration, auditing etc. Also the OpenEMS App-Center is tightly integrated with Odoo, even though certain parts are unfortunately not yet published as open source.

You can use our Gitpod for a live Demo of the integration: Dashboard

Regards,
Stefan

acabrera · February 8, 2024, 3:50pm

I don’t mean to hijack this thread, Stefan, but since I am still unable to get the GitPod simulation working, can your provide some simple initial steps to get the Odoo user authentication working? I have created an account and database on Odoo and enabled the Metadata.Odoo service in my OpenEMS Backend but I am not quite clear on the process. I heard mention of the Odoo plugin for OpenEMS but it appears to be a work in progress. Any advice would be appreciated.

Sn0w3y · February 8, 2024, 4:34pm

Install this in Odoo…

acabrera · February 8, 2024, 4:51pm

Thanks Sn0w3y. Do you mean as an App in Odoo or something else? I do not currently have a self-hosted instance of Odoo. I just have an account with them and they are hosting it.

Sn0w3y · February 8, 2024, 5:06pm

yes, you need to self-host odoo16

acabrera · February 8, 2024, 5:15pm

Ah. That clears up a lot. Thanks, I will run with it…

thomas · February 8, 2024, 5:24pm

I previously attempted trying to use the Odoo Metadata provider but gave up and wrote my own metadata provider because I couldn’t get the Odoo one to work.

I would still like to try the Odoo provider because running my own one requires a certain amount of maintenance. Is there any installation instructions for the Odoo Addon?

Sn0w3y · February 8, 2024, 5:32pm

no, but it should not be too hard… just google installation instructions for odoo on for example linux ubuntu and so on

thomas · February 15, 2024, 9:27am

I have successfully installed the Odoo addon for OpenEMS in my Odoo 16 instance, and now the OpenEMS area is appearing within Odoo for me.

However, when I try to add a new device in Odoo, I immediately receive ‘RPC Error - Odoo Server Error’. Stacktrace below.

It appears that ‘rec.name’ is evaluating as a boolean instead of a string within the ‘_compute_monitoring_url()’ function.

Have you experienced this issue before or are you aware of any misconfigurations that could have caused it?

Traceback (most recent call last):
  File "/usr/lib/python3/dist-packages/odoo/api.py", line 996, in get
    cache_value = field_cache[record._ids[0]]
KeyError: <NewId 0x7fccefa95ab0>

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/usr/lib/python3/dist-packages/odoo/fields.py", line 1161, in __get__
    value = env.cache.get(record, self)
  File "/usr/lib/python3/dist-packages/odoo/api.py", line 1003, in get
    raise CacheMiss(record, field)
odoo.exceptions.CacheMiss: 'openems.device(<NewId 0x7fccefa95ab0>,).monitoring_url'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/usr/lib/python3/dist-packages/odoo/http.py", line 1633, in _serve_db
    return service_model.retrying(self._serve_ir_http, self.env)
  File "/usr/lib/python3/dist-packages/odoo/service/model.py", line 133, in retrying
    result = func()
  File "/usr/lib/python3/dist-packages/odoo/http.py", line 1660, in _serve_ir_http
    response = self.dispatcher.dispatch(rule.endpoint, args)
  File "/usr/lib/python3/dist-packages/odoo/http.py", line 1864, in dispatch
    result = self.request.registry['ir.http']._dispatch(endpoint)
  File "/usr/lib/python3/dist-packages/odoo/addons/base/models/ir_http.py", line 154, in _dispatch
    result = endpoint(**request.params)
  File "/usr/lib/python3/dist-packages/odoo/http.py", line 697, in route_wrapper
    result = endpoint(self, *args, **params_ok)
  File "/usr/lib/python3/dist-packages/odoo/addons/web/controllers/dataset.py", line 42, in call_kw
    return self._call_kw(model, method, args, kwargs)
  File "/usr/lib/python3/dist-packages/odoo/addons/web/controllers/dataset.py", line 33, in _call_kw
    return call_kw(request.env[model], method, args, kwargs)
  File "/usr/lib/python3/dist-packages/odoo/api.py", line 468, in call_kw
    result = _call_kw_multi(method, model, args, kwargs)
  File "/usr/lib/python3/dist-packages/odoo/api.py", line 453, in _call_kw_multi
    result = method(recs, *args, **kwargs)
  File "/usr/lib/python3/dist-packages/odoo/models.py", line 6587, in onchange
    snapshot1 = Snapshot(record, nametree)
  File "/usr/lib/python3/dist-packages/odoo/models.py", line 6347, in __init__
    self.fetch(name)
  File "/usr/lib/python3/dist-packages/odoo/models.py", line 6357, in fetch
    self[name] = record[name]
  File "/usr/lib/python3/dist-packages/odoo/models.py", line 5915, in __getitem__
    return self._fields[key].__get__(self, self.env.registry[self._name])
  File "/usr/lib/python3/dist-packages/odoo/fields.py", line 1210, in __get__
    self.compute_value(recs)
  File "/usr/lib/python3/dist-packages/odoo/fields.py", line 1392, in compute_value
    records._compute_field_value(self)
  File "/usr/lib/python3/dist-packages/odoo/addons/mail/models/mail_thread.py", line 403, in _compute_field_value
    return super()._compute_field_value(field)
  File "/usr/lib/python3/dist-packages/odoo/models.py", line 4232, in _compute_field_value
    fields.determine(field.compute, self)
  File "/usr/lib/python3/dist-packages/odoo/fields.py", line 98, in determine
    return needle(*args)
  File "/odoo/odoo-server/addons/openems/models/device.py", line 45, in _compute_monitoring_url
    rec.monitoring_url = url + rec.name
TypeError: can only concatenate str (not "bool") to str

The above server error caused the following client error:
null `

Sn0w3y · February 15, 2024, 12:28pm

Please see the Pull Requests for this Errror on GutHub

@sfeilmeier this was the error i was talking about in the PR

thomas · February 20, 2024, 10:35am

Hi @Sn0w3y,

Do you know of a workaround for this or a way of getting it working?

Thanks,
Thomas

JimsterCoder · February 21, 2024, 11:28pm

We would like to go ahead with the metadata implementation but I can’t find any instructions on how to proceed. Are there any?
Thanks.

stefan.feilmeier · February 23, 2024, 11:12pm

Sn0w3ys PR has been merged recently:

acabrera · March 12, 2024, 5:52pm

Were you able to get any further, @thomas? I have Odoo installed and I am able to authenticate users and even add an edge device such as “edge0”. But, the websocket queries never return an edge device when I log in as a user through the OpenEMS UI. I get this error:

{"jsonrpc":"2.0","id":"1de80263-0ed7-4beb-8dde-b7e193447ea0","error":{"code":1,"message":"Unable to find edge with id [edge0]","data":["Unable to find edge with id [edge0]"]}}

I am so close but I an unsure how there are no edge devices returning even though the users are definitely associated with one in Odoo.

A.Elhadioui · November 15, 2024, 7:17am

I encountered the same problem when running Odoo with Docker Compose, whereas it works perfectly when I run it directly from PyCharm. If anyone has resolved this issue or can share best practices for setting up Odoo to work with the OpenEMS backend, I would greatly appreciate it

Sn0w3y · November 15, 2024, 9:13am

Hello,

if you want to use OpenEMS Commercially i recommend you to join the OpenEMS Association

Greetings