Skip to main content

OCF VRMAPI

ease of contribution: easy

Python client for interacting with the Victron VRM portal (http://vrm.victronenergy.com)

This repo is being maintained by OCF because the original was not being maintained by Victron.

Installation

$ pip install ocf_vrmapi

Examples

>> from ocf_vrmapi.vrm import VRM_API
>> api = VRM_API(username='vrm_username', password='vrm_password')
>> api.get_user_sites(api.user_id)

>>{u'records':
      [{u'accessLevel': 1,
      u'device_icon': u'solar',
      u'geofence': None,
      u'geofenceEnabled': False,
      u'idSite': 4470,
      u'idUser': 5155,
      u'identifier': u'6cecebc2d7de',
      u'name': u'Mukuyu HC',
      u'owner': True,
      u'pvMax': 1458,
      u'reports_enabled': True,
      u'timezone': u'Africa/Kigali'}],
  u'success': True}


>> api.get_consumption_stats(inst_id=4470) 

>>{u'records': {u'Bc': [[1473681210000, 0.018203735351562],
   [1473692010000, 0.018211364746094],
   [1473695610000, 0.036407470703125],
   [1473699210000, 0.054611206054688],
   [1473702810000, 0.054611206054688],
   [1473706410000, 0.054611206054688],
   [1473710010000, 0.054618835449219],
   [1473713610000, 0.054611206054688],
   [1473717210000, 0.036415100097656],
   [1473720810000, 0.054603576660156],
   [1473724410000, 0.054618835449219],
   [1473728010000, 0.054611206054688],
   [1473731610000, 0.054618835449219],
   [1473735210000, 0.018203735351562],
   [1473738810000, 0.018203735351562]],
  u'Gc': False,
  u'Pc': [[1473681210000, 0.018218994140625],
   [1473684810000, 0.018203735351562],
   [1473688410000, 0.036376953125],
   [1473692010000, 0.018218994140625],
   [1473742410000, 0.054641723632812],
   [1473746010000, 0.0181884765625]],
  u'gc': False},
 u'success': True,
 u'totals': {u'Bc': 0.63716125488281,
  u'Gc': False,
  u'Pc': 0.16384887695312,
  u'gc': False}}

Metadata

Release files for ocf-vrmapi 0.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ocf-vrmapi 0.1.4
File Size Uploaded
ocf_vrmapi-0.1.4.tar.gz 6.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ocf-vrmapi 0.1.4
File Interpreter ABI Platform
ocf_vrmapi-0.1.4-py3-none-any.whl Python 3 none any Details

Total release size: 13.4 kB

Release files / ocf_vrmapi-0.1.4.tar.gz

Download URL ocf_vrmapi-0.1.4.tar.gz
Size 6.8 kB
Tags Source
SHA-256 checksum
How to use checksums
712edc7d5fad0e4436605ccb87ede659e25b99459adace20053707336f100748
BLAKE2b-256 checksum
How to use checksums
f180a348cc9d2a1602020d2caebdf6830b317c64ec206d9a4a646f557d0df6da
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.20

Release files / ocf_vrmapi-0.1.4-py3-none-any.whl

Download URL ocf_vrmapi-0.1.4-py3-none-any.whl
Size 6.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0fe723cd107aee5fa968f271ab66aeb52aaeeab406546dad6151344d962ca73f
BLAKE2b-256 checksum
How to use checksums
f577d2916f51b07466d905b5369dec45ce8600cde7c2c33473d144f9ec587f69
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.20

Release history Release notifications | RSS feed

This release

0.1.4 This release

2 release 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