devices-app

Desktop App

This app demonstrates the GUI supported pairing process using the eebus-go library. It consists of a server component written in Go and a web implemented using VueJS 3.

Once this app is paired with another service (could also be the same service running on a different port), it will show the SPINE data with details about supported usecases and features. The goal is to also present this information in a more user friendly way in the future.

Another goal is to provide an executable for every supported platform that contains everything required.

The service requires a certificate and a key which will be created automatically and saved in the working folder if file names are not provided or the default filenames are not found.

First steps

• Download and install golang for your computer
• Download and install NodeJS and NPM if you do not already have it
• Download the source code of this repository
• Run npm install inside the root repository folder
• Now follow either the Development or Build binary steps

Development

Running the server component

• make ui for creating the UI assets
• go run main.go -h to see all the possible parameters.
• go run main.go to start with the default parameters.

Running the web frontend

npx vite dev to start with the default parameters using vite.config.js. The web service is now accessible at http://localhost:7051/

Build binary

• make ui for creating the UI assets
• make build for building the binary for the local system
• execute the binary with ./devices-app
• Open the website in a browser at http://localhost:7050/

Usage

General Usage:
  devices-app <httpd-port> <eebus-port> <crtfile> <keyfile> <serial>
    <httpd-port> Optional port for the HTTPD server
    <eebus-port> Optional port for the EEBUS service
    <crt-file>   Optional filepath for the cert file
    <key-file>   Option filepath for the key file
    <serial>     Option mDNS serial string

Default values:
  httpd-port: 7050
  eebus-port: 4815
  crt-file:   cert.crt (same folder as executable)
  key-file:   cert.key (same folder as executable)
  serial:     123456789

If no cert-file or key-file parameters are provided and
the files do not exist, they will be created automatically.