{"id":42399974,"url":"https://github.com/finitelabs/control4-mqtt","last_synced_at":"2026-04-14T23:01:13.116Z","repository":{"id":333165181,"uuid":"1124878159","full_name":"finitelabs/control4-mqtt","owner":"finitelabs","description":"Control4 drivers for MQTT integration. Connect your Control4 system to any MQTT broker to control switches, buttons, and contact sensors.","archived":false,"fork":false,"pushed_at":"2026-04-14T21:06:18.000Z","size":1363,"stargazers_count":8,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-04-14T22:23:13.971Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/finitelabs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-29T19:17:27.000Z","updated_at":"2026-04-14T21:06:15.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/finitelabs/control4-mqtt","commit_stats":null,"previous_names":["finitelabs/control4-mqtt"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/finitelabs/control4-mqtt","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/finitelabs%2Fcontrol4-mqtt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/finitelabs%2Fcontrol4-mqtt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/finitelabs%2Fcontrol4-mqtt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/finitelabs%2Fcontrol4-mqtt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/finitelabs","download_url":"https://codeload.github.com/finitelabs/control4-mqtt/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/finitelabs%2Fcontrol4-mqtt/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31818840,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-14T18:05:02.291Z","status":"ssl_error","status_checked_at":"2026-04-14T18:05:01.765Z","response_time":153,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-28T01:15:37.499Z","updated_at":"2026-04-14T23:01:13.082Z","avatar_url":"https://github.com/finitelabs.png","language":"Lua","funding_links":["https://www.buymeacoffee.com/derek.miller"],"categories":[],"sub_categories":[],"readme":"\u003cimg alt=\"MQTT\" src=\"./images/header.png\" width=\"500\"/\u003e\n\n---\n\n# \u003cspan style=\"color:#660066\"\u003eOverview\u003c/span\u003e\n\n\u003e DISCLAIMER: This software is neither affiliated with nor endorsed by either\n\u003e Control4 or MQTT.\n\nThe MQTT Broker driver connects Control4 to an MQTT broker (such as Mosquitto,\nHiveMQ, or other MQTT-compatible platforms). It manages the connection and\nprovides pub/sub services to child drivers that connect via the MQTT broker\nconnection binding.\n\n## Driver Suite\n\nThe MQTT driver suite consists of two drivers:\n\n| Driver             | Direction | Purpose                                                                                          |\n| ------------------ | --------- | ------------------------------------------------------------------------------------------------ |\n| **MQTT Broker**    | N/A       | Connection management to your MQTT broker                                                        |\n| **MQTT Universal** | Inbound   | External MQTT device -\\\u003e Control4 (create relays, contacts, buttons, variables from MQTT topics) |\n\n**Typical Setup:**\n\n1.  Add the **MQTT Broker** driver and configure your broker connection\n2.  Add **MQTT Universal** if you need to bring external MQTT devices into\n    Control4\n\n# \u003cspan style=\"color:#660066\"\u003eIndex\u003c/span\u003e\n\n\u003cdiv style=\"font-size: small\"\u003e\n\n- [System Requirements](#system-requirements)\n- [Features](#features)\n- [Installer Setup](#installer-setup)\n  - [Driver Installation](#driver-installation)\n  - [Driver Setup](#driver-setup)\n    - [Driver Properties](#driver-properties)\n      - [Cloud Settings](#cloud-settings)\n      - [Driver Settings](#driver-settings)\n      - [MQTT Settings](#mqtt-settings)\n  - [Driver Actions](#driver-actions)\n  - [Programming](#programming)\n- [Support](#support)\n- [Changelog](#changelog)\n\n\u003c/div\u003e\n\n\u003cdiv style=\"page-break-after: always\"\u003e\u003c/div\u003e\n\n# \u003cspan style=\"color:#660066\"\u003eSystem Requirements\u003c/span\u003e\n\n- Control4 OS 3.3+\n- An MQTT broker accessible on the local network\n\n# \u003cspan style=\"color:#660066\"\u003eFeatures\u003c/span\u003e\n\n- Local network communication requiring no cloud services\n- Connects to any standard MQTT broker\n- Supports username/password authentication\n- Manages subscriptions for connected child drivers\n- Automatic reconnection on disconnect\n- Message caching for late-subscribing devices\n\n\u003cdiv style=\"page-break-after: always\"\u003e\u003c/div\u003e\n\n# \u003cspan style=\"color:#660066\"\u003eInstaller Setup\u003c/span\u003e\n\n## Driver Installation\n\nDriver installation and setup are similar to most other ip-based drivers. Below\nis an outline of the basic steps for your convenience.\n\n1.  Download the latest `control4-mqtt.zip` from\n    [Github](https://github.com/finitelabs/control4-mqtt/releases/latest).\n\n2.  Extract and\n    [install](\u003c(https://www.control4.com/help/c4/software/cpro/dealer-composer-help/content/composerpro_userguide/adding_drivers_manually.htm)\u003e)\n    the `mqtt_broker.c4z` and `mqtt_universal.c4z` drivers.\n\n3.  Use the \"Search\" tab to find the \"MQTT Broker\" driver and add it to your\n    project.\n\n    \u003e ⚠️ A **_single_** broker driver instance is required per broker you wish\n    \u003e to connect to.\n\n    ![Search Drivers](images/search-drivers.png)\n\n4.  Configure the [Device Settings](#device-settings) with the connection\n    information.\n\n5.  After a few moments the [`Driver Status`](#driver-status-read-only) will\n    display `Connected`. If the driver fails to connect, set the\n    [`Log Mode`](#log-mode--off--print--log--print-and-log-) property to `Print`\n    and run action [`Reconnect`](#reconnect) from the actions tab. Then check\n    the lua output window for more information.\n\n## Driver Setup\n\n### Driver Properties\n\n#### Cloud Settings\n\n##### Automatic Updates\n\nTurns on/off the GitHub cloud automatic updates.\n\n##### Update Channel\n\nSets the update channel for which releases are considered during an automatic\nupdate from the GitHub repo releases.\n\n#### Driver Settings\n\n##### Driver Status (read-only)\n\nDisplays the current status of the driver.\n\n##### Driver Version (read-only)\n\nDisplays the current version of the driver.\n\n##### Log Level \\[ Fatal \\| Error \\| Warning \\| **_Info_** \\| Debug \\| Trace \\| Ultra \\]\n\nSets the logging level. Default is `Info`.\n\n##### Log Mode \\[ **_Off_** \\| Print \\| Log \\| Print and Log \\]\n\nSets the logging mode. Default is `Off`.\n\n#### MQTT Settings\n\n##### Broker Address\n\nSets the broker IP address (e.g. `192.168.1.30`). Domain names are allowed as\nlong as they can be resolved to an accessible IP address by the controller.\nHTTPS is not supported.\n\n\u003e ⚠️ If you are using an IP address, you should ensure it will not change by\n\u003e assigning a static IP or creating a DHCP reservation.\n\n##### Port\n\nSets the broker port. The default port for most brokers is `1883`.\n\n##### Username\n\nSets the username for broker authentication (optional).\n\n##### Password\n\nSets the password for broker authentication (optional).\n\n##### Keep Alive\n\nSets the keep-alive interval in seconds. Default is `60`.\n\n#### Driver Actions\n\n##### Reconnect\n\nManually trigger a reconnection to the MQTT broker.\n\n##### Update Drivers\n\nTrigger all MQTT drivers to update from the latest release on GitHub, regardless\nof the current version.\n\n### Programming\n\n**Events:**\n\n- **Broker Connected** - Fires when the driver connects to the MQTT broker\n- **Broker Disconnected** - Fires when the driver disconnects from the MQTT\n  broker\n\n**Conditionals:**\n\n- **Broker Connected** - Check if the broker is connected or disconnected\n\n\u003cdiv style=\"page-break-after: always\"\u003e\u003c/div\u003e\n\n# \u003cspan style=\"color:#660066\"\u003eSupport\u003c/span\u003e\n\nIf you have any questions or issues integrating this driver with Control4, you\ncan file an issue on GitHub:\n\n\u003chttps://github.com/finitelabs/control4-mqtt/issues/new\u003e\n\n\u003ca href=\"https://www.buymeacoffee.com/derek.miller\" target=\"_blank\"\u003e\u003cimg src=\"https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png\" alt=\"Buy Me A Coffee\" style=\"height: 60px !important;width: 217px !important;\" \u003e\u003c/a\u003e\n\n\u003cdiv style=\"page-break-after: always\"\u003e\u003c/div\u003e\n\n# \u003cspan style=\"color:#660066\"\u003eChangelog\u003c/span\u003e\n\n## v20260414 - 2026-04-14\n\n### Fixed\n\n- Fixed MQTT Universal variables losing their programming \"Set Variable\"\n  callback after the first inbound MQTT message on the variable's state topic.\n- Fixed MQTT Universal BOOL variables not toggling reliably from programming due\n  to incorrect serialization to Control4.\n- Fixed MQTT Universal variables losing their writable state after a controller\n  reboot or driver reload.\n- Fixed automatic driver updates not working when the leader instance is removed\n  from the project\n\n## v20260217 - 2026-02-17\n\n### Changed\n\n- Broker properties (Automatic Updates, Update Channel) now automatically sync\n  across all MQTT Broker driver instances.\n- Temperature conversions (Fahrenheit/Celsius) now use single decimal precision\n  instead of rounding to the nearest integer or half degree.\n\n### Fixed\n\n- Fixed variable restore order during driver initialization on controller\n  reboot.\n\n## v20260120 - 2026-01-27\n\n### Fixed\n\n- Fixed incorrect DriverCentral product ID in MQTT Universal driver.\n\n## v20260120 - 2026-01-20\n\n### Fixed\n\n- Fixed consumer bindings (e.g., BUTTON_LINK for Event entities) not restoring\n  their connections on controller reboot. The bindings module now tracks\n  connection info and automatically re-establishes consumer binding connections\n  when bindings are restored.\n\n## v20260119 - 2026-01-19\n\n### Added\n\n- Added Event entity type to MQTT Universal driver for receiving MQTT events and\n  triggering Control4 buttons/keypads.\n\n### Changed\n\n- Updated MQTT Broker documentation to include Programming section with events\n  and conditionals.\n- Updated MQTT Universal documentation to include missing read-only properties\n  and BUTTON_LINK binding information.\n\n### Removed\n\n- Removed deprecated MQTT Switch, MQTT Contact, and MQTT Button drivers.\n\n## v20260117 - 2026-01-17\n\n### Added\n\n- Added the MQTT Universal driver for managing multiple MQTT devices from a\n  single driver instance. Supports relays, contacts, buttons, variables, and\n  sensors with features including:\n  - Keypad button linking for MQTT buttons\n  - Device availability conditionals and events\n  - State variables for relay and contact items\n  - JSONPath value extraction for complex JSON payloads\n- Added \"Broker Connected\" conditional and events to the MQTT Broker driver.\n\n### Deprecated\n\n- Deprecated the MQTT Switch, MQTT Contact, and MQTT Button drivers. Use MQTT\n  Universal instead. This is the terminal release for these drivers.\n\n## v20251229 - 2025-12-29\n\n### Added\n\n- Initial Release\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffinitelabs%2Fcontrol4-mqtt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffinitelabs%2Fcontrol4-mqtt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffinitelabs%2Fcontrol4-mqtt/lists"}