@rhizomatics/signalk-bluetti-plugin 1.4.1 → 1.5.0

package/registers/ep500p.yaml

@@ -0,0 +1,57 @@
+# Bluetti EP500P register map
+# Source: https://github.com/Patrick762/bluetti-bt-lib (bluetti_bt_lib/devices/ep500p.py)
+#
+# field_name is a standard Bluetti register name — the code maps these to
+# SignalK paths on its own (see lib/path-mapper.js). `path` on a field is an
+# override, only needed if you're exposing a register the code doesn't
+# recognise. `constants` are fixed, non-register facts about this model —
+# a bare scalar (string/number) or { value, unit } for one that needs unit
+# conversion (e.g. total_capacity in Wh -> J). No verified nominal capacity
+# is bundled for most models — add a total_capacity constant yourself if you
+# know it, to enable the derived remaining-capacity calculation.
+#
+
+fields:
+  battery_soc:
+    register: 43
+    unit: "%"
+  dc_input_power:
+    register: 36
+    unit: W
+  ac_input_power:
+    register: 37
+    unit: W
+  ac_output_power:
+    register: 38
+    unit: W
+  dc_output_power:
+    register: 39
+    unit: W
+  ac_output_voltage:
+    register: 71
+    scale: 0.1
+    unit: V
+  ac_output_frequency:
+    register: 74
+    scale: 0.01
+    unit: Hz
+  ac_input_voltage:
+    register: 77
+    scale: 0.1
+    unit: V
+  ac_input_frequency:
+    register: 80
+    scale: 0.01
+    unit: Hz
+  dc_input_voltage:
+    register: 86
+    scale: 0.1
+    unit: V
+  dc_input_current:
+    register: 88
+    scale: 0.1
+    unit: A
+constants:
+  battery_chemistry: LiFePO4
+  battery_manufacturer_name: Bluetti
+  battery_manufacturer_model: EP500P

package/registers/ep600.yaml

@@ -0,0 +1,151 @@
+# Bluetti EP600 register map
+# Source: https://github.com/Patrick762/bluetti-bt-lib (bluetti_bt_lib/devices/ep600.py)
+#
+# field_name is a standard Bluetti register name — the code maps these to
+# SignalK paths on its own (see lib/path-mapper.js). `path` on a field is an
+# override, only needed if you're exposing a register the code doesn't
+# recognise. `constants` are fixed, non-register facts about this model —
+# a bare scalar (string/number) or { value, unit } for one that needs unit
+# conversion (e.g. total_capacity in Wh -> J). No verified nominal capacity
+# is bundled for most models — add a total_capacity constant yourself if you
+# know it, to enable the derived remaining-capacity calculation.
+#
+
+fields:
+  battery_soc:
+    register: 102
+    unit: "%"
+  power_generation:
+    register: 1202
+    scale: 0.1
+    unit: kWh
+  dc_input_power:
+    register: 1212
+    unit: W
+  dc_input_voltage:
+    register: 1213
+    scale: 0.1
+    unit: V
+  dc_input_current:
+    register: 1214
+    scale: 0.1
+    unit: A
+  pv_s2_power:
+    register: 1220
+    unit: W
+  pv_s2_voltage:
+    register: 1221
+    scale: 0.1
+    unit: V
+  pv_s2_current:
+    register: 1222
+    scale: 0.1
+    unit: A
+  sm_p1_power:
+    register: 1228
+    unit: W
+  sm_p1_voltage:
+    register: 1229
+    scale: 0.1
+    unit: V
+  sm_p1_current:
+    register: 1230
+    unit: A
+  sm_p2_power:
+    register: 1236
+    unit: W
+  sm_p2_voltage:
+    register: 1237
+    scale: 0.1
+    unit: V
+  sm_p2_current:
+    register: 1238
+    unit: A
+  sm_p3_power:
+    register: 1244
+    unit: W
+  sm_p3_voltage:
+    register: 1245
+    scale: 0.1
+    unit: V
+  sm_p3_current:
+    register: 1246
+    unit: A
+  grid_frequency:
+    register: 1300
+    scale: 0.1
+    unit: Hz
+  grid_p1_power:
+    register: 1313
+    unit: W
+  grid_p1_voltage:
+    register: 1314
+    scale: 0.1
+    unit: V
+  grid_p1_current:
+    register: 1315
+    scale: 0.1
+    unit: A
+  grid_p2_power:
+    register: 1319
+    unit: W
+  grid_p2_voltage:
+    register: 1320
+    scale: 0.1
+    unit: V
+  grid_p2_current:
+    register: 1321
+    scale: 0.1
+    unit: A
+  grid_p3_power:
+    register: 1325
+    unit: W
+  grid_p3_voltage:
+    register: 1326
+    scale: 0.1
+    unit: V
+  grid_p3_current:
+    register: 1327
+    scale: 0.1
+    unit: A
+  ac_output_frequency:
+    register: 1500
+    scale: 0.1
+    unit: Hz
+  ac_p1_power:
+    register: 1510
+    unit: W
+  ac_p1_voltage:
+    register: 1511
+    scale: 0.1
+    unit: V
+  ac_p1_current:
+    register: 1512
+    scale: 0.1
+    unit: A
+  ac_p2_power:
+    register: 1517
+    unit: W
+  ac_p2_voltage:
+    register: 1518
+    scale: 0.1
+    unit: V
+  ac_p2_current:
+    register: 1519
+    scale: 0.1
+    unit: A
+  ac_p3_power:
+    register: 1524
+    unit: W
+  ac_p3_voltage:
+    register: 1525
+    scale: 0.1
+    unit: V
+  ac_p3_current:
+    register: 1526
+    scale: 0.1
+    unit: A
+constants:
+  battery_chemistry: LiFePO4
+  battery_manufacturer_name: Bluetti
+  battery_manufacturer_model: EP600

package/registers/ep760.yaml

@@ -0,0 +1,72 @@
+# Bluetti EP760 register map
+# Source: https://github.com/Patrick762/bluetti-bt-lib (bluetti_bt_lib/devices/ep760.py)
+#
+# field_name is a standard Bluetti register name — the code maps these to
+# SignalK paths on its own (see lib/path-mapper.js). `path` on a field is an
+# override, only needed if you're exposing a register the code doesn't
+# recognise. `constants` are fixed, non-register facts about this model —
+# a bare scalar (string/number) or { value, unit } for one that needs unit
+# conversion (e.g. total_capacity in Wh -> J). No verified nominal capacity
+# is bundled for most models — add a total_capacity constant yourself if you
+# know it, to enable the derived remaining-capacity calculation.
+#
+
+fields:
+  battery_soc:
+    register: 102
+    unit: "%"
+  dc_input_power:
+    register: 1212
+    unit: W
+  dc_input_voltage:
+    register: 1213
+    scale: 0.1
+    unit: V
+  dc_input_current:
+    register: 1214
+    scale: 0.1
+    unit: A
+  sm_p1_power:
+    register: 1228
+    unit: W
+  sm_p1_voltage:
+    register: 1229
+    scale: 0.1
+    unit: V
+  sm_p1_current:
+    register: 1230
+    unit: A
+  ac_input_frequency:
+    register: 1300
+    scale: 0.1
+    unit: Hz
+  ac_input_power:
+    register: 1313
+    unit: W
+  ac_input_voltage:
+    register: 1314
+    scale: 0.1
+    unit: V
+  ac_input_current:
+    register: 1315
+    scale: 0.1
+    unit: A
+  ac_output_frequency:
+    register: 1500
+    scale: 0.1
+    unit: Hz
+  ac_output_power:
+    register: 1510
+    unit: W
+  ac_output_voltage:
+    register: 1511
+    scale: 0.1
+    unit: V
+  ac_output_current:
+    register: 1512
+    scale: 0.1
+    unit: A
+constants:
+  battery_chemistry: LiFePO4
+  battery_manufacturer_name: Bluetti
+  battery_manufacturer_model: EP760

package/registers/ep800.yaml

@@ -0,0 +1,21 @@
+# Bluetti EP800 register map
+# Source: https://github.com/Patrick762/bluetti-bt-lib (bluetti_bt_lib/devices/ep800.py)
+#
+# field_name is a standard Bluetti register name — the code maps these to
+# SignalK paths on its own (see lib/path-mapper.js). `path` on a field is an
+# override, only needed if you're exposing a register the code doesn't
+# recognise. `constants` are fixed, non-register facts about this model —
+# a bare scalar (string/number) or { value, unit } for one that needs unit
+# conversion (e.g. total_capacity in Wh -> J). No verified nominal capacity
+# is bundled for most models — add a total_capacity constant yourself if you
+# know it, to enable the derived remaining-capacity calculation.
+#
+
+fields:
+  battery_soc:
+    register: 102
+    unit: "%"
+constants:
+  battery_chemistry: LiFePO4
+  battery_manufacturer_name: Bluetti
+  battery_manufacturer_model: EP800

package/registers/handsfree1.yaml

@@ -0,0 +1,62 @@
+# Bluetti HANDSFREE1 register map
+# Source: https://github.com/Patrick762/bluetti-bt-lib (bluetti_bt_lib/devices/handsfree1.py)
+#
+# field_name is a standard Bluetti register name — the code maps these to
+# SignalK paths on its own (see lib/path-mapper.js). `path` on a field is an
+# override, only needed if you're exposing a register the code doesn't
+# recognise. `constants` are fixed, non-register facts about this model —
+# a bare scalar (string/number) or { value, unit } for one that needs unit
+# conversion (e.g. total_capacity in Wh -> J). No verified nominal capacity
+# is bundled for most models — add a total_capacity constant yourself if you
+# know it, to enable the derived remaining-capacity calculation.
+#
+
+fields:
+  dc_output_power:
+    register: 140
+    unit: W
+  ac_output_power:
+    register: 142
+    unit: W
+  dc_input_power:
+    register: 144
+    unit: W
+  ac_input_power:
+    register: 146
+    unit: W
+  time_remaining_minutes:
+    register: 104
+    scale: 6
+    unit: min
+  dc_input_voltage:
+    register: 1213
+    scale: 0.1
+    unit: V
+  dc_input_current:
+    register: 1214
+    scale: 0.1
+    unit: A
+  ac_input_frequency:
+    register: 1300
+    scale: 0.1
+    unit: Hz
+  ac_input_voltage:
+    register: 1314
+    scale: 0.1
+    unit: V
+  ac_input_current:
+    register: 1315
+    scale: 0.1
+    unit: A
+  ac_output_frequency:
+    register: 1500
+    scale: 0.1
+    unit: Hz
+  ac_output_voltage:
+    register: 1511
+    scale: 0.1
+    unit: V
+constants:
+  battery_chemistry: LiFePO4
+  battery_manufacturer_name: Bluetti
+  battery_manufacturer_model: Handsfree 1

package/registers/pr100v2.yaml

@@ -0,0 +1,34 @@
+# Bluetti PR100V2 register map
+# Source: https://github.com/Patrick762/bluetti-bt-lib (bluetti_bt_lib/devices/pr100v2.py)
+#
+# field_name is a standard Bluetti register name — the code maps these to
+# SignalK paths on its own (see lib/path-mapper.js). `path` on a field is an
+# override, only needed if you're exposing a register the code doesn't
+# recognise. `constants` are fixed, non-register facts about this model —
+# a bare scalar (string/number) or { value, unit } for one that needs unit
+# conversion (e.g. total_capacity in Wh -> J). No verified nominal capacity
+# is bundled for most models — add a total_capacity constant yourself if you
+# know it, to enable the derived remaining-capacity calculation.
+#
+
+fields:
+  dc_output_power:
+    register: 140
+    unit: W
+  ac_output_power:
+    register: 142
+    unit: W
+  dc_input_power:
+    register: 144
+    unit: W
+  ac_input_power:
+    register: 146
+    unit: W
+  ac_input_voltage:
+    register: 1314
+    scale: 0.1
+    unit: V
+constants:
+  battery_chemistry: LiFePO4
+  battery_manufacturer_name: Bluetti
+  battery_manufacturer_model: PR100 V2

package/registers/pr30v2.yaml

@@ -0,0 +1,34 @@
+# Bluetti PR30V2 register map
+# Source: https://github.com/Patrick762/bluetti-bt-lib (bluetti_bt_lib/devices/pr30v2.py)
+#
+# field_name is a standard Bluetti register name — the code maps these to
+# SignalK paths on its own (see lib/path-mapper.js). `path` on a field is an
+# override, only needed if you're exposing a register the code doesn't
+# recognise. `constants` are fixed, non-register facts about this model —
+# a bare scalar (string/number) or { value, unit } for one that needs unit
+# conversion (e.g. total_capacity in Wh -> J). No verified nominal capacity
+# is bundled for most models — add a total_capacity constant yourself if you
+# know it, to enable the derived remaining-capacity calculation.
+#
+
+fields:
+  dc_output_power:
+    register: 140
+    unit: W
+  ac_output_power:
+    register: 142
+    unit: W
+  dc_input_power:
+    register: 144
+    unit: W
+  ac_input_power:
+    register: 146
+    unit: W
+  ac_input_voltage:
+    register: 1314
+    scale: 0.1
+    unit: V
+constants:
+  battery_chemistry: LiFePO4
+  battery_manufacturer_name: Bluetti
+  battery_manufacturer_model: PR30 V2

package/lib/csv-loader.js

@@ -1,160 +0,0 @@
-"use strict";
-
-const fs = require("fs");
-const { parse } = require("csv-parse/sync");
-
-// Column name aliases — Bluetti CSVs have been seen in English and Chinese headers.
-// Maps our internal key → list of possible header strings (case-insensitive match).
-const COL_ALIASES = {
-  field_name: ["field_name", "fieldname", "name", "字段名", "field"],
-  register_address: ["register_address", "register", "address", "addr", "reg", "no", "no.", "寄存器", "地址"],
-  data_type: ["data_type", "datatype", "type", "数据type", "数据类型"],
-  scale: ["scale", "倍率", "factor", "multiplier"],
-  offset: ["offset", "偏移"],
-  unit: ["unit", "units", "单位"],
-  signalk_path: ["signalk_path", "signalk", "sk_path", "path"],
-  register_count: ["register_count", "count", "length", "bytes", "数据长度"],
-  constant_value: ["constant_value", "constant", "const", "fixed_value", "static_value"],
-};
-
-function resolveColumn(headers, key) {
-  const aliases = COL_ALIASES[key];
-  for (const alias of aliases) {
-    const found = headers.find((h) => h.trim().toLowerCase() === alias.toLowerCase());
-    if (found) return found;
-  }
-  return null;
-}
-
-// Parse the CSV and return an array of field descriptors.
-// Each descriptor is either register-backed: { fieldName, register, count, dataType, scale, offset, unit, signalkPath }
-// or a fixed constant (register_address left blank): { fieldName, register: null, count: 0, dataType: "const", ..., constantValue }
-function loadCsv(filePath) {
-  const raw = fs.readFileSync(filePath, "utf8");
-
-  // Strip BOM if present
-  const content = raw.charCodeAt(0) === 0xfeff ? raw.slice(1) : raw;
-
-  const records = parse(content, {
-    columns: true,
-    skip_empty_lines: true,
-    trim: true,
-    comment: "#",
-    relax_column_count: true,
-  });
-
-  if (records.length === 0) throw new Error(`CSV file ${filePath} has no data rows`);
-
-  const headers = Object.keys(records[0]);
-
-  const col = {};
-  for (const key of Object.keys(COL_ALIASES)) {
-    col[key] = resolveColumn(headers, key);
-  }
-
-  if (!col.register_address) throw new Error("CSV must have a register address column");
-  if (!col.field_name) throw new Error("CSV must have a field name column");
-
-  const fields = [];
-  for (const row of records) {
-    const fieldName = (row[col.field_name] || "").trim();
-    if (!fieldName) continue;
-
-    const signalkPath = col.signalk_path ? (row[col.signalk_path] || "").trim() : "";
-    const constantRaw = col.constant_value ? (row[col.constant_value] || "").trim() : "";
-
-    const registerRaw = row[col.register_address];
-    const register = parseInt(registerRaw, 10);
-
-    if (isNaN(register)) {
-      // No register address — only valid if this row instead supplies a fixed
-      // constant (e.g. a model's nominal battery capacity or chemistry, which
-      // isn't a live register on every device). Otherwise it's a header-like
-      // row embedded in the data and gets skipped.
-      if (!constantRaw) continue;
-      // Numeric constants (e.g. a nominal capacity in Wh) need to go through
-      // the same unit conversion as register-backed fields; text constants
-      // (chemistry, manufacturer name) are left as-is.
-      const asNumber = Number(constantRaw);
-      const constantValue = Number.isNaN(asNumber) ? constantRaw : asNumber;
-      const unit = col.unit ? (row[col.unit] || "").trim() : "";
-      fields.push({ fieldName, register: null, count: 0, dataType: "const", scale: 1, offset: 0, unit, signalkPath, constantValue });
-      continue;
-    }
-
-    const dataType = col.data_type ? (row[col.data_type] || "uint16").toLowerCase().trim() : "uint16";
-    const scale = col.scale ? parseFloat(row[col.scale]) || 1 : 1;
-    const offset = col.offset ? parseFloat(row[col.offset]) || 0 : 0;
-    const unit = col.unit ? (row[col.unit] || "").trim() : "";
-
-    // register_count: for multi-register types (int32, uint32, float32 = 2 regs; int64 = 4 regs)
-    let count = col.register_count ? parseInt(row[col.register_count], 10) : NaN;
-    if (isNaN(count)) count = registersForType(dataType);
-
-    fields.push({ fieldName, register, count, dataType, scale, offset, unit, signalkPath });
-  }
-
-  if (fields.length === 0) throw new Error(`No valid register rows found in ${filePath}`);
-  return fields;
-}
-
-function registersForType(dataType) {
-  switch (dataType) {
-    case "int32":
-    case "uint32":
-    case "float32":
-      return 2;
-    case "int64":
-    case "uint64":
-      return 4;
-    default:
-      return 1; // uint16, int16, bool, enum
-  }
-}
-
-// Decode a raw register value (or pair of registers for 32-bit types) into a number.
-// rawRegs: Map<addr, uint16>, startAddr: the register address for this field
-function decodeValue(field, rawRegs) {
-  const { register, count, dataType, scale, offset } = field;
-
-  if (dataType === "const") return field.constantValue;
-
-  let raw;
-  if (count === 1) {
-    raw = rawRegs.get(register);
-    if (raw === undefined) return null;
-  } else if (count === 2) {
-    const hi = rawRegs.get(register);
-    const lo = rawRegs.get(register + 1);
-    if (hi === undefined || lo === undefined) return null;
-    raw = (hi << 16) | lo;
-  } else {
-    return null;
-  }
-
-  let value;
-  switch (dataType) {
-    case "int16":
-      value = raw > 0x7fff ? raw - 0x10000 : raw;
-      break;
-    case "int32": {
-      const signed = raw > 0x7fffffff ? raw - 0x100000000 : raw;
-      value = signed;
-      break;
-    }
-    case "float32": {
-      const tmpBuf = Buffer.alloc(4);
-      tmpBuf.writeUInt32BE(raw, 0);
-      value = tmpBuf.readFloatBE(0);
-      break;
-    }
-    case "bool":
-      return raw !== 0 ? 1 : 0;
-    default:
-      value = raw;
-  }
-
-  return value * scale + offset;
-}
-
-module.exports = { loadCsv, decodeValue };

package/registers/ac200p.csv

