YamBMS_Local_Packages_example.yaml

# Updated : 2026.06.29
# Version : 1.7.0
# GitHub  : https://github.com/Sleeper85/esphome-yambms

# YamBMS ( Yet another multi-BMS Merging Solution )

# This YAML is free software: you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation, either version 3
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/gpl.html>.

######################## YamBMS Remote Packages Version ########################

# You can compile this YAML directly without the `packages` folder.
# The packages will be automatically downloaded from GitHub.
# Don't forget to configure your WiFi credentials in the secrets.yaml

################################################################################

# If needed, configure a static IP here
# wifi:
#   manual_ip:
#     static_ip: 192.168.0.85
#     gateway: 192.168.0.1
#     subnet: 255.255.255.0
#     dns1: 8.8.8.8
#     dns2: 8.8.4.4

logger:
  level: INFO # VERBOSE / DEBUG / INFO / WARN
  # baud_rate: 115200 # Send logs to the `hardware_uart` USB output (this consumes a UART interface)
  # hardware_uart: UART0 # UART0 / USB_SERIAL_JTAG

ota:
  - platform: esphome

# Uncomment:
# API: to monitor entities via Home Assistant
# MQTT: to monitor entities via another system
# Neither: to monitor entities only via `web_server` or nothing

api:
  reboot_timeout: 0s

# mqtt:
#   broker: !secret mqtt_host
#   username: !secret mqtt_username
#   password: !secret mqtt_password
#   id: mqtt_client

# +--------------------------------------+
# | Global Settings                      |
# +--------------------------------------+
substitutions:
  # This project uses the `sub-device` function of ESPHome to prefix entity names.
  # This allows to group entities into logical devices that appear separately in Home Assistant.
  hostname: 'yambms' # Name of your ESPHome node registered on the IP network (DNS name must be unique)
  friendly_name : 'YamBMS' # Name of your board (prefix for board entities)
  # +--------------------------------------+
  # | YamBMS Settings                      |
  # +--------------------------------------+
  # Please read the cut-off charging logic README to understand how the YamBMS works
  yambms_id: '1' # Number without spaces
  yambms_name: 'YamBMS 1' # Prefix for YamBMS entities
  yambms_update_interval: '1s'
  # Input numbers can be displayed as a slider or an input box, options are 'slider' or 'box'.
  yambms_input_number_mode: 'slider'
  # Please check and fill in the options below correctly according to your battery chemistry and number of cells in series.
  # These parameters are important and used for charging logic.
  # Battery Chemistry
  yambms_battery_chemistry: '1' # 1-LFP | 2-Li-ion | 3-LTO
  # Number of cells in series
  yambms_cell_count: '16'
  # Bulk / Absorption Voltage : corresponds to the Bulk voltage that will be used to charge the battery. (LFP : 55.2V = 3.45V/Cell for 16S battery)
  yambms_bulk_v: '55.2'
  # Float Voltage : corresponds to the voltage at which the battery would be maintained at the end of charge. (LFP : 53.6V = 3.35V/Cell for 16S battery)
  yambms_float_v: '53.6'
  # Rebulk voltage, voltage from which a new Bulk charge can start. (LFP : 52.8V = 3.3V/Cell for 16S battery)
  yambms_rebulk_v: '52.8'
  # Maximum time in minutes that the cut-off step can last before charging is complete
  # If your cells are properly balanced this step ends at the fastest after the `cut-off timer`
  # This timer can be deactivated with a switch
  yambms_eoc_timer: '30'
  # Time in seconds during which the end of charge conditions must be respected (cut-off + cells not equalizing)
  yambms_cutoff_timer: '60'
  # Max. charge current : corresponds to the maximum charge current which may be requested by YamBMS.
  # The current requested will be proportional to the BMS count without ever exceeding this value.
  yambms_max_requested_charge_current: '300' # in Ampere
  # Max. discharge current : corresponds to the maximum discharge current which may be requested by YamBMS.
  # The current requested will be proportional to the BMS count without ever exceeding this value.
  yambms_max_requested_discharge_current: '300' # in Ampere
  # +-------------------------------------------------------------------------
  # | Temperature-based current limitation
  # | Can be disabled via the switch "Temperature-based current limitation"
  # | This factor is applied to the battery capacity (Ah), not the current 
  # | maximum charge/discharge current. For example : 280Ah x 0.5 = 140A
  # +-------------------------------------------------------------------------
  # Temperature °C -> Charge Rate (0.0C to 1.0C)
  yambms_charging_rate_table: |
    {
      { -0.1, 0.00 },
      {  0.0, 0.05 },
      {  5.0, 0.12 },
      { 10.0, 0.30 },
      { 20.0, 0.50 },
      { 25.0, 0.50 },
      { 45.0, 0.50 },
      { 50.0, 0.50 },
      { 55.0, 0.50 },
      { 60.0, 0.00 }
    }
 # Temperature °C -> Discharge Rate (0.0C to 1.0C)
  yambms_discharging_rate_table: |
    {
      {-30.0, 0.00 },
      {-20.0, 0.50 },
      {-10.0, 0.50 },
      { -5.0, 0.50 },
      {  0.0, 0.50 },
      {  5.0, 0.50 },
      { 45.0, 0.50 },
      { 50.0, 0.50 },
      { 55.0, 0.50 },
      { 60.0, 0.00 }
    }
  # +--------------------------------------+
  # | Shunt Settings                       |
  # +--------------------------------------+
  shunt_update_interval: '3s'  # frequency at which Shunt data is refreshed
  # +--------------------------------------+
  # | BMS Settings                         |
  # +--------------------------------------+
  bms_update_interval: '3s'    # frequency at which BMS data is refreshed, going below '3s' can cause problems
  # +--------------------------------------+
  # | Health & LED Assignment Logs         |
  # +--------------------------------------+
  enable_led_logging: 'false'     # Set to true to see if an led is assigned to a component correctly, logged every 60 seconds
  enable_health_logging: 'false'  # Set to true to see if component health for all component instances, logged every 60 seconds



