User Tools

Site Tools


vrm_portal:vrm_juice_json_api_notes

This is an old revision of the document!


VRM JSON Juice API notes (DEPRECATED!)

The VRM Juice API has been deprecated in favor of the VRM v2 API. See new API documentation here:

https://vrmapi.victronenergy.com/v2/docs

Introduction

The Juice API can be used to request data from the VRM database, using JSON. On this page there are usage notes as well as an example. The formal API documentation is found here: https://juice.victronenergy.com/build/apidoc/.

An example PHP file is here: vrm_juice_php_example.

A Wordpress blog that uses the API to show actual solar yield in Watts as well as a complete system status is here: http://lackancottage.co.uk/about-us/off-grid/.

And the source code of the iOS and Android VRM apps, also using the Juice API, are here:

idDataAttribute vs code

When parsing results, do not use the idDataAttribute. Use the code instead.

Formatting values, and adding a unit (ie. V or W)

the API will reply with a format string, usable by many programming languages. For PHP see printf

Juice backend work list

  1. Make it clear that sites/attributes is deprecated, since idDataAttribute is in the input. The new one is sites/get_attributes_by_code.

Postman App for Chrome: useful to test!

DISQUS

vrm_portal/vrm_juice_json_api_notes.1478698252.txt.gz · Last modified: 2016-11-09 14:30 by mvader