@@ -1,47 +0,0 @@
-# Bluetti register map example — based on AC200P / AC200MAX community reverse-engineering.
-# Replace with your device's actual CSV. Columns the plugin recognises:
-#
-#   field_name       — a standard Bluetti register name (see lib/path-mapper.js
-#                       for the ones the code already maps to a SignalK path),
-#                       or any identifier you like if you're supplying signalk_path
-#   register_address — Modbus holding register number (decimal); leave blank
-#                       for a fixed constant_value row instead (e.g. model specs)
-#   register_count   — number of 16-bit registers this field spans (1 for uint16/int16, 2 for int32/float32)
-#   data_type        — uint16 | int16 | uint32 | int32 | float32 | bool
-#   scale            — multiply raw value by this to get physical value
-#   offset           — add after scale (usually 0)
-#   unit             — V | A | W | Wh | % | °C | Hz | min — drives SignalK unit conversion
-#   signalk_path     — override; only needed for a register the code doesn't
-#                       recognise by field_name. Use {name} where the device name goes
-#   constant_value   — fixed value for a non-register row (register_address blank)
-#
-field_name,register_address,register_count,data_type,scale,offset,unit,signalk_path,constant_value
-# ── Battery ────────────────────────────────────────────────────────────────
-battery_percent,100,1,uint16,1,0,%,,
-battery_voltage,101,1,uint16,0.1,0,V,,
-battery_current,102,1,int16,0.1,0,A,,
-battery_power,103,1,int16,1,0,W,,
-battery_temperature,104,1,uint16,0.1,0,°C,,
-# ── DC / Solar input ────────────────────────────────────────────────────────
-dc_input_power,107,1,uint16,1,0,W,,
-dc_input_voltage,108,1,uint16,0.1,0,V,,
-dc_input_current,109,1,uint16,0.1,0,A,,
-# ── AC output (inverter) ────────────────────────────────────────────────────
-ac_output_power,110,1,uint16,1,0,W,,
-ac_output_voltage,111,1,uint16,0.1,0,V,,
-ac_output_current,112,1,uint16,0.1,0,A,,
-ac_output_frequency,113,1,uint16,0.1,0,Hz,,
-# ── AC input (charger / mains) ──────────────────────────────────────────────
-ac_input_power,114,1,uint16,1,0,W,,
-ac_input_voltage,115,1,uint16,0.1,0,V,,
-ac_input_current,116,1,uint16,0.1,0,A,,
-ac_input_frequency,117,1,uint16,0.1,0,Hz,,
-# ── Internal temperature ────────────────────────────────────────────────────
-internal_temperature,118,1,uint16,0.1,0,°C,,
-# ── Estimated time remaining ────────────────────────────────────────────────
-time_remaining_minutes,119,1,uint16,1,0,min,,
-# ── Fixed model facts ────────────────────────────────────────────────────────
-battery_chemistry,,,,,,,,LiFePO4
-total_capacity,,,,,,Wh,,2000
-battery_manufacturer_name,,,,,,,,Bluetti
-battery_manufacturer_model,,,,,,,,AC200P

package/registers/el100v2.csv

@@ -1,27 +0,0 @@
-# Bluetti Elite 100 V2 (EL100V2) register map
-# Source: https://github.com/Patrick762/bluetti-bt-lib
-# BaseDeviceV2 fields: BATTERY_SOC (102)
-# EL100V2-specific fields: 140, 142, 144, 146, 1314
-# Note: DEVICE_TYPE (110) and DEVICE_SN (116) are string/serial fields — omitted.
-#
-# field_name is a standard Bluetti register name — the code maps these to
-# SignalK paths on its own (see lib/path-mapper.js). signalk_path is an
-# override, only needed if you're exposing a register the code doesn't
-# recognise. constant_value is for fixed, non-register facts about this model
-# (register_address left blank for those rows).
-#
-field_name,register_address,register_count,data_type,scale,offset,unit,signalk_path,constant_value
-battery_soc,102,1,uint16,1,0,%,,
-dc_output_power,140,1,uint16,1,0,W,,
-ac_output_power,142,1,uint16,1,0,W,,
-dc_input_power,144,1,uint16,1,0,W,,
-ac_input_power,146,1,uint16,1,0,W,,
-ac_input_voltage,1314,1,uint16,0.1,0,V,,
-# ── Fixed model facts ────────────────────────────────────────────────────────
-battery_chemistry,,,,,,,,LiFePO4
-total_capacity,,,,,,Wh,,1024
-battery_manufacturer_name,,,,,,,,Bluetti
-battery_manufacturer_model,,,,,,,,Elite 100 V2
-# dc_output_power (140) only reports power, not current — this fixed nominal
-# voltage (12V accessory port) is what lib/path-mapper.js derives current from.
-dc_output_voltage,,,,,,V,,12