Skip to content

mase1981/uc-intg-bond

Repository files navigation

Bond Integration for Unfolded Circle Remote 2/3

Control your Bond-connected ceiling fans, fireplaces, and other RF/IR devices directly from your Unfolded Circle Remote 2 or Remote 3 with PIN-based authentication, auto-discovery, and full device support.

Bond GitHub Release License GitHub issues Community Forum Discord GitHub Downloads (all assets, all releases) Buy Me A Coffee PayPal Github Sponsors

Features

This integration provides comprehensive control of Bond-connected devices through the Bond Local API, delivering seamless integration with your Unfolded Circle Remote for complete RF/IR device control.


❤️ Support Development ❤️

If you find this integration useful, consider supporting development:

GitHub Sponsors Buy Me A Coffee PayPal

Your support helps maintain this integration. Thank you! ❤️

🎛️ Device Control

Ceiling Fans (CF)

  • Power Control - Turn on/off, toggle
  • Speed Control - Adjust fan speed (multiple levels)
  • Direction Control - Reverse fan direction
  • Light Control - Integrated light on/off and toggle

Fireplaces (FP)

  • Power Control - Turn on/off, toggle
  • Flame Control - Adjust flame height
  • Fan Control - Blower fan speed adjustment

Motorized Shades (MS)

  • Position Control - Open/close, position adjustment
  • Stop Command - Stop movement at current position

Lights (LT)

  • Power Control - On/off, toggle
  • Brightness Control - Adjust light brightness levels

Generic Devices (GX)

  • Power Control - Basic on/off and toggle
  • Action Support - All available device actions

🔐 Authentication & Discovery

PIN-based Authentication

  • Secure Setup - Using your Bond device's PIN
  • Automatic Unlock - Integration unlocks Bond device with PIN
  • Token Management - Secure token storage for future use

Auto-discovery

  • Network Discovery - Automatically find Bond hubs on local network
  • Device Discovery - All configured devices automatically discovered
  • Real-time Updates - Periodic polling for device state

🎮 Remote Control Entity

Multi-Page UI

  • Main Page - Overview with all devices and quick controls
  • Device Pages - Individual pages for each device
  • Clear Labels - Device-specific UI with descriptive text
  • Organized Controls - Grouped by function for easy access

Physical Button Mapping

  • Power Button - Primary device power toggle
  • Volume Buttons - Fan speed or level control
  • Channel Buttons - Available for custom mapping

Protocol Requirements

  • Protocol: Bond Local HTTP API v2
  • Network Access: Bond hub must be on same local network
  • Authentication: 4-digit PIN from device label
  • Connection: Direct HTTP communication with command throttling
  • Polling: 30-second interval for state updates

Network Requirements

  • Local Network Access - Integration requires same network as Bond hub
  • HTTP Protocol - Bond Local API
  • Static IP Recommended - Bond hub should have static IP or DHCP reservation
  • Firewall - Must allow HTTP traffic

Installation

Option 1: Remote Web Interface (Recommended)

  1. Navigate to the Releases page
  2. Download the latest uc-intg-bond-<version>-aarch64.tar.gz file
  3. Open your remote's web interface (http://your-remote-ip)
  4. Go to SettingsIntegrationsAdd Integration
  5. Click Upload and select the downloaded .tar.gz file

Option 2: Docker (Advanced Users)

The integration is available as a pre-built Docker image from GitHub Container Registry:

Image: ghcr.io/mase1981/uc-intg-bond:latest

Docker Compose:

services:
  uc-intg-bond:
    image: ghcr.io/mase1981/uc-intg-bond:latest
    container_name: uc-intg-bond
    network_mode: host
    volumes:
      - </local/path>:/data
    environment:
      - UC_CONFIG_HOME=/data
      - UC_INTEGRATION_HTTP_PORT=9090
      - UC_INTEGRATION_INTERFACE=0.0.0.0
      - PYTHONPATH=/app
    restart: unless-stopped

Docker Run:

docker run -d --name uc-bond --restart unless-stopped --network host -v bond-config:/app/config -e UC_CONFIG_HOME=/app/config -e UC_INTEGRATION_INTERFACE=0.0.0.0 -e UC_INTEGRATION_HTTP_PORT=9090 -e PYTHONPATH=/app ghcr.io/mase1981/uc-intg-bond:latest

Configuration

Step 1: Prepare Your Bond Device

IMPORTANT: Bond hub must be powered on and connected to your network before adding the integration.

Find Your Bond IP Address:

  1. Router Admin Panel: Check connected devices (recommended: set static IP)
  2. Bond App: Look in device settings
  3. Network Scanner: Use tools like Advanced IP Scanner
  4. Command Line:
    # Windows
    arp -a | findstr "b0-ce-18"
    
    # Linux/Mac
    arp -a | grep "b0:ce:18"

Find Your Bond PIN:

  • Look for a 4-digit number on a sticker on your Bond device (usually on the bottom or back)

Network Setup:

  • Wired Connection: Recommended for stability
  • Static IP: Recommended via DHCP reservation
  • Firewall: Allow HTTP traffic
  • Network Isolation: Must be on same subnet as Remote

Step 2: Setup Integration

  1. After installation, go to SettingsIntegrations
  2. The Bond integration should appear in Available Integrations
  3. Click "Configure" to begin setup:

Configuration:

  • Bond IP Address: Enter Bond hub IP (e.g., 192.168.1.100)
  • Bond PIN: Enter 4-digit PIN from device label
  • Click Complete Setup

Authentication Process:

  • Integration unlocks Bond device using PIN
  • Secure token obtained and stored
  • All configured devices discovered
  • Remote control entities created
  1. Integration will create entities:
    • Remote: remote.bond_[device_name] for each device
    • Main Remote: Overview page with all devices

Using the Integration

Remote Control Entities

The integration creates remote entities with multiple pages:

  • Main Page: Overview with all devices and quick controls

    • Device names above control buttons
    • "Turn On", "Turn Off", "Toggle" for each device
  • Device Pages: Individual pages for each device

    • Power Controls: Turn On, Turn Off, Power Toggle
    • Level Controls: Speed +/-, Flame +/-, Brightness +/-
    • Light Controls: Light On/Off, Light Toggle
    • Other Controls: Direction, Timer, Stop, etc.

Physical Button Mapping

  • Power Button: Primary device power toggle
  • Volume Up/Down: Fan speed or level control
  • Channel Buttons: Available for custom mapping

Supported Device Types

Type Description Controls
Ceiling Fans (CF) Power, speed, direction, light Full control
Fireplaces (FP) Power, flame, fan Full control
Motorized Shades (MS) Open/close, position Full control
Lights (LT) On/off, brightness Full control
Generic (GX) Basic controls Available actions

Credits

  • Developer: Meir Miyara
  • Bond: RF/IR device control platform
  • Unfolded Circle: Remote 2/3 integration framework (ucapi)
  • Protocol: Bond Local HTTP API v2
  • Community: Testing and feedback from UC community

License

This project is licensed under the Mozilla Public License 2.0 (MPL-2.0) - see LICENSE file for details.

Support & Community


Made with ❤️ for the Unfolded Circle and Bond Communities

Thank You: Meir Miyara

About

Custom integration to control your BOND smart devices via Unfolded Circle Remote

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors