Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/squazel/homeassistant-fibaro-intercom

Home Assistant custom integration for Fibaro Intercom devices, enabling local control and monitoring through Home Assistant.
https://github.com/squazel/homeassistant-fibaro-intercom

fibaro hacs home-assistant integration intercom

Last synced: 3 months ago
JSON representation

Home Assistant custom integration for Fibaro Intercom devices, enabling local control and monitoring through Home Assistant.

Awesome Lists containing this project

README 

          
# FIBARO Intercom Integration for Home Assistant



[![Code Quality](https://github.com/Squazel/homeassistant-fibaro-intercom/actions/workflows/quality.yml/badge.svg)](https://github.com/Squazel/homeassistant-fibaro-intercom/actions/workflows/quality.yml)

[![Tests](https://github.com/Squazel/homeassistant-fibaro-intercom/actions/workflows/tests.yml/badge.svg)](https://github.com/Squazel/homeassistant-fibaro-intercom/actions/workflows/tests.yml)

[![HACS](https://github.com/Squazel/homeassistant-fibaro-intercom/actions/workflows/hacs.yml/badge.svg)](https://github.com/Squazel/homeassistant-fibaro-intercom/actions/workflows/hacs.yml)

[![hassfest](https://github.com/Squazel/homeassistant-fibaro-intercom/actions/workflows/hassfest.yml/badge.svg)](https://github.com/Squazel/homeassistant-fibaro-intercom/actions/workflows/hassfest.yml)

[![CodeQL](https://github.com/Squazel/homeassistant-fibaro-intercom/actions/workflows/codeql.yml/badge.svg)](https://github.com/Squazel/homeassistant-fibaro-intercom/actions/workflows/codeql.yml)



A custom Home Assistant integration for controlling and monitoring FIBARO Intercom devices over their JSON-RPC 2.0 WebSocket API.



## Features



- **Real-time Connection**: Persistent WebSocket connection with automatic reconnection

- **Relay Control**: Open door/gate relays with optional timeout

- **Doorbell Monitoring**: Real-time doorbell press detection

- **Camera Integration**: Access to live video stream and still images

- **Event Handling**: Home Assistant events for doorbell presses

- **Custom Lovelace Card**: Unified dashboard card with camera and controls

- **Robust Error Handling**: Comprehensive error handling and logging



## Installation



### HACS (Recommended)



1. Open HACS in Home Assistant

2. Go to "Integrations"

3. Click the three dots in the top right corner

4. Select "Custom repositories"

5. Add this repository URL: `https://github.com/Squazel/homeassistant-fibaro-intercom`

6. Select "Integration" as the category

7. Click "Add" and close the dialog

8. Locate Fibaro Intercom in the list of repositories and Download it

9. Restart Home Assistant



### Manual Installation



1. Copy the `custom_components/fibaro_intercom` folder to your Home Assistant `custom_components` directory

2. Restart Home Assistant



## Configuration



### Via UI



1. Go to Settings → Devices & Services → Integrations

2. Click "Add Integration"

3. Search for "FIBARO Intercom"

4. Enter your intercom details:

   - **Host**: IP address or hostname

   - **Port**: WebSocket port (default: `8081`)

   - **Username**: Local account username

   - **Password**: Local account password



### Configuration Options



After setup, you can modify these options:

- Port number

- Credentials

- TLS verification settings

- Camera stream URLs



## Entities Created



### Binary Sensors

- **FIBARO Intercom Connection Status**: Shows if the integration is connected to the intercom

- **FIBARO Intercom Relay 0**: Shows the state of the first relay (on = relay is open/activated)

- **FIBARO Intercom Relay 1**: Shows the state of the second relay (on = relay is open/activated)



### Camera

- **FIBARO Intercom Camera**: Real-time video feed from the intercom camera

- **Still Images**: Snapshot capability



### Device Triggers

- **Doorbell Pressed**: Fires when the doorbell button is pressed (recommended for automations)



## Custom Lovelace Card



The integration includes a custom Lovelace card that provides a unified interface for your intercom. The card combines camera viewing with relay controls in a single, easy-to-use dashboard widget.



### Card Setup



**Automatic Setup (Default):**

The custom card is automatically available after installing the integration. The integration registers the frontend resources automatically, so you can immediately:



1. Go to your dashboard and click "Add Card"

2. Search for "FIBARO" or look for "Custom: FIBARO Intercom Card"

3. Configure the card with your entities



**Manual Setup (Alternative):**

If you prefer manual installation or encounter issues:



1. **Add the resource manually:**

   - Go to Settings → Dashboards → Resources

   - Click "Add Resource"

   - URL: `/fibaro_intercom/fibaro-intercom-card.js` (if using the integration's path)

   - Or URL: `/local/fibaro-intercom-card.js` (if copied to www folder)

   - Resource type: JavaScript Module

   - Click "Create"



2. **Use the card:**

   - Restart Home Assistant and clear browser cache

   - Go to your dashboard and click "Add Card"

   - Search for "FIBARO" or look for "Custom: FIBARO Intercom Card"



**Quick Configuration:**

```yaml

type: custom:fibaro-intercom-card

camera_entity: camera.fibaro_intercom_camera

relay_0_entity: binary_sensor.fibaro_intercom_relay_0

relay_1_entity: binary_sensor.fibaro_intercom_relay_1

relay_0_label: "Front Door"

relay_1_label: "Gate"

```



For complete card documentation, configuration options, and examples, see [`custom_components/fibaro_intercom/frontend/README.md`](custom_components/fibaro_intercom/frontend/README.md).



## Services



### `fibaro_intercom.open_relay`



Opens a relay for a specified duration.



**Parameters:**

- `relay` (required): Relay number (0 or 1)

- `timeout` (optional): Duration in milliseconds (250-30000ms)



**Example:**

```yaml

service: fibaro_intercom.open_relay

data:

  relay: 0

  timeout: 5000

```



## Events



### `fibaro_intercom.doorbell_pressed`



Fired when the doorbell button is pressed. This event triggers device triggers for easy automation setup.



**Event Data:**

- `button`: Button number that was pressed

- `device_id`: Device ID for the intercom



**Example Automation (using Device Trigger):**

```yaml

automation:

  - alias: "Doorbell Notification"

    trigger:

      platform: device

      device_id: [your_device_id]

      domain: fibaro_intercom

      type: doorbell_pressed

    action:

      service: notify.mobile_app_your_phone

      data:

        message: "Someone is at the door!"

```



**Alternative (using Event Trigger):**

```yaml

automation:

  - alias: "Doorbell Notification"

    trigger:

      platform: event

      event_type: fibaro_intercom.doorbell_pressed

    action:

      service: notify.mobile_app_your_phone

      data:

        message: "Someone is at the door!"

```



## API Reference



The integration communicates with the FIBARO Intercom using JSON-RPC 2.0 over WebSocket.



For complete API documentation, see the [FIBARO Intercom API Reference](https://manuals.fibaro.com/knowledge-base-browse/intercom-api/).



### WebSocket Endpoint

```

wss://:/wsock

```



### Authentication

```json

{

  "jsonrpc": "2.0",

  "id": 1,

  "method": "com.fibaro.intercom.account.login",

  "params": {

    "user": "",

    "pass": ""

  }

}

```



### Relay Control

```json

{

  "jsonrpc": "2.0",

  "id": 2,

  "method": "com.fibaro.intercom.relay.open",

  "params": {

    "token": "",

    "relay": 0,

    "timeout": 5000

  }

}

```



## Troubleshooting



### Connection Issues



1. **Check Network Connectivity**: Ensure Home Assistant can reach the intercom

2. **Verify Credentials**: Confirm username/password are correct

3. **Check Port**: Default WebSocket port is 8081

4. **TLS Issues**: Try disabling TLS verification if using self-signed certificates



### Testing Connection



A test script is provided to diagnose connection issues independently of Home Assistant:



**Using Environment Variables (Recommended):**

```powershell

# Windows PowerShell

$env:FIBARO_HOST='192.168.1.100'

$env:FIBARO_USERNAME='admin'

$env:FIBARO_PASSWORD='your_password'

python tests/test_connection.py

```



```bash

# Linux/macOS

export FIBARO_HOST='192.168.1.100'

export FIBARO_USERNAME='admin'

export FIBARO_PASSWORD='your_password'

python tests/test_connection.py

```



**Alternative:** Edit the script directly and replace the placeholder values with your intercom details.



The test script will:

- ✅ Test WebSocket connectivity

- ✅ Verify authentication

- ✅ Provide detailed error messages

- ✅ Confirm the integration should work



### Debugging



Enable debug logging by adding to your `configuration.yaml`:



```yaml

logger:

  logs:

    custom_components.fibaro_intercom: debug

```



### Common Issues



- **Authentication Failed**: Check username/password and ensure local account is enabled

- **Connection Refused**: Verify the intercom IP address and port

- **Camera Not Working**: Check camera URLs and authentication



## Development



For development setup, testing, and contributing guidelines, see [tests/README.md](tests/README.md).

For project structure and documentation overview, see [PROJECT.md](PROJECT.md).



**Quick start for developers:**

```bash

git clone https://github.com/Squazel/homeassistant-fibaro-intercom.git

cd homeassistant-fibaro-intercom



# One-command setup

python hass-dev.py setup



# Development workflow:

python hass-dev.py quality    # Quick format + lint check (no tests)

python hass-dev.py check      # Full check including tests

python hass-dev.py test       # Run tests only

python hass-dev.py format     # Format code only

```



**Modern Development Stack:**

- **Centralized Commands**: All development tools call `tools/commands.py` for consistency

- **Ruff**: Ultra-fast linter and formatter (replaces flake8 + isort + black)

- **Separate CI Workflows**: Code quality and tests run independently

- **Pre-commit Integration**: Automatic code quality checks on commit



## Contributing



1. Fork the repository

2. Create a feature branch

3. Make your changes

4. Add tests for new functionality

5. Ensure all tests pass

6. Submit a pull request



## License



This project is licensed under the MIT License - see the LICENSE file for details.



## Support



- **Issues**: [GitHub Issues](https://github.com/Squazel/homeassistant-fibaro-intercom/issues)

- **Documentation**: This README and [tests/README.md](tests/README.md) for development

- **Home Assistant Community**: [Community Forum](https://community.home-assistant.io/)

- **FIBARO API Reference**: [Official API Documentation](https://manuals.fibaro.com/knowledge-base-browse/intercom-api/)



## Version



**v1.0.0** - Initial release with WebSocket connection, relay control, doorbell monitoring, camera integration, and configuration flow.