From 7c419cb99eb7309b1e5e73928ca7d07c0b67cb85 Mon Sep 17 00:00:00 2001 From: Alex Hope-O'Connor Date: Sun, 19 Apr 2026 21:17:11 +1000 Subject: [PATCH] Add PlatformIO library.json and README note Declare PubSubClient dependency; document lib_deps for PIO consumers. --- README.md | 11 +++++++++++ library.json | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 61 insertions(+) create mode 100644 library.json diff --git a/README.md b/README.md index 64d2b80..07940c5 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,17 @@ The library is designed to use as low resources (RAM/flash) as possible. Initially, it was optimized to work on Arduino Uno with Ethernet Shield, but I successfully use it on ESP8266/ESP8255 boards in my projects. +## PlatformIO + +[`library.json`](library.json) declares the **PubSubClient** dependency for Library Manager / LDF. Example: + +```ini +lib_deps = + https://github.com/alexhopeoconnor/arduino-home-assistant.git +``` + +(`library.properties` remains the source of truth for the Arduino IDE 1.x/2.x library manager name **home-assistant-integration**.) + ## Features * Two-way communication (state reporting and command execution) diff --git a/library.json b/library.json new file mode 100644 index 0000000..7646de6 --- /dev/null +++ b/library.json @@ -0,0 +1,50 @@ +{ + "name": "home-assistant-integration", + "version": "2.1.0", + "description": "Home Assistant MQTT integration for Arduino (ArduinoHA): discovery, entities, and low resource use.", + "keywords": [ + "mqtt", + "home-assistant", + "homeassistant", + "arduino", + "esp8266", + "esp32", + "communication", + "smarthome" + ], + "authors": [ + { + "name": "Dawid Chyrzynski", + "email": "dev@chyrzynski.pl" + }, + { + "name": "Alex Hope-O'Connor", + "email": "alex.hope.oconnor@pomonaqld.au", + "maintainer": true + } + ], + "license": "MIT", + "homepage": "https://github.com/alexhopeoconnor/arduino-home-assistant", + "repository": { + "type": "git", + "url": "https://github.com/alexhopeoconnor/arduino-home-assistant.git" + }, + "frameworks": "arduino", + "dependencies": [ + { + "name": "knolleary/PubSubClient", + "version": "^2.8.0" + } + ], + "export": { + "include": [ + "src", + "examples", + "library.properties", + "library.json", + "README.md", + "LICENSE", + "CHANGELOG.md" + ] + } +}