janlahmann / qoffee-maker

Qoffee-Maker

User Instructions

Find user instructions on the project GitHub pages: http://qoffee-maker.org

Installation

As an example, we will install the Qoffee Maker Graphical User Interface (GUI) to be accessed under https://localhost:8887. It is also possible to choose another URL that you want to access the GUI from.

Prerequisites

• Home Connect enabled coffee machine
• Android Phone or iPhone
• Computer
• Email address you will use to register with Home Connect

Install Home Connect

1. Install the Home Connect iOS App or Android App

2. In the App Connect mobile app, you need to sign in with a Home Connect User Account.

After starting the app, the welcome screen will show the option to log in to the app or register a new user.

If you have not used the "Home Connect" app before follow these steps on how to create an account:

• Click on the Register link as shown in the picture below.

• Use your email address to register new user. Provide a new password as requested on the form:

• Then, press "Continue" link on the top-right corner.

• Read "Terms and Condition" rules, and accept it by checking "I have read and accept the terms of use" checkbox, then press "Continue" button.

• Once again, read "Data protection statement" and accept it by checking "I have read and accept the data protection statement" checkbox. Press "Continue" button to proceed.

• Read the statements regarding collecting user data and accept it by clicking "I consent to the collection of mu user data" checkbox. Press "Continue" button to finish procedure.

• Review the provided information and click "Send" button.

• Now, you have to activate the registered account. To confirm the account you must click the link in the activation email that you will receive in your mailbox.

• Now, you confirm your email address, your account will be activated and you can log in to the Home Connect app using your newly registered user.

3. Add your Coffee Machine appliance to the Home Connect App

You can connect your Coffee Machine under Appliances in the App.

4. Sign up for a Home Connect Developer Account

Make sure to set your Default Home Connect User Account for Testing to the Home Connect User Account (mail address) used in the previous step.

Hint: It is not crucial to provide meaningful Additional Information.

5. Register a new Home Connect Appliance

Set an Application ID of your choice. Using localhost, the Redirect URI is set to http://localhost:8887/auth/callback. Keep the default settings for the remaining boxes and create the appliance.

Install the Qoffee Maker GUI

Install the Qoffee Maker GUI in three steps:

1. Create a .env file with the following variables:

   • HOMECONNECT_API_URL: https://api.home-connect.com/ (Home Connect API) or https://simulator.home-connect.com/ (simulator API)
   • HOMECONNECT_CLIENT_ID: Client ID of the Home Connect Appliance
   • HOMECONNECT_CLIENT_SECRET: Client Secret of the Home Connect Appliance
   • HOMECONNECT_REDIRECT_URL: Callback URL for HomeConnect as registered in your application in HomeConnect. On localhost this is http://localhost:8887/auth/callback (the port is determined by Jupyter, /auth/callback is fixed)
   • DEVICE_HA_ID: This is the HomeConnect Appliance ID (HA ID) of your coffee machine. It is useful when you have multiple coffee machines registered in your Home Connect App. Leave it blank if you don't want to set it/don't know about it.
     • To get the HA IDs of your available machines start the QoffeeMaker, authenticate and then, type http://{YOUR_IP_ADRESS}:8887/machines into your browser. You will get an response with all your appliances and HA IDs.
   • IBMQ_API_KEY: the API Key for IBM Quantum

2. Run the container image with the specified environment variables: docker run --name qoffee --rm -itp 8887:8887 --env-file .env ghcr.io/janlahmann/qoffee-maker

3. Now you can start using the Qoffee Maker GUI under http://localhost:8887 (the login token is shown in the StdOut of the docker container). After logging in to Jupyter, you have to select qoffee.ipynb and then you have to click the rocket icon to Activate App Mode.

Enjoy your Quantum Coffee. ☕️

Installation on RasQberry (draft):

Installation and startup of Qoffee-Maker has been fully integrated to the RasQberry automated setup. (Currently in branch "dev8", but will be merged to master soon.)

