Skip to main content

A library for parsing Renogy BLE data

Project description

Renogy BLE

Tests Release

A Python library for communicating with Renogy Bluetooth Low Energy (BLE) devices and parsing their Modbus responses.

Overview

Library for communicating with Renogy devices over BLE using BT-1 and BT-2 Bluetooth modules for controller-style devices, plus direct BLE communication for Renogy inverters and Smart Shunt 300 devices.

Currently supported devices:

  • Renogy charge controllers (such as Rover, Wanderer, Adventurer)
  • Renogy inverters
  • Renogy Smart Shunt 300

Future planned support:

  • Renogy batteries

Installation

pip install renogy-ble

Usage

There are two common ways to use this library:

  • Parse raw Modbus response bytes (if you already handle BLE I/O elsewhere).
  • Use the built-in BLE client to connect, read, and parse data end-to-end.

Parse Raw Modbus Responses

Use this when you already have the raw Modbus response bytes and the register address you requested.

from renogy_ble import RenogyParser

# Raw BLE data received from your Renogy device
raw_data = b"\xff\x03\x02\x00\x04\x90S"  # Example data

# Parse the data for a specific model and register
parsed_data = RenogyParser.parse(raw_data, device_type="controller", register=57348)

# Use the parsed data
print(parsed_data)
# Example output: {'battery_type': 'lithium'}

Notes:

  • raw_data must include the full Modbus response, including address, function code, byte count, and CRC.
  • Parsed values may be scaled or mapped based on the register map (for example, voltages are scaled to volts).

Connect Over BLE and Read Data

The RenogyBleClient handles Modbus framing, BLE notification reads, and parsing. This example discovers a BLE device, connects, reads the default command set, and prints the parsed data.

import asyncio

from bleak import BleakScanner

from renogy_ble import RenogyBLEDevice, RenogyBleClient


async def main() -> None:
    devices = await BleakScanner.discover()
    ble_device = next(
        device for device in devices if "Renogy" in (device.name or "")
    )

    renogy_device = RenogyBLEDevice(ble_device, device_type="controller")
    client = RenogyBleClient()

    result = await client.read_device(renogy_device)
    if result.success:
        print(result.parsed_data)
    else:
        print(f"Read failed: {result.error}")


if __name__ == "__main__":
    asyncio.run(main())

Inverter Reads

Inverters use a dedicated BLE read flow. device_type="inverter" triggers the inverter-specific transport and parser path automatically.

import asyncio

from bleak import BleakScanner

from renogy_ble import RenogyBLEDevice, RenogyBleClient


async def main() -> None:
    devices = await BleakScanner.discover()
    ble_device = next(
        device for device in devices if (device.name or "").startswith("RNGRIU")
    )

    renogy_device = RenogyBLEDevice(ble_device, device_type="inverter")
    result = await RenogyBleClient().read_device(renogy_device)
    print(result.parsed_data)


if __name__ == "__main__":
    asyncio.run(main())

Smart Shunt 300 Reads

Smart Shunt 300 devices do not use the same Modbus command flow as Renogy controllers. device_type="shunt300" is handled by a dedicated notification-based client.

For one-off reads, RenogyBleClient.read_device() will automatically delegate to the shunt client:

import asyncio

from bleak import BleakScanner

from renogy_ble import RenogyBLEDevice, RenogyBleClient


async def main() -> None:
    devices = await BleakScanner.discover()
    ble_device = next(
        device for device in devices if (device.name or "").startswith("RTMShunt300")
    )

    renogy_device = RenogyBLEDevice(ble_device, device_type="shunt300")
    result = await RenogyBleClient().read_device(renogy_device)
    print(result.parsed_data)


if __name__ == "__main__":
    asyncio.run(main())

If you want the derived shunt energy totals to accumulate across repeated reads, reuse a single ShuntBleClient instance:

from renogy_ble import RenogyBLEDevice, ShuntBleClient

client = ShuntBleClient()
device = RenogyBLEDevice(ble_device, device_type="shunt300")
result = await client.read_device(device)

Custom Commands or Device IDs

You can supply your own Modbus command set or device ID if needed.

from renogy_ble import COMMANDS, RenogyBleClient

custom_commands = {
    "controller": {
        **COMMANDS["controller"],
        "battery": (3, 57348, 1),
    }
}

client = RenogyBleClient(device_id=0xFF, commands=custom_commands)

Features

  • Connects to Renogy BLE devices and reads Modbus registers
  • Connects to Renogy inverter devices and reads inverter-specific Modbus registers
  • Connects to Renogy Smart Shunt 300 devices and parses BLE notifications
  • Builds Modbus read requests with CRC framing
  • Parses raw BLE Modbus responses from Renogy devices
  • Extracts information about battery, solar input, load output, inverter status, controller status, and energy statistics
  • Returns data in a flat dictionary structure
  • Applies scaling and mapping based on the register definitions

Data Handling

Input Format

The library accepts raw BLE Modbus response bytes and requires you to specify:

  • The device type (e.g., device_type="controller")
  • The register number being parsed (e.g., register=256)

Output Format

Returns a flat dictionary of parsed values:

{
    "battery_voltage": 12.9,
    "pv_power": 250,
    "charging_status": "mppt"  # Mapped from numeric values where applicable
}

Extending for Other Models

The library is designed to be easily extensible for other Renogy device types. To add support for a new type:

  1. Update the REGISTER_MAP in register_map.py with the new device type's register mapping
  2. Create a new type-specific parser class in parser.py (if needed)
  3. Update the RenogyParser.parse() method to route to your new parser

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

References

cyrils/renogy-bt

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Project details


Release history Release notifications | RSS feed

This version

2.3.0

Download files

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

Source Distribution

renogy_ble-2.3.0.tar.gz (63.5 kB view details)

Uploaded Source

Built Distribution

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

renogy_ble-2.3.0-py3-none-any.whl (28.5 kB view details)

Uploaded Python 3

File details

Details for the file renogy_ble-2.3.0.tar.gz.

File metadata

  • Download URL: renogy_ble-2.3.0.tar.gz
  • Upload date:
  • Size: 63.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for renogy_ble-2.3.0.tar.gz
Algorithm Hash digest
SHA256 4b88fc5471ed2f97ab8ece271c5dcbd6dada44d082f1b6ae8420b0ececd39c12
MD5 165a77e88645a1574ae657d765ef6e1f
BLAKE2b-256 d6823370c946c5abf1ee3d3ae46b5ad0e5a7343be2dc24c382c01453a295df44

See more details on using hashes here.

File details

Details for the file renogy_ble-2.3.0-py3-none-any.whl.

File metadata

  • Download URL: renogy_ble-2.3.0-py3-none-any.whl
  • Upload date:
  • Size: 28.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for renogy_ble-2.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8ba9682d3cc888d7547ef176c579020418eb5cb7f88fd784a7034396c57ef9df
MD5 4390653caafa31f117c687f31b92eb28
BLAKE2b-256 d7ae0dc085d602b020291c638e750e078a6739311dc579ebd6d5f3452dd90ce8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page