https://github.com/itavero/homebridge-z2m

Expose your Zigbee devices to HomeKit with ease, by integrating 🐝 Zigbee2MQTT with 🏠 Homebridge.
https://github.com/itavero/homebridge-z2m

home-automation homebridge homebridge-platform homebridge-plugin homekit zigbee zigbee2mqtt

Last synced: about 1 month ago
JSON representation

Expose your Zigbee devices to HomeKit with ease, by integrating 🐝 Zigbee2MQTT with 🏠 Homebridge.

• Host: GitHub
• URL: https://github.com/itavero/homebridge-z2m
• Owner: itavero
• License: apache-2.0
• Created: 2020-06-27T11:28:06.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-02T16:03:57.000Z (about 1 month ago)
• Last Synced: 2024-10-07T21:35:00.068Z (about 1 month ago)
• Topics: home-automation, homebridge, homebridge-platform, homebridge-plugin, homekit, zigbee, zigbee2mqtt
• Language: TypeScript
• Homepage: https://z2m.dev
• Size: 6.88 MB
• Stars: 316
• Watchers: 4
• Forks: 49
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-homebridge - Zigbee2MQTT

README

        


  



# homebridge-z2m

[![verified-by-homebridge](https://flat.badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)

[![NPM Latest version](https://flat.badgen.net/npm/v/homebridge-z2m/latest?icon=npm&label=%40latest&color=blue)](https://www.npmjs.com/package/homebridge-z2m/v/latest)

[![NPM Next/future version](https://flat.badgen.net/npm/v/homebridge-z2m/next?icon=npm&label=%40next&color=orange)](https://www.npmjs.com/package/homebridge-z2m/v/next)

[![NPM Downloads](https://flat.badgen.net/npm/dt/homebridge-z2m/?icon=npm&color=blue)](https://www.npmjs.com/package/homebridge-z2m)

[![GitHub Checks status](https://flat.badgen.net/github/checks/itavero/homebridge-z2m?icon=github)](https://github.com/itavero/homebridge-z2m)

Expose your Zigbee devices to HomeKit with ease, by integrating 🐝 [Zigbee2MQTT](https://www.zigbee2mqtt.io/) with 🏠 [Homebridge](https://homebridge.io/) (via an MQTT message broker).

This Homebridge plugin can be installed using `npm install homebridge-z2m` or via the [Homebridge Config UI X](https://www.npmjs.com/package/homebridge-config-ui-x) plugin.

The bare minimum configuration for this plugin only has to contain the MQTT server information:

```json

{

   "platform": "zigbee2mqtt",

   "mqtt": {

      "base_topic": "zigbee2mqtt",

      "server": "mqtt://localhost:1883"

   }

}

```

After adding this to your configuration and restarting Homebridge, it should automatically retrieve all the required information about the devices from Zigbee2MQTT (via the configured MQTT server).

For more information on installing, configuring and using the plugin, please check the [documentation on the plugin website](https://z2m.dev).

## Need help?

[![Homebridge Discord](https://flat.badgen.net/badge/homebridge/%23z2m/purple?icon=discord)](https://discord.gg/kqNCe2D)

If you have a question or run into a problem, please ask a question in the `#z2m` channel on the [Homebridge Discord](https://discord.gg/kqNCe2D). I also try to check the [homebridge subreddit](https://www.reddit.com/r/homebridge/) for `Zigbee` and `Zigbee2MQTT` every now and then (but you'll probably get a faster answer on Discord).

## Contribute

This project is open to contributions. Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.