Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a SoC module for Nissan Leaf till MY 2019 #1682

Open
wants to merge 12 commits into
base: master
Choose a base branch
from

Conversation

mekrapp
Copy link
Contributor

@mekrapp mekrapp commented Jun 19, 2024

Folder "leaf" added to folder "packages/modules/vehicles".
Empty module init.py added into folder leaf.
Based on examples from other cars within packages/modules/vehicles the module config.py was created and added.
Based on examples from other cars the module soc.py was created and added.
The function fetch_soc() within soc.py was derived from snaptec/openWB/blob/master/modules/soc_leaf/soc.py (V1.9)
The modules pycarwings2.py and responses.py have been taken over from snaptec/openWB/blob/master/modules/soc_leaf/ (V1.9)

I have already tested successfully the function fetch_soc() within soc.py together with pycarwings2.py and responses.py in combination with my Leaf MY2018 and a Windows PC.
The module config.py and the other parts within soc.py besides fetch-soc()) were not tested so far.
So the whole leaf package needs still to be tested in an openWB V2 environment.

Copy link
Contributor

@LKuemmel LKuemmel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hast du eine openWB mit software2 und einen Leaf zum testen? Dann kann ich deinen PR in einen Feature-Branch mergen, dann kannst du über das UI ein Update darauf machen.

packages/modules/vehicles/leaf/soc.py Outdated Show resolved Hide resolved
Comment on lines +1 to +13
# Copyright 2016 Jason Horne
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Es ist leider nicht möglich einen Teil der Software unter eine Lizenz zu stellen. pycarwings2 kann aber auch über pip installiert werden. Dazu in requirements.txt pycarwings2==2.14 ergänzen. Dann wird das Paket beim Starten installiert.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pycarwings2 ist in V1.9 wie in meinem soc-draft eingebunden. Siehe hier:
https://github.com/snaptec/openWB/blob/master/modules/soc_leaf/pycarwings2.py
Wenn es in V1.9 genutzt wird, dann muss dafür ja früher mal ein OK eingeholt worden sein. Oder?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wenn ich auf die Zusammenfassung https://de.wikipedia.org/wiki/Apache-Lizenz#Eigenschaften schaue, dann sehe ich auch kein Problem, pycarwings2 weiterhin zu nutzen.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ja, in 1.9 ist das so gewesen. In software2 verfolgen wir eine anderen Linie. Hier wird die komplette Software unter eine Lizenz gestellt.
Bitte probiere, pycarwings über pip zu installieren. Vielleicht hat sich damit auch gleich das Crypto.Cipher-Problem gelöst.
Die imports musst du dann wieder auf import pycarwings2 ändern.
In der requirements.txt pycarwings2==2.14 hinzufügen und dann mit sudo systemctl restart openwb2.service den Sercvice neu starten. Dann wird das Package installiert. Das siehst du dann auch im main.log.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Die Apache Lizenz ist nach meinem Verständnis ein Copy-Left und kein Copyright. Der beschriebene Lizenz-Umweg mag für Testzwecke gehen und für einige Nutzer von V2 ein möglicher Workaround sein. Das ist aber keine allgemeine Lösung für OpenWB V2 Nutzer mit einem älteren Leaf oder NV200. Mit dem vorgeschlagenen Workaround sind viele überfordert. Wie müsste eine Lösung aussehen, die man mit einem normalen Softwareupdate aufspielen kann?

Das Crypto.Cipher-Problem überschaue ich noch nicht. In der V1.9 ist Crypto.Cypher anscheinend noch enthalten. Sonst würde pycarwings2 dort ja nicht laufen.
Ich musste auf meinem PC mit Python 3.12 zusätzlich Pycryptodome mit "pip install pycryptodome" installieren, um Crypto.Cipher verfügbar zu haben. Inwieweit Crypto.Cipher bereits/noch auf der OpenWB mit V2 verfügbar ist, kann ich nicht sagen. Bitte prüfen.

Copy link
Contributor

@LKuemmel LKuemmel Jul 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was für ein Workaround? Die requirements.txt ist der Standardweg, um nach einem Softwareupdate fehlende Python-Packages zu installieren. Der Endbenutzer muss dafür gar nichts tun.

pycryptodome ist nicht vorhanden. Aber ist das überhaupt erforderlich, wenn man pycarwings über den Paketmanager installiert?

EDIT: In der Alpha wurde es mit bimmer-connected installiert.

openwb@openwb-2:~ $ pip show pycryptodome
Name: pycryptodome
Version: 3.20.0
Summary: Cryptographic library for Python
Home-page: https://www.pycryptodome.org
Author: Helder Eijs
Author-email: helderijs@gmail.com
License: BSD, Public Domain
Location: /home/openwb/.local/lib/python3.9/site-packages
Requires:
Required-by: bimmer-connected

@mekrapp
Copy link
Contributor Author

mekrapp commented Jun 21, 2024

Hast du eine openWB mit software2 und einen Leaf zum testen? Dann kann ich deinen PR in einen Feature-Branch mergen, dann kannst du über das UI ein Update darauf machen.

Ich habe eine OpenWB Series 2+, jedoch noch mit V1.9.304N, weil es bislang noch kein SoC-Modul für meinen Leaf gab. Ich müsste also erst auf V2.0 umsteigen. Ich denke darüber nach und melde mich nochmals.

@ddraeyer
Copy link

Ich kann wieder helfen. Ich habe einen NISSAN Leaf 2.ZERO Edition (2018), einen RasPi mit openWB 1.9.275 und einen Test-RasPi mit openWB 2.14.

Ich werde mir die Files runterladen und in meiner openWB2 testen.

Bitte beachtet auch meine Thread https://forum.openwb.de/viewtopic.php?p=110908&hilit=myvehicle#p110908. Diese Aufgabe muss nämlich auch noch gelöst werden. Aber jetzt zuerst Schritt für Schritt. Ich hätte es übrigens in eine paar Tagen auch versucht mit der Zufügung von pycarwings2.py im vehicle-Folder. Das war also auch meine Idee. Ich war einfach nicht so schnell wie mekrapp.

@ddraeyer
Copy link

Hast du eine openWB mit software2 und einen Leaf zum testen? Dann kann ich deinen PR in einen Feature-Branch mergen, dann kannst du über das UI ein Update darauf machen.

Der Code ist auf dem RasPI mit openWB2 2.14 noch nicht lauffähig. In main.log war erkennbar, dass das SoC-Modul nicht geladen wurde. Ich musste in zwei Files
import pycarwings2
ersetzen durch
from modules.vehicles.leaf import pycarwings2

Jetzt werden jedoch in der main.log andere Fehler geworfen, die darauf deuten, dass ungültige oder unvollständige Methoden aufgerufen werden.

Es geht also nicht ohne Beschaffung eines RasPi für die Entwicklung und fürs Debuggen. Ich weiss nicht, ob openWB2 auch in einer VM auf dem Intel-PC lauffähig ist (Raspberry Pi Desktop for PC or Mac).

Hier noch Know How für den Entwicklungs-RasPi:

  1. User openwb mit einem Passwort ausstatten,
  2. Es ist hilfreich /var/www/html/openWB/modules/soc_leaf aus openWB 1.9 einzukopieren und manuell zu testen, ob
    sudo python2 /var/www/html/openWB/packages/modules/soc_leaf/soc.py <my_username> <my_password> 1 fehlerfrei durchläuft (die Zeile mit dem leeren User-Agent ist hier erforderlich).
    Vorgängig muss python2 installiert werden:
    sudo apt-get install python2
    sudo python2 get-pip.py
    sudo pip2 install requests
    pycarwings2.py ruft die Methode Crypto.Cipher auf. Das muss zuerst installiert werden:
    sudo pip2 uninstall crypto
    sudo pip2 uninstall pycrypto
    sudo pip2 install pycryptodome

Python3 kennt pycryptodome bereits.
Der Test wirft Fehler:
openwb@openWB:/var/www/html/openWB/packages/modules/vehicles/leaf $ sudo python3 soc.py <my_user> <my_password> 1
Traceback (most recent call last):
File "/var/www/html/openWB/packages/modules/vehicles/leaf/soc.py", line 7, in
from helpermodules.cli import run_using_positional_cli_args
ModuleNotFoundError: No module named 'helpermodules'

@mekrapp
Copy link
Contributor Author

mekrapp commented Jun 21, 2024

Zuerst einmal Danke an ddraeyer.

Bei dem Import war ich mir nicht sicher, ob es reicht, pycarwings2 einfach aus dem gleichen Ordner wie soc.py mit "import pycarwings2" zu laden. Über die Ordnerstruktur läuft es also. Auch gut. Das ändere ich ab. (ich hatte sogar schon einmal eine Version damit)

Bei dem geworfenen Fehler bin ich etwas verwundert, weil z.B. in BMW soc.py und in KIA soc.Py der gleiche Import
"from helpermodules.cli import run_using_positional_cli_args" steht. die Zeile habe ich 1:1 übernommen..
So wie ich die Fehlermeldung verstehe, findet er den Pfad "helpermodules" nicht.
Probiere bitte mal
from packages.helpermodules.cli import run_using_positional_cli_args

Wenn man in den Ordner helpermodules.cli schaut, dann gibt es dort ein py Modul "_run_using_positional_cli_args.py", also mit einem vorangestellten Unterstrich.
Vielleicht braucht man den Unterstrich auch im import-Befehl.

Außerdem gibt es weder den Import Befehl noch die Zeilen
def main(argv: List[str]):
run_using_positional_cli_args(leaf_update, argv)
im SoC Mustermodul auf https://github.com/openWB/core/blob/master/docs/samples/sample_vehicle/soc.py

Letztlich geht es hier darum, wie die ganzen Module zum User und Passwort für den Login in den Nissan Server kommen.

@mekrapp
Copy link
Contributor Author

mekrapp commented Jun 21, 2024

pycryptodome musste ich meinem Python 3 auf dem PC auch erst hinzufügen. Ohne das Paket gibt es kein Crypto.Cipher

mekrapp and others added 2 commits June 22, 2024 11:10
Co-authored-by: LKuemmel <76958050+LKuemmel@users.noreply.github.com>
Ich habe Anzahl der Wartezyklen noch von 3 auf 9 erhöht, also insgesamt 3 Minuten Wartezeit. Bis dahin müsste der Nissan Server den Leaf in jedem Fall erreicht haben. Falls nicht, kehrt requestSoc() nach drei Minuten ohne Update des SoC auf dem Server zurück und das anschließende readSoc holt sich dann halt nur den alten SoC vom Server. In der Zeit haben die Funktionen von pycarwings2 und responses auch genug Zeit für Einträge ins Logging für eine evtl. notwendige Fehleranalyse.
@mekrapp
Copy link
Contributor Author

mekrapp commented Jun 22, 2024

Im Einstellungsbereich war ich bislang noch nicht und es gibt dort bislang auch kein vehicle.vue für den Leaf. Ich vermute mal, dass das erforderlich ist, um das komplette SoC-Package für den Leaf in einer OpenWB 2.14 Umgebung testen zu können. Ich hatte mich eh schon gefragt, wie das ganze SoC Package an die User-ID und das Passwort für den Nissan Server kommt.
@ddraeyer bist Du bitte so nett und legst ein vehicle.vue für den Leaf an. Da hast Du ggü. mir einen Wissensvorsprung.

@ddraeyer
Copy link

Im Einstellungsbereich war ich bislang noch nicht und es gibt dort bislang auch kein vehicle.vue für den Leaf. Ich vermute mal, dass das erforderlich ist, um das komplette SoC-Package für den Leaf in einer OpenWB 2.14 Umgebung testen zu können. Ich hatte mich eh schon gefragt, wie das ganze SoC Package an die User-ID und das Passwort für den Nissan Server kommt. @ddraeyer bist Du bitte so nett und legst ein vehicle.vue für den Leaf an. Da hast Du ggü. mir einen Wissensvorsprung.

Nein, zum Testen ist es noch nicht erforderlich. Unter Konfiguration | Fahrzeuge findet sich dann unter Leaf bei 'Einstellungen für SoC-Modul "Leaf"' eine rudimentäre XML-Struktur:
{
"user_id": null,
"password": null
}

Dort kann man seine Nissan-User-ID und sein zugehöriges Pw eintippen und speichern.

Prüfen kann man das vom Windows-PC aus, wenn man darauf MQTT Explorer installiert hat. Damit kann man sich den Mosquito von openWB2 anschnallen und in die Topics gucken.

Ich werde folglich erst zu einem späteren Zeitpunkt helfen, das ganz am Schluss noch erforderliche "beautifying" fürs GUI beizusteuern.

Den Namen "Leaf" sollten wir noch diskutieren. Bei meinen Experimenten nannte ich das vehicule "Nissan". Begründung: pycarwings2.py unterstützt nicht nur den Nissan Leaf sondern auch den NV200. Wie es mit dem Nissan Ariya steht, entzieht sich meiner Kenntnis. Aufs neutrale "Nissan" kam ich, weil ich mich an "Renault" orientierte. Im Forum gibt es eine Liste für die von openWB2 unterstützte Renault-Modelle. Mir schwebt vor, es für Nissan gleichartig zu handhaben.

Und für den Fall, dass der Ariya eine andere Bibliothek als pycarwings2 benötigen sollte, kannt dann diejenige Person, welche die Erweiterung an die Hand nimmt, einfach im GUI noch einen Parameter zufügen à la
{
"user_id": null,
"password": null,
"library": null
}

@ddraeyer
Copy link

Ich habe heute auf dem Windows-PC die Virtualisierungssoftware Oracle VirtualBox installiert. Darin kreierte ich eine VM mit "Raspberry Pi Desktop for PC and Mac" (x86, 32-bit). Ich schaffte es leider auf keine Art, die Dependency cryptography zu installieren. Die Installation von openWB2 lief nicht fehlerfrei durch. Es konnte kein Wheel für cryptography gebildet werden. Es wird angemeckert, dass das erforderliche rust 1.63.0 nicht installiert werden kann. Für i686 gibt es max. 1.48.0.

Fürs Testen führt somit kein Weg daran vorbei, einen RasPi >= 3B zu beschaffen.

Mit MQTT Explorer können ebenfalls Fehlermeldungen erkannt werden.

image

@MartinRinas
Copy link
Contributor

MartinRinas commented Jun 22, 2024

Für die Entwicklung kann man relativ gut eine debian12 (oder 11? Kann ich nochmal nachschauen) VM nutzen, die kommt dem Raspberry Pi Recht nahe. Nutze ich selbst auch.

Wobei gerade für die Validierung von Bibliotheken und Abhängigkeiten ein Raspberry Pi notwendig ist. Bin da selbst mal reingelaufen.

@mekrapp
Copy link
Contributor Author

mekrapp commented Jun 23, 2024

Ich würde auch erst einmal direkt auf dem Pi mit OpenWB2.14 weiterprobieren.
@ddraeyer konntest Du das Problem mit den helpermodules schon lösen?
Da klemmte es ja wohl schon beim Import.

@ddraeyer
Copy link

Ich würde auch erst einmal direkt auf dem Pi mit OpenWB2.14 weiterprobieren. @ddraeyer konntest Du das Problem mit den helpermodules schon lösen? Da klemmte es ja wohl schon beim Import.

Nein, habe ich nicht. Das war ja nur mein Versuch, soc.py einfach ab Kommandozeile aufzurufen. Das hat unter openWB 1.9 funktioniert und den Output in die soc.log geschrieben. soc.log wird unter 1.9 regelmässig gelesen und für die Anzeige im Browser-GUI genutzt. Unter 2.14 muss der Output ins Topic geschrieben werden (unter get|soc (siehe meinen Screenshot)). Ich weiss somit nicht, ob ein manueller Aufruf unter 2.14 auch machbar ist.

Aus meiner Sicht benötigt der Programmierer entweder einen RasPI, um selbst testen und debuggen zu können oder alternativ eine VM mit Debian 11 (bullseye).

@ddraeyer
Copy link

Ich habe eine VM mit Debian 11 (amd64) aufgebaut und darin erfolgreich openWB2 installiert. Nach der Einrichtung einer fixen IP-Adresse und der Nachinstallation von SSH und cURL in Debian (sudo apt-get install openssh-server curl) lief der Installationsbefehl curl -s https://raw.githubusercontent.com/openWB/core/master/openwb-install.sh | sudo bash wie Butter durch.

@mekrapp
Copy link
Contributor Author

mekrapp commented Jun 24, 2024

Das klingt sehr gut. Wie weit bist Du dabei gekommen? Nur die OpenWB V2.14 erfolgreich in der VM installiert oder auch schon das Modul SoC Modul für den Leaf erfolgreich getestet?

@ddraeyer
Copy link

Das klingt sehr gut. Wie weit bist Du dabei gekommen? Nur die OpenWB V2.14 erfolgreich in der VM installiert oder auch schon das Modul SoC Modul für den Leaf erfolgreich getestet?

In der VM wurde openWB 2.14 frisch installiert und kurz gestartet. Die Konfigurationsmasken im Browser-GUI sind fehlerfrei zugänglich. Die Files vom Pull Request sind noch nicht eingespielt worden. Es liefen somit noch keine Tests. Auch hat der User openwb noch kein Pw.

Ein ZIP-File der VM habe ich auf Google Drive gelegt. https://drive.google.com/file/d/1g4xyowe6OS0p3WwpZzGSUGkSDVAWnE9h/view?usp=drive_link
Sie kann runtergeladen werden und nach dem Unzippen in den Ordner der VMs von Oracle VirtualBox gelegt werden und dort gestartet werden.

Login / Pw: pi / qwertz12345 (pi gehört zur Gruppe sudo)
Nach dem Login kann die locale geändert werden von de-CH UTF-8 auf z.B. de-DE UTF-8. Weiter kann die Tastatur geändert werden von Schweiz | Deutsch auf z.B Deutschland | Deutsch.

Es ist eine fixe IP-Adresse konfiguriert. Sie kann geändert werden mit:
sudo nmtui
Danach:
sudo init 6

Damit wäre dann alles vorbereitet, um von Windows aus per PuTTY auf die gestartete VM zuzugreifen. Dann können die eigenen Tests beginnen. Wenn der User openwb mit einem Pw ausgestattet wurde, können die Files vom Pull Request per WinSCP auf die VM gelegt werden und zwar nach openwb@debian11:/var/www/html/openWB/packages/modules/vehicles/leaf.

Viel Erfolg beim Runterladen, Unzippen und anschliessenden Testen!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants