Skip to content

Home

Jump to bottom
flip555 edited this page Sep 28, 2023 · 3 revisions

BMS Connector Integration for Home Assistant Wiki

Table of Contents

Introduction

Welcome to the BMS Connector integration for Home Assistant. This integration provides support for interfacing with various Battery Management Systems (BMS), not limited to Seplos, via RS485-USB or other connection methods.

Installation

Via HACS (Home Assistant Community Store) as a Custom Repository

  1. Make sure HACS is installed.
  2. Go to the HACS Integrations page.
  3. Click on the three dots in the upper right corner and select "Custom repositories."
  4. Enter the URL https://github.com/flip555/bms_connector and choose "Integration" in the category dropdown.
  5. Click "Add."
  6. You will now find "BMS Connector" in the Integrations list within HACS. Simply install it.

Manual Installation

  1. Clone this repository or download the zip file.
  2. Transfer the bms_connector folder from the repository into the custom_components directory within your Home Assistant configuration.
  3. Restart Home Assistant.

Configuration

Follow these steps to configure the BMS Connector integration for Home Assistant:

Step 1: Confirm Old Entries

Before proceeding, please ensure that you have deleted any old entries added via the 'seplos_bms_ha' addon. Keeping old entries may lead to sensor naming conflicts with the new version. Any data stored in the old sensors should be automatically adopted by the new addon.

  1. Confirm that you have deleted any old entries from the 'seplos_bms_ha' addon.

  2. Check the box below to confirm.

    • I confirm I have deleted old entries.

  3. Click "Next" to continue.

Step 2: Select BMS Type

Please select your BMS version from the list below. If your BMS is not listed, it is currently not supported. You can request support on our GitHub repository.

  1. Choose your BMS type from the dropdown list.

    • BMS Type: [Dropdown]

  2. Click "Next" to proceed.

Step 3: Configure Connection Port

Enter the connection port for your BMS. For example, use '/dev/ttyUSB0' for local serial connections. ESPHome and Bluetooth connection ports may become available in the future.

  1. Enter your connection port in the field below.

    • Connection Port: [Field]

  2. Click "Next" to move on.

Step 4: Set Battery Address and Sensor Prefix

Please enter your battery address and desired sensor naming prefix. All sensors will automatically include the battery address as part of their names, and this cannot be removed.

  1. Enter your battery pack address in the field below.

    • Battery Address: 0x00

  2. Enter your desired sensor prefix in the field below.

    • Sensor Prefix: Seplos BMS HA

  3. Click "Finish" to create the configuration entry.

That's it! Your BMS Connector integration is now configured and ready to use with Home Assistant.

Usage

This section provides information on how to use the integration once it's set up. Describe the available entities, services, and how users can access telemetry data, alarm data, and more.

Troubleshooting

Here, you'll find solutions to common issues that users might encounter, such as:

  • Invalid USB Port: Ensure that the port starts with "/dev/ttyUSB" and ends with a single digit.
  • Other Issues: List and address any other potential problems users may face.

Contributing

If you want to contribute to this project, please follow these guidelines:

  • Report bugs and request new features on the GitHub issues page.
  • Follow coding and documentation standards specified in the project's repository. Your contributions are welcome and appreciated!
Clone this wiki locally