Skip to content

bballdavis/hass-wattbox

ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

127 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

GitHub Activity License

hacs Project Maintenance BuyMeCoffee

Discord Community Forum

Home Assistant Wattbox Integration

A comprehensive Home Assistant integration for WattBox power management devices.

This integration provides full control and monitoring of WattBox devices through Home Assistant, featuring individual outlet control, power monitoring, and device status sensors. This integration was built around the Wattbox API v2.4, and has only been tested with the 800 series power strips.

โœจ Key Features:

  • ๐Ÿ”Œ Individual outlet control and monitoring
  • โšก Real-time power consumption tracking per outlet
  • ๐Ÿ“Š Comprehensive device sensors (voltage, current, battery status, etc.)
  • ๐Ÿ–ฅ๏ธ Easy setup through Home Assistant's UI (Config Flow)
  • ๐Ÿ”„ Automatic device discovery and configuration
  • ๐Ÿ“ฑ Modern API integration with improved reliability

Installation

HACS Installation (Recommended)

  1. Add Custom Repository:

    • Open HACS in Home Assistant
    • Go to "Integrations"
    • Click the three dots menu (โ‹ฎ) in the top right
    • Select "Custom repositories"
    • Add https://github.com/bballdavis/hass-wattbox as repository
    • Set category to "Integration"
    • Click "Add"
  2. Install the Integration:

    • Search for "WattBox" in HACS
    • Click "Download"
    • Restart Home Assistant

Manual Installation

  1. Download the latest release from GitHub
  2. Extract the custom_components/wattbox folder to your Home Assistant custom_components directory
  3. Restart Home Assistant

Configuration

Adding WattBox Devices

  1. Via UI (Recommended):
    • Go to Settings โ†’ Devices & Services
    • Click "Add Integration"
    • Search for "WattBox"
    • Enter your WattBox device details:
      • Host IP address
      • Port (default: 23)
      • Username (default: wattbox, latest firmwares for you to change this)
      • Password (default: wattbox, latest firmwares for you to change this)
      • Device name (optional)
    • Click "Submit"

Configuration Options

Option Required Default Description
host Yes - IP address of your WattBox device
port No 80 HTTP port for the WattBox web interface
username No wattbox Authentication username
password No wattbox Authentication password
name No wattbox Friendly name for the device

Available Entities

Once configured, the integration will automatically create entities for your WattBox device:

Switches

  • Individual Outlets: Control each outlet independently (switch.wattbox_outlet_1, switch.wattbox_outlet_2, etc.)
  • Master Control: Controls all outlets configured for master control on the device

Sensors

Power Monitoring (Per Outlet)

  • Power Consumption: Real-time power usage in watts (sensor.wattbox_outlet_1_power)
  • Current: Current draw in amps (sensor.wattbox_outlet_1_current)
  • Voltage: Voltage measurement (sensor.wattbox_outlet_1_voltage)

Device Status

  • Total Power: Overall device power consumption
  • Total Current: Total current draw across all outlets
  • Input Voltage: Main input voltage to the device

Binary Sensors

  • Auto Reboot: Status of auto-reboot being enabled
  • Firmware Version: Current firmware version
  • Service Tag: Easy reference for your service tag #
  • UPS Connected: Status of connection to the UPS

Usage

Outlet Control

  • Use the individual outlet switches to control specific devices
  • The master switch controls all outlets configured for master control
  • Outlet status is updated in real-time

Power Monitoring

  • Monitor individual outlet power consumption
  • Track total device power usage
  • Set up automations based on power thresholds

Safety Features

  • Monitor voltage quality with safe voltage status

โš ๏ธ Important: Be careful when controlling outlets that power networking equipment. Turning off the wrong outlet could disable remote access to your WattBox device.

Troubleshooting

Common Issues

Device Not Found:

  • Verify the IP address and port are correct
  • Ensure the WattBox is powered on and accessible on the network
  • Check that the username and password are correct

Connection Timeout:

  • Verify network connectivity between Home Assistant and the WattBox
  • Check if a firewall is blocking the connection
  • Try increasing the scan interval

Missing Entities:

  • Restart Home Assistant after installation
  • Check the Home Assistant logs for any error messages
  • Verify the WattBox firmware supports the required API endpoints

Getting Help

Contributing

Contributions are welcome! Please read our Contributing Guidelines before submitting pull requests.

Changelog

Recent Updates

  • โœ… Added Config Flow for easy UI-based setup
  • โœ… Individual power monitoring per outlet
  • โœ… Enhanced API integration with improved reliability
  • โœ… Better error handling and connection management
  • โœ… Comprehensive entity coverage for all WattBox features

Acknowledgments

This project is a comprehensive rewrite and enhancement of the original hass-wattbox integration by @eseglem. We extend our sincere gratitude for the foundation and inspiration provided by the original work.

Key improvements in this version:

  • Complete Config Flow implementation
  • Individual outlet power monitoring
  • Enhanced API client with modern architecture
  • Improved reliability and error handling
  • Comprehensive test coverage

Based on custom-components/integration_blueprint


About

Home Assistant WattBox Integration

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Contributors

Languages

  • Python 100.0%