In rasqberry-config (started with $ . ./RasQ-init.sh dev9), use the following menu items in "D Quantum Demos" to run the locally build docker image or the image available on dockerhub: "QM Qoffee-Maker", "QMd Qoffee-Maker".

To trigger a rebuild, choose "A Advanced Config" -> "QMrb Qoffee-Maker rebuild".

To stop all qoffee containers, select "A Advanced Config" -> "QMst stop Qoffee-Maker".

The two versions of the demo can also be started using the "Qoffee Maker" desktop icons.

qoffee-maker's Issues

Feature: Link to websites

In der Diskussion wäre es hilfreich, wenn wir möglichst einfach auf folgende URLs zugreifen können. Kann man die aus der Hauptseite der Demo verlinken? (Full-Screen mode müssen wir dabei berücksichtigen bzw beenden)
http://qoffee-maker.org/
http://quantum-computing.ibm.com/

Ideen:

• Falls ihr den full-screen beenden wollt wenn eine der anderen URLs aufgerufen wird: Sowas haben wir auch bei einer anderen Demo gemacht. @nico hatte dazu einen PR gemacht in dem anderen Projekt: https://github.com/JanLahmann/rasqberry-grok-bloch/pull/1/files (geht aber sicher auch anders)
• iFrame

Add GUI for choosing correct coffee machine (from /machines endpoint)

With the new DEVICE_HA_ID support, there should be a GUI to choose the correct coffee machine. This is easier than using the http://{YOUR_IP_ADRESS}:8887/machines endpoint and copying the HA ID to the .env file.

A first implementation could be to add a clickable button in the existing UI to open http://{YOUR_IP_ADDRESS}:8887/machines endpoint.

New builds (local and GitHub actions) don't work correctly, as of 2023/08.

Build completes without errors (local and GitHub actions).
Desktop icons work correctly.
Chrome starts, coffee notebook can be selected.
App mode can be started, but then UI gets frozen.

build on ARM fails with "npm ERR! cb() never called!"

Sometimes, but not always, the build on Arm (e.g. Raspberry Pi) fails with

Step 3/25 : RUN cd appwidgets &&     npm install yarn &&     yarn build:prod
 ---> Running in e23951c6eacc
npm WARN read-shrinkwrap This version of npm is compatible with lockfileVersion@1, but package-lock.json was generated for lockfileVersion@2. I'll try to do my best with it!

npm ERR! cb() never called!

npm ERR! This is an error with npm itself. Please report this error at:
npm ERR!     <https://npm.community/>

npm ERR! A complete log of this run can be found in:
npm ERR!     /root/.npm/_logs/2022-03-30T13_35_23_129Z-debug.log
The command '/bin/sh -c cd appwidgets &&     npm install yarn &&     yarn build:prod' returned a non-zero code: 1

Fix: Fehlermeldung, wenn man noch nicht authentifiziert deskriptiv

Wenn man auf GET beverages klickt, aber noch nicht authentifiziert ist:
Deskriptiver Fehler und nicht "Internal Server Error"

Remove +, c3

+, c3 können weg links bei den qubits

Bug: arm64 Version not running on M1 Macbook

Display numerical value for mock device probabilities

Grüne probabilities für mock device könnte man auch als Zahlen zeigen, nicht nur als Balken.

Qubit representation vertical vs horizontal

Die drei Qubits sind oben senkrecht angeordnet, beim histogramm aber horizontal (000, 001, ...). Das umdenken ist eigentlich einfach, fällt aber vielen schwer.

Fix: Nur Basis-Gates anzeigen

Wir brauchen nur die ersten 5 Gates. Kann man die restlichen ausblenden?

Feature: CI/CD cross-compile Dockerfiles automatically

Ideas:

• use Github actions

Remove Ry, Z in simple version

Z, Ry können in der einfachen Version weg und nur bei allen Gates mit rein.

Remove i, ...

Rechts oben das i und die drei Punkte haben keine Funktion und können weg