[Optional Components] ESPhome dashboard

[moodyblue]

Issue information:

Now that OH has an esphome binding it would be great that openhabian includes esphome dashboard

Description:

ESPhome dashboard allows one to manage ESP devices. It can be installed with pip3 install esphome and run with esphome dashboard <folder name>. Users can access it with http:\\openhabian:6052

[SeveranExp]

I’m using the docker container of esphome, so having it in openhabian would be great, since esphome provides access to a lot of sensors and others.

[ecdye]

This sounds like a great addition, I personally don't use this feature but I would be happy to review a pull request if one of you would be willing to implement it.

[moodyblue]

Install instructions are here https://esphome.io/guides/installing_esphome#linux

To run:

source venv/bin/activate
esphome dashboard <folder> &

This returns the pid to kill the process, if needed.

esphome can be updated using pip --upgrade

Pls note that I'm not a Linux expert.

[mstormi]

Please note we don't build stuff on people's request. We're just the maintainers, that means we coordinate development.
If you want the thing to happen, please implement and test it yourself and provide a PR here then we can review and eventually merge it.

[moodyblue]

Is there any documentation on how to do it ? One thing is to change the Z2M installation (I've eventually found the way to do it), another is to create a new option in openhabian-config, with all its consequences (update, start and kill the process, etc)

[mstormi]

No there isn't.
As one will have either a network coordinator OR a stick, it's both options. I'd think this should be the way to implement:
First you need to provide a routine that takes an option (to specify to install or remove/uninstall), and it needs to work in both modes, in interactive and in automated mode.
Next you should build a setup_z2m() function that likewise works in both modes that configures the z2m setup and lets you choose either network coordinator or local stick.
In menu, add install, remove and setup.
Check the code and menu on EVCC for a template (in packages.bash).

[moodyblue]

Actually my idea is slightly different. If there is a stick proceed as usual. If not, prompt the user for the ip:port address of the coordinator. The yaml is the same in both cases (stick or network), what changes is the port: clause.

1. In the case of stick port: /dev/serial/xxx (detected by the script)
2. In the case of network port: tcp://<ip address>:port (input by the user)

Incidently the SLZB-06 can also be discovered with port: mdns://slzb-06 if mDNS is active so the ability to edit configuration.yaml may be good.

What do you think ?

[mstormi]

From a coding perspective, you should first be building a setup routine that takes coordinator or stick as a parameter at runtime (plus 2ndary parameters) and configures your system for the specified version.
Your implementation should be reusing (not copy!) and replace the existing 'stick' code.

Then next you can call that routine from the menu with an explicit parameter or from a parameterless routine that does some sort of autodetection.

[moodyblue]

Something like this ?

[mstormi]

yes if internally made like written above

[moodyblue]

I'm planning to use miflora_setup as the base for esphome dashboard. Questions:

1. I've noticed that miflora_setup has no remove option. Can I do the same ?
2. Can I call the new function espdashboard_setup ?

[mstormi]

1. no, please.
   miflora stuff is ancient and does not meet the standard for new additions (such as that 'remove' should also be implemented right away)
2. any install+remove routine should not be called ..._setup, that's for setup routines, obviously.

[moodyblue]

I'll do my best. I'm not a developer, and like myflora the "esphome dashboard" uses python venv.

I've seen that all other routines are _setup, why do you say that I cannot use that suffix ? Implementing one parameter ("install" or "remove") should be no problem.

[mstormi]

like I said _setup should be for setup, i.e. configuring things, not for (un)install
and it's not all others.
Like I said use a recent addition such as evcc as your template .

[moodyblue]

I see. install_espdashboard with "install" and "remove" options ?

[miloit]

@moodyblue are you working on this or should I do my pull request?

[moodyblue]

@miloit I've implemented the z2m network part but I'm not working on esphome dashboard. pls proceed with your pull request

[miloit]

@ecdye is there any specific directory to install it or /opt/esphome_dashboard is ok?

[ecdye]

That would be fine. It doesn't matter a ton what exactly the directory name is, but something that is it the /opt directory and is named in a clear and consistent way should be fine.