# +--------------------------------------+
# | Packages                             |
# +--------------------------------------+

# PLEASE READ : https://github.com/Sleeper85/esphome-yambms/blob/main/documents/README/YamBMS_LP_YAML.md

packages:

  # +------------------------------------------------------------------------------+
  # | >>> UNCOMMENT YOUR BOARD
  # | >>> ONLY ONE BOARD !
  # +------------------------------------------------------------------------------+

  # This list is incomplete, other board.yaml are available in the board folder

  board: !include
    file: 'packages/board/board_ESP32_Generic.yaml'
    # file: 'packages/board/board_ESP32_Atom-Lite.yaml'
    # file: 'packages/board/board_ESP32_DevKit-V1.yaml'
    # file: 'packages/board/board_ESP32_EVB.yaml'
    # file: 'packages/board/board_ESP32_iBMS_CAN_RS485_V3.3.yaml'
    # file: 'packages/board/board_ESP32_LilyGo-T-CAN485.yaml'
    # file: 'packages/board/board_ESP32-C3_DevKitM-1.yaml'
    # file: 'packages/board/board_ESP32-C3_ETH01-EVO.yaml'
    # file: 'packages/board/board_ESP32-C3_FlipC3.yaml'
    # file: 'packages/board/board_ESP32-S3_Generic.yaml'
    # file: 'packages/board/board_ESP32-S3_AtomS3-Lite.yaml'
    # file: 'packages/board/board_ESP32-S3_AtomS3.yaml'
    # file: 'packages/board/board_ESP32-S3_AtomS3R.yaml'
    # file: 'packages/board/board_ESP32-S3_DevKitC-1_LED-38.yaml'
    # file: 'packages/board/board_ESP32-S3_DevKitC-1_LED-48.yaml'
    # file: 'packages/board/board_ESP32-S3_LilyGo-T-Connect.yaml'
    # file: 'packages/board/board_ESP32-S3_LilyGo-T-Connect-Pro.yaml'
    # file: 'packages/board/board_ESP32-S3_WS-ETH.yaml'
    # file: 'packages/board/board_ESP32-S3_WS-RS485-CAN.yaml'
    # file: 'packages/board/board_ESP32-S3_WS-Touch-LCD-4.3.yaml'
    # file: 'packages/board/board_ESP32-S3_WS-Touch-LCD-7.yaml'
    # file: 'packages/board/board_ESP32-S3_XIAO.yaml'
    # file: 'packages/board/board_ESP32-S3_YBoard.yaml'

    # vars:
    #   server_status_led_id: 'virtual_status_light' # led used to show status. Default = esp_light, set specific led or set to 'virtual_status_light' to disable
    #   network_status_led_id: 'virtual_status_light' # led used to show status. Default = esp_light, set specific led or set to 'virtual_status_light' to disable

  # +------------------------------------------------------------------------------+
  # | >>> Board Display
  # | >>> Uncomment the display that corresponds to your board
  # +------------------------------------------------------------------------------+

  # board_display: !include
  #   file: 'packages/board/board_options_display_128x128.yaml'                                # AtomS3 / AtomS3R
  #   file: 'packages/board/board_options_display_480x222.yaml'                                # LilyGo T-Connect Pro
  #   file: 'packages/board/board_options_display_lvgl_package_800x480_blue_navy_esphome.yaml' # WS Touch LCD 4.3" and 7"
  #   file: 'packages/board/board_options_display_lvgl_package_1280x720_Tab5_esphome.yaml'     # M5Stack Tab5

  #   vars:
  #     display_auto_next_page_interval: '5s'
  #     display_rotation: '0' # 0/90/180/270 rotation angle in degrees



  # +------------------------------------------------------------------------------+
  # | >>> Board Options
  # | >>> Uncomment your interfaces and options
  # +------------------------------------------------------------------------------+

  # UART 1 (uart_id: uart_esp_1)
  uart_esp_1: !include packages/board/board_options_itf_uart_esp_1.yaml
  # UART 2 (uart_id: uart_esp_2)
  # uart_esp_2: !include packages/board/board_options_itf_uart_esp_2.yaml
  # UART 3 (uart_id: uart_esp_3)
  # uart_esp_3: !include packages/board/board_options_itf_uart_esp_3.yaml

  # UART flow control
  # uart_flow_control: !include
  #   file: packages/board/board_options_itf_uart_flow_control.yaml
  #   vars:
  #     uart_id: 'uart_esp_1'
  #     uart_flow_control_pin: ${talk_pin}

  # CAN transceiver - ESP32_CAN (TJA105x, SN65HVD230, M5Stack CAN base/unit)
  canbus_node_1: !include
    file: packages/board/board_options_itf_canbus_esp32_can.yaml
    vars:
      # to bms = canbus_bms_1
      # to inverter = canbus_inverter_1
      canbus_node_id: 'canbus_inverter_1'

  # CAN transceiver - MCP2515
  # canbus_node_2: !include
  #   file: packages/board/board_options_itf_canbus_mcp2515.yaml
  #   vars:
  #     # to bms = canbus_bms_1
  #     # to inverter = canbus_inverter_1
  #     canbus_node_id: 'canbus_inverter_1'

  # PSRAM octal 80Mhz
  # psram_octal_80Mhz: !include packages/board/board_options_PSRAM_octal_80Mhz.yaml

  # Web Server
  # web_server: !include packages/yambms/yambms_web_server.yaml

  # WiFi AP @ 192.168.4.1
  # wifi_ap: !include packages/board/board_options_wifi_ap.yaml

  # Captive Portal @ 192.168.4.1
  # captive_portal: !include packages/board/board_options_captive_portal.yaml



  # +------------------------------------------------------------------------------+
  # | >>> BMS / Balancer / Shunt
  # +------------------------------------------------------------------------------+

  # You don't have to import a shunt but you must import at least one BMS.
  # You can mix different BMS models, the only condition is that the `bms_id` are numbered in order starting from 1 !

  # >>> Copy your BMS / Balancer / Shunt packages here
  # >>> You can find examples at this address :
  # >>> https://github.com/Sleeper85/esphome-yambms/tree/main/examples/single-node/



  # +------------------------------------------------------------------------------+
  # | >>> YamBMS
  # +------------------------------------------------------------------------------+

  yambms: !include packages/yambms/yambms.yaml



  # +------------------------------------------------------------------------------+
  # | >>> CAN bus to Inverter
  # +------------------------------------------------------------------------------+

  canbus1: !include
    file: packages/yambms/yambms_canbus.yaml # yambms_canbus_web_server.yaml
    vars:
      canbus_id: '1' # Must be a number
      canbus_name: 'CANBUS 1'
      canbus_node_id: 'canbus_inverter_1' # CAN bus node to which your inverter is connected
      canbus_status_led_id: 'esp_light' # LED used to show status; default = esp_light, comment out to disable
      # CAN frames sending will be paused for `30s` if the inverter does not respond with an ACK (can_id 0x305) before the end of the `canbus_link_timer` (5s by default).
      canbus_link_timer_enabled: 'true' # Set it to 'false' if your inverter/charger is not sending ACK (can_id 0x305) every `1s` as specified by the protocol
      canbus_link_timer: '5s'
      canbus_extended_ack: 'false' # Set to 'true' for enable extended 29-bit IDs for the ACK can_id 0x305 (required for Schneider XW Pro)



  # +------------------------------------------------------------------------------+
  # | >>> RS485 bus to Inverter
  # +------------------------------------------------------------------------------+

  # rs485_pylon: !include
  #   file: packages/yambms/yambms_rs485_pylon.yaml # yambms_rs485_pylon_web_server.yaml
  #   vars:
  #     rs485_id: '1' # Must be a number
  #     rs485_name: 'RS485 1'
  #     rs485_uart_id: 'uart_esp_3' # UART interface to which your inverter is connected
  #     rs485_uart_baud_rate: '9600'
  #     rs485_update_timeout: '10s'
  #     rs485_status_led_id: 'esp_light' # LED used to show status; default = esp_light, comment out to disable



  # +------------------------------------------------------------------------------+
  # | >>> DEBUG ( logger level must be DEBUG )
  # +------------------------------------------------------------------------------+

  device_debug: !include
    file: packages/base/device_debug_ESP32.yaml
    # file: packages/base/device_debug_ESP32_PSRAM.yaml
    vars:
      debug_name: 'Debug'
      debug_update_interval: '5s'
      # Size of your PSRAM in bits
      # 8Mb='8388608' | 6Mb='6291456' | 4Mb='4194304' | 2Mb='2097152' | NoPSRAM='0'
      debug_psram_size: '8388608'



  # +------------------------------------------------------------------------------+
  # | >>> Add your custom packages below
  # +------------------------------------------------------------------------------+

  # Custom packages
  # yambms_custom: !include yambms_custom.yaml

# +------------------------------------------------------------------------------+
# | >>> Add your custom YAML below
# +----- -------------------------------------------------------------------------+

# Custom YAML