base on Hue Bridge Emulator  # Bifrost Bridge Bifrost enables you to emulate a Philips Hue Bridge to control lights, groups and scenes from [Zigbee2Mqtt](https://www.zigbee2mqtt.io/). If you are already familiar with [DiyHue](https://github.com/diyhue/diyHue), you might like to read the [comparison with DiyHue](doc/comparison-with-diyhue.md). Questions, feedback, comments? Join us on discord [](https://discord.gg/YvBKjHBJpA) ## Installation guide There are currently three ways you can install Bifrost: 1. [Install manually](#manual) from source (recommended) 2. [Install it via Docker](#docker) for container-based deployment. 3. Install as Home Assistant Add-on. Please see the [bifrost-hassio](https://github.com/chrivers/bifrost-hassio) project for more information. ### Manual To install Bifrost from source, you will need the following: 1. The rust language toolchain (https://rustup.rs/) 2. At least one zigbee2mqtt server to connect to 3. The MAC address of the network interface you want to run the server on 4. `build-essential` package for compiling the source code (on Debian/Ubuntu systems) First, install a few necessary build dependencies: ```sh sudo apt install build-essential pkg-config libssl3 libssl-dev ``` When you have these things available, install bifrost: ```sh cargo install --git https://github.com/chrivers/bifrost.git ``` After Cargo has finished downloading, compiling, and installing Bifrost, you should have the "bifrost" command available to you. The last step is to create a configuration for bifrost, `config.yaml`. Here's a minimal example: ```yaml bridge: name: Bifrost mac: 00:11:22:33:44:55 ipaddress: 10.12.0.20 netmask: 255.255.255.0 gateway: 10.12.0.1 timezone: Europe/Copenhagen z2m: server1: url: ws://10.0.0.100:8080 ``` Please adjust this as needed. Particularly, make **sure** the "mac:" field matches a mac address on the network interface you want to serve requests from. Make sure to read the [configuration reference](doc/config-reference.md) to learn how to adjust the configuration file. This mac address if used to generate a self-signed certificate, so the Hue App will recognize this as a "real" Hue Bridge. If the mac address is incorrect, this will not work. [How to find your mac address](doc/how-to-find-mac-linux.md). Now you can start Bifrost. Simple start the "bifrost" command from the same directory where you put the `config.yaml`: ```sh bifrost ``` At this point, the server should start: (log timestamps omitted for clarity) ``` =================================================================== ███████████ ███ ██████ █████ ░░███░░░░░███ ░░░ ███░░███ ░░███ ░███ ░███ ████ ░███ ░░░ ████████ ██████ █████ ███████ ░██████████ ░░███ ███████ ░░███░░███ ███░░███ ███░░ ░░░███░ ░███░░░░░███ ░███ ░░░███░ ░███ ░░░ ░███ ░███░░█████ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░███ ░░░░███ ░███ ███ ███████████ █████ █████ █████ ░░██████ ██████ ░░█████ ░░░░░░░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░░ ░░░░░░ ░░░░░ =================================================================== DEBUG bifrost > Configuration loaded successfully DEBUG bifrost::server::certificate > Found existing certificate for bridge id [001122fffe334455] DEBUG bifrost::state > Existing state file found, loading.. INFO bifrost::mdns > Registered service bifrost-001122334455._hue._tcp.local. INFO bifrost > Serving mac [00:11:22:33:44:55] DEBUG bifrost::state > Loading certificate from [cert.pem] INFO bifrost::server > http listening on 10.12.0.20:80 INFO bifrost::server > https listening on 10.12.0.20:443 INFO bifrost::z2m > [server1] Connecting to ws://10.0.0.100:8080 DEBUG tungstenite::handshake::client > Client handshake done. DEBUG tungstenite::handshake::client > Client handshake done. DEBUG bifrost::z2m > [server1] Ignoring unsupported device Coordinator INFO bifrost::z2m > [server1] Adding light IeeeAddress(000000fffe111111): [office_1] (TRADFRI bulb GU10 CWS 345lm) INFO bifrost::z2m > [server1] Adding light IeeeAddress(222222fffe333333): [office_2] (TRADFRI bulb GU10 CWS 345lm) INFO bifrost::z2m > [server1] Adding light IeeeAddress(444444fffe555555): [office_3] (TRADFRI bulb GU10 CWS 345lm) ... ``` The log output shows Bifrost talking with zigbee2mqtt, and finding some lights to control (office\_{1,2,3}). At this point, you're running a Bifrost bridge. The Philips Hue app should be able to find it on your network! ### Docker #### Docker Installation To install Bifrost with Docker, you will need the following: 1. At least one zigbee2mqtt server to connect to 2. The MAC address of the network interface you want to run the server on 3. A running [Docker](https://docs.docker.com/engine/install/) instance with [Docker-Compose](https://docs.docker.com/compose/install/) installed 4. Have `git` installed to clone this repository Please choose one of the following installation methods: - [Install using Docker Compose](doc/docker-compose-install.md) (recommended for most users) - [Install using Docker Image](doc/docker-image-install.md) (for direct image pulls) # Configuration See [configuration reference](doc/config-reference.md). # Problems? Questions? Feedback? Please note: Bifrost is a very young project. Some things are incomplete, and/or broken when they shouldn't be. Consider joining us on discord: [](https://discord.gg/YvBKjHBJpA) If you have any problems, questions or suggestions, feel free to [create an issue](https://github.com/chrivers/bifrost/issues) on this project. Also, pull requests are always welcome! ", Assign "at most 3 tags" to the expected json: {"id":"12747","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"