iobroker.bydhvs 1.3.0 → 1.4.1

package/CHANGELOG_OLD.md

@@ -1,8 +1,19 @@
 # Older changes
+## 1.2.2 (2021-06-14)
+* bump to new patch-level (to get rid of the "-0")
+
+## 1.2.2-0 (2021-05-30)
+* Create States for Diagnose-Data only if necessary
+* changes according review of the adapter
+
+## 1.2.2-0 (2021-05-30)
+* Create States for Diagnose-Data only if necessary
+* changes according review of the adapter
+
 ## 1.2.1 (2021-05-20)
 * Power is now fixed with 2 number after the decimal point
-* bug removed, cell voltage for cell 64 works now
-
+* bug removed, cell voltage for cell 64 works now
+
 ## 1.2.0 (2021-05-15)
 * preparation for being listed in official repository
 * English part in readme.md
@@ -13,9 +24,8 @@
 * New: type of battery 
 * compatibility with new js-controller 3.3
 * compatibility with nodejs 15
-* compatibility with admin UI 5
-
-
+* compatibility with admin UI 5
+
 ## 1.1.0 (2021-04-22)
 * HVS-Version with two banks and - hopefully - correct display
 * states are now with units, the existing states are changed
@@ -24,23 +34,26 @@
 * moved state from State.ErrorNum to System.ErrorNum --> old states exists further on, I do not know how to delete it, adapter.deletestate does not work.
 * deleted test-answers --> moved to my BYD-HVS-Simulator
 * some minor bugs removed
-* obviously the adapter works for hvm, too -> need more testers and an idea for a new name
-
+* obviously the adapter works for hvm, too -> need more testers and an idea for a new name
+
 ## 1.0.0 (2021-04-05)
 * Update all dependencies
-* first public version
+* first public version
+
 ## 0.1.4-beta.0 (2021-04-02)
-* 1st change with release-script
+* 1st change with release-script
+
 ## 0.1.3
-- Test Mode for getting hex data easily, removed check for 2 modules, moved "diagnosis-states" to extra folder, renaming CellStates
+- Test Mode for getting hex data easily, removed check for 2 modules, moved "diagnosis-states" to extra folder, renaming CellStates
+
 ## 0.1.2
-- Battery Voltage is unsigned, should now work with 4 modules
+- Battery Voltage is unsigned, should now work with 4 modules
+
 ## 0.1.1
-- start of documentation (German)
+- start of documentation (German)
+
 ## 0.1.0
-- (Christian) first testing release with (limited) public announcement
+- (Christian) first testing release with (limited) public announcement
+
 ## 0.0.1
-- (Christian) initial release
-
-
-
+- (Christian) initial release

package/README.md

@@ -8,15 +8,15 @@ BYD HVS Battery poll data
 
 ## Introduction
 
-This Adapter takes data from a byd PV battery ( https://www.bydbatterybox.com/ ) and puts them into datapoints in the adapter. Unfortunally there is no official API and no documentation, so I used wireshark and a byd-hvs-simulater to try to understand the communication. My adapter simulates the byd-app, sends similar packets to the device and analyses the responses. 
+This Adapter takes data from a byd PV battery ( https://www.bydbatterybox.com/ ) and puts them into datapoints in the adapter. Unfortunately there is no official API and no documentation, so I used wireshark and a byd-hvs-simulator to try to understand the communication. My adapter simulates the byd-app, sends similar packets to the device and analyses the responses. 
 
 ## be careful
 
-There are two steps in the beConnect app, in the first step you get the normal data, in the second step you get detail-data for all cells (individual cell temperature and voltage and some more details) To get the detail-data there has to be a delay after one of the data-packets till I can get the result. I think in the meantime alle cells are measured, but I am not sure. So I limited the frequency of reading the detail-data, it is done only ever "n" readings of the normal data, you can change this setting. If you do not need the detail-data: you can switch this part off.
+There are two steps in the beConnect app, in the first step you get the normal data, in the second step you get detail-data for all cells (individual cell temperature and voltage and some more details) To get the detail-data there has to be a delay after one of the data-packets till I can get the result. I think in the meantime alle cells are measured, but I am not sure. I am definitely not sure if you harm your battery with polling this data too often, so be aware: You are on your own risk!
 
-## hint for systems with 5 modules
+## support for up to 5 modules
 
-People who have 5 modules: The cell details are read only for the first 4 modules - the protocol is the same for 2-4 modules. I would like to extend it for 5 modules but either somebody buys me the three missing modules ;-) so I can analyse the protocol or I get a wireshark capture from a working connection.
+Up to 5 HVS Modules are now supported.
 
 ## settings
 
@@ -34,7 +34,7 @@ Test Mode - show data in error log: If you check this box: the sent and recieved
 
 Prinzipiell ist der Adapter durch Anaylse der Datenpakete zwischen der BYD-App und dem BYD-Akku-System entstanden. Es werden im Wesentlichen die Daten aus dem TAB System Info und aus dem TAB Diagnosis dargestellt. Offensichtlich sind die Daten für "System Info" sofort in der Batterie bereit zum abholen, für die Diagnose-Daten sieht es so aus als wäre ein Messvorgang erforderlich, zwischen der Abfrage und den Werten muss ein Zeitintervall von gut 3 Sekunden eingehalten werden. 
 
-Daher lasse ich die Diagnose-Daten auch nicht bei jeder Abfrage der Daten mit ermitteln.
+Ich bin mir nicht sicher ob das BYD-System durch zu häufige Abfragen beschädigt wird, also: Es ist Dein Risiko was Du hier einträgst!
 
 ## Zu den Einstellungen:
 Intervall: Zeitlicher Abstand zwischen den Abfragen des Adapters
@@ -43,34 +43,41 @@ IP-Adresse: Eigentlich logisch, damit ist die IP-Adresse des Adapters gemeint. D
 
 Batterie-Details: Steuerung, ob die Details zu den Zellen gelesen werden sollen
 
-Lesezyklen zu Batterie-Details: Anzahl der "Normal-Lese-Zyklen" bis wieder einmal die Diagnose-Daten gelesen werden. Hier die Warnung dazu: Ich habe keine Idee ob man sich durch häufige Diagnose-Messungen Nachteile einhandelt, daher empfehle ich den Wert möglichst hoch zu setzen. Ich wüsste auch nicht was man mit den Diagnose-Daten im regelmäßigen Poll anfangen sollte.
+Lesezyklen zu Batterie-Details: Anzahl der "Normal-Lese-Zyklen" bis wieder einmal die Diagnose-Daten gelesen werden. Hier die Warnung dazu: Ich habe keine Idee ob man sich durch häufige Diagnose-Messungen Nachteile einhandelt, daher empfehle ich den Wert möglichst hoch zu setzen. Ich wüsste auch nicht was man mit den Diagnose-Daten im regelmäßigen Poll anfangen sollte. 
 
-Zu den Batterie-Größen: Der Adapter funktioniert auch für Zelltemperaturen und ZellSpannungen bei 2,3 und 4 Batterie-Modulen. Bei einem System mit 5 Modulen werden nur die Zellspannungen der ersten 128 Zellen angezeigt. Für die Zellen 129 bis 160 ist mir nicht bekannt wo die Daten gespeichert werden. Ich würde das gerne mit in den Adapter einbauen, benötige aber dafür einen Wireshark-Mittschnitt der Kommunikation zwischen der beConnect App und dem Speicher. Ich helfe auch gerne wenn jemand nicht weiß wie man den Mittschnitt machen kann, entweder per Teamviewer oder per Postings im Forum. Offensichtlich funktioniert die Kommunikation für die 5. Einheit anders als bei den ersten 4 Einheiten. 
+Zu den Batterie-Größen: Der Adapter funktioniert für Zelltemperaturen und ZellSpannungen bei 2-5 Batterie-Modulen. 
 
 
 ## Changelog
 <!--
 	Placeholder for the next version (at the beginning of the line):
 	### __WORK IN PROGRESS__
--->
+-->
+### 1.4.1 (2023-09-24)
+* Compatibility with js.controller 5x
+* Removed some bugs in detecting inverter
+* Inverternumber ist logged, so I can easily add new inverters if neccerary, just send me the silly-log if inverter is unknown.
+
+### 1.4.0 (2022-10-31)
+* Update of referred modules (mainly around testing)
+* improvmenets contributed by Tapter (5 modules, readme and better readable code)
+* Better detection of battery type and inverter
+* SOC not only from normal data but from diagnosis-data, too. There we have one decimal place more
+* removed frequency limit for battery detail data
+* increased max count of temperature measurements for HVS to 64
+* support for up to 5 HVS modules
+
 ### 1.3.0 (2021-11-06)
 * updated even more dependencies
-* official release with new state SOH
-
+* official release with new state SOH
+
 ### 1.2.4-0 (2021-11-02)
 * Added state: SOH
-* updated dependencies as suggested from bot
-
+* updated dependencies as suggested from bot
+
 ### 1.2.3 (2021-06-18)
-* changed ratio of logo
-
-### 1.2.2 (2021-06-14)
-* bump to new patch-level (to get rid of the "-0")
-
-### 1.2.2-0 (2021-05-30)
-* Create States for Diagnose-Data only if necessary
-* changes according review of the adapter
-
+* changed ratio of logo
+
 ###
 
 ## License
@@ -94,4 +101,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/admin/admin.d.ts

@@ -1,93 +1,93 @@
-declare let systemDictionary: Record<string, Record<string, string>>;
-
-declare let load: (settings: Record<string, unknown>, onChange: (hasChanges: boolean) => void) => void;
-declare let save: (callback: (settings: Record<string, unknown>) => void) => void;
-
-// make load and save exist on the window object
-interface Window {
-    load: typeof load;
-    save: typeof save;
-}
-
-declare const instance: number;
-declare const adapter: string;
-/** Translates text */
-declare function _(text: string): string;
-declare const socket: ioBrokerSocket;
-declare function sendTo(
-    instance: any | null,
-    command: string,
-    message: any,
-    callback: (result: SendToResult) => void | Promise<void>,
-): void;
-
-interface SendToResult {
-    error?: string | Error;
-    result?: any;
-}
-
-// tslint:disable-next-line:class-name
-interface ioBrokerSocket {
-    emit(
-        command: "subscribeObjects",
-        pattern: string,
-        callback?: (err?: string) => void | Promise<void>,
-    ): void;
-    emit(
-        command: "subscribeStates",
-        pattern: string,
-        callback?: (err?: string) => void | Promise<void>,
-    ): void;
-    emit(
-        command: "unsubscribeObjects",
-        pattern: string,
-        callback?: (err?: string) => void | Promise<void>,
-    ): void;
-    emit(
-        command: "unsubscribeStates",
-        pattern: string,
-        callback?: (err?: string) => void | Promise<void>,
-    ): void;
-
-    emit(
-        event: "getObjectView",
-        view: "system",
-        type: "device",
-        options: ioBroker.GetObjectViewParams,
-        callback: (
-            err: string | undefined,
-            result?: any,
-        ) => void | Promise<void>,
-    ): void;
-    emit(
-        event: "getStates",
-        callback: (
-            err: string | undefined,
-            result?: Record<string, any>,
-        ) => void,
-    ): void;
-    emit(
-        event: "getState",
-        id: string,
-        callback: (err: string | undefined, result?: ioBroker.State) => void,
-    ): void;
-    emit(
-        event: "setState",
-        id: string,
-        state: unknown,
-        callback: (err: string | undefined, result?: any) => void,
-    ): void;
-
-    on(event: "objectChange", handler: ioBroker.ObjectChangeHandler): void;
-    on(event: "stateChange", handler: ioBroker.StateChangeHandler): void;
-    removeEventHandler(
-        event: "objectChange",
-        handler: ioBroker.ObjectChangeHandler,
-    ): void;
-    removeEventHandler(
-        event: "stateChange",
-        handler: ioBroker.StateChangeHandler,
-    ): void;
-
-    // TODO: other events
-}
+declare let systemDictionary: Record<string, Record<string, string>>;
+
+declare let load: (settings: Record<string, unknown>, onChange: (hasChanges: boolean) => void) => void;
+declare let save: (callback: (settings: Record<string, unknown>) => void) => void;
+
+// make load and save exist on the window object
+interface Window {
+    load: typeof load;
+    save: typeof save;
+}
+
+declare const instance: number;
+declare const adapter: string;
+/** Translates text */
+declare function _(text: string): string;
+declare const socket: ioBrokerSocket;
+declare function sendTo(
+    instance: any | null,
+    command: string,
+    message: any,
+    callback: (result: SendToResult) => void | Promise<void>,
+): void;
+
+interface SendToResult {
+    error?: string | Error;
+    result?: any;
+}
+
+// tslint:disable-next-line:class-name
+interface ioBrokerSocket {
+    emit(
+        command: "subscribeObjects",
+        pattern: string,
+        callback?: (err?: string) => void | Promise<void>,
+    ): void;
+    emit(
+        command: "subscribeStates",
+        pattern: string,
+        callback?: (err?: string) => void | Promise<void>,
+    ): void;
+    emit(
+        command: "unsubscribeObjects",
+        pattern: string,
+        callback?: (err?: string) => void | Promise<void>,
+    ): void;
+    emit(
+        command: "unsubscribeStates",
+        pattern: string,
+        callback?: (err?: string) => void | Promise<void>,
+    ): void;
+
+    emit(
+        event: "getObjectView",
+        view: "system",
+        type: "device",
+        options: ioBroker.GetObjectViewParams,
+        callback: (
+            err: string | undefined,
+            result?: any,
+        ) => void | Promise<void>,
+    ): void;
+    emit(
+        event: "getStates",
+        callback: (
+            err: string | undefined,
+            result?: Record<string, any>,
+        ) => void,
+    ): void;
+    emit(
+        event: "getState",
+        id: string,
+        callback: (err: string | undefined, result?: ioBroker.State) => void,
+    ): void;
+    emit(
+        event: "setState",
+        id: string,
+        state: unknown,
+        callback: (err: string | undefined, result?: any) => void,
+    ): void;
+
+    on(event: "objectChange", handler: ioBroker.ObjectChangeHandler): void;
+    on(event: "stateChange", handler: ioBroker.StateChangeHandler): void;
+    removeEventHandler(
+        event: "objectChange",
+        handler: ioBroker.ObjectChangeHandler,
+    ): void;
+    removeEventHandler(
+        event: "stateChange",
+        handler: ioBroker.StateChangeHandler,
+    ): void;
+
+    // TODO: other events
+}

package/admin/index_m.html

@@ -1,113 +1,113 @@
-<html>
-
-<head>
-
-    <!-- Load ioBroker scripts and styles-->
-    <link rel="stylesheet" type="text/css" href="../../css/adapter.css" />
-    <link rel="stylesheet" type="text/css" href="../../lib/css/materialize.css">
-
-    <script type="text/javascript" src="../../lib/js/jquery-3.2.1.min.js"></script>
-    <script type="text/javascript" src="../../socket.io/socket.io.js"></script>
-
-    <script type="text/javascript" src="../../js/translate.js"></script>
-    <script type="text/javascript" src="../../lib/js/materialize.js"></script>
-    <script type="text/javascript" src="../../js/adapter-settings.js"></script>
-
-    <!-- Load our own files -->
-    <link rel="stylesheet" type="text/css" href="style.css" />
-    <script type="text/javascript" src="words.js"></script>
-
-    <script type="text/javascript">
-        // This will be called by the admin adapter when the settings page loads
-        function load(settings, onChange) {
-            // example: select elements with id=key and class=value and insert value
-            if (!settings) return;
-            $('.value').each(function () {
-                var $key = $(this);
-                var id = $key.attr('id');
-                if ($key.attr('type') === 'checkbox') {
-                    // do not call onChange direct, because onChange could expect some arguments
-                    $key.prop('checked', settings[id])
-                        .on('change', () => onChange())
-                        ;
-                } else {
-                    // do not call onChange direct, because onChange could expect some arguments
-                    $key.val(settings[id])
-                        .on('change', () => onChange())
-                        .on('keyup', () => onChange())
-                        ;
-                }
-            });
-            onChange(false);
-            // reinitialize all the Materialize labels on the page if you are dynamically adding inputs:
-            if (M) M.updateTextFields();
-        }
-
-        // This will be called by the admin adapter when the user presses the save button
-        function save(callback) {
-            // example: select elements with class=value and build settings object
-            var obj = {};
-            $('.value').each(function () {
-                var $this = $(this);
-                if ($this.attr('type') === 'checkbox') {
-                    obj[$this.attr('id')] = $this.prop('checked');
-                } else if ($this.attr('type') === 'number') {
-                    obj[$this.attr('id')] = parseFloat($this.val());
-                } else {
-                    obj[$this.attr('id')] = $this.val();
-                }
-            });
-            callback(obj);
-        }
-    </script>
-
-</head>
-
-<body>
-
-    <div class="m adapter-container">
-
-        <div class="row">
-            <div class="col s12 m4 l2">
-                <img src="bydhvs.png" class="logo">
-            </div>
-        </div>
-
-        <!-- Put your content here -->
-
-        <!-- For example columns with settings: -->
-        <div class="row">
-            <div class="col s6 input-field">
-                <input type="text" class="value" id="ConfPollInterval" />
-                <label for="PollInterval" class="translate">Interval (s)</label>
-            </div>
-
-            <div class="col s6 input-field">
-                <input type="text" class="value" id="ConfIPAdress" />
-                <label for="IP Adress" class="translate">IP Adress</label>
-            </div>
-            <div class="row">
-				<div class="col s6 input-field">
-					<input type="checkbox" class="value" id="ConfBatDetails" />
-					<label for="ConfBatDetails" class="translate">Diagnosis Data from Battery (only tested with two and four modules)</label>
-				</div>
-			</div>
-            <div class="row">
-				<div class="col s6 input-field">
-					<input type="checkbox" class="value" id="ConfTestMode" />
-					<label for="ConfTestMode" class="translate">Test Mode - show data in error log</label>
-				</div>
-			</div>            
-            <div class="row">
-				<div class="col s6 input-field">
-					<input type="text" class="value" id="ConfDetailshowoften" />
-					<label for="ConfDetailshowoften" class="translate">Battery-details - every ... cycles</label>
-				</div>
-			</div>
-        </div>
-
-    </div>
-
-</body>
-
+<html>
+
+<head>
+
+    <!-- Load ioBroker scripts and styles-->
+    <link rel="stylesheet" type="text/css" href="../../css/adapter.css" />
+    <link rel="stylesheet" type="text/css" href="../../lib/css/materialize.css">
+
+    <script type="text/javascript" src="../../lib/js/jquery-3.2.1.min.js"></script>
+    <script type="text/javascript" src="../../socket.io/socket.io.js"></script>
+
+    <script type="text/javascript" src="../../js/translate.js"></script>
+    <script type="text/javascript" src="../../lib/js/materialize.js"></script>
+    <script type="text/javascript" src="../../js/adapter-settings.js"></script>
+
+    <!-- Load our own files -->
+    <link rel="stylesheet" type="text/css" href="style.css" />
+    <script type="text/javascript" src="words.js"></script>
+
+    <script type="text/javascript">
+        // This will be called by the admin adapter when the settings page loads
+        function load(settings, onChange) {
+            // example: select elements with id=key and class=value and insert value
+            if (!settings) return;
+            $('.value').each(function () {
+                var $key = $(this);
+                var id = $key.attr('id');
+                if ($key.attr('type') === 'checkbox') {
+                    // do not call onChange direct, because onChange could expect some arguments
+                    $key.prop('checked', settings[id])
+                        .on('change', () => onChange())
+                        ;
+                } else {
+                    // do not call onChange direct, because onChange could expect some arguments
+                    $key.val(settings[id])
+                        .on('change', () => onChange())
+                        .on('keyup', () => onChange())
+                        ;
+                }
+            });
+            onChange(false);
+            // reinitialize all the Materialize labels on the page if you are dynamically adding inputs:
+            if (M) M.updateTextFields();
+        }
+
+        // This will be called by the admin adapter when the user presses the save button
+        function save(callback) {
+            // example: select elements with class=value and build settings object
+            var obj = {};
+            $('.value').each(function () {
+                var $this = $(this);
+                if ($this.attr('type') === 'checkbox') {
+                    obj[$this.attr('id')] = $this.prop('checked');
+                } else if ($this.attr('type') === 'number') {
+                    obj[$this.attr('id')] = parseFloat($this.val());
+                } else {
+                    obj[$this.attr('id')] = $this.val();
+                }
+            });
+            callback(obj);
+        }
+    </script>
+
+</head>
+
+<body>
+
+    <div class="m adapter-container">
+
+        <div class="row">
+            <div class="col s12 m4 l2">
+                <img src="bydhvs.png" class="logo">
+            </div>
+        </div>
+
+        <!-- Put your content here -->
+
+        <!-- For example columns with settings: -->
+        <div class="row">
+            <div class="col s6 input-field">
+                <input type="text" class="value" id="ConfPollInterval" />
+                <label for="PollInterval" class="translate">Interval (s)</label>
+            </div>
+
+            <div class="col s6 input-field">
+                <input type="text" class="value" id="ConfIPAdress" />
+                <label for="IP Adress" class="translate">IP Adress</label>
+            </div>
+            <div class="row">
+				<div class="col s6 input-field">
+					<input type="checkbox" class="value" id="ConfBatDetails" />
+					<label for="ConfBatDetails" class="translate">Diagnosis Data from Battery (only tested with two and four modules)</label>
+				</div>
+			</div>
+            <div class="row">
+				<div class="col s6 input-field">
+					<input type="checkbox" class="value" id="ConfTestMode" />
+					<label for="ConfTestMode" class="translate">Test Mode - show data in error log</label>
+				</div>
+			</div>            
+            <div class="row">
+				<div class="col s6 input-field">
+					<input type="text" class="value" id="ConfDetailshowoften" />
+					<label for="ConfDetailshowoften" class="translate">Battery-details - every ... cycles</label>
+				</div>
+			</div>
+        </div>
+
+    </div>
+
+</body>
+
 </html>

package/admin/style.css

@@ -1,32 +1,32 @@
-/* You can delete those if you want. I just found them very helpful */
-* {
-    box-sizing: border-box
-}
-.m {
-    /* Don't cut off dropdowns! */
-    overflow: initial;
-}
-.m.adapter-container,
-.m.adapter-container > div.App {
-    /* Fix layout/scrolling issues with tabs */
-    height: 100%;
-    width: 100%;
-    position: relative;
-}
-.m .select-wrapper + label {
-    /* The positioning for dropdown labels is messed up */
-    transform: none !important;
-}
-
-label > i[title] {
-    /* Display the help cursor for the tooltip icons and fix their positioning */
-    cursor: help;
-    margin-left: 0.25em;
-}
-
-.dropdown-content {
-    /* Don't wrap text in dropdowns */
-    white-space: nowrap;
-}
-
-/* Add your styles here */
+/* You can delete those if you want. I just found them very helpful */
+* {
+    box-sizing: border-box
+}
+.m {
+    /* Don't cut off dropdowns! */
+    overflow: initial;
+}
+.m.adapter-container,
+.m.adapter-container > div.App {
+    /* Fix layout/scrolling issues with tabs */
+    height: 100%;
+    width: 100%;
+    position: relative;
+}
+.m .select-wrapper + label {
+    /* The positioning for dropdown labels is messed up */
+    transform: none !important;
+}
+
+label > i[title] {
+    /* Display the help cursor for the tooltip icons and fix their positioning */
+    cursor: help;
+    margin-left: 0.25em;
+}
+
+.dropdown-content {
+    /* Don't wrap text in dropdowns */
+    white-space: nowrap;
+}
+
+/* Add your styles here */