Skip to content

BatteryPoweredDevice.md

Latest commit

 

History

History
37 lines (27 loc) · 1.28 KB

BatteryPoweredDevice.md

File metadata and controls

37 lines (27 loc) · 1.28 KB

Generic BLE Device which provides battery information

This module can be used in combination with other modules to add battery information. This way, you will know when you need to replace your ble beacons battery.

Please replace FF:FF:FF:FF:FF:FF as well as ffffffffffff with your devices mac.

Device Config Entry

{
  "type": "BatteryPoweredDevice",
  "friendlyName": "Keychain Beacon",
  "mac": "FF:FF:FF:FF:FF:FF",
  "pollingInterval": 300000,
  "pollOnStartup": false,
  "disconnectAfterFetch": true,
  "maxDelayAfterConnect": 8000
}

pollingInterval the interval this module will use to fetch battery information in milliseconds

If pollOnStartup is set to true, the first polling will happen 1s after startup.

disconnectAfterFetch determine if this module should disconnect after fetching battery information Beacons will usually stop advertising while being connected so not disconnecting might break things

maxDelayAfterConnect maximum time to wait for the battery interface to become available in milliseconds

MQTT

Autoconfig

The device will attempt to autoconfigure Home Assistant for state information on homeassistant/sensor/bat_ffffffffffff/config

State

cybele/battery_powered_ble_device/ffffffffffff/state provides the current battery percentage