Skip to main content

mk2vsc

tests PyPI license

Read, validate, decode, diff, edit and qualify Victron VEConfigure .rvms configuration files without VEConfigure, on any operating system, from Python or the command line.

The problem

Victron MultiPlus and Quattro inverter/chargers are configured with VEConfigure and VE.Bus System Configurator. Those tools run only on Windows. VictronConnect is replacing them but does not support assistants (ESS, AC PV and the rest), so anyone maintaining a real installation still needs a Windows machine or a virtual machine. The configuration itself travels as a small binary file: .rvsc for a single unit, .rvms for parallel and multi-phase systems, downloaded and uploaded through VRM's Remote VEConfigure. A Victron Community thread titled "RVSC File Format Specification" asked Victron to publish the format so people could write their own editors; it received no answer. As of September 2026 we found no open-source parser, specification or editor for these files anywhere.

We operate four two-inverter systems and needed to change charge voltages and Virtual Switch thresholds on them remotely, repeatably, and with a record of what changed. This repository is what we built to do that, together with everything we learned about the file along the way.

What this is

  • A zero-dependency Python 3.9+ library and a CLI (mk2vsc) that:
    • parses the file's section structure and verifies every integrity checksum,
    • decodes the per-inverter settings array into labelled values with a confidence level per field,
    • compares two files by inverter serial and tells you whether they differ only in bookkeeping,
    • edits settings in place, self-verifies that nothing else changed, and never changes file length,
    • qualifies a file against the values you intended before you upload and after you re-download,
    • mines a library of archived downloads into a dated, per-inverter change log (mk2vsc history).
  • A corpus of 84 real device files with a manifest, and a test suite that checks every documented claim against that corpus (475 tests).
  • A written account of the format as we understand it, and of what we do not understand.

What this is not

  • It does not upload anything. You upload through VRM, exactly as before.
  • It does not install assistants (ESS and others) as a supported operation. The experimental graft and upload-form transform are included under mk2vsc.experimental, gated, and have never produced a running system; docs/ESS_INJECTION.md is the complete record for anyone who wants to pick that up.
  • It does not touch grid codes or the dealer password that protects them.
  • It is not affiliated with or endorsed by Victron Energy.

Status and confidence

Capability Status Evidence
Section grammar and integrity checksum Proven Validates on every section of all 84 fixture files (107 counting archive duplicates); edited files accepted by the device on 4 systems
Settings array = VE.Bus setting IDs at +0x59 + 2n High Reference IDs reproduce 120 V output, 50.0 A limit, 95 %/98 % SoC, grid-code flag on all 162 blocks of the 81 well-formed fixtures
Field table (190 entries) Partial 4 CONFIRMED, 10 HIGH, 9 MEDIUM, 19 LOW, 20 UNKNOWN named; the rest unnamed
Guarded writer (mk2vsc edit) Proven live Absorption, float and Virtual Switch thresholds written and read back on 4 systems, July to August 2026
By-serial diff (mk2vsc diff) Proven Consecutive downloads, including a pair whose blocks swapped position, classify as bookkeeping only
Checker (mk2vsc check) Proven Reproduces the incident that motivated it (a rollback that reverted a charge-voltage fix)
Assistant area Read only Record structure and stub signature recognised; record bodies not understood
Upload-form (GUI export) files Read only Detected and decoded; the writer refuses them
ESS injection (mk2vsc experimental) Experimental, never ran Graft and device-to-upload-form transform reproduce the August 2026 files byte-for-byte; the device stored them, the system never started

The confidence vocabulary (CONFIRMED, HIGH, MEDIUM, LOW, UNKNOWN) is defined in mk2vsc/fields.py and docs/FIELDS.md. The writer edits CONFIRMED and HIGH fields; anything lower needs an explicit override.

Install

pip install mk2vsc

Or from source, with the fixture corpus and tests:

git clone https://github.com/kylehart/mk2vsc.git && cd mk2vsc
python3 -m venv .venv && .venv/bin/pip install -e ".[test]"
.venv/bin/pytest          # 475 tests against the fixture corpus

Quickstart: one download, one change

Download the file from VRM (Device list, Remote VEConfigure, Download). Then:

mk2vsc show download.rvms
download.rvms: 5055 bytes, 2 inverter(s), form=device, checksums OK
  HQ2414AXENJ: firmware 2729560, saved 2026-07-20T18:41:22+00:00, assistant: no assistant
  HQ2414U6FVN: firmware 2729560, saved 2026-07-20T18:41:28+00:00, assistant: no assistant
  Charger
    absorption_V        Absorption voltage       57.6 V    56 V   <- inverters differ
    float_V             Float voltage            55.2 V    54 V   <- inverters differ
    charge_current_A    Charge current             35 A    35 A
    ...

Change what needs changing. The output is written next to the input; the input is never touched:

mk2vsc edit download.rvms absorption=56.8 float=54.0
  HQ2414AXENJ  absorption_V   57.6 -> 56.8 V
  HQ2414U6FVN  absorption_V   56.0 -> 56.8 V
  HQ2414AXENJ  float_V        55.2 -> 54.0 V
  HQ2414U6FVN  float_V        54.0 -> 54.0 V (unchanged)

wrote download.edited.rvms
verified: only those bytes and their section checksums changed; the input file is untouched.

Next:
  1. VRM > Device list > Remote VEConfigure > Upload: download.edited.rvms
  2. Download again from the same page.
  3. mk2vsc verify download.edited.rvms <the new download>

After the upload, prove the device took exactly your change and nothing else, and that the values are what you intended on both inverters:

mk2vsc verify download.edited.rvms redownload.rvms
mk2vsc check  redownload.rvms --expect absorption=56.8 float=54.0

That is the whole loop. show, edit, verify, check; plus diff for any two files, history for a folder of old downloads, validate, fields, and experimental (read docs/ESS_INJECTION.md first). Field names take aliases (absorption, float, charge_current, ac_limit, low_shutdown, vs_entry, vs_return, capacity), full names from mk2vsc fields, or VE.Bus setting IDs.

From Python, the same loop:

import mk2vsc

cfg = mk2vsc.load("download.rvms")
print(cfg["HQ2414U6FVN"]["absorption"])        # 56.0
cfg.set("absorption", 56.8)                      # every inverter
cfg.set("float", 54.0)
path = cfg.save()                                # download.edited.rvms
# upload through VRM, download again, then:
ok, report = mk2vsc.verify(path, "redownload.rvms")
ok, results = mk2vsc.load("redownload.rvms").check(absorption=56.8, float=54.0)

When you run a fleet: the change-control loop

Uploading a file replaces the whole configuration of every inverter in the system. These five steps are how we make that safe; docs/CHANGE_CONTROL.md explains each one and the incident behind it.

  1. Download a fresh file from VRM (Remote VEConfigure) into 00_baseline/. Never start from an archived copy: the device rejects stale save timestamps, and old files carry old values.
  2. mk2vsc edit the baseline into 01_prepared/, then mk2vsc check it against the values you intend (on the command line, or an intent file that lives outside the file under test).
  3. Upload 01_prepared/ through VRM.
  4. Download again into 02_downloaded/.
  5. mk2vsc verify prepared against downloaded and mk2vsc check the download. "Success" in the upload dialog is not the same as "the settings are right".

Corpus and tests

The fixtures/ directory holds 84 unique files from 4 split-phase MultiPlus systems (8 inverters, firmware 2729560, format version 1.33) collected between June and September 2026, including device downloads, GUI exports, files our tools produced, and three deliberately broken files kept as negative controls. fixtures/manifest.json records each file's hash, origin, state and inverters. The tests in tests/ check structure, checksums, byte-exact round trips, every documented field claim, the writer, the diff, the qualifier and the CLI against that corpus. docs/QA.md describes how to verify the same things on your own system before trusting the tool with it.

Documentation

File Contents
docs/FORMAT.md The file format as we understand it: sections, checksum, unit block layout, device vs upload form, assistant area
docs/FIELDS.md The settings table: every field's offset, label, scale, confidence, presumed purpose and evidence
docs/CHANGE_CONTROL.md The baseline / prepared / downloaded pattern, the rules, and the incidents that produced them
docs/WORKFLOW.md Working with VRM Remote VEConfigure, and what still needs the Windows GUI
docs/SAFETY.md Responsible use, the proven-safe surface, recovery, first-use protocol
docs/QA.md How to decide whether to trust this: the test suite, the corpus, and a verify-it-yourself recipe
docs/ASSISTANTS.md What we know and do not know about ESS and other assistants in the file
docs/ERRORS.md What mk2vsc-36, mk2vsc-47, mk2vsc-49, Error 1303 and the VE.Bus errors mean
docs/HISTORY.md How this came to be, in order, including the things we got wrong
docs/ESS_INJECTION.md The ESS-by-file experiment in full: what a GUI install writes, every attempt, hypotheses, the next test
docs/FIXTURES.md What every file in the corpus is
docs/PRACTICES.md How the project is run: public record, evidence rules, safety rules, AI-assistance disclosure

Limits and unknowns

  • We hold files from one firmware (2729560), one format version (1.33), one product family, one topology (two inverters, split phase). Other hardware may differ; the tests will tell you.
  • We have no .rvsc single-unit files and no three-phase or three-plus-unit files.
  • About two thirds of the settings array is unnamed or named with low confidence. docs/FIELDS.md lists what each value looks like even where we cannot say what it does.
  • The assistant record bodies, the 4001-byte BareSettingInfo section and parts of the block header are not understood. docs/FORMAT.md keeps an explicit Observed / Inferred / Unknown list.
  • Installing an assistant by file has never produced a running system for us. docs/ASSISTANTS.md records each attempt and its outcome so nobody has to repeat them on live hardware.

How to help

The most useful contributions are files and controlled pairs, not code:

  • A download, one setting changed in VEConfigure, and a second download, plus a screenshot of the VEConfigure tab showing the value. One such pair names a field for everyone.
  • Files from other hardware: Quattro, other firmware, three-phase, single-unit .rvsc.
  • Running the verify-it-yourself recipe in docs/QA.md on your system and reporting what happened.

See CONTRIBUTING.md for how to add a fixture and what the privacy expectations are.

License and responsible use

MIT, see LICENSE. This tool is for people who are already responsible for, and authorized to configure, the systems they apply it to. It produces files; the decision to upload one, and the consequences on a live battery system, remain yours. Read docs/SAFETY.md first.

How this project is run

Every change goes through a public pull request, every open question is a labelled issue, and every format claim is tied to a test on real files. The project is developed with AI assistance, disclosed in commits and in docs/PRACTICES.md.

Acknowledgements

  • Victron's public document "Interfacing with VE.Bus products, MK2 Protocol 3.14" names settings 0 to 65, every flag bit, and the setting-info record that turned out to be the BareSettingInfo section.
  • github.com/xcellsior/ve-bus-programming documented the VE.Bus setting IDs and scales over the MK2/MK3 protocol before we found the Victron document; it is what led us to the setting-ID mapping.
  • The Victron Community threads on .rvsc/.rvms files, Remote VEConfigure and the "switch as group" error saved us time and confirmed the demand for this work.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mk2vsc-0.4.0.tar.gz (64.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mk2vsc-0.4.0-py3-none-any.whl (55.6 kB view details)

Uploaded Python 3

File details

Details for the file mk2vsc-0.4.0.tar.gz.

File metadata

  • Download URL: mk2vsc-0.4.0.tar.gz
  • Upload date:
  • Size: 64.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for mk2vsc-0.4.0.tar.gz
Algorithm Hash digest
SHA256 57125563fa4f3e43e84c3f65d1ad02218a688967e7add165a771ff258a1422ad
MD5 3ae3b20a976e6f313723feae8eac0192
BLAKE2b-256 775e3ec6a5118d22143059dabb54b40c9a8b2577488af2dce898893adc38d4eb

See more details on using hashes here.

Provenance

The following attestation bundles were made for mk2vsc-0.4.0.tar.gz:

Publisher: release.yml on kylehart/mk2vsc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mk2vsc-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: mk2vsc-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 55.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for mk2vsc-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f2b929c9cfcad60458f91793dac012c1a852f054499a497d9621df6e2b678670
MD5 1502932cd9737e7cc569ad819996d244
BLAKE2b-256 9754a21c7a54735cd37064bb72f0c838fc3239efa8e7462bbbb9263b6352ccdf

See more details on using hashes here.

Provenance

The following attestation bundles were made for mk2vsc-0.4.0-py3-none-any.whl:

Publisher: release.yml on kylehart/mk2vsc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.10.0

2 files

0.9.0

2 files

0.8.0

2 files

0.7.0

2 files

0.6.0

2 files

0.5.1

2 files

0.5.0

2 files

0.4.1

2 files

This release

0.4.0 This release

2 files

0.3.0

2 files

0.2.1

2 files

0.2.0

2 files

0.1.2

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page